b2f9dccc07cc1ae4829fcd7a604af6f6e78e6a69
[users/jgh/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.92"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2018
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 .cindex "documentation"
375 This edition of the Exim specification applies to version &version() of Exim.
376 Substantive changes from the &previousversion; edition are marked in some
377 renditions of this document; this paragraph is so marked if the rendition is
378 capable of showing a change indicator.
379
380 This document is very much a reference manual; it is not a tutorial. The reader
381 is expected to have some familiarity with the SMTP mail transfer protocol and
382 with general Unix system administration. Although there are some discussions
383 and examples in places, the information is mostly organized in a way that makes
384 it easy to look up, rather than in a natural order for sequential reading.
385 Furthermore, this manual aims to cover every aspect of Exim in detail, including
386 a number of rarely-used, special-purpose features that are unlikely to be of
387 very wide interest.
388
389 .cindex "books about Exim"
390 An &"easier"& discussion of Exim which provides more in-depth explanatory,
391 introductory, and tutorial material can be found in a book entitled &'The Exim
392 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
393 (&url(https://www.uit.co.uk/exim-book/)).
394
395 The book also contains a chapter that gives a general introduction to SMTP and
396 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
397 with the latest release of Exim. (Note that the earlier book about Exim,
398 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
399
400 .cindex "Debian" "information sources"
401 If you are using a Debian distribution of Exim, you will find information about
402 Debian-specific features in the file
403 &_/usr/share/doc/exim4-base/README.Debian_&.
404 The command &(man update-exim.conf)& is another source of Debian-specific
405 information.
406
407 .cindex "&_doc/NewStuff_&"
408 .cindex "&_doc/ChangeLog_&"
409 .cindex "change log"
410 As Exim develops, there may be features in newer versions that have not
411 yet made it into this document, which is updated only when the most significant
412 digit of the fractional part of the version number changes. Specifications of
413 new features that are not yet in this manual are placed in the file
414 &_doc/NewStuff_& in the Exim distribution.
415
416 Some features may be classified as &"experimental"&. These may change
417 incompatibly while they are developing, or even be withdrawn. For this reason,
418 they are not documented in this manual. Information about experimental features
419 can be found in the file &_doc/experimental.txt_&.
420
421 All changes to Exim (whether new features, bug fixes, or other kinds of
422 change) are noted briefly in the file called &_doc/ChangeLog_&.
423
424 .cindex "&_doc/spec.txt_&"
425 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
426 that it can easily be searched with a text editor. Other files in the &_doc_&
427 directory are:
428
429 .table2 100pt
430 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
431 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
432 .row &_exim.8_&              "a man page of Exim's command line options"
433 .row &_experimental.txt_&    "documentation of experimental features"
434 .row &_filter.txt_&          "specification of the filter language"
435 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
436 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
437 .row &_openssl.txt_&         "installing a current OpenSSL release"
438 .endtable
439
440 The main specification and the specification of the filtering language are also
441 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
442 &<<SECTavail>>& below tells you how to get hold of these.
443
444
445
446 .section "FTP site and websites" "SECID2"
447 .cindex "website"
448 .cindex "FTP site"
449 The primary site for Exim source distributions is the &%exim.org%& FTP site,
450 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
451 website, are hosted at the University of Cambridge.
452
453 .cindex "wiki"
454 .cindex "FAQ"
455 As well as Exim distribution tar files, the Exim website contains a number of
456 differently formatted versions of the documentation. A recent addition to the
457 online information is the Exim wiki (&url(https://wiki.exim.org)),
458 which contains what used to be a separate FAQ, as well as various other
459 examples, tips, and know-how that have been contributed by Exim users.
460 The wiki site should always redirect to the correct place, which is currently
461 provided by GitHub, and is open to editing by anyone with a GitHub account.
462
463 .cindex Bugzilla
464 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
465 this to report bugs, and also to add items to the wish list. Please search
466 first to check that you are not duplicating a previous entry.
467 Please do not ask for configuration help in the bug-tracker.
468
469
470 .section "Mailing lists" "SECID3"
471 .cindex "mailing lists" "for Exim users"
472 The following Exim mailing lists exist:
473
474 .table2 140pt
475 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
476 .row &'exim-users@exim.org'&      "General discussion list"
477 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
478 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
479 .endtable
480
481 You can subscribe to these lists, change your existing subscriptions, and view
482 or search the archives via the mailing lists link on the Exim home page.
483 .cindex "Debian" "mailing list for"
484 If you are using a Debian distribution of Exim, you may wish to subscribe to
485 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
486 via this web page:
487 .display
488 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
489 .endd
490 Please ask Debian-specific questions on that list and not on the general Exim
491 lists.
492
493 .section "Bug reports" "SECID5"
494 .cindex "bug reports"
495 .cindex "reporting bugs"
496 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
497 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
498 whether some behaviour is a bug or not, the best thing to do is to post a
499 message to the &'exim-dev'& mailing list and have it discussed.
500
501
502
503 .section "Where to find the Exim distribution" "SECTavail"
504 .cindex "FTP site"
505 .cindex "HTTPS download site"
506 .cindex "distribution" "FTP site"
507 .cindex "distribution" "https site"
508 The master distribution site for the Exim distribution is
509 .display
510 &url(https://downloads.exim.org/)
511 .endd
512 The service is available over HTTPS, HTTP and FTP.
513 We encourage people to migrate to HTTPS.
514
515 The content served at &url(https://downloads.exim.org/) is identical to the
516 content served at &url(https://ftp.exim.org/pub/exim) and
517 &url(ftp://ftp.exim.org/pub/exim).
518
519 If accessing via a hostname containing &'ftp'&, then the file references that
520 follow are relative to the &_exim_& directories at these sites.
521 If accessing via the hostname &'downloads'& then the subdirectories described
522 here are top-level directories.
523
524 There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the top exim directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.xz_&
533 &_exim-n.nn.tar.gz_&
534 &_exim-n.nn.tar.bz2_&
535 .endd
536 where &'n.nn'& is the highest such version number in the directory. The three
537 files contain identical data; the only difference is the type of compression.
538 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
539 most portable to old systems.
540
541 .cindex "distribution" "signing details"
542 .cindex "distribution" "public key"
543 .cindex "public key for signed distribution"
544 The distributions will be PGP signed by an individual key of the Release
545 Coordinator.  This key will have a uid containing an email address in the
546 &'exim.org'& domain and will have signatures from other people, including
547 other Exim maintainers.  We expect that the key will be in the "strong set" of
548 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
549 PGP keys, a version of which can be found in the release directory in the file
550 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
551 such as &'pool.sks-keyservers.net'&.
552
553 At the time of the last update, releases were being made by Jeremy Harris and signed
554 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
555 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
556 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
557
558 The signatures for the tar bundles are in:
559 .display
560 &_exim-n.nn.tar.xz.asc_&
561 &_exim-n.nn.tar.gz.asc_&
562 &_exim-n.nn.tar.bz2.asc_&
563 .endd
564 For each released version, the log of changes is made available in a
565 separate file in the directory &_ChangeLogs_& so that it is possible to
566 find out what has changed without having to download the entire distribution.
567
568 .cindex "documentation" "available formats"
569 The main distribution contains ASCII versions of this specification and other
570 documentation; other formats of the documents are available in separate files
571 inside the &_exim4_& directory of the FTP site:
572 .display
573 &_exim-html-n.nn.tar.gz_&
574 &_exim-pdf-n.nn.tar.gz_&
575 &_exim-postscript-n.nn.tar.gz_&
576 &_exim-texinfo-n.nn.tar.gz_&
577 .endd
578 These tar files contain only the &_doc_& directory, not the complete
579 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
580
581
582 .section "Limitations" "SECID6"
583 .ilist
584 .cindex "limitations of Exim"
585 .cindex "bang paths" "not handled by Exim"
586 Exim is designed for use as an Internet MTA, and therefore handles addresses in
587 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
588 simple two-component bang paths can be converted by a straightforward rewriting
589 configuration. This restriction does not prevent Exim from being interfaced to
590 UUCP as a transport mechanism, provided that domain addresses are used.
591 .next
592 .cindex "domainless addresses"
593 .cindex "address" "without domain"
594 Exim insists that every address it handles has a domain attached. For incoming
595 local messages, domainless addresses are automatically qualified with a
596 configured domain value. Configuration options specify from which remote
597 systems unqualified addresses are acceptable. These are then qualified on
598 arrival.
599 .next
600 .cindex "transport" "external"
601 .cindex "external transports"
602 The only external transport mechanisms that are currently implemented are SMTP
603 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
604 transport is available, and there are facilities for writing messages to files
605 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
606 to send messages to other transport mechanisms such as UUCP, provided they can
607 handle domain-style addresses. Batched SMTP input is also catered for.
608 .next
609 Exim is not designed for storing mail for dial-in hosts. When the volumes of
610 such mail are large, it is better to get the messages &"delivered"& into files
611 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
612 other means.
613 .next
614 Although Exim does have basic facilities for scanning incoming messages, these
615 are not comprehensive enough to do full virus or spam scanning. Such operations
616 are best carried out using additional specialized software packages. If you
617 compile Exim with the content-scanning extension, straightforward interfaces to
618 a number of common scanners are provided.
619 .endlist
620
621
622 .section "Runtime configuration" "SECID7"
623 Exim's runtime configuration is held in a single text file that is divided
624 into a number of sections. The entries in this file consist of keywords and
625 values, in the style of Smail 3 configuration files. A default configuration
626 file which is suitable for simple online installations is provided in the
627 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
628
629
630 .section "Calling interface" "SECID8"
631 .cindex "Sendmail compatibility" "command line interface"
632 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
633 can be a straight replacement for &_/usr/lib/sendmail_& or
634 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
635 about Sendmail in order to run Exim. For actions other than sending messages,
636 Sendmail-compatible options also exist, but those that produce output (for
637 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
638 format. There are also some additional options that are compatible with Smail
639 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
640 documents all Exim's command line options. This information is automatically
641 made into the man page that forms part of the Exim distribution.
642
643 Control of messages in the queue can be done via certain privileged command
644 line options. There is also an optional monitor program called &'eximon'&,
645 which displays current information in an X window, and which contains a menu
646 interface to Exim's command line administration options.
647
648
649
650 .section "Terminology" "SECID9"
651 .cindex "terminology definitions"
652 .cindex "body of message" "definition of"
653 The &'body'& of a message is the actual data that the sender wants to transmit.
654 It is the last part of a message and is separated from the &'header'& (see
655 below) by a blank line.
656
657 .cindex "bounce message" "definition of"
658 When a message cannot be delivered, it is normally returned to the sender in a
659 delivery failure message or a &"non-delivery report"& (NDR). The term
660 &'bounce'& is commonly used for this action, and the error reports are often
661 called &'bounce messages'&. This is a convenient shorthand for &"delivery
662 failure error report"&. Such messages have an empty sender address in the
663 message's &'envelope'& (see below) to ensure that they cannot themselves give
664 rise to further bounce messages.
665
666 The term &'default'& appears frequently in this manual. It is used to qualify a
667 value which is used in the absence of any setting in the configuration. It may
668 also qualify an action which is taken unless a configuration setting specifies
669 otherwise.
670
671 The term &'defer'& is used when the delivery of a message to a specific
672 destination cannot immediately take place for some reason (a remote host may be
673 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
674 until a later time.
675
676 The word &'domain'& is sometimes used to mean all but the first component of a
677 host's name. It is &'not'& used in that sense here, where it normally refers to
678 the part of an email address following the @ sign.
679
680 .cindex "envelope, definition of"
681 .cindex "sender" "definition of"
682 A message in transit has an associated &'envelope'&, as well as a header and a
683 body. The envelope contains a sender address (to which bounce messages should
684 be delivered), and any number of recipient addresses. References to the
685 sender or the recipients of a message usually mean the addresses in the
686 envelope. An MTA uses these addresses for delivery, and for returning bounce
687 messages, not the addresses that appear in the header lines.
688
689 .cindex "message" "header, definition of"
690 .cindex "header section" "definition of"
691 The &'header'& of a message is the first part of a message's text, consisting
692 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
693 &'Subject:'&, etc. Long header lines can be split over several text lines by
694 indenting the continuations. The header is separated from the body by a blank
695 line.
696
697 .cindex "local part" "definition of"
698 .cindex "domain" "definition of"
699 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
700 part of an email address that precedes the @ sign. The part that follows the
701 @ sign is called the &'domain'& or &'mail domain'&.
702
703 .cindex "local delivery" "definition of"
704 .cindex "remote delivery, definition of"
705 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
706 delivery to a file or a pipe on the local host from delivery by SMTP over
707 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
708 host it is running on are &'remote'&.
709
710 .cindex "return path" "definition of"
711 &'Return path'& is another name that is used for the sender address in a
712 message's envelope.
713
714 .cindex "queue" "definition of"
715 The term &'queue'& is used to refer to the set of messages awaiting delivery
716 because this term is in widespread use in the context of MTAs. However, in
717 Exim's case, the reality is more like a pool than a queue, because there is
718 normally no ordering of waiting messages.
719
720 .cindex "queue runner" "definition of"
721 The term &'queue runner'& is used to describe a process that scans the queue
722 and attempts to deliver those messages whose retry times have come. This term
723 is used by other MTAs and also relates to the command &%runq%&, but in Exim
724 the waiting messages are normally processed in an unpredictable order.
725
726 .cindex "spool directory" "definition of"
727 The term &'spool directory'& is used for a directory in which Exim keeps the
728 messages in its queue &-- that is, those that it is in the process of
729 delivering. This should not be confused with the directory in which local
730 mailboxes are stored, which is called a &"spool directory"& by some people. In
731 the Exim documentation, &"spool"& is always used in the first sense.
732
733
734
735
736
737
738 . ////////////////////////////////////////////////////////////////////////////
739 . ////////////////////////////////////////////////////////////////////////////
740
741 .chapter "Incorporated code" "CHID2"
742 .cindex "incorporated code"
743 .cindex "regular expressions" "library"
744 .cindex "PCRE"
745 .cindex "OpenDMARC"
746 A number of pieces of external code are included in the Exim distribution.
747
748 .ilist
749 Regular expressions are supported in the main Exim program and in the
750 Exim monitor using the freely-distributable PCRE library, copyright
751 &copy; University of Cambridge. The source to PCRE is no longer shipped with
752 Exim, so you will need to use the version of PCRE shipped with your system,
753 or obtain and install the full version of the library from
754 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
755 .next
756 .cindex "cdb" "acknowledgment"
757 Support for the cdb (Constant DataBase) lookup method is provided by code
758 contributed by Nigel Metheringham of (at the time he contributed it) Planet
759 Online Ltd. The implementation is completely contained within the code of Exim.
760 It does not link against an external cdb library. The code contains the
761 following statements:
762
763 .blockquote
764 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
765
766 This program is free software; you can redistribute it and/or modify it under
767 the terms of the GNU General Public License as published by the Free Software
768 Foundation; either version 2 of the License, or (at your option) any later
769 version.
770 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
771 the spec and sample code for cdb can be obtained from
772 &url(https://cr.yp.to/cdb.html). This implementation borrows
773 some code from Dan Bernstein's implementation (which has no license
774 restrictions applied to it).
775 .endblockquote
776 .next
777 .cindex "SPA authentication"
778 .cindex "Samba project"
779 .cindex "Microsoft Secure Password Authentication"
780 Client support for Microsoft's &'Secure Password Authentication'& is provided
781 by code contributed by Marc Prud'hommeaux. Server support was contributed by
782 Tom Kistner. This includes code taken from the Samba project, which is released
783 under the Gnu GPL.
784 .next
785 .cindex "Cyrus"
786 .cindex "&'pwcheck'& daemon"
787 .cindex "&'pwauthd'& daemon"
788 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
789 by code taken from the Cyrus-SASL library and adapted by Alexander S.
790 Sabourenkov. The permission notice appears below, in accordance with the
791 conditions expressed therein.
792
793 .blockquote
794 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
795
796 Redistribution and use in source and binary forms, with or without
797 modification, are permitted provided that the following conditions
798 are met:
799
800 .olist
801 Redistributions of source code must retain the above copyright
802 notice, this list of conditions and the following disclaimer.
803 .next
804 Redistributions in binary form must reproduce the above copyright
805 notice, this list of conditions and the following disclaimer in
806 the documentation and/or other materials provided with the
807 distribution.
808 .next
809 The name &"Carnegie Mellon University"& must not be used to
810 endorse or promote products derived from this software without
811 prior written permission. For permission or any other legal
812 details, please contact
813 .display
814               Office of Technology Transfer
815               Carnegie Mellon University
816               5000 Forbes Avenue
817               Pittsburgh, PA  15213-3890
818               (412) 268-4387, fax: (412) 268-7395
819               tech-transfer@andrew.cmu.edu
820 .endd
821 .next
822 Redistributions of any form whatsoever must retain the following
823 acknowledgment:
824
825 &"This product includes software developed by Computing Services
826 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
827
828 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
829 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
830 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
831 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
832 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
833 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
834 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
835 .endlist
836 .endblockquote
837
838 .next
839 .cindex "Exim monitor" "acknowledgment"
840 .cindex "X-windows"
841 .cindex "Athena"
842 The Exim Monitor program, which is an X-Window application, includes
843 modified versions of the Athena StripChart and TextPop widgets.
844 This code is copyright by DEC and MIT, and their permission notice appears
845 below, in accordance with the conditions expressed therein.
846
847 .blockquote
848 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
849 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
850
851 All Rights Reserved
852
853 Permission to use, copy, modify, and distribute this software and its
854 documentation for any purpose and without fee is hereby granted,
855 provided that the above copyright notice appear in all copies and that
856 both that copyright notice and this permission notice appear in
857 supporting documentation, and that the names of Digital or MIT not be
858 used in advertising or publicity pertaining to distribution of the
859 software without specific, written prior permission.
860
861 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
862 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
863 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
864 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
865 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
866 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
867 SOFTWARE.
868 .endblockquote
869
870 .next
871 .cindex "opendmarc" "acknowledgment"
872 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
873 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
874 derived code are indicated in the respective source files. The full OpenDMARC
875 license is provided in the LICENSE.opendmarc file contained in the distributed
876 source code.
877
878 .next
879 Many people have contributed code fragments, some large, some small, that were
880 not covered by any specific license requirements. It is assumed that the
881 contributors are happy to see their code incorporated into Exim under the GPL.
882 .endlist
883
884
885
886
887
888 . ////////////////////////////////////////////////////////////////////////////
889 . ////////////////////////////////////////////////////////////////////////////
890
891 .chapter "How Exim receives and delivers mail" "CHID11" &&&
892          "Receiving and delivering mail"
893
894
895 .section "Overall philosophy" "SECID10"
896 .cindex "design philosophy"
897 Exim is designed to work efficiently on systems that are permanently connected
898 to the Internet and are handling a general mix of mail. In such circumstances,
899 most messages can be delivered immediately. Consequently, Exim does not
900 maintain independent queues of messages for specific domains or hosts, though
901 it does try to send several messages in a single SMTP connection after a host
902 has been down, and it also maintains per-host retry information.
903
904
905 .section "Policy control" "SECID11"
906 .cindex "policy control" "overview"
907 Policy controls are now an important feature of MTAs that are connected to the
908 Internet. Perhaps their most important job is to stop MTAs from being abused as
909 &"open relays"& by misguided individuals who send out vast amounts of
910 unsolicited junk and want to disguise its source. Exim provides flexible
911 facilities for specifying policy controls on incoming mail:
912
913 .ilist
914 .cindex "&ACL;" "introduction"
915 Exim 4 (unlike previous versions of Exim) implements policy controls on
916 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
917 series of statements that may either grant or deny access. ACLs can be used at
918 several places in the SMTP dialogue while receiving a message from a remote
919 host. However, the most common places are after each RCPT command, and at the
920 very end of the message. The sysadmin can specify conditions for accepting or
921 rejecting individual recipients or the entire message, respectively, at these
922 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
923 error code.
924 .next
925 An ACL is also available for locally generated, non-SMTP messages. In this
926 case, the only available actions are to accept or deny the entire message.
927 .next
928 When Exim is compiled with the content-scanning extension, facilities are
929 provided in the ACL mechanism for passing the message to external virus and/or
930 spam scanning software. The result of such a scan is passed back to the ACL,
931 which can then use it to decide what to do with the message.
932 .next
933 When a message has been received, either from a remote host or from the local
934 host, but before the final acknowledgment has been sent, a locally supplied C
935 function called &[local_scan()]& can be run to inspect the message and decide
936 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
937 is accepted, the list of recipients can be modified by the function.
938 .next
939 Using the &[local_scan()]& mechanism is another way of calling external scanner
940 software. The &%SA-Exim%& add-on package works this way. It does not require
941 Exim to be compiled with the content-scanning extension.
942 .next
943 After a message has been accepted, a further checking mechanism is available in
944 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
945 runs at the start of every delivery process.
946 .endlist
947
948
949
950 .section "User filters" "SECID12"
951 .cindex "filter" "introduction"
952 .cindex "Sieve filter"
953 In a conventional Exim configuration, users are able to run private filters by
954 setting up appropriate &_.forward_& files in their home directories. See
955 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
956 configuration needed to support this, and the separate document entitled
957 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
958 of filtering are available:
959
960 .ilist
961 Sieve filters are written in the standard filtering language that is defined
962 by RFC 3028.
963 .next
964 Exim filters are written in a syntax that is unique to Exim, but which is more
965 powerful than Sieve, which it pre-dates.
966 .endlist
967
968 User filters are run as part of the routing process, described below.
969
970
971
972 .section "Message identification" "SECTmessiden"
973 .cindex "message ids" "details of format"
974 .cindex "format" "of message id"
975 .cindex "id of message"
976 .cindex "base62"
977 .cindex "base36"
978 .cindex "Darwin"
979 .cindex "Cygwin"
980 Every message handled by Exim is given a &'message id'& which is sixteen
981 characters long. It is divided into three parts, separated by hyphens, for
982 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
983 normally encoding numbers in base 62. However, in the Darwin operating
984 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
985 (avoiding the use of lower case letters) is used instead, because the message
986 id is used to construct filenames, and the names of files in those systems are
987 not always case-sensitive.
988
989 .cindex "pid (process id)" "re-use of"
990 The detail of the contents of the message id have changed as Exim has evolved.
991 Earlier versions relied on the operating system not re-using a process id (pid)
992 within one second. On modern operating systems, this assumption can no longer
993 be made, so the algorithm had to be changed. To retain backward compatibility,
994 the format of the message id was retained, which is why the following rules are
995 somewhat eccentric:
996
997 .ilist
998 The first six characters of the message id are the time at which the message
999 started to be received, to a granularity of one second. That is, this field
1000 contains the number of seconds since the start of the epoch (the normal Unix
1001 way of representing the date and time of day).
1002 .next
1003 After the first hyphen, the next six characters are the id of the process that
1004 received the message.
1005 .next
1006 There are two different possibilities for the final two characters:
1007 .olist
1008 .oindex "&%localhost_number%&"
1009 If &%localhost_number%& is not set, this value is the fractional part of the
1010 time of reception, normally in units of 1/2000 of a second, but for systems
1011 that must use base 36 instead of base 62 (because of case-insensitive file
1012 systems), the units are 1/1000 of a second.
1013 .next
1014 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1015 the fractional part of the time, which in this case is in units of 1/200
1016 (1/100) of a second.
1017 .endlist
1018 .endlist
1019
1020 After a message has been received, Exim waits for the clock to tick at the
1021 appropriate resolution before proceeding, so that if another message is
1022 received by the same process, or by another process with the same (re-used)
1023 pid, it is guaranteed that the time will be different. In most cases, the clock
1024 will already have ticked while the message was being received.
1025
1026
1027 .section "Receiving mail" "SECID13"
1028 .cindex "receiving mail"
1029 .cindex "message" "reception"
1030 The only way Exim can receive mail from another host is using SMTP over
1031 TCP/IP, in which case the sender and recipient addresses are transferred using
1032 SMTP commands. However, from a locally running process (such as a user's MUA),
1033 there are several possibilities:
1034
1035 .ilist
1036 If the process runs Exim with the &%-bm%& option, the message is read
1037 non-interactively (usually via a pipe), with the recipients taken from the
1038 command line, or from the body of the message if &%-t%& is also used.
1039 .next
1040 If the process runs Exim with the &%-bS%& option, the message is also read
1041 non-interactively, but in this case the recipients are listed at the start of
1042 the message in a series of SMTP RCPT commands, terminated by a DATA
1043 command. This is called &"batch SMTP"& format,
1044 but it isn't really SMTP. The SMTP commands are just another way of passing
1045 envelope addresses in a non-interactive submission.
1046 .next
1047 If the process runs Exim with the &%-bs%& option, the message is read
1048 interactively, using the SMTP protocol. A two-way pipe is normally used for
1049 passing data between the local process and the Exim process.
1050 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1051 example, the ACLs for SMTP commands are used for this form of submission.
1052 .next
1053 A local process may also make a TCP/IP call to the host's loopback address
1054 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1055 does not treat the loopback address specially. It treats all such connections
1056 in the same way as connections from other hosts.
1057 .endlist
1058
1059
1060 .cindex "message sender, constructed by Exim"
1061 .cindex "sender" "constructed by Exim"
1062 In the three cases that do not involve TCP/IP, the sender address is
1063 constructed from the login name of the user that called Exim and a default
1064 qualification domain (which can be set by the &%qualify_domain%& configuration
1065 option). For local or batch SMTP, a sender address that is passed using the
1066 SMTP MAIL command is ignored. However, the system administrator may allow
1067 certain users (&"trusted users"&) to specify a different sender addresses
1068 unconditionally, or all users to specify certain forms of different sender
1069 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1070 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1071 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1072 users to change sender addresses.
1073
1074 Messages received by either of the non-interactive mechanisms are subject to
1075 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1076 (either over TCP/IP or interacting with a local process) can be checked by a
1077 number of ACLs that operate at different times during the SMTP session. Either
1078 individual recipients or the entire message can be rejected if local policy
1079 requirements are not met. The &[local_scan()]& function (see chapter
1080 &<<CHAPlocalscan>>&) is run for all incoming messages.
1081
1082 Exim can be configured not to start a delivery process when a message is
1083 received; this can be unconditional, or depend on the number of incoming SMTP
1084 connections or the system load. In these situations, new messages wait on the
1085 queue until a queue runner process picks them up. However, in standard
1086 configurations under normal conditions, delivery is started as soon as a
1087 message is received.
1088
1089
1090
1091
1092
1093 .section "Handling an incoming message" "SECID14"
1094 .cindex "spool directory" "files that hold a message"
1095 .cindex "file" "how a message is held"
1096 When Exim accepts a message, it writes two files in its spool directory. The
1097 first contains the envelope information, the current status of the message, and
1098 the header lines, and the second contains the body of the message. The names of
1099 the two spool files consist of the message id, followed by &`-H`& for the
1100 file containing the envelope and header, and &`-D`& for the data file.
1101
1102 .cindex "spool directory" "&_input_& sub-directory"
1103 By default, all these message files are held in a single directory called
1104 &_input_& inside the general Exim spool directory. Some operating systems do
1105 not perform very well if the number of files in a directory gets large; to
1106 improve performance in such cases, the &%split_spool_directory%& option can be
1107 used. This causes Exim to split up the input files into 62 sub-directories
1108 whose names are single letters or digits. When this is done, the queue is
1109 processed one sub-directory at a time instead of all at once, which can improve
1110 overall performance even when there are not enough files in each directory to
1111 affect file system performance.
1112
1113 The envelope information consists of the address of the message's sender and
1114 the addresses of the recipients. This information is entirely separate from
1115 any addresses contained in the header lines. The status of the message includes
1116 a list of recipients who have already received the message. The format of the
1117 first spool file is described in chapter &<<CHAPspool>>&.
1118
1119 .cindex "rewriting" "addresses"
1120 Address rewriting that is specified in the rewrite section of the configuration
1121 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1122 both in the header lines and the envelope, at the time the message is accepted.
1123 If during the course of delivery additional addresses are generated (for
1124 example, via aliasing), these new addresses are rewritten as soon as they are
1125 generated. At the time a message is actually delivered (transported) further
1126 rewriting can take place; because this is a transport option, it can be
1127 different for different forms of delivery. It is also possible to specify the
1128 addition or removal of certain header lines at the time the message is
1129 delivered (see chapters &<<CHAProutergeneric>>& and
1130 &<<CHAPtransportgeneric>>&).
1131
1132
1133
1134 .section "Life of a message" "SECID15"
1135 .cindex "message" "life of"
1136 .cindex "message" "frozen"
1137 A message remains in the spool directory until it is completely delivered to
1138 its recipients or to an error address, or until it is deleted by an
1139 administrator or by the user who originally created it. In cases when delivery
1140 cannot proceed &-- for example when a message can neither be delivered to its
1141 recipients nor returned to its sender, the message is marked &"frozen"& on the
1142 spool, and no more deliveries are attempted.
1143
1144 .cindex "frozen messages" "thawing"
1145 .cindex "message" "thawing frozen"
1146 An administrator can &"thaw"& such messages when the problem has been
1147 corrected, and can also freeze individual messages by hand if necessary. In
1148 addition, an administrator can force a delivery error, causing a bounce message
1149 to be sent.
1150
1151 .oindex "&%timeout_frozen_after%&"
1152 .oindex "&%ignore_bounce_errors_after%&"
1153 There are options called &%ignore_bounce_errors_after%& and
1154 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1155 The first applies only to frozen bounces, the second to all frozen messages.
1156
1157 .cindex "message" "log file for"
1158 .cindex "log" "file for each message"
1159 While Exim is working on a message, it writes information about each delivery
1160 attempt to its main log file. This includes successful, unsuccessful, and
1161 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1162 lines are also written to a separate &'message log'& file for each message.
1163 These logs are solely for the benefit of the administrator and are normally
1164 deleted along with the spool files when processing of a message is complete.
1165 The use of individual message logs can be disabled by setting
1166 &%no_message_logs%&; this might give an improvement in performance on very busy
1167 systems.
1168
1169 .cindex "journal file"
1170 .cindex "file" "journal"
1171 All the information Exim itself needs to set up a delivery is kept in the first
1172 spool file, along with the header lines. When a successful delivery occurs, the
1173 address is immediately written at the end of a journal file, whose name is the
1174 message id followed by &`-J`&. At the end of a delivery run, if there are some
1175 addresses left to be tried again later, the first spool file (the &`-H`& file)
1176 is updated to indicate which these are, and the journal file is then deleted.
1177 Updating the spool file is done by writing a new file and renaming it, to
1178 minimize the possibility of data loss.
1179
1180 Should the system or Exim crash after a successful delivery but before
1181 the spool file has been updated, the journal is left lying around. The next
1182 time Exim attempts to deliver the message, it reads the journal file and
1183 updates the spool file before proceeding. This minimizes the chances of double
1184 deliveries caused by crashes.
1185
1186
1187
1188 .section "Processing an address for delivery" "SECTprocaddress"
1189 .cindex "drivers" "definition of"
1190 .cindex "router" "definition of"
1191 .cindex "transport" "definition of"
1192 The main delivery processing elements of Exim are called &'routers'& and
1193 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1194 number of them is provided in the source distribution, and compile-time options
1195 specify which ones are included in the binary. Runtime options specify which
1196 ones are actually used for delivering messages.
1197
1198 .cindex "drivers" "instance definition"
1199 Each driver that is specified in the runtime configuration is an &'instance'&
1200 of that particular driver type. Multiple instances are allowed; for example,
1201 you can set up several different &(smtp)& transports, each with different
1202 option values that might specify different ports or different timeouts. Each
1203 instance has its own identifying name. In what follows we will normally use the
1204 instance name when discussing one particular instance (that is, one specific
1205 configuration of the driver), and the generic driver name when discussing
1206 the driver's features in general.
1207
1208 A &'router'& is a driver that operates on an address, either determining how
1209 its delivery should happen, by assigning it to a specific transport, or
1210 converting the address into one or more new addresses (for example, via an
1211 alias file). A router may also explicitly choose to fail an address, causing it
1212 to be bounced.
1213
1214 A &'transport'& is a driver that transmits a copy of the message from Exim's
1215 spool to some destination. There are two kinds of transport: for a &'local'&
1216 transport, the destination is a file or a pipe on the local host, whereas for a
1217 &'remote'& transport the destination is some other host. A message is passed
1218 to a specific transport as a result of successful routing. If a message has
1219 several recipients, it may be passed to a number of different transports.
1220
1221 .cindex "preconditions" "definition of"
1222 An address is processed by passing it to each configured router instance in
1223 turn, subject to certain preconditions, until a router accepts the address or
1224 specifies that it should be bounced. We will describe this process in more
1225 detail shortly. First, as a simple example, we consider how each recipient
1226 address in a message is processed in a small configuration of three routers.
1227
1228 To make this a more concrete example, it is described in terms of some actual
1229 routers, but remember, this is only an example. You can configure Exim's
1230 routers in many different ways, and there may be any number of routers in a
1231 configuration.
1232
1233 The first router that is specified in a configuration is often one that handles
1234 addresses in domains that are not recognized specifically by the local host.
1235 Typically these are addresses for arbitrary domains on the Internet. A precondition
1236 is set up which looks for the special domains known to the host (for example,
1237 its own domain name), and the router is run for addresses that do &'not'&
1238 match. Typically, this is a router that looks up domains in the DNS in order to
1239 find the hosts to which this address routes. If it succeeds, the address is
1240 assigned to a suitable SMTP transport; if it does not succeed, the router is
1241 configured to fail the address.
1242
1243 The second router is reached only when the domain is recognized as one that
1244 &"belongs"& to the local host. This router does redirection &-- also known as
1245 aliasing and forwarding. When it generates one or more new addresses from the
1246 original, each of them is routed independently from the start. Otherwise, the
1247 router may cause an address to fail, or it may simply decline to handle the
1248 address, in which case the address is passed to the next router.
1249
1250 The final router in many configurations is one that checks to see if the
1251 address belongs to a local mailbox. The precondition may involve a check to
1252 see if the local part is the name of a login account, or it may look up the
1253 local part in a file or a database. If its preconditions are not met, or if
1254 the router declines, we have reached the end of the routers. When this happens,
1255 the address is bounced.
1256
1257
1258
1259 .section "Processing an address for verification" "SECID16"
1260 .cindex "router" "for verification"
1261 .cindex "verifying address" "overview"
1262 As well as being used to decide how to deliver to an address, Exim's routers
1263 are also used for &'address verification'&. Verification can be requested as
1264 one of the checks to be performed in an ACL for incoming messages, on both
1265 sender and recipient addresses, and it can be tested using the &%-bv%& and
1266 &%-bvs%& command line options.
1267
1268 When an address is being verified, the routers are run in &"verify mode"&. This
1269 does not affect the way the routers work, but it is a state that can be
1270 detected. By this means, a router can be skipped or made to behave differently
1271 when verifying. A common example is a configuration in which the first router
1272 sends all messages to a message-scanning program unless they have been
1273 previously scanned. Thus, the first router accepts all addresses without any
1274 checking, making it useless for verifying. Normally, the &%no_verify%& option
1275 would be set for such a router, causing it to be skipped in verify mode.
1276
1277
1278
1279
1280 .section "Running an individual router" "SECTrunindrou"
1281 .cindex "router" "running details"
1282 .cindex "preconditions" "checking"
1283 .cindex "router" "result of running"
1284 As explained in the example above, a number of preconditions are checked before
1285 running a router. If any are not met, the router is skipped, and the address is
1286 passed to the next router. When all the preconditions on a router &'are'& met,
1287 the router is run. What happens next depends on the outcome, which is one of
1288 the following:
1289
1290 .ilist
1291 &'accept'&: The router accepts the address, and either assigns it to a
1292 transport or generates one or more &"child"& addresses. Processing the
1293 original address ceases
1294 .oindex "&%unseen%&"
1295 unless the &%unseen%& option is set on the router. This option
1296 can be used to set up multiple deliveries with different routing (for example,
1297 for keeping archive copies of messages). When &%unseen%& is set, the address is
1298 passed to the next router. Normally, however, an &'accept'& return marks the
1299 end of routing.
1300
1301 Any child addresses generated by the router are processed independently,
1302 starting with the first router by default. It is possible to change this by
1303 setting the &%redirect_router%& option to specify which router to start at for
1304 child addresses. Unlike &%pass_router%& (see below) the router specified by
1305 &%redirect_router%& may be anywhere in the router configuration.
1306 .next
1307 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1308 requests that the address be passed to another router. By default, the address
1309 is passed to the next router, but this can be changed by setting the
1310 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1311 must be below the current router (to avoid loops).
1312 .next
1313 &'decline'&: The router declines to accept the address because it does not
1314 recognize it at all. By default, the address is passed to the next router, but
1315 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1316 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1317 &'decline'& into &'fail'&.
1318 .next
1319 &'fail'&: The router determines that the address should fail, and queues it for
1320 the generation of a bounce message. There is no further processing of the
1321 original address unless &%unseen%& is set on the router.
1322 .next
1323 &'defer'&: The router cannot handle the address at the present time. (A
1324 database may be offline, or a DNS lookup may have timed out.) No further
1325 processing of the address happens in this delivery attempt. It is tried again
1326 next time the message is considered for delivery.
1327 .next
1328 &'error'&: There is some error in the router (for example, a syntax error in
1329 its configuration). The action is as for defer.
1330 .endlist
1331
1332 If an address reaches the end of the routers without having been accepted by
1333 any of them, it is bounced as unrouteable. The default error message in this
1334 situation is &"unrouteable address"&, but you can set your own message by
1335 making use of the &%cannot_route_message%& option. This can be set for any
1336 router; the value from the last router that &"saw"& the address is used.
1337
1338 Sometimes while routing you want to fail a delivery when some conditions are
1339 met but others are not, instead of passing the address on for further routing.
1340 You can do this by having a second router that explicitly fails the delivery
1341 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1342 facility for this purpose.
1343
1344
1345 .section "Duplicate addresses" "SECID17"
1346 .cindex "case of local parts"
1347 .cindex "address duplicate, discarding"
1348 .cindex "duplicate addresses"
1349 Once routing is complete, Exim scans the addresses that are assigned to local
1350 and remote transports and discards any duplicates that it finds. During this
1351 check, local parts are treated case-sensitively. This happens only when
1352 actually delivering a message; when testing routers with &%-bt%&, all the
1353 routed addresses are shown.
1354
1355
1356
1357 .section "Router preconditions" "SECTrouprecon"
1358 .cindex "router" "preconditions, order of processing"
1359 .cindex "preconditions" "order of processing"
1360 The preconditions that are tested for each router are listed below, in the
1361 order in which they are tested. The individual configuration options are
1362 described in more detail in chapter &<<CHAProutergeneric>>&.
1363
1364 .ilist
1365 .cindex affix "router precondition"
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 .cindex affix "router precondition"
1403 If the &%local_parts%& option is set, the local part of the address must be in
1404 the set of local parts that it defines. If &%local_part_prefix%& or
1405 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1406 part before this check. If you want to do precondition tests on local parts
1407 that include affixes, you can do so by using a &%condition%& option (see below)
1408 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1409 &$local_part_suffix$& as necessary.
1410 .next
1411 .vindex "&$local_user_uid$&"
1412 .vindex "&$local_user_gid$&"
1413 .vindex "&$home$&"
1414 If the &%check_local_user%& option is set, the local part must be the name of
1415 an account on the local host. If this check succeeds, the uid and gid of the
1416 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1417 user's home directory is placed in &$home$&; these values can be used in the
1418 remaining preconditions.
1419 .next
1420 If the &%router_home_directory%& option is set, it is expanded at this point,
1421 because it overrides the value of &$home$&. If this expansion were left till
1422 later, the value of &$home$& as set by &%check_local_user%& would be used in
1423 subsequent tests. Having two different values of &$home$& in the same router
1424 could lead to confusion.
1425 .next
1426 If the &%senders%& option is set, the envelope sender address must be in the
1427 set of addresses that it defines.
1428 .next
1429 If the &%require_files%& option is set, the existence or non-existence of
1430 specified files is tested.
1431 .next
1432 .cindex "customizing" "precondition"
1433 If the &%condition%& option is set, it is evaluated and tested. This option
1434 uses an expanded string to allow you to set up your own custom preconditions.
1435 Expanded strings are described in chapter &<<CHAPexpand>>&.
1436 .endlist
1437
1438
1439 Note that &%require_files%& comes near the end of the list, so you cannot use
1440 it to check for the existence of a file in which to lookup up a domain, local
1441 part, or sender. However, as these options are all expanded, you can use the
1442 &%exists%& expansion condition to make such tests within each condition. The
1443 &%require_files%& option is intended for checking files that the router may be
1444 going to use internally, or which are needed by a specific transport (for
1445 example, &_.procmailrc_&).
1446
1447
1448
1449 .section "Delivery in detail" "SECID18"
1450 .cindex "delivery" "in detail"
1451 When a message is to be delivered, the sequence of events is as follows:
1452
1453 .ilist
1454 If a system-wide filter file is specified, the message is passed to it. The
1455 filter may add recipients to the message, replace the recipients, discard the
1456 message, cause a new message to be generated, or cause the message delivery to
1457 fail. The format of the system filter file is the same as for Exim user filter
1458 files, described in the separate document entitled &'Exim's interfaces to mail
1459 filtering'&.
1460 .cindex "Sieve filter" "not available for system filter"
1461 (&*Note*&: Sieve cannot be used for system filter files.)
1462
1463 Some additional features are available in system filters &-- see chapter
1464 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1465 filter only once per delivery attempt, however many recipients it has. However,
1466 if there are several delivery attempts because one or more addresses could not
1467 be immediately delivered, the system filter is run each time. The filter
1468 condition &%first_delivery%& can be used to detect the first run of the system
1469 filter.
1470 .next
1471 Each recipient address is offered to each configured router, in turn, subject to
1472 its preconditions, until one is able to handle it. If no router can handle the
1473 address, that is, if they all decline, the address is failed. Because routers
1474 can be targeted at particular domains, several locally handled domains can be
1475 processed entirely independently of each other.
1476 .next
1477 .cindex "routing" "loops in"
1478 .cindex "loop" "while routing"
1479 A router that accepts an address may assign it to a local or a remote
1480 transport. However, the transport is not run at this time. Instead, the address
1481 is placed on a list for the particular transport, which will be run later.
1482 Alternatively, the router may generate one or more new addresses (typically
1483 from alias, forward, or filter files). New addresses are fed back into this
1484 process from the top, but in order to avoid loops, a router ignores any address
1485 which has an identically-named ancestor that was processed by itself.
1486 .next
1487 When all the routing has been done, addresses that have been successfully
1488 handled are passed to their assigned transports. When local transports are
1489 doing real local deliveries, they handle only one address at a time, but if a
1490 local transport is being used as a pseudo-remote transport (for example, to
1491 collect batched SMTP messages for transmission by some other means) multiple
1492 addresses can be handled. Remote transports can always handle more than one
1493 address at a time, but can be configured not to do so, or to restrict multiple
1494 addresses to the same domain.
1495 .next
1496 Each local delivery to a file or a pipe runs in a separate process under a
1497 non-privileged uid, and these deliveries are run one at a time. Remote
1498 deliveries also run in separate processes, normally under a uid that is private
1499 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1500 run in parallel. The maximum number of simultaneous remote deliveries for any
1501 one message is set by the &%remote_max_parallel%& option.
1502 The order in which deliveries are done is not defined, except that all local
1503 deliveries happen before any remote deliveries.
1504 .next
1505 .cindex "queue runner"
1506 When it encounters a local delivery during a queue run, Exim checks its retry
1507 database to see if there has been a previous temporary delivery failure for the
1508 address before running the local transport. If there was a previous failure,
1509 Exim does not attempt a new delivery until the retry time for the address is
1510 reached. However, this happens only for delivery attempts that are part of a
1511 queue run. Local deliveries are always attempted when delivery immediately
1512 follows message reception, even if retry times are set for them. This makes for
1513 better behaviour if one particular message is causing problems (for example,
1514 causing quota overflow, or provoking an error in a filter file).
1515 .next
1516 .cindex "delivery" "retry in remote transports"
1517 Remote transports do their own retry handling, since an address may be
1518 deliverable to one of a number of hosts, each of which may have a different
1519 retry time. If there have been previous temporary failures and no host has
1520 reached its retry time, no delivery is attempted, whether in a queue run or
1521 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1522 .next
1523 If there were any permanent errors, a bounce message is returned to an
1524 appropriate address (the sender in the common case), with details of the error
1525 for each failing address. Exim can be configured to send copies of bounce
1526 messages to other addresses.
1527 .next
1528 .cindex "delivery" "deferral"
1529 If one or more addresses suffered a temporary failure, the message is left on
1530 the queue, to be tried again later. Delivery of these addresses is said to be
1531 &'deferred'&.
1532 .next
1533 When all the recipient addresses have either been delivered or bounced,
1534 handling of the message is complete. The spool files and message log are
1535 deleted, though the message log can optionally be preserved if required.
1536 .endlist
1537
1538
1539
1540
1541 .section "Retry mechanism" "SECID19"
1542 .cindex "delivery" "retry mechanism"
1543 .cindex "retry" "description of mechanism"
1544 .cindex "queue runner"
1545 Exim's mechanism for retrying messages that fail to get delivered at the first
1546 attempt is the queue runner process. You must either run an Exim daemon that
1547 uses the &%-q%& option with a time interval to start queue runners at regular
1548 intervals or use some other means (such as &'cron'&) to start them. If you do
1549 not arrange for queue runners to be run, messages that fail temporarily at the
1550 first attempt will remain in your queue forever. A queue runner process works
1551 its way through the queue, one message at a time, trying each delivery that has
1552 passed its retry time.
1553 You can run several queue runners at once.
1554
1555 Exim uses a set of configured rules to determine when next to retry the failing
1556 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1557 should give up trying to deliver to the address, at which point it generates a
1558 bounce message. If no retry rules are set for a particular host, address, and
1559 error combination, no retries are attempted, and temporary errors are treated
1560 as permanent.
1561
1562
1563
1564 .section "Temporary delivery failure" "SECID20"
1565 .cindex "delivery" "temporary failure"
1566 There are many reasons why a message may not be immediately deliverable to a
1567 particular address. Failure to connect to a remote machine (because it, or the
1568 connection to it, is down) is one of the most common. Temporary failures may be
1569 detected during routing as well as during the transport stage of delivery.
1570 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1571 is on a file system where the user is over quota. Exim can be configured to
1572 impose its own quotas on local mailboxes; where system quotas are set they will
1573 also apply.
1574
1575 If a host is unreachable for a period of time, a number of messages may be
1576 waiting for it by the time it recovers, and sending them in a single SMTP
1577 connection is clearly beneficial. Whenever a delivery to a remote host is
1578 deferred,
1579 .cindex "hints database" "deferred deliveries"
1580 Exim makes a note in its hints database, and whenever a successful
1581 SMTP delivery has happened, it looks to see if any other messages are waiting
1582 for the same host. If any are found, they are sent over the same SMTP
1583 connection, subject to a configuration limit as to the maximum number in any
1584 one connection.
1585
1586
1587
1588 .section "Permanent delivery failure" "SECID21"
1589 .cindex "delivery" "permanent failure"
1590 .cindex "bounce message" "when generated"
1591 When a message cannot be delivered to some or all of its intended recipients, a
1592 bounce message is generated. Temporary delivery failures turn into permanent
1593 errors when their timeout expires. All the addresses that fail in a given
1594 delivery attempt are listed in a single message. If the original message has
1595 many recipients, it is possible for some addresses to fail in one delivery
1596 attempt and others to fail subsequently, giving rise to more than one bounce
1597 message. The wording of bounce messages can be customized by the administrator.
1598 See chapter &<<CHAPemsgcust>>& for details.
1599
1600 .cindex "&'X-Failed-Recipients:'& header line"
1601 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1602 failed addresses, for the benefit of programs that try to analyse such messages
1603 automatically.
1604
1605 .cindex "bounce message" "recipient of"
1606 A bounce message is normally sent to the sender of the original message, as
1607 obtained from the message's envelope. For incoming SMTP messages, this is the
1608 address given in the MAIL command. However, when an address is expanded via a
1609 forward or alias file, an alternative address can be specified for delivery
1610 failures of the generated addresses. For a mailing list expansion (see section
1611 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1612 of the list.
1613
1614
1615
1616 .section "Failures to deliver bounce messages" "SECID22"
1617 .cindex "bounce message" "failure to deliver"
1618 If a bounce message (either locally generated or received from a remote host)
1619 itself suffers a permanent delivery failure, the message is left in the queue,
1620 but it is frozen, awaiting the attention of an administrator. There are options
1621 that can be used to make Exim discard such failed messages, or to keep them
1622 for only a short time (see &%timeout_frozen_after%& and
1623 &%ignore_bounce_errors_after%&).
1624
1625
1626
1627
1628
1629 . ////////////////////////////////////////////////////////////////////////////
1630 . ////////////////////////////////////////////////////////////////////////////
1631
1632 .chapter "Building and installing Exim" "CHID3"
1633 .scindex IIDbuex "building Exim"
1634
1635 .section "Unpacking" "SECID23"
1636 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1637 creates a directory with the name of the current release (for example,
1638 &_exim-&version()_&) into which the following files are placed:
1639
1640 .table2 140pt
1641 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1642 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1643   documented"
1644 .irow &_LICENCE_&         "the GNU General Public Licence"
1645 .irow &_Makefile_&        "top-level make file"
1646 .irow &_NOTICE_&          "conditions for the use of Exim"
1647 .irow &_README_&          "list of files, directories and simple build &&&
1648   instructions"
1649 .endtable
1650
1651 Other files whose names begin with &_README_& may also be present. The
1652 following subdirectories are created:
1653
1654 .table2 140pt
1655 .irow &_Local_&           "an empty directory for local configuration files"
1656 .irow &_OS_&              "OS-specific files"
1657 .irow &_doc_&             "documentation files"
1658 .irow &_exim_monitor_&    "source files for the Exim monitor"
1659 .irow &_scripts_&         "scripts used in the build process"
1660 .irow &_src_&             "remaining source files"
1661 .irow &_util_&            "independent utilities"
1662 .endtable
1663
1664 The main utility programs are contained in the &_src_& directory and are built
1665 with the Exim binary. The &_util_& directory contains a few optional scripts
1666 that may be useful to some sites.
1667
1668
1669 .section "Multiple machine architectures and operating systems" "SECID24"
1670 .cindex "building Exim" "multiple OS/architectures"
1671 The building process for Exim is arranged to make it easy to build binaries for
1672 a number of different architectures and operating systems from the same set of
1673 source files. Compilation does not take place in the &_src_& directory.
1674 Instead, a &'build directory'& is created for each architecture and operating
1675 system.
1676 .cindex "symbolic link" "to build directory"
1677 Symbolic links to the sources are installed in this directory, which is where
1678 the actual building takes place. In most cases, Exim can discover the machine
1679 architecture and operating system for itself, but the defaults can be
1680 overridden if necessary.
1681 .cindex compiler requirements
1682 .cindex compiler version
1683 A C99-capable compiler will be required for the build.
1684
1685
1686 .section "PCRE library" "SECTpcre"
1687 .cindex "PCRE library"
1688 Exim no longer has an embedded PCRE library as the vast majority of
1689 modern systems include PCRE as a system library, although you may need to
1690 install the PCRE package or the PCRE development package for your operating
1691 system. If your system has a normal PCRE installation the Exim build
1692 process will need no further configuration. If the library or the
1693 headers are in an unusual location you will need to either set the PCRE_LIBS
1694 and INCLUDE directives appropriately,
1695 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1696 If your operating system has no
1697 PCRE support then you will need to obtain and build the current PCRE
1698 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1699 More information on PCRE is available at &url(https://www.pcre.org/).
1700
1701 .section "DBM libraries" "SECTdb"
1702 .cindex "DBM libraries" "discussion of"
1703 .cindex "hints database" "DBM files used for"
1704 Even if you do not use any DBM files in your configuration, Exim still needs a
1705 DBM library in order to operate, because it uses indexed files for its hints
1706 databases. Unfortunately, there are a number of DBM libraries in existence, and
1707 different operating systems often have different ones installed.
1708
1709 .cindex "Solaris" "DBM library for"
1710 .cindex "IRIX, DBM library for"
1711 .cindex "BSD, DBM library for"
1712 .cindex "Linux, DBM library for"
1713 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1714 Linux distribution, the DBM configuration should happen automatically, and you
1715 may be able to ignore this section. Otherwise, you may have to learn more than
1716 you would like about DBM libraries from what follows.
1717
1718 .cindex "&'ndbm'& DBM library"
1719 Licensed versions of Unix normally contain a library of DBM functions operating
1720 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1721 versions of Unix seem to vary in what they contain as standard. In particular,
1722 some early versions of Linux have no default DBM library, and different
1723 distributors have chosen to bundle different libraries with their packaged
1724 versions. However, the more recent releases seem to have standardized on the
1725 Berkeley DB library.
1726
1727 Different DBM libraries have different conventions for naming the files they
1728 use. When a program opens a file called &_dbmfile_&, there are several
1729 possibilities:
1730
1731 .olist
1732 A traditional &'ndbm'& implementation, such as that supplied as part of
1733 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1734 .next
1735 .cindex "&'gdbm'& DBM library"
1736 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1737 compatibility interface it makes two different hard links to it with names
1738 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1739 filename is used unmodified.
1740 .next
1741 .cindex "Berkeley DB library"
1742 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1743 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1744 programmer exactly the same as the traditional &'ndbm'& implementation.
1745 .next
1746 If the Berkeley package is used in its native mode, it operates on a single
1747 file called &_dbmfile_&; the programmer's interface is somewhat different to
1748 the traditional &'ndbm'& interface.
1749 .next
1750 To complicate things further, there are several very different versions of the
1751 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1752 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1753 Maintenance of some of the earlier releases has ceased. All versions of
1754 Berkeley DB could be obtained from
1755 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1756 page with far newer versions listed.
1757 It is probably wise to plan to move your storage configurations away from
1758 Berkeley DB format, as today there are smaller and simpler alternatives more
1759 suited to Exim's usage model.
1760 .next
1761 .cindex "&'tdb'& DBM library"
1762 Yet another DBM library, called &'tdb'&, is available from
1763 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1764 operates on a single file.
1765 .endlist
1766
1767 .cindex "USE_DB"
1768 .cindex "DBM libraries" "configuration for building"
1769 Exim and its utilities can be compiled to use any of these interfaces. In order
1770 to use any version of the Berkeley DB package in native mode, you must set
1771 USE_DB in an appropriate configuration file (typically
1772 &_Local/Makefile_&). For example:
1773 .code
1774 USE_DB=yes
1775 .endd
1776 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1777 error is diagnosed if you set more than one of these.
1778
1779 At the lowest level, the build-time configuration sets none of these options,
1780 thereby assuming an interface of type (1). However, some operating system
1781 configuration files (for example, those for the BSD operating systems and
1782 Linux) assume type (4) by setting USE_DB as their default, and the
1783 configuration files for Cygwin set USE_GDBM. Anything you set in
1784 &_Local/Makefile_&, however, overrides these system defaults.
1785
1786 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1787 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1788 in one of these lines:
1789 .code
1790 DBMLIB = -ldb
1791 DBMLIB = -ltdb
1792 .endd
1793 Settings like that will work if the DBM library is installed in the standard
1794 place. Sometimes it is not, and the library's header file may also not be in
1795 the default path. You may need to set INCLUDE to specify where the header
1796 file is, and to specify the path to the library more fully in DBMLIB, as in
1797 this example:
1798 .code
1799 INCLUDE=-I/usr/local/include/db-4.1
1800 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1801 .endd
1802 There is further detailed discussion about the various DBM libraries in the
1803 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1804
1805
1806
1807 .section "Pre-building configuration" "SECID25"
1808 .cindex "building Exim" "pre-building configuration"
1809 .cindex "configuration for building Exim"
1810 .cindex "&_Local/Makefile_&"
1811 .cindex "&_src/EDITME_&"
1812 Before building Exim, a local configuration file that specifies options
1813 independent of any operating system has to be created with the name
1814 &_Local/Makefile_&. A template for this file is supplied as the file
1815 &_src/EDITME_&, and it contains full descriptions of all the option settings
1816 therein. These descriptions are therefore not repeated here. If you are
1817 building Exim for the first time, the simplest thing to do is to copy
1818 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1819
1820 There are three settings that you must supply, because Exim will not build
1821 without them. They are the location of the runtime configuration file
1822 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1823 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1824 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1825 a colon-separated list of filenames; Exim uses the first of them that exists.
1826
1827 There are a few other parameters that can be specified either at build time or
1828 at runtime, to enable the same binary to be used on a number of different
1829 machines. However, if the locations of Exim's spool directory and log file
1830 directory (if not within the spool directory) are fixed, it is recommended that
1831 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1832 detected early in Exim's execution (such as a malformed configuration file) can
1833 be logged.
1834
1835 .cindex "content scanning" "specifying at build time"
1836 Exim's interfaces for calling virus and spam scanning software directly from
1837 access control lists are not compiled by default. If you want to include these
1838 facilities, you need to set
1839 .code
1840 WITH_CONTENT_SCAN=yes
1841 .endd
1842 in your &_Local/Makefile_&. For details of the facilities themselves, see
1843 chapter &<<CHAPexiscan>>&.
1844
1845
1846 .cindex "&_Local/eximon.conf_&"
1847 .cindex "&_exim_monitor/EDITME_&"
1848 If you are going to build the Exim monitor, a similar configuration process is
1849 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1850 your installation and saved under the name &_Local/eximon.conf_&. If you are
1851 happy with the default settings described in &_exim_monitor/EDITME_&,
1852 &_Local/eximon.conf_& can be empty, but it must exist.
1853
1854 This is all the configuration that is needed in straightforward cases for known
1855 operating systems. However, the building process is set up so that it is easy
1856 to override options that are set by default or by operating-system-specific
1857 configuration files, for example, to change the C compiler, which
1858 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1859 do this.
1860
1861
1862
1863 .section "Support for iconv()" "SECID26"
1864 .cindex "&[iconv()]& support"
1865 .cindex "RFC 2047"
1866 The contents of header lines in messages may be encoded according to the rules
1867 described RFC 2047. This makes it possible to transmit characters that are not
1868 in the ASCII character set, and to label them as being in a particular
1869 character set. When Exim is inspecting header lines by means of the &%$h_%&
1870 mechanism, it decodes them, and translates them into a specified character set
1871 (default is set at build time). The translation is possible only if the operating system
1872 supports the &[iconv()]& function.
1873
1874 However, some of the operating systems that supply &[iconv()]& do not support
1875 very many conversions. The GNU &%libiconv%& library (available from
1876 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1877 systems to remedy this deficiency, as well as on systems that do not supply
1878 &[iconv()]& at all. After installing &%libiconv%&, you should add
1879 .code
1880 HAVE_ICONV=yes
1881 .endd
1882 to your &_Local/Makefile_& and rebuild Exim.
1883
1884
1885
1886 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1887 .cindex "TLS" "including support for TLS"
1888 .cindex "encryption" "including support for"
1889 .cindex "SUPPORT_TLS"
1890 .cindex "OpenSSL" "building Exim with"
1891 .cindex "GnuTLS" "building Exim with"
1892 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1893 command as per RFC 2487. It can also support legacy clients that expect to
1894 start a TLS session immediately on connection to a non-standard port (see the
1895 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1896 line option).
1897
1898 If you want to build Exim with TLS support, you must first install either the
1899 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1900 implementing SSL.
1901
1902 If OpenSSL is installed, you should set
1903 .code
1904 SUPPORT_TLS=yes
1905 TLS_LIBS=-lssl -lcrypto
1906 .endd
1907 in &_Local/Makefile_&. You may also need to specify the locations of the
1908 OpenSSL library and include files. For example:
1909 .code
1910 SUPPORT_TLS=yes
1911 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1912 TLS_INCLUDE=-I/usr/local/openssl/include/
1913 .endd
1914 .cindex "pkg-config" "OpenSSL"
1915 If you have &'pkg-config'& available, then instead you can just use:
1916 .code
1917 SUPPORT_TLS=yes
1918 USE_OPENSSL_PC=openssl
1919 .endd
1920 .cindex "USE_GNUTLS"
1921 If GnuTLS is installed, you should set
1922 .code
1923 SUPPORT_TLS=yes
1924 USE_GNUTLS=yes
1925 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1926 .endd
1927 in &_Local/Makefile_&, and again you may need to specify the locations of the
1928 library and include files. For example:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1933 TLS_INCLUDE=-I/usr/gnu/include
1934 .endd
1935 .cindex "pkg-config" "GnuTLS"
1936 If you have &'pkg-config'& available, then instead you can just use:
1937 .code
1938 SUPPORT_TLS=yes
1939 USE_GNUTLS=yes
1940 USE_GNUTLS_PC=gnutls
1941 .endd
1942
1943 You do not need to set TLS_INCLUDE if the relevant directory is already
1944 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1945 given in chapter &<<CHAPTLS>>&.
1946
1947
1948
1949
1950 .section "Use of tcpwrappers" "SECID27"
1951
1952 .cindex "tcpwrappers, building Exim to support"
1953 .cindex "USE_TCP_WRAPPERS"
1954 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1955 .cindex "tcp_wrappers_daemon_name"
1956 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1957 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1958 alternative to Exim's own checking facilities for installations that are
1959 already making use of &'tcpwrappers'& for other purposes. To do this, you
1960 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1961 &_tcpd.h_& to be available at compile time, and also ensure that the library
1962 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1963 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1964 you might have
1965 .code
1966 USE_TCP_WRAPPERS=yes
1967 CFLAGS=-O -I/usr/local/include
1968 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1969 .endd
1970 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1971 files is &"exim"&. For example, the line
1972 .code
1973 exim : LOCAL  192.168.1.  .friendly.domain.example
1974 .endd
1975 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1976 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1977 All other connections are denied. The daemon name used by &'tcpwrappers'&
1978 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1979 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1980 configure file. Consult the &'tcpwrappers'& documentation for
1981 further details.
1982
1983
1984 .section "Including support for IPv6" "SECID28"
1985 .cindex "IPv6" "including support for"
1986 Exim contains code for use on systems that have IPv6 support. Setting
1987 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1988 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1989 where the IPv6 support is not fully integrated into the normal include and
1990 library files.
1991
1992 Two different types of DNS record for handling IPv6 addresses have been
1993 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1994 currently seen as the mainstream. Another record type called A6 was proposed
1995 as better than AAAA because it had more flexibility. However, it was felt to be
1996 over-complex, and its status was reduced to &"experimental"&.
1997 Exim used to
1998 have a compile option for including A6 record support but this has now been
1999 withdrawn.
2000
2001
2002
2003 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2004 .cindex "lookup modules"
2005 .cindex "dynamic modules"
2006 .cindex ".so building"
2007 On some platforms, Exim supports not compiling all lookup types directly into
2008 the main binary, instead putting some into external modules which can be loaded
2009 on demand.
2010 This permits packagers to build Exim with support for lookups with extensive
2011 library dependencies without requiring all users to install all of those
2012 dependencies.
2013 Most, but not all, lookup types can be built this way.
2014
2015 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2016 installed; Exim will only load modules from that directory, as a security
2017 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2018 for your OS; see &_OS/Makefile-Linux_& for an example.
2019 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2020 see &_src/EDITME_& for details.
2021
2022 Then, for each module to be loaded dynamically, define the relevant
2023 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2024 For example, this will build in lsearch but load sqlite and mysql support
2025 on demand:
2026 .code
2027 LOOKUP_LSEARCH=yes
2028 LOOKUP_SQLITE=2
2029 LOOKUP_MYSQL=2
2030 .endd
2031
2032
2033 .section "The building process" "SECID29"
2034 .cindex "build directory"
2035 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2036 created, run &'make'& at the top level. It determines the architecture and
2037 operating system types, and creates a build directory if one does not exist.
2038 For example, on a Sun system running Solaris 8, the directory
2039 &_build-SunOS5-5.8-sparc_& is created.
2040 .cindex "symbolic link" "to source files"
2041 Symbolic links to relevant source files are installed in the build directory.
2042
2043 If this is the first time &'make'& has been run, it calls a script that builds
2044 a make file inside the build directory, using the configuration files from the
2045 &_Local_& directory. The new make file is then passed to another instance of
2046 &'make'&. This does the real work, building a number of utility scripts, and
2047 then compiling and linking the binaries for the Exim monitor (if configured), a
2048 number of utility programs, and finally Exim itself. The command &`make
2049 makefile`& can be used to force a rebuild of the make file in the build
2050 directory, should this ever be necessary.
2051
2052 If you have problems building Exim, check for any comments there may be in the
2053 &_README_& file concerning your operating system, and also take a look at the
2054 FAQ, where some common problems are covered.
2055
2056
2057
2058 .section 'Output from &"make"&' "SECID283"
2059 The output produced by the &'make'& process for compile lines is often very
2060 unreadable, because these lines can be very long. For this reason, the normal
2061 output is suppressed by default, and instead output similar to that which
2062 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2063 each module that is being compiled or linked. However, it is still possible to
2064 get the full output, by calling &'make'& like this:
2065 .code
2066 FULLECHO='' make -e
2067 .endd
2068 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2069 command reflection in &'make'&. When you ask for the full output, it is
2070 given in addition to the short output.
2071
2072
2073
2074 .section "Overriding build-time options for Exim" "SECToverride"
2075 .cindex "build-time options, overriding"
2076 The main make file that is created at the beginning of the building process
2077 consists of the concatenation of a number of files which set configuration
2078 values, followed by a fixed set of &'make'& instructions. If a value is set
2079 more than once, the last setting overrides any previous ones. This provides a
2080 convenient way of overriding defaults. The files that are concatenated are, in
2081 order:
2082 .display
2083 &_OS/Makefile-Default_&
2084 &_OS/Makefile-_&<&'ostype'&>
2085 &_Local/Makefile_&
2086 &_Local/Makefile-_&<&'ostype'&>
2087 &_Local/Makefile-_&<&'archtype'&>
2088 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2089 &_OS/Makefile-Base_&
2090 .endd
2091 .cindex "&_Local/Makefile_&"
2092 .cindex "building Exim" "operating system type"
2093 .cindex "building Exim" "architecture type"
2094 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2095 architecture type. &_Local/Makefile_& is required to exist, and the building
2096 process fails if it is absent. The other three &_Local_& files are optional,
2097 and are often not needed.
2098
2099 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2100 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2101 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2102 values are used, thereby providing a means of forcing particular settings.
2103 Otherwise, the scripts try to get values from the &%uname%& command. If this
2104 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2105 of &'ad hoc'& transformations are then applied, to produce the standard names
2106 that Exim expects. You can run these scripts directly from the shell in order
2107 to find out what values are being used on your system.
2108
2109
2110 &_OS/Makefile-Default_& contains comments about the variables that are set
2111 therein. Some (but not all) are mentioned below. If there is something that
2112 needs changing, review the contents of this file and the contents of the make
2113 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2114 default values are.
2115
2116
2117 .cindex "building Exim" "overriding default settings"
2118 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2119 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2120 need to change the original files. Instead, you should make the changes by
2121 putting the new values in an appropriate &_Local_& file. For example,
2122 .cindex "Tru64-Unix build-time settings"
2123 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2124 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2125 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2126 called with the option &%-std1%&, to make it recognize some of the features of
2127 Standard C that Exim uses. (Most other compilers recognize Standard C by
2128 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2129 containing the lines
2130 .code
2131 CC=cc
2132 CFLAGS=-std1
2133 .endd
2134 If you are compiling for just one operating system, it may be easier to put
2135 these lines directly into &_Local/Makefile_&.
2136
2137 Keeping all your local configuration settings separate from the distributed
2138 files makes it easy to transfer them to new versions of Exim simply by copying
2139 the contents of the &_Local_& directory.
2140
2141
2142 .cindex "NIS lookup type" "including support for"
2143 .cindex "NIS+ lookup type" "including support for"
2144 .cindex "LDAP" "including support for"
2145 .cindex "lookup" "inclusion in binary"
2146 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2147 lookup, but not all systems have these components installed, so the default is
2148 not to include the relevant code in the binary. All the different kinds of file
2149 and database lookup that Exim supports are implemented as separate code modules
2150 which are included only if the relevant compile-time options are set. In the
2151 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2152 .code
2153 LOOKUP_LDAP=yes
2154 LOOKUP_NIS=yes
2155 LOOKUP_NISPLUS=yes
2156 .endd
2157 and similar settings apply to the other lookup types. They are all listed in
2158 &_src/EDITME_&. In many cases the relevant include files and interface
2159 libraries need to be installed before compiling Exim.
2160 .cindex "cdb" "including support for"
2161 However, there are some optional lookup types (such as cdb) for which
2162 the code is entirely contained within Exim, and no external include
2163 files or libraries are required. When a lookup type is not included in the
2164 binary, attempts to configure Exim to use it cause runtime configuration
2165 errors.
2166
2167 .cindex "pkg-config" "lookups"
2168 .cindex "pkg-config" "authenticators"
2169 Many systems now use a tool called &'pkg-config'& to encapsulate information
2170 about how to compile against a library; Exim has some initial support for
2171 being able to use pkg-config for lookups and authenticators.  For any given
2172 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2173 variable with the &`_PC`& suffix in the name and assign as the value the
2174 name of the package to be queried.  The results of querying via the
2175 &'pkg-config'& command will be added to the appropriate Makefile variables
2176 with &`+=`& directives, so your version of &'make'& will need to support that
2177 syntax.  For instance:
2178 .code
2179 LOOKUP_SQLITE=yes
2180 LOOKUP_SQLITE_PC=sqlite3
2181 AUTH_GSASL=yes
2182 AUTH_GSASL_PC=libgsasl
2183 AUTH_HEIMDAL_GSSAPI=yes
2184 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2185 .endd
2186
2187 .cindex "Perl" "including support for"
2188 Exim can be linked with an embedded Perl interpreter, allowing Perl
2189 subroutines to be called during string expansion. To enable this facility,
2190 .code
2191 EXIM_PERL=perl.o
2192 .endd
2193 must be defined in &_Local/Makefile_&. Details of this facility are given in
2194 chapter &<<CHAPperl>>&.
2195
2196 .cindex "X11 libraries, location of"
2197 The location of the X11 libraries is something that varies a lot between
2198 operating systems, and there may be different versions of X11 to cope
2199 with. Exim itself makes no use of X11, but if you are compiling the Exim
2200 monitor, the X11 libraries must be available.
2201 The following three variables are set in &_OS/Makefile-Default_&:
2202 .code
2203 X11=/usr/X11R6
2204 XINCLUDE=-I$(X11)/include
2205 XLFLAGS=-L$(X11)/lib
2206 .endd
2207 These are overridden in some of the operating-system configuration files. For
2208 example, in &_OS/Makefile-SunOS5_& there is
2209 .code
2210 X11=/usr/openwin
2211 XINCLUDE=-I$(X11)/include
2212 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2213 .endd
2214 If you need to override the default setting for your operating system, place a
2215 definition of all three of these variables into your
2216 &_Local/Makefile-<ostype>_& file.
2217
2218 .cindex "EXTRALIBS"
2219 If you need to add any extra libraries to the link steps, these can be put in a
2220 variable called EXTRALIBS, which appears in all the link commands, but by
2221 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2222 command for linking the main Exim binary, and not for any associated utilities.
2223
2224 .cindex "DBM libraries" "configuration for building"
2225 There is also DBMLIB, which appears in the link commands for binaries that
2226 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2227 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2228 binary, and which can be used, for example, to include additional X11
2229 libraries.
2230
2231 .cindex "configuration file" "editing"
2232 The make file copes with rebuilding Exim correctly if any of the configuration
2233 files are edited. However, if an optional configuration file is deleted, it is
2234 necessary to touch the associated non-optional file (that is,
2235 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2236
2237
2238 .section "OS-specific header files" "SECID30"
2239 .cindex "&_os.h_&"
2240 .cindex "building Exim" "OS-specific C header files"
2241 The &_OS_& directory contains a number of files with names of the form
2242 &_os.h-<ostype>_&. These are system-specific C header files that should not
2243 normally need to be changed. There is a list of macro settings that are
2244 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2245 are porting Exim to a new operating system.
2246
2247
2248
2249 .section "Overriding build-time options for the monitor" "SECID31"
2250 .cindex "building Eximon"
2251 A similar process is used for overriding things when building the Exim monitor,
2252 where the files that are involved are
2253 .display
2254 &_OS/eximon.conf-Default_&
2255 &_OS/eximon.conf-_&<&'ostype'&>
2256 &_Local/eximon.conf_&
2257 &_Local/eximon.conf-_&<&'ostype'&>
2258 &_Local/eximon.conf-_&<&'archtype'&>
2259 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2260 .endd
2261 .cindex "&_Local/eximon.conf_&"
2262 As with Exim itself, the final three files need not exist, and in this case the
2263 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2264 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2265 variables of the same name, preceded by EXIMON_. For example, setting
2266 EXIMON_LOG_DEPTH in the environment overrides the value of
2267 LOG_DEPTH at runtime.
2268 .ecindex IIDbuex
2269
2270
2271 .section "Installing Exim binaries and scripts" "SECID32"
2272 .cindex "installing Exim"
2273 .cindex "BIN_DIRECTORY"
2274 The command &`make install`& runs the &(exim_install)& script with no
2275 arguments. The script copies binaries and utility scripts into the directory
2276 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2277 .cindex "setuid" "installing Exim with"
2278 The install script copies files only if they are newer than the files they are
2279 going to replace. The Exim binary is required to be owned by root and have the
2280 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2281 install`& as root so that it can set up the Exim binary in this way. However, in
2282 some special situations (for example, if a host is doing no local deliveries)
2283 it may be possible to run Exim without making the binary setuid root (see
2284 chapter &<<CHAPsecurity>>& for details).
2285
2286 .cindex "CONFIGURE_FILE"
2287 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2288 in &_Local/Makefile_&. If this names a single file, and the file does not
2289 exist, the default configuration file &_src/configure.default_& is copied there
2290 by the installation script. If a runtime configuration file already exists, it
2291 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2292 alternative files, no default is installed.
2293
2294 .cindex "system aliases file"
2295 .cindex "&_/etc/aliases_&"
2296 One change is made to the default configuration file when it is installed: the
2297 default configuration contains a router that references a system aliases file.
2298 The path to this file is set to the value specified by
2299 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2300 If the system aliases file does not exist, the installation script creates it,
2301 and outputs a comment to the user.
2302
2303 The created file contains no aliases, but it does contain comments about the
2304 aliases a site should normally have. Mail aliases have traditionally been
2305 kept in &_/etc/aliases_&. However, some operating systems are now using
2306 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2307 Exim's configuration if necessary.
2308
2309 The default configuration uses the local host's name as the only local domain,
2310 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2311 running as the local user. System aliases and &_.forward_& files in users' home
2312 directories are supported, but no NIS or NIS+ support is configured. Domains
2313 other than the name of the local host are routed using the DNS, with delivery
2314 over SMTP.
2315
2316 It is possible to install Exim for special purposes (such as building a binary
2317 distribution) in a private part of the file system. You can do this by a
2318 command such as
2319 .code
2320 make DESTDIR=/some/directory/ install
2321 .endd
2322 This has the effect of pre-pending the specified directory to all the file
2323 paths, except the name of the system aliases file that appears in the default
2324 configuration. (If a default alias file is created, its name &'is'& modified.)
2325 For backwards compatibility, ROOT is used if DESTDIR is not set,
2326 but this usage is deprecated.
2327
2328 .cindex "installing Exim" "what is not installed"
2329 Running &'make install'& does not copy the Exim 4 conversion script
2330 &'convert4r4'&. You will probably run this only once if you are
2331 upgrading from Exim 3. None of the documentation files in the &_doc_&
2332 directory are copied, except for the info files when you have set
2333 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2334
2335 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2336 to their names. The Exim binary itself, however, is handled differently. It is
2337 installed under a name that includes the version number and the compile number,
2338 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2339 called &_exim_& to point to the binary. If you are updating a previous version
2340 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2341 from the directory (as seen by other processes).
2342
2343 .cindex "installing Exim" "testing the script"
2344 If you want to see what the &'make install'& will do before running it for
2345 real, you can pass the &%-n%& option to the installation script by this
2346 command:
2347 .code
2348 make INSTALL_ARG=-n install
2349 .endd
2350 The contents of the variable INSTALL_ARG are passed to the installation
2351 script. You do not need to be root to run this test. Alternatively, you can run
2352 the installation script directly, but this must be from within the build
2353 directory. For example, from the top-level Exim directory you could use this
2354 command:
2355 .code
2356 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2357 .endd
2358 .cindex "installing Exim" "install script options"
2359 There are two other options that can be supplied to the installation script.
2360
2361 .ilist
2362 &%-no_chown%& bypasses the call to change the owner of the installed binary
2363 to root, and the call to make it a setuid binary.
2364 .next
2365 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2366 installed binary.
2367 .endlist
2368
2369 INSTALL_ARG can be used to pass these options to the script. For example:
2370 .code
2371 make INSTALL_ARG=-no_symlink install
2372 .endd
2373 The installation script can also be given arguments specifying which files are
2374 to be copied. For example, to install just the Exim binary, and nothing else,
2375 without creating the symbolic link, you could use:
2376 .code
2377 make INSTALL_ARG='-no_symlink exim' install
2378 .endd
2379
2380
2381
2382 .section "Installing info documentation" "SECTinsinfdoc"
2383 .cindex "installing Exim" "&'info'& documentation"
2384 Not all systems use the GNU &'info'& system for documentation, and for this
2385 reason, the Texinfo source of Exim's documentation is not included in the main
2386 distribution. Instead it is available separately from the FTP site (see section
2387 &<<SECTavail>>&).
2388
2389 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2390 source of the documentation is found in the source tree, running &`make
2391 install`& automatically builds the info files and installs them.
2392
2393
2394
2395 .section "Setting up the spool directory" "SECID33"
2396 .cindex "spool directory" "creating"
2397 When it starts up, Exim tries to create its spool directory if it does not
2398 exist. The Exim uid and gid are used for the owner and group of the spool
2399 directory. Sub-directories are automatically created in the spool directory as
2400 necessary.
2401
2402
2403
2404
2405 .section "Testing" "SECID34"
2406 .cindex "testing" "installation"
2407 Having installed Exim, you can check that the runtime configuration file is
2408 syntactically valid by running the following command, which assumes that the
2409 Exim binary directory is within your PATH environment variable:
2410 .code
2411 exim -bV
2412 .endd
2413 If there are any errors in the configuration file, Exim outputs error messages.
2414 Otherwise it outputs the version number and build date,
2415 the DBM library that is being used, and information about which drivers and
2416 other optional code modules are included in the binary.
2417 Some simple routing tests can be done by using the address testing option. For
2418 example,
2419 .display
2420 &`exim -bt`& <&'local username'&>
2421 .endd
2422 should verify that it recognizes a local mailbox, and
2423 .display
2424 &`exim -bt`& <&'remote address'&>
2425 .endd
2426 a remote one. Then try getting it to deliver mail, both locally and remotely.
2427 This can be done by passing messages directly to Exim, without going through a
2428 user agent. For example:
2429 .code
2430 exim -v postmaster@your.domain.example
2431 From: user@your.domain.example
2432 To: postmaster@your.domain.example
2433 Subject: Testing Exim
2434
2435 This is a test message.
2436 ^D
2437 .endd
2438 The &%-v%& option causes Exim to output some verification of what it is doing.
2439 In this case you should see copies of three log lines, one for the message's
2440 arrival, one for its delivery, and one containing &"Completed"&.
2441
2442 .cindex "delivery" "problems with"
2443 If you encounter problems, look at Exim's log files (&'mainlog'& and
2444 &'paniclog'&) to see if there is any relevant information there. Another source
2445 of information is running Exim with debugging turned on, by specifying the
2446 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2447 with debugging turned on by a command of the form
2448 .display
2449 &`exim -d -M`& <&'exim-message-id'&>
2450 .endd
2451 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2452 produces rather a lot of output, but you can cut this down to specific areas.
2453 For example, if you use &%-d-all+route%& only the debugging information
2454 relevant to routing is included. (See the &%-d%& option in chapter
2455 &<<CHAPcommandline>>& for more details.)
2456
2457 .cindex '&"sticky"& bit'
2458 .cindex "lock files"
2459 One specific problem that has shown up on some sites is the inability to do
2460 local deliveries into a shared mailbox directory, because it does not have the
2461 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2462 writing to a mailbox file, and if it cannot create the lock file, the delivery
2463 is deferred. You can get round this either by setting the &"sticky bit"& on the
2464 directory, or by setting a specific group for local deliveries and allowing
2465 that group to create files in the directory (see the comments above the
2466 &(local_delivery)& transport in the default configuration file). Another
2467 approach is to configure Exim not to use lock files, but just to rely on
2468 &[fcntl()]& locking instead. However, you should do this only if all user
2469 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2470 see chapter &<<CHAPappendfile>>&.
2471
2472 One thing that cannot be tested on a system that is already running an MTA is
2473 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2474 &%-oX%& option can be used to run an Exim daemon that listens on some other
2475 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2476 &'exim_checkaccess'& utility can be used to check out policy controls on
2477 incoming SMTP mail.
2478
2479 Testing a new version on a system that is already running Exim can most easily
2480 be done by building a binary with a different CONFIGURE_FILE setting. From
2481 within the runtime configuration, all other file and directory names
2482 that Exim uses can be altered, in order to keep it entirely clear of the
2483 production version.
2484
2485
2486 .section "Replacing another MTA with Exim" "SECID35"
2487 .cindex "replacing another MTA"
2488 Building and installing Exim for the first time does not of itself put it in
2489 general use. The name by which the system's MTA is called by mail user agents
2490 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2491 operating system), and it is necessary to make this name point to the &'exim'&
2492 binary in order to get the user agents to pass messages to Exim. This is
2493 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2494 or &_/usr/lib/sendmail_&
2495 .cindex "symbolic link" "to &'exim'& binary"
2496 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2497 privilege and executable status from the old MTA. It is then necessary to stop
2498 and restart the mailer daemon, if one is running.
2499
2500 .cindex "FreeBSD, MTA indirection"
2501 .cindex "&_/etc/mail/mailer.conf_&"
2502 Some operating systems have introduced alternative ways of switching MTAs. For
2503 example, if you are running FreeBSD, you need to edit the file
2504 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2505 described. A typical example of the contents of this file for running Exim is
2506 as follows:
2507 .code
2508 sendmail            /usr/exim/bin/exim
2509 send-mail           /usr/exim/bin/exim
2510 mailq               /usr/exim/bin/exim -bp
2511 newaliases          /usr/bin/true
2512 .endd
2513 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2514 your Exim installation is &"live"&. Check it by sending a message from your
2515 favourite user agent.
2516
2517 You should consider what to tell your users about the change of MTA. Exim may
2518 have different capabilities to what was previously running, and there are
2519 various operational differences such as the text of messages produced by
2520 command line options and in bounce messages. If you allow your users to make
2521 use of Exim's filtering capabilities, you should make the document entitled
2522 &'Exim's interface to mail filtering'& available to them.
2523
2524
2525
2526 .section "Upgrading Exim" "SECID36"
2527 .cindex "upgrading Exim"
2528 If you are already running Exim on your host, building and installing a new
2529 version automatically makes it available to MUAs, or any other programs that
2530 call the MTA directly. However, if you are running an Exim daemon, you do need
2531 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2532 new binary. You do not need to stop processing mail in order to install a new
2533 version of Exim. The install script does not modify an existing runtime
2534 configuration file.
2535
2536
2537
2538
2539 .section "Stopping the Exim daemon on Solaris" "SECID37"
2540 .cindex "Solaris" "stopping Exim on"
2541 The standard command for stopping the mailer daemon on Solaris is
2542 .code
2543 /etc/init.d/sendmail stop
2544 .endd
2545 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2546 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2547 for the text &"sendmail"&; this is not present because the actual program name
2548 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2549 solution is to replace the line that finds the process id with something like
2550 .code
2551 pid=`cat /var/spool/exim/exim-daemon.pid`
2552 .endd
2553 to obtain the daemon's pid directly from the file that Exim saves it in.
2554
2555 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2556 still be received from local processes, and if automatic delivery is configured
2557 (the normal case), deliveries will still occur.
2558
2559
2560
2561
2562 . ////////////////////////////////////////////////////////////////////////////
2563 . ////////////////////////////////////////////////////////////////////////////
2564
2565 .chapter "The Exim command line" "CHAPcommandline"
2566 .scindex IIDclo1 "command line" "options"
2567 .scindex IIDclo2 "options" "command line"
2568 Exim's command line takes the standard Unix form of a sequence of options,
2569 each starting with a hyphen character, followed by a number of arguments. The
2570 options are compatible with the main options of Sendmail, and there are also
2571 some additional options, some of which are compatible with Smail 3. Certain
2572 combinations of options do not make sense, and provoke an error if used.
2573 The form of the arguments depends on which options are set.
2574
2575
2576 .section "Setting options by program name" "SECID38"
2577 .cindex "&'mailq'&"
2578 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2579 were present before any other options.
2580 The &%-bp%& option requests a listing of the contents of the mail queue on the
2581 standard output.
2582 This feature is for compatibility with some systems that contain a command of
2583 that name in one of the standard libraries, symbolically linked to
2584 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2585
2586 .cindex "&'rsmtp'&"
2587 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2588 were present before any other options, for compatibility with Smail. The
2589 &%-bS%& option is used for reading in a number of messages in batched SMTP
2590 format.
2591
2592 .cindex "&'rmail'&"
2593 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2594 &%-oee%& options were present before any other options, for compatibility with
2595 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2596
2597 .cindex "&'runq'&"
2598 .cindex "queue runner"
2599 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2600 were present before any other options, for compatibility with Smail. The &%-q%&
2601 option causes a single queue runner process to be started.
2602
2603 .cindex "&'newaliases'&"
2604 .cindex "alias file" "building"
2605 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2606 If Exim is called under the name &'newaliases'& it behaves as if the option
2607 &%-bi%& were present before any other options, for compatibility with Sendmail.
2608 This option is used for rebuilding Sendmail's alias file. Exim does not have
2609 the concept of a single alias file, but can be configured to run a given
2610 command if called with the &%-bi%& option.
2611
2612
2613 .section "Trusted and admin users" "SECTtrustedadmin"
2614 Some Exim options are available only to &'trusted users'& and others are
2615 available only to &'admin users'&. In the description below, the phrases &"Exim
2616 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2617 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2618 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2619
2620 .ilist
2621 .cindex "trusted users" "definition of"
2622 .cindex "user" "trusted definition of"
2623 The trusted users are root, the Exim user, any user listed in the
2624 &%trusted_users%& configuration option, and any user whose current group or any
2625 supplementary group is one of those listed in the &%trusted_groups%&
2626 configuration option. Note that the Exim group is not automatically trusted.
2627
2628 .cindex '&"From"& line'
2629 .cindex "envelope from"
2630 .cindex "envelope sender"
2631 Trusted users are always permitted to use the &%-f%& option or a leading
2632 &"From&~"& line to specify the envelope sender of a message that is passed to
2633 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2634 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2635 users to set envelope senders.
2636
2637 .cindex "&'From:'& header line"
2638 .cindex "&'Sender:'& header line"
2639 .cindex "header lines" "From:"
2640 .cindex "header lines" "Sender:"
2641 For a trusted user, there is never any check on the contents of the &'From:'&
2642 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2643 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2644
2645 Trusted users may also specify a host name, host address, interface address,
2646 protocol name, ident value, and authentication data when submitting a message
2647 locally. Thus, they are able to insert messages into Exim's queue locally that
2648 have the characteristics of messages received from a remote host. Untrusted
2649 users may in some circumstances use &%-f%&, but can never set the other values
2650 that are available to trusted users.
2651 .next
2652 .cindex "user" "admin definition of"
2653 .cindex "admin user" "definition of"
2654 The admin users are root, the Exim user, and any user that is a member of the
2655 Exim group or of any group listed in the &%admin_groups%& configuration option.
2656 The current group does not have to be one of these groups.
2657
2658 Admin users are permitted to list the queue, and to carry out certain
2659 operations on messages, for example, to force delivery failures. It is also
2660 necessary to be an admin user in order to see the full information provided by
2661 the Exim monitor, and full debugging output.
2662
2663 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2664 Exim to attempt delivery of messages on its queue is restricted to admin users.
2665 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2666 option false (that is, specifying &%no_prod_requires_admin%&).
2667
2668 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2669 is restricted to admin users unless &%queue_list_requires_admin%& is set
2670 false.
2671 .endlist
2672
2673
2674 &*Warning*&: If you configure your system so that admin users are able to
2675 edit Exim's configuration file, you are giving those users an easy way of
2676 getting root. There is further discussion of this issue at the start of chapter
2677 &<<CHAPconf>>&.
2678
2679
2680
2681
2682 .section "Command line options" "SECID39"
2683 Exim's command line options are described in alphabetical order below. If none
2684 of the options that specifies a specific action (such as starting the daemon or
2685 a queue runner, or testing an address, or receiving a message in a specific
2686 format, or listing the queue) are present, and there is at least one argument
2687 on the command line, &%-bm%& (accept a local message on the standard input,
2688 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2689 outputs a brief message about itself and exits.
2690
2691 . ////////////////////////////////////////////////////////////////////////////
2692 . Insert a stylized XML comment here, to identify the start of the command line
2693 . options. This is for the benefit of the Perl script that automatically
2694 . creates a man page for the options.
2695 . ////////////////////////////////////////////////////////////////////////////
2696
2697 .literal xml
2698 <!-- === Start of command line options === -->
2699 .literal off
2700
2701
2702 .vlist
2703 .vitem &%--%&
2704 .oindex "--"
2705 .cindex "options" "command line; terminating"
2706 This is a pseudo-option whose only purpose is to terminate the options and
2707 therefore to cause subsequent command line items to be treated as arguments
2708 rather than options, even if they begin with hyphens.
2709
2710 .vitem &%--help%&
2711 .oindex "&%--help%&"
2712 This option causes Exim to output a few sentences stating what it is.
2713 The same output is generated if the Exim binary is called with no options and
2714 no arguments.
2715
2716 .vitem &%--version%&
2717 .oindex "&%--version%&"
2718 This option is an alias for &%-bV%& and causes version information to be
2719 displayed.
2720
2721 .vitem &%-Ac%& &&&
2722        &%-Am%&
2723 .oindex "&%-Ac%&"
2724 .oindex "&%-Am%&"
2725 These options are used by Sendmail for selecting configuration files and are
2726 ignored by Exim.
2727
2728 .vitem &%-B%&<&'type'&>
2729 .oindex "&%-B%&"
2730 .cindex "8-bit characters"
2731 .cindex "Sendmail compatibility" "8-bit characters"
2732 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2733 clean; it ignores this option.
2734
2735 .vitem &%-bd%&
2736 .oindex "&%-bd%&"
2737 .cindex "daemon"
2738 .cindex "SMTP" "listener"
2739 .cindex "queue runner"
2740 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2741 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2742 that the daemon should also initiate periodic queue runs.
2743
2744 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2745 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2746 disconnect from the controlling terminal. When running this way, it can be
2747 stopped by pressing ctrl-C.
2748
2749 By default, Exim listens for incoming connections to the standard SMTP port on
2750 all the host's running interfaces. However, it is possible to listen on other
2751 ports, on multiple ports, and only on specific interfaces. Chapter
2752 &<<CHAPinterfaces>>& contains a description of the options that control this.
2753
2754 When a listening daemon
2755 .cindex "daemon" "process id (pid)"
2756 .cindex "pid (process id)" "of daemon"
2757 is started without the use of &%-oX%& (that is, without overriding the normal
2758 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2759 in Exim's spool directory. This location can be overridden by setting
2760 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2761 running as root.
2762
2763 When &%-oX%& is used on the command line to start a listening daemon, the
2764 process id is not written to the normal pid file path. However, &%-oP%& can be
2765 used to specify a path on the command line if a pid file is required.
2766
2767 The SIGHUP signal
2768 .cindex "SIGHUP"
2769 .cindex "daemon" "restarting"
2770 .cindex signal "to reload configuration"
2771 .cindex daemon "reload configuration"
2772 can be used to cause the daemon to re-execute itself. This should be done
2773 whenever Exim's configuration file, or any file that is incorporated into it by
2774 means of the &%.include%& facility, is changed, and also whenever a new version
2775 of Exim is installed. It is not necessary to do this when other files that are
2776 referenced from the configuration (for example, alias files) are changed,
2777 because these are reread each time they are used.
2778
2779 .vitem &%-bdf%&
2780 .oindex "&%-bdf%&"
2781 This option has the same effect as &%-bd%& except that it never disconnects
2782 from the controlling terminal, even when no debugging is specified.
2783
2784 .vitem &%-be%&
2785 .oindex "&%-be%&"
2786 .cindex "testing" "string expansion"
2787 .cindex "expansion" "testing"
2788 Run Exim in expansion testing mode. Exim discards its root privilege, to
2789 prevent ordinary users from using this mode to read otherwise inaccessible
2790 files. If no arguments are given, Exim runs interactively, prompting for lines
2791 of data. Otherwise, it processes each argument in turn.
2792
2793 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2794 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2795 used without command line arguments. If successful, it uses the &[readline()]&
2796 function, which provides extensive line-editing facilities, for reading the
2797 test data. A line history is supported.
2798
2799 Long expansion expressions can be split over several lines by using backslash
2800 continuations. As in Exim's runtime configuration, white space at the start of
2801 continuation lines is ignored. Each argument or data line is passed through the
2802 string expansion mechanism, and the result is output. Variable values from the
2803 configuration file (for example, &$qualify_domain$&) are available, but no
2804 message-specific values (such as &$message_exim_id$&) are set, because no message
2805 is being processed (but see &%-bem%& and &%-Mset%&).
2806
2807 &*Note*&: If you use this mechanism to test lookups, and you change the data
2808 files or databases you are using, you must exit and restart Exim before trying
2809 the same lookup again. Otherwise, because each Exim process caches the results
2810 of lookups, you will just get the same result as before.
2811
2812 Macro processing is done on lines before string-expansion: new macros can be
2813 defined and macros will be expanded.
2814 Because macros in the config file are often used for secrets, those are only
2815 available to admin users.
2816
2817 .vitem &%-bem%&&~<&'filename'&>
2818 .oindex "&%-bem%&"
2819 .cindex "testing" "string expansion"
2820 .cindex "expansion" "testing"
2821 This option operates like &%-be%& except that it must be followed by the name
2822 of a file. For example:
2823 .code
2824 exim -bem /tmp/testmessage
2825 .endd
2826 The file is read as a message (as if receiving a locally-submitted non-SMTP
2827 message) before any of the test expansions are done. Thus, message-specific
2828 variables such as &$message_size$& and &$header_from:$& are available. However,
2829 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2830 recipients are read from the headers in the normal way, and are shown in the
2831 &$recipients$& variable. Note that recipients cannot be given on the command
2832 line, because further arguments are taken as strings to expand (just like
2833 &%-be%&).
2834
2835 .vitem &%-bF%&&~<&'filename'&>
2836 .oindex "&%-bF%&"
2837 .cindex "system filter" "testing"
2838 .cindex "testing" "system filter"
2839 This option is the same as &%-bf%& except that it assumes that the filter being
2840 tested is a system filter. The additional commands that are available only in
2841 system filters are recognized.
2842
2843 .vitem &%-bf%&&~<&'filename'&>
2844 .oindex "&%-bf%&"
2845 .cindex "filter" "testing"
2846 .cindex "testing" "filter file"
2847 .cindex "forward file" "testing"
2848 .cindex "testing" "forward file"
2849 .cindex "Sieve filter" "testing"
2850 This option runs Exim in user filter testing mode; the file is the filter file
2851 to be tested, and a test message must be supplied on the standard input. If
2852 there are no message-dependent tests in the filter, an empty file can be
2853 supplied.
2854
2855 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2856 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2857 filter and a user filter in the same run. For example:
2858 .code
2859 exim -bF /system/filter -bf /user/filter </test/message
2860 .endd
2861 This is helpful when the system filter adds header lines or sets filter
2862 variables that are used by the user filter.
2863
2864 If the test filter file does not begin with one of the special lines
2865 .code
2866 # Exim filter
2867 # Sieve filter
2868 .endd
2869 it is taken to be a normal &_.forward_& file, and is tested for validity under
2870 that interpretation. See sections &<<SECTitenonfilred>>& to
2871 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2872 redirection lists.
2873
2874 The result of an Exim command that uses &%-bf%&, provided no errors are
2875 detected, is a list of the actions that Exim would try to take if presented
2876 with the message for real. More details of filter testing are given in the
2877 separate document entitled &'Exim's interfaces to mail filtering'&.
2878
2879 When testing a filter file,
2880 .cindex "&""From""& line"
2881 .cindex "envelope from"
2882 .cindex "envelope sender"
2883 .oindex "&%-f%&" "for filter testing"
2884 the envelope sender can be set by the &%-f%& option,
2885 or by a &"From&~"& line at the start of the test message. Various parameters
2886 that would normally be taken from the envelope recipient address of the message
2887 can be set by means of additional command line options (see the next four
2888 options).
2889
2890 .vitem &%-bfd%&&~<&'domain'&>
2891 .oindex "&%-bfd%&"
2892 .vindex "&$qualify_domain$&"
2893 This sets the domain of the recipient address when a filter file is being
2894 tested by means of the &%-bf%& option. The default is the value of
2895 &$qualify_domain$&.
2896
2897 .vitem &%-bfl%&&~<&'local&~part'&>
2898 .oindex "&%-bfl%&"
2899 This sets the local part of the recipient address when a filter file is being
2900 tested by means of the &%-bf%& option. The default is the username of the
2901 process that calls Exim. A local part should be specified with any prefix or
2902 suffix stripped, because that is how it appears to the filter when a message is
2903 actually being delivered.
2904
2905 .vitem &%-bfp%&&~<&'prefix'&>
2906 .oindex "&%-bfp%&"
2907 .cindex affix "filter testing"
2908 This sets the prefix of the local part of the recipient address when a filter
2909 file is being tested by means of the &%-bf%& option. The default is an empty
2910 prefix.
2911
2912 .vitem &%-bfs%&&~<&'suffix'&>
2913 .oindex "&%-bfs%&"
2914 .cindex affix "filter testing"
2915 This sets the suffix of the local part of the recipient address when a filter
2916 file is being tested by means of the &%-bf%& option. The default is an empty
2917 suffix.
2918
2919 .vitem &%-bh%&&~<&'IP&~address'&>
2920 .oindex "&%-bh%&"
2921 .cindex "testing" "incoming SMTP"
2922 .cindex "SMTP" "testing incoming"
2923 .cindex "testing" "relay control"
2924 .cindex "relaying" "testing configuration"
2925 .cindex "policy control" "testing"
2926 .cindex "debugging" "&%-bh%& option"
2927 This option runs a fake SMTP session as if from the given IP address, using the
2928 standard input and output. The IP address may include a port number at the end,
2929 after a full stop. For example:
2930 .code
2931 exim -bh 10.9.8.7.1234
2932 exim -bh fe80::a00:20ff:fe86:a061.5678
2933 .endd
2934 When an IPv6 address is given, it is converted into canonical form. In the case
2935 of the second example above, the value of &$sender_host_address$& after
2936 conversion to the canonical form is
2937 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2938
2939 Comments as to what is going on are written to the standard error file. These
2940 include lines beginning with &"LOG"& for anything that would have been logged.
2941 This facility is provided for testing configuration options for incoming
2942 messages, to make sure they implement the required policy. For example, you can
2943 test your relay controls using &%-bh%&.
2944
2945 &*Warning 1*&:
2946 .cindex "RFC 1413"
2947 You can test features of the configuration that rely on ident (RFC 1413)
2948 information by using the &%-oMt%& option. However, Exim cannot actually perform
2949 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2950 connection.
2951
2952 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2953 are also skipped when testing using &%-bh%&. If you want these callouts to
2954 occur, use &%-bhc%& instead.
2955
2956 Messages supplied during the testing session are discarded, and nothing is
2957 written to any of the real log files. There may be pauses when DNS (and other)
2958 lookups are taking place, and of course these may time out. The &%-oMi%& option
2959 can be used to specify a specific IP interface and port if this is important,
2960 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2961 session were authenticated.
2962
2963 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2964 output just states whether a given recipient address from a given host is
2965 acceptable or not. See section &<<SECTcheckaccess>>&.
2966
2967 Features such as authentication and encryption, where the client input is not
2968 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2969 specialized SMTP test program such as
2970 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2971
2972 .vitem &%-bhc%&&~<&'IP&~address'&>
2973 .oindex "&%-bhc%&"
2974 This option operates in the same way as &%-bh%&, except that address
2975 verification callouts are performed if required. This includes consulting and
2976 updating the callout cache database.
2977
2978 .vitem &%-bi%&
2979 .oindex "&%-bi%&"
2980 .cindex "alias file" "building"
2981 .cindex "building alias file"
2982 .cindex "Sendmail compatibility" "&%-bi%& option"
2983 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2984 Exim does not have the concept of a single alias file, and so it cannot mimic
2985 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2986 tend to appear in various scripts such as NIS make files, so the option must be
2987 recognized.
2988
2989 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2990 configuration option is run, under the uid and gid of the caller of Exim. If
2991 the &%-oA%& option is used, its value is passed to the command as an argument.
2992 The command set by &%bi_command%& may not contain arguments. The command can
2993 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2994 if this is required. If the &%bi_command%& option is not set, calling Exim with
2995 &%-bi%& is a no-op.
2996
2997 . // Keep :help first, then the rest in alphabetical order
2998 .vitem &%-bI:help%&
2999 .oindex "&%-bI:help%&"
3000 .cindex "querying exim information"
3001 We shall provide various options starting &`-bI:`& for querying Exim for
3002 information.  The output of many of these will be intended for machine
3003 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3004 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3005 options shall cause Exim to exit after producing the requested output.
3006
3007 .vitem &%-bI:dscp%&
3008 .oindex "&%-bI:dscp%&"
3009 .cindex "DSCP" "values"
3010 This option causes Exim to emit an alphabetically sorted list of all
3011 recognised DSCP names.
3012
3013 .vitem &%-bI:sieve%&
3014 .oindex "&%-bI:sieve%&"
3015 .cindex "Sieve filter" "capabilities"
3016 This option causes Exim to emit an alphabetically sorted list of all supported
3017 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3018 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3019 &`SIEVE`& capability response line.  As the precise list may depend upon
3020 compile-time build options, which this option will adapt to, this is the only
3021 way to guarantee a correct response.
3022
3023 .vitem &%-bm%&
3024 .oindex "&%-bm%&"
3025 .cindex "local message reception"
3026 This option runs an Exim receiving process that accepts an incoming,
3027 locally-generated message on the standard input. The recipients are given as the
3028 command arguments (except when &%-t%& is also present &-- see below). Each
3029 argument can be a comma-separated list of RFC 2822 addresses. This is the
3030 default option for selecting the overall action of an Exim call; it is assumed
3031 if no other conflicting option is present.
3032
3033 If any addresses in the message are unqualified (have no domain), they are
3034 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3035 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3036 suppressing this for special cases.
3037
3038 Policy checks on the contents of local messages can be enforced by means of
3039 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3040
3041 .cindex "return code" "for &%-bm%&"
3042 The return code is zero if the message is successfully accepted. Otherwise, the
3043 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3044
3045 The format
3046 .cindex "message" "format"
3047 .cindex "format" "message"
3048 .cindex "&""From""& line"
3049 .cindex "UUCP" "&""From""& line"
3050 .cindex "Sendmail compatibility" "&""From""& line"
3051 of the message must be as defined in RFC 2822, except that, for
3052 compatibility with Sendmail and Smail, a line in one of the forms
3053 .code
3054 From sender Fri Jan  5 12:55 GMT 1997
3055 From sender Fri, 5 Jan 97 12:55:01
3056 .endd
3057 (with the weekday optional, and possibly with additional text after the date)
3058 is permitted to appear at the start of the message. There appears to be no
3059 authoritative specification of the format of this line. Exim recognizes it by
3060 matching against the regular expression defined by the &%uucp_from_pattern%&
3061 option, which can be changed if necessary.
3062
3063 .oindex "&%-f%&" "overriding &""From""& line"
3064 The specified sender is treated as if it were given as the argument to the
3065 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3066 preference to the address taken from the message. The caller of Exim must be a
3067 trusted user for the sender of a message to be set in this way.
3068
3069 .vitem &%-bmalware%&&~<&'filename'&>
3070 .oindex "&%-bmalware%&"
3071 .cindex "testing", "malware"
3072 .cindex "malware scan test"
3073 This debugging option causes Exim to scan the given file or directory
3074 (depending on the used scanner interface),
3075 using the malware scanning framework.  The option of &%av_scanner%& influences
3076 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3077 the expansion should have defaults which apply to this invocation.  ACLs are
3078 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3079 will never be populated and &%-bmalware%& will fail.
3080
3081 Exim will have changed working directory before resolving the filename, so
3082 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3083 user when it tries to open the file, rather than as the invoking user.
3084 This option requires admin privileges.
3085
3086 The &%-bmalware%& option will not be extended to be more generally useful,
3087 there are better tools for file-scanning.  This option exists to help
3088 administrators verify their Exim and AV scanner configuration.
3089
3090 .vitem &%-bnq%&
3091 .oindex "&%-bnq%&"
3092 .cindex "address qualification, suppressing"
3093 By default, Exim automatically qualifies unqualified addresses (those
3094 without domains) that appear in messages that are submitted locally (that
3095 is, not over TCP/IP). This qualification applies both to addresses in
3096 envelopes, and addresses in header lines. Sender addresses are qualified using
3097 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3098 defaults to the value of &%qualify_domain%&).
3099
3100 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3101 being used to re-submit messages that originally came from remote hosts after
3102 content scanning, you probably do not want to qualify unqualified addresses in
3103 header lines. (Such lines will be present only if you have not enabled a header
3104 syntax check in the appropriate ACL.)
3105
3106 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3107 messages that originate on the local host. When this is used, unqualified
3108 addresses in the envelope provoke errors (causing message rejection) and
3109 unqualified addresses in header lines are left alone.
3110
3111
3112 .vitem &%-bP%&
3113 .oindex "&%-bP%&"
3114 .cindex "configuration options" "extracting"
3115 .cindex "options" "configuration &-- extracting"
3116 If this option is given with no arguments, it causes the values of all Exim's
3117 main configuration options to be written to the standard output. The values
3118 of one or more specific options can be requested by giving their names as
3119 arguments, for example:
3120 .code
3121 exim -bP qualify_domain hold_domains
3122 .endd
3123 .cindex "hiding configuration option values"
3124 .cindex "configuration options" "hiding value of"
3125 .cindex "options" "hiding value of"
3126 However, any option setting that is preceded by the word &"hide"& in the
3127 configuration file is not shown in full, except to an admin user. For other
3128 users, the output is as in this example:
3129 .code
3130 mysql_servers = <value not displayable>
3131 .endd
3132 If &%config%& is given as an argument, the config is
3133 output, as it was parsed, any include file resolved, any comment removed.
3134
3135 If &%config_file%& is given as an argument, the name of the runtime
3136 configuration file is output. (&%configure_file%& works too, for
3137 backward compatibility.)
3138 If a list of configuration files was supplied, the value that is output here
3139 is the name of the file that was actually used.
3140
3141 .cindex "options" "hiding name of"
3142 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3143 name will not be output.
3144
3145 .cindex "daemon" "process id (pid)"
3146 .cindex "pid (process id)" "of daemon"
3147 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3148 directories where log files and daemon pid files are written are output,
3149 respectively. If these values are unset, log files are written in a
3150 sub-directory of the spool directory called &%log%&, and the pid file is
3151 written directly into the spool directory.
3152
3153 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3154 .code
3155 exim -bP +local_domains
3156 .endd
3157 it searches for a matching named list of any type (domain, host, address, or
3158 local part) and outputs what it finds.
3159
3160 .cindex "options" "router &-- extracting"
3161 .cindex "options" "transport &-- extracting"
3162 .cindex "options" "authenticator &-- extracting"
3163 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3164 followed by the name of an appropriate driver instance, the option settings for
3165 that driver are output. For example:
3166 .code
3167 exim -bP transport local_delivery
3168 .endd
3169 The generic driver options are output first, followed by the driver's private
3170 options. A list of the names of drivers of a particular type can be obtained by
3171 using one of the words &%router_list%&, &%transport_list%&, or
3172 &%authenticator_list%&, and a complete list of all drivers with their option
3173 settings can be obtained by using &%routers%&, &%transports%&, or
3174 &%authenticators%&.
3175
3176 .cindex "environment"
3177 If &%environment%& is given as an argument, the set of environment
3178 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3179 variables.
3180
3181 .cindex "options" "macro &-- extracting"
3182 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3183 are available, similarly to the drivers.  Because macros are sometimes used
3184 for storing passwords, this option is restricted.
3185 The output format is one item per line.
3186 For the "-bP macro <name>" form, if no such macro is found
3187 the exit status will be nonzero.
3188
3189 .vitem &%-bp%&
3190 .oindex "&%-bp%&"
3191 .cindex "queue" "listing messages in"
3192 .cindex "listing" "messages in the queue"
3193 This option requests a listing of the contents of the mail queue on the
3194 standard output. If the &%-bp%& option is followed by a list of message ids,
3195 just those messages are listed. By default, this option can be used only by an
3196 admin user. However, the &%queue_list_requires_admin%& option can be set false
3197 to allow any user to see the queue.
3198
3199 Each message in the queue is displayed as in the following example:
3200 .code
3201 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3202           red.king@looking-glass.fict.example
3203           <other addresses>
3204 .endd
3205 .cindex "message" "size in queue listing"
3206 .cindex "size" "of message"
3207 The first line contains the length of time the message has been in the queue
3208 (in this case 25 minutes), the size of the message (2.9K), the unique local
3209 identifier for the message, and the message sender, as contained in the
3210 envelope. For bounce messages, the sender address is empty, and appears as
3211 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3212 the default sender address, the user's login name is shown in parentheses
3213 before the sender address.
3214
3215 .cindex "frozen messages" "in queue listing"
3216 If the message is frozen (attempts to deliver it are suspended) then the text
3217 &"*** frozen ***"& is displayed at the end of this line.
3218
3219 The recipients of the message (taken from the envelope, not the headers) are
3220 displayed on subsequent lines. Those addresses to which the message has already
3221 been delivered are marked with the letter D. If an original address gets
3222 expanded into several addresses via an alias or forward file, the original is
3223 displayed with a D only when deliveries for all of its child addresses are
3224 complete.
3225
3226
3227 .vitem &%-bpa%&
3228 .oindex "&%-bpa%&"
3229 This option operates like &%-bp%&, but in addition it shows delivered addresses
3230 that were generated from the original top level address(es) in each message by
3231 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3232 of just &"D"&.
3233
3234
3235 .vitem &%-bpc%&
3236 .oindex "&%-bpc%&"
3237 .cindex "queue" "count of messages on"
3238 This option counts the number of messages in the queue, and writes the total
3239 to the standard output. It is restricted to admin users, unless
3240 &%queue_list_requires_admin%& is set false.
3241
3242
3243 .vitem &%-bpr%&
3244 .oindex "&%-bpr%&"
3245 This option operates like &%-bp%&, but the output is not sorted into
3246 chronological order of message arrival. This can speed it up when there are
3247 lots of messages in the queue, and is particularly useful if the output is
3248 going to be post-processed in a way that doesn't need the sorting.
3249
3250 .vitem &%-bpra%&
3251 .oindex "&%-bpra%&"
3252 This option is a combination of &%-bpr%& and &%-bpa%&.
3253
3254 .vitem &%-bpru%&
3255 .oindex "&%-bpru%&"
3256 This option is a combination of &%-bpr%& and &%-bpu%&.
3257
3258
3259 .vitem &%-bpu%&
3260 .oindex "&%-bpu%&"
3261 This option operates like &%-bp%& but shows only undelivered top-level
3262 addresses for each message displayed. Addresses generated by aliasing or
3263 forwarding are not shown, unless the message was deferred after processing by a
3264 router with the &%one_time%& option set.
3265
3266
3267 .vitem &%-brt%&
3268 .oindex "&%-brt%&"
3269 .cindex "testing" "retry configuration"
3270 .cindex "retry" "configuration testing"
3271 This option is for testing retry rules, and it must be followed by up to three
3272 arguments. It causes Exim to look for a retry rule that matches the values
3273 and to write it to the standard output. For example:
3274 .code
3275 exim -brt bach.comp.mus.example
3276 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3277 .endd
3278 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3279 argument, which is required, can be a complete address in the form
3280 &'local_part@domain'&, or it can be just a domain name. If the second argument
3281 contains a dot, it is interpreted as an optional second domain name; if no
3282 retry rule is found for the first argument, the second is tried. This ties in
3283 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3284 rule is found that matches the host, one that matches the mail domain is
3285 sought. Finally, an argument that is the name of a specific delivery error, as
3286 used in setting up retry rules, can be given. For example:
3287 .code
3288 exim -brt haydn.comp.mus.example quota_3d
3289 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3290 .endd
3291
3292 .vitem &%-brw%&
3293 .oindex "&%-brw%&"
3294 .cindex "testing" "rewriting"
3295 .cindex "rewriting" "testing"
3296 This option is for testing address rewriting rules, and it must be followed by
3297 a single argument, consisting of either a local part without a domain, or a
3298 complete address with a fully qualified domain. Exim outputs how this address
3299 would be rewritten for each possible place it might appear. See chapter
3300 &<<CHAPrewrite>>& for further details.
3301
3302 .vitem &%-bS%&
3303 .oindex "&%-bS%&"
3304 .cindex "SMTP" "batched incoming"
3305 .cindex "batched SMTP input"
3306 This option is used for batched SMTP input, which is an alternative interface
3307 for non-interactive local message submission. A number of messages can be
3308 submitted in a single run. However, despite its name, this is not really SMTP
3309 input. Exim reads each message's envelope from SMTP commands on the standard
3310 input, but generates no responses. If the caller is trusted, or
3311 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3312 believed; otherwise the sender is always the caller of Exim.
3313
3314 The message itself is read from the standard input, in SMTP format (leading
3315 dots doubled), terminated by a line containing just a single dot. An error is
3316 provoked if the terminating dot is missing. A further message may then follow.
3317
3318 As for other local message submissions, the contents of incoming batch SMTP
3319 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3320 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3321 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3322
3323 Some other SMTP commands are recognized in the input. HELO and EHLO act
3324 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3325 QUIT quits, ignoring the rest of the standard input.
3326
3327 .cindex "return code" "for &%-bS%&"
3328 If any error is encountered, reports are written to the standard output and
3329 error streams, and Exim gives up immediately. The return code is 0 if no error
3330 was detected; it is 1 if one or more messages were accepted before the error
3331 was detected; otherwise it is 2.
3332
3333 More details of input using batched SMTP are given in section
3334 &<<SECTincomingbatchedSMTP>>&.
3335
3336 .vitem &%-bs%&
3337 .oindex "&%-bs%&"
3338 .cindex "SMTP" "local input"
3339 .cindex "local SMTP input"
3340 This option causes Exim to accept one or more messages by reading SMTP commands
3341 on the standard input, and producing SMTP replies on the standard output. SMTP
3342 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3343 Some user agents use this interface as a way of passing locally-generated
3344 messages to the MTA.
3345
3346 In
3347 .cindex "sender" "source of"
3348 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3349 set, the senders of messages are taken from the SMTP MAIL commands.
3350 Otherwise the content of these commands is ignored and the sender is set up as
3351 the calling user. Unqualified addresses are automatically qualified using
3352 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3353 &%-bnq%& option is used.
3354
3355 .cindex "inetd"
3356 The
3357 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3358 using a listening daemon. Exim can distinguish the two cases by checking
3359 whether the standard input is a TCP/IP socket. When Exim is called from
3360 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3361 above concerning senders and qualification do not apply. In this situation,
3362 Exim behaves in exactly the same way as it does when receiving a message via
3363 the listening daemon.
3364
3365 .vitem &%-bt%&
3366 .oindex "&%-bt%&"
3367 .cindex "testing" "addresses"
3368 .cindex "address" "testing"
3369 This option runs Exim in address testing mode, in which each argument is taken
3370 as a recipient address to be tested for deliverability. The results are
3371 written to the standard output. If a test fails, and the caller is not an admin
3372 user, no details of the failure are output, because these might contain
3373 sensitive information such as usernames and passwords for database lookups.
3374
3375 If no arguments are given, Exim runs in an interactive manner, prompting with a
3376 right angle bracket for addresses to be tested.
3377
3378 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3379 &[readline()]& function, because it is running as &'root'& and there are
3380 security issues.
3381
3382 Each address is handled as if it were the recipient address of a message
3383 (compare the &%-bv%& option). It is passed to the routers and the result is
3384 written to the standard output. However, any router that has
3385 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3386 genuine routing tests if your first router passes everything to a scanner
3387 program.
3388
3389 .cindex "return code" "for &%-bt%&"
3390 The return code is 2 if any address failed outright; it is 1 if no address
3391 failed outright but at least one could not be resolved for some reason. Return
3392 code 0 is given only when all addresses succeed.
3393
3394 .cindex "duplicate addresses"
3395 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3396 addresses after routing is complete, so that only one delivery takes place.
3397 This does not happen when testing with &%-bt%&; the full results of routing are
3398 always shown.
3399
3400 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3401 routers in the configuration makes any tests on the sender address of a
3402 message,
3403 .oindex "&%-f%&" "for address testing"
3404 you can use the &%-f%& option to set an appropriate sender when running
3405 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3406 default qualifying domain. However, if you have set up (for example) routers
3407 whose behaviour depends on the contents of an incoming message, you cannot test
3408 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3409 doing such tests.
3410
3411 .vitem &%-bV%&
3412 .oindex "&%-bV%&"
3413 .cindex "version number of Exim"
3414 This option causes Exim to write the current version number, compilation
3415 number, and compilation date of the &'exim'& binary to the standard output.
3416 It also lists the DBM library that is being used, the optional modules (such as
3417 specific lookup types), the drivers that are included in the binary, and the
3418 name of the runtime configuration file that is in use.
3419
3420 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3421 configuration file. However, this is a static check only. It cannot check
3422 values that are to be expanded. For example, although a misspelt ACL verb is
3423 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3424 alone to discover (for example) all the typos in the configuration; some
3425 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3426 dynamic testing facilities.
3427
3428 .vitem &%-bv%&
3429 .oindex "&%-bv%&"
3430 .cindex "verifying address" "using &%-bv%&"
3431 .cindex "address" "verification"
3432 This option runs Exim in address verification mode, in which each argument is
3433 taken as a recipient address to be verified by the routers. (This does
3434 not involve any verification callouts). During normal operation, verification
3435 happens mostly as a consequence processing a &%verify%& condition in an ACL
3436 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3437 including callouts, see the &%-bh%& and &%-bhc%& options.
3438
3439 If verification fails, and the caller is not an admin user, no details of the
3440 failure are output, because these might contain sensitive information such as
3441 usernames and passwords for database lookups.
3442
3443 If no arguments are given, Exim runs in an interactive manner, prompting with a
3444 right angle bracket for addresses to be verified.
3445
3446 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3447 &[readline()]& function, because it is running as &'exim'& and there are
3448 security issues.
3449
3450 Verification differs from address testing (the &%-bt%& option) in that routers
3451 that have &%no_verify%& set are skipped, and if the address is accepted by a
3452 router that has &%fail_verify%& set, verification fails. The address is
3453 verified as a recipient if &%-bv%& is used; to test verification for a sender
3454 address, &%-bvs%& should be used.
3455
3456 If the &%-v%& option is not set, the output consists of a single line for each
3457 address, stating whether it was verified or not, and giving a reason in the
3458 latter case. Without &%-v%&, generating more than one address by redirection
3459 causes verification to end successfully, without considering the generated
3460 addresses. However, if just one address is generated, processing continues,
3461 and the generated address must verify successfully for the overall verification
3462 to succeed.
3463
3464 When &%-v%& is set, more details are given of how the address has been handled,
3465 and in the case of address redirection, all the generated addresses are also
3466 considered. Verification may succeed for some and fail for others.
3467
3468 The
3469 .cindex "return code" "for &%-bv%&"
3470 return code is 2 if any address failed outright; it is 1 if no address
3471 failed outright but at least one could not be resolved for some reason. Return
3472 code 0 is given only when all addresses succeed.
3473
3474 If any of the routers in the configuration makes any tests on the sender
3475 address of a message, you should use the &%-f%& option to set an appropriate
3476 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3477 calling user at the default qualifying domain.
3478
3479 .vitem &%-bvs%&
3480 .oindex "&%-bvs%&"
3481 This option acts like &%-bv%&, but verifies the address as a sender rather
3482 than a recipient address. This affects any rewriting and qualification that
3483 might happen.
3484
3485 .vitem &%-bw%&
3486 .oindex "&%-bw%&"
3487 .cindex "daemon"
3488 .cindex "inetd"
3489 .cindex "inetd" "wait mode"
3490 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3491 similarly to the &%-bd%& option.  All port specifications on the command-line
3492 and in the configuration file are ignored.  Queue-running may not be specified.
3493
3494 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3495 listening for connections.  This permits the system to start up and have
3496 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3497 each port only when the first connection is received.
3498
3499 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3500 which the daemon will exit, which should cause inetd to listen once more.
3501
3502 .vitem &%-C%&&~<&'filelist'&>
3503 .oindex "&%-C%&"
3504 .cindex "configuration file" "alternate"
3505 .cindex "CONFIGURE_FILE"
3506 .cindex "alternate configuration file"
3507 This option causes Exim to find the runtime configuration file from the given
3508 list instead of from the list specified by the CONFIGURE_FILE
3509 compile-time setting. Usually, the list will consist of just a single filename,
3510 but it can be a colon-separated list of names. In this case, the first
3511 file that exists is used. Failure to open an existing file stops Exim from
3512 proceeding any further along the list, and an error is generated.
3513
3514 When this option is used by a caller other than root, and the list is different
3515 from the compiled-in list, Exim gives up its root privilege immediately, and
3516 runs with the real and effective uid and gid set to those of the caller.
3517 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3518 file contains a list of full pathnames, one per line, for configuration files
3519 which are trusted. Root privilege is retained for any configuration file so
3520 listed, as long as the caller is the Exim user (or the user specified in the
3521 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3522 not writeable by inappropriate users or groups.
3523
3524 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3525 configuration using &%-C%& right through message reception and delivery,
3526 even if the caller is root. The reception works, but by that time, Exim is
3527 running as the Exim user, so when it re-executes to regain privilege for the
3528 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3529 test reception and delivery using two separate commands (one to put a message
3530 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3531
3532 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3533 prefix string with which any file named in a &%-C%& command line option
3534 must start. In addition, the filename must not contain the sequence &`/../`&.
3535 However, if the value of the &%-C%& option is identical to the value of
3536 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3537 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3538 unset, any filename can be used with &%-C%&.
3539
3540 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3541 to a directory to which only root has access. This prevents someone who has
3542 broken into the Exim account from running a privileged Exim with an arbitrary
3543 configuration file.
3544
3545 The &%-C%& facility is useful for ensuring that configuration files are
3546 syntactically correct, but cannot be used for test deliveries, unless the
3547 caller is privileged, or unless it is an exotic configuration that does not
3548 require privilege. No check is made on the owner or group of the files
3549 specified by this option.
3550
3551
3552 .vitem &%-D%&<&'macro'&>=<&'value'&>
3553 .oindex "&%-D%&"
3554 .cindex "macro" "setting on command line"
3555 This option can be used to override macro definitions in the configuration file
3556 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3557 unprivileged caller, it causes Exim to give up its root privilege.
3558 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3559 completely disabled, and its use causes an immediate error exit.
3560
3561 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3562 colon-separated list of macros which are considered safe and, if &%-D%& only
3563 supplies macros from this list, and the values are acceptable, then Exim will
3564 not give up root privilege if the caller is root, the Exim run-time user, or
3565 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3566 to be removed in the future.  Acceptable values for the macros satisfy the
3567 regexp: &`^[A-Za-z0-9_/.-]*$`&
3568
3569 The entire option (including equals sign if present) must all be within one
3570 command line item. &%-D%& can be used to set the value of a macro to the empty
3571 string, in which case the equals sign is optional. These two commands are
3572 synonymous:
3573 .code
3574 exim -DABC  ...
3575 exim -DABC= ...
3576 .endd
3577 To include spaces in a macro definition item, quotes must be used. If you use
3578 quotes, spaces are permitted around the macro name and the equals sign. For
3579 example:
3580 .code
3581 exim '-D ABC = something' ...
3582 .endd
3583 &%-D%& may be repeated up to 10 times on a command line.
3584 Only macro names up to 22 letters long can be set.
3585
3586
3587 .vitem &%-d%&<&'debug&~options'&>
3588 .oindex "&%-d%&"
3589 .cindex "debugging" "list of selectors"
3590 .cindex "debugging" "&%-d%& option"
3591 This option causes debugging information to be written to the standard
3592 error stream. It is restricted to admin users because debugging output may show
3593 database queries that contain password information. Also, the details of users'
3594 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3595 writes an error message to the standard error stream and exits with a non-zero
3596 return code.
3597
3598 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3599 standard debugging data is output. This can be reduced, or increased to include
3600 some more rarely needed information, by directly following &%-d%& with a string
3601 made up of names preceded by plus or minus characters. These add or remove sets
3602 of debugging data, respectively. For example, &%-d+filter%& adds filter
3603 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3604 no spaces are allowed in the debug setting. The available debugging categories
3605 are:
3606 .display
3607 &`acl            `& ACL interpretation
3608 &`auth           `& authenticators
3609 &`deliver        `& general delivery logic
3610 &`dns            `& DNS lookups (see also resolver)
3611 &`dnsbl          `& DNS black list (aka RBL) code
3612 &`exec           `& arguments for &[execv()]& calls
3613 &`expand         `& detailed debugging for string expansions
3614 &`filter         `& filter handling
3615 &`hints_lookup   `& hints data lookups
3616 &`host_lookup    `& all types of name-to-IP address handling
3617 &`ident          `& ident lookup
3618 &`interface      `& lists of local interfaces
3619 &`lists          `& matching things in lists
3620 &`load           `& system load checks
3621 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3622                     &<<CHAPlocalscan>>&)
3623 &`lookup         `& general lookup code and all lookups
3624 &`memory         `& memory handling
3625 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3626 &`pid            `& modifier: add pid to debug output lines
3627 &`process_info   `& setting info for the process log
3628 &`queue_run      `& queue runs
3629 &`receive        `& general message reception logic
3630 &`resolver       `& turn on the DNS resolver's debugging output
3631 &`retry          `& retry handling
3632 &`rewrite        `& address rewriting
3633 &`route          `& address routing
3634 &`timestamp      `& modifier: add timestamp to debug output lines
3635 &`tls            `& TLS logic
3636 &`transport      `& transports
3637 &`uid            `& changes of uid/gid and looking up uid/gid
3638 &`verify         `& address verification logic
3639 &`all            `& almost all of the above (see below), and also &%-v%&
3640 .endd
3641 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3642 for &`-all`&. The reason for this is that &`+all`& is something that people
3643 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3644 is included, an awful lot of output that is very rarely of interest is
3645 generated, so it now has to be explicitly requested. However, &`-all`& does
3646 turn everything off.
3647
3648 .cindex "resolver, debugging output"
3649 .cindex "DNS resolver, debugging output"
3650 The &`resolver`& option produces output only if the DNS resolver was compiled
3651 with DEBUG enabled. This is not the case in some operating systems. Also,
3652 unfortunately, debugging output from the DNS resolver is written to stdout
3653 rather than stderr.
3654
3655 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3656 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3657 However, the &`pid`& selector is forced when debugging is turned on for a
3658 daemon, which then passes it on to any re-executed Exims. Exim also
3659 automatically adds the pid to debug lines when several remote deliveries are
3660 run in parallel.
3661
3662 The &`timestamp`& selector causes the current time to be inserted at the start
3663 of all debug output lines. This can be useful when trying to track down delays
3664 in processing.
3665
3666 .cindex debugging "UTF-8 in"
3667 .cindex UTF-8 "in debug output"
3668 The &`noutf8`& selector disables the use of
3669 UTF-8 line-drawing characters to group related information.
3670 When disabled. ascii-art is used instead.
3671 Using the &`+all`& option does not set this modifier,
3672
3673 If the &%debug_print%& option is set in any driver, it produces output whenever
3674 any debugging is selected, or if &%-v%& is used.
3675
3676 .vitem &%-dd%&<&'debug&~options'&>
3677 .oindex "&%-dd%&"
3678 This option behaves exactly like &%-d%& except when used on a command that
3679 starts a daemon process. In that case, debugging is turned off for the
3680 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3681 behaviour of the daemon without creating as much output as full debugging does.
3682
3683 .vitem &%-dropcr%&
3684 .oindex "&%-dropcr%&"
3685 This is an obsolete option that is now a no-op. It used to affect the way Exim
3686 handled CR and LF characters in incoming messages. What happens now is
3687 described in section &<<SECTlineendings>>&.
3688
3689 .vitem &%-E%&
3690 .oindex "&%-E%&"
3691 .cindex "bounce message" "generating"
3692 This option specifies that an incoming message is a locally-generated delivery
3693 failure report. It is used internally by Exim when handling delivery failures
3694 and is not intended for external use. Its only effect is to stop Exim
3695 generating certain messages to the postmaster, as otherwise message cascades
3696 could occur in some situations. As part of the same option, a message id may
3697 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3698 new message contains the id, following &"R="&, as a cross-reference.
3699
3700 .vitem &%-e%&&'x'&
3701 .oindex "&%-e%&&'x'&"
3702 There are a number of Sendmail options starting with &%-oe%& which seem to be
3703 called by various programs without the leading &%o%& in the option. For
3704 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3705 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3706
3707 .vitem &%-F%&&~<&'string'&>
3708 .oindex "&%-F%&"
3709 .cindex "sender" "name"
3710 .cindex "name" "of sender"
3711 This option sets the sender's full name for use when a locally-generated
3712 message is being accepted. In the absence of this option, the user's &'gecos'&
3713 entry from the password data is used. As users are generally permitted to alter
3714 their &'gecos'& entries, no security considerations are involved. White space
3715 between &%-F%& and the <&'string'&> is optional.
3716
3717 .vitem &%-f%&&~<&'address'&>
3718 .oindex "&%-f%&"
3719 .cindex "sender" "address"
3720 .cindex "address" "sender"
3721 .cindex "trusted users"
3722 .cindex "envelope from"
3723 .cindex "envelope sender"
3724 .cindex "user" "trusted"
3725 This option sets the address of the envelope sender of a locally-generated
3726 message (also known as the return path). The option can normally be used only
3727 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3728 users to use it.
3729
3730 Processes running as root or the Exim user are always trusted. Other
3731 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3732 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3733 of a local message is set to the caller's login name at the default qualify
3734 domain.
3735
3736 There is one exception to the restriction on the use of &%-f%&: an empty sender
3737 can be specified by any user, trusted or not, to create a message that can
3738 never provoke a bounce. An empty sender can be specified either as an empty
3739 string, or as a pair of angle brackets with nothing between them, as in these
3740 examples of shell commands:
3741 .code
3742 exim -f '<>' user@domain
3743 exim -f "" user@domain
3744 .endd
3745 In addition, the use of &%-f%& is not restricted when testing a filter file
3746 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3747 &%-bv%& options.
3748
3749 Allowing untrusted users to change the sender address does not of itself make
3750 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3751 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3752 though this can be overridden by setting &%no_local_from_check%&.
3753
3754 White
3755 .cindex "&""From""& line"
3756 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3757 given as two arguments or one combined argument). The sender of a
3758 locally-generated message can also be set (when permitted) by an initial
3759 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3760 if &%-f%& is also present, it overrides &"From&~"&.
3761
3762 .vitem &%-G%&
3763 .oindex "&%-G%&"
3764 .cindex "submission fixups, suppressing (command-line)"
3765 This option is equivalent to an ACL applying:
3766 .code
3767 control = suppress_local_fixups
3768 .endd
3769 for every message received.  Note that Sendmail will complain about such
3770 bad formatting, where Exim silently just does not fix it up.  This may change
3771 in future.
3772
3773 As this affects audit information, the caller must be a trusted user to use
3774 this option.
3775
3776 .vitem &%-h%&&~<&'number'&>
3777 .oindex "&%-h%&"
3778 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3779 This option is accepted for compatibility with Sendmail, but has no effect. (In
3780 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3781 headers.)
3782
3783 .vitem &%-i%&
3784 .oindex "&%-i%&"
3785 .cindex "Solaris" "&'mail'& command"
3786 .cindex "dot" "in incoming non-SMTP message"
3787 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3788 line by itself should not terminate an incoming, non-SMTP message. I can find
3789 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3790 command in Solaris 2.4 uses it. See also &%-ti%&.
3791
3792 .vitem &%-L%&&~<&'tag'&>
3793 .oindex "&%-L%&"
3794 .cindex "syslog" "process name; set with flag"
3795 This option is equivalent to setting &%syslog_processname%& in the config
3796 file and setting &%log_file_path%& to &`syslog`&.
3797 Its use is restricted to administrators.  The configuration file has to be
3798 read and parsed, to determine access rights, before this is set and takes
3799 effect, so early configuration file errors will not honour this flag.
3800
3801 The tag should not be longer than 32 characters.
3802
3803 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3804 .oindex "&%-M%&"
3805 .cindex "forcing delivery"
3806 .cindex "delivery" "forcing attempt"
3807 .cindex "frozen messages" "forcing delivery"
3808 This option requests Exim to run a delivery attempt on each message in turn. If
3809 any of the messages are frozen, they are automatically thawed before the
3810 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3811 and &%hold_domains%& are ignored.
3812
3813 Retry
3814 .cindex "hints database" "overriding retry hints"
3815 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3816 the normal retry time has not yet been reached. This option requires the caller
3817 to be an admin user. However, there is an option called &%prod_requires_admin%&
3818 which can be set false to relax this restriction (and also the same requirement
3819 for the &%-q%&, &%-R%&, and &%-S%& options).
3820
3821 The deliveries happen synchronously, that is, the original Exim process does
3822 not terminate until all the delivery attempts have finished. No output is
3823 produced unless there is a serious error. If you want to see what is happening,
3824 use the &%-v%& option as well, or inspect Exim's main log.
3825
3826 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3827 .oindex "&%-Mar%&"
3828 .cindex "message" "adding recipients"
3829 .cindex "recipient" "adding"
3830 This option requests Exim to add the addresses to the list of recipients of the
3831 message (&"ar"& for &"add recipients"&). The first argument must be a message
3832 id, and the remaining ones must be email addresses. However, if the message is
3833 active (in the middle of a delivery attempt), it is not altered. This option
3834 can be used only by an admin user.
3835
3836 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3837         &~<&'message&~id'&>"
3838 .oindex "&%-MC%&"
3839 .cindex "SMTP" "passed connection"
3840 .cindex "SMTP" "multiple deliveries"
3841 .cindex "multiple SMTP deliveries"
3842 This option is not intended for use by external callers. It is used internally
3843 by Exim to invoke another instance of itself to deliver a waiting message using
3844 an existing SMTP connection, which is passed as the standard input. Details are
3845 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3846 must be root or the Exim user in order to use it.
3847
3848 .vitem &%-MCA%&
3849 .oindex "&%-MCA%&"
3850 This option is not intended for use by external callers. It is used internally
3851 by Exim in conjunction with the &%-MC%& option. It signifies that the
3852 connection to the remote host has been authenticated.
3853
3854 .vitem &%-MCD%&
3855 .oindex "&%-MCD%&"
3856 This option is not intended for use by external callers. It is used internally
3857 by Exim in conjunction with the &%-MC%& option. It signifies that the
3858 remote host supports the ESMTP &_DSN_& extension.
3859
3860 .vitem &%-MCG%&&~<&'queue&~name'&>
3861 .oindex "&%-MCG%&"
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 an
3864 alternate queue is used, named by the following argument.
3865
3866 .vitem &%-MCK%&
3867 .oindex "&%-MCK%&"
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 a
3870 remote host supports the ESMTP &_CHUNKING_& extension.
3871
3872 .vitem &%-MCP%&
3873 .oindex "&%-MCP%&"
3874 This option is not intended for use by external callers. It is used internally
3875 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3876 which Exim is connected supports pipelining.
3877
3878 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3879 .oindex "&%-MCQ%&"
3880 This option is not intended for use by external callers. It is used internally
3881 by Exim in conjunction with the &%-MC%& option when the original delivery was
3882 started by a queue runner. It passes on the process id of the queue runner,
3883 together with the file descriptor number of an open pipe. Closure of the pipe
3884 signals the final completion of the sequence of processes that are passing
3885 messages through the same SMTP connection.
3886
3887 .vitem &%-MCS%&
3888 .oindex "&%-MCS%&"
3889 This option is not intended for use by external callers. It is used internally
3890 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3891 SMTP SIZE option should be used on messages delivered down the existing
3892 connection.
3893
3894 .vitem &%-MCT%&
3895 .oindex "&%-MCT%&"
3896 This option is not intended for use by external callers. It is used internally
3897 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3898 host to which Exim is connected supports TLS encryption.
3899
3900 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3901 .oindex "&%-MCt%&"
3902 This option is not intended for use by external callers. It is used internally
3903 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3904 connection is being proxied by a parent process for handling TLS encryption.
3905 The arguments give the local address and port being proxied, and the TLS cipher.
3906
3907 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3908 .oindex "&%-Mc%&"
3909 .cindex "hints database" "not overridden by &%-Mc%&"
3910 .cindex "delivery" "manually started &-- not forced"
3911 This option requests Exim to run a delivery attempt on each message, in turn,
3912 but unlike the &%-M%& option, it does check for retry hints, and respects any
3913 that are found. This option is not very useful to external callers. It is
3914 provided mainly for internal use by Exim when it needs to re-invoke itself in
3915 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3916 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3917 respects retry times and other options such as &%hold_domains%& that are
3918 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3919 If you want to run a specific delivery as if in a queue run, you should use
3920 &%-q%& with a message id argument. A distinction between queue run deliveries
3921 and other deliveries is made in one or two places.
3922
3923 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3924 .oindex "&%-Mes%&"
3925 .cindex "message" "changing sender"
3926 .cindex "sender" "changing"
3927 This option requests Exim to change the sender address in the message to the
3928 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3929 &"edit sender"&). There must be exactly two arguments. The first argument must
3930 be a message id, and the second one an email address. However, if the message
3931 is active (in the middle of a delivery attempt), its status is not altered.
3932 This option can be used only by an admin user.
3933
3934 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3935 .oindex "&%-Mf%&"
3936 .cindex "freezing messages"
3937 .cindex "message" "manually freezing"
3938 This option requests Exim to mark each listed message as &"frozen"&. This
3939 prevents any delivery attempts taking place until the message is &"thawed"&,
3940 either manually or as a result of the &%auto_thaw%& configuration option.
3941 However, if any of the messages are active (in the middle of a delivery
3942 attempt), their status is not altered. This option can be used only by an admin
3943 user.
3944
3945 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3946 .oindex "&%-Mg%&"
3947 .cindex "giving up on messages"
3948 .cindex "message" "abandoning delivery attempts"
3949 .cindex "delivery" "abandoning further attempts"
3950 This option requests Exim to give up trying to deliver the listed messages,
3951 including any that are frozen. However, if any of the messages are active,
3952 their status is not altered. For non-bounce messages, a delivery error message
3953 is sent to the sender, containing the text &"cancelled by administrator"&.
3954 Bounce messages are just discarded. This option can be used only by an admin
3955 user.
3956
3957 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3958 .oindex "&%-Mmad%&"
3959 .cindex "delivery" "cancelling all"
3960 This option requests Exim to mark all the recipient addresses in the messages
3961 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3962 message is active (in the middle of a delivery attempt), its status is not
3963 altered. This option can be used only by an admin user.
3964
3965 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3966 .oindex "&%-Mmd%&"
3967 .cindex "delivery" "cancelling by address"
3968 .cindex "recipient" "removing"
3969 .cindex "removing recipients"
3970 This option requests Exim to mark the given addresses as already delivered
3971 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3972 the remaining ones must be email addresses. These are matched to recipient
3973 addresses in the message in a case-sensitive manner. If the message is active
3974 (in the middle of a delivery attempt), its status is not altered. This option
3975 can be used only by an admin user.
3976
3977 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3978 .oindex "&%-Mrm%&"
3979 .cindex "removing messages"
3980 .cindex "abandoning mail"
3981 .cindex "message" "manually discarding"
3982 This option requests Exim to remove the given messages from the queue. No
3983 bounce messages are sent; each message is simply forgotten. However, if any of
3984 the messages are active, their status is not altered. This option can be used
3985 only by an admin user or by the user who originally caused the message to be
3986 placed in the queue.
3987
3988 . .new
3989 . .vitem &%-MS%&
3990 . .oindex "&%-MS%&"
3991 . .cindex REQUIRETLS
3992 . This option is used to request REQUIRETLS processing on the message.
3993 . It is used internally by Exim in conjunction with -E when generating
3994 . a bounce message.
3995 . .wen
3996
3997 .vitem &%-Mset%&&~<&'message&~id'&>
3998 .oindex "&%-Mset%&"
3999 .cindex "testing" "string expansion"
4000 .cindex "expansion" "testing"
4001 This option is useful only in conjunction with &%-be%& (that is, when testing
4002 string expansions). Exim loads the given message from its spool before doing
4003 the test expansions, thus setting message-specific variables such as
4004 &$message_size$& and the header variables. The &$recipients$& variable is made
4005 available. This feature is provided to make it easier to test expansions that
4006 make use of these variables. However, this option can be used only by an admin
4007 user. See also &%-bem%&.
4008
4009 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4010 .oindex "&%-Mt%&"
4011 .cindex "thawing messages"
4012 .cindex "unfreezing messages"
4013 .cindex "frozen messages" "thawing"
4014 .cindex "message" "thawing frozen"
4015 This option requests Exim to &"thaw"& any of the listed messages that are
4016 &"frozen"&, so that delivery attempts can resume. However, if any of the
4017 messages are active, their status is not altered. This option can be used only
4018 by an admin user.
4019
4020 .vitem &%-Mvb%&&~<&'message&~id'&>
4021 .oindex "&%-Mvb%&"
4022 .cindex "listing" "message body"
4023 .cindex "message" "listing body of"
4024 This option causes the contents of the message body (-D) spool file to be
4025 written to the standard output. This option can be used only by an admin user.
4026
4027 .vitem &%-Mvc%&&~<&'message&~id'&>
4028 .oindex "&%-Mvc%&"
4029 .cindex "message" "listing in RFC 2822 format"
4030 .cindex "listing" "message in RFC 2822 format"
4031 This option causes a copy of the complete message (header lines plus body) to
4032 be written to the standard output in RFC 2822 format. This option can be used
4033 only by an admin user.
4034
4035 .vitem &%-Mvh%&&~<&'message&~id'&>
4036 .oindex "&%-Mvh%&"
4037 .cindex "listing" "message headers"
4038 .cindex "header lines" "listing"
4039 .cindex "message" "listing header lines"
4040 This option causes the contents of the message headers (-H) spool file to be
4041 written to the standard output. This option can be used only by an admin user.
4042
4043 .vitem &%-Mvl%&&~<&'message&~id'&>
4044 .oindex "&%-Mvl%&"
4045 .cindex "listing" "message log"
4046 .cindex "message" "listing message log"
4047 This option causes the contents of the message log spool file to be written to
4048 the standard output. This option can be used only by an admin user.
4049
4050 .vitem &%-m%&
4051 .oindex "&%-m%&"
4052 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4053 treats it that way too.
4054
4055 .vitem &%-N%&
4056 .oindex "&%-N%&"
4057 .cindex "debugging" "&%-N%& option"
4058 .cindex "debugging" "suppressing delivery"
4059 This is a debugging option that inhibits delivery of a message at the transport
4060 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4061 it just doesn't actually transport the message, but instead behaves as if it
4062 had successfully done so. However, it does not make any updates to the retry
4063 database, and the log entries for deliveries are flagged with &"*>"& rather
4064 than &"=>"&.
4065
4066 Because &%-N%& discards any message to which it applies, only root or the Exim
4067 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4068 words, an ordinary user can use it only when supplying an incoming message to
4069 which it will apply. Although transportation never fails when &%-N%& is set, an
4070 address may be deferred because of a configuration problem on a transport, or a
4071 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4072 the message, and applies to any subsequent delivery attempts that may happen
4073 for that message.
4074
4075 .vitem &%-n%&
4076 .oindex "&%-n%&"
4077 This option is interpreted by Sendmail to mean &"no aliasing"&.
4078 For normal modes of operation, it is ignored by Exim.
4079 When combined with &%-bP%& it makes the output more terse (suppresses
4080 option names, environment values and config pretty printing).
4081
4082 .vitem &%-O%&&~<&'data'&>
4083 .oindex "&%-O%&"
4084 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4085 Exim.
4086
4087 .vitem &%-oA%&&~<&'file&~name'&>
4088 .oindex "&%-oA%&"
4089 .cindex "Sendmail compatibility" "&%-oA%& option"
4090 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4091 alternative alias filename. Exim handles &%-bi%& differently; see the
4092 description above.
4093
4094 .vitem &%-oB%&&~<&'n'&>
4095 .oindex "&%-oB%&"
4096 .cindex "SMTP" "passed connection"
4097 .cindex "SMTP" "multiple deliveries"
4098 .cindex "multiple SMTP deliveries"
4099 This is a debugging option which limits the maximum number of messages that can
4100 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4101 transport. If <&'n'&> is omitted, the limit is set to 1.
4102
4103 .vitem &%-odb%&
4104 .oindex "&%-odb%&"
4105 .cindex "background delivery"
4106 .cindex "delivery" "in the background"
4107 This option applies to all modes in which Exim accepts incoming messages,
4108 including the listening daemon. It requests &"background"& delivery of such
4109 messages, which means that the accepting process automatically starts a
4110 delivery process for each message received, but does not wait for the delivery
4111 processes to finish.
4112
4113 When all the messages have been received, the reception process exits,
4114 leaving the delivery processes to finish in their own time. The standard output
4115 and error streams are closed at the start of each delivery process.
4116 This is the default action if none of the &%-od%& options are present.
4117
4118 If one of the queueing options in the configuration file
4119 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4120 overrides it if &%queue_only_override%& is set true, which is the default
4121 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4122
4123 .vitem &%-odf%&
4124 .oindex "&%-odf%&"
4125 .cindex "foreground delivery"
4126 .cindex "delivery" "in the foreground"
4127 This option requests &"foreground"& (synchronous) delivery when Exim has
4128 accepted a locally-generated message. (For the daemon it is exactly the same as
4129 &%-odb%&.) A delivery process is automatically started to deliver the message,
4130 and Exim waits for it to complete before proceeding.
4131
4132 The original Exim reception process does not finish until the delivery
4133 process for the final message has ended. The standard error stream is left open
4134 during deliveries.
4135
4136 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4137 false and one of the queueing options in the configuration file is in effect.
4138
4139 If there is a temporary delivery error during foreground delivery, the
4140 message is left in the queue for later delivery, and the original reception
4141 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4142 restricted configuration that never queues messages.
4143
4144
4145 .vitem &%-odi%&
4146 .oindex "&%-odi%&"
4147 This option is synonymous with &%-odf%&. It is provided for compatibility with
4148 Sendmail.
4149
4150 .vitem &%-odq%&
4151 .oindex "&%-odq%&"
4152 .cindex "non-immediate delivery"
4153 .cindex "delivery" "suppressing immediate"
4154 .cindex "queueing incoming messages"
4155 This option applies to all modes in which Exim accepts incoming messages,
4156 including the listening daemon. It specifies that the accepting process should
4157 not automatically start a delivery process for each message received. Messages
4158 are placed in the queue, and remain there until a subsequent queue runner
4159 process encounters them. There are several configuration options (such as
4160 &%queue_only%&) that can be used to queue incoming messages under certain
4161 conditions. This option overrides all of them and also &%-odqs%&. It always
4162 forces queueing.
4163
4164 .vitem &%-odqs%&
4165 .oindex "&%-odqs%&"
4166 .cindex "SMTP" "delaying delivery"
4167 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4168 However, like &%-odb%& and &%-odi%&, this option has no effect if
4169 &%queue_only_override%& is false and one of the queueing options in the
4170 configuration file is in effect.
4171
4172 When &%-odqs%& does operate, a delivery process is started for each incoming
4173 message, in the background by default, but in the foreground if &%-odi%& is
4174 also present. The recipient addresses are routed, and local deliveries are done
4175 in the normal way. However, if any SMTP deliveries are required, they are not
4176 done at this time, so the message remains in the queue until a subsequent queue
4177 runner process encounters it. Because routing was done, Exim knows which
4178 messages are waiting for which hosts, and so a number of messages for the same
4179 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4180 configuration option has the same effect for specific domains. See also the
4181 &%-qq%& option.
4182
4183 .vitem &%-oee%&
4184 .oindex "&%-oee%&"
4185 .cindex "error" "reporting"
4186 If an error is detected while a non-SMTP message is being received (for
4187 example, a malformed address), the error is reported to the sender in a mail
4188 message.
4189
4190 .cindex "return code" "for &%-oee%&"
4191 Provided
4192 this error message is successfully sent, the Exim receiving process
4193 exits with a return code of zero. If not, the return code is 2 if the problem
4194 is that the original message has no recipients, or 1 for any other error.
4195 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4196
4197 .vitem &%-oem%&
4198 .oindex "&%-oem%&"
4199 .cindex "error" "reporting"
4200 .cindex "return code" "for &%-oem%&"
4201 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4202 return code, whether or not the error message was successfully sent.
4203 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4204
4205 .vitem &%-oep%&
4206 .oindex "&%-oep%&"
4207 .cindex "error" "reporting"
4208 If an error is detected while a non-SMTP message is being received, the
4209 error is reported by writing a message to the standard error file (stderr).
4210 .cindex "return code" "for &%-oep%&"
4211 The return code is 1 for all errors.
4212
4213 .vitem &%-oeq%&
4214 .oindex "&%-oeq%&"
4215 .cindex "error" "reporting"
4216 This option is supported for compatibility with Sendmail, but has the same
4217 effect as &%-oep%&.
4218
4219 .vitem &%-oew%&
4220 .oindex "&%-oew%&"
4221 .cindex "error" "reporting"
4222 This option is supported for compatibility with Sendmail, but has the same
4223 effect as &%-oem%&.
4224
4225 .vitem &%-oi%&
4226 .oindex "&%-oi%&"
4227 .cindex "dot" "in incoming non-SMTP message"
4228 This option, which has the same effect as &%-i%&, specifies that a dot on a
4229 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4230 single dot does terminate, though Exim does no special processing for other
4231 lines that start with a dot. This option is set by default if Exim is called as
4232 &'rmail'&. See also &%-ti%&.
4233
4234 .vitem &%-oitrue%&
4235 .oindex "&%-oitrue%&"
4236 This option is treated as synonymous with &%-oi%&.
4237
4238 .vitem &%-oMa%&&~<&'host&~address'&>
4239 .oindex "&%-oMa%&"
4240 .cindex "sender" "host address, specifying for local message"
4241 A number of options starting with &%-oM%& can be used to set values associated
4242 with remote hosts on locally-submitted messages (that is, messages not received
4243 over TCP/IP). These options can be used by any caller in conjunction with the
4244 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4245 other circumstances, they are ignored unless the caller is trusted.
4246
4247 The &%-oMa%& option sets the sender host address. This may include a port
4248 number at the end, after a full stop (period). For example:
4249 .code
4250 exim -bs -oMa 10.9.8.7.1234
4251 .endd
4252 An alternative syntax is to enclose the IP address in square brackets,
4253 followed by a colon and the port number:
4254 .code
4255 exim -bs -oMa [10.9.8.7]:1234
4256 .endd
4257 The IP address is placed in the &$sender_host_address$& variable, and the
4258 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4259 are present on the command line, the sender host IP address is taken from
4260 whichever one is last.
4261
4262 .vitem &%-oMaa%&&~<&'name'&>
4263 .oindex "&%-oMaa%&"
4264 .cindex "authentication" "name, specifying for local message"
4265 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4266 option sets the value of &$sender_host_authenticated$& (the authenticator
4267 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4268 This option can be used with &%-bh%& and &%-bs%& to set up an
4269 authenticated SMTP session without actually using the SMTP AUTH command.
4270
4271 .vitem &%-oMai%&&~<&'string'&>
4272 .oindex "&%-oMai%&"
4273 .cindex "authentication" "id, specifying for local message"
4274 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4275 option sets the value of &$authenticated_id$& (the id that was authenticated).
4276 This overrides the default value (the caller's login id, except with &%-bh%&,
4277 where there is no default) for messages from local sources. See chapter
4278 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4279
4280 .vitem &%-oMas%&&~<&'address'&>
4281 .oindex "&%-oMas%&"
4282 .cindex "authentication" "sender, specifying for local message"
4283 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4284 option sets the authenticated sender value in &$authenticated_sender$&. It
4285 overrides the sender address that is created from the caller's login id for
4286 messages from local sources, except when &%-bh%& is used, when there is no
4287 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4288 specified on a MAIL command overrides this value. See chapter
4289 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4290
4291 .vitem &%-oMi%&&~<&'interface&~address'&>
4292 .oindex "&%-oMi%&"
4293 .cindex "interface" "address, specifying for local message"
4294 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4295 option sets the IP interface address value. A port number may be included,
4296 using the same syntax as for &%-oMa%&. The interface address is placed in
4297 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4298
4299 .vitem &%-oMm%&&~<&'message&~reference'&>
4300 .oindex "&%-oMm%&"
4301 .cindex "message reference" "message reference, specifying for local message"
4302 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4303 option sets the message reference, e.g. message-id, and is logged during
4304 delivery. This is useful when some kind of audit trail is required to tie
4305 messages together. The format of the message reference is checked and will
4306 abort if the format is invalid. The option will only be accepted if exim is
4307 running in trusted mode, not as any regular user.
4308
4309 The best example of a message reference is when Exim sends a bounce message.
4310 The message reference is the message-id of the original message for which Exim
4311 is sending the bounce.
4312
4313 .vitem &%-oMr%&&~<&'protocol&~name'&>
4314 .oindex "&%-oMr%&"
4315 .cindex "protocol, specifying for local message"
4316 .vindex "&$received_protocol$&"
4317 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4318 option sets the received protocol value that is stored in
4319 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4320 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4321 SMTP protocol names (see the description of &$received_protocol$& in section
4322 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4323 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4324 be set by &%-oMr%&. Repeated use of this option is not supported.
4325
4326 .vitem &%-oMs%&&~<&'host&~name'&>
4327 .oindex "&%-oMs%&"
4328 .cindex "sender" "host name, specifying for local message"
4329 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4330 option sets the sender host name in &$sender_host_name$&. When this option is
4331 present, Exim does not attempt to look up a host name from an IP address; it
4332 uses the name it is given.
4333
4334 .vitem &%-oMt%&&~<&'ident&~string'&>
4335 .oindex "&%-oMt%&"
4336 .cindex "sender" "ident string, specifying for local message"
4337 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4338 option sets the sender ident value in &$sender_ident$&. The default setting for
4339 local callers is the login id of the calling process, except when &%-bh%& is
4340 used, when there is no default.
4341
4342 .vitem &%-om%&
4343 .oindex "&%-om%&"
4344 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4345 In Sendmail, this option means &"me too"&, indicating that the sender of a
4346 message should receive a copy of the message if the sender appears in an alias
4347 expansion. Exim always does this, so the option does nothing.
4348
4349 .vitem &%-oo%&
4350 .oindex "&%-oo%&"
4351 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4352 This option is ignored. In Sendmail it specifies &"old style headers"&,
4353 whatever that means.
4354
4355 .vitem &%-oP%&&~<&'path'&>
4356 .oindex "&%-oP%&"
4357 .cindex "pid (process id)" "of daemon"
4358 .cindex "daemon" "process id (pid)"
4359 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4360 value. The option specifies the file to which the process id of the daemon is
4361 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4362 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4363 because in those cases, the normal pid file is not used.
4364
4365 .vitem &%-or%&&~<&'time'&>
4366 .oindex "&%-or%&"
4367 .cindex "timeout" "for non-SMTP input"
4368 This option sets a timeout value for incoming non-SMTP messages. If it is not
4369 set, Exim will wait forever for the standard input. The value can also be set
4370 by the &%receive_timeout%& option. The format used for specifying times is
4371 described in section &<<SECTtimeformat>>&.
4372
4373 .vitem &%-os%&&~<&'time'&>
4374 .oindex "&%-os%&"
4375 .cindex "timeout" "for SMTP input"
4376 .cindex "SMTP" "input timeout"
4377 This option sets a timeout value for incoming SMTP messages. The timeout
4378 applies to each SMTP command and block of data. The value can also be set by
4379 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4380 for specifying times is described in section &<<SECTtimeformat>>&.
4381
4382 .vitem &%-ov%&
4383 .oindex "&%-ov%&"
4384 This option has exactly the same effect as &%-v%&.
4385
4386 .vitem &%-oX%&&~<&'number&~or&~string'&>
4387 .oindex "&%-oX%&"
4388 .cindex "TCP/IP" "setting listening ports"
4389 .cindex "TCP/IP" "setting listening interfaces"
4390 .cindex "port" "receiving TCP/IP"
4391 This option is relevant only when the &%-bd%& (start listening daemon) option
4392 is also given. It controls which ports and interfaces the daemon uses. Details
4393 of the syntax, and how it interacts with configuration file options, are given
4394 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4395 file is written unless &%-oP%& is also present to specify a pid filename.
4396
4397 .vitem &%-pd%&
4398 .oindex "&%-pd%&"
4399 .cindex "Perl" "starting the interpreter"
4400 This option applies when an embedded Perl interpreter is linked with Exim (see
4401 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4402 option, forcing the starting of the interpreter to be delayed until it is
4403 needed.
4404
4405 .vitem &%-ps%&
4406 .oindex "&%-ps%&"
4407 .cindex "Perl" "starting the interpreter"
4408 This option applies when an embedded Perl interpreter is linked with Exim (see
4409 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4410 option, forcing the starting of the interpreter to occur as soon as Exim is
4411 started.
4412
4413 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4414 .oindex "&%-p%&"
4415 For compatibility with Sendmail, this option is equivalent to
4416 .display
4417 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4418 .endd
4419 It sets the incoming protocol and host name (for trusted callers). The
4420 host name and its colon can be omitted when only the protocol is to be set.
4421 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4422 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4423 or &`s`& using this option (but that does not seem a real limitation).
4424 Repeated use of this option is not supported.
4425
4426 .vitem &%-q%&
4427 .oindex "&%-q%&"
4428 .cindex "queue runner" "starting manually"
4429 This option is normally restricted to admin users. However, there is a
4430 configuration option called &%prod_requires_admin%& which can be set false to
4431 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4432 and &%-S%& options).
4433
4434 .cindex "queue runner" "description of operation"
4435 If other commandline options do not specify an action,
4436 the &%-q%& option starts one queue runner process. This scans the queue of
4437 waiting messages, and runs a delivery process for each one in turn. It waits
4438 for each delivery process to finish before starting the next one. A delivery
4439 process may not actually do any deliveries if the retry times for the addresses
4440 have not been reached. Use &%-qf%& (see below) if you want to override this.
4441
4442 If
4443 .cindex "SMTP" "passed connection"
4444 .cindex "SMTP" "multiple deliveries"
4445 .cindex "multiple SMTP deliveries"
4446 the delivery process spawns other processes to deliver other messages down
4447 passed SMTP connections, the queue runner waits for these to finish before
4448 proceeding.
4449
4450 When all the queued messages have been considered, the original queue runner
4451 process terminates. In other words, a single pass is made over the waiting
4452 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4453 this to be repeated periodically.
4454
4455 Exim processes the waiting messages in an unpredictable order. It isn't very
4456 random, but it is likely to be different each time, which is all that matters.
4457 If one particular message screws up a remote MTA, other messages to the same
4458 MTA have a chance of getting through if they get tried first.
4459
4460 It is possible to cause the messages to be processed in lexical message id
4461 order, which is essentially the order in which they arrived, by setting the
4462 &%queue_run_in_order%& option, but this is not recommended for normal use.
4463
4464 .vitem &%-q%&<&'qflags'&>
4465 The &%-q%& option may be followed by one or more flag letters that change its
4466 behaviour. They are all optional, but if more than one is present, they must
4467 appear in the correct order. Each flag is described in a separate item below.
4468
4469 .vitem &%-qq...%&
4470 .oindex "&%-qq%&"
4471 .cindex "queue" "double scanning"
4472 .cindex "queue" "routing"
4473 .cindex "routing" "whole queue before delivery"
4474 An option starting with &%-qq%& requests a two-stage queue run. In the first
4475 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4476 every domain. Addresses are routed, local deliveries happen, but no remote
4477 transports are run.
4478
4479 .cindex "hints database" "remembering routing"
4480 The hints database that remembers which messages are waiting for specific hosts
4481 is updated, as if delivery to those hosts had been deferred. After this is
4482 complete, a second, normal queue scan happens, with routing and delivery taking
4483 place as normal. Messages that are routed to the same host should mostly be
4484 delivered down a single SMTP
4485 .cindex "SMTP" "passed connection"
4486 .cindex "SMTP" "multiple deliveries"
4487 .cindex "multiple SMTP deliveries"
4488 connection because of the hints that were set up during the first queue scan.
4489 This option may be useful for hosts that are connected to the Internet
4490 intermittently.
4491
4492 .vitem &%-q[q]i...%&
4493 .oindex "&%-qi%&"
4494 .cindex "queue" "initial delivery"
4495 If the &'i'& flag is present, the queue runner runs delivery processes only for
4496 those messages that haven't previously been tried. (&'i'& stands for &"initial
4497 delivery"&.) This can be helpful if you are putting messages in the queue using
4498 &%-odq%& and want a queue runner just to process the new messages.
4499
4500 .vitem &%-q[q][i]f...%&
4501 .oindex "&%-qf%&"
4502 .cindex "queue" "forcing delivery"
4503 .cindex "delivery" "forcing in queue run"
4504 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4505 message, whereas without &'f'& only those non-frozen addresses that have passed
4506 their retry times are tried.
4507
4508 .vitem &%-q[q][i]ff...%&
4509 .oindex "&%-qff%&"
4510 .cindex "frozen messages" "forcing delivery"
4511 If &'ff'& is present, a delivery attempt is forced for every message, whether
4512 frozen or not.
4513
4514 .vitem &%-q[q][i][f[f]]l%&
4515 .oindex "&%-ql%&"
4516 .cindex "queue" "local deliveries only"
4517 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4518 be done. If a message requires any remote deliveries, it remains in the queue
4519 for later delivery.
4520
4521 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4522 .oindex "&%-qG%&"
4523 .cindex queue named
4524 .cindex "named queues"
4525 .cindex "queue" "delivering specific messages"
4526 If the &'G'& flag and a name is present, the queue runner operates on the
4527 queue with the given name rather than the default queue.
4528 The name should not contain a &'/'& character.
4529 For a periodic queue run (see below)
4530 append to the name a slash and a time value.
4531
4532 If other commandline options specify an action, a &'-qG<name>'& option
4533 will specify a queue to operate on.
4534 For example:
4535 .code
4536 exim -bp -qGquarantine
4537 mailq -qGquarantine
4538 exim -qGoffpeak -Rf @special.domain.example
4539 .endd
4540
4541 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4542 When scanning the queue, Exim can be made to skip over messages whose ids are
4543 lexically less than a given value by following the &%-q%& option with a
4544 starting message id. For example:
4545 .code
4546 exim -q 0t5C6f-0000c8-00
4547 .endd
4548 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4549 second message id is given, messages whose ids are lexically greater than it
4550 are also skipped. If the same id is given twice, for example,
4551 .code
4552 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4553 .endd
4554 just one delivery process is started, for that message. This differs from
4555 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4556 that it counts as a delivery from a queue run. Note that the selection
4557 mechanism does not affect the order in which the messages are scanned. There
4558 are also other ways of selecting specific sets of messages for delivery in a
4559 queue run &-- see &%-R%& and &%-S%&.
4560
4561 .vitem &%-q%&<&'qflags'&><&'time'&>
4562 .cindex "queue runner" "starting periodically"
4563 .cindex "periodic queue running"
4564 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4565 starting a queue runner process at intervals specified by the given time value
4566 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4567 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4568 single daemon process handles both functions. A common way of starting up a
4569 combined daemon at system boot time is to use a command such as
4570 .code
4571 /usr/exim/bin/exim -bd -q30m
4572 .endd
4573 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4574 process every 30 minutes.
4575
4576 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4577 pid file is written unless one is explicitly requested by the &%-oP%& option.
4578
4579 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4580 .oindex "&%-qR%&"
4581 This option is synonymous with &%-R%&. It is provided for Sendmail
4582 compatibility.
4583
4584 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4585 .oindex "&%-qS%&"
4586 This option is synonymous with &%-S%&.
4587
4588 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4589 .oindex "&%-R%&"
4590 .cindex "queue runner" "for specific recipients"
4591 .cindex "delivery" "to given domain"
4592 .cindex "domain" "delivery to"
4593 The <&'rsflags'&> may be empty, in which case the white space before the string
4594 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4595 which are the possible values for <&'rsflags'&>. White space is required if
4596 <&'rsflags'&> is not empty.
4597
4598 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4599 perform a single queue run, except that, when scanning the messages on the
4600 queue, Exim processes only those that have at least one undelivered recipient
4601 address containing the given string, which is checked in a case-independent
4602 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4603 regular expression; otherwise it is a literal string.
4604
4605 If you want to do periodic queue runs for messages with specific recipients,
4606 you can combine &%-R%& with &%-q%& and a time value. For example:
4607 .code
4608 exim -q25m -R @special.domain.example
4609 .endd
4610 This example does a queue run for messages with recipients in the given domain
4611 every 25 minutes. Any additional flags that are specified with &%-q%& are
4612 applied to each queue run.
4613
4614 Once a message is selected for delivery by this mechanism, all its addresses
4615 are processed. For the first selected message, Exim overrides any retry
4616 information and forces a delivery attempt for each undelivered address. This
4617 means that if delivery of any address in the first message is successful, any
4618 existing retry information is deleted, and so delivery attempts for that
4619 address in subsequently selected messages (which are processed without forcing)
4620 will run. However, if delivery of any address does not succeed, the retry
4621 information is updated, and in subsequently selected messages, the failing
4622 address will be skipped.
4623
4624 .cindex "frozen messages" "forcing delivery"
4625 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4626 all selected messages, not just the first; frozen messages are included when
4627 &'ff'& is present.
4628
4629 The &%-R%& option makes it straightforward to initiate delivery of all messages
4630 to a given domain after a host has been down for some time. When the SMTP
4631 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4632 effect is to run Exim with the &%-R%& option, but it can be configured to run
4633 an arbitrary command instead.
4634
4635 .vitem &%-r%&
4636 .oindex "&%-r%&"
4637 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4638
4639 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4640 .oindex "&%-S%&"
4641 .cindex "delivery" "from given sender"
4642 .cindex "queue runner" "for specific senders"
4643 This option acts like &%-R%& except that it checks the string against each
4644 message's sender instead of against the recipients. If &%-R%& is also set, both
4645 conditions must be met for a message to be selected. If either of the options
4646 has &'f'& or &'ff'& in its flags, the associated action is taken.
4647
4648 .vitem &%-Tqt%&&~<&'times'&>
4649 .oindex "&%-Tqt%&"
4650 This is an option that is exclusively for use by the Exim testing suite. It is not
4651 recognized when Exim is run normally. It allows for the setting up of explicit
4652 &"queue times"& so that various warning/retry features can be tested.
4653
4654 .vitem &%-t%&
4655 .oindex "&%-t%&"
4656 .cindex "recipient" "extracting from header lines"
4657 .cindex "&'Bcc:'& header line"
4658 .cindex "&'Cc:'& header line"
4659 .cindex "&'To:'& header line"
4660 When Exim is receiving a locally-generated, non-SMTP message on its standard
4661 input, the &%-t%& option causes the recipients of the message to be obtained
4662 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4663 from the command arguments. The addresses are extracted before any rewriting
4664 takes place and the &'Bcc:'& header line, if present, is then removed.
4665
4666 .cindex "Sendmail compatibility" "&%-t%& option"
4667 If the command has any arguments, they specify addresses to which the message
4668 is &'not'& to be delivered. That is, the argument addresses are removed from
4669 the recipients list obtained from the headers. This is compatible with Smail 3
4670 and in accordance with the documented behaviour of several versions of
4671 Sendmail, as described in man pages on a number of operating systems (e.g.
4672 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4673 argument addresses to those obtained from the headers, and the O'Reilly
4674 Sendmail book documents it that way. Exim can be made to add argument addresses
4675 instead of subtracting them by setting the option
4676 &%extract_addresses_remove_arguments%& false.
4677
4678 .cindex "&%Resent-%& header lines" "with &%-t%&"
4679 If there are any &%Resent-%& header lines in the message, Exim extracts
4680 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4681 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4682 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4683 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4684
4685 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4686 message is resent several times). The RFC also specifies that they should be
4687 added at the front of the message, and separated by &'Received:'& lines. It is
4688 not at all clear how &%-t%& should operate in the present of multiple sets,
4689 nor indeed exactly what constitutes a &"set"&.
4690 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4691 are often added at the end of the header, and if a message is resent more than
4692 once, it is common for the original set of &%Resent-%& headers to be renamed as
4693 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4694
4695 .vitem &%-ti%&
4696 .oindex "&%-ti%&"
4697 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4698 compatibility with Sendmail.
4699
4700 .vitem &%-tls-on-connect%&
4701 .oindex "&%-tls-on-connect%&"
4702 .cindex "TLS" "use without STARTTLS"
4703 .cindex "TLS" "automatic start"
4704 This option is available when Exim is compiled with TLS support. It forces all
4705 incoming SMTP connections to behave as if the incoming port is listed in the
4706 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4707 &<<CHAPTLS>>& for further details.
4708
4709
4710 .vitem &%-U%&
4711 .oindex "&%-U%&"
4712 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4713 Sendmail uses this option for &"initial message submission"&, and its
4714 documentation states that in future releases, it may complain about
4715 syntactically invalid messages rather than fixing them when this flag is not
4716 set. Exim ignores this option.
4717
4718 .vitem &%-v%&
4719 .oindex "&%-v%&"
4720 This option causes Exim to write information to the standard error stream,
4721 describing what it is doing. In particular, it shows the log lines for
4722 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4723 dialogue is shown. Some of the log lines shown may not actually be written to
4724 the log if the setting of &%log_selector%& discards them. Any relevant
4725 selectors are shown with each log line. If none are shown, the logging is
4726 unconditional.
4727
4728 .vitem &%-x%&
4729 .oindex "&%-x%&"
4730 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4731 National Language Support extended characters in the body of the mail item"&).
4732 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4733 this option.
4734
4735 .vitem &%-X%&&~<&'logfile'&>
4736 .oindex "&%-X%&"
4737 This option is interpreted by Sendmail to cause debug information to be sent
4738 to the named file.  It is ignored by Exim.
4739
4740 .vitem &%-z%&&~<&'log-line'&>
4741 .oindex "&%-z%&"
4742 This option writes its argument to Exim's logfile.
4743 Use is restricted to administrators; the intent is for operational notes.
4744 Quotes should be used to maintain a multi-word item as a single argument,
4745 under most shells.
4746 .endlist
4747
4748 .ecindex IIDclo1
4749 .ecindex IIDclo2
4750
4751
4752 . ////////////////////////////////////////////////////////////////////////////
4753 . Insert a stylized DocBook comment here, to identify the end of the command
4754 . line options. This is for the benefit of the Perl script that automatically
4755 . creates a man page for the options.
4756 . ////////////////////////////////////////////////////////////////////////////
4757
4758 .literal xml
4759 <!-- === End of command line options === -->
4760 .literal off
4761
4762
4763
4764
4765
4766 . ////////////////////////////////////////////////////////////////////////////
4767 . ////////////////////////////////////////////////////////////////////////////
4768
4769
4770 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4771          "The runtime configuration file"
4772
4773 .cindex "runtime configuration"
4774 .cindex "configuration file" "general description"
4775 .cindex "CONFIGURE_FILE"
4776 .cindex "configuration file" "errors in"
4777 .cindex "error" "in configuration file"
4778 .cindex "return code" "for bad configuration"
4779 Exim uses a single runtime configuration file that is read whenever an Exim
4780 binary is executed. Note that in normal operation, this happens frequently,
4781 because Exim is designed to operate in a distributed manner, without central
4782 control.
4783
4784 If a syntax error is detected while reading the configuration file, Exim
4785 writes a message on the standard error, and exits with a non-zero return code.
4786 The message is also written to the panic log. &*Note*&: Only simple syntax
4787 errors can be detected at this time. The values of any expanded options are
4788 not checked until the expansion happens, even when the expansion does not
4789 actually alter the string.
4790
4791 The name of the configuration file is compiled into the binary for security
4792 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4793 most configurations, this specifies a single file. However, it is permitted to
4794 give a colon-separated list of filenames, in which case Exim uses the first
4795 existing file in the list.
4796
4797 .cindex "EXIM_USER"
4798 .cindex "EXIM_GROUP"
4799 .cindex "CONFIGURE_OWNER"
4800 .cindex "CONFIGURE_GROUP"
4801 .cindex "configuration file" "ownership"
4802 .cindex "ownership" "configuration file"
4803 The runtime configuration file must be owned by root or by the user that is
4804 specified at compile time by the CONFIGURE_OWNER option (if set). The
4805 configuration file must not be world-writeable, or group-writeable unless its
4806 group is the root group or the one specified at compile time by the
4807 CONFIGURE_GROUP option.
4808
4809 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4810 to root, anybody who is able to edit the runtime configuration file has an
4811 easy way to run commands as root. If you specify a user or group in the
4812 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4813 who are members of that group will trivially be able to obtain root privileges.
4814
4815 Up to Exim version 4.72, the runtime configuration file was also permitted to
4816 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4817 since it offered a simple privilege escalation for any attacker who managed to
4818 compromise the Exim user account.
4819
4820 A default configuration file, which will work correctly in simple situations,
4821 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4822 defines just one filename, the installation process copies the default
4823 configuration to a new file of that name if it did not previously exist. If
4824 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4825 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4826 configuration.
4827
4828
4829
4830 .section "Using a different configuration file" "SECID40"
4831 .cindex "configuration file" "alternate"
4832 A one-off alternate configuration can be specified by the &%-C%& command line
4833 option, which may specify a single file or a list of files. However, when
4834 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4835 unless the argument for &%-C%& is identical to the built-in value from
4836 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4837 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4838 is useful mainly for checking the syntax of configuration files before
4839 installing them. No owner or group checks are done on a configuration file
4840 specified by &%-C%&, if root privilege has been dropped.
4841
4842 Even the Exim user is not trusted to specify an arbitrary configuration file
4843 with the &%-C%& option to be used with root privileges, unless that file is
4844 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4845 testing a configuration using &%-C%& right through message reception and
4846 delivery, even if the caller is root. The reception works, but by that time,
4847 Exim is running as the Exim user, so when it re-execs to regain privilege for
4848 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4849 can test reception and delivery using two separate commands (one to put a
4850 message in the queue, using &%-odq%&, and another to do the delivery, using
4851 &%-M%&).
4852
4853 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4854 prefix string with which any file named in a &%-C%& command line option must
4855 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4856 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4857 filename can be used with &%-C%&.
4858
4859 One-off changes to a configuration can be specified by the &%-D%& command line
4860 option, which defines and overrides values for macros used inside the
4861 configuration file. However, like &%-C%&, the use of this option by a
4862 non-privileged user causes Exim to discard its root privilege.
4863 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4864 completely disabled, and its use causes an immediate error exit.
4865
4866 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4867 to declare certain macro names trusted, such that root privilege will not
4868 necessarily be discarded.
4869 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4870 considered safe and, if &%-D%& only supplies macros from this list, and the
4871 values are acceptable, then Exim will not give up root privilege if the caller
4872 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4873 transition mechanism and is expected to be removed in the future.  Acceptable
4874 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4875
4876 Some sites may wish to use the same Exim binary on different machines that
4877 share a file system, but to use different configuration files on each machine.
4878 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4879 looks for a file whose name is the configuration filename followed by a dot
4880 and the machine's node name, as obtained from the &[uname()]& function. If this
4881 file does not exist, the standard name is tried. This processing occurs for
4882 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4883
4884 In some esoteric situations different versions of Exim may be run under
4885 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4886 help with this. See the comments in &_src/EDITME_& for details.
4887
4888
4889
4890 .section "Configuration file format" "SECTconffilfor"
4891 .cindex "configuration file" "format of"
4892 .cindex "format" "configuration file"
4893 Exim's configuration file is divided into a number of different parts. General
4894 option settings must always appear at the start of the file. The other parts
4895 are all optional, and may appear in any order. Each part other than the first
4896 is introduced by the word &"begin"& followed by at least one literal
4897 space, and the name of the part. The optional parts are:
4898
4899 .ilist
4900 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4901 &<<CHAPACL>>&).
4902 .next
4903 .cindex "AUTH" "configuration"
4904 &'authenticators'&: Configuration settings for the authenticator drivers. These
4905 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4906 .next
4907 &'routers'&: Configuration settings for the router drivers. Routers process
4908 addresses and determine how the message is to be delivered (see chapters
4909 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4910 .next
4911 &'transports'&: Configuration settings for the transport drivers. Transports
4912 define mechanisms for copying messages to destinations (see chapters
4913 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4914 .next
4915 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4916 If there is no retry section, or if it is empty (that is, no retry rules are
4917 defined), Exim will not retry deliveries. In this situation, temporary errors
4918 are treated the same as permanent errors. Retry rules are discussed in chapter
4919 &<<CHAPretry>>&.
4920 .next
4921 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4922 when new addresses are generated during delivery. Rewriting is discussed in
4923 chapter &<<CHAPrewrite>>&.
4924 .next
4925 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4926 want to use this feature, you must set
4927 .code
4928 LOCAL_SCAN_HAS_OPTIONS=yes
4929 .endd
4930 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4931 facility are given in chapter &<<CHAPlocalscan>>&.
4932 .endlist
4933
4934 .cindex "configuration file" "leading white space in"
4935 .cindex "configuration file" "trailing white space in"
4936 .cindex "white space" "in configuration file"
4937 Leading and trailing white space in configuration lines is always ignored.
4938
4939 Blank lines in the file, and lines starting with a # character (ignoring
4940 leading white space) are treated as comments and are ignored. &*Note*&: A
4941 # character other than at the beginning of a line is not treated specially,
4942 and does not introduce a comment.
4943
4944 Any non-comment line can be continued by ending it with a backslash. Note that
4945 the general rule for white space means that trailing white space after the
4946 backslash and leading white space at the start of continuation
4947 lines is ignored. Comment lines beginning with # (but not empty lines) may
4948 appear in the middle of a sequence of continuation lines.
4949
4950 A convenient way to create a configuration file is to start from the
4951 default, which is supplied in &_src/configure.default_&, and add, delete, or
4952 change settings as required.
4953
4954 The ACLs, retry rules, and rewriting rules have their own syntax which is
4955 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4956 respectively. The other parts of the configuration file have some syntactic
4957 items in common, and these are described below, from section &<<SECTcos>>&
4958 onwards. Before that, the inclusion, macro, and conditional facilities are
4959 described.
4960
4961
4962
4963 .section "File inclusions in the configuration file" "SECID41"
4964 .cindex "inclusions in configuration file"
4965 .cindex "configuration file" "including other files"
4966 .cindex "&`.include`& in configuration file"
4967 .cindex "&`.include_if_exists`& in configuration file"
4968 You can include other files inside Exim's runtime configuration file by
4969 using this syntax:
4970 .display
4971 &`.include`& <&'filename'&>
4972 &`.include_if_exists`& <&'filename'&>
4973 .endd
4974 on a line by itself. Double quotes round the filename are optional. If you use
4975 the first form, a configuration error occurs if the file does not exist; the
4976 second form does nothing for non-existent files.
4977 The first form allows a relative name. It is resolved relative to
4978 the directory of the including file. For the second form an absolute filename
4979 is required.
4980
4981 Includes may be nested to any depth, but remember that Exim reads its
4982 configuration file often, so it is a good idea to keep them to a minimum.
4983 If you change the contents of an included file, you must HUP the daemon,
4984 because an included file is read only when the configuration itself is read.
4985
4986 The processing of inclusions happens early, at a physical line level, so, like
4987 comment lines, an inclusion can be used in the middle of an option setting,
4988 for example:
4989 .code
4990 hosts_lookup = a.b.c \
4991                .include /some/file
4992 .endd
4993 Include processing happens after macro processing (see below). Its effect is to
4994 process the lines of the included file as if they occurred inline where the
4995 inclusion appears.
4996
4997
4998
4999 .section "Macros in the configuration file" "SECTmacrodefs"
5000 .cindex "macro" "description of"
5001 .cindex "configuration file" "macros"
5002 If a line in the main part of the configuration (that is, before the first
5003 &"begin"& line) begins with an upper case letter, it is taken as a macro
5004 definition, and must be of the form
5005 .display
5006 <&'name'&> = <&'rest of line'&>
5007 .endd
5008 The name must consist of letters, digits, and underscores, and need not all be
5009 in upper case, though that is recommended. The rest of the line, including any
5010 continuations, is the replacement text, and has leading and trailing white
5011 space removed. Quotes are not removed. The replacement text can never end with
5012 a backslash character, but this doesn't seem to be a serious limitation.
5013
5014 Macros may also be defined between router, transport, authenticator, or ACL
5015 definitions. They may not, however, be defined within an individual driver or
5016 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5017
5018 .section "Macro substitution" "SECID42"
5019 Once a macro is defined, all subsequent lines in the file (and any included
5020 files) are scanned for the macro name; if there are several macros, the line is
5021 scanned for each, in turn, in the order in which the macros are defined. The
5022 replacement text is not re-scanned for the current macro, though it is scanned
5023 for subsequently defined macros. For this reason, a macro name may not contain
5024 the name of a previously defined macro as a substring. You could, for example,
5025 define
5026 .display
5027 &`ABCD_XYZ = `&<&'something'&>
5028 &`ABCD = `&<&'something else'&>
5029 .endd
5030 but putting the definitions in the opposite order would provoke a configuration
5031 error. Macro expansion is applied to individual physical lines from the file,
5032 before checking for line continuation or file inclusion (see above). If a line
5033 consists solely of a macro name, and the expansion of the macro is empty, the
5034 line is ignored. A macro at the start of a line may turn the line into a
5035 comment line or a &`.include`& line.
5036
5037
5038 .section "Redefining macros" "SECID43"
5039 Once defined, the value of a macro can be redefined later in the configuration
5040 (or in an included file). Redefinition is specified by using &'=='& instead of
5041 &'='&. For example:
5042 .code
5043 MAC =  initial value
5044 ...
5045 MAC == updated value
5046 .endd
5047 Redefinition does not alter the order in which the macros are applied to the
5048 subsequent lines of the configuration file. It is still the same order in which
5049 the macros were originally defined. All that changes is the macro's value.
5050 Redefinition makes it possible to accumulate values. For example:
5051 .code
5052 MAC =  initial value
5053 ...
5054 MAC == MAC and something added
5055 .endd
5056 This can be helpful in situations where the configuration file is built
5057 from a number of other files.
5058
5059 .section "Overriding macro values" "SECID44"
5060 The values set for macros in the configuration file can be overridden by the
5061 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5062 used, unless called by root or the Exim user. A definition on the command line
5063 using the &%-D%& option causes all definitions and redefinitions within the
5064 file to be ignored.
5065
5066
5067
5068 .section "Example of macro usage" "SECID45"
5069 As an example of macro usage, consider a configuration where aliases are looked
5070 up in a MySQL database. It helps to keep the file less cluttered if long
5071 strings such as SQL statements are defined separately as macros, for example:
5072 .code
5073 ALIAS_QUERY = select mailbox from user where \
5074               login='${quote_mysql:$local_part}';
5075 .endd
5076 This can then be used in a &(redirect)& router setting like this:
5077 .code
5078 data = ${lookup mysql{ALIAS_QUERY}}
5079 .endd
5080 In earlier versions of Exim macros were sometimes used for domain, host, or
5081 address lists. In Exim 4 these are handled better by named lists &-- see
5082 section &<<SECTnamedlists>>&.
5083
5084
5085 .section "Builtin macros" "SECTbuiltinmacros"
5086 Exim defines some macros depending on facilities available, which may
5087 differ due to build-time definitions and from one release to another.
5088 All of these macros start with an underscore.
5089 They can be used to conditionally include parts of a configuration
5090 (see below).
5091
5092 The following classes of macros are defined:
5093 .display
5094 &` _HAVE_*                    `&  build-time defines
5095 &` _DRIVER_ROUTER_*           `&  router drivers
5096 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5097 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5098 &` _LOG_*                     `&  log_selector values
5099 &` _OPT_MAIN_*                `&  main config options
5100 &` _OPT_ROUTERS_*             `&  generic router options
5101 &` _OPT_TRANSPORTS_*          `&  generic transport options
5102 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5103 &` _OPT_ROUTER_*_*            `&  private router options
5104 &` _OPT_TRANSPORT_*_*         `&  private transport options
5105 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5106 .endd
5107
5108 Use an &"exim -bP macros"& command to get the list of macros.
5109
5110
5111 .section "Conditional skips in the configuration file" "SECID46"
5112 .cindex "configuration file" "conditional skips"
5113 .cindex "&`.ifdef`&"
5114 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5115 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5116 portions of the configuration file. The processing happens whenever the file is
5117 read (that is, when an Exim binary starts to run).
5118
5119 The implementation is very simple. Instances of the first four directives must
5120 be followed by text that includes the names of one or macros. The condition
5121 that is tested is whether or not any macro substitution has taken place in the
5122 line. Thus:
5123 .code
5124 .ifdef AAA
5125 message_size_limit = 50M
5126 .else
5127 message_size_limit = 100M
5128 .endif
5129 .endd
5130 sets a message size limit of 50M if the macro &`AAA`& is defined
5131 (or &`A`& or &`AA`&), and 100M
5132 otherwise. If there is more than one macro named on the line, the condition
5133 is true if any of them are defined. That is, it is an &"or"& condition. To
5134 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5135
5136 Although you can use a macro expansion to generate one of these directives,
5137 it is not very useful, because the condition &"there was a macro substitution
5138 in this line"& will always be true.
5139
5140 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5141 to clarify complicated nestings.
5142
5143
5144
5145 .section "Common option syntax" "SECTcos"
5146 .cindex "common option syntax"
5147 .cindex "syntax of common options"
5148 .cindex "configuration file" "common option syntax"
5149 For the main set of options, driver options, and &[local_scan()]& options,
5150 each setting is on a line by itself, and starts with a name consisting of
5151 lower-case letters and underscores. Many options require a data value, and in
5152 these cases the name must be followed by an equals sign (with optional white
5153 space) and then the value. For example:
5154 .code
5155 qualify_domain = mydomain.example.com
5156 .endd
5157 .cindex "hiding configuration option values"
5158 .cindex "configuration options" "hiding value of"
5159 .cindex "options" "hiding value of"
5160 Some option settings may contain sensitive data, for example, passwords for
5161 accessing databases. To stop non-admin users from using the &%-bP%& command
5162 line option to read these values, you can precede the option settings with the
5163 word &"hide"&. For example:
5164 .code
5165 hide mysql_servers = localhost/users/admin/secret-password
5166 .endd
5167 For non-admin users, such options are displayed like this:
5168 .code
5169 mysql_servers = <value not displayable>
5170 .endd
5171 If &"hide"& is used on a driver option, it hides the value of that option on
5172 all instances of the same driver.
5173
5174 The following sections describe the syntax used for the different data types
5175 that are found in option settings.
5176
5177
5178 .section "Boolean options" "SECID47"
5179 .cindex "format" "boolean"
5180 .cindex "boolean configuration values"
5181 .oindex "&%no_%&&'xxx'&"
5182 .oindex "&%not_%&&'xxx'&"
5183 Options whose type is given as boolean are on/off switches. There are two
5184 different ways of specifying such options: with and without a data value. If
5185 the option name is specified on its own without data, the switch is turned on;
5186 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5187 boolean options may be followed by an equals sign and one of the words
5188 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5189 the following two settings have exactly the same effect:
5190 .code
5191 queue_only
5192 queue_only = true
5193 .endd
5194 The following two lines also have the same (opposite) effect:
5195 .code
5196 no_queue_only
5197 queue_only = false
5198 .endd
5199 You can use whichever syntax you prefer.
5200
5201
5202
5203
5204 .section "Integer values" "SECID48"
5205 .cindex "integer configuration values"
5206 .cindex "format" "integer"
5207 If an option's type is given as &"integer"&, the value can be given in decimal,
5208 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5209 number is assumed. Otherwise, it is treated as an octal number unless it starts
5210 with the characters &"0x"&, in which case the remainder is interpreted as a
5211 hexadecimal number.
5212
5213 If an integer value is followed by the letter K, it is multiplied by 1024; if
5214 it is followed by the letter M, it is multiplied by 1024x1024;
5215 if by the letter G, 1024x1024x1024.
5216 When the values
5217 of integer option settings are output, values which are an exact multiple of
5218 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5219 and M. The printing style is independent of the actual input format that was
5220 used.
5221
5222
5223 .section "Octal integer values" "SECID49"
5224 .cindex "integer format"
5225 .cindex "format" "octal integer"
5226 If an option's type is given as &"octal integer"&, its value is always
5227 interpreted as an octal number, whether or not it starts with the digit zero.
5228 Such options are always output in octal.
5229
5230
5231 .section "Fixed point numbers" "SECID50"
5232 .cindex "fixed point configuration values"
5233 .cindex "format" "fixed point"
5234 If an option's type is given as &"fixed-point"&, its value must be a decimal
5235 integer, optionally followed by a decimal point and up to three further digits.
5236
5237
5238
5239 .section "Time intervals" "SECTtimeformat"
5240 .cindex "time interval" "specifying in configuration"
5241 .cindex "format" "time interval"
5242 A time interval is specified as a sequence of numbers, each followed by one of
5243 the following letters, with no intervening white space:
5244
5245 .table2 30pt
5246 .irow &%s%& seconds
5247 .irow &%m%& minutes
5248 .irow &%h%& hours
5249 .irow &%d%& days
5250 .irow &%w%& weeks
5251 .endtable
5252
5253 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5254 intervals are output in the same format. Exim does not restrict the values; it
5255 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5256
5257
5258
5259 .section "String values" "SECTstrings"
5260 .cindex "string" "format of configuration values"
5261 .cindex "format" "string"
5262 If an option's type is specified as &"string"&, the value can be specified with
5263 or without double-quotes. If it does not start with a double-quote, the value
5264 consists of the remainder of the line plus any continuation lines, starting at
5265 the first character after any leading white space, with trailing white space
5266 removed, and with no interpretation of the characters in the string. Because
5267 Exim removes comment lines (those beginning with #) at an early stage, they can
5268 appear in the middle of a multi-line string. The following two settings are
5269 therefore equivalent:
5270 .code
5271 trusted_users = uucp:mail
5272 trusted_users = uucp:\
5273                 # This comment line is ignored
5274                 mail
5275 .endd
5276 .cindex "string" "quoted"
5277 .cindex "escape characters in quoted strings"
5278 If a string does start with a double-quote, it must end with a closing
5279 double-quote, and any backslash characters other than those used for line
5280 continuation are interpreted as escape characters, as follows:
5281
5282 .table2 100pt
5283 .irow &`\\`&                     "single backslash"
5284 .irow &`\n`&                     "newline"
5285 .irow &`\r`&                     "carriage return"
5286 .irow &`\t`&                     "tab"
5287 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5288 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5289                                    character"
5290 .endtable
5291
5292 If a backslash is followed by some other character, including a double-quote
5293 character, that character replaces the pair.
5294
5295 Quoting is necessary only if you want to make use of the backslash escapes to
5296 insert special characters, or if you need to specify a value with leading or
5297 trailing spaces. These cases are rare, so quoting is almost never needed in
5298 current versions of Exim. In versions of Exim before 3.14, quoting was required
5299 in order to continue lines, so you may come across older configuration files
5300 and examples that apparently quote unnecessarily.
5301
5302
5303 .section "Expanded strings" "SECID51"
5304 .cindex "expansion" "definition of"
5305 Some strings in the configuration file are subjected to &'string expansion'&,
5306 by which means various parts of the string may be changed according to the
5307 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5308 is as just described; in particular, the handling of backslashes in quoted
5309 strings is done as part of the input process, before expansion takes place.
5310 However, backslash is also an escape character for the expander, so any
5311 backslashes that are required for that reason must be doubled if they are
5312 within a quoted configuration string.
5313
5314
5315 .section "User and group names" "SECID52"
5316 .cindex "user name" "format of"
5317 .cindex "format" "user name"
5318 .cindex "groups" "name format"
5319 .cindex "format" "group name"
5320 User and group names are specified as strings, using the syntax described
5321 above, but the strings are interpreted specially. A user or group name must
5322 either consist entirely of digits, or be a name that can be looked up using the
5323 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5324
5325
5326 .section "List construction" "SECTlistconstruct"
5327 .cindex "list" "syntax of in configuration"
5328 .cindex "format" "list item in configuration"
5329 .cindex "string" "list, definition of"
5330 The data for some configuration options is a list of items, with colon as the
5331 default separator. Many of these options are shown with type &"string list"& in
5332 the descriptions later in this document. Others are listed as &"domain list"&,
5333 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5334 are all the same; however, those other than &"string list"& are subject to
5335 particular kinds of interpretation, as described in chapter
5336 &<<CHAPdomhosaddlists>>&.
5337
5338 In all these cases, the entire list is treated as a single string as far as the
5339 input syntax is concerned. The &%trusted_users%& setting in section
5340 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5341 in a list, it must be entered as two colons. Leading and trailing white space
5342 on each item in a list is ignored. This makes it possible to include items that
5343 start with a colon, and in particular, certain forms of IPv6 address. For
5344 example, the list
5345 .code
5346 local_interfaces = 127.0.0.1 : ::::1
5347 .endd
5348 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5349
5350 &*Note*&: Although leading and trailing white space is ignored in individual
5351 list items, it is not ignored when parsing the list. The space after the first
5352 colon in the example above is necessary. If it were not there, the list would
5353 be interpreted as the two items 127.0.0.1:: and 1.
5354
5355 .section "Changing list separators" "SECTlistsepchange"
5356 .cindex "list separator" "changing"
5357 .cindex "IPv6" "addresses in lists"
5358 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5359 introduced to allow the separator character to be changed. If a list begins
5360 with a left angle bracket, followed by any punctuation character, that
5361 character is used instead of colon as the list separator. For example, the list
5362 above can be rewritten to use a semicolon separator like this:
5363 .code
5364 local_interfaces = <; 127.0.0.1 ; ::1
5365 .endd
5366 This facility applies to all lists, with the exception of the list in
5367 &%log_file_path%&. It is recommended that the use of non-colon separators be
5368 confined to circumstances where they really are needed.
5369
5370 .cindex "list separator" "newline as"
5371 .cindex "newline" "as list separator"
5372 It is also possible to use newline and other control characters (those with
5373 code values less than 32, plus DEL) as separators in lists. Such separators
5374 must be provided literally at the time the list is processed. For options that
5375 are string-expanded, you can write the separator using a normal escape
5376 sequence. This will be processed by the expander before the string is
5377 interpreted as a list. For example, if a newline-separated list of domains is
5378 generated by a lookup, you can process it directly by a line such as this:
5379 .code
5380 domains = <\n ${lookup mysql{.....}}
5381 .endd
5382 This avoids having to change the list separator in such data. You are unlikely
5383 to want to use a control character as a separator in an option that is not
5384 expanded, because the value is literal text. However, it can be done by giving
5385 the value in quotes. For example:
5386 .code
5387 local_interfaces = "<\n 127.0.0.1 \n ::1"
5388 .endd
5389 Unlike printing character separators, which can be included in list items by
5390 doubling, it is not possible to include a control character as data when it is
5391 set as the separator. Two such characters in succession are interpreted as
5392 enclosing an empty list item.
5393
5394
5395
5396 .section "Empty items in lists" "SECTempitelis"
5397 .cindex "list" "empty item in"
5398 An empty item at the end of a list is always ignored. In other words, trailing
5399 separator characters are ignored. Thus, the list in
5400 .code
5401 senders = user@domain :
5402 .endd
5403 contains only a single item. If you want to include an empty string as one item
5404 in a list, it must not be the last item. For example, this list contains three
5405 items, the second of which is empty:
5406 .code
5407 senders = user1@domain : : user2@domain
5408 .endd
5409 &*Note*&: There must be white space between the two colons, as otherwise they
5410 are interpreted as representing a single colon data character (and the list
5411 would then contain just one item). If you want to specify a list that contains
5412 just one, empty item, you can do it as in this example:
5413 .code
5414 senders = :
5415 .endd
5416 In this case, the first item is empty, and the second is discarded because it
5417 is at the end of the list.
5418
5419
5420
5421
5422 .section "Format of driver configurations" "SECTfordricon"
5423 .cindex "drivers" "configuration format"
5424 There are separate parts in the configuration for defining routers, transports,
5425 and authenticators. In each part, you are defining a number of driver
5426 instances, each with its own set of options. Each driver instance is defined by
5427 a sequence of lines like this:
5428 .display
5429 <&'instance name'&>:
5430   <&'option'&>
5431   ...
5432   <&'option'&>
5433 .endd
5434 In the following example, the instance name is &(localuser)&, and it is
5435 followed by three options settings:
5436 .code
5437 localuser:
5438   driver = accept
5439   check_local_user
5440   transport = local_delivery
5441 .endd
5442 For each driver instance, you specify which Exim code module it uses &-- by the
5443 setting of the &%driver%& option &-- and (optionally) some configuration
5444 settings. For example, in the case of transports, if you want a transport to
5445 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5446 a local file you would use the &(appendfile)& driver. Each of the drivers is
5447 described in detail in its own separate chapter later in this manual.
5448
5449 You can have several routers, transports, or authenticators that are based on
5450 the same underlying driver (each must have a different instance name).
5451
5452 The order in which routers are defined is important, because addresses are
5453 passed to individual routers one by one, in order. The order in which
5454 transports are defined does not matter at all. The order in which
5455 authenticators are defined is used only when Exim, as a client, is searching
5456 them to find one that matches an authentication mechanism offered by the
5457 server.
5458
5459 .cindex "generic options"
5460 .cindex "options" "generic &-- definition of"
5461 Within a driver instance definition, there are two kinds of option: &'generic'&
5462 and &'private'&. The generic options are those that apply to all drivers of the
5463 same type (that is, all routers, all transports or all authenticators). The
5464 &%driver%& option is a generic option that must appear in every definition.
5465 .cindex "private options"
5466 The private options are special for each driver, and none need appear, because
5467 they all have default values.
5468
5469 The options may appear in any order, except that the &%driver%& option must
5470 precede any private options, since these depend on the particular driver. For
5471 this reason, it is recommended that &%driver%& always be the first option.
5472
5473 Driver instance names, which are used for reference in log entries and
5474 elsewhere, can be any sequence of letters, digits, and underscores (starting
5475 with a letter) and must be unique among drivers of the same type. A router and
5476 a transport (for example) can each have the same name, but no two router
5477 instances can have the same name. The name of a driver instance should not be
5478 confused with the name of the underlying driver module. For example, the
5479 configuration lines:
5480 .code
5481 remote_smtp:
5482   driver = smtp
5483 .endd
5484 create an instance of the &(smtp)& transport driver whose name is
5485 &(remote_smtp)&. The same driver code can be used more than once, with
5486 different instance names and different option settings each time. A second
5487 instance of the &(smtp)& transport, with different options, might be defined
5488 thus:
5489 .code
5490 special_smtp:
5491   driver = smtp
5492   port = 1234
5493   command_timeout = 10s
5494 .endd
5495 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5496 these transport instances from routers, and these names would appear in log
5497 lines.
5498
5499 Comment lines may be present in the middle of driver specifications. The full
5500 list of option settings for any particular driver instance, including all the
5501 defaulted values, can be extracted by making use of the &%-bP%& command line
5502 option.
5503
5504
5505
5506
5507
5508
5509 . ////////////////////////////////////////////////////////////////////////////
5510 . ////////////////////////////////////////////////////////////////////////////
5511
5512 .chapter "The default configuration file" "CHAPdefconfil"
5513 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5514 .cindex "default" "configuration file &""walk through""&"
5515 The default configuration file supplied with Exim as &_src/configure.default_&
5516 is sufficient for a host with simple mail requirements. As an introduction to
5517 the way Exim is configured, this chapter &"walks through"& the default
5518 configuration, giving brief explanations of the settings. Detailed descriptions
5519 of the options are given in subsequent chapters. The default configuration file
5520 itself contains extensive comments about ways you might want to modify the
5521 initial settings. However, note that there are many options that are not
5522 mentioned at all in the default configuration.
5523
5524
5525
5526 .section "Macros" "SECTdefconfmacros"
5527 All macros should be defined before any options.
5528
5529 One macro is specified, but commented out, in the default configuration:
5530 .code
5531 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5532 .endd
5533 If all off-site mail is expected to be delivered to a "smarthost", then set the
5534 hostname here and uncomment the macro.  This will affect which router is used
5535 later on.  If this is left commented out, then Exim will perform direct-to-MX
5536 deliveries using a &(dnslookup)& router.
5537
5538 In addition to macros defined here, Exim includes a number of built-in macros
5539 to enable configuration to be guarded by a binary built with support for a
5540 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5541
5542
5543 .section "Main configuration settings" "SECTdefconfmain"
5544 The main (global) configuration option settings section must always come first
5545 in the file, after the macros.
5546 The first thing you'll see in the file, after some initial comments, is the line
5547 .code
5548 # primary_hostname =
5549 .endd
5550 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5551 to know the official, fully qualified name of your host, and this is where you
5552 can specify it. However, in most cases you do not need to set this option. When
5553 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5554
5555 The first three non-comment configuration lines are as follows:
5556 .code
5557 domainlist local_domains    = @
5558 domainlist relay_to_domains =
5559 hostlist   relay_from_hosts = 127.0.0.1
5560 .endd
5561 These are not, in fact, option settings. They are definitions of two named
5562 domain lists and one named host list. Exim allows you to give names to lists of
5563 domains, hosts, and email addresses, in order to make it easier to manage the
5564 configuration file (see section &<<SECTnamedlists>>&).
5565
5566 The first line defines a domain list called &'local_domains'&; this is used
5567 later in the configuration to identify domains that are to be delivered
5568 on the local host.
5569
5570 .cindex "@ in a domain list"
5571 There is just one item in this list, the string &"@"&. This is a special form
5572 of entry which means &"the name of the local host"&. Thus, if the local host is
5573 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5574 be delivered locally. Because the local host's name is referenced indirectly,
5575 the same configuration file can be used on different hosts.
5576
5577 The second line defines a domain list called &'relay_to_domains'&, but the
5578 list itself is empty. Later in the configuration we will come to the part that
5579 controls mail relaying through the local host; it allows relaying to any
5580 domains in this list. By default, therefore, no relaying on the basis of a mail
5581 domain is permitted.
5582
5583 The third line defines a host list called &'relay_from_hosts'&. This list is
5584 used later in the configuration to permit relaying from any host or IP address
5585 that matches the list. The default contains just the IP address of the IPv4
5586 loopback interface, which means that processes on the local host are able to
5587 submit mail for relaying by sending it over TCP/IP to that interface. No other
5588 hosts are permitted to submit messages for relaying.
5589
5590 Just to be sure there's no misunderstanding: at this point in the configuration
5591 we aren't actually setting up any controls. We are just defining some domains
5592 and hosts that will be used in the controls that are specified later.
5593
5594 The next two configuration lines are genuine option settings:
5595 .code
5596 acl_smtp_rcpt = acl_check_rcpt
5597 acl_smtp_data = acl_check_data
5598 .endd
5599 These options specify &'Access Control Lists'& (ACLs) that are to be used
5600 during an incoming SMTP session for every recipient of a message (every RCPT
5601 command), and after the contents of the message have been received,
5602 respectively. The names of the lists are &'acl_check_rcpt'& and
5603 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5604 section of the configuration. The RCPT ACL controls which recipients are
5605 accepted for an incoming message &-- if a configuration does not provide an ACL
5606 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5607 contents of a message to be checked.
5608
5609 Two commented-out option settings are next:
5610 .code
5611 # av_scanner = clamd:/tmp/clamd
5612 # spamd_address = 127.0.0.1 783
5613 .endd
5614 These are example settings that can be used when Exim is compiled with the
5615 content-scanning extension. The first specifies the interface to the virus
5616 scanner, and the second specifies the interface to SpamAssassin. Further
5617 details are given in chapter &<<CHAPexiscan>>&.
5618
5619 Three more commented-out option settings follow:
5620 .code
5621 # tls_advertise_hosts = *
5622 # tls_certificate = /etc/ssl/exim.crt
5623 # tls_privatekey = /etc/ssl/exim.pem
5624 .endd
5625 These are example settings that can be used when Exim is compiled with
5626 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5627 first one specifies the list of clients that are allowed to use TLS when
5628 connecting to this server; in this case, the wildcard means all clients. The
5629 other options specify where Exim should find its TLS certificate and private
5630 key, which together prove the server's identity to any clients that connect.
5631 More details are given in chapter &<<CHAPTLS>>&.
5632
5633 Another two commented-out option settings follow:
5634 .code
5635 # daemon_smtp_ports = 25 : 465 : 587
5636 # tls_on_connect_ports = 465
5637 .endd
5638 .cindex "port" "465 and 587"
5639 .cindex "port" "for message submission"
5640 .cindex "message" "submission, ports for"
5641 .cindex "submissions protocol"
5642 .cindex "smtps protocol"
5643 .cindex "ssmtp protocol"
5644 .cindex "SMTP" "submissions protocol"
5645 .cindex "SMTP" "ssmtp protocol"
5646 .cindex "SMTP" "smtps protocol"
5647 These options provide better support for roaming users who wish to use this
5648 server for message submission. They are not much use unless you have turned on
5649 TLS (as described in the previous paragraph) and authentication (about which
5650 more in section &<<SECTdefconfauth>>&).
5651 Mail submission from mail clients (MUAs) should be separate from inbound mail
5652 to your domain (MX delivery) for various good reasons (eg, ability to impose
5653 much saner TLS protocol and ciphersuite requirements without unintended
5654 consequences).
5655 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5656 which uses STARTTLS, so this is the &"submission"& port.
5657 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5658 which should be used in preference to 587.
5659 You should also consider deploying SRV records to help clients find
5660 these ports.
5661 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5662
5663 Two more commented-out options settings follow:
5664 .code
5665 # qualify_domain =
5666 # qualify_recipient =
5667 .endd
5668 The first of these specifies a domain that Exim uses when it constructs a
5669 complete email address from a local login name. This is often needed when Exim
5670 receives a message from a local process. If you do not set &%qualify_domain%&,
5671 the value of &%primary_hostname%& is used. If you set both of these options,
5672 you can have different qualification domains for sender and recipient
5673 addresses. If you set only the first one, its value is used in both cases.
5674
5675 .cindex "domain literal" "recognizing format"
5676 The following line must be uncommented if you want Exim to recognize
5677 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5678 (an IP address within square brackets) instead of a named domain.
5679 .code
5680 # allow_domain_literals
5681 .endd
5682 The RFCs still require this form, but many people think that in the modern
5683 Internet it makes little sense to permit mail to be sent to specific hosts by
5684 quoting their IP addresses. This ancient format has been used by people who
5685 try to abuse hosts by using them for unwanted relaying. However, some
5686 people believe there are circumstances (for example, messages addressed to
5687 &'postmaster'&) where domain literals are still useful.
5688
5689 The next configuration line is a kind of trigger guard:
5690 .code
5691 never_users = root
5692 .endd
5693 It specifies that no delivery must ever be run as the root user. The normal
5694 convention is to set up &'root'& as an alias for the system administrator. This
5695 setting is a guard against slips in the configuration.
5696 The list of users specified by &%never_users%& is not, however, the complete
5697 list; the build-time configuration in &_Local/Makefile_& has an option called
5698 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5699 contents of &%never_users%& are added to this list. By default
5700 FIXED_NEVER_USERS also specifies root.
5701
5702 When a remote host connects to Exim in order to send mail, the only information
5703 Exim has about the host's identity is its IP address. The next configuration
5704 line,
5705 .code
5706 host_lookup = *
5707 .endd
5708 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5709 in order to get a host name. This improves the quality of the logging
5710 information, but if you feel it is too expensive, you can remove it entirely,
5711 or restrict the lookup to hosts on &"nearby"& networks.
5712 Note that it is not always possible to find a host name from an IP address,
5713 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5714 unreachable.
5715
5716 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5717 1413 (hence their names):
5718 .code
5719 rfc1413_hosts = *
5720 rfc1413_query_timeout = 0s
5721 .endd
5722 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5723 Few hosts offer RFC1413 service these days; calls have to be
5724 terminated by a timeout and this needlessly delays the startup
5725 of an incoming SMTP connection.
5726 If you have hosts for which you trust RFC1413 and need this
5727 information, you can change this.
5728
5729 This line enables an efficiency SMTP option.  It is negotiated by clients
5730 and not expected to cause problems but can be disabled if needed.
5731 .code
5732 prdr_enable = true
5733 .endd
5734
5735 When Exim receives messages over SMTP connections, it expects all addresses to
5736 be fully qualified with a domain, as required by the SMTP definition. However,
5737 if you are running a server to which simple clients submit messages, you may
5738 find that they send unqualified addresses. The two commented-out options:
5739 .code
5740 # sender_unqualified_hosts =
5741 # recipient_unqualified_hosts =
5742 .endd
5743 show how you can specify hosts that are permitted to send unqualified sender
5744 and recipient addresses, respectively.
5745
5746 The &%log_selector%& option is used to increase the detail of logging
5747 over the default:
5748 .code
5749 log_selector = +smtp_protocol_error +smtp_syntax_error \
5750                +tls_certificate_verified
5751 .endd
5752
5753 The &%percent_hack_domains%& option is also commented out:
5754 .code
5755 # percent_hack_domains =
5756 .endd
5757 It provides a list of domains for which the &"percent hack"& is to operate.
5758 This is an almost obsolete form of explicit email routing. If you do not know
5759 anything about it, you can safely ignore this topic.
5760
5761 The next two settings in the main part of the default configuration are
5762 concerned with messages that have been &"frozen"& on Exim's queue. When a
5763 message is frozen, Exim no longer continues to try to deliver it. Freezing
5764 occurs when a bounce message encounters a permanent failure because the sender
5765 address of the original message that caused the bounce is invalid, so the
5766 bounce cannot be delivered. This is probably the most common case, but there
5767 are also other conditions that cause freezing, and frozen messages are not
5768 always bounce messages.
5769 .code
5770 ignore_bounce_errors_after = 2d
5771 timeout_frozen_after = 7d
5772 .endd
5773 The first of these options specifies that failing bounce messages are to be
5774 discarded after 2 days in the queue. The second specifies that any frozen
5775 message (whether a bounce message or not) is to be timed out (and discarded)
5776 after a week. In this configuration, the first setting ensures that no failing
5777 bounce message ever lasts a week.
5778
5779 Exim queues it's messages in a spool directory. If you expect to have
5780 large queues, you may consider using this option. It splits the spool
5781 directory into subdirectories to avoid file system degradation from
5782 many files in a single directory, resulting in better performance.
5783 Manual manipulation of queued messages becomes more complex (though fortunately
5784 not often needed).
5785 .code
5786 # split_spool_directory = true
5787 .endd
5788
5789 In an ideal world everybody follows the standards. For non-ASCII
5790 messages RFC 2047 is a standard, allowing a maximum line length of 76
5791 characters. Exim adheres that standard and won't process messages which
5792 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5793 In particular, the Exim maintainers have had multiple reports of
5794 problems from Russian administrators of issues until they disable this
5795 check, because of some popular, yet buggy, mail composition software.
5796 .code
5797 # check_rfc2047_length = false
5798 .endd
5799
5800 If you need to be strictly RFC compliant you may wish to disable the
5801 8BITMIME advertisement. Use this, if you exchange mails with systems
5802 that are not 8-bit clean.
5803 .code
5804 # accept_8bitmime = false
5805 .endd
5806
5807 Libraries you use may depend on specific environment settings.  This
5808 imposes a security risk (e.g. PATH). There are two lists:
5809 &%keep_environment%& for the variables to import as they are, and
5810 &%add_environment%& for variables we want to set to a fixed value.
5811 Note that TZ is handled separately, by the $%timezone%$ runtime
5812 option and by the TIMEZONE_DEFAULT buildtime option.
5813 .code
5814 # keep_environment = ^LDAP
5815 # add_environment = PATH=/usr/bin::/bin
5816 .endd
5817
5818
5819 .section "ACL configuration" "SECID54"
5820 .cindex "default" "ACLs"
5821 .cindex "&ACL;" "default configuration"
5822 In the default configuration, the ACL section follows the main configuration.
5823 It starts with the line
5824 .code
5825 begin acl
5826 .endd
5827 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5828 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5829 and &%acl_smtp_data%& above.
5830
5831 .cindex "RCPT" "ACL for"
5832 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5833 RCPT command specifies one of the message's recipients. The ACL statements
5834 are considered in order, until the recipient address is either accepted or
5835 rejected. The RCPT command is then accepted or rejected, according to the
5836 result of the ACL processing.
5837 .code
5838 acl_check_rcpt:
5839 .endd
5840 This line, consisting of a name terminated by a colon, marks the start of the
5841 ACL, and names it.
5842 .code
5843 accept  hosts = :
5844 .endd
5845 This ACL statement accepts the recipient if the sending host matches the list.
5846 But what does that strange list mean? It doesn't actually contain any host
5847 names or IP addresses. The presence of the colon puts an empty item in the
5848 list; Exim matches this only if the incoming message did not come from a remote
5849 host, because in that case, the remote hostname is empty. The colon is
5850 important. Without it, the list itself is empty, and can never match anything.
5851
5852 What this statement is doing is to accept unconditionally all recipients in
5853 messages that are submitted by SMTP from local processes using the standard
5854 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5855 manner.
5856 .code
5857 deny    message       = Restricted characters in address
5858         domains       = +local_domains
5859         local_parts   = ^[.] : ^.*[@%!/|]
5860
5861 deny    message       = Restricted characters in address
5862         domains       = !+local_domains
5863         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5864 .endd
5865 These statements are concerned with local parts that contain any of the
5866 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5867 Although these characters are entirely legal in local parts (in the case of
5868 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5869 in Internet mail addresses.
5870
5871 The first three have in the past been associated with explicitly routed
5872 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5873 option). Addresses containing these characters are regularly tried by spammers
5874 in an attempt to bypass relaying restrictions, and also by open relay testing
5875 programs. Unless you really need them it is safest to reject these characters
5876 at this early stage. This configuration is heavy-handed in rejecting these
5877 characters for all messages it accepts from remote hosts. This is a deliberate
5878 policy of being as safe as possible.
5879
5880 The first rule above is stricter, and is applied to messages that are addressed
5881 to one of the local domains handled by this host. This is implemented by the
5882 first condition, which restricts it to domains that are listed in the
5883 &'local_domains'& domain list. The &"+"& character is used to indicate a
5884 reference to a named list. In this configuration, there is just one domain in
5885 &'local_domains'&, but in general there may be many.
5886
5887 The second condition on the first statement uses two regular expressions to
5888 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5889 or &"|"&. If you have local accounts that include these characters, you will
5890 have to modify this rule.
5891
5892 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5893 allows them because they have been encountered in practice. (Consider the
5894 common convention of local parts constructed as
5895 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5896 the author of Exim, who has no second initial.) However, a local part starting
5897 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5898 filename (for example, for a mailing list). This is also true for local parts
5899 that contain slashes. A pipe symbol can also be troublesome if the local part
5900 is incorporated unthinkingly into a shell command line.
5901
5902 The second rule above applies to all other domains, and is less strict. This
5903 allows your own users to send outgoing messages to sites that use slashes
5904 and vertical bars in their local parts. It blocks local parts that begin
5905 with a dot, slash, or vertical bar, but allows these characters within the
5906 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5907 and &"!"& is blocked, as before. The motivation here is to prevent your users
5908 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5909 .code
5910 accept  local_parts   = postmaster
5911         domains       = +local_domains
5912 .endd
5913 This statement, which has two conditions, accepts an incoming address if the
5914 local part is &'postmaster'& and the domain is one of those listed in the
5915 &'local_domains'& domain list. The &"+"& character is used to indicate a
5916 reference to a named list. In this configuration, there is just one domain in
5917 &'local_domains'&, but in general there may be many.
5918
5919 The presence of this statement means that mail to postmaster is never blocked
5920 by any of the subsequent tests. This can be helpful while sorting out problems
5921 in cases where the subsequent tests are incorrectly denying access.
5922 .code
5923 require verify        = sender
5924 .endd
5925 This statement requires the sender address to be verified before any subsequent
5926 ACL statement can be used. If verification fails, the incoming recipient
5927 address is refused. Verification consists of trying to route the address, to
5928 see if a bounce message could be delivered to it. In the case of remote
5929 addresses, basic verification checks only the domain, but &'callouts'& can be
5930 used for more verification if required. Section &<<SECTaddressverification>>&
5931 discusses the details of address verification.
5932 .code
5933 accept  hosts         = +relay_from_hosts
5934         control       = submission
5935 .endd
5936 This statement accepts the address if the message is coming from one of the
5937 hosts that are defined as being allowed to relay through this host. Recipient
5938 verification is omitted here, because in many cases the clients are dumb MUAs
5939 that do not cope well with SMTP error responses. For the same reason, the
5940 second line specifies &"submission mode"& for messages that are accepted. This
5941 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5942 messages that are deficient in some way, for example, because they lack a
5943 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5944 probably add recipient verification here, and disable submission mode.
5945 .code
5946 accept  authenticated = *
5947         control       = submission
5948 .endd
5949 This statement accepts the address if the client host has authenticated itself.
5950 Submission mode is again specified, on the grounds that such messages are most
5951 likely to come from MUAs. The default configuration does not define any
5952 authenticators, though it does include some nearly complete commented-out
5953 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5954 fact authenticate until you complete the authenticator definitions.
5955 .code
5956 require message = relay not permitted
5957         domains = +local_domains : +relay_to_domains
5958 .endd
5959 This statement rejects the address if its domain is neither a local domain nor
5960 one of the domains for which this host is a relay.
5961 .code
5962 require verify = recipient
5963 .endd
5964 This statement requires the recipient address to be verified; if verification
5965 fails, the address is rejected.
5966 .code
5967 # deny    message     = rejected because $sender_host_address \
5968 #                       is in a black list at $dnslist_domain\n\
5969 #                       $dnslist_text
5970 #         dnslists    = black.list.example
5971 #
5972 # warn    dnslists    = black.list.example
5973 #         add_header  = X-Warning: $sender_host_address is in \
5974 #                       a black list at $dnslist_domain
5975 #         log_message = found in $dnslist_domain
5976 .endd
5977 These commented-out lines are examples of how you could configure Exim to check
5978 sending hosts against a DNS black list. The first statement rejects messages
5979 from blacklisted hosts, whereas the second just inserts a warning header
5980 line.
5981 .code
5982 # require verify = csa
5983 .endd
5984 This commented-out line is an example of how you could turn on client SMTP
5985 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5986 records.
5987 .code
5988 accept
5989 .endd
5990 The final statement in the first ACL unconditionally accepts any recipient
5991 address that has successfully passed all the previous tests.
5992 .code
5993 acl_check_data:
5994 .endd
5995 This line marks the start of the second ACL, and names it. Most of the contents
5996 of this ACL are commented out:
5997 .code
5998 # deny    malware   = *
5999 #         message   = This message contains a virus \
6000 #                     ($malware_name).
6001 .endd
6002 These lines are examples of how to arrange for messages to be scanned for
6003 viruses when Exim has been compiled with the content-scanning extension, and a
6004 suitable virus scanner is installed. If the message is found to contain a
6005 virus, it is rejected with the given custom error message.
6006 .code
6007 # warn    spam      = nobody
6008 #         message   = X-Spam_score: $spam_score\n\
6009 #                     X-Spam_score_int: $spam_score_int\n\
6010 #                     X-Spam_bar: $spam_bar\n\
6011 #                     X-Spam_report: $spam_report
6012 .endd
6013 These lines are an example of how to arrange for messages to be scanned by
6014 SpamAssassin when Exim has been compiled with the content-scanning extension,
6015 and SpamAssassin has been installed. The SpamAssassin check is run with
6016 &`nobody`& as its user parameter, and the results are added to the message as a
6017 series of extra header line. In this case, the message is not rejected,
6018 whatever the spam score.
6019 .code
6020 accept
6021 .endd
6022 This final line in the DATA ACL accepts the message unconditionally.
6023
6024
6025 .section "Router configuration" "SECID55"
6026 .cindex "default" "routers"
6027 .cindex "routers" "default"
6028 The router configuration comes next in the default configuration, introduced
6029 by the line
6030 .code
6031 begin routers
6032 .endd
6033 Routers are the modules in Exim that make decisions about where to send
6034 messages. An address is passed to each router, in turn, until it is either
6035 accepted, or failed. This means that the order in which you define the routers
6036 matters. Each router is fully described in its own chapter later in this
6037 manual. Here we give only brief overviews.
6038 .code
6039 # domain_literal:
6040 #   driver = ipliteral
6041 #   domains = !+local_domains
6042 #   transport = remote_smtp
6043 .endd
6044 .cindex "domain literal" "default router"
6045 This router is commented out because the majority of sites do not want to
6046 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6047 you uncomment this router, you also need to uncomment the setting of
6048 &%allow_domain_literals%& in the main part of the configuration.
6049
6050 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6051 macro has been defined, per
6052 .code
6053 .ifdef ROUTER_SMARTHOST
6054 smarthost:
6055 #...
6056 .else
6057 dnslookup:
6058 #...
6059 .endif
6060 .endd
6061
6062 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6063 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6064 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6065 skip these routers because of the &%domains%& option.
6066
6067 .code
6068 smarthost:
6069   driver = manualroute
6070   domains = ! +local_domains
6071   transport = smarthost_smtp
6072   route_data = ROUTER_SMARTHOST
6073   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6074   no_more
6075 .endd
6076 This router only handles mail which is not to any local domains; this is
6077 specified by the line
6078 .code
6079 domains = ! +local_domains
6080 .endd
6081 The &%domains%& option lists the domains to which this router applies, but the
6082 exclamation mark is a negation sign, so the router is used only for domains
6083 that are not in the domain list called &'local_domains'& (which was defined at
6084 the start of the configuration). The plus sign before &'local_domains'&
6085 indicates that it is referring to a named list. Addresses in other domains are
6086 passed on to the following routers.
6087
6088 The name of the router driver is &(manualroute)& because we are manually
6089 specifying how mail should be routed onwards, instead of using DNS MX.
6090 While the name of this router instance is arbitrary, the &%driver%& option must
6091 be one of the driver modules that is in the Exim binary.
6092
6093 With no pre-conditions other than &%domains%&, all mail for non-local domains
6094 will be handled by this router, and the &%no_more%& setting will ensure that no
6095 other routers will be used for messages matching the pre-conditions.  See
6096 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6097 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6098 and the macro supplies the value; the address is then queued for the
6099 &(smarthost_smtp)& transport.
6100
6101 .code
6102 dnslookup:
6103   driver = dnslookup
6104   domains = ! +local_domains
6105   transport = remote_smtp
6106   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6107   no_more
6108 .endd
6109 The &%domains%& option behaves as per smarthost, above.
6110
6111 The name of the router driver is &(dnslookup)&,
6112 and is specified by the &%driver%& option. Do not be confused by the fact that
6113 the name of this router instance is the same as the name of the driver. The
6114 instance name is arbitrary, but the name set in the &%driver%& option must be
6115 one of the driver modules that is in the Exim binary.
6116
6117 The &(dnslookup)& router routes addresses by looking up their domains in the
6118 DNS in order to obtain a list of hosts to which the address is routed. If the
6119 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6120 specified by the &%transport%& option. If the router does not find the domain
6121 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6122 the address fails and is bounced.
6123
6124 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6125 be entirely ignored. This option is present because a number of cases have been
6126 encountered where MX records in the DNS point to host names
6127 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6128 Completely ignoring these IP addresses causes Exim to fail to route the
6129 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6130 continue to try to deliver the message periodically until the address timed
6131 out.
6132 .code
6133 system_aliases:
6134   driver = redirect
6135   allow_fail
6136   allow_defer
6137   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6138 # user = exim
6139   file_transport = address_file
6140   pipe_transport = address_pipe
6141 .endd
6142 Control reaches this and subsequent routers only for addresses in the local
6143 domains. This router checks to see whether the local part is defined as an
6144 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6145 data that it looks up from that file. If no data is found for the local part,
6146 the value of the &%data%& option is empty, causing the address to be passed to
6147 the next router.
6148
6149 &_/etc/aliases_& is a conventional name for the system aliases file that is
6150 often used. That is why it is referenced by from the default configuration
6151 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6152 &_Local/Makefile_& before building Exim.
6153 .code
6154 userforward:
6155   driver = redirect
6156   check_local_user
6157 # local_part_suffix = +* : -*
6158 # local_part_suffix_optional
6159   file = $home/.forward
6160 # allow_filter
6161   no_verify
6162   no_expn
6163   check_ancestor
6164   file_transport = address_file
6165   pipe_transport = address_pipe
6166   reply_transport = address_reply
6167 .endd
6168 This is the most complicated router in the default configuration. It is another
6169 redirection router, but this time it is looking for forwarding data set up by
6170 individual users. The &%check_local_user%& setting specifies a check that the
6171 local part of the address is the login name of a local user. If it is not, the
6172 router is skipped. The two commented options that follow &%check_local_user%&,
6173 namely:
6174 .code
6175 # local_part_suffix = +* : -*
6176 # local_part_suffix_optional
6177 .endd
6178 .vindex "&$local_part_suffix$&"
6179 show how you can specify the recognition of local part suffixes. If the first
6180 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6181 by any sequence of characters, is removed from the local part and placed in the
6182 variable &$local_part_suffix$&. The second suffix option specifies that the
6183 presence of a suffix in the local part is optional. When a suffix is present,
6184 the check for a local login uses the local part with the suffix removed.
6185
6186 When a local user account is found, the file called &_.forward_& in the user's
6187 home directory is consulted. If it does not exist, or is empty, the router
6188 declines. Otherwise, the contents of &_.forward_& are interpreted as
6189 redirection data (see chapter &<<CHAPredirect>>& for more details).
6190
6191 .cindex "Sieve filter" "enabling in default router"
6192 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6193 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6194 is commented out by default), the contents of the file are interpreted as a set
6195 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6196 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6197 separate document entitled &'Exim's interfaces to mail filtering'&.
6198
6199 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6200 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6201 There are two reasons for doing this:
6202
6203 .olist
6204 Whether or not a local user has a &_.forward_& file is not really relevant when
6205 checking an address for validity; it makes sense not to waste resources doing
6206 unnecessary work.
6207 .next
6208 More importantly, when Exim is verifying addresses or handling an EXPN
6209 command during an SMTP session, it is running as the Exim user, not as root.
6210 The group is the Exim group, and no additional groups are set up.
6211 It may therefore not be possible for Exim to read users' &_.forward_& files at
6212 this time.
6213 .endlist
6214
6215 The setting of &%check_ancestor%& prevents the router from generating a new
6216 address that is the same as any previous address that was redirected. (This
6217 works round a problem concerning a bad interaction between aliasing and
6218 forwarding &-- see section &<<SECTredlocmai>>&).
6219
6220 The final three option settings specify the transports that are to be used when
6221 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6222 auto-reply, respectively. For example, if a &_.forward_& file contains
6223 .code
6224 a.nother@elsewhere.example, /home/spqr/archive
6225 .endd
6226 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6227 transport.
6228 .code
6229 localuser:
6230   driver = accept
6231   check_local_user
6232 # local_part_suffix = +* : -*
6233 # local_part_suffix_optional
6234   transport = local_delivery
6235 .endd
6236 The final router sets up delivery into local mailboxes, provided that the local
6237 part is the name of a local login, by accepting the address and assigning it to
6238 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6239 routers, so the address is bounced. The commented suffix settings fulfil the
6240 same purpose as they do for the &(userforward)& router.
6241
6242
6243 .section "Transport configuration" "SECID56"
6244 .cindex "default" "transports"
6245 .cindex "transports" "default"
6246 Transports define mechanisms for actually delivering messages. They operate
6247 only when referenced from routers, so the order in which they are defined does
6248 not matter. The transports section of the configuration starts with
6249 .code
6250 begin transports
6251 .endd
6252 Two remote transports and four local transports are defined.
6253 .code
6254 remote_smtp:
6255   driver = smtp
6256   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6257 .ifdef _HAVE_DANE
6258   dnssec_request_domains = *
6259   hosts_try_dane = *
6260 .endif
6261 .ifdef _HAVE_PRDR
6262   hosts_try_prdr = *
6263 .endif
6264 .endd
6265 This transport is used for delivering messages over SMTP connections.
6266 The list of remote hosts comes from the router.
6267 The &%message_size_limit%& usage is a hack to avoid sending on messages
6268 with over-long lines.  The built-in macro _HAVE_DANE guards configuration
6269 to try to use DNSSEC for all queries and to use DANE for delivery;
6270 see section &<<SECDANE>>& for more details.
6271
6272 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6273 negotiated between client and server and not expected to cause problems
6274 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6275 use of the &%hosts_try_prdr%& configuration option.
6276
6277 The other remote transport is used when delivering to a specific smarthost
6278 with whom there must be some kind of existing relationship, instead of the
6279 usual federated system.
6280
6281 .code
6282 smarthost_smtp:
6283   driver = smtp
6284   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6285   multi_domain
6286   #
6287 .ifdef _HAVE_TLS
6288   # Comment out any of these which you have to, then file a Support
6289   # request with your smarthost provider to get things fixed:
6290   hosts_require_tls = *
6291   tls_verify_hosts = *
6292   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6293   # have to comment it out then this will at least log whether you succeed
6294   # or not:
6295   tls_try_verify_hosts = *
6296   #
6297   # The SNI name should match the name which we'll expect to verify;
6298   # many mail systems don't use SNI and this doesn't matter, but if it does,
6299   # we need to send a name which the remote site will recognize.
6300   # This _should_ be the name which the smarthost operators specified as
6301   # the hostname for sending your mail to.
6302   tls_sni = ROUTER_SMARTHOST
6303   #
6304 .ifdef _HAVE_OPENSSL
6305   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6306 .endif
6307 .ifdef _HAVE_GNUTLS
6308   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6309 .endif
6310 .endif
6311 .ifdef _HAVE_PRDR
6312   hosts_try_prdr = *
6313 .endif
6314 .endd
6315 After the same &%message_size_limit%& hack, we then specify that this Transport
6316 can handle messages to multiple domains in one run.  The assumption here is
6317 that you're routing all non-local mail to the same place and that place is
6318 happy to take all messages from you as quickly as possible.
6319 All other options depend upon built-in macros; if Exim was built without TLS support
6320 then no other options are defined.
6321 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6322 and versions using the &%tls_require_ciphers%& option, where the value to be
6323 used depends upon the library providing TLS.
6324 Beyond that, the options adopt the stance that you should have TLS support available
6325 from your smarthost on today's Internet, so we turn on requiring TLS for the
6326 mail to be delivered, and requiring that the certificate be valid, and match
6327 the expected hostname.  The &%tls_sni%& option can be used by service providers
6328 to select an appropriate certificate to present to you and here we re-use the
6329 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6330 You want to specify the hostname which you'll expect to validate for, and that
6331 should not be subject to insecure tampering via DNS results.
6332
6333 For the &%hosts_try_prdr%& option see the previous transport.
6334
6335 All other options are defaulted.
6336 .code
6337 local_delivery:
6338   driver = appendfile
6339   file = /var/mail/$local_part
6340   delivery_date_add
6341   envelope_to_add
6342   return_path_add
6343 # group = mail
6344 # mode = 0660
6345 .endd
6346 This &(appendfile)& transport is used for local delivery to user mailboxes in
6347 traditional BSD mailbox format. By default it runs under the uid and gid of the
6348 local user, which requires the sticky bit to be set on the &_/var/mail_&
6349 directory. Some systems use the alternative approach of running mail deliveries
6350 under a particular group instead of using the sticky bit. The commented options
6351 show how this can be done.
6352
6353 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6354 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6355 similarly-named options above.
6356 .code
6357 address_pipe:
6358   driver = pipe
6359   return_output
6360 .endd
6361 This transport is used for handling deliveries to pipes that are generated by
6362 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6363 option specifies that any output on stdout or stderr generated by the pipe is to
6364 be returned to the sender.
6365 .code
6366 address_file:
6367   driver = appendfile
6368   delivery_date_add
6369   envelope_to_add
6370   return_path_add
6371 .endd
6372 This transport is used for handling deliveries to files that are generated by
6373 redirection. The name of the file is not specified in this instance of
6374 &(appendfile)&, because it comes from the &(redirect)& router.
6375 .code
6376 address_reply:
6377   driver = autoreply
6378 .endd
6379 This transport is used for handling automatic replies generated by users'
6380 filter files.
6381
6382
6383
6384 .section "Default retry rule" "SECID57"
6385 .cindex "retry" "default rule"
6386 .cindex "default" "retry rule"
6387 The retry section of the configuration file contains rules which affect the way
6388 Exim retries deliveries that cannot be completed at the first attempt. It is
6389 introduced by the line
6390 .code
6391 begin retry
6392 .endd
6393 In the default configuration, there is just one rule, which applies to all
6394 errors:
6395 .code
6396 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6397 .endd
6398 This causes any temporarily failing address to be retried every 15 minutes for
6399 2 hours, then at intervals starting at one hour and increasing by a factor of
6400 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6401 is not delivered after 4 days of temporary failure, it is bounced. The time is
6402 measured from first failure, not from the time the message was received.
6403
6404 If the retry section is removed from the configuration, or is empty (that is,
6405 if no retry rules are defined), Exim will not retry deliveries. This turns
6406 temporary errors into permanent errors.
6407
6408
6409 .section "Rewriting configuration" "SECID58"
6410 The rewriting section of the configuration, introduced by
6411 .code
6412 begin rewrite
6413 .endd
6414 contains rules for rewriting addresses in messages as they arrive. There are no
6415 rewriting rules in the default configuration file.
6416
6417
6418
6419 .section "Authenticators configuration" "SECTdefconfauth"
6420 .cindex "AUTH" "configuration"
6421 The authenticators section of the configuration, introduced by
6422 .code
6423 begin authenticators
6424 .endd
6425 defines mechanisms for the use of the SMTP AUTH command. The default
6426 configuration file contains two commented-out example authenticators
6427 which support plaintext username/password authentication using the
6428 standard PLAIN mechanism and the traditional but non-standard LOGIN
6429 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6430 to support most MUA software.
6431
6432 The example PLAIN authenticator looks like this:
6433 .code
6434 #PLAIN:
6435 #  driver                  = plaintext
6436 #  server_set_id           = $auth2
6437 #  server_prompts          = :
6438 #  server_condition        = Authentication is not yet configured
6439 #  server_advertise_condition = ${if def:tls_in_cipher }
6440 .endd
6441 And the example LOGIN authenticator looks like this:
6442 .code
6443 #LOGIN:
6444 #  driver                  = plaintext
6445 #  server_set_id           = $auth1
6446 #  server_prompts          = <| Username: | Password:
6447 #  server_condition        = Authentication is not yet configured
6448 #  server_advertise_condition = ${if def:tls_in_cipher }
6449 .endd
6450
6451 The &%server_set_id%& option makes Exim remember the authenticated username
6452 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6453 &%server_prompts%& option configures the &(plaintext)& authenticator so
6454 that it implements the details of the specific authentication mechanism,
6455 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6456 when Exim offers authentication to clients; in the examples, this is only
6457 when TLS or SSL has been started, so to enable the authenticators you also
6458 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6459
6460 The &%server_condition%& setting defines how to verify that the username and
6461 password are correct. In the examples it just produces an error message.
6462 To make the authenticators work, you can use a string expansion
6463 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6464
6465 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6466 usercode and password are in different positions.
6467 Chapter &<<CHAPplaintext>>& covers both.
6468
6469 .ecindex IIDconfiwal
6470
6471
6472
6473 . ////////////////////////////////////////////////////////////////////////////
6474 . ////////////////////////////////////////////////////////////////////////////
6475
6476 .chapter "Regular expressions" "CHAPregexp"
6477
6478 .cindex "regular expressions" "library"
6479 .cindex "PCRE"
6480 Exim supports the use of regular expressions in many of its options. It
6481 uses the PCRE regular expression library; this provides regular expression
6482 matching that is compatible with Perl 5. The syntax and semantics of
6483 regular expressions is discussed in
6484 online Perl manpages, in
6485 many Perl reference books, and also in
6486 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6487 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6488 . --- the http: URL here redirects to another page with the ISBN in the URL
6489 . --- where trying to use https: just redirects back to http:, so sticking
6490 . --- to the old URL for now.  2018-09-07.
6491
6492 The documentation for the syntax and semantics of the regular expressions that
6493 are supported by PCRE is included in the PCRE distribution, and no further
6494 description is included here. The PCRE functions are called from Exim using
6495 the default option settings (that is, with no PCRE options set), except that
6496 the PCRE_CASELESS option is set when the matching is required to be
6497 case-insensitive.
6498
6499 In most cases, when a regular expression is required in an Exim configuration,
6500 it has to start with a circumflex, in order to distinguish it from plain text
6501 or an &"ends with"& wildcard. In this example of a configuration setting, the
6502 second item in the colon-separated list is a regular expression.
6503 .code
6504 domains = a.b.c : ^\\d{3} : *.y.z : ...
6505 .endd
6506 The doubling of the backslash is required because of string expansion that
6507 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6508 of this issue, and a way of avoiding the need for doubling backslashes. The
6509 regular expression that is eventually used in this example contains just one
6510 backslash. The circumflex is included in the regular expression, and has the
6511 normal effect of &"anchoring"& it to the start of the string that is being
6512 matched.
6513
6514 There are, however, two cases where a circumflex is not required for the
6515 recognition of a regular expression: these are the &%match%& condition in a
6516 string expansion, and the &%matches%& condition in an Exim filter file. In
6517 these cases, the relevant string is always treated as a regular expression; if
6518 it does not start with a circumflex, the expression is not anchored, and can
6519 match anywhere in the subject string.
6520
6521 In all cases, if you want a regular expression to match at the end of a string,
6522 you must code the $ metacharacter to indicate this. For example:
6523 .code
6524 domains = ^\\d{3}\\.example
6525 .endd
6526 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6527 You need to use:
6528 .code
6529 domains = ^\\d{3}\\.example\$
6530 .endd
6531 if you want &'example'& to be the top-level domain. The backslash before the
6532 $ is needed because string expansion also interprets dollar characters.
6533
6534
6535
6536 . ////////////////////////////////////////////////////////////////////////////
6537 . ////////////////////////////////////////////////////////////////////////////
6538
6539 .chapter "File and database lookups" "CHAPfdlookup"
6540 .scindex IIDfidalo1 "file" "lookups"
6541 .scindex IIDfidalo2 "database" "lookups"
6542 .cindex "lookup" "description of"
6543 Exim can be configured to look up data in files or databases as it processes
6544 messages. Two different kinds of syntax are used:
6545
6546 .olist
6547 A string that is to be expanded may contain explicit lookup requests. These
6548 cause parts of the string to be replaced by data that is obtained from the
6549 lookup. Lookups of this type are conditional expansion items. Different results
6550 can be defined for the cases of lookup success and failure. See chapter
6551 &<<CHAPexpand>>&, where string expansions are described in detail.
6552 The key for the lookup is specified as part of the string expansion.
6553 .next
6554 Lists of domains, hosts, and email addresses can contain lookup requests as a
6555 way of avoiding excessively long linear lists. In this case, the data that is
6556 returned by the lookup is often (but not always) discarded; whether the lookup
6557 succeeds or fails is what really counts. These kinds of list are described in
6558 chapter &<<CHAPdomhosaddlists>>&.
6559 The key for the lookup is given by the context in which the list is expanded.
6560 .endlist
6561
6562 String expansions, lists, and lookups interact with each other in such a way
6563 that there is no order in which to describe any one of them that does not
6564 involve references to the others. Each of these three chapters makes more sense
6565 if you have read the other two first. If you are reading this for the first
6566 time, be aware that some of it will make a lot more sense after you have read
6567 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6568
6569 .section "Examples of different lookup syntax" "SECID60"
6570 It is easy to confuse the two different kinds of lookup, especially as the
6571 lists that may contain the second kind are always expanded before being
6572 processed as lists. Therefore, they may also contain lookups of the first kind.
6573 Be careful to distinguish between the following two examples:
6574 .code
6575 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6576 domains = lsearch;/some/file
6577 .endd
6578 The first uses a string expansion, the result of which must be a domain list.
6579 No strings have been specified for a successful or a failing lookup; the
6580 defaults in this case are the looked-up data and an empty string, respectively.
6581 The expansion takes place before the string is processed as a list, and the
6582 file that is searched could contain lines like this:
6583 .code
6584 192.168.3.4: domain1:domain2:...
6585 192.168.1.9: domain3:domain4:...
6586 .endd
6587 When the lookup succeeds, the result of the expansion is a list of domains (and
6588 possibly other types of item that are allowed in domain lists).
6589
6590 In the second example, the lookup is a single item in a domain list. It causes
6591 Exim to use a lookup to see if the domain that is being processed can be found
6592 in the file. The file could contains lines like this:
6593 .code
6594 domain1:
6595 domain2:
6596 .endd
6597 Any data that follows the keys is not relevant when checking that the domain
6598 matches the list item.
6599
6600 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6601 Consider a file containing lines like this:
6602 .code
6603 192.168.5.6: lsearch;/another/file
6604 .endd
6605 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6606 first &%domains%& setting above generates the second setting, which therefore
6607 causes a second lookup to occur.
6608
6609 The rest of this chapter describes the different lookup types that are
6610 available. Any of them can be used in any part of the configuration where a
6611 lookup is permitted.
6612
6613
6614 .section "Lookup types" "SECID61"
6615 .cindex "lookup" "types of"
6616 .cindex "single-key lookup" "definition of"
6617 Two different types of data lookup are implemented:
6618
6619 .ilist
6620 The &'single-key'& type requires the specification of a file in which to look,
6621 and a single key to search for. The key must be a non-empty string for the
6622 lookup to succeed. The lookup type determines how the file is searched.
6623 .next
6624 .cindex "query-style lookup" "definition of"
6625 The &'query-style'& type accepts a generalized database query. No particular
6626 key value is assumed by Exim for query-style lookups. You can use whichever
6627 Exim variables you need to construct the database query.
6628 .endlist
6629
6630 The code for each lookup type is in a separate source file that is included in
6631 the binary of Exim only if the corresponding compile-time option is set. The
6632 default settings in &_src/EDITME_& are:
6633 .code
6634 LOOKUP_DBM=yes
6635 LOOKUP_LSEARCH=yes
6636 .endd
6637 which means that only linear searching and DBM lookups are included by default.
6638 For some types of lookup (e.g. SQL databases), you need to install appropriate
6639 libraries and header files before building Exim.
6640
6641
6642
6643
6644 .section "Single-key lookup types" "SECTsinglekeylookups"
6645 .cindex "lookup" "single-key types"
6646 .cindex "single-key lookup" "list of types"
6647 The following single-key lookup types are implemented:
6648
6649 .ilist
6650 .cindex "cdb" "description of"
6651 .cindex "lookup" "cdb"
6652 .cindex "binary zero" "in lookup key"
6653 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6654 string without a terminating binary zero. The cdb format is designed for
6655 indexed files that are read frequently and never updated, except by total
6656 re-creation. As such, it is particularly suitable for large files containing
6657 aliases or other indexed data referenced by an MTA. Information about cdb and
6658 tools for building the files can be found in several places:
6659 .display
6660 &url(https://cr.yp.to/cdb.html)
6661 &url(http://www.corpit.ru/mjt/tinycdb.html)
6662 &url(https://packages.debian.org/stable/utils/freecdb)
6663 &url(https://github.com/philpennock/cdbtools) (in Go)
6664 .endd
6665 . --- 2018-09-07: corpit.ru http:-only
6666 A cdb distribution is not needed in order to build Exim with cdb support,
6667 because the code for reading cdb files is included directly in Exim itself.
6668 However, no means of building or testing cdb files is provided with Exim, so
6669 you need to obtain a cdb distribution in order to do this.
6670 .next
6671 .cindex "DBM" "lookup type"
6672 .cindex "lookup" "dbm"
6673 .cindex "binary zero" "in lookup key"
6674 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6675 DBM file by looking up the record with the given key. A terminating binary
6676 zero is included in the key that is passed to the DBM library. See section
6677 &<<SECTdb>>& for a discussion of DBM libraries.
6678
6679 .cindex "Berkeley DB library" "file format"
6680 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6681 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6682 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6683 the DB_UNKNOWN option. This enables it to handle any of the types of database
6684 that the library supports, and can be useful for accessing DBM files created by
6685 other applications. (For earlier DB versions, DB_HASH is always used.)
6686 .next
6687 .cindex "lookup" "dbmjz"
6688 .cindex "lookup" "dbm &-- embedded NULs"
6689 .cindex "sasldb2"
6690 .cindex "dbmjz lookup type"
6691 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6692 interpreted as an Exim list; the elements of the list are joined together with
6693 ASCII NUL characters to form the lookup key.  An example usage would be to
6694 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6695 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6696 &(cram_md5)& authenticator.
6697 .next
6698 .cindex "lookup" "dbmnz"
6699 .cindex "lookup" "dbm &-- terminating zero"
6700 .cindex "binary zero" "in lookup key"
6701 .cindex "Courier"
6702 .cindex "&_/etc/userdbshadow.dat_&"
6703 .cindex "dbmnz lookup type"
6704 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6705 is not included in the key that is passed to the DBM library. You may need this
6706 if you want to look up data in files that are created by or shared with some
6707 other application that does not use terminating zeros. For example, you need to
6708 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6709 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6710 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6711 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6712 .next
6713 .cindex "lookup" "dsearch"
6714 .cindex "dsearch lookup type"
6715 &(dsearch)&: The given file must be a directory; this is searched for an entry
6716 whose name is the key by calling the &[lstat()]& function. The key may not
6717 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6718 the lookup is the name of the entry, which may be a file, directory,
6719 symbolic link, or any other kind of directory entry. An example of how this
6720 lookup can be used to support virtual domains is given in section
6721 &<<SECTvirtualdomains>>&.
6722 .next
6723 .cindex "lookup" "iplsearch"
6724 .cindex "iplsearch lookup type"
6725 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6726 terminated by a colon or white space or the end of the line. The keys in the
6727 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6728 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6729 being interpreted as a key terminator. For example:
6730 .code
6731 1.2.3.4:           data for 1.2.3.4
6732 192.168.0.0/16:    data for 192.168.0.0/16
6733 "abcd::cdab":      data for abcd::cdab
6734 "abcd:abcd::/32"   data for abcd:abcd::/32
6735 .endd
6736 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6737 file is searched linearly, using the CIDR masks where present, until a matching
6738 key is found. The first key that matches is used; there is no attempt to find a
6739 &"best"& match. Apart from the way the keys are matched, the processing for
6740 &(iplsearch)& is the same as for &(lsearch)&.
6741
6742 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6743 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6744 lookup types support only literal keys.
6745
6746 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6747 the implicit key is the host's IP address rather than its name (see section
6748 &<<SECThoslispatsikey>>&).
6749
6750 .new
6751 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6752 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6753 notation before executing the lookup.)
6754 .wen
6755 .next
6756 .new
6757 .cindex lookup json
6758 .cindex json "lookup type"
6759 .cindex JSON expansions
6760 &(json)&: The given file is a text file with a JSON structure.
6761 An element of the structure is extracted, defined by the search key.
6762 The key is a list of subelement selectors
6763 (colon-separated by default but changeable in the usual way)
6764 which are applied in turn to select smaller and smaller portions
6765 of the JSON structure.
6766 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6767 nunbered array element is selected.
6768 Otherwise it must apply to a JSON object; the named element is selected.
6769 The final resulting element can be a simple JSON type or a JSON object
6770 or array; for the latter two a string-representation os the JSON
6771 is returned.
6772 For elements of type string, the returned value is de-quoted.
6773 .wen
6774 .next
6775 .cindex "linear search"
6776 .cindex "lookup" "lsearch"
6777 .cindex "lsearch lookup type"
6778 .cindex "case sensitivity" "in lsearch lookup"
6779 &(lsearch)&: The given file is a text file that is searched linearly for a
6780 line beginning with the search key, terminated by a colon or white space or the
6781 end of the line. The search is case-insensitive; that is, upper and lower case
6782 letters are treated as the same. The first occurrence of the key that is found
6783 in the file is used.
6784
6785 White space between the key and the colon is permitted. The remainder of the
6786 line, with leading and trailing white space removed, is the data. This can be
6787 continued onto subsequent lines by starting them with any amount of white
6788 space, but only a single space character is included in the data at such a
6789 junction. If the data begins with a colon, the key must be terminated by a
6790 colon, for example:
6791 .code
6792 baduser:  :fail:
6793 .endd
6794 Empty lines and lines beginning with # are ignored, even if they occur in the
6795 middle of an item. This is the traditional textual format of alias files. Note
6796 that the keys in an &(lsearch)& file are literal strings. There is no
6797 wildcarding of any kind.
6798
6799 .cindex "lookup" "lsearch &-- colons in keys"
6800 .cindex "white space" "in lsearch key"
6801 In most &(lsearch)& files, keys are not required to contain colons or #
6802 characters, or white space. However, if you need this feature, it is available.
6803 If a key begins with a doublequote character, it is terminated only by a
6804 matching quote (or end of line), and the normal escaping rules apply to its
6805 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6806 quoted keys (exactly as for unquoted keys). There is no special handling of
6807 quotes for the data part of an &(lsearch)& line.
6808
6809 .next
6810 .cindex "NIS lookup type"
6811 .cindex "lookup" "NIS"
6812 .cindex "binary zero" "in lookup key"
6813 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6814 the given key, without a terminating binary zero. There is a variant called
6815 &(nis0)& which does include the terminating binary zero in the key. This is
6816 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6817 aliases; the full map names must be used.
6818
6819 .next
6820 .cindex "wildlsearch lookup type"
6821 .cindex "lookup" "wildlsearch"
6822 .cindex "nwildlsearch lookup type"
6823 .cindex "lookup" "nwildlsearch"
6824 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6825 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6826 the file may be wildcarded. The difference between these two lookup types is
6827 that for &(wildlsearch)&, each key in the file is string-expanded before being
6828 used, whereas for &(nwildlsearch)&, no expansion takes place.
6829
6830 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6831 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6832 file that are regular expressions can be made case-sensitive by the use of
6833 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6834
6835 . ==== As this is a nested list, any displays it contains must be indented
6836 . ==== as otherwise they are too far to the left.
6837
6838 .olist
6839 The string may begin with an asterisk to mean &"ends with"&. For example:
6840 .code
6841     *.a.b.c       data for anything.a.b.c
6842     *fish         data for anythingfish
6843 .endd
6844 .next
6845 The string may begin with a circumflex to indicate a regular expression. For
6846 example, for &(wildlsearch)&:
6847 .code
6848     ^\N\d+\.a\.b\N    data for <digits>.a.b
6849 .endd
6850 Note the use of &`\N`& to disable expansion of the contents of the regular
6851 expression. If you are using &(nwildlsearch)&, where the keys are not
6852 string-expanded, the equivalent entry is:
6853 .code
6854     ^\d+\.a\.b        data for <digits>.a.b
6855 .endd
6856 The case-insensitive flag is set at the start of compiling the regular
6857 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6858 For example, to make the entire pattern case-sensitive:
6859 .code
6860     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6861 .endd
6862
6863 If the regular expression contains white space or colon characters, you must
6864 either quote it (see &(lsearch)& above), or represent these characters in other
6865 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6866 colon. This may be easier than quoting, because if you quote, you have to
6867 escape all the backslashes inside the quotes.
6868
6869 &*Note*&: It is not possible to capture substrings in a regular expression
6870 match for later use, because the results of all lookups are cached. If a lookup
6871 is repeated, the result is taken from the cache, and no actual pattern matching
6872 takes place. The values of all the numeric variables are unset after a
6873 &((n)wildlsearch)& match.
6874
6875 .next
6876 Although I cannot see it being of much use, the general matching function that
6877 is used to implement &((n)wildlsearch)& means that the string may begin with a
6878 lookup name terminated by a semicolon, and followed by lookup data. For
6879 example:
6880 .code
6881     cdb;/some/file  data for keys that match the file
6882 .endd
6883 The data that is obtained from the nested lookup is discarded.
6884 .endlist olist
6885
6886 Keys that do not match any of these patterns are interpreted literally. The
6887 continuation rules for the data are the same as for &(lsearch)&, and keys may
6888 be followed by optional colons.
6889
6890 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6891 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6892 lookup types support only literal keys.
6893
6894 .next
6895 .cindex "lookup" "spf"
6896 If Exim is built with SPF support, manual lookups can be done
6897 (as opposed to the standard ACL condition method.
6898 For details see section &<<SECSPF>>&.
6899 .endlist ilist
6900
6901
6902 .section "Query-style lookup types" "SECTquerystylelookups"
6903 .cindex "lookup" "query-style types"
6904 .cindex "query-style lookup" "list of types"
6905 The supported query-style lookup types are listed below. Further details about
6906 many of them are given in later sections.
6907
6908 .ilist
6909 .cindex "DNS" "as a lookup type"
6910 .cindex "lookup" "DNS"
6911 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6912 are given in the supplied query. The resulting data is the contents of the
6913 records. See section &<<SECTdnsdb>>&.
6914 .next
6915 .cindex "InterBase lookup type"
6916 .cindex "lookup" "InterBase"
6917 &(ibase)&: This does a lookup in an InterBase database.
6918 .next
6919 .cindex "LDAP" "lookup type"
6920 .cindex "lookup" "LDAP"
6921 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6922 returns attributes from a single entry. There is a variant called &(ldapm)&
6923 that permits values from multiple entries to be returned. A third variant
6924 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6925 any attribute values. See section &<<SECTldap>>&.
6926 .next
6927 .cindex "MySQL" "lookup type"
6928 .cindex "lookup" "MySQL"
6929 &(mysql)&: The format of the query is an SQL statement that is passed to a
6930 MySQL database. See section &<<SECTsql>>&.
6931 .next
6932 .cindex "NIS+ lookup type"
6933 .cindex "lookup" "NIS+"
6934 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6935 the field to be returned. See section &<<SECTnisplus>>&.
6936 .next
6937 .cindex "Oracle" "lookup type"
6938 .cindex "lookup" "Oracle"
6939 &(oracle)&: The format of the query is an SQL statement that is passed to an
6940 Oracle database. See section &<<SECTsql>>&.
6941 .next
6942 .cindex "lookup" "passwd"
6943 .cindex "passwd lookup type"
6944 .cindex "&_/etc/passwd_&"
6945 &(passwd)& is a query-style lookup with queries that are just user names. The
6946 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6947 success, the result string is the same as you would get from an &(lsearch)&
6948 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6949 password value. For example:
6950 .code
6951 *:42:42:King Rat:/home/kr:/bin/bash
6952 .endd
6953 .next
6954 .cindex "PostgreSQL lookup type"
6955 .cindex "lookup" "PostgreSQL"
6956 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6957 PostgreSQL database. See section &<<SECTsql>>&.
6958
6959 .next
6960 .cindex "Redis lookup type"
6961 .cindex lookup Redis
6962 &(redis)&: The format of the query is either a simple get or simple set,
6963 passed to a Redis database. See section &<<SECTsql>>&.
6964
6965 .next
6966 .cindex "sqlite lookup type"
6967 .cindex "lookup" "sqlite"
6968 &(sqlite)&: The format of the query is a filename followed by an SQL statement
6969 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6970
6971 .next
6972 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6973 not likely to be useful in normal operation.
6974 .next
6975 .cindex "whoson lookup type"
6976 .cindex "lookup" "whoson"
6977 . --- still http:-only, 2018-09-07
6978 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6979 allows a server to check whether a particular (dynamically allocated) IP
6980 address is currently allocated to a known (trusted) user and, optionally, to
6981 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6982 at one time for &"POP before SMTP"& authentication, but that approach has been
6983 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6984 &"POP before SMTP"& checking using ACL statements such as
6985 .code
6986 require condition = \
6987   ${lookup whoson {$sender_host_address}{yes}{no}}
6988 .endd
6989 The query consists of a single IP address. The value returned is the name of
6990 the authenticated user, which is stored in the variable &$value$&. However, in
6991 this example, the data in &$value$& is not used; the result of the lookup is
6992 one of the fixed strings &"yes"& or &"no"&.
6993 .endlist
6994
6995
6996
6997 .section "Temporary errors in lookups" "SECID63"
6998 .cindex "lookup" "temporary error in"
6999 Lookup functions can return temporary error codes if the lookup cannot be
7000 completed. For example, an SQL or LDAP database might be unavailable. For this
7001 reason, it is not advisable to use a lookup that might do this for critical
7002 options such as a list of local domains.
7003
7004 When a lookup cannot be completed in a router or transport, delivery
7005 of the message (to the relevant address) is deferred, as for any other
7006 temporary error. In other circumstances Exim may assume the lookup has failed,
7007 or may give up altogether.
7008
7009
7010
7011 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7012 .cindex "wildcard lookups"
7013 .cindex "lookup" "default values"
7014 .cindex "lookup" "wildcard"
7015 .cindex "lookup" "* added to type"
7016 .cindex "default" "in single-key lookups"
7017 In this context, a &"default value"& is a value specified by the administrator
7018 that is to be used if a lookup fails.
7019
7020 &*Note:*& This section applies only to single-key lookups. For query-style
7021 lookups, the facilities of the query language must be used. An attempt to
7022 specify a default for a query-style lookup provokes an error.
7023
7024 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7025 and the initial lookup fails, the key &"*"& is looked up in the file to
7026 provide a default value. See also the section on partial matching below.
7027
7028 .cindex "*@ with single-key lookup"
7029 .cindex "lookup" "*@ added to type"
7030 .cindex "alias file" "per-domain default"
7031 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7032 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7033 character, a second lookup is done with everything before the last @ replaced
7034 by *. This makes it possible to provide per-domain defaults in alias files
7035 that include the domains in the keys. If the second lookup fails (or doesn't
7036 take place because there is no @ in the key), &"*"& is looked up.
7037 For example, a &(redirect)& router might contain:
7038 .code
7039 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7040 .endd
7041 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7042 looks up these keys, in this order:
7043 .code
7044 jane@eyre.example
7045 *@eyre.example
7046 *
7047 .endd
7048 The data is taken from whichever key it finds first. &*Note*&: In an
7049 &(lsearch)& file, this does not mean the first of these keys in the file. A
7050 complete scan is done for each key, and only if it is not found at all does
7051 Exim move on to try the next key.
7052
7053
7054
7055 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7056 .cindex "partial matching"
7057 .cindex "wildcard lookups"
7058 .cindex "lookup" "partial matching"
7059 .cindex "lookup" "wildcard"
7060 .cindex "asterisk" "in search type"
7061 The normal operation of a single-key lookup is to search the file for an exact
7062 match with the given key. However, in a number of situations where domains are
7063 being looked up, it is useful to be able to do partial matching. In this case,
7064 information in the file that has a key starting with &"*."& is matched by any
7065 domain that ends with the components that follow the full stop. For example, if
7066 a key in a DBM file is
7067 .code
7068 *.dates.fict.example
7069 .endd
7070 then when partial matching is enabled this is matched by (amongst others)
7071 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7072 by &'dates.fict.example'&, if that does not appear as a separate key in the
7073 file.
7074
7075 &*Note*&: Partial matching is not available for query-style lookups. It is
7076 also not available for any lookup items in address lists (see section
7077 &<<SECTaddresslist>>&).
7078
7079 Partial matching is implemented by doing a series of separate lookups using
7080 keys constructed by modifying the original subject key. This means that it can
7081 be used with any of the single-key lookup types, provided that
7082 partial matching keys
7083 beginning with a special prefix (default &"*."&) are included in the data file.
7084 Keys in the file that do not begin with the prefix are matched only by
7085 unmodified subject keys when partial matching is in use.
7086
7087 Partial matching is requested by adding the string &"partial-"& to the front of
7088 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7089 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7090 is added at the start of the subject key, and it is looked up again. If that
7091 fails, further lookups are tried with dot-separated components removed from the
7092 start of the subject key, one-by-one, and &"*."& added on the front of what
7093 remains.
7094
7095 A minimum number of two non-* components are required. This can be adjusted
7096 by including a number before the hyphen in the search type. For example,
7097 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7098 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7099 subject key is &'2250.dates.fict.example'& then the following keys are looked
7100 up when the minimum number of non-* components is two:
7101 .code
7102 2250.dates.fict.example
7103 *.2250.dates.fict.example
7104 *.dates.fict.example
7105 *.fict.example
7106 .endd
7107 As soon as one key in the sequence is successfully looked up, the lookup
7108 finishes.
7109
7110 .cindex "lookup" "partial matching &-- changing prefix"
7111 .cindex "prefix" "for partial matching"
7112 The use of &"*."& as the partial matching prefix is a default that can be
7113 changed. The motivation for this feature is to allow Exim to operate with file
7114 formats that are used by other MTAs. A different prefix can be supplied in
7115 parentheses instead of the hyphen after &"partial"&. For example:
7116 .code
7117 domains = partial(.)lsearch;/some/file
7118 .endd
7119 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7120 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7121 components is unchanged). The prefix may consist of any punctuation characters
7122 other than a closing parenthesis. It may be empty, for example:
7123 .code
7124 domains = partial1()cdb;/some/file
7125 .endd
7126 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7127 &`a.b.c`&, &`b.c`&, and &`c`&.
7128
7129 If &"partial0"& is specified, what happens at the end (when the lookup with
7130 just one non-wild component has failed, and the original key is shortened right
7131 down to the null string) depends on the prefix:
7132
7133 .ilist
7134 If the prefix has zero length, the whole lookup fails.
7135 .next
7136 If the prefix has length 1, a lookup for just the prefix is done. For
7137 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7138 .next
7139 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7140 remainder is looked up. With the default prefix, therefore, the final lookup is
7141 for &"*"& on its own.
7142 .next
7143 Otherwise, the whole prefix is looked up.
7144 .endlist
7145
7146
7147 If the search type ends in &"*"& or &"*@"& (see section
7148 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7149 this implies happens after all partial lookups have failed. If &"partial0"& is
7150 specified, adding &"*"& to the search type has no effect with the default
7151 prefix, because the &"*"& key is already included in the sequence of partial
7152 lookups. However, there might be a use for lookup types such as
7153 &"partial0(.)lsearch*"&.
7154
7155 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7156 in domain lists and the like. Partial matching works only in terms of
7157 dot-separated components; a key such as &`*fict.example`&
7158 in a database file is useless, because the asterisk in a partial matching
7159 subject key is always followed by a dot.
7160
7161
7162
7163
7164 .section "Lookup caching" "SECID64"
7165 .cindex "lookup" "caching"
7166 .cindex "caching" "lookup data"
7167 Exim caches all lookup results in order to avoid needless repetition of
7168 lookups. However, because (apart from the daemon) Exim operates as a collection
7169 of independent, short-lived processes, this caching applies only within a
7170 single Exim process. There is no inter-process lookup caching facility.
7171
7172 For single-key lookups, Exim keeps the relevant files open in case there is
7173 another lookup that needs them. In some types of configuration this can lead to
7174 many files being kept open for messages with many recipients. To avoid hitting
7175 the operating system limit on the number of simultaneously open files, Exim
7176 closes the least recently used file when it needs to open more files than its
7177 own internal limit, which can be changed via the &%lookup_open_max%& option.
7178
7179 The single-key lookup files are closed and the lookup caches are flushed at
7180 strategic points during delivery &-- for example, after all routing is
7181 complete.
7182
7183
7184
7185
7186 .section "Quoting lookup data" "SECID65"
7187 .cindex "lookup" "quoting"
7188 .cindex "quoting" "in lookups"
7189 When data from an incoming message is included in a query-style lookup, there
7190 is the possibility of special characters in the data messing up the syntax of
7191 the query. For example, a NIS+ query that contains
7192 .code
7193 [name=$local_part]
7194 .endd
7195 will be broken if the local part happens to contain a closing square bracket.
7196 For NIS+, data can be enclosed in double quotes like this:
7197 .code
7198 [name="$local_part"]
7199 .endd
7200 but this still leaves the problem of a double quote in the data. The rule for
7201 NIS+ is that double quotes must be doubled. Other lookup types have different
7202 rules, and to cope with the differing requirements, an expansion operator
7203 of the following form is provided:
7204 .code
7205 ${quote_<lookup-type>:<string>}
7206 .endd
7207 For example, the safest way to write the NIS+ query is
7208 .code
7209 [name="${quote_nisplus:$local_part}"]
7210 .endd
7211 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7212 operator can be used for all lookup types, but has no effect for single-key
7213 lookups, since no quoting is ever needed in their key strings.
7214
7215
7216
7217
7218 .section "More about dnsdb" "SECTdnsdb"
7219 .cindex "dnsdb lookup"
7220 .cindex "lookup" "dnsdb"
7221 .cindex "DNS" "as a lookup type"
7222 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7223 of a record type and a domain name, separated by an equals sign. For example,
7224 an expansion string could contain:
7225 .code
7226 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7227 .endd
7228 If the lookup succeeds, the result is placed in &$value$&, which in this case
7229 is used on its own as the result. If the lookup does not succeed, the
7230 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7231 &<<SECTforexpfai>>& for an explanation of what this means.
7232
7233 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7234 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7235 If no type is given, TXT is assumed.
7236
7237 For any record type, if multiple records are found, the data is returned as a
7238 concatenation, with newline as the default separator. The order, of course,
7239 depends on the DNS resolver. You can specify a different separator character
7240 between multiple records by putting a right angle-bracket followed immediately
7241 by the new separator at the start of the query. For example:
7242 .code
7243 ${lookup dnsdb{>: a=host1.example}}
7244 .endd
7245 It is permitted to specify a space as the separator character. Further
7246 white space is ignored.
7247 For lookup types that return multiple fields per record,
7248 an alternate field separator can be specified using a comma after the main
7249 separator character, followed immediately by the field separator.
7250
7251 .cindex "PTR record" "in &(dnsdb)& lookup"
7252 When the type is PTR,
7253 the data can be an IP address, written as normal; inversion and the addition of
7254 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7255 .code
7256 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7257 .endd
7258 If the data for a PTR record is not a syntactically valid IP address, it is not
7259 altered and nothing is added.
7260
7261 .cindex "MX record" "in &(dnsdb)& lookup"
7262 .cindex "SRV record" "in &(dnsdb)& lookup"
7263 For an MX lookup, both the preference value and the host name are returned for
7264 each record, separated by a space. For an SRV lookup, the priority, weight,
7265 port, and host name are returned for each record, separated by spaces.
7266 The field separator can be modified as above.
7267
7268 .cindex "TXT record" "in &(dnsdb)& lookup"
7269 .cindex "SPF record" "in &(dnsdb)& lookup"
7270 For TXT records with multiple items of data, only the first item is returned,
7271 unless a field separator is specified.
7272 To concatenate items without a separator, use a semicolon instead.
7273 For SPF records the
7274 default behaviour is to concatenate multiple items without using a separator.
7275 .code
7276 ${lookup dnsdb{>\n,: txt=a.b.example}}
7277 ${lookup dnsdb{>\n; txt=a.b.example}}
7278 ${lookup dnsdb{spf=example.org}}
7279 .endd
7280 It is permitted to specify a space as the separator character. Further
7281 white space is ignored.
7282
7283 .cindex "SOA record" "in &(dnsdb)& lookup"
7284 For an SOA lookup, while no result is obtained the lookup is redone with
7285 successively more leading components dropped from the given domain.
7286 Only the primary-nameserver field is returned unless a field separator is
7287 specified.
7288 .code
7289 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7290 .endd
7291
7292 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7293 .cindex "dnsdb modifiers"
7294 .cindex "modifiers" "dnsdb"
7295 .cindex "options" "dnsdb"
7296 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7297 each followed by a comma,
7298 that may appear before the record type.
7299
7300 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7301 temporary DNS error for any of them, the behaviour is controlled by
7302 a defer-option modifier.
7303 The possible keywords are
7304 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7305 With &"strict"& behaviour, any temporary DNS error causes the
7306 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7307 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7308 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7309 error causes the whole lookup to defer only if none of the other lookups
7310 succeed. The default is &"lax"&, so the following lookups are equivalent:
7311 .code
7312 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7313 ${lookup dnsdb{a=one.host.com:two.host.com}}
7314 .endd
7315 Thus, in the default case, as long as at least one of the DNS lookups
7316 yields some data, the lookup succeeds.
7317
7318 .cindex "DNSSEC" "dns lookup"
7319 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7320 The possible keywords are
7321 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7322 With &"strict"& or &"lax"& DNSSEC information is requested
7323 with the lookup.
7324 With &"strict"& a response from the DNS resolver that
7325 is not labelled as authenticated data
7326 is treated as equivalent to a temporary DNS error.
7327 The default is &"never"&.
7328
7329 See also the &$lookup_dnssec_authenticated$& variable.
7330
7331 .cindex timeout "dns lookup"
7332 .cindex "DNS" timeout
7333 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7334 The form is &"retrans_VAL"& where VAL is an Exim time specification
7335 (e.g. &"5s"&).
7336 The default value is set by the main configuration option &%dns_retrans%&.
7337
7338 Retries for the dnsdb lookup can be controlled by a retry modifier.
7339 The form if &"retry_VAL"& where VAL is an integer.
7340 The default count is set by the main configuration option &%dns_retry%&.
7341
7342 .cindex caching "of dns lookup"
7343 .cindex TTL "of dns lookup"
7344 .cindex DNS TTL
7345 Dnsdb lookup results are cached within a single process (and its children).
7346 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7347 value of the set of returned DNS records.
7348
7349
7350 .section "Pseudo dnsdb record types" "SECID66"
7351 .cindex "MX record" "in &(dnsdb)& lookup"
7352 By default, both the preference value and the host name are returned for
7353 each MX record, separated by a space. If you want only host names, you can use
7354 the pseudo-type MXH:
7355 .code
7356 ${lookup dnsdb{mxh=a.b.example}}
7357 .endd
7358 In this case, the preference values are omitted, and just the host names are
7359 returned.
7360
7361 .cindex "name server for enclosing domain"
7362 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7363 records on the given domain, but if none are found, it removes the first
7364 component of the domain name, and tries again. This process continues until NS
7365 records are found or there are no more components left (or there is a DNS
7366 error). In other words, it may return the name servers for a top-level domain,
7367 but it never returns the root name servers. If there are no NS records for the
7368 top-level domain, the lookup fails. Consider these examples:
7369 .code
7370 ${lookup dnsdb{zns=xxx.quercite.com}}
7371 ${lookup dnsdb{zns=xxx.edu}}
7372 .endd
7373 Assuming that in each case there are no NS records for the full domain name,
7374 the first returns the name servers for &%quercite.com%&, and the second returns
7375 the name servers for &%edu%&.
7376
7377 You should be careful about how you use this lookup because, unless the
7378 top-level domain does not exist, the lookup always returns some host names. The
7379 sort of use to which this might be put is for seeing if the name servers for a
7380 given domain are on a blacklist. You can probably assume that the name servers
7381 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7382 such a list.
7383
7384 .cindex "CSA" "in &(dnsdb)& lookup"
7385 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7386 records according to the CSA rules, which are described in section
7387 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7388 not sufficient because of the extra parent domain search behaviour of CSA. The
7389 result of a successful lookup such as:
7390 .code
7391 ${lookup dnsdb {csa=$sender_helo_name}}
7392 .endd
7393 has two space-separated fields: an authorization code and a target host name.
7394 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7395 authorization required but absent, or &"?"& for unknown.
7396
7397 .cindex "A+" "in &(dnsdb)& lookup"
7398 The pseudo-type A+ performs an AAAA
7399 and then an A lookup.  All results are returned; defer processing
7400 (see below) is handled separately for each lookup.  Example:
7401 .code
7402 ${lookup dnsdb {>; a+=$sender_helo_name}}
7403 .endd
7404
7405
7406 .section "Multiple dnsdb lookups" "SECID67"
7407 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7408 However, you can specify a list of domains or IP addresses in a single
7409 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7410 the default separator, but with the ability to change this. For example:
7411 .code
7412 ${lookup dnsdb{one.domain.com:two.domain.com}}
7413 ${lookup dnsdb{a=one.host.com:two.host.com}}
7414 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7415 .endd
7416 In order to retain backwards compatibility, there is one special case: if
7417 the lookup type is PTR and no change of separator is specified, Exim looks
7418 to see if the rest of the string is precisely one IPv6 address. In this
7419 case, it does not treat it as a list.
7420
7421 The data from each lookup is concatenated, with newline separators by default,
7422 in the same way that multiple DNS records for a single item are handled. A
7423 different separator can be specified, as described above.
7424
7425
7426
7427
7428 .section "More about LDAP" "SECTldap"
7429 .cindex "LDAP" "lookup, more about"
7430 .cindex "lookup" "LDAP"
7431 .cindex "Solaris" "LDAP"
7432 The original LDAP implementation came from the University of Michigan; this has
7433 become &"Open LDAP"&, and there are now two different releases. Another
7434 implementation comes from Netscape, and Solaris 7 and subsequent releases
7435 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7436 the lookup function level, their error handling is different. For this reason
7437 it is necessary to set a compile-time variable when building Exim with LDAP, to
7438 indicate which LDAP library is in use. One of the following should appear in
7439 your &_Local/Makefile_&:
7440 .code
7441 LDAP_LIB_TYPE=UMICHIGAN
7442 LDAP_LIB_TYPE=OPENLDAP1
7443 LDAP_LIB_TYPE=OPENLDAP2
7444 LDAP_LIB_TYPE=NETSCAPE
7445 LDAP_LIB_TYPE=SOLARIS
7446 .endd
7447 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7448 same interface as the University of Michigan version.
7449
7450 There are three LDAP lookup types in Exim. These behave slightly differently in
7451 the way they handle the results of a query:
7452
7453 .ilist
7454 &(ldap)& requires the result to contain just one entry; if there are more, it
7455 gives an error.
7456 .next
7457 &(ldapdn)& also requires the result to contain just one entry, but it is the
7458 Distinguished Name that is returned rather than any attribute values.
7459 .next
7460 &(ldapm)& permits the result to contain more than one entry; the attributes
7461 from all of them are returned.
7462 .endlist
7463
7464
7465 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7466 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7467 the data returned by a successful lookup is described in the next section.
7468 First we explain how LDAP queries are coded.
7469
7470
7471 .section "Format of LDAP queries" "SECTforldaque"
7472 .cindex "LDAP" "query format"
7473 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7474 the configuration of a &(redirect)& router one might have this setting:
7475 .code
7476 data = ${lookup ldap \
7477   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7478   c=UK?mailbox?base?}}
7479 .endd
7480 .cindex "LDAP" "with TLS"
7481 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7482 secure (encrypted) LDAP connections. The second of these ensures that an
7483 encrypted TLS connection is used.
7484
7485 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7486 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7487 See the &%ldap_start_tls%& option.
7488
7489 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7490 controlled. Every part of the TLS configuration can be configured by settings in
7491 &_exim.conf_&. Depending on the version of the client libraries installed on
7492 your system, some of the initialization may have required setting options in
7493 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7494 certificates. This revealed a nuance where the current UID that exim was
7495 running as could affect which config files it read. With Exim 4.83, these
7496 methods become optional, only taking effect if not specifically set in
7497 &_exim.conf_&.
7498
7499
7500 .section "LDAP quoting" "SECID68"
7501 .cindex "LDAP" "quoting"
7502 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7503 and the second because the LDAP query is represented as a URL. Furthermore,
7504 within an LDAP query, two different kinds of quoting are required. For this
7505 reason, there are two different LDAP-specific quoting operators.
7506
7507 The &%quote_ldap%& operator is designed for use on strings that are part of
7508 filter specifications. Conceptually, it first does the following conversions on
7509 the string:
7510 .code
7511 *   =>   \2A
7512 (   =>   \28
7513 )   =>   \29
7514 \   =>   \5C
7515 .endd
7516 in accordance with RFC 2254. The resulting string is then quoted according
7517 to the rules for URLs, that is, all non-alphanumeric characters except
7518 .code
7519 ! $ ' - . _ ( ) * +
7520 .endd
7521 are converted to their hex values, preceded by a percent sign. For example:
7522 .code
7523 ${quote_ldap: a(bc)*, a<yz>; }
7524 .endd
7525 yields
7526 .code
7527 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7528 .endd
7529 Removing the URL quoting, this is (with a leading and a trailing space):
7530 .code
7531 a\28bc\29\2A, a<yz>;
7532 .endd
7533 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7534 base DN specifications in queries. Conceptually, it first converts the string
7535 by inserting a backslash in front of any of the following characters:
7536 .code
7537 , + " \ < > ;
7538 .endd
7539 It also inserts a backslash before any leading spaces or # characters, and
7540 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7541 is then quoted according to the rules for URLs. For example:
7542 .code
7543 ${quote_ldap_dn: a(bc)*, a<yz>; }
7544 .endd
7545 yields
7546 .code
7547 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7548 .endd
7549 Removing the URL quoting, this is (with a trailing space):
7550 .code
7551 \ a(bc)*\, a\<yz\>\;\
7552 .endd
7553 There are some further comments about quoting in the section on LDAP
7554 authentication below.
7555
7556
7557 .section "LDAP connections" "SECID69"
7558 .cindex "LDAP" "connections"
7559 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7560 is in use, via a Unix domain socket. The example given above does not specify
7561 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7562 by starting it with
7563 .code
7564 ldap://<hostname>:<port>/...
7565 .endd
7566 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7567 used. When no server is specified in a query, a list of default servers is
7568 taken from the &%ldap_default_servers%& configuration option. This supplies a
7569 colon-separated list of servers which are tried in turn until one successfully
7570 handles a query, or there is a serious error. Successful handling either
7571 returns the requested data, or indicates that it does not exist. Serious errors
7572 are syntactical, or multiple values when only a single value is expected.
7573 Errors which cause the next server to be tried are connection failures, bind
7574 failures, and timeouts.
7575
7576 For each server name in the list, a port number can be given. The standard way
7577 of specifying a host and port is to use a colon separator (RFC 1738). Because
7578 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7579 doubled. For example
7580 .code
7581 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7582 .endd
7583 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7584 to the LDAP library with no server name, and the library's default (normally
7585 the local host) is used.
7586
7587 If you are using the OpenLDAP library, you can connect to an LDAP server using
7588 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7589 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7590 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7591 not available.
7592
7593 For this type of connection, instead of a host name for the server, a pathname
7594 for the socket is required, and the port number is not relevant. The pathname
7595 can be specified either as an item in &%ldap_default_servers%&, or inline in
7596 the query. In the former case, you can have settings such as
7597 .code
7598 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7599 .endd
7600 When the pathname is given in the query, you have to escape the slashes as
7601 &`%2F`& to fit in with the LDAP URL syntax. For example:
7602 .code
7603 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7604 .endd
7605 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7606 a pathname, it uses the Unix domain socket code, even if the query actually
7607 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7608 socket connection. This behaviour means that you can use a setting of
7609 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7610 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7611 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7612 backup host.
7613
7614 If an explicit &`ldapi`& type is given in a query when a host name is
7615 specified, an error is diagnosed. However, if there are more items in
7616 &%ldap_default_servers%&, they are tried. In other words:
7617
7618 .ilist
7619 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7620 interface.
7621 .next
7622 Using &`ldapi`& with a host name causes an error.
7623 .endlist
7624
7625
7626 Using &`ldapi`& with no host or path in the query, and no setting of
7627 &%ldap_default_servers%&, does whatever the library does by default.
7628
7629
7630
7631 .section "LDAP authentication and control information" "SECID70"
7632 .cindex "LDAP" "authentication"
7633 The LDAP URL syntax provides no way of passing authentication and other control
7634 information to the server. To make this possible, the URL in an LDAP query may
7635 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7636 spaces. If a value contains spaces it must be enclosed in double quotes, and
7637 when double quotes are used, backslash is interpreted in the usual way inside
7638 them. The following names are recognized:
7639 .display
7640 &`DEREFERENCE`&  set the dereferencing parameter
7641 &`NETTIME    `&  set a timeout for a network operation
7642 &`USER       `&  set the DN, for authenticating the LDAP bind
7643 &`PASS       `&  set the password, likewise
7644 &`REFERRALS  `&  set the referrals parameter
7645 &`SERVERS    `&  set alternate server list for this query only
7646 &`SIZE       `&  set the limit for the number of entries returned
7647 &`TIME       `&  set the maximum waiting time for a query
7648 .endd
7649 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7650 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7651 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7652 library from trying to follow referrals issued by the LDAP server.
7653
7654 .cindex LDAP timeout
7655 .cindex timeout "LDAP lookup"
7656 The name CONNECT is an obsolete name for NETTIME, retained for
7657 backwards compatibility. This timeout (specified as a number of seconds) is
7658 enforced from the client end for operations that can be carried out over a
7659 network. Specifically, it applies to network connections and calls to the
7660 &'ldap_result()'& function. If the value is greater than zero, it is used if
7661 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7662 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7663 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7664 Netscape SDK; for OpenLDAP no action is taken.
7665
7666 The TIME parameter (also a number of seconds) is passed to the server to
7667 set a server-side limit on the time taken to complete a search.
7668
7669 The SERVERS parameter allows you to specify an alternate list of ldap servers
7670 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7671 default list of ldap servers, and a single lookup can specify a single ldap
7672 server to use.  But when you need to do a lookup with a list of servers that is
7673 different than the default list (maybe different order, maybe a completely
7674 different set of servers), the SERVERS parameter allows you to specify this
7675 alternate list (colon-separated).
7676
7677 Here is an example of an LDAP query in an Exim lookup that uses some of these
7678 values. This is a single line, folded to fit on the page:
7679 .code
7680 ${lookup ldap
7681   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7682   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7683   {$value}fail}
7684 .endd
7685 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7686 any of the auxiliary data. Exim configuration settings that include lookups
7687 which contain password information should be preceded by &"hide"& to prevent
7688 non-admin users from using the &%-bP%& option to see their values.
7689
7690 The auxiliary data items may be given in any order. The default is no
7691 connection timeout (the system timeout is used), no user or password, no limit
7692 on the number of entries returned, and no time limit on queries.
7693
7694 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7695 removes any URL quoting that it may contain before passing it LDAP. Apparently
7696 some libraries do this for themselves, but some do not. Removing the URL
7697 quoting has two advantages:
7698
7699 .ilist
7700 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7701 DNs as with DNs inside actual queries.
7702 .next
7703 It permits spaces inside USER= DNs.
7704 .endlist
7705
7706 For example, a setting such as
7707 .code
7708 USER=cn=${quote_ldap_dn:$1}
7709 .endd
7710 should work even if &$1$& contains spaces.
7711
7712 Expanded data for the PASS= value should be quoted using the &%quote%&
7713 expansion operator, rather than the LDAP quote operators. The only reason this
7714 field needs quoting is to ensure that it conforms to the Exim syntax, which
7715 does not allow unquoted spaces. For example:
7716 .code
7717 PASS=${quote:$3}
7718 .endd
7719 The LDAP authentication mechanism can be used to check passwords as part of
7720 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7721 &<<CHAPexpand>>&.
7722
7723
7724
7725 .section "Format of data returned by LDAP" "SECID71"
7726 .cindex "LDAP" "returned data formats"
7727 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7728 as a sequence of values, for example
7729 .code
7730 cn=manager,o=University of Cambridge,c=UK
7731 .endd
7732 The &(ldap)& lookup type generates an error if more than one entry matches the
7733 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7734 the result between the data from different entries. It is possible for multiple
7735 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7736 you know that whatever values are returned all came from a single entry in the
7737 directory.
7738
7739 In the common case where you specify a single attribute in your LDAP query, the
7740 result is not quoted, and does not contain the attribute name. If the attribute
7741 has multiple values, they are separated by commas. Any comma that is
7742 part of an attribute's value is doubled.
7743
7744 If you specify multiple attributes, the result contains space-separated, quoted
7745 strings, each preceded by the attribute name and an equals sign. Within the
7746 quotes, the quote character, backslash, and newline are escaped with
7747 backslashes, and commas are used to separate multiple values for the attribute.
7748 Any commas in attribute values are doubled
7749 (permitting treatment of the values as a comma-separated list).
7750 Apart from the escaping, the string within quotes takes the same form as the
7751 output when a single attribute is requested. Specifying no attributes is the
7752 same as specifying all of an entry's attributes.
7753
7754 Here are some examples of the output format. The first line of each pair is an
7755 LDAP query, and the second is the data that is returned. The attribute called
7756 &%attr1%& has two values, one of them with an embedded comma, whereas
7757 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7758 (they have SUP &%attr%& in their schema definitions).
7759
7760 .code
7761 ldap:///o=base?attr1?sub?(uid=fred)
7762 value1.1,value1,,2
7763
7764 ldap:///o=base?attr2?sub?(uid=fred)
7765 value two
7766
7767 ldap:///o=base?attr?sub?(uid=fred)
7768 value1.1,value1,,2,value two
7769
7770 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7771 attr1="value1.1,value1,,2" attr2="value two"
7772
7773 ldap:///o=base??sub?(uid=fred)
7774 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7775 .endd
7776 You can
7777 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7778 results of LDAP lookups.
7779 The &%extract%& operator in string expansions can be used to pick out
7780 individual fields from data that consists of &'key'&=&'value'& pairs.
7781 The &%listextract%& operator should be used to pick out individual values
7782 of attributes, even when only a single value is expected.
7783 The doubling of embedded commas allows you to use the returned data as a
7784 comma separated list (using the "<," syntax for changing the input list separator).
7785
7786
7787
7788
7789 .section "More about NIS+" "SECTnisplus"
7790 .cindex "NIS+ lookup type"
7791 .cindex "lookup" "NIS+"
7792 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7793 and field name. If this is given, the result of a successful query is the
7794 contents of the named field; otherwise the result consists of a concatenation
7795 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7796 values containing spaces are quoted. For example, the query
7797 .code
7798 [name=mg1456],passwd.org_dir
7799 .endd
7800 might return the string
7801 .code
7802 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7803 home=/home/mg1456 shell=/bin/bash shadow=""
7804 .endd
7805 (split over two lines here to fit on the page), whereas
7806 .code
7807 [name=mg1456],passwd.org_dir:gcos
7808 .endd
7809 would just return
7810 .code
7811 Martin Guerre
7812 .endd
7813 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7814 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7815 operator is to double any quote characters within the text.
7816
7817
7818
7819 .section "SQL lookups" "SECTsql"
7820 .cindex "SQL lookup types"
7821 .cindex "MySQL" "lookup type"
7822 .cindex "PostgreSQL lookup type"
7823 .cindex "lookup" "MySQL"
7824 .cindex "lookup" "PostgreSQL"
7825 .cindex "Oracle" "lookup type"
7826 .cindex "lookup" "Oracle"
7827 .cindex "InterBase lookup type"
7828 .cindex "lookup" "InterBase"
7829 .cindex "Redis lookup type"
7830 .cindex lookup Redis
7831 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7832 and SQLite
7833 databases. Queries for these databases contain SQL statements, so an example
7834 might be
7835 .code
7836 ${lookup mysql{select mailbox from users where id='userx'}\
7837   {$value}fail}
7838 .endd
7839 If the result of the query contains more than one field, the data for each
7840 field in the row is returned, preceded by its name, so the result of
7841 .code
7842 ${lookup pgsql{select home,name from users where id='userx'}\
7843   {$value}}
7844 .endd
7845 might be
7846 .code
7847 home=/home/userx name="Mister X"
7848 .endd
7849 Empty values and values containing spaces are double quoted, with embedded
7850 quotes escaped by a backslash. If the result of the query contains just one
7851 field, the value is passed back verbatim, without a field name, for example:
7852 .code
7853 Mister X
7854 .endd
7855 If the result of the query yields more than one row, it is all concatenated,
7856 with a newline between the data for each row.
7857
7858
7859 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7860 .cindex "MySQL" "lookup type"
7861 .cindex "PostgreSQL lookup type"
7862 .cindex "lookup" "MySQL"
7863 .cindex "lookup" "PostgreSQL"
7864 .cindex "Oracle" "lookup type"
7865 .cindex "lookup" "Oracle"
7866 .cindex "InterBase lookup type"
7867 .cindex "lookup" "InterBase"
7868 .cindex "Redis lookup type"
7869 .cindex lookup Redis
7870 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7871 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7872 or &%redis_servers%&
7873 option (as appropriate) must be set to a colon-separated list of server
7874 information.
7875 (For MySQL and PostgreSQL, the global option need not be set if all
7876 queries contain their own server information &-- see section
7877 &<<SECTspeserque>>&.)
7878 For all but Redis
7879 each item in the list is a slash-separated list of four
7880 items: host name, database name, user name, and password. In the case of
7881 Oracle, the host name field is used for the &"service name"&, and the database
7882 name field is not used and should be empty. For example:
7883 .code
7884 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7885 .endd
7886 Because password data is sensitive, you should always precede the setting with
7887 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7888 option. Here is an example where two MySQL servers are listed:
7889 .code
7890 hide mysql_servers = localhost/users/root/secret:\
7891                      otherhost/users/root/othersecret
7892 .endd
7893 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7894 because this is a colon-separated list, the colon has to be doubled. For each
7895 query, these parameter groups are tried in order until a connection is made and
7896 a query is successfully processed. The result of a query may be that no data is
7897 found, but that is still a successful query. In other words, the list of
7898 servers provides a backup facility, not a list of different places to look.
7899
7900 For Redis the global option need not be specified if all queries contain their
7901 own server information &-- see section &<<SECTspeserque>>&.
7902 If specified, the option must be set to a colon-separated list of server
7903 information.
7904 Each item in the list is a slash-separated list of three items:
7905 host, database number, and password.
7906 .olist
7907 The host is required and may be either an IPv4 address and optional
7908 port number (separated by a colon, which needs doubling due to the
7909 higher-level list), or a Unix socket pathname enclosed in parentheses
7910 .next
7911 The database number is optional; if present that number is selected in the backend
7912 .next
7913 The password is optional; if present it is used to authenticate to the backend
7914 .endlist
7915
7916 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7917 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7918 respectively, and the characters single-quote, double-quote, and backslash
7919 itself are escaped with backslashes.
7920
7921 The &%quote_redis%& expansion operator
7922 escapes whitespace and backslash characters with a backslash.
7923
7924 .section "Specifying the server in the query" "SECTspeserque"
7925 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7926 it is possible to specify a list of servers with an individual query. This is
7927 done by starting the query with
7928 .display
7929 &`servers=`&&'server1:server2:server3:...'&&`;`&
7930 .endd
7931 Each item in the list may take one of two forms:
7932 .olist
7933 If it contains no slashes it is assumed to be just a host name. The appropriate
7934 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7935 of the same name, and the remaining parameters (database, user, password) are
7936 taken from there.
7937 .next
7938 If it contains any slashes, it is taken as a complete parameter set.
7939 .endlist
7940 The list of servers is used in exactly the same way as the global list.
7941 Once a connection to a server has happened and a query has been
7942 successfully executed, processing of the lookup ceases.
7943
7944 This feature is intended for use in master/slave situations where updates
7945 are occurring and you want to update the master rather than a slave. If the
7946 master is in the list as a backup for reading, you might have a global setting
7947 like this:
7948 .code
7949 mysql_servers = slave1/db/name/pw:\
7950                 slave2/db/name/pw:\
7951                 master/db/name/pw
7952 .endd
7953 In an updating lookup, you could then write:
7954 .code
7955 ${lookup mysql{servers=master; UPDATE ...} }
7956 .endd
7957 That query would then be sent only to the master server. If, on the other hand,
7958 the master is not to be used for reading, and so is not present in the global
7959 option, you can still update it by a query of this form:
7960 .code
7961 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7962 .endd
7963
7964
7965 .section "Special MySQL features" "SECID73"
7966 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7967 causes a connection to the server on the local host by means of a Unix domain
7968 socket. An alternate socket can be specified in parentheses.
7969 An option group name for MySQL option files can be specified in square brackets;
7970 the default value is &"exim"&.
7971 The full syntax of each item in &%mysql_servers%& is:
7972 .display
7973 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7974   <&'database'&>/<&'user'&>/<&'password'&>
7975 .endd
7976 Any of the four sub-parts of the first field can be omitted. For normal use on
7977 the local host it can be left blank or set to just &"localhost"&.
7978
7979 No database need be supplied &-- but if it is absent here, it must be given in
7980 the queries.
7981
7982 If a MySQL query is issued that does not request any data (an insert, update,
7983 or delete command), the result of the lookup is the number of rows affected.
7984
7985 &*Warning*&: This can be misleading. If an update does not actually change
7986 anything (for example, setting a field to the value it already has), the result
7987 is zero because no rows are affected.
7988
7989
7990 .section "Special PostgreSQL features" "SECID74"
7991 PostgreSQL lookups can also use Unix domain socket connections to the database.
7992 This is usually faster and costs less CPU time than a TCP/IP connection.
7993 However it can be used only if the mail server runs on the same machine as the
7994 database server. A configuration line for PostgreSQL via Unix domain sockets
7995 looks like this:
7996 .code
7997 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7998 .endd
7999 In other words, instead of supplying a host name, a path to the socket is
8000 given. The path name is enclosed in parentheses so that its slashes aren't
8001 visually confused with the delimiters for the other server parameters.
8002
8003 If a PostgreSQL query is issued that does not request any data (an insert,
8004 update, or delete command), the result of the lookup is the number of rows
8005 affected.
8006
8007 .section "More about SQLite" "SECTsqlite"
8008 .cindex "lookup" "SQLite"
8009 .cindex "sqlite lookup type"
8010 SQLite is different to the other SQL lookups because a filename is required in
8011 addition to the SQL query. An SQLite database is a single file, and there is no
8012 daemon as in the other SQL databases. The interface to Exim requires the name
8013 of the file, as an absolute path, to be given at the start of the query. It is
8014 separated from the query by white space. This means that the path name cannot
8015 contain white space. Here is a lookup expansion example:
8016 .code
8017 ${lookup sqlite {/some/thing/sqlitedb \
8018   select name from aliases where id='userx';}}
8019 .endd
8020 In a list, the syntax is similar. For example:
8021 .code
8022 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8023    select * from relays where ip='$sender_host_address';
8024 .endd
8025 The only character affected by the &%quote_sqlite%& operator is a single
8026 quote, which it doubles.
8027
8028 .cindex timeout SQLite
8029 .cindex sqlite "lookup timeout"
8030 The SQLite library handles multiple simultaneous accesses to the database
8031 internally. Multiple readers are permitted, but only one process can
8032 update at once. Attempts to access the database while it is being updated
8033 are rejected after a timeout period, during which the SQLite library
8034 waits for the lock to be released. In Exim, the default timeout is set
8035 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8036 option.
8037
8038 .section "More about Redis" "SECTredis"
8039 .cindex "lookup" "Redis"
8040 .cindex "redis lookup type"
8041 Redis is a non-SQL database. Commands are simple get and set.
8042 Examples:
8043 .code
8044 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8045 ${lookup redis{get keyname}}
8046 .endd
8047
8048 As of release 4.91, "lightweight" support for Redis Cluster is available.
8049 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8050 of which must be reachable from the running exim instance. If the cluster has
8051 master/slave replication, the list must contain all the master and slave
8052 servers.
8053
8054 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8055 immediately follow the redirection but treats the response as a DEFER, moving on
8056 to the next server in the &%redis_servers%& list until the correct server is
8057 reached.
8058
8059 .ecindex IIDfidalo1
8060 .ecindex IIDfidalo2
8061
8062
8063 . ////////////////////////////////////////////////////////////////////////////
8064 . ////////////////////////////////////////////////////////////////////////////
8065
8066 .chapter "Domain, host, address, and local part lists" &&&
8067          "CHAPdomhosaddlists" &&&
8068          "Domain, host, and address lists"
8069 .scindex IIDdohoadli "lists of domains; hosts; etc."
8070 A number of Exim configuration options contain lists of domains, hosts,
8071 email addresses, or local parts. For example, the &%hold_domains%& option
8072 contains a list of domains whose delivery is currently suspended. These lists
8073 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8074 arguments to expansion conditions such as &%match_domain%&.
8075
8076 Each item in one of these lists is a pattern to be matched against a domain,
8077 host, email address, or local part, respectively. In the sections below, the
8078 different types of pattern for each case are described, but first we cover some
8079 general facilities that apply to all four kinds of list.
8080
8081 Note that other parts of Exim use a &'string list'& which does not
8082 support all the complexity available in
8083 domain, host, address and local part lists.
8084
8085
8086
8087 .section "Expansion of lists" "SECTlistexpand"
8088 .cindex "expansion" "of lists"
8089 Each list is expanded as a single string before it is used.
8090
8091 &'Exception: the router headers_remove option, where list-item
8092 splitting is done before string-expansion.'&
8093
8094 The result of
8095 expansion must be a list, possibly containing empty items, which is split up
8096 into separate items for matching. By default, colon is the separator character,
8097 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8098 &<<SECTempitelis>>& for details of the list syntax; the second of these
8099 discusses the way to specify empty list items.
8100
8101
8102 If the string expansion is forced to fail, Exim behaves as if the item it is
8103 testing (domain, host, address, or local part) is not in the list. Other
8104 expansion failures cause temporary errors.
8105
8106 If an item in a list is a regular expression, backslashes, dollars and possibly
8107 other special characters in the expression must be protected against
8108 misinterpretation by the string expander. The easiest way to do this is to use
8109 the &`\N`& expansion feature to indicate that the contents of the regular
8110 expression should not be expanded. For example, in an ACL you might have:
8111 .code
8112 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8113                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8114 .endd
8115 The first item is a regular expression that is protected from expansion by
8116 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8117 senders based on the receiving domain.
8118
8119
8120
8121
8122 .section "Negated items in lists" "SECID76"
8123 .cindex "list" "negation"
8124 .cindex "negation" "in lists"
8125 Items in a list may be positive or negative. Negative items are indicated by a
8126 leading exclamation mark, which may be followed by optional white space. A list
8127 defines a set of items (domains, etc). When Exim processes one of these lists,
8128 it is trying to find out whether a domain, host, address, or local part
8129 (respectively) is in the set that is defined by the list. It works like this:
8130
8131 The list is scanned from left to right. If a positive item is matched, the
8132 subject that is being checked is in the set; if a negative item is matched, the
8133 subject is not in the set. If the end of the list is reached without the
8134 subject having matched any of the patterns, it is in the set if the last item
8135 was a negative one, but not if it was a positive one. For example, the list in
8136 .code
8137 domainlist relay_to_domains = !a.b.c : *.b.c
8138 .endd
8139 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8140 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8141 list is positive. However, if the setting were
8142 .code
8143 domainlist relay_to_domains = !a.b.c
8144 .endd
8145 then all domains other than &'a.b.c'& would match because the last item in the
8146 list is negative. In other words, a list that ends with a negative item behaves
8147 as if it had an extra item &`:*`& on the end.
8148
8149 Another way of thinking about positive and negative items in lists is to read
8150 the connector as &"or"& after a positive item and as &"and"& after a negative
8151 item.
8152
8153
8154
8155 .section "File names in lists" "SECTfilnamlis"
8156 .cindex "list" "filename in"
8157 If an item in a domain, host, address, or local part list is an absolute
8158 filename (beginning with a slash character), each line of the file is read and
8159 processed as if it were an independent item in the list, except that further
8160 filenames are not allowed,
8161 and no expansion of the data from the file takes place.
8162 Empty lines in the file are ignored, and the file may also contain comment
8163 lines:
8164
8165 .ilist
8166 For domain and host lists, if a # character appears anywhere in a line of the
8167 file, it and all following characters are ignored.
8168 .next
8169 Because local parts may legitimately contain # characters, a comment in an
8170 address list or local part list file is recognized only if # is preceded by
8171 white space or the start of the line. For example:
8172 .code
8173 not#comment@x.y.z   # but this is a comment
8174 .endd
8175 .endlist
8176
8177 Putting a filename in a list has the same effect as inserting each line of the
8178 file as an item in the list (blank lines and comments excepted). However, there
8179 is one important difference: the file is read each time the list is processed,
8180 so if its contents vary over time, Exim's behaviour changes.
8181
8182 If a filename is preceded by an exclamation mark, the sense of any match
8183 within the file is inverted. For example, if
8184 .code
8185 hold_domains = !/etc/nohold-domains
8186 .endd
8187 and the file contains the lines
8188 .code
8189 !a.b.c
8190 *.b.c
8191 .endd
8192 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8193 any domain matching &`*.b.c`& is not.
8194
8195
8196
8197 .section "An lsearch file is not an out-of-line list" "SECID77"
8198 As will be described in the sections that follow, lookups can be used in lists
8199 to provide indexed methods of checking list membership. There has been some
8200 confusion about the way &(lsearch)& lookups work in lists. Because
8201 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8202 sometimes thought that it is allowed to contain wild cards and other kinds of
8203 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8204 always fixed strings, just as for any other single-key lookup type.
8205
8206 If you want to use a file to contain wild-card patterns that form part of a
8207 list, just give the filename on its own, without a search type, as described
8208 in the previous section. You could also use the &(wildlsearch)& or
8209 &(nwildlsearch)&, but there is no advantage in doing this.
8210
8211
8212
8213
8214 .section "Named lists" "SECTnamedlists"
8215 .cindex "named lists"
8216 .cindex "list" "named"
8217 A list of domains, hosts, email addresses, or local parts can be given a name
8218 which is then used to refer to the list elsewhere in the configuration. This is
8219 particularly convenient if the same list is required in several different
8220 places. It also allows lists to be given meaningful names, which can improve
8221 the readability of the configuration. For example, it is conventional to define
8222 a domain list called &'local_domains'& for all the domains that are handled
8223 locally on a host, using a configuration line such as
8224 .code
8225 domainlist local_domains = localhost:my.dom.example
8226 .endd
8227 Named lists are referenced by giving their name preceded by a plus sign, so,
8228 for example, a router that is intended to handle local domains would be
8229 configured with the line
8230 .code
8231 domains = +local_domains
8232 .endd
8233 The first router in a configuration is often one that handles all domains
8234 except the local ones, using a configuration with a negated item like this:
8235 .code
8236 dnslookup:
8237   driver = dnslookup
8238   domains = ! +local_domains
8239   transport = remote_smtp
8240   no_more
8241 .endd
8242 The four kinds of named list are created by configuration lines starting with
8243 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8244 respectively. Then there follows the name that you are defining, followed by an
8245 equals sign and the list itself. For example:
8246 .code
8247 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8248 addresslist bad_senders = cdb;/etc/badsenders
8249 .endd
8250 A named list may refer to other named lists:
8251 .code
8252 domainlist  dom1 = first.example : second.example
8253 domainlist  dom2 = +dom1 : third.example
8254 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8255 .endd
8256 &*Warning*&: If the last item in a referenced list is a negative one, the
8257 effect may not be what you intended, because the negation does not propagate
8258 out to the higher level. For example, consider:
8259 .code
8260 domainlist  dom1 = !a.b
8261 domainlist  dom2 = +dom1 : *.b
8262 .endd
8263 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8264 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8265 means it matches the second list as well. The effect is not the same as
8266 .code
8267 domainlist  dom2 = !a.b : *.b
8268 .endd
8269 where &'x.y'& does not match. It's best to avoid negation altogether in
8270 referenced lists if you can.
8271
8272 Named lists may have a performance advantage. When Exim is routing an
8273 address or checking an incoming message, it caches the result of tests on named
8274 lists. So, if you have a setting such as
8275 .code
8276 domains = +local_domains
8277 .endd
8278 on several of your routers
8279 or in several ACL statements,
8280 the actual test is done only for the first one. However, the caching works only
8281 if there are no expansions within the list itself or any sublists that it
8282 references. In other words, caching happens only for lists that are known to be
8283 the same each time they are referenced.
8284
8285 By default, there may be up to 16 named lists of each type. This limit can be
8286 extended by changing a compile-time variable. The use of domain and host lists
8287 is recommended for concepts such as local domains, relay domains, and relay
8288 hosts. The default configuration is set up like this.
8289
8290
8291
8292 .section "Named lists compared with macros" "SECID78"
8293 .cindex "list" "named compared with macro"
8294 .cindex "macro" "compared with named list"
8295 At first sight, named lists might seem to be no different from macros in the
8296 configuration file. However, macros are just textual substitutions. If you
8297 write
8298 .code
8299 ALIST = host1 : host2
8300 auth_advertise_hosts = !ALIST
8301 .endd
8302 it probably won't do what you want, because that is exactly the same as
8303 .code
8304 auth_advertise_hosts = !host1 : host2
8305 .endd
8306 Notice that the second host name is not negated. However, if you use a host
8307 list, and write
8308 .code
8309 hostlist alist = host1 : host2
8310 auth_advertise_hosts = ! +alist
8311 .endd
8312 the negation applies to the whole list, and so that is equivalent to
8313 .code
8314 auth_advertise_hosts = !host1 : !host2
8315 .endd
8316
8317
8318 .section "Named list caching" "SECID79"
8319 .cindex "list" "caching of named"
8320 .cindex "caching" "named lists"
8321 While processing a message, Exim caches the result of checking a named list if
8322 it is sure that the list is the same each time. In practice, this means that
8323 the cache operates only if the list contains no $ characters, which guarantees
8324 that it will not change when it is expanded. Sometimes, however, you may have
8325 an expanded list that you know will be the same each time within a given
8326 message. For example:
8327 .code
8328 domainlist special_domains = \
8329            ${lookup{$sender_host_address}cdb{/some/file}}
8330 .endd
8331 This provides a list of domains that depends only on the sending host's IP
8332 address. If this domain list is referenced a number of times (for example,
8333 in several ACL lines, or in several routers) the result of the check is not
8334 cached by default, because Exim does not know that it is going to be the
8335 same list each time.
8336
8337 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8338 cache the result anyway. For example:
8339 .code
8340 domainlist_cache special_domains = ${lookup{...
8341 .endd
8342 If you do this, you should be absolutely sure that caching is going to do
8343 the right thing in all cases. When in doubt, leave it out.
8344
8345
8346
8347 .section "Domain lists" "SECTdomainlist"
8348 .cindex "domain list" "patterns for"
8349 .cindex "list" "domain list"
8350 Domain lists contain patterns that are to be matched against a mail domain.
8351 The following types of item may appear in domain lists:
8352
8353 .ilist
8354 .cindex "primary host name"
8355 .cindex "host name" "matched in domain list"
8356 .oindex "&%primary_hostname%&"
8357 .cindex "domain list" "matching primary host name"
8358 .cindex "@ in a domain list"
8359 If a pattern consists of a single @ character, it matches the local host name,
8360 as set by the &%primary_hostname%& option (or defaulted). This makes it
8361 possible to use the same configuration file on several different hosts that
8362 differ only in their names.
8363 .next
8364 .cindex "@[] in a domain list"
8365 .cindex "domain list" "matching local IP interfaces"
8366 .cindex "domain literal"
8367 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8368 in square brackets (as in an email address that contains a domain literal), but
8369 only if that IP address is recognized as local for email routing purposes. The
8370 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8371 control which of a host's several IP addresses are treated as local.
8372 In today's Internet, the use of domain literals is controversial.
8373 .next
8374 .cindex "@mx_any"
8375 .cindex "@mx_primary"
8376 .cindex "@mx_secondary"
8377 .cindex "domain list" "matching MX pointers to local host"
8378 If a pattern consists of the string &`@mx_any`& it matches any domain that
8379 has an MX record pointing to the local host or to any host that is listed in
8380 .oindex "&%hosts_treat_as_local%&"
8381 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8382 are similar, except that the first matches only when a primary MX target is the
8383 local host, and the second only when no primary MX target is the local host,
8384 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8385 preference value &-- there may of course be more than one of them.
8386
8387 The MX lookup that takes place when matching a pattern of this type is
8388 performed with the resolver options for widening names turned off. Thus, for
8389 example, a single-component domain will &'not'& be expanded by adding the
8390 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8391 options of the &(dnslookup)& router for a discussion of domain widening.
8392
8393 Sometimes you may want to ignore certain IP addresses when using one of these
8394 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8395 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8396 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8397 on a router). For example:
8398 .code
8399 domains = @mx_any/ignore=127.0.0.1
8400 .endd
8401 This example matches any domain that has an MX record pointing to one of
8402 the local host's IP addresses other than 127.0.0.1.
8403
8404 The list of IP addresses is in fact processed by the same code that processes
8405 host lists, so it may contain CIDR-coded network specifications and it may also
8406 contain negative items.
8407
8408 Because the list of IP addresses is a sublist within a domain list, you have to
8409 be careful about delimiters if there is more than one address. Like any other
8410 list, the default delimiter can be changed. Thus, you might have:
8411 .code
8412 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8413           an.other.domain : ...
8414 .endd
8415 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8416 involved, it is easiest to change the delimiter for the main list as well:
8417 .code
8418 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8419           an.other.domain ? ...
8420 .endd
8421 .next
8422 .cindex "asterisk" "in domain list"
8423 .cindex "domain list" "asterisk in"
8424 .cindex "domain list" "matching &""ends with""&"
8425 If a pattern starts with an asterisk, the remaining characters of the pattern
8426 are compared with the terminating characters of the domain. The use of &"*"& in
8427 domain lists differs from its use in partial matching lookups. In a domain
8428 list, the character following the asterisk need not be a dot, whereas partial
8429 matching works only in terms of dot-separated components. For example, a domain
8430 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8431 &'cipher.key.ex'&.
8432
8433 .next
8434 .cindex "regular expressions" "in domain list"
8435 .cindex "domain list" "matching regular expression"
8436 If a pattern starts with a circumflex character, it is treated as a regular
8437 expression, and matched against the domain using a regular expression matching
8438 function. The circumflex is treated as part of the regular expression.
8439 Email domains are case-independent, so this regular expression match is by
8440 default case-independent, but you can make it case-dependent by starting it
8441 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8442 are given in chapter &<<CHAPregexp>>&.
8443
8444 &*Warning*&: Because domain lists are expanded before being processed, you
8445 must escape any backslash and dollar characters in the regular expression, or
8446 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8447 it is not to be expanded (unless you really do want to build a regular
8448 expression by expansion, of course).
8449 .next
8450 .cindex "lookup" "in domain list"
8451 .cindex "domain list" "matching by lookup"
8452 If a pattern starts with the name of a single-key lookup type followed by a
8453 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8454 must be a filename in a suitable format for the lookup type. For example, for
8455 &"cdb;"& it must be an absolute path:
8456 .code
8457 domains = cdb;/etc/mail/local_domains.cdb
8458 .endd
8459 The appropriate type of lookup is done on the file using the domain name as the
8460 key. In most cases, the data that is looked up is not used; Exim is interested
8461 only in whether or not the key is present in the file. However, when a lookup
8462 is used for the &%domains%& option on a router
8463 or a &%domains%& condition in an ACL statement, the data is preserved in the
8464 &$domain_data$& variable and can be referred to in other router options or
8465 other statements in the same ACL.
8466
8467 .next
8468 Any of the single-key lookup type names may be preceded by
8469 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8470 .code
8471 domains = partial-dbm;/partial/domains
8472 .endd
8473 This causes partial matching logic to be invoked; a description of how this
8474 works is given in section &<<SECTpartiallookup>>&.
8475
8476 .next
8477 .cindex "asterisk" "in lookup type"
8478 Any of the single-key lookup types may be followed by an asterisk. This causes
8479 a default lookup for a key consisting of a single asterisk to be done if the
8480 original lookup fails. This is not a useful feature when using a domain list to
8481 select particular domains (because any domain would match), but it might have
8482 value if the result of the lookup is being used via the &$domain_data$&
8483 expansion variable.
8484 .next
8485 If the pattern starts with the name of a query-style lookup type followed by a
8486 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8487 pattern must be an appropriate query for the lookup type, as described in
8488 chapter &<<CHAPfdlookup>>&. For example:
8489 .code
8490 hold_domains = mysql;select domain from holdlist \
8491   where domain = '${quote_mysql:$domain}';
8492 .endd
8493 In most cases, the data that is looked up is not used (so for an SQL query, for
8494 example, it doesn't matter what field you select). Exim is interested only in
8495 whether or not the query succeeds. However, when a lookup is used for the
8496 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8497 variable and can be referred to in other options.
8498 .next
8499 .cindex "domain list" "matching literal domain name"
8500 If none of the above cases apply, a caseless textual comparison is made
8501 between the pattern and the domain.
8502 .endlist
8503
8504 Here is an example that uses several different kinds of pattern:
8505 .code
8506 domainlist funny_domains = \
8507   @ : \
8508   lib.unseen.edu : \
8509   *.foundation.fict.example : \
8510   \N^[1-2]\d{3}\.fict\.example$\N : \
8511   partial-dbm;/opt/data/penguin/book : \
8512   nis;domains.byname : \
8513   nisplus;[name=$domain,status=local],domains.org_dir
8514 .endd
8515 There are obvious processing trade-offs among the various matching modes. Using
8516 an asterisk is faster than a regular expression, and listing a few names
8517 explicitly probably is too. The use of a file or database lookup is expensive,
8518 but may be the only option if hundreds of names are required. Because the
8519 patterns are tested in order, it makes sense to put the most commonly matched
8520 patterns earlier.
8521
8522
8523
8524 .section "Host lists" "SECThostlist"
8525 .cindex "host list" "patterns in"
8526 .cindex "list" "host list"
8527 Host lists are used to control what remote hosts are allowed to do. For
8528 example, some hosts may be allowed to use the local host as a relay, and some
8529 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8530 two different ways, by name or by IP address. In a host list, some types of
8531 pattern are matched to a host name, and some are matched to an IP address.
8532 You need to be particularly careful with this when single-key lookups are
8533 involved, to ensure that the right value is being used as the key.
8534
8535
8536 .section "Special host list patterns" "SECID80"
8537 .cindex "empty item in hosts list"
8538 .cindex "host list" "empty string in"
8539 If a host list item is the empty string, it matches only when no remote host is
8540 involved. This is the case when a message is being received from a local
8541 process using SMTP on the standard input, that is, when a TCP/IP connection is
8542 not used.
8543
8544 .cindex "asterisk" "in host list"
8545 The special pattern &"*"& in a host list matches any host or no host. Neither
8546 the IP address nor the name is actually inspected.
8547
8548
8549
8550 .section "Host list patterns that match by IP address" "SECThoslispatip"
8551 .cindex "host list" "matching IP addresses"
8552 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8553 the incoming address actually appears in the IPv6 host as
8554 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8555 list, it is converted into a traditional IPv4 address first. (Not all operating
8556 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8557 concerns.)
8558
8559 The following types of pattern in a host list check the remote host by
8560 inspecting its IP address:
8561
8562 .ilist
8563 If the pattern is a plain domain name (not a regular expression, not starting
8564 with *, not a lookup of any kind), Exim calls the operating system function
8565 to find the associated IP address(es). Exim uses the newer
8566 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8567 This typically causes a forward DNS lookup of the name. The result is compared
8568 with the IP address of the subject host.
8569
8570 If there is a temporary problem (such as a DNS timeout) with the host name
8571 lookup, a temporary error occurs. For example, if the list is being used in an
8572 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8573 temporary SMTP error code. If no IP address can be found for the host name,
8574 what happens is described in section &<<SECTbehipnot>>& below.
8575
8576 .next
8577 .cindex "@ in a host list"
8578 If the pattern is &"@"&, the primary host name is substituted and used as a
8579 domain name, as just described.
8580
8581 .next
8582 If the pattern is an IP address, it is matched against the IP address of the
8583 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8584 IPv6 addresses can be given in colon-separated format, but the colons have to
8585 be doubled so as not to be taken as item separators when the default list
8586 separator is used. IPv6 addresses are recognized even when Exim is compiled
8587 without IPv6 support. This means that if they appear in a host list on an
8588 IPv4-only host, Exim will not treat them as host names. They are just addresses
8589 that can never match a client host.
8590
8591 .next
8592 .cindex "@[] in a host list"
8593 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8594 the local host. For example, if the local host is an IPv4 host with one
8595 interface address 10.45.23.56, these two ACL statements have the same effect:
8596 .code
8597 accept hosts = 127.0.0.1 : 10.45.23.56
8598 accept hosts = @[]
8599 .endd
8600 .next
8601 .cindex "CIDR notation"
8602 If the pattern is an IP address followed by a slash and a mask length (for
8603 example 10.11.42.0/24), it is matched against the IP address of the subject
8604 host under the given mask. This allows, an entire network of hosts to be
8605 included (or excluded) by a single item. The mask uses CIDR notation; it
8606 specifies the number of address bits that must match, starting from the most
8607 significant end of the address.
8608
8609 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8610 of a range of addresses. It is the number of bits in the network portion of the
8611 address. The above example specifies a 24-bit netmask, so it matches all 256
8612 addresses in the 10.11.42.0 network. An item such as
8613 .code
8614 192.168.23.236/31
8615 .endd
8616 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8617 32 for an IPv4 address is the same as no mask at all; just a single address
8618 matches.
8619
8620 Here is another example which shows an IPv4 and an IPv6 network:
8621 .code
8622 recipient_unqualified_hosts = 192.168.0.0/16: \
8623                               3ffe::ffff::836f::::/48
8624 .endd
8625 The doubling of list separator characters applies only when these items
8626 appear inline in a host list. It is not required when indirecting via a file.
8627 For example:
8628 .code
8629 recipient_unqualified_hosts = /opt/exim/unqualnets
8630 .endd
8631 could make use of a file containing
8632 .code
8633 172.16.0.0/12
8634 3ffe:ffff:836f::/48
8635 .endd
8636 to have exactly the same effect as the previous example. When listing IPv6
8637 addresses inline, it is usually more convenient to use the facility for
8638 changing separator characters. This list contains the same two networks:
8639 .code
8640 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8641                                  3ffe:ffff:836f::/48
8642 .endd
8643 The separator is changed to semicolon by the leading &"<;"& at the start of the
8644 list.
8645 .endlist
8646
8647
8648
8649 .section "Host list patterns for single-key lookups by host address" &&&
8650          "SECThoslispatsikey"
8651 .cindex "host list" "lookup of IP address"
8652 When a host is to be identified by a single-key lookup of its complete IP
8653 address, the pattern takes this form:
8654 .display
8655 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8656 .endd
8657 For example:
8658 .code
8659 hosts_lookup = net-cdb;/hosts-by-ip.db
8660 .endd
8661 The text form of the IP address of the subject host is used as the lookup key.
8662 IPv6 addresses are converted to an unabbreviated form, using lower case
8663 letters, with dots as separators because colon is the key terminator in
8664 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8665 quoting the keys, but this is a facility that was added later.] The data
8666 returned by the lookup is not used.
8667
8668 .cindex "IP address" "masking"
8669 .cindex "host list" "masked IP address"
8670 Single-key lookups can also be performed using masked IP addresses, using
8671 patterns of this form:
8672 .display
8673 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8674 .endd
8675 For example:
8676 .code
8677 net24-dbm;/networks.db
8678 .endd
8679 The IP address of the subject host is masked using <&'number'&> as the mask
8680 length. A textual string is constructed from the masked value, followed by the
8681 mask, and this is used as the lookup key. For example, if the host's IP address
8682 is 192.168.34.6, the key that is looked up for the above example is
8683 &"192.168.34.0/24"&.
8684
8685 When an IPv6 address is converted to a string, dots are normally used instead
8686 of colons, so that keys in &(lsearch)& files need not contain colons (which
8687 terminate &(lsearch)& keys). This was implemented some time before the ability
8688 to quote keys was made available in &(lsearch)& files. However, the more
8689 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8690 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8691 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8692 converted using colons and not dots.
8693 .new
8694 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8695 addresses are always used.
8696 The latter are converted to IPv4 addresses, in dotted-quad form.
8697 .wen
8698
8699 Ideally, it would be nice to tidy up this anomalous situation by changing to
8700 colons in all cases, given that quoting is now available for &(lsearch)&.
8701 However, this would be an incompatible change that might break some existing
8702 configurations.
8703
8704 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8705 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8706 the former case the key strings include the mask value, whereas in the latter
8707 case the IP address is used on its own.
8708
8709
8710
8711 .section "Host list patterns that match by host name" "SECThoslispatnam"
8712 .cindex "host" "lookup failures"
8713 .cindex "unknown host name"
8714 .cindex "host list" "matching host name"
8715 There are several types of pattern that require Exim to know the name of the
8716 remote host. These are either wildcard patterns or lookups by name. (If a
8717 complete hostname is given without any wildcarding, it is used to find an IP
8718 address to match against, as described in section &<<SECThoslispatip>>&
8719 above.)
8720
8721 If the remote host name is not already known when Exim encounters one of these
8722 patterns, it has to be found from the IP address.
8723 Although many sites on the Internet are conscientious about maintaining reverse
8724 DNS data for their hosts, there are also many that do not do this.
8725 Consequently, a name cannot always be found, and this may lead to unwanted
8726 effects. Take care when configuring host lists with wildcarded name patterns.
8727 Consider what will happen if a name cannot be found.
8728
8729 Because of the problems of determining host names from IP addresses, matching
8730 against host names is not as common as matching against IP addresses.
8731
8732 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8733 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8734 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8735 are done can be changed by setting the &%host_lookup_order%& option. For
8736 security, once Exim has found one or more names, it looks up the IP addresses
8737 for these names and compares them with the IP address that it started with.
8738 Only those names whose IP addresses match are accepted. Any other names are
8739 discarded. If no names are left, Exim behaves as if the host name cannot be
8740 found. In the most common case there is only one name and one IP address.
8741
8742 There are some options that control what happens if a host name cannot be
8743 found. These are described in section &<<SECTbehipnot>>& below.
8744
8745 .cindex "host" "alias for"
8746 .cindex "alias for host"
8747 As a result of aliasing, hosts may have more than one name. When processing any
8748 of the following types of pattern, all the host's names are checked:
8749
8750 .ilist
8751 .cindex "asterisk" "in host list"
8752 If a pattern starts with &"*"& the remainder of the item must match the end of
8753 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8754 &'.b.c'&. This special simple form is provided because this is a very common
8755 requirement. Other kinds of wildcarding require the use of a regular
8756 expression.
8757 .next
8758 .cindex "regular expressions" "in host list"
8759 .cindex "host list" "regular expression in"
8760 If the item starts with &"^"& it is taken to be a regular expression which is
8761 matched against the host name. Host names are case-independent, so this regular
8762 expression match is by default case-independent, but you can make it
8763 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8764 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8765 example,
8766 .code
8767 ^(a|b)\.c\.d$
8768 .endd
8769 is a regular expression that matches either of the two hosts &'a.c.d'& or
8770 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8771 that backslash and dollar characters are not misinterpreted as part of the
8772 string expansion. The simplest way to do this is to use &`\N`& to mark that
8773 part of the string as non-expandable. For example:
8774 .code
8775 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8776 .endd
8777 &*Warning*&: If you want to match a complete host name, you must include the
8778 &`$`& terminating metacharacter in the regular expression, as in the above
8779 example. Without it, a match at the start of the host name is all that is
8780 required.
8781 .endlist
8782
8783
8784
8785
8786 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8787 .cindex "host" "lookup failures, permanent"
8788 While processing a host list, Exim may need to look up an IP address from a
8789 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8790 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8791 behaviour when it fails to find the information it is seeking is the same.
8792
8793 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8794 apply to temporary DNS errors, whose handling is described in the next section.
8795
8796 .cindex "&`+include_unknown`&"
8797 .cindex "&`+ignore_unknown`&"
8798 Exim parses a host list from left to right. If it encounters a permanent
8799 lookup failure in any item in the host list before it has found a match,
8800 Exim treats it as a failure and the default behavior is as if the host
8801 does not match the list. This may not always be what you want to happen.
8802 To change Exim's behaviour, the special items &`+include_unknown`& or
8803 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8804 not recognized in an indirected file).
8805
8806 .ilist
8807 If any item that follows &`+include_unknown`& requires information that
8808 cannot found, Exim behaves as if the host does match the list. For example,
8809 .code
8810 host_reject_connection = +include_unknown:*.enemy.ex
8811 .endd
8812 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8813 any hosts whose name it cannot find.
8814
8815 .next
8816 If any item that follows &`+ignore_unknown`& requires information that cannot
8817 be found, Exim ignores that item and proceeds to the rest of the list. For
8818 example:
8819 .code
8820 accept hosts = +ignore_unknown : friend.example : \
8821                192.168.4.5
8822 .endd
8823 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8824 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8825 name can be found for 192.168.4.5, it is rejected.
8826 .endlist
8827
8828 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8829 list. The effect of each one lasts until the next, or until the end of the
8830 list.
8831
8832 .section "Mixing wildcarded host names and addresses in host lists" &&&
8833          "SECTmixwilhos"
8834 .cindex "host list" "mixing names and addresses in"
8835
8836 This section explains the host/ip processing logic with the same concepts
8837 as the previous section, but specifically addresses what happens when a
8838 wildcarded hostname is one of the items in the hostlist.
8839
8840 .ilist
8841 If you have name lookups or wildcarded host names and
8842 IP addresses in the same host list, you should normally put the IP
8843 addresses first. For example, in an ACL you could have:
8844 .code
8845 accept hosts = 10.9.8.7 : *.friend.example
8846 .endd
8847 The reason you normally would order it this way lies in the
8848 left-to-right way that Exim processes lists.  It can test IP addresses
8849 without doing any DNS lookups, but when it reaches an item that requires
8850 a host name, it fails if it cannot find a host name to compare with the
8851 pattern. If the above list is given in the opposite order, the
8852 &%accept%& statement fails for a host whose name cannot be found, even
8853 if its IP address is 10.9.8.7.
8854
8855 .next
8856 If you really do want to do the name check first, and still recognize the IP
8857 address, you can rewrite the ACL like this:
8858 .code
8859 accept hosts = *.friend.example
8860 accept hosts = 10.9.8.7
8861 .endd
8862 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8863 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8864 &`+ignore_unknown`&, which was discussed in depth in the first example in
8865 this section.
8866 .endlist
8867
8868
8869 .section "Temporary DNS errors when looking up host information" &&&
8870          "SECTtemdnserr"
8871 .cindex "host" "lookup failures, temporary"
8872 .cindex "&`+include_defer`&"
8873 .cindex "&`+ignore_defer`&"
8874 A temporary DNS lookup failure normally causes a defer action (except when
8875 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8876 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8877 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8878 section. These options should be used with care, probably only in non-critical
8879 host lists such as whitelists.
8880
8881
8882
8883 .section "Host list patterns for single-key lookups by host name" &&&
8884          "SECThoslispatnamsk"
8885 .cindex "unknown host name"
8886 .cindex "host list" "matching host name"
8887 If a pattern is of the form
8888 .display
8889 <&'single-key-search-type'&>;<&'search-data'&>
8890 .endd
8891 for example
8892 .code
8893 dbm;/host/accept/list
8894 .endd
8895 a single-key lookup is performed, using the host name as its key. If the
8896 lookup succeeds, the host matches the item. The actual data that is looked up
8897 is not used.
8898
8899 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8900 keys in the file, not IP addresses. If you want to do lookups based on IP
8901 addresses, you must precede the search type with &"net-"& (see section
8902 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8903 two items in the same list, one doing an address lookup and one doing a name
8904 lookup, both using the same file.
8905
8906
8907
8908 .section "Host list patterns for query-style lookups" "SECID81"
8909 If a pattern is of the form
8910 .display
8911 <&'query-style-search-type'&>;<&'query'&>
8912 .endd
8913 the query is obeyed, and if it succeeds, the host matches the item. The actual
8914 data that is looked up is not used. The variables &$sender_host_address$& and
8915 &$sender_host_name$& can be used in the query. For example:
8916 .code
8917 hosts_lookup = pgsql;\
8918   select ip from hostlist where ip='$sender_host_address'
8919 .endd
8920 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8921 can use the &%sg%& expansion item to change this if you need to. If you want to
8922 use masked IP addresses in database queries, you can use the &%mask%& expansion
8923 operator.
8924
8925 If the query contains a reference to &$sender_host_name$&, Exim automatically
8926 looks up the host name if it has not already done so. (See section
8927 &<<SECThoslispatnam>>& for comments on finding host names.)
8928
8929 Historical note: prior to release 4.30, Exim would always attempt to find a
8930 host name before running the query, unless the search type was preceded by
8931 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8932 still recognized for query-style lookups, but its presence or absence has no
8933 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8934 See section &<<SECThoslispatsikey>>&.)
8935
8936
8937
8938
8939
8940 .section "Address lists" "SECTaddresslist"
8941 .cindex "list" "address list"
8942 .cindex "address list" "empty item"
8943 .cindex "address list" "patterns"
8944 Address lists contain patterns that are matched against mail addresses. There
8945 is one special case to be considered: the sender address of a bounce message is
8946 always empty. You can test for this by providing an empty item in an address
8947 list. For example, you can set up a router to process bounce messages by
8948 using this option setting:
8949 .code
8950 senders = :
8951 .endd
8952 The presence of the colon creates an empty item. If you do not provide any
8953 data, the list is empty and matches nothing. The empty sender can also be
8954 detected by a regular expression that matches an empty string,
8955 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8956
8957 Non-empty items in an address list can be straightforward email addresses. For
8958 example:
8959 .code
8960 senders = jbc@askone.example : hs@anacreon.example
8961 .endd
8962 A certain amount of wildcarding is permitted. If a pattern contains an @
8963 character, but is not a regular expression and does not begin with a
8964 semicolon-terminated lookup type (described below), the local part of the
8965 subject address is compared with the local part of the pattern, which may start
8966 with an asterisk. If the local parts match, the domain is checked in exactly
8967 the same way as for a pattern in a domain list. For example, the domain can be
8968 wildcarded, refer to a named list, or be a lookup:
8969 .code
8970 deny senders = *@*.spamming.site:\
8971                *@+hostile_domains:\
8972                bozo@partial-lsearch;/list/of/dodgy/sites:\
8973                *@dbm;/bad/domains.db
8974 .endd
8975 .cindex "local part" "starting with !"
8976 .cindex "address list" "local part starting with !"
8977 If a local part that begins with an exclamation mark is required, it has to be
8978 specified using a regular expression, because otherwise the exclamation mark is
8979 treated as a sign of negation, as is standard in lists.
8980
8981 If a non-empty pattern that is not a regular expression or a lookup does not
8982 contain an @ character, it is matched against the domain part of the subject
8983 address. The only two formats that are recognized this way are a literal
8984 domain, or a domain pattern that starts with *. In both these cases, the effect
8985 is the same as if &`*@`& preceded the pattern. For example:
8986 .code
8987 deny senders = enemy.domain : *.enemy.domain
8988 .endd
8989
8990 The following kinds of more complicated address list pattern can match any
8991 address, including the empty address that is characteristic of bounce message
8992 senders:
8993
8994 .ilist
8995 .cindex "regular expressions" "in address list"
8996 .cindex "address list" "regular expression in"
8997 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8998 done against the complete address, with the pattern as the regular expression.
8999 You must take care that backslash and dollar characters are not misinterpreted
9000 as part of the string expansion. The simplest way to do this is to use &`\N`&
9001 to mark that part of the string as non-expandable. For example:
9002 .code
9003 deny senders = \N^.*this.*@example\.com$\N : \
9004                \N^\d{8}.+@spamhaus.example$\N : ...
9005 .endd
9006 The &`\N`& sequences are removed by the expansion, so these items do indeed
9007 start with &"^"& by the time they are being interpreted as address patterns.
9008
9009 .next
9010 .cindex "address list" "lookup for complete address"
9011 Complete addresses can be looked up by using a pattern that starts with a
9012 lookup type terminated by a semicolon, followed by the data for the lookup. For
9013 example:
9014 .code
9015 deny senders = cdb;/etc/blocked.senders : \
9016   mysql;select address from blocked where \
9017   address='${quote_mysql:$sender_address}'
9018 .endd
9019 Both query-style and single-key lookup types can be used. For a single-key
9020 lookup type, Exim uses the complete address as the key. However, empty keys are
9021 not supported for single-key lookups, so a match against the empty address
9022 always fails. This restriction does not apply to query-style lookups.
9023
9024 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9025 cannot be used, and is ignored if specified, with an entry being written to the
9026 panic log.
9027 .cindex "*@ with single-key lookup"
9028 However, you can configure lookup defaults, as described in section
9029 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9030 default. For example, with this lookup:
9031 .code
9032 accept senders = lsearch*@;/some/file
9033 .endd
9034 the file could contains lines like this:
9035 .code
9036 user1@domain1.example
9037 *@domain2.example
9038 .endd
9039 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9040 that are tried is:
9041 .code
9042 nimrod@jaeger.example
9043 *@jaeger.example
9044 *
9045 .endd
9046 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9047 would mean that every address matches, thus rendering the test useless.
9048
9049 &*Warning 2*&: Do not confuse these two kinds of item:
9050 .code
9051 deny recipients = dbm*@;/some/file
9052 deny recipients = *@dbm;/some/file
9053 .endd
9054 The first does a whole address lookup, with defaulting, as just described,
9055 because it starts with a lookup type. The second matches the local part and
9056 domain independently, as described in a bullet point below.
9057 .endlist
9058
9059
9060 The following kinds of address list pattern can match only non-empty addresses.
9061 If the subject address is empty, a match against any of these pattern types
9062 always fails.
9063
9064
9065 .ilist
9066 .cindex "@@ with single-key lookup"
9067 .cindex "address list" "@@ lookup type"
9068 .cindex "address list" "split local part and domain"
9069 If a pattern starts with &"@@"& followed by a single-key lookup item
9070 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9071 split into a local part and a domain. The domain is looked up in the file. If
9072 it is not found, there is no match. If it is found, the data that is looked up
9073 from the file is treated as a colon-separated list of local part patterns, each
9074 of which is matched against the subject local part in turn.
9075
9076 .cindex "asterisk" "in address list"
9077 The lookup may be a partial one, and/or one involving a search for a default
9078 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9079 patterns that are looked up can be regular expressions or begin with &"*"&, or
9080 even be further lookups. They may also be independently negated. For example,
9081 with
9082 .code
9083 deny senders = @@dbm;/etc/reject-by-domain
9084 .endd
9085 the data from which the DBM file is built could contain lines like
9086 .code
9087 baddomain.com:  !postmaster : *
9088 .endd
9089 to reject all senders except &%postmaster%& from that domain.
9090
9091 .cindex "local part" "starting with !"
9092 If a local part that actually begins with an exclamation mark is required, it
9093 has to be specified using a regular expression. In &(lsearch)& files, an entry
9094 may be split over several lines by indenting the second and subsequent lines,
9095 but the separating colon must still be included at line breaks. White space
9096 surrounding the colons is ignored. For example:
9097 .code
9098 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9099   spammer3 : spammer4
9100 .endd
9101 As in all colon-separated lists in Exim, a colon can be included in an item by
9102 doubling.
9103
9104 If the last item in the list starts with a right angle-bracket, the remainder
9105 of the item is taken as a new key to look up in order to obtain a continuation
9106 list of local parts. The new key can be any sequence of characters. Thus one
9107 might have entries like
9108 .code
9109 aol.com: spammer1 : spammer 2 : >*
9110 xyz.com: spammer3 : >*
9111 *:       ^\d{8}$
9112 .endd
9113 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9114 local parts for all domains, in addition to the specific local parts listed for
9115 each domain. Of course, using this feature costs another lookup each time a
9116 chain is followed, but the effort needed to maintain the data is reduced.
9117
9118 .cindex "loop" "in lookups"
9119 It is possible to construct loops using this facility, and in order to catch
9120 them, the chains may be no more than fifty items long.
9121
9122 .next
9123 The @@<&'lookup'&> style of item can also be used with a query-style
9124 lookup, but in this case, the chaining facility is not available. The lookup
9125 can only return a single list of local parts.
9126 .endlist
9127
9128 &*Warning*&: There is an important difference between the address list items
9129 in these two examples:
9130 .code
9131 senders = +my_list
9132 senders = *@+my_list
9133 .endd
9134 In the first one, &`my_list`& is a named address list, whereas in the second
9135 example it is a named domain list.
9136
9137
9138
9139
9140 .section "Case of letters in address lists" "SECTcasletadd"
9141 .cindex "case of local parts"
9142 .cindex "address list" "case forcing"
9143 .cindex "case forcing in address lists"
9144 Domains in email addresses are always handled caselessly, but for local parts
9145 case may be significant on some systems (see &%caseful_local_part%& for how
9146 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9147 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9148 blocking lists should be done in a case-independent manner. Since most address
9149 lists in Exim are used for this kind of control, Exim attempts to do this by
9150 default.
9151
9152 The domain portion of an address is always lowercased before matching it to an
9153 address list. The local part is lowercased by default, and any string
9154 comparisons that take place are done caselessly. This means that the data in
9155 the address list itself, in files included as plain filenames, and in any file
9156 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9157 keys in files that are looked up by a search type other than &(lsearch)& (which
9158 works caselessly) must be in lower case, because these lookups are not
9159 case-independent.
9160
9161 .cindex "&`+caseful`&"
9162 To allow for the possibility of caseful address list matching, if an item in
9163 an address list is the string &"+caseful"&, the original case of the local
9164 part is restored for any comparisons that follow, and string comparisons are no
9165 longer case-independent. This does not affect the domain, which remains in
9166 lower case. However, although independent matches on the domain alone are still
9167 performed caselessly, regular expressions that match against an entire address
9168 become case-sensitive after &"+caseful"& has been seen.
9169
9170
9171
9172 .section "Local part lists" "SECTlocparlis"
9173 .cindex "list" "local part list"
9174 .cindex "local part" "list"
9175 Case-sensitivity in local part lists is handled in the same way as for address
9176 lists, as just described. The &"+caseful"& item can be used if required. In a
9177 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9178 set false, the subject is lowercased and the matching is initially
9179 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9180 matching in the local part list, but not elsewhere in the router. If
9181 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9182 option is case-sensitive from the start.
9183
9184 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9185 comments are handled in the same way as address lists &-- they are recognized
9186 only if the # is preceded by white space or the start of the line.
9187 Otherwise, local part lists are matched in the same way as domain lists, except
9188 that the special items that refer to the local host (&`@`&, &`@[]`&,
9189 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9190 Refer to section &<<SECTdomainlist>>& for details of the other available item
9191 types.
9192 .ecindex IIDdohoadli
9193
9194
9195
9196
9197 . ////////////////////////////////////////////////////////////////////////////
9198 . ////////////////////////////////////////////////////////////////////////////
9199
9200 .chapter "String expansions" "CHAPexpand"
9201 .scindex IIDstrexp "expansion" "of strings"
9202 Many strings in Exim's runtime configuration are expanded before use. Some of
9203 them are expanded every time they are used; others are expanded only once.
9204
9205 When a string is being expanded it is copied verbatim from left to right except
9206 .cindex expansion "string concatenation"
9207 when a dollar or backslash character is encountered. A dollar specifies the
9208 start of a portion of the string that is interpreted and replaced as described
9209 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9210 escape character, as described in the following section.
9211
9212 Whether a string is expanded depends upon the context.  Usually this is solely
9213 dependent upon the option for which a value is sought; in this documentation,
9214 options for which string expansion is performed are marked with &dagger; after
9215 the data type.  ACL rules always expand strings.  A couple of expansion
9216 conditions do not expand some of the brace-delimited branches, for security
9217 reasons.
9218
9219
9220
9221 .section "Literal text in expanded strings" "SECTlittext"
9222 .cindex "expansion" "including literal text"
9223 An uninterpreted dollar can be included in an expanded string by putting a
9224 backslash in front of it. A backslash can be used to prevent any special
9225 character being treated specially in an expansion, including backslash itself.
9226 If the string appears in quotes in the configuration file, two backslashes are
9227 required because the quotes themselves cause interpretation of backslashes when
9228 the string is read in (see section &<<SECTstrings>>&).
9229
9230 .cindex "expansion" "non-expandable substrings"
9231 A portion of the string can specified as non-expandable by placing it between
9232 two occurrences of &`\N`&. This is particularly useful for protecting regular
9233 expressions, which often contain backslashes and dollar signs. For example:
9234 .code
9235 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9236 .endd
9237 On encountering the first &`\N`&, the expander copies subsequent characters
9238 without interpretation until it reaches the next &`\N`& or the end of the
9239 string.
9240
9241
9242
9243 .section "Character escape sequences in expanded strings" "SECID82"
9244 .cindex "expansion" "escape sequences"
9245 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9246 expanded string is recognized as an escape sequence for the character newline,
9247 carriage return, or tab, respectively. A backslash followed by up to three
9248 octal digits is recognized as an octal encoding for a single character, and a
9249 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9250 encoding.
9251
9252 These escape sequences are also recognized in quoted strings when they are read
9253 in. Their interpretation in expansions as well is useful for unquoted strings,
9254 and for other cases such as looked-up strings that are then expanded.
9255
9256
9257 .section "Testing string expansions" "SECID83"
9258 .cindex "expansion" "testing"
9259 .cindex "testing" "string expansion"
9260 .oindex "&%-be%&"
9261 Many expansions can be tested by calling Exim with the &%-be%& option. This
9262 takes the command arguments, or lines from the standard input if there are no
9263 arguments, runs them through the string expansion code, and writes the results
9264 to the standard output. Variables based on configuration values are set up, but
9265 since no message is being processed, variables such as &$local_part$& have no
9266 value. Nevertheless the &%-be%& option can be useful for checking out file and
9267 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9268 and &%nhash%&.
9269
9270 Exim gives up its root privilege when it is called with the &%-be%& option, and
9271 instead runs under the uid and gid it was called with, to prevent users from
9272 using &%-be%& for reading files to which they do not have access.
9273
9274 .oindex "&%-bem%&"
9275 If you want to test expansions that include variables whose values are taken
9276 from a message, there are two other options that can be used. The &%-bem%&
9277 option is like &%-be%& except that it is followed by a filename. The file is
9278 read as a message before doing the test expansions. For example:
9279 .code
9280 exim -bem /tmp/test.message '$h_subject:'
9281 .endd
9282 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9283 Exim message identifier. For example:
9284 .code
9285 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9286 .endd
9287 This loads the message from Exim's spool before doing the test expansions, and
9288 is therefore restricted to admin users.
9289
9290
9291 .section "Forced expansion failure" "SECTforexpfai"
9292 .cindex "expansion" "forced failure"
9293 A number of expansions that are described in the following section have
9294 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9295 (which are sometimes called &"curly brackets"&). Which of the two strings is
9296 used depends on some condition that is evaluated as part of the expansion. If,
9297 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9298 the entire string expansion fails in a way that can be detected by the code
9299 that requested the expansion. This is called &"forced expansion failure"&, and
9300 its consequences depend on the circumstances. In some cases it is no different
9301 from any other expansion failure, but in others a different action may be
9302 taken. Such variations are mentioned in the documentation of the option that is
9303 being expanded.
9304
9305
9306
9307
9308 .section "Expansion items" "SECTexpansionitems"
9309 The following items are recognized in expanded strings. White space may be used
9310 between sub-items that are keywords or substrings enclosed in braces inside an
9311 outer set of braces, to improve readability. &*Warning*&: Within braces,
9312 white space is significant.
9313
9314 .vlist
9315 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9316 .cindex "expansion" "variables"
9317 Substitute the contents of the named variable, for example:
9318 .code
9319 $local_part
9320 ${domain}
9321 .endd
9322 The second form can be used to separate the name from subsequent alphanumeric
9323 characters. This form (using braces) is available only for variables; it does
9324 &'not'& apply to message headers. The names of the variables are given in
9325 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9326 given, the expansion fails.
9327
9328 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9329 .cindex "expansion" "operators"
9330 The string is first itself expanded, and then the operation specified by
9331 <&'op'&> is applied to it. For example:
9332 .code
9333 ${lc:$local_part}
9334 .endd
9335 The string starts with the first character after the colon, which may be
9336 leading white space. A list of operators is given in section &<<SECTexpop>>&
9337 below. The operator notation is used for simple expansion items that have just
9338 one argument, because it reduces the number of braces and therefore makes the
9339 string easier to understand.
9340
9341 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9342 This item inserts &"basic"& header lines. It is described with the &%header%&
9343 expansion item below.
9344
9345
9346 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9347 .cindex "expansion" "calling an acl"
9348 .cindex "&%acl%&" "call from expansion"
9349 The name and zero to nine argument strings are first expanded separately.  The expanded
9350 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9351 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9352 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9353 and may use the variables; if another acl expansion is used the values
9354 are restored after it returns.  If the ACL sets
9355 a value using a "message =" modifier and returns accept or deny, the value becomes
9356 the result of the expansion.
9357 If no message is set and the ACL returns accept or deny
9358 the expansion result is an empty string.
9359 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9360
9361
9362 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9363 .cindex authentication "results header"
9364 .cindex headers "authentication-results:"
9365 .cindex authentication "expansion item"
9366 This item returns a string suitable for insertion as an
9367 &'Authentication-Results"'&
9368 header line.
9369 The given <&'authserv-id'&> is included in the result; typically this
9370 will be a domain name identifying the system performing the authentications.
9371 Methods that might be present in the result include:
9372 .code
9373 none
9374 iprev
9375 auth
9376 spf
9377 dkim
9378 .endd
9379
9380 Example use (as an ACL modifier):
9381 .code
9382       add_header = :at_start:${authresults {$primary_hostname}}
9383 .endd
9384 This is safe even if no authentication results are available.
9385
9386
9387 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9388        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9389 .cindex "expansion" "extracting certificate fields"
9390 .cindex "&%certextract%&" "certificate fields"
9391 .cindex "certificate" "extracting fields"
9392 The <&'certificate'&> must be a variable of type certificate.
9393 The field name is expanded and used to retrieve the relevant field from
9394 the certificate.  Supported fields are:
9395 .display
9396 &`version        `&
9397 &`serial_number  `&
9398 &`subject        `& RFC4514 DN
9399 &`issuer         `& RFC4514 DN
9400 &`notbefore      `& time
9401 &`notafter       `& time
9402 &`sig_algorithm  `&
9403 &`signature      `&
9404 &`subj_altname   `& tagged list
9405 &`ocsp_uri       `& list
9406 &`crl_uri        `& list
9407 .endd
9408 If the field is found,
9409 <&'string2'&> is expanded, and replaces the whole item;
9410 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9411 variable &$value$& contains the value that has been extracted. Afterwards, it
9412 is restored to any previous value it might have had.
9413
9414 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9415 key is not found. If {<&'string2'&>} is also omitted, the value that was
9416 extracted is used.
9417
9418 Some field names take optional modifiers, appended and separated by commas.
9419
9420 The field selectors marked as "RFC4514" above
9421 output a Distinguished Name string which is
9422 not quite
9423 parseable by Exim as a comma-separated tagged list
9424 (the exceptions being elements containing commas).
9425 RDN elements of a single type may be selected by
9426 a modifier of the type label; if so the expansion
9427 result is a list (newline-separated by default).
9428 The separator may be changed by another modifier of
9429 a right angle-bracket followed immediately by the new separator.
9430 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9431
9432 The field selectors marked as "time" above
9433 take an optional modifier of "int"
9434 for which the result is the number of seconds since epoch.
9435 Otherwise the result is a human-readable string
9436 in the timezone selected by the main "timezone" option.
9437
9438 The field selectors marked as "list" above return a list,
9439 newline-separated by default,
9440 (embedded separator characters in elements are doubled).
9441 The separator may be changed by a modifier of
9442 a right angle-bracket followed immediately by the new separator.
9443
9444 The field selectors marked as "tagged" above
9445 prefix each list element with a type string and an equals sign.
9446 Elements of only one type may be selected by a modifier
9447 which is one of "dns", "uri" or "mail";
9448 if so the element tags are omitted.
9449
9450 If not otherwise noted field values are presented in human-readable form.
9451
9452 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9453        {*&<&'arg'&>&*}...}*&"
9454 .cindex &%dlfunc%&
9455 This expansion dynamically loads and then calls a locally-written C function.
9456 This functionality is available only if Exim is compiled with
9457 .code
9458 EXPAND_DLFUNC=yes
9459 .endd
9460 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9461 object so that it doesn't reload the same object file in the same Exim process
9462 (but of course Exim does start new processes frequently).
9463
9464 There may be from zero to eight arguments to the function. When compiling
9465 a local function that is to be called in this way, &_local_scan.h_& should be
9466 included. The Exim variables and functions that are defined by that API
9467 are also available for dynamically loaded functions. The function itself
9468 must have the following type:
9469 .code
9470 int dlfunction(uschar **yield, int argc, uschar *argv[])
9471 .endd
9472 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9473 function should return one of the following values:
9474
9475 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9476 into the expanded string that is being built.
9477
9478 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9479 from &'yield'&, if it is set.
9480
9481 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9482 taken from &'yield'& if it is set.
9483
9484 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9485
9486 When compiling a function that is to be used in this way with gcc,
9487 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9488 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9489
9490
9491 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9492 .cindex "expansion" "extracting value from environment"
9493 .cindex "environment" "values from"
9494 The key is first expanded separately, and leading and trailing white space
9495 removed.
9496 This is then searched for as a name in the environment.
9497 If a variable is found then its value is placed in &$value$&
9498 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9499
9500 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9501 appear, for example:
9502 .code
9503 ${env{USER}{$value} fail }
9504 .endd
9505 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9506 {<&'string1'&>} must be present for &"fail"& to be recognized.
9507
9508 If {<&'string2'&>} is omitted an empty string is substituted on
9509 search failure.
9510 If {<&'string1'&>} is omitted the search result is substituted on
9511 search success.
9512
9513 The environment is adjusted by the &%keep_environment%& and
9514 &%add_environment%& main section options.
9515
9516
9517 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9518        {*&<&'string3'&>&*}}*&"
9519 .cindex "expansion" "extracting substrings by key"
9520 .cindex "&%extract%&" "substrings by key"
9521 The key and <&'string1'&> are first expanded separately. Leading and trailing
9522 white space is removed from the key (but not from any of the strings). The key
9523 must not be empty and must not consist entirely of digits.
9524 The expanded <&'string1'&> must be of the form:
9525 .display
9526 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9527 .endd
9528 .vindex "&$value$&"
9529 where the equals signs and spaces (but not both) are optional. If any of the
9530 values contain white space, they must be enclosed in double quotes, and any
9531 values that are enclosed in double quotes are subject to escape processing as
9532 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9533 for the value that corresponds to the key. The search is case-insensitive. If
9534 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9535 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9536 variable &$value$& contains the value that has been extracted. Afterwards, it
9537 is restored to any previous value it might have had.
9538
9539 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9540 key is not found. If {<&'string2'&>} is also omitted, the value that was
9541 extracted is used. Thus, for example, these two expansions are identical, and
9542 yield &"2001"&:
9543 .code
9544 ${extract{gid}{uid=1984 gid=2001}}
9545 ${extract{gid}{uid=1984 gid=2001}{$value}}
9546 .endd
9547 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9548 appear, for example:
9549 .code
9550 ${extract{Z}{A=... B=...}{$value} fail }
9551 .endd
9552 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9553 {<&'string2'&>} must be present for &"fail"& to be recognized.
9554
9555 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9556        {*&<&'string3'&>&*}}*&" &&&
9557        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9558        {*&<&'string3'&>&*}}*&"
9559 .cindex "expansion" "extracting from JSON object"
9560 .cindex JSON expansions
9561 The key and <&'string1'&> are first expanded separately. Leading and trailing
9562 white space is removed from the key (but not from any of the strings). The key
9563 must not be empty and must not consist entirely of digits.
9564 The expanded <&'string1'&> must be of the form:
9565 .display
9566 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9567 .endd
9568 .vindex "&$value$&"
9569 The braces, commas and colons, and the quoting of the member name are required;
9570 the spaces are optional.
9571 Matching of the key against the member names is done case-sensitively.
9572 For the &"json"& variant,
9573 if a returned value is a JSON string, it retains its leading and
9574 trailing quotes.
9575 .new
9576 For the &"jsons"& variant, which is intended for use with JSON strings, the
9577 leading and trailing quotes are removed from the returned value.
9578 .wen
9579 . XXX should be a UTF-8 compare
9580
9581 The results of matching are handled as above.
9582
9583
9584 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9585         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9586 .cindex "expansion" "extracting substrings by number"
9587 .cindex "&%extract%&" "substrings by number"
9588 The <&'number'&> argument must consist entirely of decimal digits,
9589 apart from leading and trailing white space, which is ignored.
9590 This is what distinguishes this form of &%extract%& from the previous kind. It
9591 behaves in the same way, except that, instead of extracting a named field, it
9592 extracts from <&'string1'&> the field whose number is given as the first
9593 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9594 <&'string3'&> as before.
9595
9596 The fields in the string are separated by any one of the characters in the
9597 separator string. These may include space or tab characters.
9598 The first field is numbered one. If the number is negative, the fields are
9599 counted from the end of the string, with the rightmost one numbered -1. If the
9600 number given is zero, the entire string is returned. If the modulus of the
9601 number is greater than the number of fields in the string, the result is the
9602 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9603 provided. For example:
9604 .code
9605 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9606 .endd
9607 yields &"42"&, and
9608 .code
9609 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9610 .endd
9611 yields &"99"&. Two successive separators mean that the field between them is
9612 empty (for example, the fifth field above).
9613
9614
9615 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9616         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9617        "&*${extract jsons{*&<&'number'&>&*}}&&&
9618         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9619 .cindex "expansion" "extracting from JSON array"
9620 .cindex JSON expansions
9621 The <&'number'&> argument must consist entirely of decimal digits,
9622 apart from leading and trailing white space, which is ignored.
9623
9624 Field selection and result handling is as above;
9625 there is no choice of field separator.
9626 For the &"json"& variant,
9627 if a returned value is a JSON string, it retains its leading and
9628 trailing quotes.
9629 .new
9630 For the &"jsons"& variant, which is intended for use with JSON strings, the
9631 leading and trailing quotes are removed from the returned value.
9632 .wen
9633
9634
9635 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9636 .cindex "list" "selecting by condition"
9637 .cindex "expansion" "selecting from list by condition"
9638 .vindex "&$item$&"
9639 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9640 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9641 For each item
9642 in this list, its value is place in &$item$&, and then the condition is
9643 evaluated. If the condition is true, &$item$& is added to the output as an
9644 item in a new list; if the condition is false, the item is discarded. The
9645 separator used for the output list is the same as the one used for the
9646 input, but a separator setting is not included in the output. For example:
9647 .code
9648 ${filter{a:b:c}{!eq{$item}{b}}}
9649 .endd
9650 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9651 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9652
9653
9654 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9655 .cindex "hash function" "textual"
9656 .cindex "expansion" "textual hash"
9657 This is a textual hashing function, and was the first to be implemented in
9658 early versions of Exim. In current releases, there are other hashing functions
9659 (numeric, MD5, and SHA-1), which are described below.
9660
9661 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9662 <&'n'&>. If you are using fixed values for these numbers, that is, if
9663 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9664 use the simpler operator notation that avoids some of the braces:
9665 .code
9666 ${hash_<n>_<m>:<string>}
9667 .endd
9668 The second number is optional (in both notations). If <&'n'&> is greater than
9669 or equal to the length of the string, the expansion item returns the string.
9670 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9671 function to the string. The new string consists of characters taken from the
9672 first <&'m'&> characters of the string
9673 .code
9674 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9675 .endd
9676 If <&'m'&> is not present the value 26 is used, so that only lower case
9677 letters appear. For example:
9678 .display
9679 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9680 &`$hash{5}{monty}}           `&   yields  &`monty`&
9681 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9682 .endd
9683
9684 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9685         &*$h_*&<&'header&~name'&>&*:*&" &&&
9686        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9687         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9688        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9689         &*$lh_*&<&'header&~name'&>&*:*&"
9690        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9691         &*$rh_*&<&'header&~name'&>&*:*&"
9692 .cindex "expansion" "header insertion"
9693 .vindex "&$header_$&"
9694 .vindex "&$bheader_$&"
9695 .vindex "&$lheader_$&"
9696 .vindex "&$rheader_$&"
9697 .cindex "header lines" "in expansion strings"
9698 .cindex "header lines" "character sets"
9699 .cindex "header lines" "decoding"
9700 Substitute the contents of the named message header line, for example
9701 .code
9702 $header_reply-to:
9703 .endd
9704 The newline that terminates a header line is not included in the expansion, but
9705 internal newlines (caused by splitting the header line over several physical
9706 lines) may be present.
9707
9708 The difference between the four pairs of expansions is in the way
9709 the data in the header line is interpreted.
9710
9711 .ilist
9712 .cindex "white space" "in header lines"
9713 &%rheader%& gives the original &"raw"& content of the header line, with no
9714 processing at all, and without the removal of leading and trailing white space.
9715
9716 .next
9717 .cindex "list" "of header lines"
9718 &%lheader%& gives a colon-separated list, one element per header when there
9719 are multiple headers with a given name.
9720 Any embedded colon characters within an element are doubled, so normal Exim
9721 list-processing facilities can be used.
9722 The terminating newline of each element is removed; in other respects
9723 the content is &"raw"&.
9724
9725 .next
9726 .cindex "base64 encoding" "in header lines"
9727 &%bheader%& removes leading and trailing white space, and then decodes base64
9728 or quoted-printable MIME &"words"& within the header text, but does no
9729 character set translation. If decoding of what looks superficially like a MIME
9730 &"word"& fails, the raw string is returned. If decoding
9731 .cindex "binary zero" "in header line"
9732 produces a binary zero character, it is replaced by a question mark &-- this is
9733 what Exim does for binary zeros that are actually received in header lines.
9734
9735 .next
9736 &%header%& tries to translate the string as decoded by &%bheader%& to a
9737 standard character set. This is an attempt to produce the same string as would
9738 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9739 returned. Translation is attempted only on operating systems that support the
9740 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9741 a system Makefile or in &_Local/Makefile_&.
9742 .endlist ilist
9743
9744 In a filter file, the target character set for &%header%& can be specified by a
9745 command of the following form:
9746 .code
9747 headers charset "UTF-8"
9748 .endd
9749 This command affects all references to &$h_$& (or &$header_$&) expansions in
9750 subsequently obeyed filter commands. In the absence of this command, the target
9751 character set in a filter is taken from the setting of the &%headers_charset%&
9752 option in the runtime configuration. The value of this option defaults to the
9753 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9754 ISO-8859-1.
9755
9756 Header names follow the syntax of RFC 2822, which states that they may contain
9757 any printing characters except space and colon. Consequently, curly brackets
9758 &'do not'& terminate header names, and should not be used to enclose them as
9759 if they were variables. Attempting to do so causes a syntax error.
9760
9761 Only header lines that are common to all copies of a message are visible to
9762 this mechanism. These are the original header lines that are received with the
9763 message, and any that are added by an ACL statement or by a system
9764 filter. Header lines that are added to a particular copy of a message by a
9765 router or transport are not accessible.
9766
9767 For incoming SMTP messages, no header lines are visible in
9768 ACLs that are obeyed before the data phase completes,
9769 because the header structure is not set up until the message is received.
9770 They are visible in DKIM, PRDR and DATA ACLs.
9771 Header lines that are added in a RCPT ACL (for example)
9772 are saved until the message's incoming header lines are available, at which
9773 point they are added.
9774 When any of the above ACLs ar
9775 running, however, header lines added by earlier ACLs are visible.
9776
9777 Upper case and lower case letters are synonymous in header names. If the
9778 following character is white space, the terminating colon may be omitted, but
9779 this is not recommended, because you may then forget it when it is needed. When
9780 white space terminates the header name, this white space is included in the
9781 expanded string.  If the message does not contain the given header, the
9782 expansion item is replaced by an empty string. (See the &%def%& condition in
9783 section &<<SECTexpcond>>& for a means of testing for the existence of a
9784 header.)
9785
9786 If there is more than one header with the same name, they are all concatenated
9787 to form the substitution string, up to a maximum length of 64K. Unless
9788 &%rheader%& is being used, leading and trailing white space is removed from
9789 each header before concatenation, and a completely empty header is ignored. A
9790 newline character is then inserted between non-empty headers, but there is no
9791 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9792 those headers that contain lists of addresses, a comma is also inserted at the
9793 junctions between headers. This does not happen for the &%rheader%& expansion.
9794
9795
9796 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9797 .cindex "expansion" "hmac hashing"
9798 .cindex &%hmac%&
9799 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9800 shared secret and some text into a message authentication code, as specified in
9801 RFC 2104. This differs from &`${md5:secret_text...}`& or
9802 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9803 cryptographic hash, allowing for authentication that is not possible with MD5
9804 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9805 present. For example:
9806 .code
9807 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9808 .endd
9809 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9810 produces:
9811 .code
9812 dd97e3ba5d1a61b5006108f8c8252953
9813 .endd
9814 As an example of how this might be used, you might put in the main part of
9815 an Exim configuration:
9816 .code
9817 SPAMSCAN_SECRET=cohgheeLei2thahw
9818 .endd
9819 In a router or a transport you could then have:
9820 .code
9821 headers_add = \
9822   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9823   ${hmac{md5}{SPAMSCAN_SECRET}\
9824   {${primary_hostname},${message_exim_id},$h_message-id:}}
9825 .endd
9826 Then given a message, you can check where it was scanned by looking at the
9827 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9828 this header line is authentic by recomputing the authentication code from the
9829 host name, message ID and the &'Message-id:'& header line. This can be done
9830 using Exim's &%-be%& option, or by other means, for example, by using the
9831 &'hmac_md5_hex()'& function in Perl.
9832
9833
9834 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9835 .cindex "expansion" "conditional"
9836 .cindex "&%if%&, expansion item"
9837 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9838 item; otherwise <&'string2'&> is used. The available conditions are described
9839 in section &<<SECTexpcond>>& below. For example:
9840 .code
9841 ${if eq {$local_part}{postmaster} {yes}{no} }
9842 .endd
9843 The second string need not be present; if it is not and the condition is not
9844 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9845 be present instead of the second string (without any curly brackets). In this
9846 case, the expansion is forced to fail if the condition is not true (see section
9847 &<<SECTforexpfai>>&).
9848
9849 If both strings are omitted, the result is the string &`true`& if the condition
9850 is true, and the empty string if the condition is false. This makes it less
9851 cumbersome to write custom ACL and router conditions. For example, instead of
9852 .code
9853 condition = ${if >{$acl_m4}{3}{true}{false}}
9854 .endd
9855 you can use
9856 .code
9857 condition = ${if >{$acl_m4}{3}}
9858 .endd
9859
9860
9861
9862 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9863 .cindex expansion "imap folder"
9864 .cindex "&%imapfolder%& expansion item"
9865 This item converts a (possibly multilevel, or with non-ASCII characters)
9866 folder specification to a Maildir name for filesystem use.
9867 For information on internationalisation support see &<<SECTi18nMDA>>&.
9868
9869
9870
9871 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9872 .cindex "expansion" "string truncation"
9873 .cindex "&%length%& expansion item"
9874 The &%length%& item is used to extract the initial portion of a string. Both
9875 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9876 you are using a fixed value for the number, that is, if <&'string1'&> does not
9877 change when expanded, you can use the simpler operator notation that avoids
9878 some of the braces:
9879 .code
9880 ${length_<n>:<string>}
9881 .endd
9882 The result of this item is either the first <&'n'&> bytes or the whole
9883 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9884 &%strlen%&, which gives the length of a string.
9885 All measurement is done in bytes and is not UTF-8 aware.
9886
9887
9888 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9889         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9890 .cindex "expansion" "extracting list elements by number"
9891 .cindex "&%listextract%&" "extract list elements by number"
9892 .cindex "list" "extracting elements by number"
9893 The <&'number'&> argument must consist entirely of decimal digits,
9894 apart from an optional leading minus,
9895 and leading and trailing white space (which is ignored).
9896
9897 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9898 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9899
9900 The first field of the list is numbered one.
9901 If the number is negative, the fields are
9902 counted from the end of the list, with the rightmost one numbered -1.
9903 The numbered element of the list is extracted and placed in &$value$&,
9904 then <&'string2'&> is expanded as the result.
9905
9906 If the modulus of the
9907 number is zero or greater than the number of fields in the string,
9908 the result is the expansion of <&'string3'&>.
9909
9910 For example:
9911 .code
9912 ${listextract{2}{x:42:99}}
9913 .endd
9914 yields &"42"&, and
9915 .code
9916 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9917 .endd
9918 yields &"result: 42"&.
9919
9920 If {<&'string3'&>} is omitted, an empty string is used for string3.
9921 If {<&'string2'&>} is also omitted, the value that was
9922 extracted is used.
9923 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9924
9925
9926 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9927         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9928 This is the first of one of two different types of lookup item, which are both
9929 described in the next item.
9930
9931 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9932         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9933 .cindex "expansion" "lookup in"
9934 .cindex "file" "lookups"
9935 .cindex "lookup" "in expanded string"
9936 The two forms of lookup item specify data lookups in files and databases, as
9937 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9938 lookups, and the second is used for query-style lookups. The <&'key'&>,
9939 <&'file'&>, and <&'query'&> strings are expanded before use.
9940
9941 If there is any white space in a lookup item which is part of a filter command,
9942 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9943 other place where white space is significant, the lookup item must be enclosed
9944 in double quotes. The use of data lookups in users' filter files may be locked
9945 out by the system administrator.
9946
9947 .vindex "&$value$&"
9948 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9949 During its expansion, the variable &$value$& contains the data returned by the
9950 lookup. Afterwards it reverts to the value it had previously (at the outer
9951 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9952 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9953 string on failure. If <&'string2'&> is provided, it can itself be a nested
9954 lookup, thus providing a mechanism for looking up a default value when the
9955 original lookup fails.
9956
9957 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9958 data for the outer lookup while the parameters of the second lookup are
9959 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9960 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9961 appear, and in this case, if the lookup fails, the entire expansion is forced
9962 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9963 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9964 successful lookup, and nothing in the case of failure.
9965
9966 For single-key lookups, the string &"partial"& is permitted to precede the
9967 search type in order to do partial matching, and * or *@ may follow a search
9968 type to request default lookups if the key does not match (see sections
9969 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9970
9971 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9972 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9973 and non-wild parts of the key during the expansion of the replacement text.
9974 They return to their previous values at the end of the lookup item.
9975
9976 This example looks up the postmaster alias in the conventional alias file:
9977 .code
9978 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9979 .endd
9980 This example uses NIS+ to look up the full name of the user corresponding to
9981 the local part of an address, forcing the expansion to fail if it is not found:
9982 .code
9983 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9984   {$value}fail}
9985 .endd
9986
9987
9988 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9989 .cindex "expansion" "list creation"
9990 .vindex "&$item$&"
9991 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9992 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9993 For each item
9994 in this list, its value is place in &$item$&, and then <&'string2'&> is
9995 expanded and added to the output as an item in a new list. The separator used
9996 for the output list is the same as the one used for the input, but a separator
9997 setting is not included in the output. For example:
9998 .code
9999 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10000 .endd
10001 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10002 value of &$item$& is restored to what it was before. See also the &*filter*&
10003 and &*reduce*& expansion items.
10004
10005 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10006 .cindex "expansion" "numeric hash"
10007 .cindex "hash function" "numeric"
10008 The three strings are expanded; the first two must yield numbers. Call them
10009 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10010 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10011 can use the simpler operator notation that avoids some of the braces:
10012 .code
10013 ${nhash_<n>_<m>:<string>}
10014 .endd
10015 The second number is optional (in both notations). If there is only one number,
10016 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10017 processed by a div/mod hash function that returns two numbers, separated by a
10018 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10019 example,
10020 .code
10021 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10022 .endd
10023 returns the string &"6/33"&.
10024
10025
10026
10027 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10028 .cindex "Perl" "use in expanded string"
10029 .cindex "expansion" "calling Perl from"
10030 This item is available only if Exim has been built to include an embedded Perl
10031 interpreter. The subroutine name and the arguments are first separately
10032 expanded, and then the Perl subroutine is called with those arguments. No
10033 additional arguments need be given; the maximum number permitted, including the
10034 name of the subroutine, is nine.
10035
10036 The return value of the subroutine is inserted into the expanded string, unless
10037 the return value is &%undef%&. In that case, the expansion fails in the same
10038 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10039 Whatever you return is evaluated in a scalar context. For example, if you
10040 return the name of a Perl vector, the return value is the size of the vector,
10041 not its contents.
10042
10043 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10044 with the error message that was passed to &%die%&. More details of the embedded
10045 Perl facility are given in chapter &<<CHAPperl>>&.
10046
10047 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10048 out the use of this expansion item in filter files.
10049
10050
10051 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10052 .cindex "&%prvs%& expansion item"
10053 The first argument is a complete email address and the second is secret
10054 keystring. The third argument, specifying a key number, is optional. If absent,
10055 it defaults to 0. The result of the expansion is a prvs-signed email address,
10056 to be typically used with the &%return_path%& option on an &(smtp)& transport
10057 as part of a bounce address tag validation (BATV) scheme. For more discussion
10058 and an example, see section &<<SECTverifyPRVS>>&.
10059
10060 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10061         {*&<&'string'&>&*}}*&"
10062 .cindex "&%prvscheck%& expansion item"
10063 This expansion item is the complement of the &%prvs%& item. It is used for
10064 checking prvs-signed addresses. If the expansion of the first argument does not
10065 yield a syntactically valid prvs-signed address, the whole item expands to the
10066 empty string. When the first argument does expand to a syntactically valid
10067 prvs-signed address, the second argument is expanded, with the prvs-decoded
10068 version of the address and the key number extracted from the address in the
10069 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10070
10071 These two variables can be used in the expansion of the second argument to
10072 retrieve the secret. The validity of the prvs-signed address is then checked
10073 against the secret. The result is stored in the variable &$prvscheck_result$&,
10074 which is empty for failure or &"1"& for success.
10075
10076 The third argument is optional; if it is missing, it defaults to an empty
10077 string. This argument is now expanded. If the result is an empty string, the
10078 result of the expansion is the decoded version of the address. This is the case
10079 whether or not the signature was valid. Otherwise, the result of the expansion
10080 is the expansion of the third argument.
10081
10082 All three variables can be used in the expansion of the third argument.
10083 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10084 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10085
10086 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10087 .cindex "expansion" "inserting an entire file"
10088 .cindex "file" "inserting into expansion"
10089 .cindex "&%readfile%& expansion item"
10090 The filename and end-of-line string are first expanded separately. The file is
10091 then read, and its contents replace the entire item. All newline characters in
10092 the file are replaced by the end-of-line string if it is present. Otherwise,
10093 newlines are left in the string.
10094 String expansion is not applied to the contents of the file. If you want this,
10095 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10096 the string expansion fails.
10097
10098 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10099 locks out the use of this expansion item in filter files.
10100
10101
10102
10103 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10104         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10105 .cindex "expansion" "inserting from a socket"
10106 .cindex "socket, use of in expansion"
10107 .cindex "&%readsocket%& expansion item"
10108 This item inserts data from a Unix domain or TCP socket into the expanded
10109 string. The minimal way of using it uses just two arguments, as in these
10110 examples:
10111 .code
10112 ${readsocket{/socket/name}{request string}}
10113 ${readsocket{inet:some.host:1234}{request string}}
10114 .endd
10115 For a Unix domain socket, the first substring must be the path to the socket.
10116 For an Internet socket, the first substring must contain &`inet:`& followed by
10117 a host name or IP address, followed by a colon and a port, which can be a
10118 number or the name of a TCP port in &_/etc/services_&. An IP address may
10119 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10120 example:
10121 .code
10122 ${readsocket{inet:[::1]:1234}{request string}}
10123 .endd
10124 Only a single host name may be given, but if looking it up yields more than
10125 one IP address, they are each tried in turn until a connection is made. For
10126 both kinds of socket, Exim makes a connection, writes the request string
10127 unless it is an empty string; and no terminating NUL is ever sent)
10128 and reads from the socket until an end-of-file
10129 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10130 extend what can be done. Firstly, you can vary the timeout. For example:
10131 .code
10132 ${readsocket{/socket/name}{request string}{3s}}
10133 .endd
10134
10135 The third argument is a list of options, of which the first element is the timeout
10136 and must be present if the argument is given.
10137 Further elements are options of form &'name=value'&.
10138 Two option types is currently recognised: shutdown and tls.
10139 The first defines whether (the default)
10140 or not a shutdown is done on the connection after sending the request.
10141 Example, to not do so (preferred, eg. by some webservers):
10142 .code
10143 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10144 .endd
10145 The second, tls, controls the use of TLS on the connection.  Example:
10146 .code
10147 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10148 .endd
10149 The default is to not use TLS.
10150 If it is enabled, a shutdown as descripbed above is never done.
10151
10152 A fourth argument allows you to change any newlines that are in the data
10153 that is read, in the same way as for &%readfile%& (see above). This example
10154 turns them into spaces:
10155 .code
10156 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10157 .endd
10158 As with all expansions, the substrings are expanded before the processing
10159 happens. Errors in these sub-expansions cause the expansion to fail. In
10160 addition, the following errors can occur:
10161
10162 .ilist
10163 Failure to create a socket file descriptor;
10164 .next
10165 Failure to connect the socket;
10166 .next
10167 Failure to write the request string;
10168 .next
10169 Timeout on reading from the socket.
10170 .endlist
10171
10172 By default, any of these errors causes the expansion to fail. However, if
10173 you supply a fifth substring, it is expanded and used when any of the above
10174 errors occurs. For example:
10175 .code
10176 ${readsocket{/socket/name}{request string}{3s}{\n}\
10177   {socket failure}}
10178 .endd
10179 You can test for the existence of a Unix domain socket by wrapping this
10180 expansion in &`${if exists`&, but there is a race condition between that test
10181 and the actual opening of the socket, so it is safer to use the fifth argument
10182 if you want to be absolutely sure of avoiding an expansion error for a
10183 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10184
10185 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10186 locks out the use of this expansion item in filter files.
10187
10188
10189 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10190 .cindex "expansion" "reducing a list to a scalar"
10191 .cindex "list" "reducing to a scalar"
10192 .vindex "&$value$&"
10193 .vindex "&$item$&"
10194 This operation reduces a list to a single, scalar string. After expansion,
10195 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10196 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10197 Then <&'string2'&> is expanded and
10198 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10199 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10200 them. The result of that expansion is assigned to &$value$& before the next
10201 iteration. When the end of the list is reached, the final value of &$value$& is
10202 added to the expansion output. The &*reduce*& expansion item can be used in a
10203 number of ways. For example, to add up a list of numbers:
10204 .code
10205 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10206 .endd
10207 The result of that expansion would be &`6`&. The maximum of a list of numbers
10208 can be found:
10209 .code
10210 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10211 .endd
10212 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10213 restored to what they were before. See also the &*filter*& and &*map*&
10214 expansion items.
10215
10216 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10217 This item inserts &"raw"& header lines. It is described with the &%header%&
10218 expansion item in section &<<SECTexpansionitems>>& above.
10219
10220 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10221         {*&<&'string2'&>&*}}*&"
10222 .cindex "expansion" "running a command"
10223 .cindex "&%run%& expansion item"
10224 The command and its arguments are first expanded as one string. The string is
10225 split apart into individual arguments by spaces, and then the command is run
10226 in a separate process, but under the same uid and gid.  As in other command
10227 executions from Exim, a shell is not used by default. If the command requires
10228 a shell, you must explicitly code it.
10229
10230 Since the arguments are split by spaces, when there is a variable expansion
10231 which has an empty result, it will cause the situation that the argument will
10232 simply be omitted when the program is actually executed by Exim. If the
10233 script/program requires a specific number of arguments and the expanded
10234 variable could possibly result in this empty expansion, the variable must be
10235 quoted. This is more difficult if the expanded variable itself could result
10236 in a string containing quotes, because it would interfere with the quotes
10237 around the command arguments. A possible guard against this is to wrap the
10238 variable in the &%sg%& operator to change any quote marks to some other
10239 character.
10240
10241 The standard input for the command exists, but is empty. The standard output
10242 and standard error are set to the same file descriptor.
10243 .cindex "return code" "from &%run%& expansion"
10244 .vindex "&$value$&"
10245 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10246 and replaces the entire item; during this expansion, the standard output/error
10247 from the command is in the variable &$value$&. If the command fails,
10248 <&'string2'&>, if present, is expanded and used. Once again, during the
10249 expansion, the standard output/error from the command is in the variable
10250 &$value$&.
10251
10252 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10253 can be the word &"fail"& (not in braces) to force expansion failure if the
10254 command does not succeed. If both strings are omitted, the result is contents
10255 of the standard output/error on success, and nothing on failure.
10256
10257 .vindex "&$run_in_acl$&"
10258 The standard output/error of the command is put in the variable &$value$&.
10259 In this ACL example, the output of a command is logged for the admin to
10260 troubleshoot:
10261 .code
10262 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10263       log_message  = Output of id: $value
10264 .endd
10265 If the command requires shell idioms, such as the > redirect operator, the
10266 shell must be invoked directly, such as with:
10267 .code
10268 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10269 .endd
10270
10271 .vindex "&$runrc$&"
10272 The return code from the command is put in the variable &$runrc$&, and this
10273 remains set afterwards, so in a filter file you can do things like this:
10274 .code
10275 if "${run{x y z}{}}$runrc" is 1 then ...
10276   elif $runrc is 2 then ...
10277   ...
10278 endif
10279 .endd
10280 If execution of the command fails (for example, the command does not exist),
10281 the return code is 127 &-- the same code that shells use for non-existent
10282 commands.
10283
10284 &*Warning*&: In a router or transport, you cannot assume the order in which
10285 option values are expanded, except for those preconditions whose order of
10286 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10287 by the expansion of one option, and use it in another.
10288
10289 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10290 out the use of this expansion item in filter files.
10291
10292
10293 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10294 .cindex "expansion" "string substitution"
10295 .cindex "&%sg%& expansion item"
10296 This item works like Perl's substitution operator (s) with the global (/g)
10297 option; hence its name. However, unlike the Perl equivalent, Exim does not
10298 modify the subject string; instead it returns the modified string for insertion
10299 into the overall expansion. The item takes three arguments: the subject string,
10300 a regular expression, and a substitution string. For example:
10301 .code
10302 ${sg{abcdefabcdef}{abc}{xyz}}
10303 .endd
10304 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10305 if any $, } or \ characters are required in the regular expression or in the
10306 substitution string, they have to be escaped. For example:
10307 .code
10308 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10309 .endd
10310 yields &"defabc"&, and
10311 .code
10312 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10313 .endd
10314 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10315 the regular expression from string expansion.
10316
10317 The regular expression is compiled in 8-bit mode, working against bytes
10318 rather than any Unicode-aware character handling.
10319
10320
10321 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10322 .cindex sorting "a list"
10323 .cindex list sorting
10324 .cindex expansion "list sorting"
10325 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10326 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10327 The <&'comparator'&> argument is interpreted as the operator
10328 of a two-argument expansion condition.
10329 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10330 The comparison should return true when applied to two values
10331 if the first value should sort before the second value.
10332 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10333 the element being placed in &$item$&,
10334 to give values for comparison.
10335
10336 The item result is a sorted list,
10337 with the original list separator,
10338 of the list elements (in full) of the original.
10339
10340 Examples:
10341 .code
10342 ${sort{3:2:1:4}{<}{$item}}
10343 .endd
10344 sorts a list of numbers, and
10345 .code
10346 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10347 .endd
10348 will sort an MX lookup into priority order.
10349
10350
10351 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10352 .cindex "&%substr%& expansion item"
10353 .cindex "substring extraction"
10354 .cindex "expansion" "substring extraction"
10355 The three strings are expanded; the first two must yield numbers. Call them
10356 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10357 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10358 can use the simpler operator notation that avoids some of the braces:
10359 .code
10360 ${substr_<n>_<m>:<string>}
10361 .endd
10362 The second number is optional (in both notations).
10363 If it is absent in the simpler format, the preceding underscore must also be
10364 omitted.
10365
10366 The &%substr%& item can be used to extract more general substrings than
10367 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10368 length required. For example
10369 .code
10370 ${substr{3}{2}{$local_part}}
10371 .endd
10372 If the starting offset is greater than the string length the result is the
10373 null string; if the length plus starting offset is greater than the string
10374 length, the result is the right-hand part of the string, starting from the
10375 given offset. The first byte (character) in the string has offset zero.
10376
10377 The &%substr%& expansion item can take negative offset values to count
10378 from the right-hand end of its operand. The last byte (character) is offset -1,
10379 the second-last is offset -2, and so on. Thus, for example,
10380 .code
10381 ${substr{-5}{2}{1234567}}
10382 .endd
10383 yields &"34"&. If the absolute value of a negative offset is greater than the
10384 length of the string, the substring starts at the beginning of the string, and
10385 the length is reduced by the amount of overshoot. Thus, for example,
10386 .code
10387 ${substr{-5}{2}{12}}
10388 .endd
10389 yields an empty string, but
10390 .code
10391 ${substr{-3}{2}{12}}
10392 .endd
10393 yields &"1"&.
10394
10395 When the second number is omitted from &%substr%&, the remainder of the string
10396 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10397 string preceding the offset point are taken. For example, an offset of -1 and
10398 no length, as in these semantically identical examples:
10399 .code
10400 ${substr_-1:abcde}
10401 ${substr{-1}{abcde}}
10402 .endd
10403 yields all but the last character of the string, that is, &"abcd"&.
10404
10405 All measurement is done in bytes and is not UTF-8 aware.
10406
10407
10408
10409 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10410         {*&<&'replacements'&>&*}}*&"
10411 .cindex "expansion" "character translation"
10412 .cindex "&%tr%& expansion item"
10413 This item does single-character (in bytes) translation on its subject string. The second
10414 argument is a list of characters to be translated in the subject string. Each
10415 matching character is replaced by the corresponding character from the
10416 replacement list. For example
10417 .code
10418 ${tr{abcdea}{ac}{13}}
10419 .endd
10420 yields &`1b3de1`&. If there are duplicates in the second character string, the
10421 last occurrence is used. If the third string is shorter than the second, its
10422 last character is replicated. However, if it is empty, no translation takes
10423 place.
10424
10425 All character handling is done in bytes and is not UTF-8 aware.
10426
10427 .endlist
10428
10429
10430
10431 .section "Expansion operators" "SECTexpop"
10432 .cindex "expansion" "operators"
10433 For expansion items that perform transformations on a single argument string,
10434 the &"operator"& notation is used because it is simpler and uses fewer braces.
10435 The substring is first expanded before the operation is applied to it. The
10436 following operations can be performed:
10437
10438 .vlist
10439 .vitem &*${address:*&<&'string'&>&*}*&
10440 .cindex "expansion" "RFC 2822 address handling"
10441 .cindex "&%address%& expansion item"
10442 The string is interpreted as an RFC 2822 address, as it might appear in a
10443 header line, and the effective address is extracted from it. If the string does
10444 not parse successfully, the result is empty.
10445
10446 The parsing correctly handles SMTPUTF8 Unicode in the string.
10447
10448
10449 .vitem &*${addresses:*&<&'string'&>&*}*&
10450 .cindex "expansion" "RFC 2822 address handling"
10451 .cindex "&%addresses%& expansion item"
10452 The string (after expansion) is interpreted as a list of addresses in RFC
10453 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10454 operative address (&'local-part@domain'&) is extracted from each item, and the
10455 result of the expansion is a colon-separated list, with appropriate
10456 doubling of colons should any happen to be present in the email addresses.
10457 Syntactically invalid RFC2822 address items are omitted from the output.
10458
10459 It is possible to specify a character other than colon for the output
10460 separator by starting the string with > followed by the new separator
10461 character. For example:
10462 .code
10463 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10464 .endd
10465 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10466 first, so if the expanded string starts with >, it may change the output
10467 separator unintentionally. This can be avoided by setting the output
10468 separator explicitly:
10469 .code
10470 ${addresses:>:$h_from:}
10471 .endd
10472
10473 Compare the &*address*& (singular)
10474 expansion item, which extracts the working address from a single RFC2822
10475 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10476 processing lists.
10477
10478 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10479 a strict interpretation of header line formatting.  Exim parses the bare,
10480 unquoted portion of an email address and if it finds a comma, treats it as an
10481 email address separator. For the example header line:
10482 .code
10483 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10484 .endd
10485 The first example below demonstrates that Q-encoded email addresses are parsed
10486 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10487 It does not see the comma because it's still encoded as "=2C".  The second
10488 example below is passed the contents of &`$header_from:`&, meaning it gets
10489 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10490 The third example shows that the presence of a comma is skipped when it is
10491 quoted.  The fourth example shows SMTPUTF8 handling.
10492 .code
10493 # exim -be '${addresses:From: \
10494 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10495 user@example.com
10496 # exim -be '${addresses:From: Last, First <user@example.com>}'
10497 Last:user@example.com
10498 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10499 user@example.com
10500 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10501 フィリップ@example.jp
10502 .endd
10503
10504 .vitem &*${base32:*&<&'digits'&>&*}*&
10505 .cindex "&%base32%& expansion item"
10506 .cindex "expansion" "conversion to base 32"
10507 The string must consist entirely of decimal digits. The number is converted to
10508 base 32 and output as a (empty, for zero) string of characters.
10509 Only lowercase letters are used.
10510
10511 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10512 .cindex "&%base32d%& expansion item"
10513 .cindex "expansion" "conversion to base 32"
10514 The string must consist entirely of base-32 digits.
10515 The number is converted to decimal and output as a string.
10516
10517 .vitem &*${base62:*&<&'digits'&>&*}*&
10518 .cindex "&%base62%& expansion item"
10519 .cindex "expansion" "conversion to base 62"
10520 The string must consist entirely of decimal digits. The number is converted to
10521 base 62 and output as a string of six characters, including leading zeros. In
10522 the few operating environments where Exim uses base 36 instead of base 62 for
10523 its message identifiers (because those systems do not have case-sensitive
10524 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10525 to be absolutely clear: this is &'not'& base64 encoding.
10526
10527 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10528 .cindex "&%base62d%& expansion item"
10529 .cindex "expansion" "conversion to base 62"
10530 The string must consist entirely of base-62 digits, or, in operating
10531 environments where Exim uses base 36 instead of base 62 for its message
10532 identifiers, base-36 digits. The number is converted to decimal and output as a
10533 string.
10534
10535 .vitem &*${base64:*&<&'string'&>&*}*&
10536 .cindex "expansion" "base64 encoding"
10537 .cindex "base64 encoding" "in string expansion"
10538 .cindex "&%base64%& expansion item"
10539 .cindex certificate "base64 of DER"
10540 This operator converts a string into one that is base64 encoded.
10541
10542 If the string is a single variable of type certificate,
10543 returns the base64 encoding of the DER form of the certificate.
10544
10545
10546 .vitem &*${base64d:*&<&'string'&>&*}*&
10547 .cindex "expansion" "base64 decoding"
10548 .cindex "base64 decoding" "in string expansion"
10549 .cindex "&%base64d%& expansion item"
10550 This operator converts a base64-encoded string into the un-coded form.
10551
10552
10553 .vitem &*${domain:*&<&'string'&>&*}*&
10554 .cindex "domain" "extraction"
10555 .cindex "expansion" "domain extraction"
10556 The string is interpreted as an RFC 2822 address and the domain is extracted
10557 from it. If the string does not parse successfully, the result is empty.
10558
10559
10560 .vitem &*${escape:*&<&'string'&>&*}*&
10561 .cindex "expansion" "escaping non-printing characters"
10562 .cindex "&%escape%& expansion item"
10563 If the string contains any non-printing characters, they are converted to
10564 escape sequences starting with a backslash. Whether characters with the most
10565 significant bit set (so-called &"8-bit characters"&) count as printing or not
10566 is controlled by the &%print_topbitchars%& option.
10567
10568 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10569 .cindex "expansion" "escaping 8-bit characters"
10570 .cindex "&%escape8bit%& expansion item"
10571 If the string contains and characters with the most significant bit set,
10572 they are converted to escape sequences starting with a backslash.
10573 Backslashes and DEL characters are also converted.
10574
10575
10576 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10577 .cindex "expansion" "expression evaluation"
10578 .cindex "expansion" "arithmetic expression"
10579 .cindex "&%eval%& expansion item"
10580 These items supports simple arithmetic and bitwise logical operations in
10581 expansion strings. The string (after expansion) must be a conventional
10582 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10583 logical operators, and parentheses. All operations are carried out using
10584 integer arithmetic. The operator priorities are as follows (the same as in the
10585 C programming language):
10586 .table2 70pt 300pt
10587 .irow &'highest:'& "not (~), negate (-)"
10588 .irow ""   "multiply (*), divide (/), remainder (%)"
10589 .irow ""   "plus (+), minus (-)"
10590 .irow ""   "shift-left (<<), shift-right (>>)"
10591 .irow ""   "and (&&)"
10592 .irow ""   "xor (^)"
10593 .irow &'lowest:'&  "or (|)"
10594 .endtable
10595 Binary operators with the same priority are evaluated from left to right. White
10596 space is permitted before or after operators.
10597
10598 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10599 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10600 decimal, even if they start with a leading zero; hexadecimal numbers are not
10601 permitted. This can be useful when processing numbers extracted from dates or
10602 times, which often do have leading zeros.
10603
10604 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10605 or 1024*1024*1024,
10606 respectively. Negative numbers are supported. The result of the computation is
10607 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10608
10609 .display
10610 &`${eval:1+1}            `&  yields 2
10611 &`${eval:1+2*3}          `&  yields 7
10612 &`${eval:(1+2)*3}        `&  yields 9
10613 &`${eval:2+42%5}         `&  yields 4
10614 &`${eval:0xc&amp;5}          `&  yields 4
10615 &`${eval:0xc|5}          `&  yields 13
10616 &`${eval:0xc^5}          `&  yields 9
10617 &`${eval:0xc>>1}         `&  yields 6
10618 &`${eval:0xc<<1}         `&  yields 24
10619 &`${eval:~255&amp;0x1234}    `&  yields 4608
10620 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10621 .endd
10622
10623 As a more realistic example, in an ACL you might have
10624 .code
10625 deny   message = Too many bad recipients
10626        condition =                    \
10627          ${if and {                   \
10628            {>{$rcpt_count}{10}}       \
10629            {                          \
10630            <                          \
10631              {$recipients_count}      \
10632              {${eval:$rcpt_count/2}}  \
10633            }                          \
10634          }{yes}{no}}
10635 .endd
10636 The condition is true if there have been more than 10 RCPT commands and
10637 fewer than half of them have resulted in a valid recipient.
10638
10639
10640 .vitem &*${expand:*&<&'string'&>&*}*&
10641 .cindex "expansion" "re-expansion of substring"
10642 The &%expand%& operator causes a string to be expanded for a second time. For
10643 example,
10644 .code
10645 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10646 .endd
10647 first looks up a string in a file while expanding the operand for &%expand%&,
10648 and then re-expands what it has found.
10649
10650
10651 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10652 .cindex "Unicode"
10653 .cindex "UTF-8" "conversion from"
10654 .cindex "expansion" "UTF-8 conversion"
10655 .cindex "&%from_utf8%& expansion item"
10656 The world is slowly moving towards Unicode, although there are no standards for
10657 email yet. However, other applications (including some databases) are starting
10658 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10659 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10660 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10661 the result is an undefined sequence of bytes.
10662
10663 Unicode code points with values less than 256 are compatible with ASCII and
10664 ISO-8859-1 (also known as Latin-1).
10665 For example, character 169 is the copyright symbol in both cases, though the
10666 way it is encoded is different. In UTF-8, more than one byte is needed for
10667 characters with code values greater than 127, whereas ISO-8859-1 is a
10668 single-byte encoding (but thereby limited to 256 characters). This makes
10669 translation from UTF-8 to ISO-8859-1 straightforward.
10670
10671
10672 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10673 .cindex "hash function" "textual"
10674 .cindex "expansion" "textual hash"
10675 The &%hash%& operator is a simpler interface to the hashing function that can
10676 be used when the two parameters are fixed numbers (as opposed to strings that
10677 change when expanded). The effect is the same as
10678 .code
10679 ${hash{<n>}{<m>}{<string>}}
10680 .endd
10681 See the description of the general &%hash%& item above for details. The
10682 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10683
10684
10685
10686 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10687 .cindex "base64 encoding" "conversion from hex"
10688 .cindex "expansion" "hex to base64"
10689 .cindex "&%hex2b64%& expansion item"
10690 This operator converts a hex string into one that is base64 encoded. This can
10691 be useful for processing the output of the various hashing functions.
10692
10693
10694
10695 .vitem &*${hexquote:*&<&'string'&>&*}*&
10696 .cindex "quoting" "hex-encoded unprintable characters"
10697 .cindex "&%hexquote%& expansion item"
10698 This operator converts non-printable characters in a string into a hex
10699 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10700 as is, and other byte values are converted to &`\xNN`&, for example, a
10701 byte value 127 is converted to &`\x7f`&.
10702
10703
10704 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10705 .cindex "&%ipv6denorm%& expansion item"
10706 .cindex "IP address" normalisation
10707 This expands an IPv6 address to a full eight-element colon-separated set
10708 of hex digits including leading zeroes.
10709 A trailing ipv4-style dotted-decimal set is converted to hex.
10710 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10711
10712 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10713 .cindex "&%ipv6norm%& expansion item"
10714 .cindex "IP address" normalisation
10715 .cindex "IP address" "canonical form"
10716 This converts an IPv6 address to canonical form.
10717 Leading zeroes of groups are omitted, and the longest
10718 set of zero-valued groups is replaced with a double colon.
10719 A trailing ipv4-style dotted-decimal set is converted to hex.
10720 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10721
10722
10723 .vitem &*${lc:*&<&'string'&>&*}*&
10724 .cindex "case forcing in strings"
10725 .cindex "string" "case forcing"
10726 .cindex "lower casing"
10727 .cindex "expansion" "case forcing"
10728 .cindex "&%lc%& expansion item"
10729 This forces the letters in the string into lower-case, for example:
10730 .code
10731 ${lc:$local_part}
10732 .endd
10733 Case is defined per the system C locale.
10734
10735 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10736 .cindex "expansion" "string truncation"
10737 .cindex "&%length%& expansion item"
10738 The &%length%& operator is a simpler interface to the &%length%& function that
10739 can be used when the parameter is a fixed number (as opposed to a string that
10740 changes when expanded). The effect is the same as
10741 .code
10742 ${length{<number>}{<string>}}
10743 .endd
10744 See the description of the general &%length%& item above for details. Note that
10745 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10746 when &%length%& is used as an operator.
10747 All measurement is done in bytes and is not UTF-8 aware.
10748
10749
10750 .vitem &*${listcount:*&<&'string'&>&*}*&
10751 .cindex "expansion" "list item count"
10752 .cindex "list" "item count"
10753 .cindex "list" "count of items"
10754 .cindex "&%listcount%& expansion item"
10755 The string is interpreted as a list and the number of items is returned.
10756
10757
10758 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10759 .cindex "expansion" "named list"
10760 .cindex "&%listnamed%& expansion item"
10761 The name is interpreted as a named list and the content of the list is returned,
10762 expanding any referenced lists, re-quoting as needed for colon-separation.
10763 If the optional type is given it must be one of "a", "d", "h" or "l"
10764 and selects address-, domain-, host- or localpart- lists to search among respectively.
10765 Otherwise all types are searched in an undefined order and the first
10766 matching list is returned.
10767
10768
10769 .vitem &*${local_part:*&<&'string'&>&*}*&
10770 .cindex "expansion" "local part extraction"
10771 .cindex "&%local_part%& expansion item"
10772 The string is interpreted as an RFC 2822 address and the local part is
10773 extracted from it. If the string does not parse successfully, the result is
10774 empty.
10775 The parsing correctly handles SMTPUTF8 Unicode in the string.
10776
10777
10778 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10779 .cindex "masked IP address"
10780 .cindex "IP address" "masking"
10781 .cindex "CIDR notation"
10782 .cindex "expansion" "IP address masking"
10783 .cindex "&%mask%& expansion item"
10784 If the form of the string to be operated on is not an IP address followed by a
10785 slash and an integer (that is, a network address in CIDR notation), the
10786 expansion fails. Otherwise, this operator converts the IP address to binary,
10787 masks off the least significant bits according to the bit count, and converts
10788 the result back to text, with mask appended. For example,
10789 .code
10790 ${mask:10.111.131.206/28}
10791 .endd
10792 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10793 be mostly used for looking up masked addresses in files, the result for an IPv6
10794 address uses dots to separate components instead of colons, because colon
10795 terminates a key string in lsearch files. So, for example,
10796 .code
10797 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10798 .endd
10799 returns the string
10800 .code
10801 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10802 .endd
10803 Letters in IPv6 addresses are always output in lower case.
10804
10805
10806 .vitem &*${md5:*&<&'string'&>&*}*&
10807 .cindex "MD5 hash"
10808 .cindex "expansion" "MD5 hash"
10809 .cindex certificate fingerprint
10810 .cindex "&%md5%& expansion item"
10811 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10812 as a 32-digit hexadecimal number, in which any letters are in lower case.
10813
10814 If the string is a single variable of type certificate,
10815 returns the MD5 hash fingerprint of the certificate.
10816
10817
10818 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10819 .cindex "expansion" "numeric hash"
10820 .cindex "hash function" "numeric"
10821 The &%nhash%& operator is a simpler interface to the numeric hashing function
10822 that can be used when the two parameters are fixed numbers (as opposed to
10823 strings that change when expanded). The effect is the same as
10824 .code
10825 ${nhash{<n>}{<m>}{<string>}}
10826 .endd
10827 See the description of the general &%nhash%& item above for details.
10828
10829
10830 .vitem &*${quote:*&<&'string'&>&*}*&
10831 .cindex "quoting" "in string expansions"
10832 .cindex "expansion" "quoting"
10833 .cindex "&%quote%& expansion item"
10834 The &%quote%& operator puts its argument into double quotes if it
10835 is an empty string or
10836 contains anything other than letters, digits, underscores, dots, and hyphens.
10837 Any occurrences of double quotes and backslashes are escaped with a backslash.
10838 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10839 respectively For example,
10840 .code
10841 ${quote:ab"*"cd}
10842 .endd
10843 becomes
10844 .code
10845 "ab\"*\"cd"
10846 .endd
10847 The place where this is useful is when the argument is a substitution from a
10848 variable or a message header.
10849
10850 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10851 .cindex "&%quote_local_part%& expansion item"
10852 This operator is like &%quote%&, except that it quotes the string only if
10853 required to do so by the rules of RFC 2822 for quoting local parts. For
10854 example, a plus sign would not cause quoting (but it would for &%quote%&).
10855 If you are creating a new email address from the contents of &$local_part$&
10856 (or any other unknown data), you should always use this operator.
10857
10858 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10859 will likely use the quoting form.
10860 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10861
10862
10863 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10864 .cindex "quoting" "lookup-specific"
10865 This operator applies lookup-specific quoting rules to the string. Each
10866 query-style lookup type has its own quoting rules which are described with
10867 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10868 .code
10869 ${quote_ldap:two * two}
10870 .endd
10871 returns
10872 .code
10873 two%20%5C2A%20two
10874 .endd
10875 For single-key lookup types, no quoting is ever necessary and this operator
10876 yields an unchanged string.
10877
10878
10879 .vitem &*${randint:*&<&'n'&>&*}*&
10880 .cindex "random number"
10881 This operator returns a somewhat random number which is less than the
10882 supplied number and is at least 0.  The quality of this randomness depends
10883 on how Exim was built; the values are not suitable for keying material.
10884 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10885 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10886 for versions of GnuTLS with that function.
10887 Otherwise, the implementation may be arc4random(), random() seeded by
10888 srandomdev() or srandom(), or a custom implementation even weaker than
10889 random().
10890
10891
10892 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10893 .cindex "expansion" "IP address"
10894 This operator reverses an IP address; for IPv4 addresses, the result is in
10895 dotted-quad decimal form, while for IPv6 addresses the result is in
10896 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10897 for DNS.  For example,
10898 .code
10899 ${reverse_ip:192.0.2.4}
10900 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10901 .endd
10902 returns
10903 .code
10904 4.2.0.192
10905 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
10906 .endd
10907
10908
10909 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10910 .cindex "expansion" "RFC 2047"
10911 .cindex "RFC 2047" "expansion operator"
10912 .cindex "&%rfc2047%& expansion item"
10913 This operator encodes text according to the rules of RFC 2047. This is an
10914 encoding that is used in header lines to encode non-ASCII characters. It is
10915 assumed that the input string is in the encoding specified by the
10916 &%headers_charset%& option, which gets its default at build time. If the string
10917 contains only characters in the range 33&--126, and no instances of the
10918 characters
10919 .code
10920 ? = ( ) < > @ , ; : \ " . [ ] _
10921 .endd
10922 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10923 string, using as many &"encoded words"& as necessary to encode all the
10924 characters.
10925
10926
10927 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10928 .cindex "expansion" "RFC 2047"
10929 .cindex "RFC 2047" "decoding"
10930 .cindex "&%rfc2047d%& expansion item"
10931 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10932 bytes are replaced by question marks. Characters are converted into the
10933 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10934 not recognized unless &%check_rfc2047_length%& is set false.
10935
10936 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10937 access a header line, RFC 2047 decoding is done automatically. You do not need
10938 to use this operator as well.
10939
10940
10941
10942 .vitem &*${rxquote:*&<&'string'&>&*}*&
10943 .cindex "quoting" "in regular expressions"
10944 .cindex "regular expressions" "quoting"
10945 .cindex "&%rxquote%& expansion item"
10946 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10947 characters in its argument. This is useful when substituting the values of
10948 variables or headers inside regular expressions.
10949
10950
10951 .vitem &*${sha1:*&<&'string'&>&*}*&
10952 .cindex "SHA-1 hash"
10953 .cindex "expansion" "SHA-1 hashing"
10954 .cindex certificate fingerprint
10955 .cindex "&%sha1%& expansion item"
10956 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10957 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10958
10959 If the string is a single variable of type certificate,
10960 returns the SHA-1 hash fingerprint of the certificate.
10961
10962
10963 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
10964        &*${sha2:*&<&'string'&>&*}*& &&&
10965        &*${sha2_<n>:*&<&'string'&>&*}*&
10966 .cindex "SHA-256 hash"
10967 .cindex "SHA-2 hash"
10968 .cindex certificate fingerprint
10969 .cindex "expansion" "SHA-256 hashing"
10970 .cindex "&%sha256%& expansion item"
10971 .cindex "&%sha2%& expansion item"
10972 The &%sha256%& operator computes the SHA-256 hash value of the string
10973 and returns
10974 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10975
10976 If the string is a single variable of type certificate,
10977 returns the SHA-256 hash fingerprint of the certificate.
10978
10979 .new
10980 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
10981 (except for certificates, which are not supported).
10982 Finally, if an underbar
10983 and a number is appended it specifies the output length, selecting a
10984 member of the SHA-2 family of hash functions.
10985 Values of 256, 384 and 512 are accepted, with 256 being the default.
10986 .wen
10987
10988
10989 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10990        &*${sha3_<n>:*&<&'string'&>&*}*&
10991 .cindex "SHA3 hash"
10992 .cindex "expansion" "SHA3 hashing"
10993 .cindex "&%sha3%& expansion item"
10994 The &%sha3%& operator computes the SHA3-256 hash value of the string
10995 and returns
10996 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10997
10998 If a number is appended, separated by an underbar, it specifies
10999 the output length.  Values of 224, 256, 384 and 512 are accepted;
11000 with 256 being the default.
11001
11002 The &%sha3%& expansion item is only supported if Exim has been
11003 compiled with GnuTLS 3.5.0 or later,
11004 or OpenSSL 1.1.1 or later.
11005 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11006
11007
11008 .vitem &*${stat:*&<&'string'&>&*}*&
11009 .cindex "expansion" "statting a file"
11010 .cindex "file" "extracting characteristics"
11011 .cindex "&%stat%& expansion item"
11012 The string, after expansion, must be a file path. A call to the &[stat()]&
11013 function is made for this path. If &[stat()]& fails, an error occurs and the
11014 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11015 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11016 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11017 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11018 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11019 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11020 can extract individual fields using the &%extract%& expansion item.
11021
11022 The use of the &%stat%& expansion in users' filter files can be locked out by
11023 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11024 systems for files larger than 2GB.
11025
11026 .vitem &*${str2b64:*&<&'string'&>&*}*&
11027 .cindex "&%str2b64%& expansion item"
11028 Now deprecated, a synonym for the &%base64%& expansion operator.
11029
11030
11031
11032 .vitem &*${strlen:*&<&'string'&>&*}*&
11033 .cindex "expansion" "string length"
11034 .cindex "string" "length in expansion"
11035 .cindex "&%strlen%& expansion item"
11036 The item is replace by the length of the expanded string, expressed as a
11037 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11038 All measurement is done in bytes and is not UTF-8 aware.
11039
11040
11041 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11042 .cindex "&%substr%& expansion item"
11043 .cindex "substring extraction"
11044 .cindex "expansion" "substring expansion"
11045 The &%substr%& operator is a simpler interface to the &%substr%& function that
11046 can be used when the two parameters are fixed numbers (as opposed to strings
11047 that change when expanded). The effect is the same as
11048 .code
11049 ${substr{<start>}{<length>}{<string>}}
11050 .endd
11051 See the description of the general &%substr%& item above for details. The
11052 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11053 All measurement is done in bytes and is not UTF-8 aware.
11054
11055 .vitem &*${time_eval:*&<&'string'&>&*}*&
11056 .cindex "&%time_eval%& expansion item"
11057 .cindex "time interval" "decoding"
11058 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11059 seconds.
11060
11061 .vitem &*${time_interval:*&<&'string'&>&*}*&
11062 .cindex "&%time_interval%& expansion item"
11063 .cindex "time interval" "formatting"
11064 The argument (after sub-expansion) must be a sequence of decimal digits that
11065 represents an interval of time as a number of seconds. It is converted into a
11066 number of larger units and output in Exim's normal time format, for example,
11067 &`1w3d4h2m6s`&.
11068
11069 .vitem &*${uc:*&<&'string'&>&*}*&
11070 .cindex "case forcing in strings"
11071 .cindex "string" "case forcing"
11072 .cindex "upper casing"
11073 .cindex "expansion" "case forcing"
11074 .cindex "&%uc%& expansion item"
11075 This forces the letters in the string into upper-case.
11076 Case is defined per the system C locale.
11077
11078 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11079 .cindex "correction of invalid utf-8 sequences in strings"
11080 .cindex "utf-8" "utf-8 sequences"
11081 .cindex "incorrect utf-8"
11082 .cindex "expansion" "utf-8 forcing"
11083 .cindex "&%utf8clean%& expansion item"
11084 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11085 In versions of Exim before 4.92, this did not correctly do so for a truncated
11086 final codepoint's encoding, and the character would be silently dropped.
11087 If you must handle detection of this scenario across both sets of Exim behavior,
11088 the complexity will depend upon the task.
11089 For instance, to detect if the first character is multibyte and a 1-byte
11090 extraction can be successfully used as a path component (as is common for
11091 dividing up delivery folders), you might use:
11092 .code
11093 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11094 .endd
11095 (which will false-positive if the first character of the local part is a
11096 literal question mark).
11097
11098 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11099        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11100        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11101        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11102 .cindex expansion UTF-8
11103 .cindex UTF-8 expansion
11104 .cindex EAI
11105 .cindex internationalisation
11106 .cindex "&%utf8_domain_to_alabel%& expansion item"
11107 .cindex "&%utf8_domain_from_alabel%& expansion item"
11108 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11109 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11110 These convert EAI mail name components between UTF-8 and a-label forms.
11111 For information on internationalisation support see &<<SECTi18nMTA>>&.
11112 .endlist
11113
11114
11115
11116
11117
11118
11119 .section "Expansion conditions" "SECTexpcond"
11120 .scindex IIDexpcond "expansion" "conditions"
11121 The following conditions are available for testing by the &%${if%& construct
11122 while expanding strings:
11123
11124 .vlist
11125 .vitem &*!*&<&'condition'&>
11126 .cindex "expansion" "negating a condition"
11127 .cindex "negation" "in expansion condition"
11128 Preceding any condition with an exclamation mark negates the result of the
11129 condition.
11130
11131 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11132 .cindex "numeric comparison"
11133 .cindex "expansion" "numeric comparison"
11134 There are a number of symbolic operators for doing numeric comparisons. They
11135 are:
11136 .display
11137 &`=   `&   equal
11138 &`==  `&   equal
11139 &`>   `&   greater
11140 &`>=  `&   greater or equal
11141 &`<   `&   less
11142 &`<=  `&   less or equal
11143 .endd
11144 For example:
11145 .code
11146 ${if >{$message_size}{10M} ...
11147 .endd
11148 Note that the general negation operator provides for inequality testing. The
11149 two strings must take the form of optionally signed decimal integers,
11150 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11151 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11152 As a special case, the numerical value of an empty string is taken as
11153 zero.
11154
11155 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11156 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11157 10M, not if 10M is larger than &$message_size$&.
11158
11159
11160 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11161         {*&<&'arg2'&>&*}...}*&
11162 .cindex "expansion" "calling an acl"
11163 .cindex "&%acl%&" "expansion condition"
11164 The name and zero to nine argument strings are first expanded separately.  The expanded
11165 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11166 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11167 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11168 and may use the variables; if another acl expansion is used the values
11169 are restored after it returns.  If the ACL sets
11170 a value using a "message =" modifier the variable $value becomes
11171 the result of the expansion, otherwise it is empty.
11172 If the ACL returns accept the condition is true; if deny, false.
11173 If the ACL returns defer the result is a forced-fail.
11174
11175 .vitem &*bool&~{*&<&'string'&>&*}*&
11176 .cindex "expansion" "boolean parsing"
11177 .cindex "&%bool%& expansion condition"
11178 This condition turns a string holding a true or false representation into
11179 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11180 (case-insensitively); also integer numbers map to true if non-zero,
11181 false if zero.
11182 An empty string is treated as false.
11183 Leading and trailing whitespace is ignored;
11184 thus a string consisting only of whitespace is false.
11185 All other string values will result in expansion failure.
11186
11187 When combined with ACL variables, this expansion condition will let you
11188 make decisions in one place and act on those decisions in another place.
11189 For example:
11190 .code
11191 ${if bool{$acl_m_privileged_sender} ...
11192 .endd
11193
11194
11195 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11196 .cindex "expansion" "boolean parsing"
11197 .cindex "&%bool_lax%& expansion condition"
11198 Like &%bool%&, this condition turns a string into a boolean state.  But
11199 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11200 loose definition that the Router &%condition%& option uses.  The empty string
11201 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11202 true.  Leading and trailing whitespace is ignored.
11203
11204 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11205
11206 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11207 .cindex "expansion" "encrypted comparison"
11208 .cindex "encrypted strings, comparing"
11209 .cindex "&%crypteq%& expansion condition"
11210 This condition is included in the Exim binary if it is built to support any
11211 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11212 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11213 included in the binary.
11214
11215 The &%crypteq%& condition has two arguments. The first is encrypted and
11216 compared against the second, which is already encrypted. The second string may
11217 be in the LDAP form for storing encrypted strings, which starts with the
11218 encryption type in curly brackets, followed by the data. If the second string
11219 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11220 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11221 Typically this will be a field from a password file. An example of an encrypted
11222 string in LDAP form is:
11223 .code
11224 {md5}CY9rzUYh03PK3k6DJie09g==
11225 .endd
11226 If such a string appears directly in an expansion, the curly brackets have to
11227 be quoted, because they are part of the expansion syntax. For example:
11228 .code
11229 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11230 .endd
11231 The following encryption types (whose names are matched case-independently) are
11232 supported:
11233
11234 .ilist
11235 .cindex "MD5 hash"
11236 .cindex "base64 encoding" "in encrypted password"
11237 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11238 printable characters to compare with the remainder of the second string. If the
11239 length of the comparison string is 24, Exim assumes that it is base64 encoded
11240 (as in the above example). If the length is 32, Exim assumes that it is a
11241 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11242 comparison fails.
11243
11244 .next
11245 .cindex "SHA-1 hash"
11246 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11247 printable characters to compare with the remainder of the second string. If the
11248 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11249 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11250 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11251
11252 .next
11253 .cindex "&[crypt()]&"
11254 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11255 only the first eight characters of the password. However, in modern operating
11256 systems this is no longer true, and in many cases the entire password is used,
11257 whatever its length.
11258
11259 .next
11260 .cindex "&[crypt16()]&"
11261 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11262 use up to 16 characters of the password in some operating systems. Again, in
11263 modern operating systems, more characters may be used.
11264 .endlist
11265 Exim has its own version of &[crypt16()]&, which is just a double call to
11266 &[crypt()]&. For operating systems that have their own version, setting
11267 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11268 operating system version instead of its own. This option is set by default in
11269 the OS-dependent &_Makefile_& for those operating systems that are known to
11270 support &[crypt16()]&.
11271
11272 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11273 it was not using the same algorithm as some operating systems' versions. It
11274 turns out that as well as &[crypt16()]& there is a function called
11275 &[bigcrypt()]& in some operating systems. This may or may not use the same
11276 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11277
11278 However, since there is now a move away from the traditional &[crypt()]&
11279 functions towards using SHA1 and other algorithms, tidying up this area of
11280 Exim is seen as very low priority.
11281
11282 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11283 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11284 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11285 default is &`{crypt}`&. Whatever the default, you can always use either
11286 function by specifying it explicitly in curly brackets.
11287
11288 .vitem &*def:*&<&'variable&~name'&>
11289 .cindex "expansion" "checking for empty variable"
11290 .cindex "&%def%& expansion condition"
11291 The &%def%& condition must be followed by the name of one of the expansion
11292 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11293 variable does not contain the empty string. For example:
11294 .code
11295 ${if def:sender_ident {from $sender_ident}}
11296 .endd
11297 Note that the variable name is given without a leading &%$%& character. If the
11298 variable does not exist, the expansion fails.
11299
11300 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11301         &~&*def:h_*&<&'header&~name'&>&*:*&"
11302 .cindex "expansion" "checking header line existence"
11303 This condition is true if a message is being processed and the named header
11304 exists in the message. For example,
11305 .code
11306 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11307 .endd
11308 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11309 the header name must be terminated by a colon if white space does not follow.
11310
11311 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11312        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11313 .cindex "string" "comparison"
11314 .cindex "expansion" "string comparison"
11315 .cindex "&%eq%& expansion condition"
11316 .cindex "&%eqi%& expansion condition"
11317 The two substrings are first expanded. The condition is true if the two
11318 resulting strings are identical. For &%eq%& the comparison includes the case of
11319 letters, whereas for &%eqi%& the comparison is case-independent, where
11320 case is defined per the system C locale.
11321
11322 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11323 .cindex "expansion" "file existence test"
11324 .cindex "file" "existence test"
11325 .cindex "&%exists%&, expansion condition"
11326 The substring is first expanded and then interpreted as an absolute path. The
11327 condition is true if the named file (or directory) exists. The existence test
11328 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11329 users' filter files may be locked out by the system administrator.
11330
11331 .vitem &*first_delivery*&
11332 .cindex "delivery" "first"
11333 .cindex "first delivery"
11334 .cindex "expansion" "first delivery test"
11335 .cindex "&%first_delivery%& expansion condition"
11336 This condition, which has no data, is true during a message's first delivery
11337 attempt. It is false during any subsequent delivery attempts.
11338
11339
11340 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11341        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11342 .cindex "list" "iterative conditions"
11343 .cindex "expansion" "&*forall*& condition"
11344 .cindex "expansion" "&*forany*& condition"
11345 .vindex "&$item$&"
11346 These conditions iterate over a list. The first argument is expanded to form
11347 the list. By default, the list separator is a colon, but it can be changed by
11348 the normal method (&<<SECTlistsepchange>>&).
11349 The second argument is interpreted as a condition that is to
11350 be applied to each item in the list in turn. During the interpretation of the
11351 condition, the current list item is placed in a variable called &$item$&.
11352 .ilist
11353 For &*forany*&, interpretation stops if the condition is true for any item, and
11354 the result of the whole condition is true. If the condition is false for all
11355 items in the list, the overall condition is false.
11356 .next
11357 For &*forall*&, interpretation stops if the condition is false for any item,
11358 and the result of the whole condition is false. If the condition is true for
11359 all items in the list, the overall condition is true.
11360 .endlist
11361 Note that negation of &*forany*& means that the condition must be false for all
11362 items for the overall condition to succeed, and negation of &*forall*& means
11363 that the condition must be false for at least one item. In this example, the
11364 list separator is changed to a comma:
11365 .code
11366 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11367 .endd
11368 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
11369 being processed, to enable these expansion items to be nested.
11370
11371 To scan a named list, expand it with the &*listnamed*& operator.
11372
11373 .new
11374 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11375        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11376        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11377        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11378 .cindex JSON "iterative conditions"
11379 .cindex JSON expansions
11380 .cindex expansion "&*forall_json*& condition"
11381 .cindex expansion "&*forany_json*& condition"
11382 .cindex expansion "&*forall_jsons*& condition"
11383 .cindex expansion "&*forany_jsons*& condition"
11384 As for the above, except that the first argument must, after expansion,
11385 be a JSON array.
11386 The array separator is not changeable.
11387 For the &"jsons"& variants the elements are expected to be JSON strings
11388 and have their quotes removed before the evaluation of the condition.
11389 .wen
11390
11391
11392
11393 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11394        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11395 .cindex "string" "comparison"
11396 .cindex "expansion" "string comparison"
11397 .cindex "&%ge%& expansion condition"
11398 .cindex "&%gei%& expansion condition"
11399 The two substrings are first expanded. The condition is true if the first
11400 string is lexically greater than or equal to the second string. For &%ge%& the
11401 comparison includes the case of letters, whereas for &%gei%& the comparison is
11402 case-independent.
11403 Case and collation order are defined per the system C locale.
11404
11405 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11406        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11407 .cindex "string" "comparison"
11408 .cindex "expansion" "string comparison"
11409 .cindex "&%gt%& expansion condition"
11410 .cindex "&%gti%& expansion condition"
11411 The two substrings are first expanded. The condition is true if the first
11412 string is lexically greater than the second string. For &%gt%& the comparison
11413 includes the case of letters, whereas for &%gti%& the comparison is
11414 case-independent.
11415 Case and collation order are defined per the system C locale.
11416
11417 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11418        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11419 .cindex "string" "comparison"
11420 .cindex "list" "iterative conditions"
11421 Both strings are expanded; the second string is treated as a list of simple
11422 strings; if the first string is a member of the second, then the condition
11423 is true.
11424 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11425
11426 These are simpler to use versions of the more powerful &*forany*& condition.
11427 Examples, and the &*forany*& equivalents:
11428 .code
11429 ${if inlist{needle}{foo:needle:bar}}
11430   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11431 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11432   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11433 .endd
11434
11435 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11436        &*isip4&~{*&<&'string'&>&*}*& &&&
11437        &*isip6&~{*&<&'string'&>&*}*&
11438 .cindex "IP address" "testing string format"
11439 .cindex "string" "testing for IP address"
11440 .cindex "&%isip%& expansion condition"
11441 .cindex "&%isip4%& expansion condition"
11442 .cindex "&%isip6%& expansion condition"
11443 The substring is first expanded, and then tested to see if it has the form of
11444 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11445 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11446
11447 For an IPv4 address, the test is for four dot-separated components, each of
11448 which consists of from one to three digits. For an IPv6 address, up to eight
11449 colon-separated components are permitted, each containing from one to four
11450 hexadecimal digits. There may be fewer than eight components if an empty
11451 component (adjacent colons) is present. Only one empty component is permitted.
11452
11453 &*Note*&: The checks used to be just on the form of the address; actual numerical
11454 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11455 check.
11456 This is no longer the case.
11457
11458 The main use of these tests is to distinguish between IP addresses and
11459 host names, or between IPv4 and IPv6 addresses. For example, you could use
11460 .code
11461 ${if isip4{$sender_host_address}...
11462 .endd
11463 to test which IP version an incoming SMTP connection is using.
11464
11465 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11466 .cindex "LDAP" "use for authentication"
11467 .cindex "expansion" "LDAP authentication test"
11468 .cindex "&%ldapauth%& expansion condition"
11469 This condition supports user authentication using LDAP. See section
11470 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11471 queries. For this use, the query must contain a user name and password. The
11472 query itself is not used, and can be empty. The condition is true if the
11473 password is not empty, and the user name and password are accepted by the LDAP
11474 server. An empty password is rejected without calling LDAP because LDAP binds
11475 with an empty password are considered anonymous regardless of the username, and
11476 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11477 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11478 this can be used.
11479
11480
11481 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11482        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11483 .cindex "string" "comparison"
11484 .cindex "expansion" "string comparison"
11485 .cindex "&%le%& expansion condition"
11486 .cindex "&%lei%& expansion condition"
11487 The two substrings are first expanded. The condition is true if the first
11488 string is lexically less than or equal to the second string. For &%le%& the
11489 comparison includes the case of letters, whereas for &%lei%& the comparison is
11490 case-independent.
11491 Case and collation order are defined per the system C locale.
11492
11493 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11494        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11495 .cindex "string" "comparison"
11496 .cindex "expansion" "string comparison"
11497 .cindex "&%lt%& expansion condition"
11498 .cindex "&%lti%& expansion condition"
11499 The two substrings are first expanded. The condition is true if the first
11500 string is lexically less than the second string. For &%lt%& the comparison
11501 includes the case of letters, whereas for &%lti%& the comparison is
11502 case-independent.
11503 Case and collation order are defined per the system C locale.
11504
11505
11506 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11507 .cindex "expansion" "regular expression comparison"
11508 .cindex "regular expressions" "match in expanded string"
11509 .cindex "&%match%& expansion condition"
11510 The two substrings are first expanded. The second is then treated as a regular
11511 expression and applied to the first. Because of the pre-expansion, if the
11512 regular expression contains dollar, or backslash characters, they must be
11513 escaped. Care must also be taken if the regular expression contains braces
11514 (curly brackets). A closing brace must be escaped so that it is not taken as a
11515 premature termination of <&'string2'&>. The easiest approach is to use the
11516 &`\N`& feature to disable expansion of the regular expression.
11517 For example,
11518 .code
11519 ${if match {$local_part}{\N^\d{3}\N} ...
11520 .endd
11521 If the whole expansion string is in double quotes, further escaping of
11522 backslashes is also required.
11523
11524 The condition is true if the regular expression match succeeds.
11525 The regular expression is not required to begin with a circumflex
11526 metacharacter, but if there is no circumflex, the expression is not anchored,
11527 and it may match anywhere in the subject, not just at the start. If you want
11528 the pattern to match at the end of the subject, you must include the &`$`&
11529 metacharacter at an appropriate point.
11530 All character handling is done in bytes and is not UTF-8 aware,
11531 but we might change this in a future Exim release.
11532
11533 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11534 At the start of an &%if%& expansion the values of the numeric variable
11535 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11536 succeeds causes them to be reset to the substrings of that condition and they
11537 will have these values during the expansion of the success string. At the end
11538 of the &%if%& expansion, the previous values are restored. After testing a
11539 combination of conditions using &%or%&, the subsequent values of the numeric
11540 variables are those of the condition that succeeded.
11541
11542 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11543 .cindex "&%match_address%& expansion condition"
11544 See &*match_local_part*&.
11545
11546 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11547 .cindex "&%match_domain%& expansion condition"
11548 See &*match_local_part*&.
11549
11550 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11551 .cindex "&%match_ip%& expansion condition"
11552 This condition matches an IP address to a list of IP address patterns. It must
11553 be followed by two argument strings. The first (after expansion) must be an IP
11554 address or an empty string. The second (not expanded) is a restricted host
11555 list that can match only an IP address, not a host name. For example:
11556 .code
11557 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11558 .endd
11559 The specific types of host list item that are permitted in the list are:
11560
11561 .ilist
11562 An IP address, optionally with a CIDR mask.
11563 .next
11564 A single asterisk, which matches any IP address.
11565 .next
11566 An empty item, which matches only if the IP address is empty. This could be
11567 useful for testing for a locally submitted message or one from specific hosts
11568 in a single test such as
11569 . ==== As this is a nested list, any displays it contains must be indented
11570 . ==== as otherwise they are too far to the left. This comment applies to
11571 . ==== the use of xmlto plus fop. There's no problem when formatting with
11572 . ==== sdop, with or without the extra indent.
11573 .code
11574   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11575 .endd
11576 where the first item in the list is the empty string.
11577 .next
11578 The item @[] matches any of the local host's interface addresses.
11579 .next
11580 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11581 even if &`net-`& is not specified. There is never any attempt to turn the IP
11582 address into a host name. The most common type of linear search for
11583 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11584 masks. For example:
11585 .code
11586   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11587 .endd
11588 It is of course possible to use other kinds of lookup, and in such a case, you
11589 do need to specify the &`net-`& prefix if you want to specify a specific
11590 address mask, for example:
11591 .code
11592   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11593 .endd
11594 However, unless you are combining a &%match_ip%& condition with others, it is
11595 just as easy to use the fact that a lookup is itself a condition, and write:
11596 .code
11597   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11598 .endd
11599 .endlist ilist
11600
11601 Note that <&'string2'&> is not itself subject to string expansion, unless
11602 Exim was built with the EXPAND_LISTMATCH_RHS option.
11603
11604 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11605
11606 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11607 .cindex "domain list" "in expansion condition"
11608 .cindex "address list" "in expansion condition"
11609 .cindex "local part" "list, in expansion condition"
11610 .cindex "&%match_local_part%& expansion condition"
11611 This condition, together with &%match_address%& and &%match_domain%&, make it
11612 possible to test domain, address, and local part lists within expansions. Each
11613 condition requires two arguments: an item and a list to match. A trivial
11614 example is:
11615 .code
11616 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11617 .endd
11618 In each case, the second argument may contain any of the allowable items for a
11619 list of the appropriate type. Also, because the second argument
11620 is a standard form of list, it is possible to refer to a named list.
11621 Thus, you can use conditions like this:
11622 .code
11623 ${if match_domain{$domain}{+local_domains}{...
11624 .endd
11625 .cindex "&`+caseful`&"
11626 For address lists, the matching starts off caselessly, but the &`+caseful`&
11627 item can be used, as in all address lists, to cause subsequent items to
11628 have their local parts matched casefully. Domains are always matched
11629 caselessly.
11630
11631 Note that <&'string2'&> is not itself subject to string expansion, unless
11632 Exim was built with the EXPAND_LISTMATCH_RHS option.
11633
11634 &*Note*&: Host lists are &'not'& supported in this way. This is because
11635 hosts have two identities: a name and an IP address, and it is not clear
11636 how to specify cleanly how such a test would work. However, IP addresses can be
11637 matched using &%match_ip%&.
11638
11639 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11640 .cindex "PAM authentication"
11641 .cindex "AUTH" "with PAM"
11642 .cindex "Solaris" "PAM support"
11643 .cindex "expansion" "PAM authentication test"
11644 .cindex "&%pam%& expansion condition"
11645 &'Pluggable Authentication Modules'&
11646 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11647 available in the latest releases of Solaris and in some GNU/Linux
11648 distributions. The Exim support, which is intended for use in conjunction with
11649 the SMTP AUTH command, is available only if Exim is compiled with
11650 .code
11651 SUPPORT_PAM=yes
11652 .endd
11653 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11654 in some releases of GNU/Linux &%-ldl%& is also needed.
11655
11656 The argument string is first expanded, and the result must be a
11657 colon-separated list of strings. Leading and trailing white space is ignored.
11658 The PAM module is initialized with the service name &"exim"& and the user name
11659 taken from the first item in the colon-separated data string (<&'string1'&>).
11660 The remaining items in the data string are passed over in response to requests
11661 from the authentication function. In the simple case there will only be one
11662 request, for a password, so the data consists of just two strings.
11663
11664 There can be problems if any of the strings are permitted to contain colon
11665 characters. In the usual way, these have to be doubled to avoid being taken as
11666 separators. If the data is being inserted from a variable, the &%sg%& expansion
11667 item can be used to double any existing colons. For example, the configuration
11668 of a LOGIN authenticator might contain this setting:
11669 .code
11670 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11671 .endd
11672 For a PLAIN authenticator you could use:
11673 .code
11674 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11675 .endd
11676 In some operating systems, PAM authentication can be done only from a process
11677 running as root. Since Exim is running as the Exim user when receiving
11678 messages, this means that PAM cannot be used directly in those systems.
11679 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11680
11681
11682 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11683 .cindex "&'pwcheck'& daemon"
11684 .cindex "Cyrus"
11685 .cindex "expansion" "&'pwcheck'& authentication test"
11686 .cindex "&%pwcheck%& expansion condition"
11687 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11688 This is one way of making it possible for passwords to be checked by a process
11689 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11690 deprecated. Its replacement is &'saslauthd'& (see below).
11691
11692 The pwcheck support is not included in Exim by default. You need to specify
11693 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11694 building Exim. For example:
11695 .code
11696 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11697 .endd
11698 You do not need to install the full Cyrus software suite in order to use
11699 the pwcheck daemon. You can compile and install just the daemon alone
11700 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11701 access to the &_/var/pwcheck_& directory.
11702
11703 The &%pwcheck%& condition takes one argument, which must be the user name and
11704 password, separated by a colon. For example, in a LOGIN authenticator
11705 configuration, you might have this:
11706 .code
11707 server_condition = ${if pwcheck{$auth1:$auth2}}
11708 .endd
11709 Again, for a PLAIN authenticator configuration, this would be:
11710 .code
11711 server_condition = ${if pwcheck{$auth2:$auth3}}
11712 .endd
11713 .vitem &*queue_running*&
11714 .cindex "queue runner" "detecting when delivering from"
11715 .cindex "expansion" "queue runner test"
11716 .cindex "&%queue_running%& expansion condition"
11717 This condition, which has no data, is true during delivery attempts that are
11718 initiated by queue runner processes, and false otherwise.
11719
11720
11721 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11722 .cindex "Radius"
11723 .cindex "expansion" "Radius authentication"
11724 .cindex "&%radius%& expansion condition"
11725 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11726 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11727 the Radius client configuration file in order to build Exim with Radius
11728 support.
11729
11730 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11731 library, using the original API. If you are using release 0.4.0 or later of
11732 this library, you need to set
11733 .code
11734 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11735 .endd
11736 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11737 &%libradius%& library that comes with FreeBSD. To do this, set
11738 .code
11739 RADIUS_LIB_TYPE=RADLIB
11740 .endd
11741 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11742 You may also have to supply a suitable setting in EXTRALIBS so that the
11743 Radius library can be found when Exim is linked.
11744
11745 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11746 Radius client library, which calls the Radius server. The condition is true if
11747 the authentication is successful. For example:
11748 .code
11749 server_condition = ${if radius{<arguments>}}
11750 .endd
11751
11752
11753 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11754         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11755 .cindex "&'saslauthd'& daemon"
11756 .cindex "Cyrus"
11757 .cindex "expansion" "&'saslauthd'& authentication test"
11758 .cindex "&%saslauthd%& expansion condition"
11759 This condition supports user authentication using the Cyrus &'saslauthd'&
11760 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11761 Using this daemon is one way of making it possible for passwords to be checked
11762 by a process that is not running as root.
11763
11764 The saslauthd support is not included in Exim by default. You need to specify
11765 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11766 building Exim. For example:
11767 .code
11768 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11769 .endd
11770 You do not need to install the full Cyrus software suite in order to use
11771 the saslauthd daemon. You can compile and install just the daemon alone
11772 from the Cyrus SASL library.
11773
11774 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11775 two are mandatory. For example:
11776 .code
11777 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11778 .endd
11779 The service and the realm are optional (which is why the arguments are enclosed
11780 in their own set of braces). For details of the meaning of the service and
11781 realm, and how to run the daemon, consult the Cyrus documentation.
11782 .endlist vlist
11783
11784
11785
11786 .section "Combining expansion conditions" "SECID84"
11787 .cindex "expansion" "combining conditions"
11788 Several conditions can be tested at once by combining them using the &%and%&
11789 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11790 conditions on their own, and precede their lists of sub-conditions. Each
11791 sub-condition must be enclosed in braces within the overall braces that contain
11792 the list. No repetition of &%if%& is used.
11793
11794
11795 .vlist
11796 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11797 .cindex "&""or""& expansion condition"
11798 .cindex "expansion" "&""or""& of conditions"
11799 The sub-conditions are evaluated from left to right. The condition is true if
11800 any one of the sub-conditions is true.
11801 For example,
11802 .code
11803 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11804 .endd
11805 When a true sub-condition is found, the following ones are parsed but not
11806 evaluated. If there are several &"match"& sub-conditions the values of the
11807 numeric variables afterwards are taken from the first one that succeeds.
11808
11809 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11810 .cindex "&""and""& expansion condition"
11811 .cindex "expansion" "&""and""& of conditions"
11812 The sub-conditions are evaluated from left to right. The condition is true if
11813 all of the sub-conditions are true. If there are several &"match"&
11814 sub-conditions, the values of the numeric variables afterwards are taken from
11815 the last one. When a false sub-condition is found, the following ones are
11816 parsed but not evaluated.
11817 .endlist
11818 .ecindex IIDexpcond
11819
11820
11821
11822
11823 .section "Expansion variables" "SECTexpvar"
11824 .cindex "expansion" "variables, list of"
11825 This section contains an alphabetical list of all the expansion variables. Some
11826 of them are available only when Exim is compiled with specific options such as
11827 support for TLS or the content scanning extension.
11828
11829 .vlist
11830 .vitem "&$0$&, &$1$&, etc"
11831 .cindex "numerical variables (&$1$& &$2$& etc)"
11832 When a &%match%& expansion condition succeeds, these variables contain the
11833 captured substrings identified by the regular expression during subsequent
11834 processing of the success string of the containing &%if%& expansion item.
11835 In the expansion condition case
11836 they do not retain their values afterwards; in fact, their previous
11837 values are restored at the end of processing an &%if%& item. The numerical
11838 variables may also be set externally by some other matching process which
11839 precedes the expansion of the string. For example, the commands available in
11840 Exim filter files include an &%if%& command with its own regular expression
11841 matching condition.
11842
11843 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11844 Within an acl condition, expansion condition or expansion item
11845 any arguments are copied to these variables,
11846 any unused variables being made empty.
11847
11848 .vitem "&$acl_c...$&"
11849 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11850 can be given any name that starts with &$acl_c$& and is at least six characters
11851 long, but the sixth character must be either a digit or an underscore. For
11852 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11853 variables persist throughout the lifetime of an SMTP connection. They can be
11854 used to pass information between ACLs and between different invocations of the
11855 same ACL. When a message is received, the values of these variables are saved
11856 with the message, and can be accessed by filters, routers, and transports
11857 during subsequent delivery.
11858
11859 .vitem "&$acl_m...$&"
11860 These variables are like the &$acl_c...$& variables, except that their values
11861 are reset after a message has been received. Thus, if several messages are
11862 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11863 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11864 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11865 message is received, the values of these variables are saved with the message,
11866 and can be accessed by filters, routers, and transports during subsequent
11867 delivery.
11868
11869 .vitem &$acl_narg$&
11870 Within an acl condition, expansion condition or expansion item
11871 this variable has the number of arguments.
11872
11873 .vitem &$acl_verify_message$&
11874 .vindex "&$acl_verify_message$&"
11875 After an address verification has failed, this variable contains the failure
11876 message. It retains its value for use in subsequent modifiers. The message can
11877 be preserved by coding like this:
11878 .code
11879 warn !verify = sender
11880      set acl_m0 = $acl_verify_message
11881 .endd
11882 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11883 &%log_message%& modifiers, to include information about the verification
11884 failure.
11885
11886 .vitem &$address_data$&
11887 .vindex "&$address_data$&"
11888 This variable is set by means of the &%address_data%& option in routers. The
11889 value then remains with the address while it is processed by subsequent routers
11890 and eventually a transport. If the transport is handling multiple addresses,
11891 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11892 for more details. &*Note*&: The contents of &$address_data$& are visible in
11893 user filter files.
11894
11895 If &$address_data$& is set when the routers are called from an ACL to verify
11896 a recipient address, the final value is still in the variable for subsequent
11897 conditions and modifiers of the ACL statement. If routing the address caused it
11898 to be redirected to just one address, the child address is also routed as part
11899 of the verification, and in this case the final value of &$address_data$& is
11900 from the child's routing.
11901
11902 If &$address_data$& is set when the routers are called from an ACL to verify a
11903 sender address, the final value is also preserved, but this time in
11904 &$sender_address_data$&, to distinguish it from data from a recipient
11905 address.
11906
11907 In both cases (recipient and sender verification), the value does not persist
11908 after the end of the current ACL statement. If you want to preserve
11909 these values for longer, you can save them in ACL variables.
11910
11911 .vitem &$address_file$&
11912 .vindex "&$address_file$&"
11913 When, as a result of aliasing, forwarding, or filtering, a message is directed
11914 to a specific file, this variable holds the name of the file when the transport
11915 is running. At other times, the variable is empty. For example, using the
11916 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11917 .code
11918 /home/r2d2/savemail
11919 .endd
11920 then when the &(address_file)& transport is running, &$address_file$&
11921 contains the text string &`/home/r2d2/savemail`&.
11922 .cindex "Sieve filter" "value of &$address_file$&"
11923 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11924 then up to the transport configuration to generate an appropriate absolute path
11925 to the relevant file.
11926
11927 .vitem &$address_pipe$&
11928 .vindex "&$address_pipe$&"
11929 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11930 this variable holds the pipe command when the transport is running.
11931
11932 .vitem "&$auth1$& &-- &$auth3$&"
11933 .vindex "&$auth1$&, &$auth2$&, etc"
11934 These variables are used in SMTP authenticators (see chapters
11935 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11936
11937 .vitem &$authenticated_id$&
11938 .cindex "authentication" "id"
11939 .vindex "&$authenticated_id$&"
11940 When a server successfully authenticates a client it may be configured to
11941 preserve some of the authentication information in the variable
11942 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11943 user/password authenticator configuration might preserve the user name for use
11944 in the routers. Note that this is not the same information that is saved in
11945 &$sender_host_authenticated$&.
11946
11947 When a message is submitted locally (that is, not over a TCP connection)
11948 the value of &$authenticated_id$& is normally the login name of the calling
11949 process. However, a trusted user can override this by means of the &%-oMai%&
11950 command line option.
11951 This second case also sets up information used by the
11952 &$authresults$& expansion item.
11953
11954 .vitem &$authenticated_fail_id$&
11955 .cindex "authentication" "fail" "id"
11956 .vindex "&$authenticated_fail_id$&"
11957 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11958 will contain the failed authentication id. If more than one authentication
11959 id is attempted, it will contain only the last one. The variable is
11960 available for processing in the ACL's, generally the quit or notquit ACL.
11961 A message to a local recipient could still be accepted without requiring
11962 authentication, which means this variable could also be visible in all of
11963 the ACL's as well.
11964
11965
11966 .vitem &$authenticated_sender$&
11967 .cindex "sender" "authenticated"
11968 .cindex "authentication" "sender"
11969 .cindex "AUTH" "on MAIL command"
11970 .vindex "&$authenticated_sender$&"
11971 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11972 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11973 described in section &<<SECTauthparamail>>&. Unless the data is the string
11974 &"<>"&, it is set as the authenticated sender of the message, and the value is
11975 available during delivery in the &$authenticated_sender$& variable. If the
11976 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11977
11978 .vindex "&$qualify_domain$&"
11979 When a message is submitted locally (that is, not over a TCP connection), the
11980 value of &$authenticated_sender$& is an address constructed from the login
11981 name of the calling process and &$qualify_domain$&, except that a trusted user
11982 can override this by means of the &%-oMas%& command line option.
11983
11984
11985 .vitem &$authentication_failed$&
11986 .cindex "authentication" "failure"
11987 .vindex "&$authentication_failed$&"
11988 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11989 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11990 possible to distinguish between &"did not try to authenticate"&
11991 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11992 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11993 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11994 negative response to an AUTH command, including (for example) an attempt to use
11995 an undefined mechanism.
11996
11997 .vitem &$av_failed$&
11998 .cindex "content scanning" "AV scanner failure"
11999 This variable is available when Exim is compiled with the content-scanning
12000 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12001 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12002 the ACL malware condition.
12003
12004 .vitem &$body_linecount$&
12005 .cindex "message body" "line count"
12006 .cindex "body of message" "line count"
12007 .vindex "&$body_linecount$&"
12008 When a message is being received or delivered, this variable contains the
12009 number of lines in the message's body. See also &$message_linecount$&.
12010
12011 .vitem &$body_zerocount$&
12012 .cindex "message body" "binary zero count"
12013 .cindex "body of message" "binary zero count"
12014 .cindex "binary zero" "in message body"
12015 .vindex "&$body_zerocount$&"
12016 When a message is being received or delivered, this variable contains the
12017 number of binary zero bytes (ASCII NULs) in the message's body.
12018
12019 .vitem &$bounce_recipient$&
12020 .vindex "&$bounce_recipient$&"
12021 This is set to the recipient address of a bounce message while Exim is creating
12022 it. It is useful if a customized bounce message text file is in use (see
12023 chapter &<<CHAPemsgcust>>&).
12024
12025 .vitem &$bounce_return_size_limit$&
12026 .vindex "&$bounce_return_size_limit$&"
12027 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12028 up to a multiple of 1000. It is useful when a customized error message text
12029 file is in use (see chapter &<<CHAPemsgcust>>&).
12030
12031 .vitem &$caller_gid$&
12032 .cindex "gid (group id)" "caller"
12033 .vindex "&$caller_gid$&"
12034 The real group id under which the process that called Exim was running. This is
12035 not the same as the group id of the originator of a message (see
12036 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12037 incarnation normally contains the Exim gid.
12038
12039 .vitem &$caller_uid$&
12040 .cindex "uid (user id)" "caller"
12041 .vindex "&$caller_uid$&"
12042 The real user id under which the process that called Exim was running. This is
12043 not the same as the user id of the originator of a message (see
12044 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12045 incarnation normally contains the Exim uid.
12046
12047 .vitem &$callout_address$&
12048 .vindex "&$callout_address$&"
12049 After a callout for verification, spamd or malware daemon service, the
12050 address that was connected to.
12051
12052 .vitem &$compile_number$&
12053 .vindex "&$compile_number$&"
12054 The building process for Exim keeps a count of the number
12055 of times it has been compiled. This serves to distinguish different
12056 compilations of the same version of Exim.
12057
12058 .vitem &$config_dir$&
12059 .vindex "&$config_dir$&"
12060 The directory name of the main configuration file. That is, the content of
12061 &$config_file$& with the last component stripped. The value does not
12062 contain the trailing slash. If &$config_file$& does not contain a slash,
12063 &$config_dir$& is ".".
12064
12065 .vitem &$config_file$&
12066 .vindex "&$config_file$&"
12067 The name of the main configuration file Exim is using.
12068
12069 .vitem &$dkim_verify_status$&
12070 Results of DKIM verification.
12071 For details see section &<<SECDKIMVFY>>&.
12072
12073 .vitem &$dkim_cur_signer$& &&&
12074        &$dkim_verify_reason$& &&&
12075        &$dkim_domain$& &&&
12076        &$dkim_identity$& &&&
12077        &$dkim_selector$& &&&
12078        &$dkim_algo$& &&&
12079        &$dkim_canon_body$& &&&
12080        &$dkim_canon_headers$& &&&
12081        &$dkim_copiedheaders$& &&&
12082        &$dkim_bodylength$& &&&
12083        &$dkim_created$& &&&
12084        &$dkim_expires$& &&&
12085        &$dkim_headernames$& &&&
12086        &$dkim_key_testing$& &&&
12087        &$dkim_key_nosubdomains$& &&&
12088        &$dkim_key_srvtype$& &&&
12089        &$dkim_key_granularity$& &&&
12090        &$dkim_key_notes$& &&&
12091        &$dkim_key_length$&
12092 These variables are only available within the DKIM ACL.
12093 For details see section &<<SECDKIMVFY>>&.
12094
12095 .vitem &$dkim_signers$&
12096 .vindex &$dkim_signers$&
12097 When a message has been received this variable contains
12098 a colon-separated list of signer domains and identities for the message.
12099 For details see section &<<SECDKIMVFY>>&.
12100
12101 .vitem &$dnslist_domain$& &&&
12102        &$dnslist_matched$& &&&
12103        &$dnslist_text$& &&&
12104        &$dnslist_value$&
12105 .vindex "&$dnslist_domain$&"
12106 .vindex "&$dnslist_matched$&"
12107 .vindex "&$dnslist_text$&"
12108 .vindex "&$dnslist_value$&"
12109 .cindex "black list (DNS)"
12110 When a DNS (black) list lookup succeeds, these variables are set to contain
12111 the following data from the lookup: the list's domain name, the key that was
12112 looked up, the contents of any associated TXT record, and the value from the
12113 main A record. See section &<<SECID204>>& for more details.
12114
12115 .vitem &$domain$&
12116 .vindex "&$domain$&"
12117 When an address is being routed, or delivered on its own, this variable
12118 contains the domain. Uppercase letters in the domain are converted into lower
12119 case for &$domain$&.
12120
12121 Global address rewriting happens when a message is received, so the value of
12122 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12123 is set during user filtering, but not during system filtering, because a
12124 message may have many recipients and the system filter is called just once.
12125
12126 When more than one address is being delivered at once (for example, several
12127 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12128 have the same domain. Transports can be restricted to handling only one domain
12129 at a time if the value of &$domain$& is required at transport time &-- this is
12130 the default for local transports. For further details of the environment in
12131 which local transports are run, see chapter &<<CHAPenvironment>>&.
12132
12133 .oindex "&%delay_warning_condition%&"
12134 At the end of a delivery, if all deferred addresses have the same domain, it is
12135 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12136
12137 The &$domain$& variable is also used in some other circumstances:
12138
12139 .ilist
12140 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12141 the recipient address. The domain of the &'sender'& address is in
12142 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12143 normally set during the running of the MAIL ACL. However, if the sender address
12144 is verified with a callout during the MAIL ACL, the sender domain is placed in
12145 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12146 the &(smtp)& transport.
12147
12148 .next
12149 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12150 &$domain$& contains the domain portion of the address that is being rewritten;
12151 it can be used in the expansion of the replacement address, for example, to
12152 rewrite domains by file lookup.
12153
12154 .next
12155 With one important exception, whenever a domain list is being scanned,
12156 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12157 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12158 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12159 that, in a RCPT ACL, the sender domain list can be dependent on the
12160 recipient domain (which is what is in &$domain$& at this time).
12161
12162 .next
12163 .cindex "ETRN" "value of &$domain$&"
12164 .oindex "&%smtp_etrn_command%&"
12165 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12166 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12167 .endlist
12168
12169
12170 .vitem &$domain_data$&
12171 .vindex "&$domain_data$&"
12172 When the &%domains%& option on a router matches a domain by
12173 means of a lookup, the data read by the lookup is available during the running
12174 of the router as &$domain_data$&. In addition, if the driver routes the
12175 address to a transport, the value is available in that transport. If the
12176 transport is handling multiple addresses, the value from the first address is
12177 used.
12178
12179 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12180 domain by means of a lookup. The data read by the lookup is available during
12181 the rest of the ACL statement. In all other situations, this variable expands
12182 to nothing.
12183
12184 .vitem &$exim_gid$&
12185 .vindex "&$exim_gid$&"
12186 This variable contains the numerical value of the Exim group id.
12187
12188 .vitem &$exim_path$&
12189 .vindex "&$exim_path$&"
12190 This variable contains the path to the Exim binary.
12191
12192 .vitem &$exim_uid$&
12193 .vindex "&$exim_uid$&"
12194 This variable contains the numerical value of the Exim user id.
12195
12196 .vitem &$exim_version$&
12197 .vindex "&$exim_version$&"
12198 This variable contains the version string of the Exim build.
12199 The first character is a major version number, currently 4.
12200 Then after a dot, the next group of digits is a minor version number.
12201 There may be other characters following the minor version.
12202 This value may be overridden by the &%exim_version%& main config option.
12203
12204 .vitem &$header_$&<&'name'&>
12205 This is not strictly an expansion variable. It is expansion syntax for
12206 inserting the message header line with the given name. Note that the name must
12207 be terminated by colon or white space, because it may contain a wide variety of
12208 characters. Note also that braces must &'not'& be used.
12209 See the full description in section &<<SECTexpansionitems>>& above.
12210
12211 .vitem &$headers_added$&
12212 .vindex "&$headers_added$&"
12213 Within an ACL this variable contains the headers added so far by
12214 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12215 The headers are a newline-separated list.
12216
12217 .vitem &$home$&
12218 .vindex "&$home$&"
12219 When the &%check_local_user%& option is set for a router, the user's home
12220 directory is placed in &$home$& when the check succeeds. In particular, this
12221 means it is set during the running of users' filter files. A router may also
12222 explicitly set a home directory for use by a transport; this can be overridden
12223 by a setting on the transport itself.
12224
12225 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12226 of the environment variable HOME, which is subject to the
12227 &%keep_environment%& and &%add_environment%& main config options.
12228
12229 .vitem &$host$&
12230 .vindex "&$host$&"
12231 If a router assigns an address to a transport (any transport), and passes a
12232 list of hosts with the address, the value of &$host$& when the transport starts
12233 to run is the name of the first host on the list. Note that this applies both
12234 to local and remote transports.
12235
12236 .cindex "transport" "filter"
12237 .cindex "filter" "transport filter"
12238 For the &(smtp)& transport, if there is more than one host, the value of
12239 &$host$& changes as the transport works its way through the list. In
12240 particular, when the &(smtp)& transport is expanding its options for encryption
12241 using TLS, or for specifying a transport filter (see chapter
12242 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12243 is connected.
12244
12245 When used in the client part of an authenticator configuration (see chapter
12246 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12247 client is connected.
12248
12249
12250 .vitem &$host_address$&
12251 .vindex "&$host_address$&"
12252 This variable is set to the remote host's IP address whenever &$host$& is set
12253 for a remote connection. It is also set to the IP address that is being checked
12254 when the &%ignore_target_hosts%& option is being processed.
12255
12256 .vitem &$host_data$&
12257 .vindex "&$host_data$&"
12258 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12259 result of the lookup is made available in the &$host_data$& variable. This
12260 allows you, for example, to do things like this:
12261 .code
12262 deny  hosts = net-lsearch;/some/file
12263 message = $host_data
12264 .endd
12265 .vitem &$host_lookup_deferred$&
12266 .cindex "host name" "lookup, failure of"
12267 .vindex "&$host_lookup_deferred$&"
12268 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12269 message comes from a remote host and there is an attempt to look up the host's
12270 name from its IP address, and the attempt is not successful, one of these
12271 variables is set to &"1"&.
12272
12273 .ilist
12274 If the lookup receives a definite negative response (for example, a DNS lookup
12275 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12276
12277 .next
12278 If there is any kind of problem during the lookup, such that Exim cannot
12279 tell whether or not the host name is defined (for example, a timeout for a DNS
12280 lookup), &$host_lookup_deferred$& is set to &"1"&.
12281 .endlist ilist
12282
12283 Looking up a host's name from its IP address consists of more than just a
12284 single reverse lookup. Exim checks that a forward lookup of at least one of the
12285 names it receives from a reverse lookup yields the original IP address. If this
12286 is not the case, Exim does not accept the looked up name(s), and
12287 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12288 IP address (for example, the existence of a PTR record in the DNS) is not
12289 sufficient on its own for the success of a host name lookup. If the reverse
12290 lookup succeeds, but there is a lookup problem such as a timeout when checking
12291 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12292 &"1"&. See also &$sender_host_name$&.
12293
12294 .cindex authentication "expansion item"
12295 Performing these checks sets up information used by the
12296 &$authresults$& expansion item.
12297
12298
12299 .vitem &$host_lookup_failed$&
12300 .vindex "&$host_lookup_failed$&"
12301 See &$host_lookup_deferred$&.
12302
12303 .vitem &$host_port$&
12304 .vindex "&$host_port$&"
12305 This variable is set to the remote host's TCP port whenever &$host$& is set
12306 for an outbound connection.
12307
12308 .vitem &$initial_cwd$&
12309 .vindex "&$initial_cwd$&
12310 This variable contains the full path name of the initial working
12311 directory of the current Exim process. This may differ from the current
12312 working directory, as Exim changes this to "/" during early startup, and
12313 to &$spool_directory$& later.
12314
12315 .vitem &$inode$&
12316 .vindex "&$inode$&"
12317 The only time this variable is set is while expanding the &%directory_file%&
12318 option in the &(appendfile)& transport. The variable contains the inode number
12319 of the temporary file which is about to be renamed. It can be used to construct
12320 a unique name for the file.
12321
12322 .vitem &$interface_address$&
12323 .vindex "&$interface_address$&"
12324 This is an obsolete name for &$received_ip_address$&.
12325
12326 .vitem &$interface_port$&
12327 .vindex "&$interface_port$&"
12328 This is an obsolete name for &$received_port$&.
12329
12330 .vitem &$item$&
12331 .vindex "&$item$&"
12332 This variable is used during the expansion of &*forall*& and &*forany*&
12333 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12334 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12335 empty.
12336
12337 .vitem &$ldap_dn$&
12338 .vindex "&$ldap_dn$&"
12339 This variable, which is available only when Exim is compiled with LDAP support,
12340 contains the DN from the last entry in the most recently successful LDAP
12341 lookup.
12342
12343 .vitem &$load_average$&
12344 .vindex "&$load_average$&"
12345 This variable contains the system load average, multiplied by 1000 so that it
12346 is an integer. For example, if the load average is 0.21, the value of the
12347 variable is 210. The value is recomputed every time the variable is referenced.
12348
12349 .vitem &$local_part$&
12350 .vindex "&$local_part$&"
12351 When an address is being routed, or delivered on its own, this
12352 variable contains the local part. When a number of addresses are being
12353 delivered together (for example, multiple RCPT commands in an SMTP
12354 session), &$local_part$& is not set.
12355
12356 Global address rewriting happens when a message is received, so the value of
12357 &$local_part$& during routing and delivery is the value after rewriting.
12358 &$local_part$& is set during user filtering, but not during system filtering,
12359 because a message may have many recipients and the system filter is called just
12360 once.
12361
12362 .vindex "&$local_part_prefix$&"
12363 .vindex "&$local_part_suffix$&"
12364 .cindex affix variables
12365 If a local part prefix or suffix has been recognized, it is not included in the
12366 value of &$local_part$& during routing and subsequent delivery. The values of
12367 any prefix or suffix are in &$local_part_prefix$& and
12368 &$local_part_suffix$&, respectively.
12369
12370 When a message is being delivered to a file, pipe, or autoreply transport as a
12371 result of aliasing or forwarding, &$local_part$& is set to the local part of
12372 the parent address, not to the filename or command (see &$address_file$& and
12373 &$address_pipe$&).
12374
12375 When an ACL is running for a RCPT command, &$local_part$& contains the
12376 local part of the recipient address.
12377
12378 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12379 &$local_part$& contains the local part of the address that is being rewritten;
12380 it can be used in the expansion of the replacement address, for example.
12381
12382 In all cases, all quoting is removed from the local part. For example, for both
12383 the addresses
12384 .code
12385 "abc:xyz"@test.example
12386 abc\:xyz@test.example
12387 .endd
12388 the value of &$local_part$& is
12389 .code
12390 abc:xyz
12391 .endd
12392 If you use &$local_part$& to create another address, you should always wrap it
12393 inside a quoting operator. For example, in a &(redirect)& router you could
12394 have:
12395 .code
12396 data = ${quote_local_part:$local_part}@new.domain.example
12397 .endd
12398 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12399 to process local parts in a case-dependent manner in a router, you can set the
12400 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12401
12402 .vitem &$local_part_data$&
12403 .vindex "&$local_part_data$&"
12404 When the &%local_parts%& option on a router matches a local part by means of a
12405 lookup, the data read by the lookup is available during the running of the
12406 router as &$local_part_data$&. In addition, if the driver routes the address
12407 to a transport, the value is available in that transport. If the transport is
12408 handling multiple addresses, the value from the first address is used.
12409
12410 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12411 matches a local part by means of a lookup. The data read by the lookup is
12412 available during the rest of the ACL statement. In all other situations, this
12413 variable expands to nothing.
12414
12415 .vitem &$local_part_prefix$&
12416 .vindex "&$local_part_prefix$&"
12417 .cindex affix variables
12418 When an address is being routed or delivered, and a
12419 specific prefix for the local part was recognized, it is available in this
12420 variable, having been removed from &$local_part$&.
12421
12422 .vitem &$local_part_suffix$&
12423 .vindex "&$local_part_suffix$&"
12424 When an address is being routed or delivered, and a
12425 specific suffix for the local part was recognized, it is available in this
12426 variable, having been removed from &$local_part$&.
12427
12428 .vitem &$local_scan_data$&
12429 .vindex "&$local_scan_data$&"
12430 This variable contains the text returned by the &[local_scan()]& function when
12431 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12432
12433 .vitem &$local_user_gid$&
12434 .vindex "&$local_user_gid$&"
12435 See &$local_user_uid$&.
12436
12437 .vitem &$local_user_uid$&
12438 .vindex "&$local_user_uid$&"
12439 This variable and &$local_user_gid$& are set to the uid and gid after the
12440 &%check_local_user%& router precondition succeeds. This means that their values
12441 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12442 and &%condition%&), for the &%address_data%& expansion, and for any
12443 router-specific expansions. At all other times, the values in these variables
12444 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12445
12446 .vitem &$localhost_number$&
12447 .vindex "&$localhost_number$&"
12448 This contains the expanded value of the
12449 &%localhost_number%& option. The expansion happens after the main options have
12450 been read.
12451
12452 .vitem &$log_inodes$&
12453 .vindex "&$log_inodes$&"
12454 The number of free inodes in the disk partition where Exim's
12455 log files are being written. The value is recalculated whenever the variable is
12456 referenced. If the relevant file system does not have the concept of inodes,
12457 the value of is -1. See also the &%check_log_inodes%& option.
12458
12459 .vitem &$log_space$&
12460 .vindex "&$log_space$&"
12461 The amount of free space (as a number of kilobytes) in the disk
12462 partition where Exim's log files are being written. The value is recalculated
12463 whenever the variable is referenced. If the operating system does not have the
12464 ability to find the amount of free space (only true for experimental systems),
12465 the space value is -1. See also the &%check_log_space%& option.
12466
12467
12468 .vitem &$lookup_dnssec_authenticated$&
12469 .vindex "&$lookup_dnssec_authenticated$&"
12470 This variable is set after a DNS lookup done by
12471 a dnsdb lookup expansion, dnslookup router or smtp transport.
12472 .cindex "DNS" "DNSSEC"
12473 It will be empty if &(DNSSEC)& was not requested,
12474 &"no"& if the result was not labelled as authenticated data
12475 and &"yes"& if it was.
12476 Results that are labelled as authoritative answer that match
12477 the &%dns_trust_aa%& configuration variable count also
12478 as authenticated data.
12479
12480 .vitem &$mailstore_basename$&
12481 .vindex "&$mailstore_basename$&"
12482 This variable is set only when doing deliveries in &"mailstore"& format in the
12483 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12484 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12485 contains the basename of the files that are being written, that is, the name
12486 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12487 variable is empty.
12488
12489 .vitem &$malware_name$&
12490 .vindex "&$malware_name$&"
12491 This variable is available when Exim is compiled with the
12492 content-scanning extension. It is set to the name of the virus that was found
12493 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12494
12495 .vitem &$max_received_linelength$&
12496 .vindex "&$max_received_linelength$&"
12497 .cindex "maximum" "line length"
12498 .cindex "line length" "maximum"
12499 This variable contains the number of bytes in the longest line that was
12500 received as part of the message, not counting the line termination
12501 character(s).
12502 It is not valid if the &%spool_files_wireformat%& option is used.
12503
12504 .vitem &$message_age$&
12505 .cindex "message" "age of"
12506 .vindex "&$message_age$&"
12507 This variable is set at the start of a delivery attempt to contain the number
12508 of seconds since the message was received. It does not change during a single
12509 delivery attempt.
12510
12511 .vitem &$message_body$&
12512 .cindex "body of message" "expansion variable"
12513 .cindex "message body" "in expansion"
12514 .cindex "binary zero" "in message body"
12515 .vindex "&$message_body$&"
12516 .oindex "&%message_body_visible%&"
12517 This variable contains the initial portion of a message's body while it is
12518 being delivered, and is intended mainly for use in filter files. The maximum
12519 number of characters of the body that are put into the variable is set by the
12520 &%message_body_visible%& configuration option; the default is 500.
12521
12522 .oindex "&%message_body_newlines%&"
12523 By default, newlines are converted into spaces in &$message_body$&, to make it
12524 easier to search for phrases that might be split over a line break. However,
12525 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12526 zeros are always converted into spaces.
12527
12528 .vitem &$message_body_end$&
12529 .cindex "body of message" "expansion variable"
12530 .cindex "message body" "in expansion"
12531 .vindex "&$message_body_end$&"
12532 This variable contains the final portion of a message's
12533 body while it is being delivered. The format and maximum size are as for
12534 &$message_body$&.
12535
12536 .vitem &$message_body_size$&
12537 .cindex "body of message" "size"
12538 .cindex "message body" "size"
12539 .vindex "&$message_body_size$&"
12540 When a message is being delivered, this variable contains the size of the body
12541 in bytes. The count starts from the character after the blank line that
12542 separates the body from the header. Newlines are included in the count. See
12543 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12544
12545 If the spool file is wireformat
12546 (see the &%spool_files_wireformat%& main option)
12547 the CRLF line-terminators are included in the count.
12548
12549 .vitem &$message_exim_id$&
12550 .vindex "&$message_exim_id$&"
12551 When a message is being received or delivered, this variable contains the
12552 unique message id that is generated and used by Exim to identify the message.
12553 An id is not created for a message until after its header has been successfully
12554 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12555 line; it is the local id that Exim assigns to the message, for example:
12556 &`1BXTIK-0001yO-VA`&.
12557
12558 .vitem &$message_headers$&
12559 .vindex &$message_headers$&
12560 This variable contains a concatenation of all the header lines when a message
12561 is being processed, except for lines added by routers or transports. The header
12562 lines are separated by newline characters. Their contents are decoded in the
12563 same way as a header line that is inserted by &%bheader%&.
12564
12565 .vitem &$message_headers_raw$&
12566 .vindex &$message_headers_raw$&
12567 This variable is like &$message_headers$& except that no processing of the
12568 contents of header lines is done.
12569
12570 .vitem &$message_id$&
12571 This is an old name for &$message_exim_id$&. It is now deprecated.
12572
12573 .vitem &$message_linecount$&
12574 .vindex "&$message_linecount$&"
12575 This variable contains the total number of lines in the header and body of the
12576 message. Compare &$body_linecount$&, which is the count for the body only.
12577 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12578 number of lines received. Before delivery happens (that is, before filters,
12579 routers, and transports run) the count is increased to include the
12580 &'Received:'& header line that Exim standardly adds, and also any other header
12581 lines that are added by ACLs. The blank line that separates the message header
12582 from the body is not counted.
12583
12584 As with the special case of &$message_size$&, during the expansion of the
12585 appendfile transport's maildir_tag option in maildir format, the value of
12586 &$message_linecount$& is the precise size of the number of newlines in the
12587 file that has been written (minus one for the blank line between the
12588 header and the body).
12589
12590 Here is an example of the use of this variable in a DATA ACL:
12591 .code
12592 deny message   = Too many lines in message header
12593      condition = \
12594       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12595 .endd
12596 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12597 message has not yet been received.
12598
12599 This variable is not valid if the &%spool_files_wireformat%& option is used.
12600
12601 .vitem &$message_size$&
12602 .cindex "size" "of message"
12603 .cindex "message" "size"
12604 .vindex "&$message_size$&"
12605 When a message is being processed, this variable contains its size in bytes. In
12606 most cases, the size includes those headers that were received with the
12607 message, but not those (such as &'Envelope-to:'&) that are added to individual
12608 deliveries as they are written. However, there is one special case: during the
12609 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12610 doing a delivery in maildir format, the value of &$message_size$& is the
12611 precise size of the file that has been written. See also
12612 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12613
12614 .cindex "RCPT" "value of &$message_size$&"
12615 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12616 contains the size supplied on the MAIL command, or -1 if no size was given. The
12617 value may not, of course, be truthful.
12618
12619 .vitem &$mime_$&&'xxx'&
12620 A number of variables whose names start with &$mime$& are
12621 available when Exim is compiled with the content-scanning extension. For
12622 details, see section &<<SECTscanmimepart>>&.
12623
12624 .vitem "&$n0$& &-- &$n9$&"
12625 These variables are counters that can be incremented by means
12626 of the &%add%& command in filter files.
12627
12628 .vitem &$original_domain$&
12629 .vindex "&$domain$&"
12630 .vindex "&$original_domain$&"
12631 When a top-level address is being processed for delivery, this contains the
12632 same value as &$domain$&. However, if a &"child"& address (for example,
12633 generated by an alias, forward, or filter file) is being processed, this
12634 variable contains the domain of the original address (lower cased). This
12635 differs from &$parent_domain$& only when there is more than one level of
12636 aliasing or forwarding. When more than one address is being delivered in a
12637 single transport run, &$original_domain$& is not set.
12638
12639 If a new address is created by means of a &%deliver%& command in a system
12640 filter, it is set up with an artificial &"parent"& address. This has the local
12641 part &'system-filter'& and the default qualify domain.
12642
12643 .vitem &$original_local_part$&
12644 .vindex "&$local_part$&"
12645 .vindex "&$original_local_part$&"
12646 When a top-level address is being processed for delivery, this contains the
12647 same value as &$local_part$&, unless a prefix or suffix was removed from the
12648 local part, because &$original_local_part$& always contains the full local
12649 part. When a &"child"& address (for example, generated by an alias, forward, or
12650 filter file) is being processed, this variable contains the full local part of
12651 the original address.
12652
12653 If the router that did the redirection processed the local part
12654 case-insensitively, the value in &$original_local_part$& is in lower case.
12655 This variable differs from &$parent_local_part$& only when there is more than
12656 one level of aliasing or forwarding. When more than one address is being
12657 delivered in a single transport run, &$original_local_part$& is not set.
12658
12659 If a new address is created by means of a &%deliver%& command in a system
12660 filter, it is set up with an artificial &"parent"& address. This has the local
12661 part &'system-filter'& and the default qualify domain.
12662
12663 .vitem &$originator_gid$&
12664 .cindex "gid (group id)" "of originating user"
12665 .cindex "sender" "gid"
12666 .vindex "&$caller_gid$&"
12667 .vindex "&$originator_gid$&"
12668 This variable contains the value of &$caller_gid$& that was set when the
12669 message was received. For messages received via the command line, this is the
12670 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12671 normally the gid of the Exim user.
12672
12673 .vitem &$originator_uid$&
12674 .cindex "uid (user id)" "of originating user"
12675 .cindex "sender" "uid"
12676 .vindex "&$caller_uid$&"
12677 .vindex "&$originator_uid$&"
12678 The value of &$caller_uid$& that was set when the message was received. For
12679 messages received via the command line, this is the uid of the sending user.
12680 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12681 user.
12682
12683 .vitem &$parent_domain$&
12684 .vindex "&$parent_domain$&"
12685 This variable is similar to &$original_domain$& (see
12686 above), except that it refers to the immediately preceding parent address.
12687
12688 .vitem &$parent_local_part$&
12689 .vindex "&$parent_local_part$&"
12690 This variable is similar to &$original_local_part$&
12691 (see above), except that it refers to the immediately preceding parent address.
12692
12693 .vitem &$pid$&
12694 .cindex "pid (process id)" "of current process"
12695 .vindex "&$pid$&"
12696 This variable contains the current process id.
12697
12698 .vitem &$pipe_addresses$&
12699 .cindex "filter" "transport filter"
12700 .cindex "transport" "filter"
12701 .vindex "&$pipe_addresses$&"
12702 This is not an expansion variable, but is mentioned here because the string
12703 &`$pipe_addresses`& is handled specially in the command specification for the
12704 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12705 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12706 It cannot be used in general expansion strings, and provokes an &"unknown
12707 variable"& error if encountered.
12708
12709 .vitem &$primary_hostname$&
12710 .vindex "&$primary_hostname$&"
12711 This variable contains the value set by &%primary_hostname%& in the
12712 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12713 a single-component name, Exim calls &[gethostbyname()]& (or
12714 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12715 qualified host name. See also &$smtp_active_hostname$&.
12716
12717
12718 .vitem &$proxy_external_address$& &&&
12719        &$proxy_external_port$& &&&
12720        &$proxy_local_address$& &&&
12721        &$proxy_local_port$& &&&
12722        &$proxy_session$&
12723 These variables are only available when built with Proxy Protocol
12724 or SOCKS5 support.
12725 For details see chapter &<<SECTproxyInbound>>&.
12726
12727 .vitem &$prdr_requested$&
12728 .cindex "PRDR" "variable for"
12729 This variable is set to &"yes"& if PRDR was requested by the client for the
12730 current message, otherwise &"no"&.
12731
12732 .vitem &$prvscheck_address$&
12733 This variable is used in conjunction with the &%prvscheck%& expansion item,
12734 which is described in sections &<<SECTexpansionitems>>& and
12735 &<<SECTverifyPRVS>>&.
12736
12737 .vitem &$prvscheck_keynum$&
12738 This variable is used in conjunction with the &%prvscheck%& expansion item,
12739 which is described in sections &<<SECTexpansionitems>>& and
12740 &<<SECTverifyPRVS>>&.
12741
12742 .vitem &$prvscheck_result$&
12743 This variable is used in conjunction with the &%prvscheck%& expansion item,
12744 which is described in sections &<<SECTexpansionitems>>& and
12745 &<<SECTverifyPRVS>>&.
12746
12747 .vitem &$qualify_domain$&
12748 .vindex "&$qualify_domain$&"
12749 The value set for the &%qualify_domain%& option in the configuration file.
12750
12751 .vitem &$qualify_recipient$&
12752 .vindex "&$qualify_recipient$&"
12753 The value set for the &%qualify_recipient%& option in the configuration file,
12754 or if not set, the value of &$qualify_domain$&.
12755
12756 .vitem &$queue_name$&
12757 .vindex &$queue_name$&
12758 .cindex "named queues"
12759 .cindex queues named
12760 The name of the spool queue in use; empty for the default queue.
12761
12762 .vitem &$rcpt_count$&
12763 .vindex "&$rcpt_count$&"
12764 When a message is being received by SMTP, this variable contains the number of
12765 RCPT commands received for the current message. If this variable is used in a
12766 RCPT ACL, its value includes the current command.
12767
12768 .vitem &$rcpt_defer_count$&
12769 .vindex "&$rcpt_defer_count$&"
12770 .cindex "4&'xx'& responses" "count of"
12771 When a message is being received by SMTP, this variable contains the number of
12772 RCPT commands in the current message that have previously been rejected with a
12773 temporary (4&'xx'&) response.
12774
12775 .vitem &$rcpt_fail_count$&
12776 .vindex "&$rcpt_fail_count$&"
12777 When a message is being received by SMTP, this variable contains the number of
12778 RCPT commands in the current message that have previously been rejected with a
12779 permanent (5&'xx'&) response.
12780
12781 .vitem &$received_count$&
12782 .vindex "&$received_count$&"
12783 This variable contains the number of &'Received:'& header lines in the message,
12784 including the one added by Exim (so its value is always greater than zero). It
12785 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12786 delivering.
12787
12788 .vitem &$received_for$&
12789 .vindex "&$received_for$&"
12790 If there is only a single recipient address in an incoming message, this
12791 variable contains that address when the &'Received:'& header line is being
12792 built. The value is copied after recipient rewriting has happened, but before
12793 the &[local_scan()]& function is run.
12794
12795 .vitem &$received_ip_address$&
12796 .vindex "&$received_ip_address$&"
12797 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12798 variable is set to the address of the local IP interface, and &$received_port$&
12799 is set to the local port number. (The remote IP address and port are in
12800 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12801 the port value is -1 unless it has been set using the &%-oMi%& command line
12802 option.
12803
12804 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12805 could be used, for example, to make the filename for a TLS certificate depend
12806 on which interface and/or port is being used for the incoming connection. The
12807 values of &$received_ip_address$& and &$received_port$& are saved with any
12808 messages that are received, thus making these variables available at delivery
12809 time.
12810 For outbound connections see &$sending_ip_address$&.
12811
12812 .vitem &$received_port$&
12813 .vindex "&$received_port$&"
12814 See &$received_ip_address$&.
12815
12816 .vitem &$received_protocol$&
12817 .vindex "&$received_protocol$&"
12818 When a message is being processed, this variable contains the name of the
12819 protocol by which it was received. Most of the names used by Exim are defined
12820 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12821 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12822 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12823 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12824 connection and the client was successfully authenticated.
12825
12826 Exim uses the protocol name &"smtps"& for the case when encryption is
12827 automatically set up on connection without the use of STARTTLS (see
12828 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12829 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12830 where the client initially uses EHLO, sets up an encrypted connection using
12831 STARTTLS, and then uses HELO afterwards.
12832
12833 The &%-oMr%& option provides a way of specifying a custom protocol name for
12834 messages that are injected locally by trusted callers. This is commonly used to
12835 identify messages that are being re-injected after some kind of scanning.
12836
12837 .vitem &$received_time$&
12838 .vindex "&$received_time$&"
12839 This variable contains the date and time when the current message was received,
12840 as a number of seconds since the start of the Unix epoch.
12841
12842 .vitem &$recipient_data$&
12843 .vindex "&$recipient_data$&"
12844 This variable is set after an indexing lookup success in an ACL &%recipients%&
12845 condition. It contains the data from the lookup, and the value remains set
12846 until the next &%recipients%& test. Thus, you can do things like this:
12847 .display
12848 &`require recipients  = cdb*@;/some/file`&
12849 &`deny    `&&'some further test involving'& &`$recipient_data`&
12850 .endd
12851 &*Warning*&: This variable is set only when a lookup is used as an indexing
12852 method in the address list, using the semicolon syntax as in the example above.
12853 The variable is not set for a lookup that is used as part of the string
12854 expansion that all such lists undergo before being interpreted.
12855
12856 .vitem &$recipient_verify_failure$&
12857 .vindex "&$recipient_verify_failure$&"
12858 In an ACL, when a recipient verification fails, this variable contains
12859 information about the failure. It is set to one of the following words:
12860
12861 .ilist
12862 &"qualify"&: The address was unqualified (no domain), and the message
12863 was neither local nor came from an exempted host.
12864
12865 .next
12866 &"route"&: Routing failed.
12867
12868 .next
12869 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12870 or before the MAIL command (that is, on initial connection, HELO, or
12871 MAIL).
12872
12873 .next
12874 &"recipient"&: The RCPT command in a callout was rejected.
12875 .next
12876
12877 &"postmaster"&: The postmaster check in a callout was rejected.
12878 .endlist
12879
12880 The main use of this variable is expected to be to distinguish between
12881 rejections of MAIL and rejections of RCPT.
12882
12883 .vitem &$recipients$&
12884 .vindex "&$recipients$&"
12885 This variable contains a list of envelope recipients for a message. A comma and
12886 a space separate the addresses in the replacement text. However, the variable
12887 is not generally available, to prevent exposure of Bcc recipients in
12888 unprivileged users' filter files. You can use &$recipients$& only in these
12889 cases:
12890
12891 .olist
12892 In a system filter file.
12893 .next
12894 In the ACLs associated with the DATA command and with non-SMTP messages, that
12895 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12896 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12897 &%acl_not_smtp_mime%&.
12898 .next
12899 From within a &[local_scan()]& function.
12900 .endlist
12901
12902
12903 .vitem &$recipients_count$&
12904 .vindex "&$recipients_count$&"
12905 When a message is being processed, this variable contains the number of
12906 envelope recipients that came with the message. Duplicates are not excluded
12907 from the count. While a message is being received over SMTP, the number
12908 increases for each accepted recipient. It can be referenced in an ACL.
12909
12910
12911 .vitem &$regex_match_string$&
12912 .vindex "&$regex_match_string$&"
12913 This variable is set to contain the matching regular expression after a
12914 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12915
12916 .vitem "&$regex1$&, &$regex2$&, etc"
12917 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12918 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12919 these variables contain the
12920 captured substrings identified by the regular expression.
12921
12922
12923 .vitem &$reply_address$&
12924 .vindex "&$reply_address$&"
12925 When a message is being processed, this variable contains the contents of the
12926 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12927 contents of the &'From:'& header line. Apart from the removal of leading
12928 white space, the value is not processed in any way. In particular, no RFC 2047
12929 decoding or character code translation takes place.
12930
12931 .vitem &$return_path$&
12932 .vindex "&$return_path$&"
12933 When a message is being delivered, this variable contains the return path &--
12934 the sender field that will be sent as part of the envelope. It is not enclosed
12935 in <> characters. At the start of routing an address, &$return_path$& has the
12936 same value as &$sender_address$&, but if, for example, an incoming message to a
12937 mailing list has been expanded by a router which specifies a different address
12938 for bounce messages, &$return_path$& subsequently contains the new bounce
12939 address, whereas &$sender_address$& always contains the original sender address
12940 that was received with the message. In other words, &$sender_address$& contains
12941 the incoming envelope sender, and &$return_path$& contains the outgoing
12942 envelope sender.
12943
12944 .vitem &$return_size_limit$&
12945 .vindex "&$return_size_limit$&"
12946 This is an obsolete name for &$bounce_return_size_limit$&.
12947
12948 .vitem &$router_name$&
12949 .cindex "router" "name"
12950 .cindex "name" "of router"
12951 .vindex "&$router_name$&"
12952 During the running of a router this variable contains its name.
12953
12954 .vitem &$runrc$&
12955 .cindex "return code" "from &%run%& expansion"
12956 .vindex "&$runrc$&"
12957 This variable contains the return code from a command that is run by the
12958 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12959 assume the order in which option values are expanded, except for those
12960 preconditions whose order of testing is documented. Therefore, you cannot
12961 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12962 another.
12963
12964 .vitem &$self_hostname$&
12965 .oindex "&%self%&" "value of host name"
12966 .vindex "&$self_hostname$&"
12967 When an address is routed to a supposedly remote host that turns out to be the
12968 local host, what happens is controlled by the &%self%& generic router option.
12969 One of its values causes the address to be passed to another router. When this
12970 happens, &$self_hostname$& is set to the name of the local host that the
12971 original router encountered. In other circumstances its contents are null.
12972
12973 .vitem &$sender_address$&
12974 .vindex "&$sender_address$&"
12975 When a message is being processed, this variable contains the sender's address
12976 that was received in the message's envelope. The case of letters in the address
12977 is retained, in both the local part and the domain. For bounce messages, the
12978 value of this variable is the empty string. See also &$return_path$&.
12979
12980 .vitem &$sender_address_data$&
12981 .vindex "&$address_data$&"
12982 .vindex "&$sender_address_data$&"
12983 If &$address_data$& is set when the routers are called from an ACL to verify a
12984 sender address, the final value is preserved in &$sender_address_data$&, to
12985 distinguish it from data from a recipient address. The value does not persist
12986 after the end of the current ACL statement. If you want to preserve it for
12987 longer, you can save it in an ACL variable.
12988
12989 .vitem &$sender_address_domain$&
12990 .vindex "&$sender_address_domain$&"
12991 The domain portion of &$sender_address$&.
12992
12993 .vitem &$sender_address_local_part$&
12994 .vindex "&$sender_address_local_part$&"
12995 The local part portion of &$sender_address$&.
12996
12997 .vitem &$sender_data$&
12998 .vindex "&$sender_data$&"
12999 This variable is set after a lookup success in an ACL &%senders%& condition or
13000 in a router &%senders%& option. It contains the data from the lookup, and the
13001 value remains set until the next &%senders%& test. Thus, you can do things like
13002 this:
13003 .display
13004 &`require senders      = cdb*@;/some/file`&
13005 &`deny    `&&'some further test involving'& &`$sender_data`&
13006 .endd
13007 &*Warning*&: This variable is set only when a lookup is used as an indexing
13008 method in the address list, using the semicolon syntax as in the example above.
13009 The variable is not set for a lookup that is used as part of the string
13010 expansion that all such lists undergo before being interpreted.
13011
13012 .vitem &$sender_fullhost$&
13013 .vindex "&$sender_fullhost$&"
13014 When a message is received from a remote host, this variable contains the host
13015 name and IP address in a single string. It ends with the IP address in square
13016 brackets, followed by a colon and a port number if the logging of ports is
13017 enabled. The format of the rest of the string depends on whether the host
13018 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13019 looking up its IP address. (Looking up the IP address can be forced by the
13020 &%host_lookup%& option, independent of verification.) A plain host name at the
13021 start of the string is a verified host name; if this is not present,
13022 verification either failed or was not requested. A host name in parentheses is
13023 the argument of a HELO or EHLO command. This is omitted if it is identical to
13024 the verified host name or to the host's IP address in square brackets.
13025
13026 .vitem &$sender_helo_dnssec$&
13027 .vindex "&$sender_helo_dnssec$&"
13028 This boolean variable is true if a successful HELO verification was
13029 .cindex "DNS" "DNSSEC"
13030 done using DNS information the resolver library stated was authenticated data.
13031
13032 .vitem &$sender_helo_name$&
13033 .vindex "&$sender_helo_name$&"
13034 When a message is received from a remote host that has issued a HELO or EHLO
13035 command, the argument of that command is placed in this variable. It is also
13036 set if HELO or EHLO is used when a message is received using SMTP locally via
13037 the &%-bs%& or &%-bS%& options.
13038
13039 .vitem &$sender_host_address$&
13040 .vindex "&$sender_host_address$&"
13041 When a message is received from a remote host using SMTP,
13042 this variable contains that
13043 host's IP address. For locally non-SMTP submitted messages, it is empty.
13044
13045 .vitem &$sender_host_authenticated$&
13046 .vindex "&$sender_host_authenticated$&"
13047 This variable contains the name (not the public name) of the authenticator
13048 driver that successfully authenticated the client from which the message was
13049 received. It is empty if there was no successful authentication. See also
13050 &$authenticated_id$&.
13051
13052 .vitem &$sender_host_dnssec$&
13053 .vindex "&$sender_host_dnssec$&"
13054 If an attempt to populate &$sender_host_name$& has been made
13055 (by reference, &%hosts_lookup%& or
13056 otherwise) then this boolean will have been set true if, and only if, the
13057 resolver library states that both
13058 the reverse and forward DNS were authenticated data.  At all
13059 other times, this variable is false.
13060
13061 .cindex "DNS" "DNSSEC"
13062 It is likely that you will need to coerce DNSSEC support on in the resolver
13063 library, by setting:
13064 .code
13065 dns_dnssec_ok = 1
13066 .endd
13067
13068 Exim does not perform DNSSEC validation itself, instead leaving that to a
13069 validating resolver (e.g. unbound, or bind with suitable configuration).
13070
13071 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13072 mechanism in the list, then this variable will be false.
13073
13074 This requires that your system resolver library support EDNS0 (and that
13075 DNSSEC flags exist in the system headers).  If the resolver silently drops
13076 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13077 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13078
13079
13080 .vitem &$sender_host_name$&
13081 .vindex "&$sender_host_name$&"
13082 When a message is received from a remote host, this variable contains the
13083 host's name as obtained by looking up its IP address. For messages received by
13084 other means, this variable is empty.
13085
13086 .vindex "&$host_lookup_failed$&"
13087 If the host name has not previously been looked up, a reference to
13088 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13089 A looked up name is accepted only if it leads back to the original IP address
13090 via a forward lookup. If either the reverse or the forward lookup fails to find
13091 any data, or if the forward lookup does not yield the original IP address,
13092 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13093
13094 .vindex "&$host_lookup_deferred$&"
13095 However, if either of the lookups cannot be completed (for example, there is a
13096 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13097 &$host_lookup_failed$& remains set to &"0"&.
13098
13099 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13100 host name again if there is a subsequent reference to &$sender_host_name$&
13101 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13102 is set to &"1"&.
13103
13104 Exim does not automatically look up every calling host's name. If you want
13105 maximum efficiency, you should arrange your configuration so that it avoids
13106 these lookups altogether. The lookup happens only if one or more of the
13107 following are true:
13108
13109 .ilist
13110 A string containing &$sender_host_name$& is expanded.
13111 .next
13112 The calling host matches the list in &%host_lookup%&. In the default
13113 configuration, this option is set to *, so it must be changed if lookups are
13114 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13115 .next
13116 Exim needs the host name in order to test an item in a host list. The items
13117 that require this are described in sections &<<SECThoslispatnam>>& and
13118 &<<SECThoslispatnamsk>>&.
13119 .next
13120 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13121 In this case, the host name is required to compare with the name quoted in any
13122 EHLO or HELO commands that the client issues.
13123 .next
13124 The remote host issues a EHLO or HELO command that quotes one of the
13125 domains in &%helo_lookup_domains%&. The default value of this option is
13126 . ==== As this is a nested list, any displays it contains must be indented
13127 . ==== as otherwise they are too far to the left.
13128 .code
13129   helo_lookup_domains = @ : @[]
13130 .endd
13131 which causes a lookup if a remote host (incorrectly) gives the server's name or
13132 IP address in an EHLO or HELO command.
13133 .endlist
13134
13135
13136 .vitem &$sender_host_port$&
13137 .vindex "&$sender_host_port$&"
13138 When a message is received from a remote host, this variable contains the port
13139 number that was used on the remote host.
13140
13141 .vitem &$sender_ident$&
13142 .vindex "&$sender_ident$&"
13143 When a message is received from a remote host, this variable contains the
13144 identification received in response to an RFC 1413 request. When a message has
13145 been received locally, this variable contains the login name of the user that
13146 called Exim.
13147
13148 .vitem &$sender_rate_$&&'xxx'&
13149 A number of variables whose names begin &$sender_rate_$& are set as part of the
13150 &%ratelimit%& ACL condition. Details are given in section
13151 &<<SECTratelimiting>>&.
13152
13153 .vitem &$sender_rcvhost$&
13154 .cindex "DNS" "reverse lookup"
13155 .cindex "reverse DNS lookup"
13156 .vindex "&$sender_rcvhost$&"
13157 This is provided specifically for use in &'Received:'& headers. It starts with
13158 either the verified host name (as obtained from a reverse DNS lookup) or, if
13159 there is no verified host name, the IP address in square brackets. After that
13160 there may be text in parentheses. When the first item is a verified host name,
13161 the first thing in the parentheses is the IP address in square brackets,
13162 followed by a colon and a port number if port logging is enabled. When the
13163 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13164 the parentheses.
13165
13166 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13167 was used and its argument was not identical to the real host name or IP
13168 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13169 all three items are present in the parentheses, a newline and tab are inserted
13170 into the string, to improve the formatting of the &'Received:'& header.
13171
13172 .vitem &$sender_verify_failure$&
13173 .vindex "&$sender_verify_failure$&"
13174 In an ACL, when a sender verification fails, this variable contains information
13175 about the failure. The details are the same as for
13176 &$recipient_verify_failure$&.
13177
13178 .vitem &$sending_ip_address$&
13179 .vindex "&$sending_ip_address$&"
13180 This variable is set whenever an outgoing SMTP connection to another host has
13181 been set up. It contains the IP address of the local interface that is being
13182 used. This is useful if a host that has more than one IP address wants to take
13183 on different personalities depending on which one is being used. For incoming
13184 connections, see &$received_ip_address$&.
13185
13186 .vitem &$sending_port$&
13187 .vindex "&$sending_port$&"
13188 This variable is set whenever an outgoing SMTP connection to another host has
13189 been set up. It contains the local port that is being used. For incoming
13190 connections, see &$received_port$&.
13191
13192 .vitem &$smtp_active_hostname$&
13193 .vindex "&$smtp_active_hostname$&"
13194 During an incoming SMTP session, this variable contains the value of the active
13195 host name, as specified by the &%smtp_active_hostname%& option. The value of
13196 &$smtp_active_hostname$& is saved with any message that is received, so its
13197 value can be consulted during routing and delivery.
13198
13199 .vitem &$smtp_command$&
13200 .vindex "&$smtp_command$&"
13201 During the processing of an incoming SMTP command, this variable contains the
13202 entire command. This makes it possible to distinguish between HELO and EHLO in
13203 the HELO ACL, and also to distinguish between commands such as these:
13204 .code
13205 MAIL FROM:<>
13206 MAIL FROM: <>
13207 .endd
13208 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13209 command, the address in &$smtp_command$& is the original address before any
13210 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13211 the address after SMTP-time rewriting.
13212
13213 .vitem &$smtp_command_argument$&
13214 .cindex "SMTP" "command, argument for"
13215 .vindex "&$smtp_command_argument$&"
13216 While an ACL is running to check an SMTP command, this variable contains the
13217 argument, that is, the text that follows the command name, with leading white
13218 space removed. Following the introduction of &$smtp_command$&, this variable is
13219 somewhat redundant, but is retained for backwards compatibility.
13220
13221 .vitem &$smtp_command_history$&
13222 .cindex SMTP "command history"
13223 .vindex "&$smtp_command_history$&"
13224 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13225 received, in time-order left to right.  Only a limited number of commands
13226 are remembered.
13227
13228 .vitem &$smtp_count_at_connection_start$&
13229 .vindex "&$smtp_count_at_connection_start$&"
13230 This variable is set greater than zero only in processes spawned by the Exim
13231 daemon for handling incoming SMTP connections. The name is deliberately long,
13232 in order to emphasize what the contents are. When the daemon accepts a new
13233 connection, it increments this variable. A copy of the variable is passed to
13234 the child process that handles the connection, but its value is fixed, and
13235 never changes. It is only an approximation of how many incoming connections
13236 there actually are, because many other connections may come and go while a
13237 single connection is being processed. When a child process terminates, the
13238 daemon decrements its copy of the variable.
13239
13240 .vitem "&$sn0$& &-- &$sn9$&"
13241 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13242 that were current at the end of the system filter file. This allows a system
13243 filter file to set values that can be tested in users' filter files. For
13244 example, a system filter could set a value indicating how likely it is that a
13245 message is junk mail.
13246
13247 .vitem &$spam_$&&'xxx'&
13248 A number of variables whose names start with &$spam$& are available when Exim
13249 is compiled with the content-scanning extension. For details, see section
13250 &<<SECTscanspamass>>&.
13251
13252 .vitem &$spf_header_comment$& &&&
13253        &$spf_received$& &&&
13254        &$spf_result$& &&&
13255        &$spf_result_guessed$& &&&
13256        &$spf_smtp_comment$&
13257 These variables are only available if Exim is built with SPF support.
13258 For details see section &<<SECSPF>>&.
13259
13260 .vitem &$spool_directory$&
13261 .vindex "&$spool_directory$&"
13262 The name of Exim's spool directory.
13263
13264 .vitem &$spool_inodes$&
13265 .vindex "&$spool_inodes$&"
13266 The number of free inodes in the disk partition where Exim's spool files are
13267 being written. The value is recalculated whenever the variable is referenced.
13268 If the relevant file system does not have the concept of inodes, the value of
13269 is -1. See also the &%check_spool_inodes%& option.
13270
13271 .vitem &$spool_space$&
13272 .vindex "&$spool_space$&"
13273 The amount of free space (as a number of kilobytes) in the disk partition where
13274 Exim's spool files are being written. The value is recalculated whenever the
13275 variable is referenced. If the operating system does not have the ability to
13276 find the amount of free space (only true for experimental systems), the space
13277 value is -1. For example, to check in an ACL that there is at least 50
13278 megabytes free on the spool, you could write:
13279 .code
13280 condition = ${if > {$spool_space}{50000}}
13281 .endd
13282 See also the &%check_spool_space%& option.
13283
13284
13285 .vitem &$thisaddress$&
13286 .vindex "&$thisaddress$&"
13287 This variable is set only during the processing of the &%foranyaddress%&
13288 command in a filter file. Its use is explained in the description of that
13289 command, which can be found in the separate document entitled &'Exim's
13290 interfaces to mail filtering'&.
13291
13292 .vitem &$tls_in_bits$&
13293 .vindex "&$tls_in_bits$&"
13294 Contains an approximation of the TLS cipher's bit-strength
13295 on the inbound connection; the meaning of
13296 this depends upon the TLS implementation used.
13297 If TLS has not been negotiated, the value will be 0.
13298 The value of this is automatically fed into the Cyrus SASL authenticator
13299 when acting as a server, to specify the "external SSF" (a SASL term).
13300
13301 The deprecated &$tls_bits$& variable refers to the inbound side
13302 except when used in the context of an outbound SMTP delivery, when it refers to
13303 the outbound.
13304
13305 .vitem &$tls_out_bits$&
13306 .vindex "&$tls_out_bits$&"
13307 Contains an approximation of the TLS cipher's bit-strength
13308 on an outbound SMTP connection; the meaning of
13309 this depends upon the TLS implementation used.
13310 If TLS has not been negotiated, the value will be 0.
13311
13312 .vitem &$tls_in_ourcert$&
13313 .vindex "&$tls_in_ourcert$&"
13314 .cindex certificate variables
13315 This variable refers to the certificate presented to the peer of an
13316 inbound connection when the message was received.
13317 It is only useful as the argument of a
13318 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13319 or a &%def%& condition.
13320
13321 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13322 when a list of more than one
13323 file is used for &%tls_certificate%&, this variable is not reliable.
13324
13325 .vitem &$tls_in_peercert$&
13326 .vindex "&$tls_in_peercert$&"
13327 This variable refers to the certificate presented by the peer of an
13328 inbound connection when the message was received.
13329 It is only useful as the argument of a
13330 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13331 or a &%def%& condition.
13332 If certificate verification fails it may refer to a failing chain element
13333 which is not the leaf.
13334
13335 .vitem &$tls_out_ourcert$&
13336 .vindex "&$tls_out_ourcert$&"
13337 This variable refers to the certificate presented to the peer of an
13338 outbound connection.  It is only useful as the argument of a
13339 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13340 or a &%def%& condition.
13341
13342 .vitem &$tls_out_peercert$&
13343 .vindex "&$tls_out_peercert$&"
13344 This variable refers to the certificate presented by the peer of an
13345 outbound connection.  It is only useful as the argument of a
13346 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13347 or a &%def%& condition.
13348 If certificate verification fails it may refer to a failing chain element
13349 which is not the leaf.
13350
13351 .vitem &$tls_in_certificate_verified$&
13352 .vindex "&$tls_in_certificate_verified$&"
13353 This variable is set to &"1"& if a TLS certificate was verified when the
13354 message was received, and &"0"& otherwise.
13355
13356 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13357 except when used in the context of an outbound SMTP delivery, when it refers to
13358 the outbound.
13359
13360 .vitem &$tls_out_certificate_verified$&
13361 .vindex "&$tls_out_certificate_verified$&"
13362 This variable is set to &"1"& if a TLS certificate was verified when an
13363 outbound SMTP connection was made,
13364 and &"0"& otherwise.
13365
13366 .vitem &$tls_in_cipher$&
13367 .vindex "&$tls_in_cipher$&"
13368 .vindex "&$tls_cipher$&"
13369 When a message is received from a remote host over an encrypted SMTP
13370 connection, this variable is set to the cipher suite that was negotiated, for
13371 example DES-CBC3-SHA. In other circumstances, in particular, for message
13372 received over unencrypted connections, the variable is empty. Testing
13373 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13374 non-encrypted connections during ACL processing.
13375
13376 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13377 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13378 becomes the same as &$tls_out_cipher$&.
13379
13380 .new
13381 .vitem &$tls_in_cipher_std$&
13382 .vindex "&$tls_in_cipher_std$&"
13383 As above, but returning the RFC standard name for the cipher suite.
13384 .wen
13385
13386 .vitem &$tls_out_cipher$&
13387 .vindex "&$tls_out_cipher$&"
13388 This variable is
13389 cleared before any outgoing SMTP connection is made,
13390 and then set to the outgoing cipher suite if one is negotiated. See chapter
13391 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13392 details of the &(smtp)& transport.
13393
13394 ,new
13395 .vitem &$tls_out_cipher_std$&
13396 .vindex "&$tls_out_cipher_std$&"
13397 As above, but returning the RFC standard name for the cipher suite.
13398 .wen
13399
13400 .vitem &$tls_out_dane$&
13401 .vindex &$tls_out_dane$&
13402 DANE active status.  See section &<<SECDANE>>&.
13403
13404 .vitem &$tls_in_ocsp$&
13405 .vindex "&$tls_in_ocsp$&"
13406 When a message is received from a remote client connection
13407 the result of any OCSP request from the client is encoded in this variable:
13408 .code
13409 0 OCSP proof was not requested (default value)
13410 1 No response to request
13411 2 Response not verified
13412 3 Verification failed
13413 4 Verification succeeded
13414 .endd
13415
13416 .vitem &$tls_out_ocsp$&
13417 .vindex "&$tls_out_ocsp$&"
13418 When a message is sent to a remote host connection
13419 the result of any OCSP request made is encoded in this variable.
13420 See &$tls_in_ocsp$& for values.
13421
13422 .vitem &$tls_in_peerdn$&
13423 .vindex "&$tls_in_peerdn$&"
13424 .vindex "&$tls_peerdn$&"
13425 .cindex certificate "extracting fields"
13426 When a message is received from a remote host over an encrypted SMTP
13427 connection, and Exim is configured to request a certificate from the client,
13428 the value of the Distinguished Name of the certificate is made available in the
13429 &$tls_in_peerdn$& during subsequent processing.
13430 If certificate verification fails it may refer to a failing chain element
13431 which is not the leaf.
13432
13433 The deprecated &$tls_peerdn$& variable refers to the inbound side
13434 except when used in the context of an outbound SMTP delivery, when it refers to
13435 the outbound.
13436
13437 .vitem &$tls_out_peerdn$&
13438 .vindex "&$tls_out_peerdn$&"
13439 When a message is being delivered to a remote host over an encrypted SMTP
13440 connection, and Exim is configured to request a certificate from the server,
13441 the value of the Distinguished Name of the certificate is made available in the
13442 &$tls_out_peerdn$& during subsequent processing.
13443 If certificate verification fails it may refer to a failing chain element
13444 which is not the leaf.
13445
13446 .vitem &$tls_in_sni$&
13447 .vindex "&$tls_in_sni$&"
13448 .vindex "&$tls_sni$&"
13449 .cindex "TLS" "Server Name Indication"
13450 When a TLS session is being established, if the client sends the Server
13451 Name Indication extension, the value will be placed in this variable.
13452 If the variable appears in &%tls_certificate%& then this option and
13453 some others, described in &<<SECTtlssni>>&,
13454 will be re-expanded early in the TLS session, to permit
13455 a different certificate to be presented (and optionally a different key to be
13456 used) to the client, based upon the value of the SNI extension.
13457
13458 The deprecated &$tls_sni$& variable refers to the inbound side
13459 except when used in the context of an outbound SMTP delivery, when it refers to
13460 the outbound.
13461
13462 .vitem &$tls_out_sni$&
13463 .vindex "&$tls_out_sni$&"
13464 .cindex "TLS" "Server Name Indication"
13465 During outbound
13466 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13467 the transport.
13468
13469 .vitem &$tls_out_tlsa_usage$&
13470 .vindex &$tls_out_tlsa_usage$&
13471 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13472
13473 .vitem &$tod_bsdinbox$&
13474 .vindex "&$tod_bsdinbox$&"
13475 The time of day and the date, in the format required for BSD-style mailbox
13476 files, for example: Thu Oct 17 17:14:09 1995.
13477
13478 .vitem &$tod_epoch$&
13479 .vindex "&$tod_epoch$&"
13480 The time and date as a number of seconds since the start of the Unix epoch.
13481
13482 .vitem &$tod_epoch_l$&
13483 .vindex "&$tod_epoch_l$&"
13484 The time and date as a number of microseconds since the start of the Unix epoch.
13485
13486 .vitem &$tod_full$&
13487 .vindex "&$tod_full$&"
13488 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13489 +0100. The timezone is always given as a numerical offset from UTC, with
13490 positive values used for timezones that are ahead (east) of UTC, and negative
13491 values for those that are behind (west).
13492
13493 .vitem &$tod_log$&
13494 .vindex "&$tod_log$&"
13495 The time and date in the format used for writing Exim's log files, for example:
13496 1995-10-12 15:32:29, but without a timezone.
13497
13498 .vitem &$tod_logfile$&
13499 .vindex "&$tod_logfile$&"
13500 This variable contains the date in the format yyyymmdd. This is the format that
13501 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13502 flag.
13503
13504 .vitem &$tod_zone$&
13505 .vindex "&$tod_zone$&"
13506 This variable contains the numerical value of the local timezone, for example:
13507 -0500.
13508
13509 .vitem &$tod_zulu$&
13510 .vindex "&$tod_zulu$&"
13511 This variable contains the UTC date and time in &"Zulu"& format, as specified
13512 by ISO 8601, for example: 20030221154023Z.
13513
13514 .vitem &$transport_name$&
13515 .cindex "transport" "name"
13516 .cindex "name" "of transport"
13517 .vindex "&$transport_name$&"
13518 During the running of a transport, this variable contains its name.
13519
13520 .vitem &$value$&
13521 .vindex "&$value$&"
13522 This variable contains the result of an expansion lookup, extraction operation,
13523 or external command, as described above. It is also used during a
13524 &*reduce*& expansion.
13525
13526 .vitem &$verify_mode$&
13527 .vindex "&$verify_mode$&"
13528 While a router or transport is being run in verify mode or for cutthrough delivery,
13529 contains "S" for sender-verification or "R" for recipient-verification.
13530 Otherwise, empty.
13531
13532 .vitem &$version_number$&
13533 .vindex "&$version_number$&"
13534 The version number of Exim. Same as &$exim_version$&, may be overridden
13535 by the &%exim_version%& main config option.
13536
13537 .vitem &$warn_message_delay$&
13538 .vindex "&$warn_message_delay$&"
13539 This variable is set only during the creation of a message warning about a
13540 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13541
13542 .vitem &$warn_message_recipients$&
13543 .vindex "&$warn_message_recipients$&"
13544 This variable is set only during the creation of a message warning about a
13545 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13546 .endlist
13547 .ecindex IIDstrexp
13548
13549
13550
13551 . ////////////////////////////////////////////////////////////////////////////
13552 . ////////////////////////////////////////////////////////////////////////////
13553
13554 .chapter "Embedded Perl" "CHAPperl"
13555 .scindex IIDperl "Perl" "calling from Exim"
13556 Exim can be built to include an embedded Perl interpreter. When this is done,
13557 Perl subroutines can be called as part of the string expansion process. To make
13558 use of the Perl support, you need version 5.004 or later of Perl installed on
13559 your system. To include the embedded interpreter in the Exim binary, include
13560 the line
13561 .code
13562 EXIM_PERL = perl.o
13563 .endd
13564 in your &_Local/Makefile_& and then build Exim in the normal way.
13565
13566
13567 .section "Setting up so Perl can be used" "SECID85"
13568 .oindex "&%perl_startup%&"
13569 Access to Perl subroutines is via a global configuration option called
13570 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13571 no &%perl_startup%& option in the Exim configuration file then no Perl
13572 interpreter is started and there is almost no overhead for Exim (since none of
13573 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13574 option then the associated value is taken to be Perl code which is executed in
13575 a newly created Perl interpreter.
13576
13577 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13578 need backslashes before any characters to escape special meanings. The option
13579 should usually be something like
13580 .code
13581 perl_startup = do '/etc/exim.pl'
13582 .endd
13583 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13584 use from Exim. Exim can be configured either to start up a Perl interpreter as
13585 soon as it is entered, or to wait until the first time it is needed. Starting
13586 the interpreter at the beginning ensures that it is done while Exim still has
13587 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13588 fact used in a particular run. Also, note that this does not mean that Exim is
13589 necessarily running as root when Perl is called at a later time. By default,
13590 the interpreter is started only when it is needed, but this can be changed in
13591 two ways:
13592
13593 .ilist
13594 .oindex "&%perl_at_start%&"
13595 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13596 a startup when Exim is entered.
13597 .next
13598 The command line option &%-ps%& also requests a startup when Exim is entered,
13599 overriding the setting of &%perl_at_start%&.
13600 .endlist
13601
13602 There is also a command line option &%-pd%& (for delay) which suppresses the
13603 initial startup, even if &%perl_at_start%& is set.
13604
13605 .ilist
13606 .oindex "&%perl_taintmode%&"
13607 .cindex "Perl" "taintmode"
13608 To provide more security executing Perl code via the embedded Perl
13609 interpreter, the &%perl_taintmode%& option can be set. This enables the
13610 taint mode of the Perl interpreter. You are encouraged to set this
13611 option to a true value. To avoid breaking existing installations, it
13612 defaults to false.
13613
13614
13615 .section "Calling Perl subroutines" "SECID86"
13616 When the configuration file includes a &%perl_startup%& option you can make use
13617 of the string expansion item to call the Perl subroutines that are defined
13618 by the &%perl_startup%& code. The operator is used in any of the following
13619 forms:
13620 .code
13621 ${perl{foo}}
13622 ${perl{foo}{argument}}
13623 ${perl{foo}{argument1}{argument2} ... }
13624 .endd
13625 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13626 arguments may be passed. Passing more than this results in an expansion failure
13627 with an error message of the form
13628 .code
13629 Too many arguments passed to Perl subroutine "foo" (max is 8)
13630 .endd
13631 The return value of the Perl subroutine is evaluated in a scalar context before
13632 it is passed back to Exim to be inserted into the expanded string. If the
13633 return value is &'undef'&, the expansion is forced to fail in the same way as
13634 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13635 by obeying Perl's &%die%& function, the expansion fails with the error message
13636 that was passed to &%die%&.
13637
13638
13639 .section "Calling Exim functions from Perl" "SECID87"
13640 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13641 is available to call back into Exim's string expansion function. For example,
13642 the Perl code
13643 .code
13644 my $lp = Exim::expand_string('$local_part');
13645 .endd
13646 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13647 Note those are single quotes and not double quotes to protect against
13648 &$local_part$& being interpolated as a Perl variable.
13649
13650 If the string expansion is forced to fail by a &"fail"& item, the result of
13651 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13652 expansion string, the Perl call from the original expansion string fails with
13653 an appropriate error message, in the same way as if &%die%& were used.
13654
13655 .cindex "debugging" "from embedded Perl"
13656 .cindex "log" "writing from embedded Perl"
13657 Two other Exim functions are available for use from within Perl code.
13658 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13659 debugging is enabled. If you want a newline at the end, you must supply it.
13660 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13661 timestamp. In this case, you should not supply a terminating newline.
13662
13663
13664 .section "Use of standard output and error by Perl" "SECID88"
13665 .cindex "Perl" "standard output and error"
13666 You should not write to the standard error or output streams from within your
13667 Perl code, as it is not defined how these are set up. In versions of Exim
13668 before 4.50, it is possible for the standard output or error to refer to the
13669 SMTP connection during message reception via the daemon. Writing to this stream
13670 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13671 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13672 avoided, but the output is lost.
13673
13674 .cindex "Perl" "use of &%warn%&"
13675 The Perl &%warn%& statement writes to the standard error stream by default.
13676 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13677 you have no control. When Exim starts up the Perl interpreter, it arranges for
13678 output from the &%warn%& statement to be written to the Exim main log. You can
13679 change this by including appropriate Perl magic somewhere in your Perl code.
13680 For example, to discard &%warn%& output completely, you need this:
13681 .code
13682 $SIG{__WARN__} = sub { };
13683 .endd
13684 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13685 example, the code for the subroutine is empty, so it does nothing, but you can
13686 include any Perl code that you like. The text of the &%warn%& message is passed
13687 as the first subroutine argument.
13688 .ecindex IIDperl
13689
13690
13691 . ////////////////////////////////////////////////////////////////////////////
13692 . ////////////////////////////////////////////////////////////////////////////
13693
13694 .chapter "Starting the daemon and the use of network interfaces" &&&
13695          "CHAPinterfaces" &&&
13696          "Starting the daemon"
13697 .cindex "daemon" "starting"
13698 .cindex "interface" "listening"
13699 .cindex "network interface"
13700 .cindex "interface" "network"
13701 .cindex "IP address" "for listening"
13702 .cindex "daemon" "listening IP addresses"
13703 .cindex "TCP/IP" "setting listening interfaces"
13704 .cindex "TCP/IP" "setting listening ports"
13705 A host that is connected to a TCP/IP network may have one or more physical
13706 hardware network interfaces. Each of these interfaces may be configured as one
13707 or more &"logical"& interfaces, which are the entities that a program actually
13708 works with. Each of these logical interfaces is associated with an IP address.
13709 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13710 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13711 knowledge about the host's interfaces for use in three different circumstances:
13712
13713 .olist
13714 When a listening daemon is started, Exim needs to know which interfaces
13715 and ports to listen on.
13716 .next
13717 When Exim is routing an address, it needs to know which IP addresses
13718 are associated with local interfaces. This is required for the correct
13719 processing of MX lists by removing the local host and others with the
13720 same or higher priority values. Also, Exim needs to detect cases
13721 when an address is routed to an IP address that in fact belongs to the
13722 local host. Unless the &%self%& router option or the &%allow_localhost%&
13723 option of the smtp transport is set (as appropriate), this is treated
13724 as an error situation.
13725 .next
13726 When Exim connects to a remote host, it may need to know which interface to use
13727 for the outgoing connection.
13728 .endlist
13729
13730
13731 Exim's default behaviour is likely to be appropriate in the vast majority
13732 of cases. If your host has only one interface, and you want all its IP
13733 addresses to be treated in the same way, and you are using only the
13734 standard SMTP port, you should not need to take any special action. The
13735 rest of this chapter does not apply to you.
13736
13737 In a more complicated situation you may want to listen only on certain
13738 interfaces, or on different ports, and for this reason there are a number of
13739 options that can be used to influence Exim's behaviour. The rest of this
13740 chapter describes how they operate.
13741
13742 When a message is received over TCP/IP, the interface and port that were
13743 actually used are set in &$received_ip_address$& and &$received_port$&.
13744
13745
13746
13747 .section "Starting a listening daemon" "SECID89"
13748 When a listening daemon is started (by means of the &%-bd%& command line
13749 option), the interfaces and ports on which it listens are controlled by the
13750 following options:
13751
13752 .ilist
13753 &%daemon_smtp_ports%& contains a list of default ports
13754 or service names.
13755 (For backward compatibility, this option can also be specified in the singular.)
13756 .next
13757 &%local_interfaces%& contains list of interface IP addresses on which to
13758 listen. Each item may optionally also specify a port.
13759 .endlist
13760
13761 The default list separator in both cases is a colon, but this can be changed as
13762 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13763 it is usually best to change the separator to avoid having to double all the
13764 colons. For example:
13765 .code
13766 local_interfaces = <; 127.0.0.1 ; \
13767                       192.168.23.65 ; \
13768                       ::1 ; \
13769                       3ffe:ffff:836f::fe86:a061
13770 .endd
13771 There are two different formats for specifying a port along with an IP address
13772 in &%local_interfaces%&:
13773
13774 .olist
13775 The port is added onto the address with a dot separator. For example, to listen
13776 on port 1234 on two different IP addresses:
13777 .code
13778 local_interfaces = <; 192.168.23.65.1234 ; \
13779                       3ffe:ffff:836f::fe86:a061.1234
13780 .endd
13781 .next
13782 The IP address is enclosed in square brackets, and the port is added
13783 with a colon separator, for example:
13784 .code
13785 local_interfaces = <; [192.168.23.65]:1234 ; \
13786                       [3ffe:ffff:836f::fe86:a061]:1234
13787 .endd
13788 .endlist
13789
13790 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13791 default setting contains just one port:
13792 .code
13793 daemon_smtp_ports = smtp
13794 .endd
13795 If more than one port is listed, each interface that does not have its own port
13796 specified listens on all of them. Ports that are listed in
13797 &%daemon_smtp_ports%& can be identified either by name (defined in
13798 &_/etc/services_&) or by number. However, when ports are given with individual
13799 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13800
13801
13802
13803 .section "Special IP listening addresses" "SECID90"
13804 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13805 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13806 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13807 instead of setting up separate listening sockets for each interface. The
13808 default value of &%local_interfaces%& is
13809 .code
13810 local_interfaces = 0.0.0.0
13811 .endd
13812 when Exim is built without IPv6 support; otherwise it is:
13813 .code
13814 local_interfaces = <; ::0 ; 0.0.0.0
13815 .endd
13816 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13817
13818
13819
13820 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13821 The &%-oX%& command line option can be used to override the values of
13822 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13823 instance. Another way of doing this would be to use macros and the &%-D%&
13824 option. However, &%-oX%& can be used by any admin user, whereas modification of
13825 the runtime configuration by &%-D%& is allowed only when the caller is root or
13826 exim.
13827
13828 The value of &%-oX%& is a list of items. The default colon separator can be
13829 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13830 If there are any items that do not
13831 contain dots or colons (that is, are not IP addresses), the value of
13832 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13833 items that do contain dots or colons, the value of &%local_interfaces%& is
13834 replaced by those items. Thus, for example,
13835 .code
13836 -oX 1225
13837 .endd
13838 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13839 whereas
13840 .code
13841 -oX 192.168.34.5.1125
13842 .endd
13843 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13844 (However, since &%local_interfaces%& now contains no items without ports, the
13845 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13846
13847
13848
13849 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13850 .cindex "submissions protocol"
13851 .cindex "ssmtp protocol"
13852 .cindex "smtps protocol"
13853 .cindex "SMTP" "ssmtp protocol"
13854 .cindex "SMTP" "smtps protocol"
13855 Exim supports the use of TLS-on-connect, used by mail clients in the
13856 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13857 For some years, IETF Standards Track documents only blessed the
13858 STARTTLS-based Submission service (port 587) while common practice was to support
13859 the same feature set on port 465, but using TLS-on-connect.
13860 If your installation needs to provide service to mail clients
13861 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13862 the 465 TCP ports.
13863
13864 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13865 service names, connections to those ports must first establish TLS, before
13866 proceeding to the application layer use of the SMTP protocol.
13867
13868 The common use of this option is expected to be
13869 .code
13870 tls_on_connect_ports = 465
13871 .endd
13872 per RFC 8314.
13873 There is also a command line option &%-tls-on-connect%&, which forces all ports
13874 to behave in this way when a daemon is started.
13875
13876 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13877 daemon to listen on those ports. You must still specify them in
13878 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13879 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13880 connections via the daemon.)
13881
13882
13883
13884
13885 .section "IPv6 address scopes" "SECID92"
13886 .cindex "IPv6" "address scopes"
13887 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13888 can, in principle, have the same link-local IPv6 address on different
13889 interfaces. Thus, additional information is needed, over and above the IP
13890 address, to distinguish individual interfaces. A convention of using a
13891 percent sign followed by something (often the interface name) has been
13892 adopted in some cases, leading to addresses like this:
13893 .code
13894 fe80::202:b3ff:fe03:45c1%eth0
13895 .endd
13896 To accommodate this usage, a percent sign followed by an arbitrary string is
13897 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13898 to convert a textual IPv6 address for actual use. This function recognizes the
13899 percent convention in operating systems that support it, and it processes the
13900 address appropriately. Unfortunately, some older libraries have problems with
13901 &[getaddrinfo()]&. If
13902 .code
13903 IPV6_USE_INET_PTON=yes
13904 .endd
13905 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13906 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13907 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13908 function.) Of course, this means that the additional functionality of
13909 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13910
13911 .section "Disabling IPv6" "SECID93"
13912 .cindex "IPv6" "disabling"
13913 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13914 run on a host whose kernel does not support IPv6. The binary will fall back to
13915 using IPv4, but it may waste resources looking up AAAA records, and trying to
13916 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13917 .oindex "&%disable_ipv6%&"
13918 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13919 activities take place. AAAA records are never looked up, and any IPv6 addresses
13920 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13921 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13922 to handle IPv6 literal addresses.
13923
13924 On the other hand, when IPv6 is in use, there may be times when you want to
13925 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13926 option to globally suppress the lookup of AAAA records for specified domains,
13927 and you can use the &%ignore_target_hosts%& generic router option to ignore
13928 IPv6 addresses in an individual router.
13929
13930
13931
13932 .section "Examples of starting a listening daemon" "SECID94"
13933 The default case in an IPv6 environment is
13934 .code
13935 daemon_smtp_ports = smtp
13936 local_interfaces = <; ::0 ; 0.0.0.0
13937 .endd
13938 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13939 Either one or two sockets may be used, depending on the characteristics of
13940 the TCP/IP stack. (This is complicated and messy; for more information,
13941 read the comments in the &_daemon.c_& source file.)
13942
13943 To specify listening on ports 25 and 26 on all interfaces:
13944 .code
13945 daemon_smtp_ports = 25 : 26
13946 .endd
13947 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13948 .code
13949 local_interfaces = <; ::0.25     ; ::0.26 \
13950                       0.0.0.0.25 ; 0.0.0.0.26
13951 .endd
13952 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13953 IPv4 loopback address only:
13954 .code
13955 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13956 .endd
13957 To specify listening on the default port on specific interfaces only:
13958 .code
13959 local_interfaces = 10.0.0.67 : 192.168.34.67
13960 .endd
13961 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13962
13963
13964
13965 .section "Recognizing the local host" "SECTreclocipadd"
13966 The &%local_interfaces%& option is also used when Exim needs to determine
13967 whether or not an IP address refers to the local host. That is, the IP
13968 addresses of all the interfaces on which a daemon is listening are always
13969 treated as local.
13970
13971 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13972 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13973 available interfaces from the operating system, and extracts the relevant
13974 (that is, IPv4 or IPv6) addresses to use for checking.
13975
13976 Some systems set up large numbers of virtual interfaces in order to provide
13977 many virtual web servers. In this situation, you may want to listen for
13978 email on only a few of the available interfaces, but nevertheless treat all
13979 interfaces as local when routing. You can do this by setting
13980 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13981 &"all"& wildcard values. These addresses are recognized as local, but are not
13982 used for listening. Consider this example:
13983 .code
13984 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13985                       192.168.53.235 ; \
13986                       3ffe:2101:12:1:a00:20ff:fe86:a061
13987
13988 extra_local_interfaces = <; ::0 ; 0.0.0.0
13989 .endd
13990 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13991 address, but all available interface addresses are treated as local when
13992 Exim is routing.
13993
13994 In some environments the local host name may be in an MX list, but with an IP
13995 address that is not assigned to any local interface. In other cases it may be
13996 desirable to treat other host names as if they referred to the local host. Both
13997 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13998 This contains host names rather than IP addresses. When a host is referenced
13999 during routing, either via an MX record or directly, it is treated as the local
14000 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14001 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14002
14003
14004
14005 .section "Delivering to a remote host" "SECID95"
14006 Delivery to a remote host is handled by the smtp transport. By default, it
14007 allows the system's TCP/IP functions to choose which interface to use (if
14008 there is more than one) when connecting to a remote host. However, the
14009 &%interface%& option can be set to specify which interface is used. See the
14010 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14011 details.
14012
14013
14014
14015
14016 . ////////////////////////////////////////////////////////////////////////////
14017 . ////////////////////////////////////////////////////////////////////////////
14018
14019 .chapter "Main configuration" "CHAPmainconfig"
14020 .scindex IIDconfima "configuration file" "main section"
14021 .scindex IIDmaiconf "main configuration"
14022 The first part of the runtime configuration file contains three types of item:
14023
14024 .ilist
14025 Macro definitions: These lines start with an upper case letter. See section
14026 &<<SECTmacrodefs>>& for details of macro processing.
14027 .next
14028 Named list definitions: These lines start with one of the words &"domainlist"&,
14029 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14030 section &<<SECTnamedlists>>&.
14031 .next
14032 Main configuration settings: Each setting occupies one line of the file
14033 (with possible continuations). If any setting is preceded by the word
14034 &"hide"&, the &%-bP%& command line option displays its value to admin users
14035 only. See section &<<SECTcos>>& for a description of the syntax of these option
14036 settings.
14037 .endlist
14038
14039 This chapter specifies all the main configuration options, along with their
14040 types and default values. For ease of finding a particular option, they appear
14041 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14042 are now so many options, they are first listed briefly in functional groups, as
14043 an aid to finding the name of the option you are looking for. Some options are
14044 listed in more than one group.
14045
14046 .section "Miscellaneous" "SECID96"
14047 .table2
14048 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14049 .row &%debug_store%&                 "do extra internal checks"
14050 .row &%disable_ipv6%&                "do no IPv6 processing"
14051 .row &%keep_malformed%&              "for broken files &-- should not happen"
14052 .row &%localhost_number%&            "for unique message ids in clusters"
14053 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14054 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14055 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14056 .row &%print_topbitchars%&           "top-bit characters are printing"
14057 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14058 .row &%timezone%&                    "force time zone"
14059 .endtable
14060
14061
14062 .section "Exim parameters" "SECID97"
14063 .table2
14064 .row &%exim_group%&                  "override compiled-in value"
14065 .row &%exim_path%&                   "override compiled-in value"
14066 .row &%exim_user%&                   "override compiled-in value"
14067 .row &%primary_hostname%&            "default from &[uname()]&"
14068 .row &%split_spool_directory%&       "use multiple directories"
14069 .row &%spool_directory%&             "override compiled-in value"
14070 .endtable
14071
14072
14073
14074 .section "Privilege controls" "SECID98"
14075 .table2
14076 .row &%admin_groups%&                "groups that are Exim admin users"
14077 .row &%commandline_checks_require_admin%& "require admin for various checks"
14078 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14079 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14080 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14081 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14082 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14083 .row &%never_users%&                 "do not run deliveries as these"
14084 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14085 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14086 .row &%trusted_groups%&              "groups that are trusted"
14087 .row &%trusted_users%&               "users that are trusted"
14088 .endtable
14089
14090
14091
14092 .section "Logging" "SECID99"
14093 .table2
14094 .row &%event_action%&                "custom logging"
14095 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14096 .row &%log_file_path%&               "override compiled-in value"
14097 .row &%log_selector%&                "set/unset optional logging"
14098 .row &%log_timezone%&                "add timezone to log lines"
14099 .row &%message_logs%&                "create per-message logs"
14100 .row &%preserve_message_logs%&       "after message completion"
14101 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14102 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14103 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14104 .row &%syslog_facility%&             "set syslog &""facility""& field"
14105 .row &%syslog_pid%&                  "pid in syslog lines"
14106 .row &%syslog_processname%&          "set syslog &""ident""& field"
14107 .row &%syslog_timestamp%&            "timestamp syslog lines"
14108 .row &%write_rejectlog%&             "control use of message log"
14109 .endtable
14110
14111
14112
14113 .section "Frozen messages" "SECID100"
14114 .table2
14115 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14116 .row &%freeze_tell%&                 "send message when freezing"
14117 .row &%move_frozen_messages%&        "to another directory"
14118 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14119 .endtable
14120
14121
14122
14123 .section "Data lookups" "SECID101"
14124 .table2
14125 .row &%ibase_servers%&               "InterBase servers"
14126 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14127 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14128 .row &%ldap_cert_file%&              "client cert file for LDAP"
14129 .row &%ldap_cert_key%&               "client key file for LDAP"
14130 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14131 .row &%ldap_default_servers%&        "used if no server in query"
14132 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14133 .row &%ldap_start_tls%&              "require TLS within LDAP"
14134 .row &%ldap_version%&                "set protocol version"
14135 .row &%lookup_open_max%&             "lookup files held open"
14136 .row &%mysql_servers%&               "default MySQL servers"
14137 .row &%oracle_servers%&              "Oracle servers"
14138 .row &%pgsql_servers%&               "default PostgreSQL servers"
14139 .row &%sqlite_lock_timeout%&         "as it says"
14140 .endtable
14141
14142
14143
14144 .section "Message ids" "SECID102"
14145 .table2
14146 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14147 .row &%message_id_header_text%&      "ditto"
14148 .endtable
14149
14150
14151
14152 .section "Embedded Perl Startup" "SECID103"
14153 .table2
14154 .row &%perl_at_start%&               "always start the interpreter"
14155 .row &%perl_startup%&                "code to obey when starting Perl"
14156 .row &%perl_taintmode%&              "enable taint mode in Perl"
14157 .endtable
14158
14159
14160
14161 .section "Daemon" "SECID104"
14162 .table2
14163 .row &%daemon_smtp_ports%&           "default ports"
14164 .row &%daemon_startup_retries%&      "number of times to retry"
14165 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14166 .row &%extra_local_interfaces%&      "not necessarily listened on"
14167 .row &%local_interfaces%&            "on which to listen, with optional ports"
14168 .row &%pid_file_path%&               "override compiled-in value"
14169 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14170 .endtable
14171
14172
14173
14174 .section "Resource control" "SECID105"
14175 .table2
14176 .row &%check_log_inodes%&            "before accepting a message"
14177 .row &%check_log_space%&             "before accepting a message"
14178 .row &%check_spool_inodes%&          "before accepting a message"
14179 .row &%check_spool_space%&           "before accepting a message"
14180 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14181 .row &%queue_only_load%&             "queue incoming if load high"
14182 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14183 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14184 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14185 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14186 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14187 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14188 .row &%smtp_accept_max_per_connection%& "messages per connection"
14189 .row &%smtp_accept_max_per_host%&    "connections from one host"
14190 .row &%smtp_accept_queue%&           "queue mail if more connections"
14191 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14192                                            connection"
14193 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14194 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14195 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14196 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14197 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14198 .endtable
14199
14200
14201
14202 .section "Policy controls" "SECID106"
14203 .table2
14204 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14205 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14206 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14207 .row &%acl_smtp_auth%&               "ACL for AUTH"
14208 .row &%acl_smtp_connect%&            "ACL for connection"
14209 .row &%acl_smtp_data%&               "ACL for DATA"
14210 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14211 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14212 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14213 .row &%acl_smtp_expn%&               "ACL for EXPN"
14214 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14215 .row &%acl_smtp_mail%&               "ACL for MAIL"
14216 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14217 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14218 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14219 .row &%acl_smtp_predata%&            "ACL for start of data"
14220 .row &%acl_smtp_quit%&               "ACL for QUIT"
14221 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14222 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14223 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14224 .row &%av_scanner%&                  "specify virus scanner"
14225 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14226                                       words""&"
14227 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14228 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14229 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14230 .row &%header_maxsize%&              "total size of message header"
14231 .row &%header_line_maxsize%&         "individual header line limit"
14232 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14233 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14234 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14235 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14236 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14237 .row &%host_lookup%&                 "host name looked up for these hosts"
14238 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14239 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14240 .row &%host_reject_connection%&      "reject connection from these hosts"
14241 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14242 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14243 .row &%message_size_limit%&          "for all messages"
14244 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14245 .row &%spamd_address%&               "set interface to SpamAssassin"
14246 .row &%strict_acl_vars%&             "object to unset ACL variables"
14247 .endtable
14248
14249
14250
14251 .section "Callout cache" "SECID107"
14252 .table2
14253 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14254                                          item"
14255 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14256                                          item"
14257 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14258 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14259 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14260 .endtable
14261
14262
14263
14264 .section "TLS" "SECID108"
14265 .table2
14266 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14267 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14268 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14269 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14270 .row &%tls_certificate%&             "location of server certificate"
14271 .row &%tls_crl%&                     "certificate revocation list"
14272 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14273 .row &%tls_dhparam%&                 "DH parameters for server"
14274 .row &%tls_eccurve%&                 "EC curve selection for server"
14275 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14276 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14277 .row &%tls_privatekey%&              "location of server private key"
14278 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14279 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14280 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14281 .row &%tls_verify_certificates%&     "expected client certificates"
14282 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14283 .endtable
14284
14285
14286
14287 .section "Local user handling" "SECID109"
14288 .table2
14289 .row &%finduser_retries%&            "useful in NIS environments"
14290 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14291 .row &%gecos_pattern%&               "ditto"
14292 .row &%max_username_length%&         "for systems that truncate"
14293 .row &%unknown_login%&               "used when no login name found"
14294 .row &%unknown_username%&            "ditto"
14295 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14296 .row &%uucp_from_sender%&            "ditto"
14297 .endtable
14298
14299
14300
14301 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14302 .table2
14303 .row &%header_maxsize%&              "total size of message header"
14304 .row &%header_line_maxsize%&         "individual header line limit"
14305 .row &%message_size_limit%&          "applies to all messages"
14306 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14307 .row &%received_header_text%&        "expanded to make &'Received:'&"
14308 .row &%received_headers_max%&        "for mail loop detection"
14309 .row &%recipients_max%&              "limit per message"
14310 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14311 .endtable
14312
14313
14314
14315
14316 .section "Non-SMTP incoming messages" "SECID111"
14317 .table2
14318 .row &%receive_timeout%&             "for non-SMTP messages"
14319 .endtable
14320
14321
14322
14323
14324
14325 .section "Incoming SMTP messages" "SECID112"
14326 See also the &'Policy controls'& section above.
14327
14328 .table2
14329 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
14330 .row &%host_lookup%&                 "host name looked up for these hosts"
14331 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14332 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14333 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14334 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14335 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14336 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14337 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14338 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14339 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14340 .row &%smtp_accept_max_per_connection%& "messages per connection"
14341 .row &%smtp_accept_max_per_host%&    "connections from one host"
14342 .row &%smtp_accept_queue%&           "queue mail if more connections"
14343 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14344                                            connection"
14345 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14346 .row &%smtp_active_hostname%&        "host name to use in messages"
14347 .row &%smtp_banner%&                 "text for welcome banner"
14348 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14349 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14350 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14351 .row &%smtp_etrn_command%&           "what to run for ETRN"
14352 .row &%smtp_etrn_serialize%&         "only one at once"
14353 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14354 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14355 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14356 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14357 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14358 .row &%smtp_receive_timeout%&        "per command or data line"
14359 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14360 .row &%smtp_return_error_details%&   "give detail on rejections"
14361 .endtable
14362
14363
14364
14365 .section "SMTP extensions" "SECID113"
14366 .table2
14367 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14368 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14369 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14370 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14371 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14372 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14373 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14374 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14375 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14376 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14377 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14378 .endtable
14379
14380
14381
14382 .section "Processing messages" "SECID114"
14383 .table2
14384 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14385 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14386 .row &%allow_utf8_domains%&          "in addresses"
14387 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14388                                       words""&"
14389 .row &%delivery_date_remove%&        "from incoming messages"
14390 .row &%envelope_to_remove%&          "from incoming messages"
14391 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14392 .row &%headers_charset%&             "default for translations"
14393 .row &%qualify_domain%&              "default for senders"
14394 .row &%qualify_recipient%&           "default for recipients"
14395 .row &%return_path_remove%&          "from incoming messages"
14396 .row &%strip_excess_angle_brackets%& "in addresses"
14397 .row &%strip_trailing_dot%&          "at end of addresses"
14398 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14399 .endtable
14400
14401
14402
14403 .section "System filter" "SECID115"
14404 .table2
14405 .row &%system_filter%&               "locate system filter"
14406 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14407                                             directory"
14408 .row &%system_filter_file_transport%& "transport for delivery to a file"
14409 .row &%system_filter_group%&         "group for filter running"
14410 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14411 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14412 .row &%system_filter_user%&          "user for filter running"
14413 .endtable
14414
14415
14416
14417 .section "Routing and delivery" "SECID116"
14418 .table2
14419 .row &%disable_ipv6%&                "do no IPv6 processing"
14420 .row &%dns_again_means_nonexist%&    "for broken domains"
14421 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14422 .row &%dns_dnssec_ok%&               "parameter for resolver"
14423 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14424 .row &%dns_retrans%&                 "parameter for resolver"
14425 .row &%dns_retry%&                   "parameter for resolver"
14426 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14427 .row &%dns_use_edns0%&               "parameter for resolver"
14428 .row &%hold_domains%&                "hold delivery for these domains"
14429 .row &%local_interfaces%&            "for routing checks"
14430 .row &%queue_domains%&               "no immediate delivery for these"
14431 .row &%queue_only%&                  "no immediate delivery at all"
14432 .row &%queue_only_file%&             "no immediate delivery if file exists"
14433 .row &%queue_only_load%&             "no immediate delivery if load is high"
14434 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14435 .row &%queue_only_override%&         "allow command line to override"
14436 .row &%queue_run_in_order%&          "order of arrival"
14437 .row &%queue_run_max%&               "of simultaneous queue runners"
14438 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14439 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14440 .row &%remote_sort_domains%&         "order of remote deliveries"
14441 .row &%retry_data_expire%&           "timeout for retry data"
14442 .row &%retry_interval_max%&          "safety net for retry rules"
14443 .endtable
14444
14445
14446
14447 .section "Bounce and warning messages" "SECID117"
14448 .table2
14449 .row &%bounce_message_file%&         "content of bounce"
14450 .row &%bounce_message_text%&         "content of bounce"
14451 .row &%bounce_return_body%&          "include body if returning message"
14452 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14453 .row &%bounce_return_message%&       "include original message in bounce"
14454 .row &%bounce_return_size_limit%&    "limit on returned message"
14455 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14456 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14457 .row &%errors_copy%&                 "copy bounce messages"
14458 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14459 .row &%delay_warning%&               "time schedule"
14460 .row &%delay_warning_condition%&     "condition for warning messages"
14461 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14462 .row &%smtp_return_error_details%&   "give detail on rejections"
14463 .row &%warn_message_file%&           "content of warning message"
14464 .endtable
14465
14466
14467
14468 .section "Alphabetical list of main options" "SECTalomo"
14469 Those options that undergo string expansion before use are marked with
14470 &dagger;.
14471
14472 .option accept_8bitmime main boolean true
14473 .cindex "8BITMIME"
14474 .cindex "8-bit characters"
14475 .cindex "log" "selectors"
14476 .cindex "log" "8BITMIME"
14477 This option causes Exim to send 8BITMIME in its response to an SMTP
14478 EHLO command, and to accept the BODY= parameter on MAIL commands.
14479 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14480 takes no steps to do anything special with messages received by this route.
14481
14482 Historically Exim kept this option off by default, but the maintainers
14483 feel that in today's Internet, this causes more problems than it solves.
14484 It now defaults to true.
14485 A more detailed analysis of the issues is provided by Dan Bernstein:
14486 .display
14487 &url(https://cr.yp.to/smtp/8bitmime.html)
14488 .endd
14489
14490 To log received 8BITMIME status use
14491 .code
14492 log_selector = +8bitmime
14493 .endd
14494
14495 .option acl_not_smtp main string&!! unset
14496 .cindex "&ACL;" "for non-SMTP messages"
14497 .cindex "non-SMTP messages" "ACLs for"
14498 This option defines the ACL that is run when a non-SMTP message has been
14499 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14500 further details.
14501
14502 .option acl_not_smtp_mime main string&!! unset
14503 This option defines the ACL that is run for individual MIME parts of non-SMTP
14504 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14505 SMTP messages.
14506
14507 .option acl_not_smtp_start main string&!! unset
14508 .cindex "&ACL;" "at start of non-SMTP message"
14509 .cindex "non-SMTP messages" "ACLs for"
14510 This option defines the ACL that is run before Exim starts reading a
14511 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14512
14513 .option acl_smtp_auth main string&!! unset
14514 .cindex "&ACL;" "setting up for SMTP commands"
14515 .cindex "AUTH" "ACL for"
14516 This option defines the ACL that is run when an SMTP AUTH command is
14517 received. See chapter &<<CHAPACL>>& for further details.
14518
14519 .option acl_smtp_connect main string&!! unset
14520 .cindex "&ACL;" "on SMTP connection"
14521 This option defines the ACL that is run when an SMTP connection is received.
14522 See chapter &<<CHAPACL>>& for further details.
14523
14524 .option acl_smtp_data main string&!! unset
14525 .cindex "DATA" "ACL for"
14526 This option defines the ACL that is run after an SMTP DATA command has been
14527 processed and the message itself has been received, but before the final
14528 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14529
14530 .option acl_smtp_data_prdr main string&!! accept
14531 .cindex "PRDR" "ACL for"
14532 .cindex "DATA" "PRDR ACL for"
14533 .cindex "&ACL;" "PRDR-related"
14534 .cindex "&ACL;" "per-user data processing"
14535 This option defines the ACL that,
14536 if the PRDR feature has been negotiated,
14537 is run for each recipient after an SMTP DATA command has been
14538 processed and the message itself has been received, but before the
14539 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14540
14541 .option acl_smtp_dkim main string&!! unset
14542 .cindex DKIM "ACL for"
14543 This option defines the ACL that is run for each DKIM signature
14544 (by default, or as specified in the dkim_verify_signers option)
14545 of a received message.
14546 See section &<<SECDKIMVFY>>& for further details.
14547
14548 .option acl_smtp_etrn main string&!! unset
14549 .cindex "ETRN" "ACL for"
14550 This option defines the ACL that is run when an SMTP ETRN command is
14551 received. See chapter &<<CHAPACL>>& for further details.
14552
14553 .option acl_smtp_expn main string&!! unset
14554 .cindex "EXPN" "ACL for"
14555 This option defines the ACL that is run when an SMTP EXPN command is
14556 received. See chapter &<<CHAPACL>>& for further details.
14557
14558 .option acl_smtp_helo main string&!! unset
14559 .cindex "EHLO" "ACL for"
14560 .cindex "HELO" "ACL for"
14561 This option defines the ACL that is run when an SMTP EHLO or HELO
14562 command is received. See chapter &<<CHAPACL>>& for further details.
14563
14564
14565 .option acl_smtp_mail main string&!! unset
14566 .cindex "MAIL" "ACL for"
14567 This option defines the ACL that is run when an SMTP MAIL command is
14568 received. See chapter &<<CHAPACL>>& for further details.
14569
14570 .option acl_smtp_mailauth main string&!! unset
14571 .cindex "AUTH" "on MAIL command"
14572 This option defines the ACL that is run when there is an AUTH parameter on
14573 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14574 &<<CHAPSMTPAUTH>>& for details of authentication.
14575
14576 .option acl_smtp_mime main string&!! unset
14577 .cindex "MIME content scanning" "ACL for"
14578 This option is available when Exim is built with the content-scanning
14579 extension. It defines the ACL that is run for each MIME part in a message. See
14580 section &<<SECTscanmimepart>>& for details.
14581
14582 .option acl_smtp_notquit main string&!! unset
14583 .cindex "not-QUIT, ACL for"
14584 This option defines the ACL that is run when an SMTP session
14585 ends without a QUIT command being received.
14586 See chapter &<<CHAPACL>>& for further details.
14587
14588 .option acl_smtp_predata main string&!! unset
14589 This option defines the ACL that is run when an SMTP DATA command is
14590 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14591 further details.
14592
14593 .option acl_smtp_quit main string&!! unset
14594 .cindex "QUIT, ACL for"
14595 This option defines the ACL that is run when an SMTP QUIT command is
14596 received. See chapter &<<CHAPACL>>& for further details.
14597
14598 .option acl_smtp_rcpt main string&!! unset
14599 .cindex "RCPT" "ACL for"
14600 This option defines the ACL that is run when an SMTP RCPT command is
14601 received. See chapter &<<CHAPACL>>& for further details.
14602
14603 .option acl_smtp_starttls main string&!! unset
14604 .cindex "STARTTLS, ACL for"
14605 This option defines the ACL that is run when an SMTP STARTTLS command is
14606 received. See chapter &<<CHAPACL>>& for further details.
14607
14608 .option acl_smtp_vrfy main string&!! unset
14609 .cindex "VRFY" "ACL for"
14610 This option defines the ACL that is run when an SMTP VRFY command is
14611 received. See chapter &<<CHAPACL>>& for further details.
14612
14613 .option add_environment main "string list" empty
14614 .cindex "environment" "set values"
14615 This option allows to set individual environment variables that the
14616 currently linked libraries and programs in child processes use.
14617 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14618
14619 .option admin_groups main "string list&!!" unset
14620 .cindex "admin user"
14621 This option is expanded just once, at the start of Exim's processing. If the
14622 current group or any of the supplementary groups of an Exim caller is in this
14623 colon-separated list, the caller has admin privileges. If all your system
14624 programmers are in a specific group, for example, you can give them all Exim
14625 admin privileges by putting that group in &%admin_groups%&. However, this does
14626 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14627 To permit this, you have to add individuals to the Exim group.
14628
14629 .option allow_domain_literals main boolean false
14630 .cindex "domain literal"
14631 If this option is set, the RFC 2822 domain literal format is permitted in
14632 email addresses. The option is not set by default, because the domain literal
14633 format is not normally required these days, and few people know about it. It
14634 has, however, been exploited by mail abusers.
14635
14636 Unfortunately, it seems that some DNS black list maintainers are using this
14637 format to report black listing to postmasters. If you want to accept messages
14638 addressed to your hosts by IP address, you need to set
14639 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14640 domains (defined in the named domain list &%local_domains%& in the default
14641 configuration). This &"magic string"& matches the domain literal form of all
14642 the local host's IP addresses.
14643
14644
14645 .option allow_mx_to_ip main boolean false
14646 .cindex "MX record" "pointing to IP address"
14647 It appears that more and more DNS zone administrators are breaking the rules
14648 and putting domain names that look like IP addresses on the right hand side of
14649 MX records. Exim follows the rules and rejects this, giving an error message
14650 that explains the misconfiguration. However, some other MTAs support this
14651 practice, so to avoid &"Why can't Exim do this?"& complaints,
14652 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14653 recommended, except when you have no other choice.
14654
14655 .option allow_utf8_domains main boolean false
14656 .cindex "domain" "UTF-8 characters in"
14657 .cindex "UTF-8" "in domain name"
14658 Lots of discussion is going on about internationalized domain names. One
14659 camp is strongly in favour of just using UTF-8 characters, and it seems
14660 that at least two other MTAs permit this. This option allows Exim users to
14661 experiment if they wish.
14662
14663 If it is set true, Exim's domain parsing function allows valid
14664 UTF-8 multicharacters to appear in domain name components, in addition to
14665 letters, digits, and hyphens. However, just setting this option is not
14666 enough; if you want to look up these domain names in the DNS, you must also
14667 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14668 suitable setting is:
14669 .code
14670 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14671   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14672 .endd
14673 Alternatively, you can just disable this feature by setting
14674 .code
14675 dns_check_names_pattern =
14676 .endd
14677 That is, set the option to an empty string so that no check is done.
14678
14679
14680 .option auth_advertise_hosts main "host list&!!" *
14681 .cindex "authentication" "advertising"
14682 .cindex "AUTH" "advertising"
14683 If any server authentication mechanisms are configured, Exim advertises them in
14684 response to an EHLO command only if the calling host matches this list.
14685 Otherwise, Exim does not advertise AUTH.
14686 Exim does not accept AUTH commands from clients to which it has not
14687 advertised the availability of AUTH. The advertising of individual
14688 authentication mechanisms can be controlled by the use of the
14689 &%server_advertise_condition%& generic authenticator option on the individual
14690 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14691
14692 Certain mail clients (for example, Netscape) require the user to provide a name
14693 and password for authentication if AUTH is advertised, even though it may
14694 not be needed (the host may accept messages from hosts on its local LAN without
14695 authentication, for example). The &%auth_advertise_hosts%& option can be used
14696 to make these clients more friendly by excluding them from the set of hosts to
14697 which Exim advertises AUTH.
14698
14699 .cindex "AUTH" "advertising when encrypted"
14700 If you want to advertise the availability of AUTH only when the connection
14701 is encrypted using TLS, you can make use of the fact that the value of this
14702 option is expanded, with a setting like this:
14703 .code
14704 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14705 .endd
14706 .vindex "&$tls_in_cipher$&"
14707 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14708 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14709 expansion is *, which matches all hosts.
14710
14711
14712 .option auto_thaw main time 0s
14713 .cindex "thawing messages"
14714 .cindex "unfreezing messages"
14715 If this option is set to a time greater than zero, a queue runner will try a
14716 new delivery attempt on any frozen message, other than a bounce message, if
14717 this much time has passed since it was frozen. This may result in the message
14718 being re-frozen if nothing has changed since the last attempt. It is a way of
14719 saying &"keep on trying, even though there are big problems"&.
14720
14721 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14722 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14723 thought to be very useful any more, and its use should probably be avoided.
14724
14725
14726 .option av_scanner main string "see below"
14727 This option is available if Exim is built with the content-scanning extension.
14728 It specifies which anti-virus scanner to use. The default value is:
14729 .code
14730 sophie:/var/run/sophie
14731 .endd
14732 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14733 before use. See section &<<SECTscanvirus>>& for further details.
14734
14735
14736 .option bi_command main string unset
14737 .oindex "&%-bi%&"
14738 This option supplies the name of a command that is run when Exim is called with
14739 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14740 just the command name, it is not a complete command line. If an argument is
14741 required, it must come from the &%-oA%& command line option.
14742
14743
14744 .option bounce_message_file main string unset
14745 .cindex "bounce message" "customizing"
14746 .cindex "customizing" "bounce message"
14747 This option defines a template file containing paragraphs of text to be used
14748 for constructing bounce messages.  Details of the file's contents are given in
14749 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14750
14751
14752 .option bounce_message_text main string unset
14753 When this option is set, its contents are included in the default bounce
14754 message immediately after &"This message was created automatically by mail
14755 delivery software."& It is not used if &%bounce_message_file%& is set.
14756
14757 .option bounce_return_body main boolean true
14758 .cindex "bounce message" "including body"
14759 This option controls whether the body of an incoming message is included in a
14760 bounce message when &%bounce_return_message%& is true. The default setting
14761 causes the entire message, both header and body, to be returned (subject to the
14762 value of &%bounce_return_size_limit%&). If this option is false, only the
14763 message header is included. In the case of a non-SMTP message containing an
14764 error that is detected during reception, only those header lines preceding the
14765 point at which the error was detected are returned.
14766 .cindex "bounce message" "including original"
14767
14768 .option bounce_return_linesize_limit main integer 998
14769 .cindex "size" "of bounce lines, limit"
14770 .cindex "bounce message" "line length limit"
14771 .cindex "limit" "bounce message line length"
14772 This option sets a limit in bytes on the line length of messages
14773 that are returned to senders due to delivery problems,
14774 when &%bounce_return_message%& is true.
14775 The default value corresponds to RFC limits.
14776 If the message being returned has lines longer than this value it is
14777 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14778
14779 The option also applies to bounces returned when an error is detected
14780 during reception of a message.
14781 In this case lines from the original are truncated.
14782
14783 The option does not apply to messages generated by an &(autoreply)& transport.
14784
14785
14786 .option bounce_return_message main boolean true
14787 If this option is set false, none of the original message is included in
14788 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14789 &%bounce_return_body%&.
14790
14791
14792 .option bounce_return_size_limit main integer 100K
14793 .cindex "size" "of bounce, limit"
14794 .cindex "bounce message" "size limit"
14795 .cindex "limit" "bounce message size"
14796 This option sets a limit in bytes on the size of messages that are returned to
14797 senders as part of bounce messages when &%bounce_return_message%& is true. The
14798 limit should be less than the value of the global &%message_size_limit%& and of
14799 any &%message_size_limit%& settings on transports, to allow for the bounce text
14800 that Exim generates. If this option is set to zero there is no limit.
14801
14802 When the body of any message that is to be included in a bounce message is
14803 greater than the limit, it is truncated, and a comment pointing this out is
14804 added at the top. The actual cutoff may be greater than the value given, owing
14805 to the use of buffering for transferring the message in chunks (typically 8K in
14806 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14807 messages.
14808
14809 .option bounce_sender_authentication main string unset
14810 .cindex "bounce message" "sender authentication"
14811 .cindex "authentication" "bounce message"
14812 .cindex "AUTH" "on bounce message"
14813 This option provides an authenticated sender address that is sent with any
14814 bounce messages generated by Exim that are sent over an authenticated SMTP
14815 connection. A typical setting might be:
14816 .code
14817 bounce_sender_authentication = mailer-daemon@my.domain.example
14818 .endd
14819 which would cause bounce messages to be sent using the SMTP command:
14820 .code
14821 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14822 .endd
14823 The value of &%bounce_sender_authentication%& must always be a complete email
14824 address.
14825
14826 .option callout_domain_negative_expire main time 3h
14827 .cindex "caching" "callout timeouts"
14828 .cindex "callout" "caching timeouts"
14829 This option specifies the expiry time for negative callout cache data for a
14830 domain. See section &<<SECTcallver>>& for details of callout verification, and
14831 section &<<SECTcallvercache>>& for details of the caching.
14832
14833
14834 .option callout_domain_positive_expire main time 7d
14835 This option specifies the expiry time for positive callout cache data for a
14836 domain. See section &<<SECTcallver>>& for details of callout verification, and
14837 section &<<SECTcallvercache>>& for details of the caching.
14838
14839
14840 .option callout_negative_expire main time 2h
14841 This option specifies the expiry time for negative callout cache data for an
14842 address. See section &<<SECTcallver>>& for details of callout verification, and
14843 section &<<SECTcallvercache>>& for details of the caching.
14844
14845
14846 .option callout_positive_expire main time 24h
14847 This option specifies the expiry time for positive callout cache data for an
14848 address. See section &<<SECTcallver>>& for details of callout verification, and
14849 section &<<SECTcallvercache>>& for details of the caching.
14850
14851
14852 .option callout_random_local_part main string&!! "see below"
14853 This option defines the &"random"& local part that can be used as part of
14854 callout verification. The default value is
14855 .code
14856 $primary_hostname-$tod_epoch-testing
14857 .endd
14858 See section &<<CALLaddparcall>>& for details of how this value is used.
14859
14860
14861 .option check_log_inodes main integer 100
14862 See &%check_spool_space%& below.
14863
14864
14865 .option check_log_space main integer 10M
14866 See &%check_spool_space%& below.
14867
14868 .oindex "&%check_rfc2047_length%&"
14869 .cindex "RFC 2047" "disabling length check"
14870 .option check_rfc2047_length main boolean true
14871 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14872 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14873 word; strings to be encoded that exceed this length are supposed to use
14874 multiple encoded words. By default, Exim does not recognize encoded words that
14875 exceed the maximum length. However, it seems that some software, in violation
14876 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14877 set false, Exim recognizes encoded words of any length.
14878
14879
14880 .option check_spool_inodes main integer 100
14881 See &%check_spool_space%& below.
14882
14883
14884 .option check_spool_space main integer 10M
14885 .cindex "checking disk space"
14886 .cindex "disk space, checking"
14887 .cindex "spool directory" "checking space"
14888 The four &%check_...%& options allow for checking of disk resources before a
14889 message is accepted.
14890
14891 .vindex "&$log_inodes$&"
14892 .vindex "&$log_space$&"
14893 .vindex "&$spool_inodes$&"
14894 .vindex "&$spool_space$&"
14895 When any of these options are nonzero, they apply to all incoming messages. If you
14896 want to apply different checks to different kinds of message, you can do so by
14897 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14898 &$spool_space$& in an ACL with appropriate additional conditions.
14899
14900
14901 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14902 either value is greater than zero, for example:
14903 .code
14904 check_spool_space = 100M
14905 check_spool_inodes = 100
14906 .endd
14907 The spool partition is the one that contains the directory defined by
14908 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14909 transit.
14910
14911 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14912 files are written if either is greater than zero. These should be set only if
14913 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14914
14915 If there is less space or fewer inodes than requested, Exim refuses to accept
14916 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14917 error response to the MAIL command. If ESMTP is in use and there was a
14918 SIZE parameter on the MAIL command, its value is added to the
14919 &%check_spool_space%& value, and the check is performed even if
14920 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14921
14922 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14923 number of kilobytes (though specified in bytes).
14924 If a non-multiple of 1024 is specified, it is rounded up.
14925
14926 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14927 failure a message is written to stderr and Exim exits with a non-zero code, as
14928 it obviously cannot send an error message of any kind.
14929
14930 There is a slight performance penalty for these checks.
14931 Versions of Exim preceding 4.88 had these disabled by default;
14932 high-rate installations confident they will never run out of resources
14933 may wish to deliberately disable them.
14934
14935 .option chunking_advertise_hosts main "host list&!!" *
14936 .cindex CHUNKING advertisement
14937 .cindex "RFC 3030" "CHUNKING"
14938 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14939 these hosts.
14940 Hosts may use the BDAT command as an alternate to DATA.
14941
14942 .option commandline_checks_require_admin main boolean &`false`&
14943 .cindex "restricting access to features"
14944 This option restricts various basic checking features to require an
14945 administrative user.
14946 This affects most of the &%-b*%& options, such as &%-be%&.
14947
14948 .option debug_store main boolean &`false`&
14949 .cindex debugging "memory corruption"
14950 .cindex memory debugging
14951 This option, when true, enables extra checking in Exim's internal memory
14952 management.  For use when a memory corruption issue is being investigated,
14953 it should normally be left as default.
14954
14955 .option daemon_smtp_ports main string &`smtp`&
14956 .cindex "port" "for daemon"
14957 .cindex "TCP/IP" "setting listening ports"
14958 This option specifies one or more default SMTP ports on which the Exim daemon
14959 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14960 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14961
14962 .option daemon_startup_retries main integer 9
14963 .cindex "daemon startup, retrying"
14964 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14965 the daemon at startup when it cannot immediately bind a listening socket
14966 (typically because the socket is already in use): &%daemon_startup_retries%&
14967 defines the number of retries after the first failure, and
14968 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14969
14970 .option daemon_startup_sleep main time 30s
14971 See &%daemon_startup_retries%&.
14972
14973 .option delay_warning main "time list" 24h
14974 .cindex "warning of delay"
14975 .cindex "delay warning, specifying"
14976 .cindex "queue" "delay warning"
14977 When a message is delayed, Exim sends a warning message to the sender at
14978 intervals specified by this option. The data is a colon-separated list of times
14979 after which to send warning messages. If the value of the option is an empty
14980 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14981 message has been in the queue for longer than the last time, the last interval
14982 between the times is used to compute subsequent warning times. For example,
14983 with
14984 .code
14985 delay_warning = 4h:8h:24h
14986 .endd
14987 the first message is sent after 4 hours, the second after 8 hours, and
14988 the third one after 24 hours. After that, messages are sent every 16 hours,
14989 because that is the interval between the last two times on the list. If you set
14990 just one time, it specifies the repeat interval. For example, with:
14991 .code
14992 delay_warning = 6h
14993 .endd
14994 messages are repeated every six hours. To stop warnings after a given time, set
14995 a very large time at the end of the list. For example:
14996 .code
14997 delay_warning = 2h:12h:99d
14998 .endd
14999 Note that the option is only evaluated at the time a delivery attempt fails,
15000 which depends on retry and queue-runner configuration.
15001 Typically retries will be configured more frequently than warning messages.
15002
15003 .option delay_warning_condition main string&!! "see below"
15004 .vindex "&$domain$&"
15005 The string is expanded at the time a warning message might be sent. If all the
15006 deferred addresses have the same domain, it is set in &$domain$& during the
15007 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15008 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15009 &"false"& (the comparison being done caselessly) then the warning message is
15010 not sent. The default is:
15011 .code
15012 delay_warning_condition = ${if or {\
15013   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15014   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15015   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15016   } {no}{yes}}
15017 .endd
15018 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15019 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15020 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15021 &"auto-replied"& in an &'Auto-Submitted:'& header.
15022
15023 .option deliver_drop_privilege main boolean false
15024 .cindex "unprivileged delivery"
15025 .cindex "delivery" "unprivileged"
15026 If this option is set true, Exim drops its root privilege at the start of a
15027 delivery process, and runs as the Exim user throughout. This severely restricts
15028 the kinds of local delivery that are possible, but is viable in certain types
15029 of configuration. There is a discussion about the use of root privilege in
15030 chapter &<<CHAPsecurity>>&.
15031
15032 .option deliver_queue_load_max main fixed-point unset
15033 .cindex "load average"
15034 .cindex "queue runner" "abandoning"
15035 When this option is set, a queue run is abandoned if the system load average
15036 becomes greater than the value of the option. The option has no effect on
15037 ancient operating systems on which Exim cannot determine the load average.
15038 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15039
15040
15041 .option delivery_date_remove main boolean true
15042 .cindex "&'Delivery-date:'& header line"
15043 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15044 message when it is delivered, in exactly the same way as &'Return-path:'& is
15045 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15046 should not be present in incoming messages, and this option causes them to be
15047 removed at the time the message is received, to avoid any problems that might
15048 occur when a delivered message is subsequently sent on to some other recipient.
15049
15050 .option disable_fsync main boolean false
15051 .cindex "&[fsync()]&, disabling"
15052 This option is available only if Exim was built with the compile-time option
15053 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15054 a runtime configuration generates an &"unknown option"& error. You should not
15055 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15056 really, really, really understand what you are doing. &'No pre-compiled
15057 distributions of Exim should ever make this option available.'&
15058
15059 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15060 updated files' data to be written to disc before continuing. Unexpected events
15061 such as crashes and power outages may cause data to be lost or scrambled.
15062 Here be Dragons. &*Beware.*&
15063
15064
15065 .option disable_ipv6 main boolean false
15066 .cindex "IPv6" "disabling"
15067 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15068 activities take place. AAAA records are never looked up, and any IPv6 addresses
15069 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15070 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15071 to handle IPv6 literal addresses.
15072
15073
15074 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15075 .cindex DKIM "controlling calls to the ACL"
15076 This option gives a list of DKIM domains for which the DKIM ACL is run.
15077 It is expanded after the message is received; by default it runs
15078 the ACL once for each signature in the message.
15079 See section &<<SECDKIMVFY>>&.
15080
15081
15082 .option dns_again_means_nonexist main "domain list&!!" unset
15083 .cindex "DNS" "&""try again""& response; overriding"
15084 DNS lookups give a &"try again"& response for the DNS errors
15085 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15086 keep trying to deliver a message, or to give repeated temporary errors to
15087 incoming mail. Sometimes the effect is caused by a badly set up name server and
15088 may persist for a long time. If a domain which exhibits this problem matches
15089 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15090 This option should be used with care. You can make it apply to reverse lookups
15091 by a setting such as this:
15092 .code
15093 dns_again_means_nonexist = *.in-addr.arpa
15094 .endd
15095 This option applies to all DNS lookups that Exim does. It also applies when the
15096 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15097 since these are most likely to be caused by DNS lookup problems. The
15098 &(dnslookup)& router has some options of its own for controlling what happens
15099 when lookups for MX or SRV records give temporary errors. These more specific
15100 options are applied after this global option.
15101
15102 .option dns_check_names_pattern main string "see below"
15103 .cindex "DNS" "pre-check of name syntax"
15104 When this option is set to a non-empty string, it causes Exim to check domain
15105 names for characters that are not allowed in host names before handing them to
15106 the DNS resolver, because some resolvers give temporary errors for names that
15107 contain unusual characters. If a domain name contains any unwanted characters,
15108 a &"not found"& result is forced, and the resolver is not called. The check is
15109 done by matching the domain name against a regular expression, which is the
15110 value of this option. The default pattern is
15111 .code
15112 dns_check_names_pattern = \
15113   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15114 .endd
15115 which permits only letters, digits, slashes, and hyphens in components, but
15116 they must start and end with a letter or digit. Slashes are not, in fact,
15117 permitted in host names, but they are found in certain NS records (which can be
15118 accessed in Exim by using a &%dnsdb%& lookup). If you set
15119 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15120 empty string.
15121
15122 .option dns_csa_search_limit main integer 5
15123 This option controls the depth of parental searching for CSA SRV records in the
15124 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15125
15126 .option dns_csa_use_reverse main boolean true
15127 This option controls whether or not an IP address, given as a CSA domain, is
15128 reversed and looked up in the reverse DNS, as described in more detail in
15129 section &<<SECTverifyCSA>>&.
15130
15131 .option dns_cname_loops main integer 1
15132 .cindex DNS "CNAME following"
15133 This option controls the following of CNAME chains, needed if the resolver does
15134 not do it internally.
15135 As of 2018 most should, and the default can be left.
15136 If you have an ancient one, a value of 10 is likely needed.
15137
15138 The default value of one CNAME-follow is needed
15139 thanks to the observed return for an MX request,
15140 given no MX presence but a CNAME to an A, of the CNAME.
15141
15142
15143 .option dns_dnssec_ok main integer -1
15144 .cindex "DNS" "resolver options"
15145 .cindex "DNS" "DNSSEC"
15146 If this option is set to a non-negative number then Exim will initialise the
15147 DNS resolver library to either use or not use DNSSEC, overriding the system
15148 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15149
15150 If the resolver library does not support DNSSEC then this option has no effect.
15151
15152
15153 .option dns_ipv4_lookup main "domain list&!!" unset
15154 .cindex "IPv6" "DNS lookup for AAAA records"
15155 .cindex "DNS" "IPv6 lookup for AAAA records"
15156 .cindex DNS "IPv6 disabling"
15157 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15158 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15159 (A records) when trying to find IP addresses for hosts, unless the host's
15160 domain matches this list.
15161
15162 This is a fudge to help with name servers that give big delays or otherwise do
15163 not work for the AAAA record type. In due course, when the world's name
15164 servers have all been upgraded, there should be no need for this option.
15165 .new
15166 Note that all lookups, including those done for verification, are affected;
15167 this will result in verify failure for IPv6 connections or ones using names
15168 only valid for IPv6 addresses.
15169 .wen
15170
15171
15172 .option dns_retrans main time 0s
15173 .cindex "DNS" "resolver options"
15174 .cindex timeout "dns lookup"
15175 .cindex "DNS" timeout
15176 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15177 retransmission and retry parameters for DNS lookups. Values of zero (the
15178 defaults) leave the system default settings unchanged. The first value is the
15179 time between retries, and the second is the number of retries. It isn't
15180 totally clear exactly how these settings affect the total time a DNS lookup may
15181 take. I haven't found any documentation about timeouts on DNS lookups; these
15182 parameter values are available in the external resolver interface structure,
15183 but nowhere does it seem to describe how they are used or what you might want
15184 to set in them.
15185 See also the &%slow_lookup_log%& option.
15186
15187
15188 .option dns_retry main integer 0
15189 See &%dns_retrans%& above.
15190
15191
15192 .option dns_trust_aa main "domain list&!!" unset
15193 .cindex "DNS" "resolver options"
15194 .cindex "DNS" "DNSSEC"
15195 If this option is set then lookup results marked with the AA bit
15196 (Authoritative Answer) are trusted the same way as if they were
15197 DNSSEC-verified. The authority section's name of the answer must
15198 match with this expanded domain list.
15199
15200 Use this option only if you talk directly to a resolver that is
15201 authoritative for some zones and does not set the AD (Authentic Data)
15202 bit in the answer. Some DNS servers may have an configuration option to
15203 mark the answers from their own zones as verified (they set the AD bit).
15204 Others do not have this option. It is considered as poor practice using
15205 a resolver that is an authoritative server for some zones.
15206
15207 Use this option only if you really have to (e.g. if you want
15208 to use DANE for remote delivery to a server that is listed in the DNS
15209 zones that your resolver is authoritative for).
15210
15211 If the DNS answer packet has the AA bit set and contains resource record
15212 in the answer section, the name of the first NS record appearing in the
15213 authority section is compared against the list. If the answer packet is
15214 authoritative but the answer section is empty, the name of the first SOA
15215 record in the authoritative section is used instead.
15216
15217 .cindex "DNS" "resolver options"
15218 .option dns_use_edns0 main integer -1
15219 .cindex "DNS" "resolver options"
15220 .cindex "DNS" "EDNS0"
15221 .cindex "DNS" "OpenBSD
15222 If this option is set to a non-negative number then Exim will initialise the
15223 DNS resolver library to either use or not use EDNS0 extensions, overriding
15224 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15225 on.
15226
15227 If the resolver library does not support EDNS0 then this option has no effect.
15228
15229 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15230 means that DNSSEC will not work with Exim on that platform either, unless Exim
15231 is linked against an alternative DNS client library.
15232
15233
15234 .option drop_cr main boolean false
15235 This is an obsolete option that is now a no-op. It used to affect the way Exim
15236 handled CR and LF characters in incoming messages. What happens now is
15237 described in section &<<SECTlineendings>>&.
15238
15239 .option dsn_advertise_hosts main "host list&!!" unset
15240 .cindex "bounce messages" "success"
15241 .cindex "DSN" "success"
15242 .cindex "Delivery Status Notification" "success"
15243 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15244 and accepted from, these hosts.
15245 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15246 and RET and ORCPT options on MAIL FROM commands.
15247 A NOTIFY=SUCCESS option requests success-DSN messages.
15248 A NOTIFY= option with no argument requests that no delay or failure DSNs
15249 are sent.
15250
15251 .option dsn_from main "string&!!" "see below"
15252 .cindex "&'From:'& header line" "in bounces"
15253 .cindex "bounce messages" "&'From:'& line, specifying"
15254 This option can be used to vary the contents of &'From:'& header lines in
15255 bounces and other automatically generated messages (&"Delivery Status
15256 Notifications"& &-- hence the name of the option). The default setting is:
15257 .code
15258 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15259 .endd
15260 The value is expanded every time it is needed. If the expansion fails, a
15261 panic is logged, and the default value is used.
15262
15263 .option envelope_to_remove main boolean true
15264 .cindex "&'Envelope-to:'& header line"
15265 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15266 message when it is delivered, in exactly the same way as &'Return-path:'& is
15267 handled. &'Envelope-to:'& records the original recipient address from the
15268 message's envelope that caused the delivery to happen. Such headers should not
15269 be present in incoming messages, and this option causes them to be removed at
15270 the time the message is received, to avoid any problems that might occur when a
15271 delivered message is subsequently sent on to some other recipient.
15272
15273
15274 .option errors_copy main "string list&!!" unset
15275 .cindex "bounce message" "copy to other address"
15276 .cindex "copy of bounce message"
15277 Setting this option causes Exim to send bcc copies of bounce messages that it
15278 generates to other addresses. &*Note*&: This does not apply to bounce messages
15279 coming from elsewhere. The value of the option is a colon-separated list of
15280 items. Each item consists of a pattern, terminated by white space, followed by
15281 a comma-separated list of email addresses. If a pattern contains spaces, it
15282 must be enclosed in double quotes.
15283
15284 Each pattern is processed in the same way as a single item in an address list
15285 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15286 the bounce message, the message is copied to the addresses on the list. The
15287 items are scanned in order, and once a matching one is found, no further items
15288 are examined. For example:
15289 .code
15290 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15291               rqps@mydomain   hostmaster@mydomain.example,\
15292                               postmaster@mydomain.example
15293 .endd
15294 .vindex "&$domain$&"
15295 .vindex "&$local_part$&"
15296 The address list is expanded before use. The expansion variables &$local_part$&
15297 and &$domain$& are set from the original recipient of the error message, and if
15298 there was any wildcard matching in the pattern, the expansion
15299 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15300 variables &$0$&, &$1$&, etc. are set in the normal way.
15301
15302
15303 .option errors_reply_to main string unset
15304 .cindex "bounce message" "&'Reply-to:'& in"
15305 By default, Exim's bounce and delivery warning messages contain the header line
15306 .display
15307 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15308 .endd
15309 .oindex &%quota_warn_message%&
15310 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15311 A warning message that is generated by the &%quota_warn_message%& option in an
15312 &(appendfile)& transport may contain its own &'From:'& header line that
15313 overrides the default.
15314
15315 Experience shows that people reply to bounce messages. If the
15316 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15317 and warning messages. For example:
15318 .code
15319 errors_reply_to = postmaster@my.domain.example
15320 .endd
15321 The value of the option is not expanded. It must specify a valid RFC 2822
15322 address. However, if a warning message that is generated by the
15323 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15324 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15325 not used.
15326
15327
15328 .option event_action main string&!! unset
15329 .cindex events
15330 This option declares a string to be expanded for Exim's events mechanism.
15331 For details see chapter &<<CHAPevents>>&.
15332
15333
15334 .option exim_group main string "compile-time configured"
15335 .cindex "gid (group id)" "Exim's own"
15336 .cindex "Exim group"
15337 This option changes the gid under which Exim runs when it gives up root
15338 privilege. The default value is compiled into the binary. The value of this
15339 option is used only when &%exim_user%& is also set. Unless it consists entirely
15340 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15341 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15342 security issues.
15343
15344
15345 .option exim_path main string "see below"
15346 .cindex "Exim binary, path name"
15347 This option specifies the path name of the Exim binary, which is used when Exim
15348 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15349 the directory configured at compile time by the BIN_DIRECTORY setting. It
15350 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15351 other place.
15352 &*Warning*&: Do not use a macro to define the value of this option, because
15353 you will break those Exim utilities that scan the configuration file to find
15354 where the binary is. (They then use the &%-bP%& option to extract option
15355 settings such as the value of &%spool_directory%&.)
15356
15357
15358 .option exim_user main string "compile-time configured"
15359 .cindex "uid (user id)" "Exim's own"
15360 .cindex "Exim user"
15361 This option changes the uid under which Exim runs when it gives up root
15362 privilege. The default value is compiled into the binary. Ownership of the run
15363 time configuration file and the use of the &%-C%& and &%-D%& command line
15364 options is checked against the values in the binary, not what is set here.
15365
15366 Unless it consists entirely of digits, the string is looked up using
15367 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15368 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15369 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15370
15371
15372 .option exim_version main string "current version"
15373 .cindex "Exim version"
15374 .cindex customizing "version number"
15375 .cindex "version number of Exim" override
15376 This option allows to override the &$version_number$&/&$exim_version$& Exim reports in
15377 various places.  Use with care, this may fool stupid security scanners.
15378
15379
15380 .option extra_local_interfaces main "string list" unset
15381 This option defines network interfaces that are to be considered local when
15382 routing, but which are not used for listening by the daemon. See section
15383 &<<SECTreclocipadd>>& for details.
15384
15385
15386 . Allow this long option name to split; give it unsplit as a fifth argument
15387 . for the automatic .oindex that is generated by .option.
15388
15389 .option "extract_addresses_remove_arguments" main boolean true &&&
15390          extract_addresses_remove_arguments
15391 .oindex "&%-t%&"
15392 .cindex "command line" "addresses with &%-t%&"
15393 .cindex "Sendmail compatibility" "&%-t%& option"
15394 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15395 are present on the command line when the &%-t%& option is used to build an
15396 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15397 line addresses are removed from the recipients list. This is also how Smail
15398 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15399 command line addresses are added to those obtained from the header lines. When
15400 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15401 argument headers. If it is set false, Exim adds rather than removes argument
15402 addresses.
15403
15404
15405 .option finduser_retries main integer 0
15406 .cindex "NIS, retrying user lookups"
15407 On systems running NIS or other schemes in which user and group information is
15408 distributed from a remote system, there can be times when &[getpwnam()]& and
15409 related functions fail, even when given valid data, because things time out.
15410 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15411 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15412 many extra times to find a user or a group, waiting for one second between
15413 retries.
15414
15415 .cindex "&_/etc/passwd_&" "multiple reading of"
15416 You should not set this option greater than zero if your user information is in
15417 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15418 search the file multiple times for non-existent users, and also cause delay.
15419
15420
15421
15422 .option freeze_tell main "string list, comma separated" unset
15423 .cindex "freezing messages" "sending a message when freezing"
15424 On encountering certain errors, or when configured to do so in a system filter,
15425 ACL, or special router, Exim freezes a message. This means that no further
15426 delivery attempts take place until an administrator thaws the message, or the
15427 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15428 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15429 warning message whenever it freezes something, unless the message it is
15430 freezing is a locally-generated bounce message. (Without this exception there
15431 is the possibility of looping.) The warning message is sent to the addresses
15432 supplied as the comma-separated value of this option. If several of the
15433 message's addresses cause freezing, only a single message is sent. If the
15434 freezing was automatic, the reason(s) for freezing can be found in the message
15435 log. If you configure freezing in a filter or ACL, you must arrange for any
15436 logging that you require.
15437
15438
15439 .option gecos_name main string&!! unset
15440 .cindex "HP-UX"
15441 .cindex "&""gecos""& field, parsing"
15442 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15443 password file to hold other information in addition to users' real names. Exim
15444 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15445 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15446 of the field are used unchanged, except that, if an ampersand is encountered,
15447 it is replaced by the user's login name with the first character forced to
15448 upper case, since this is a convention that is observed on many systems.
15449
15450 When these options are set, &%gecos_pattern%& is treated as a regular
15451 expression that is to be applied to the field (again with && replaced by the
15452 login name), and if it matches, &%gecos_name%& is expanded and used as the
15453 user's name.
15454
15455 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15456 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15457 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15458 name terminates at the first comma, the following can be used:
15459 .code
15460 gecos_pattern = ([^,]*)
15461 gecos_name = $1
15462 .endd
15463
15464 .option gecos_pattern main string unset
15465 See &%gecos_name%& above.
15466
15467
15468 .option gnutls_compat_mode main boolean unset
15469 This option controls whether GnuTLS is used in compatibility mode in an Exim
15470 server. This reduces security slightly, but improves interworking with older
15471 implementations of TLS.
15472
15473
15474 .option gnutls_allow_auto_pkcs11 main boolean unset
15475 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15476 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15477
15478 See
15479 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15480 for documentation.
15481
15482
15483
15484 .option headers_charset main string "see below"
15485 This option sets a default character set for translating from encoded MIME
15486 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15487 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15488 ultimate default is ISO-8859-1. For more details see the description of header
15489 insertions in section &<<SECTexpansionitems>>&.
15490
15491
15492
15493 .option header_maxsize main integer "see below"
15494 .cindex "header section" "maximum size of"
15495 .cindex "limit" "size of message header section"
15496 This option controls the overall maximum size of a message's header
15497 section. The default is the value of HEADER_MAXSIZE in
15498 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15499 sections are rejected.
15500
15501
15502 .option header_line_maxsize main integer 0
15503 .cindex "header lines" "maximum size of"
15504 .cindex "limit" "size of one header line"
15505 This option limits the length of any individual header line in a message, after
15506 all the continuations have been joined together. Messages with individual
15507 header lines that are longer than the limit are rejected. The default value of
15508 zero means &"no limit"&.
15509
15510
15511
15512
15513 .option helo_accept_junk_hosts main "host list&!!" unset
15514 .cindex "HELO" "accepting junk data"
15515 .cindex "EHLO" "accepting junk data"
15516 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15517 mail, and gives an error response for invalid data. Unfortunately, there are
15518 some SMTP clients that send syntactic junk. They can be accommodated by setting
15519 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15520 if you want to do semantic checking.
15521 See also &%helo_allow_chars%& for a way of extending the permitted character
15522 set.
15523
15524
15525 .option helo_allow_chars main string unset
15526 .cindex "HELO" "underscores in"
15527 .cindex "EHLO" "underscores in"
15528 .cindex "underscore in EHLO/HELO"
15529 This option can be set to a string of rogue characters that are permitted in
15530 all EHLO and HELO names in addition to the standard letters, digits,
15531 hyphens, and dots. If you really must allow underscores, you can set
15532 .code
15533 helo_allow_chars = _
15534 .endd
15535 Note that the value is one string, not a list.
15536
15537
15538 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15539 .cindex "HELO" "forcing reverse lookup"
15540 .cindex "EHLO" "forcing reverse lookup"
15541 If the domain given by a client in a HELO or EHLO command matches this
15542 list, a reverse lookup is done in order to establish the host's true name. The
15543 default forces a lookup if the client host gives the server's name or any of
15544 its IP addresses (in brackets), something that broken clients have been seen to
15545 do.
15546
15547
15548 .option helo_try_verify_hosts main "host list&!!" unset
15549 .cindex "HELO verifying" "optional"
15550 .cindex "EHLO" "verifying, optional"
15551 By default, Exim just checks the syntax of HELO and EHLO commands (see
15552 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15553 to do more extensive checking of the data supplied by these commands. The ACL
15554 condition &`verify = helo`& is provided to make this possible.
15555 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15556 to force the check to occur. From release 4.53 onwards, this is no longer
15557 necessary. If the check has not been done before &`verify = helo`& is
15558 encountered, it is done at that time. Consequently, this option is obsolete.
15559 Its specification is retained here for backwards compatibility.
15560
15561 When an EHLO or HELO command is received, if the calling host matches
15562 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15563 EHLO command either:
15564
15565 .ilist
15566 is an IP literal matching the calling address of the host, or
15567 .next
15568 .cindex "DNS" "reverse lookup"
15569 .cindex "reverse DNS lookup"
15570 matches the host name that Exim obtains by doing a reverse lookup of the
15571 calling host address, or
15572 .next
15573 when looked up in DNS yields the calling host address.
15574 .endlist
15575
15576 However, the EHLO or HELO command is not rejected if any of the checks
15577 fail. Processing continues, but the result of the check is remembered, and can
15578 be detected later in an ACL by the &`verify = helo`& condition.
15579
15580 If DNS was used for successful verification, the variable
15581 .cindex "DNS" "DNSSEC"
15582 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15583
15584 .option helo_verify_hosts main "host list&!!" unset
15585 .cindex "HELO verifying" "mandatory"
15586 .cindex "EHLO" "verifying, mandatory"
15587 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15588 backwards compatibility. For hosts that match this option, Exim checks the host
15589 name given in the HELO or EHLO in the same way as for
15590 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15591 rejected with a 550 error, and entries are written to the main and reject logs.
15592 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15593 error.
15594
15595 .option hold_domains main "domain list&!!" unset
15596 .cindex "domain" "delaying delivery"
15597 .cindex "delivery" "delaying certain domains"
15598 This option allows mail for particular domains to be held in the queue
15599 manually. The option is overridden if a message delivery is forced with the
15600 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15601 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15602 item in &%hold_domains%&, no routing or delivery for that address is done, and
15603 it is deferred every time the message is looked at.
15604
15605 This option is intended as a temporary operational measure for delaying the
15606 delivery of mail while some problem is being sorted out, or some new
15607 configuration tested. If you just want to delay the processing of some
15608 domains until a queue run occurs, you should use &%queue_domains%& or
15609 &%queue_smtp_domains%&, not &%hold_domains%&.
15610
15611 A setting of &%hold_domains%& does not override Exim's code for removing
15612 messages from the queue if they have been there longer than the longest retry
15613 time in any retry rule. If you want to hold messages for longer than the normal
15614 retry times, insert a dummy retry rule with a long retry time.
15615
15616
15617 .option host_lookup main "host list&!!" unset
15618 .cindex "host name" "lookup, forcing"
15619 Exim does not look up the name of a calling host from its IP address unless it
15620 is required to compare against some host list, or the host matches
15621 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15622 option (which normally contains IP addresses rather than host names). The
15623 default configuration file contains
15624 .code
15625 host_lookup = *
15626 .endd
15627 which causes a lookup to happen for all hosts. If the expense of these lookups
15628 is felt to be too great, the setting can be changed or removed.
15629
15630 After a successful reverse lookup, Exim does a forward lookup on the name it
15631 has obtained, to verify that it yields the IP address that it started with. If
15632 this check fails, Exim behaves as if the name lookup failed.
15633
15634 .vindex "&$host_lookup_failed$&"
15635 .vindex "&$sender_host_name$&"
15636 After any kind of failure, the host name (in &$sender_host_name$&) remains
15637 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15638 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15639 &`verify = reverse_host_lookup`& in ACLs.
15640
15641
15642 .option host_lookup_order main "string list" &`bydns:byaddr`&
15643 This option specifies the order of different lookup methods when Exim is trying
15644 to find a host name from an IP address. The default is to do a DNS lookup
15645 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15646 if that fails. You can change the order of these lookups, or omit one entirely,
15647 if you want.
15648
15649 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15650 multiple PTR records in the DNS and the IP address is not listed in
15651 &_/etc/hosts_&. Different operating systems give different results in this
15652 case. That is why the default tries a DNS lookup first.
15653
15654
15655
15656 .option host_reject_connection main "host list&!!" unset
15657 .cindex "host" "rejecting connections from"
15658 If this option is set, incoming SMTP calls from the hosts listed are rejected
15659 as soon as the connection is made.
15660 This option is obsolete, and retained only for backward compatibility, because
15661 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15662 connections immediately.
15663
15664 The ability to give an immediate rejection (either by this option or using an
15665 ACL) is provided for use in unusual cases. Many hosts will just try again,
15666 sometimes without much delay. Normally, it is better to use an ACL to reject
15667 incoming messages at a later stage, such as after RCPT commands. See
15668 chapter &<<CHAPACL>>&.
15669
15670
15671 .option hosts_connection_nolog main "host list&!!" unset
15672 .cindex "host" "not logging connections from"
15673 This option defines a list of hosts for which connection logging does not
15674 happen, even though the &%smtp_connection%& log selector is set. For example,
15675 you might want not to log SMTP connections from local processes, or from
15676 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15677 the daemon; you should therefore strive to restrict its value to a short inline
15678 list of IP addresses and networks. To disable logging SMTP connections from
15679 local processes, you must create a host list with an empty item. For example:
15680 .code
15681 hosts_connection_nolog = :
15682 .endd
15683 If the &%smtp_connection%& log selector is not set, this option has no effect.
15684
15685
15686
15687 .option hosts_proxy main "host list&!!" unset
15688 .cindex proxy "proxy protocol"
15689 This option enables use of Proxy Protocol proxies for incoming
15690 connections.  For details see section &<<SECTproxyInbound>>&.
15691
15692
15693 .option hosts_treat_as_local main "domain list&!!" unset
15694 .cindex "local host" "domains treated as"
15695 .cindex "host" "treated as local"
15696 If this option is set, any host names that match the domain list are treated as
15697 if they were the local host when Exim is scanning host lists obtained from MX
15698 records
15699 or other sources. Note that the value of this option is a domain list, not a
15700 host list, because it is always used to check host names, not IP addresses.
15701
15702 This option also applies when Exim is matching the special items
15703 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15704 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15705 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15706 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15707 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15708 interfaces and recognizing the local host.
15709
15710
15711 .option ibase_servers main "string list" unset
15712 .cindex "InterBase" "server list"
15713 This option provides a list of InterBase servers and associated connection data,
15714 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15715 The option is available only if Exim has been built with InterBase support.
15716
15717
15718
15719 .option ignore_bounce_errors_after main time 10w
15720 .cindex "bounce message" "discarding"
15721 .cindex "discarding bounce message"
15722 This option affects the processing of bounce messages that cannot be delivered,
15723 that is, those that suffer a permanent delivery failure. (Bounce messages that
15724 suffer temporary delivery failures are of course retried in the usual way.)
15725
15726 After a permanent delivery failure, bounce messages are frozen,
15727 because there is no sender to whom they can be returned. When a frozen bounce
15728 message has been in the queue for more than the given time, it is unfrozen at
15729 the next queue run, and a further delivery is attempted. If delivery fails
15730 again, the bounce message is discarded. This makes it possible to keep failed
15731 bounce messages around for a shorter time than the normal maximum retry time
15732 for frozen messages. For example,
15733 .code
15734 ignore_bounce_errors_after = 12h
15735 .endd
15736 retries failed bounce message deliveries after 12 hours, discarding any further
15737 failures. If the value of this option is set to a zero time period, bounce
15738 failures are discarded immediately. Setting a very long time (as in the default
15739 value) has the effect of disabling this option. For ways of automatically
15740 dealing with other kinds of frozen message, see &%auto_thaw%& and
15741 &%timeout_frozen_after%&.
15742
15743
15744 .option ignore_fromline_hosts main "host list&!!" unset
15745 .cindex "&""From""& line"
15746 .cindex "UUCP" "&""From""& line"
15747 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15748 the headers of a message. By default this is treated as the start of the
15749 message's body, which means that any following headers are not recognized as
15750 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15751 match those hosts that insist on sending it. If the sender is actually a local
15752 process rather than a remote host, and is using &%-bs%& to inject the messages,
15753 &%ignore_fromline_local%& must be set to achieve this effect.
15754
15755
15756 .option ignore_fromline_local main boolean false
15757 See &%ignore_fromline_hosts%& above.
15758
15759 .option keep_environment main "string list" unset
15760 .cindex "environment" "values from"
15761 This option contains a string list of environment variables to keep.
15762 You have to trust these variables or you have to be sure that
15763 these variables do not impose any security risk. Keep in mind that
15764 during the startup phase Exim is running with an effective UID 0 in most
15765 installations. As the default value is an empty list, the default
15766 environment for using libraries, running embedded Perl code, or running
15767 external binaries is empty, and does not not even contain PATH or HOME.
15768
15769 Actually the list is interpreted as a list of patterns
15770 (&<<SECTlistexpand>>&), except that it is not expanded first.
15771
15772 WARNING: Macro substitution is still done first, so having a macro
15773 FOO and having FOO_HOME in your &%keep_environment%& option may have
15774 unexpected results. You may work around this using a regular expression
15775 that does not match the macro name: ^[F]OO_HOME$.
15776
15777 Current versions of Exim issue a warning during startup if you do not mention
15778 &%keep_environment%& in your runtime configuration file and if your
15779 current environment is not empty. Future versions may not issue that warning
15780 anymore.
15781
15782 See the &%add_environment%& main config option for a way to set
15783 environment variables to a fixed value.  The environment for &(pipe)&
15784 transports is handled separately, see section &<<SECTpipeenv>>& for
15785 details.
15786
15787
15788 .option keep_malformed main time 4d
15789 This option specifies the length of time to keep messages whose spool files
15790 have been corrupted in some way. This should, of course, never happen. At the
15791 next attempt to deliver such a message, it gets removed. The incident is
15792 logged.
15793
15794
15795 .option ldap_ca_cert_dir main string unset
15796 .cindex "LDAP", "TLS CA certificate directory"
15797 .cindex certificate "directory for LDAP"
15798 This option indicates which directory contains CA certificates for verifying
15799 a TLS certificate presented by an LDAP server.
15800 While Exim does not provide a default value, your SSL library may.
15801 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15802 and constrained to be a directory.
15803
15804
15805 .option ldap_ca_cert_file main string unset
15806 .cindex "LDAP", "TLS CA certificate file"
15807 .cindex certificate "file for LDAP"
15808 This option indicates which file contains CA certificates for verifying
15809 a TLS certificate presented by an LDAP server.
15810 While Exim does not provide a default value, your SSL library may.
15811 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15812 and constrained to be a file.
15813
15814
15815 .option ldap_cert_file main string unset
15816 .cindex "LDAP" "TLS client certificate file"
15817 .cindex certificate "file for LDAP"
15818 This option indicates which file contains an TLS client certificate which
15819 Exim should present to the LDAP server during TLS negotiation.
15820 Should be used together with &%ldap_cert_key%&.
15821
15822
15823 .option ldap_cert_key main string unset
15824 .cindex "LDAP" "TLS client key file"
15825 .cindex certificate "key for LDAP"
15826 This option indicates which file contains the secret/private key to use
15827 to prove identity to the LDAP server during TLS negotiation.
15828 Should be used together with &%ldap_cert_file%&, which contains the
15829 identity to be proven.
15830
15831
15832 .option ldap_cipher_suite main string unset
15833 .cindex "LDAP" "TLS cipher suite"
15834 This controls the TLS cipher-suite negotiation during TLS negotiation with
15835 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15836 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15837
15838
15839 .option ldap_default_servers main "string list" unset
15840 .cindex "LDAP" "default servers"
15841 This option provides a list of LDAP servers which are tried in turn when an
15842 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15843 details of LDAP queries. This option is available only when Exim has been built
15844 with LDAP support.
15845
15846
15847 .option ldap_require_cert main string unset.
15848 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15849 This should be one of the values "hard", "demand", "allow", "try" or "never".
15850 A value other than one of these is interpreted as "never".
15851 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15852 Although Exim does not set a default, the LDAP library probably defaults
15853 to hard/demand.
15854
15855
15856 .option ldap_start_tls main boolean false
15857 .cindex "LDAP" "whether or not to negotiate TLS"
15858 If set, Exim will attempt to negotiate TLS with the LDAP server when
15859 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15860 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15861 of SSL-on-connect.
15862 In the event of failure to negotiate TLS, the action taken is controlled
15863 by &%ldap_require_cert%&.
15864 This option is ignored for &`ldapi`& connections.
15865
15866
15867 .option ldap_version main integer unset
15868 .cindex "LDAP" "protocol version, forcing"
15869 This option can be used to force Exim to set a specific protocol version for
15870 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15871 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15872 the LDAP headers; otherwise it is 2. This option is available only when Exim
15873 has been built with LDAP support.
15874
15875
15876
15877 .option local_from_check main boolean true
15878 .cindex "&'Sender:'& header line" "disabling addition of"
15879 .cindex "&'From:'& header line" "disabling checking of"
15880 When a message is submitted locally (that is, not over a TCP/IP connection) by
15881 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15882 checks that the &'From:'& header line matches the login of the calling user and
15883 the domain specified by &%qualify_domain%&.
15884
15885 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15886 locally submitted message is automatically qualified by Exim, unless the
15887 &%-bnq%& command line option is used.
15888
15889 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15890 on the local part. If the &'From:'& header line does not match, Exim adds a
15891 &'Sender:'& header with an address constructed from the calling user's login
15892 and the default qualify domain.
15893
15894 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15895 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15896 &'Sender:'& header lines supplied by untrusted users, you must also set
15897 &%local_sender_retain%& to be true.
15898
15899 .cindex "envelope from"
15900 .cindex "envelope sender"
15901 These options affect only the header lines in the message. The envelope sender
15902 is still forced to be the login id at the qualify domain unless
15903 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15904
15905 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15906 request similar header line checking. See section &<<SECTthesenhea>>&, which
15907 has more details about &'Sender:'& processing.
15908
15909
15910
15911
15912 .option local_from_prefix main string unset
15913 When Exim checks the &'From:'& header line of locally submitted messages for
15914 matching the login id (see &%local_from_check%& above), it can be configured to
15915 ignore certain prefixes and suffixes in the local part of the address. This is
15916 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15917 appropriate lists, in the same form as the &%local_part_prefix%& and
15918 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15919 example, if
15920 .code
15921 local_from_prefix = *-
15922 .endd
15923 is set, a &'From:'& line containing
15924 .code
15925 From: anything-user@your.domain.example
15926 .endd
15927 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15928 matches the actual sender address that is constructed from the login name and
15929 qualify domain.
15930
15931
15932 .option local_from_suffix main string unset
15933 See &%local_from_prefix%& above.
15934
15935
15936 .option local_interfaces main "string list" "see below"
15937 This option controls which network interfaces are used by the daemon for
15938 listening; they are also used to identify the local host when routing. Chapter
15939 &<<CHAPinterfaces>>& contains a full description of this option and the related
15940 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15941 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15942 &%local_interfaces%& is
15943 .code
15944 local_interfaces = 0.0.0.0
15945 .endd
15946 when Exim is built without IPv6 support; otherwise it is
15947 .code
15948 local_interfaces = <; ::0 ; 0.0.0.0
15949 .endd
15950
15951 .option local_scan_timeout main time 5m
15952 .cindex "timeout" "for &[local_scan()]& function"
15953 .cindex "&[local_scan()]& function" "timeout"
15954 This timeout applies to the &[local_scan()]& function (see chapter
15955 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15956 the incoming message is rejected with a temporary error if it is an SMTP
15957 message. For a non-SMTP message, the message is dropped and Exim ends with a
15958 non-zero code. The incident is logged on the main and reject logs.
15959
15960
15961
15962 .option local_sender_retain main boolean false
15963 .cindex "&'Sender:'& header line" "retaining from local submission"
15964 When a message is submitted locally (that is, not over a TCP/IP connection) by
15965 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15966 do not want this to happen, you must set &%local_sender_retain%&, and you must
15967 also set &%local_from_check%& to be false (Exim will complain if you do not).
15968 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15969 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15970
15971
15972
15973
15974 .option localhost_number main string&!! unset
15975 .cindex "host" "locally unique number for"
15976 .cindex "message ids" "with multiple hosts"
15977 .vindex "&$localhost_number$&"
15978 Exim's message ids are normally unique only within the local host. If
15979 uniqueness among a set of hosts is required, each host must set a different
15980 value for the &%localhost_number%& option. The string is expanded immediately
15981 after reading the configuration file (so that a number can be computed from the
15982 host name, for example) and the result of the expansion must be a number in the
15983 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15984 systems). This is available in subsequent string expansions via the variable
15985 &$localhost_number$&. When &%localhost_number is set%&, the final two
15986 characters of the message id, instead of just being a fractional part of the
15987 time, are computed from the time and the local host number as described in
15988 section &<<SECTmessiden>>&.
15989
15990
15991
15992 .option log_file_path main "string list&!!" "set at compile time"
15993 .cindex "log" "file path for"
15994 This option sets the path which is used to determine the names of Exim's log
15995 files, or indicates that logging is to be to syslog, or both. It is expanded
15996 when Exim is entered, so it can, for example, contain a reference to the host
15997 name. If no specific path is set for the log files at compile or runtime,
15998 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
15999 they are written in a sub-directory called &_log_& in Exim's spool directory.
16000 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16001 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16002 used. If this string is fixed at your installation (contains no expansion
16003 variables) it is recommended that you do not set this option in the
16004 configuration file, but instead supply the path using LOG_FILE_PATH in
16005 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16006 early on &-- in particular, failure to read the configuration file.
16007
16008
16009 .option log_selector main string unset
16010 .cindex "log" "selectors"
16011 This option can be used to reduce or increase the number of things that Exim
16012 writes to its log files. Its argument is made up of names preceded by plus or
16013 minus characters. For example:
16014 .code
16015 log_selector = +arguments -retry_defer
16016 .endd
16017 A list of possible names and what they control is given in the chapter on
16018 logging, in section &<<SECTlogselector>>&.
16019
16020
16021 .option log_timezone main boolean false
16022 .cindex "log" "timezone for entries"
16023 .vindex "&$tod_log$&"
16024 .vindex "&$tod_zone$&"
16025 By default, the timestamps on log lines are in local time without the
16026 timezone. This means that if your timezone changes twice a year, the timestamps
16027 in log lines are ambiguous for an hour when the clocks go back. One way of
16028 avoiding this problem is to set the timezone to UTC. An alternative is to set
16029 &%log_timezone%& true. This turns on the addition of the timezone offset to
16030 timestamps in log lines. Turning on this option can add quite a lot to the size
16031 of log files because each line is extended by 6 characters. Note that the
16032 &$tod_log$& variable contains the log timestamp without the zone, but there is
16033 another variable called &$tod_zone$& that contains just the timezone offset.
16034
16035
16036 .option lookup_open_max main integer 25
16037 .cindex "too many open files"
16038 .cindex "open files, too many"
16039 .cindex "file" "too many open"
16040 .cindex "lookup" "maximum open files"
16041 .cindex "limit" "open files for lookups"
16042 This option limits the number of simultaneously open files for single-key
16043 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16044 Exim normally keeps these files open during routing, because often the same
16045 file is required several times. If the limit is reached, Exim closes the least
16046 recently used file. Note that if you are using the &'ndbm'& library, it
16047 actually opens two files for each logical DBM database, though it still counts
16048 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16049 open files"& errors with NDBM, you need to reduce the value of
16050 &%lookup_open_max%&.
16051
16052
16053 .option max_username_length main integer 0
16054 .cindex "length of login name"
16055 .cindex "user name" "maximum length"
16056 .cindex "limit" "user name length"
16057 Some operating systems are broken in that they truncate long arguments to
16058 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16059 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16060 an argument that is longer behaves as if &[getpwnam()]& failed.
16061
16062
16063 .option message_body_newlines main bool false
16064 .cindex "message body" "newlines in variables"
16065 .cindex "newline" "in message body variables"
16066 .vindex "&$message_body$&"
16067 .vindex "&$message_body_end$&"
16068 By default, newlines in the message body are replaced by spaces when setting
16069 the &$message_body$& and &$message_body_end$& expansion variables. If this
16070 option is set true, this no longer happens.
16071
16072
16073 .option message_body_visible main integer 500
16074 .cindex "body of message" "visible size"
16075 .cindex "message body" "visible size"
16076 .vindex "&$message_body$&"
16077 .vindex "&$message_body_end$&"
16078 This option specifies how much of a message's body is to be included in the
16079 &$message_body$& and &$message_body_end$& expansion variables.
16080
16081
16082 .option message_id_header_domain main string&!! unset
16083 .cindex "&'Message-ID:'& header line"
16084 If this option is set, the string is expanded and used as the right hand side
16085 (domain) of the &'Message-ID:'& header that Exim creates if a
16086 locally-originated incoming message does not have one. &"Locally-originated"&
16087 means &"not received over TCP/IP."&
16088 Otherwise, the primary host name is used.
16089 Only letters, digits, dot and hyphen are accepted; any other characters are
16090 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16091 empty string, the option is ignored.
16092
16093
16094 .option message_id_header_text main string&!! unset
16095 If this variable is set, the string is expanded and used to augment the text of
16096 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16097 message does not have one. The text of this header is required by RFC 2822 to
16098 take the form of an address. By default, Exim uses its internal message id as
16099 the local part, and the primary host name as the domain. If this option is set,
16100 it is expanded, and provided the expansion is not forced to fail, and does not
16101 yield an empty string, the result is inserted into the header immediately
16102 before the @, separated from the internal message id by a dot. Any characters
16103 that are illegal in an address are automatically converted into hyphens. This
16104 means that variables such as &$tod_log$& can be used, because the spaces and
16105 colons will become hyphens.
16106
16107
16108 .option message_logs main boolean true
16109 .cindex "message logs" "disabling"
16110 .cindex "log" "message log; disabling"
16111 If this option is turned off, per-message log files are not created in the
16112 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16113 Exim, by reducing the number of files involved in handling a message from a
16114 minimum of four (header spool file, body spool file, delivery journal, and
16115 per-message log) to three. The other major I/O activity is Exim's main log,
16116 which is not affected by this option.
16117
16118
16119 .option message_size_limit main string&!! 50M
16120 .cindex "message" "size limit"
16121 .cindex "limit" "message size"
16122 .cindex "size" "of message, limit"
16123 This option limits the maximum size of message that Exim will process. The
16124 value is expanded for each incoming connection so, for example, it can be made
16125 to depend on the IP address of the remote host for messages arriving via
16126 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16127 optionally followed by K or M.
16128
16129 &*Note*&: This limit cannot be made to depend on a message's sender or any
16130 other properties of an individual message, because it has to be advertised in
16131 the server's response to EHLO. String expansion failure causes a temporary
16132 error. A value of zero means no limit, but its use is not recommended. See also
16133 &%bounce_return_size_limit%&.
16134
16135 Incoming SMTP messages are failed with a 552 error if the limit is
16136 exceeded; locally-generated messages either get a stderr message or a delivery
16137 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16138 an oversized message is logged in both the main and the reject logs. See also
16139 the generic transport option &%message_size_limit%&, which limits the size of
16140 message that an individual transport can process.
16141
16142 If you use a virus-scanner and set this option to to a value larger than the
16143 maximum size that your virus-scanner is configured to support, you may get
16144 failures triggered by large mails.  The right size to configure for the
16145 virus-scanner depends upon what data is passed and the options in use but it's
16146 probably safest to just set it to a little larger than this value.  E.g., with a
16147 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16148 some problems may result.
16149
16150 A value of 0 will disable size limit checking; Exim will still advertise the
16151 SIZE extension in an EHLO response, but without a limit, so as to permit
16152 SMTP clients to still indicate the message size along with the MAIL verb.
16153
16154
16155 .option move_frozen_messages main boolean false
16156 .cindex "frozen messages" "moving"
16157 This option, which is available only if Exim has been built with the setting
16158 .code
16159 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16160 .endd
16161 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16162 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16163 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16164 standard utilities for handling such moved messages, and they do not show up in
16165 lists generated by &%-bp%& or by the Exim monitor.
16166
16167
16168 .option mua_wrapper main boolean false
16169 Setting this option true causes Exim to run in a very restrictive mode in which
16170 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16171 contains a full description of this facility.
16172
16173
16174
16175 .option mysql_servers main "string list" unset
16176 .cindex "MySQL" "server list"
16177 This option provides a list of MySQL servers and associated connection data, to
16178 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16179 option is available only if Exim has been built with MySQL support.
16180
16181
16182 .option never_users main "string list&!!" unset
16183 This option is expanded just once, at the start of Exim's processing. Local
16184 message deliveries are normally run in processes that are setuid to the
16185 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16186 It is usually desirable to prevent any deliveries from running as root, as a
16187 safety precaution.
16188
16189 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16190 list of users that must not be used for local deliveries. This list is fixed in
16191 the binary and cannot be overridden by the configuration file. By default, it
16192 contains just the single user name &"root"&. The &%never_users%& runtime option
16193 can be used to add more users to the fixed list.
16194
16195 If a message is to be delivered as one of the users on the fixed list or the
16196 &%never_users%& list, an error occurs, and delivery is deferred. A common
16197 example is
16198 .code
16199 never_users = root:daemon:bin
16200 .endd
16201 Including root is redundant if it is also on the fixed list, but it does no
16202 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16203 transport driver.
16204
16205
16206 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket"
16207 .cindex "OpenSSL "compatibility options"
16208 This option allows an administrator to adjust the SSL options applied
16209 by OpenSSL to connections.  It is given as a space-separated list of items,
16210 each one to be +added or -subtracted from the current value.
16211
16212 This option is only available if Exim is built against OpenSSL.  The values
16213 available for this option vary according to the age of your OpenSSL install.
16214 The &"all"& value controls a subset of flags which are available, typically
16215 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16216 list the values known on your system and Exim should support all the
16217 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16218 names lose the leading &"SSL_OP_"& and are lower-cased.
16219
16220 Note that adjusting the options can have severe impact upon the security of
16221 SSL as used by Exim.  It is possible to disable safety checks and shoot
16222 yourself in the foot in various unpleasant ways.  This option should not be
16223 adjusted lightly.  An unrecognised item will be detected at startup, by
16224 invoking Exim with the &%-bV%& flag.
16225
16226 The option affects Exim operating both as a server and as a client.
16227
16228 Historical note: prior to release 4.80, Exim defaulted this value to
16229 "+dont_insert_empty_fragments", which may still be needed for compatibility
16230 with some clients, but which lowers security by increasing exposure to
16231 some now infamous attacks.
16232
16233 Examples:
16234 .code
16235 # Make both old MS and old Eudora happy:
16236 openssl_options = -all +microsoft_big_sslv3_buffer \
16237                        +dont_insert_empty_fragments
16238
16239 # Disable older protocol versions:
16240 openssl_options = +no_sslv2 +no_sslv3
16241 .endd
16242
16243 Possible options may include:
16244 .ilist
16245 &`all`&
16246 .next
16247 &`allow_unsafe_legacy_renegotiation`&
16248 .next
16249 &`cipher_server_preference`&
16250 .next
16251 &`dont_insert_empty_fragments`&
16252 .next
16253 &`ephemeral_rsa`&
16254 .next
16255 &`legacy_server_connect`&
16256 .next
16257 &`microsoft_big_sslv3_buffer`&
16258 .next
16259 &`microsoft_sess_id_bug`&
16260 .next
16261 &`msie_sslv2_rsa_padding`&
16262 .next
16263 &`netscape_challenge_bug`&
16264 .next
16265 &`netscape_reuse_cipher_change_bug`&
16266 .next
16267 &`no_compression`&
16268 .next
16269 &`no_session_resumption_on_renegotiation`&
16270 .next
16271 &`no_sslv2`&
16272 .next
16273 &`no_sslv3`&
16274 .next
16275 &`no_ticket`&
16276 .next
16277 &`no_tlsv1`&
16278 .next
16279 &`no_tlsv1_1`&
16280 .next
16281 &`no_tlsv1_2`&
16282 .next
16283 &`safari_ecdhe_ecdsa_bug`&
16284 .next
16285 &`single_dh_use`&
16286 .next
16287 &`single_ecdh_use`&
16288 .next
16289 &`ssleay_080_client_dh_bug`&
16290 .next
16291 &`sslref2_reuse_cert_type_bug`&
16292 .next
16293 &`tls_block_padding_bug`&
16294 .next
16295 &`tls_d5_bug`&
16296 .next
16297 &`tls_rollback_bug`&
16298 .endlist
16299
16300 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16301 all clients connecting using the MacOS SecureTransport TLS facility prior
16302 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16303 to negotiate TLS then this option value might help, provided that your OpenSSL
16304 release is new enough to contain this work-around.  This may be a situation
16305 where you have to upgrade OpenSSL to get buggy clients working.
16306
16307
16308 .option oracle_servers main "string list" unset
16309 .cindex "Oracle" "server list"
16310 This option provides a list of Oracle servers and associated connection data,
16311 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16312 The option is available only if Exim has been built with Oracle support.
16313
16314
16315 .option percent_hack_domains main "domain list&!!" unset
16316 .cindex "&""percent hack""&"
16317 .cindex "source routing" "in email address"
16318 .cindex "address" "source-routed"
16319 The &"percent hack"& is the convention whereby a local part containing a
16320 percent sign is re-interpreted as a new email address, with the percent
16321 replaced by @. This is sometimes called &"source routing"&, though that term is
16322 also applied to RFC 2822 addresses that begin with an @ character. If this
16323 option is set, Exim implements the percent facility for those domains listed,
16324 but no others. This happens before an incoming SMTP address is tested against
16325 an ACL.
16326
16327 &*Warning*&: The &"percent hack"& has often been abused by people who are
16328 trying to get round relaying restrictions. For this reason, it is best avoided
16329 if at all possible. Unfortunately, a number of less security-conscious MTAs
16330 implement it unconditionally. If you are running Exim on a gateway host, and
16331 routing mail through to internal MTAs without processing the local parts, it is
16332 a good idea to reject recipient addresses with percent characters in their
16333 local parts. Exim's default configuration does this.
16334
16335
16336 .option perl_at_start main boolean false
16337 .cindex "Perl"
16338 This option is available only when Exim is built with an embedded Perl
16339 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16340
16341
16342 .option perl_startup main string unset
16343 .cindex "Perl"
16344 This option is available only when Exim is built with an embedded Perl
16345 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16346
16347 .option perl_startup main boolean false
16348 .cindex "Perl"
16349 This Option enables the taint mode of the embedded Perl interpreter.
16350
16351
16352 .option pgsql_servers main "string list" unset
16353 .cindex "PostgreSQL lookup type" "server list"
16354 This option provides a list of PostgreSQL servers and associated connection
16355 data, to be used in conjunction with &(pgsql)& lookups (see section
16356 &<<SECID72>>&). The option is available only if Exim has been built with
16357 PostgreSQL support.
16358
16359
16360 .option pid_file_path main string&!! "set at compile time"
16361 .cindex "daemon" "pid file path"
16362 .cindex "pid file, path for"
16363 This option sets the name of the file to which the Exim daemon writes its
16364 process id. The string is expanded, so it can contain, for example, references
16365 to the host name:
16366 .code
16367 pid_file_path = /var/log/$primary_hostname/exim.pid
16368 .endd
16369 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16370 spool directory.
16371 The value set by the option can be overridden by the &%-oP%& command line
16372 option. A pid file is not written if a &"non-standard"& daemon is run by means
16373 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16374
16375
16376 .option pipelining_advertise_hosts main "host list&!!" *
16377 .cindex "PIPELINING" "suppressing advertising"
16378 This option can be used to suppress the advertisement of the SMTP
16379 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16380 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16381 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16382 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16383 that clients will use it; &"out of order"& commands that are &"expected"& do
16384 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16385
16386 .new
16387 .option pipelining_connect_advertise_hosts main "host list&!!" *
16388 .cindex "pipelining" "early connection"
16389 .cindex "pipelining" PIPE_CONNECT
16390 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16391 this option controls which hosts the facility is advertised to
16392 and from which pipeline early-connection (before MAIL) SMTP
16393 commands are acceptable.
16394 When used, the pipelining saves on roundtrip times.
16395
16396 Currently the option name &"X_PIPE_CONNECT"& is used.
16397 .wen
16398
16399
16400 .option prdr_enable main boolean false
16401 .cindex "PRDR" "enabling on server"
16402 This option can be used to enable the Per-Recipient Data Response extension
16403 to SMTP, defined by Eric Hall.
16404 If the option is set, PRDR is advertised by Exim when operating as a server.
16405 If the client requests PRDR, and more than one recipient, for a message
16406 an additional ACL is called for each recipient after the message content
16407 is received.  See section &<<SECTPRDRACL>>&.
16408
16409 .option preserve_message_logs main boolean false
16410 .cindex "message logs" "preserving"
16411 If this option is set, message log files are not deleted when messages are
16412 completed. Instead, they are moved to a sub-directory of the spool directory
16413 called &_msglog.OLD_&, where they remain available for statistical or debugging
16414 purposes. This is a dangerous option to set on systems with any appreciable
16415 volume of mail. Use with care!
16416
16417
16418 .option primary_hostname main string "see below"
16419 .cindex "name" "of local host"
16420 .cindex "host" "name of local"
16421 .cindex "local host" "name of"
16422 .vindex "&$primary_hostname$&"
16423 This specifies the name of the current host. It is used in the default EHLO or
16424 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16425 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16426 The value is also used by default in some SMTP response messages from an Exim
16427 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16428
16429 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16430 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16431 contains only one component, Exim passes it to &[gethostbyname()]& (or
16432 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16433 version. The variable &$primary_hostname$& contains the host name, whether set
16434 explicitly by this option, or defaulted.
16435
16436
16437 .option print_topbitchars main boolean false
16438 .cindex "printing characters"
16439 .cindex "8-bit characters"
16440 By default, Exim considers only those characters whose codes lie in the range
16441 32&--126 to be printing characters. In a number of circumstances (for example,
16442 when writing log entries) non-printing characters are converted into escape
16443 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16444 is set, code values of 128 and above are also considered to be printing
16445 characters.
16446
16447 This option also affects the header syntax checks performed by the
16448 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16449 the user's full name when constructing From: and Sender: addresses (as
16450 described in section &<<SECTconstr>>&). Setting this option can cause
16451 Exim to generate eight bit message headers that do not conform to the
16452 standards.
16453
16454
16455 .option process_log_path main string unset
16456 .cindex "process log path"
16457 .cindex "log" "process log"
16458 .cindex "&'exiwhat'&"
16459 This option sets the name of the file to which an Exim process writes its
16460 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16461 utility script. If this option is unset, the file called &_exim-process.info_&
16462 in Exim's spool directory is used. The ability to specify the name explicitly
16463 can be useful in environments where two different Exims are running, using
16464 different spool directories.
16465
16466
16467 .option prod_requires_admin main boolean true
16468 .cindex "restricting access to features"
16469 .oindex "&%-M%&"
16470 .oindex "&%-R%&"
16471 .oindex "&%-q%&"
16472 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16473 admin user unless &%prod_requires_admin%& is set false. See also
16474 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16475
16476
16477 .option qualify_domain main string "see below"
16478 .cindex "domain" "for qualifying addresses"
16479 .cindex "address" "qualification"
16480 This option specifies the domain name that is added to any envelope sender
16481 addresses that do not have a domain qualification. It also applies to
16482 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16483 are accepted by default only for locally-generated messages. Qualification is
16484 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16485 locally-generated messages, unless the &%-bnq%& command line option is used.
16486
16487 Messages from external sources must always contain fully qualified addresses,
16488 unless the sending host matches &%sender_unqualified_hosts%& or
16489 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16490 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16491 necessary. Internally, Exim always works with fully qualified envelope
16492 addresses. If &%qualify_domain%& is not set, it defaults to the
16493 &%primary_hostname%& value.
16494
16495
16496 .option qualify_recipient main string "see below"
16497 This option allows you to specify a different domain for qualifying recipient
16498 addresses to the one that is used for senders. See &%qualify_domain%& above.
16499
16500
16501
16502 .option queue_domains main "domain list&!!" unset
16503 .cindex "domain" "specifying non-immediate delivery"
16504 .cindex "queueing incoming messages"
16505 .cindex "message" "queueing certain domains"
16506 This option lists domains for which immediate delivery is not required.
16507 A delivery process is started whenever a message is received, but only those
16508 domains that do not match are processed. All other deliveries wait until the
16509 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16510
16511
16512 .option queue_list_requires_admin main boolean true
16513 .cindex "restricting access to features"
16514 .oindex "&%-bp%&"
16515 The &%-bp%& command-line option, which lists the messages that are on the
16516 queue, requires the caller to be an admin user unless
16517 &%queue_list_requires_admin%& is set false.
16518 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16519
16520
16521 .option queue_only main boolean false
16522 .cindex "queueing incoming messages"
16523 .cindex "message" "queueing unconditionally"
16524 If &%queue_only%& is set, a delivery process is not automatically started
16525 whenever a message is received. Instead, the message waits in the queue for the
16526 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16527 delivered immediately when certain conditions (such as heavy load) occur.
16528
16529 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16530 and &%-odi%& command line options override &%queue_only%& unless
16531 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16532 &%queue_only_load%&, and &%smtp_accept_queue%&.
16533
16534
16535 .option queue_only_file main string unset
16536 .cindex "queueing incoming messages"
16537 .cindex "message" "queueing by file existence"
16538 This option can be set to a colon-separated list of absolute path names, each
16539 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16540 it tests for the existence of each listed path using a call to &[stat()]&. For
16541 each path that exists, the corresponding queueing option is set.
16542 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16543 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16544 .code
16545 queue_only_file = smtp/some/file
16546 .endd
16547 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16548 &_/some/file_& exists.
16549
16550
16551 .option queue_only_load main fixed-point unset
16552 .cindex "load average"
16553 .cindex "queueing incoming messages"
16554 .cindex "message" "queueing by load"
16555 If the system load average is higher than this value, incoming messages from
16556 all sources are queued, and no automatic deliveries are started. If this
16557 happens during local or remote SMTP input, all subsequent messages received on
16558 the same SMTP connection are queued by default, whatever happens to the load in
16559 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16560 false.
16561
16562 Deliveries will subsequently be performed by queue runner processes. This
16563 option has no effect on ancient operating systems on which Exim cannot
16564 determine the load average. See also &%deliver_queue_load_max%& and
16565 &%smtp_load_reserve%&.
16566
16567
16568 .option queue_only_load_latch main boolean true
16569 .cindex "load average" "re-evaluating per message"
16570 When this option is true (the default), once one message has been queued
16571 because the load average is higher than the value set by &%queue_only_load%&,
16572 all subsequent messages received on the same SMTP connection are also queued.
16573 This is a deliberate choice; even though the load average may fall below the
16574 threshold, it doesn't seem right to deliver later messages on the same
16575 connection when not delivering earlier ones. However, there are special
16576 circumstances such as very long-lived connections from scanning appliances
16577 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16578 should be set false. This causes the value of the load average to be
16579 re-evaluated for each message.
16580
16581
16582 .option queue_only_override main boolean true
16583 .cindex "queueing incoming messages"
16584 When this option is true, the &%-od%&&'x'& command line options override the
16585 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16586 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16587 to override; they are accepted, but ignored.
16588
16589
16590 .option queue_run_in_order main boolean false
16591 .cindex "queue runner" "processing messages in order"
16592 If this option is set, queue runs happen in order of message arrival instead of
16593 in an arbitrary order. For this to happen, a complete list of the entire queue
16594 must be set up before the deliveries start. When the queue is all held in a
16595 single directory (the default), a single list is created for both the ordered
16596 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16597 single list is not created when &%queue_run_in_order%& is false. In this case,
16598 the sub-directories are processed one at a time (in a random order), and this
16599 avoids setting up one huge list for the whole queue. Thus, setting
16600 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16601 when the queue is large, because of the extra work in setting up the single,
16602 large list. In most situations, &%queue_run_in_order%& should not be set.
16603
16604
16605
16606 .option queue_run_max main integer&!! 5
16607 .cindex "queue runner" "maximum number of"
16608 This controls the maximum number of queue runner processes that an Exim daemon
16609 can run simultaneously. This does not mean that it starts them all at once,
16610 but rather that if the maximum number are still running when the time comes to
16611 start another one, it refrains from starting another one. This can happen with
16612 very large queues and/or very sluggish deliveries. This option does not,
16613 however, interlock with other processes, so additional queue runners can be
16614 started by other means, or by killing and restarting the daemon.
16615
16616 Setting this option to zero does not suppress queue runs; rather, it disables
16617 the limit, allowing any number of simultaneous queue runner processes to be
16618 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16619 the daemon's command line.
16620
16621 .cindex queues named
16622 .cindex "named queues"
16623 To set limits for different named queues use
16624 an expansion depending on the &$queue_name$& variable.
16625
16626 .option queue_smtp_domains main "domain list&!!" unset
16627 .cindex "queueing incoming messages"
16628 .cindex "message" "queueing remote deliveries"
16629 When this option is set, a delivery process is started whenever a message is
16630 received, routing is performed, and local deliveries take place.
16631 However, if any SMTP deliveries are required for domains that match
16632 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16633 message waits in the queue for the next queue run. Since routing of the message
16634 has taken place, Exim knows to which remote hosts it must be delivered, and so
16635 when the queue run happens, multiple messages for the same host are delivered
16636 over a single SMTP connection. The &%-odqs%& command line option causes all
16637 SMTP deliveries to be queued in this way, and is equivalent to setting
16638 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16639 &%queue_domains%&.
16640
16641
16642 .option receive_timeout main time 0s
16643 .cindex "timeout" "for non-SMTP input"
16644 This option sets the timeout for accepting a non-SMTP message, that is, the
16645 maximum time that Exim waits when reading a message on the standard input. If
16646 the value is zero, it will wait forever. This setting is overridden by the
16647 &%-or%& command line option. The timeout for incoming SMTP messages is
16648 controlled by &%smtp_receive_timeout%&.
16649
16650 .option received_header_text main string&!! "see below"
16651 .cindex "customizing" "&'Received:'& header"
16652 .cindex "&'Received:'& header line" "customizing"
16653 This string defines the contents of the &'Received:'& message header that is
16654 added to each message, except for the timestamp, which is automatically added
16655 on at the end (preceded by a semicolon). The string is expanded each time it is
16656 used. If the expansion yields an empty string, no &'Received:'& header line is
16657 added to the message. Otherwise, the string should start with the text
16658 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16659 header lines.
16660 .new
16661 The default setting is:
16662
16663 .code
16664 received_header_text = Received: \
16665   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16666     {${if def:sender_ident \
16667       {from ${quote_local_part:$sender_ident} }}\
16668         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16669   by $primary_hostname \
16670   ${if def:received_protocol {with $received_protocol }}\
16671   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16672   (Exim $version_number)\n\t\
16673   ${if def:sender_address \
16674   {(envelope-from <$sender_address>)\n\t}}\
16675   id $message_exim_id\
16676   ${if def:received_for {\n\tfor $received_for}}
16677 .endd
16678 .wen
16679
16680 The reference to the TLS cipher is omitted when Exim is built without TLS
16681 support. The use of conditional expansions ensures that this works for both
16682 locally generated messages and messages received from remote hosts, giving
16683 header lines such as the following:
16684 .code
16685 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16686 by marley.carol.example with esmtp (Exim 4.00)
16687 (envelope-from <bob@carol.example>)
16688 id 16IOWa-00019l-00
16689 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16690 Received: by scrooge.carol.example with local (Exim 4.00)
16691 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16692 .endd
16693 Until the body of the message has been received, the timestamp is the time when
16694 the message started to be received. Once the body has arrived, and all policy
16695 checks have taken place, the timestamp is updated to the time at which the
16696 message was accepted.
16697
16698
16699 .option received_headers_max main integer 30
16700 .cindex "loop" "prevention"
16701 .cindex "mail loop prevention"
16702 .cindex "&'Received:'& header line" "counting"
16703 When a message is to be delivered, the number of &'Received:'& headers is
16704 counted, and if it is greater than this parameter, a mail loop is assumed to
16705 have occurred, the delivery is abandoned, and an error message is generated.
16706 This applies to both local and remote deliveries.
16707
16708
16709 .option recipient_unqualified_hosts main "host list&!!" unset
16710 .cindex "unqualified addresses"
16711 .cindex "host" "unqualified addresses from"
16712 This option lists those hosts from which Exim is prepared to accept unqualified
16713 recipient addresses in message envelopes. The addresses are made fully
16714 qualified by the addition of the &%qualify_recipient%& value. This option also
16715 affects message header lines. Exim does not reject unqualified recipient
16716 addresses in headers, but it qualifies them only if the message came from a
16717 host that matches &%recipient_unqualified_hosts%&,
16718 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16719 option was not set.
16720
16721
16722 .option recipients_max main integer 0
16723 .cindex "limit" "number of recipients"
16724 .cindex "recipient" "maximum number"
16725 If this option is set greater than zero, it specifies the maximum number of
16726 original recipients for any message. Additional recipients that are generated
16727 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16728 all recipients over the limit; earlier recipients are delivered as normal.
16729 Non-SMTP messages with too many recipients are failed, and no deliveries are
16730 done.
16731
16732 .cindex "RCPT" "maximum number of incoming"
16733 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16734 RCPT commands in a single message.
16735
16736
16737 .option recipients_max_reject main boolean false
16738 If this option is set true, Exim rejects SMTP messages containing too many
16739 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16740 error to the eventual DATA command. Otherwise (the default) it gives a 452
16741 error to the surplus RCPT commands and accepts the message on behalf of the
16742 initial set of recipients. The remote server should then re-send the message
16743 for the remaining recipients at a later time.
16744
16745
16746 .option remote_max_parallel main integer 2
16747 .cindex "delivery" "parallelism for remote"
16748 This option controls parallel delivery of one message to a number of remote
16749 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16750 does all the remote deliveries for a message one by one. Otherwise, if a single
16751 message has to be delivered to more than one remote host, or if several copies
16752 have to be sent to the same remote host, up to &%remote_max_parallel%&
16753 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16754 deliveries are required, the maximum number of processes are started, and as
16755 each one finishes, another is begun. The order of starting processes is the
16756 same as if sequential delivery were being done, and can be controlled by the
16757 &%remote_sort_domains%& option. If parallel delivery takes place while running
16758 with debugging turned on, the debugging output from each delivery process is
16759 tagged with its process id.
16760
16761 This option controls only the maximum number of parallel deliveries for one
16762 message in one Exim delivery process. Because Exim has no central queue
16763 manager, there is no way of controlling the total number of simultaneous
16764 deliveries if the configuration allows a delivery attempt as soon as a message
16765 is received.
16766
16767 .cindex "number of deliveries"
16768 .cindex "delivery" "maximum number of"
16769 If you want to control the total number of deliveries on the system, you
16770 need to set the &%queue_only%& option. This ensures that all incoming messages
16771 are added to the queue without starting a delivery process. Then set up an Exim
16772 daemon to start queue runner processes at appropriate intervals (probably
16773 fairly often, for example, every minute), and limit the total number of queue
16774 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16775 delivers only one message at a time, the maximum number of deliveries that can
16776 then take place at once is &%queue_run_max%& multiplied by
16777 &%remote_max_parallel%&.
16778
16779 If it is purely remote deliveries you want to control, use
16780 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16781 doing the SMTP routing before queueing, so that several messages for the same
16782 host will eventually get delivered down the same connection.
16783
16784
16785 .option remote_sort_domains main "domain list&!!" unset
16786 .cindex "sorting remote deliveries"
16787 .cindex "delivery" "sorting remote"
16788 When there are a number of remote deliveries for a message, they are sorted by
16789 domain into the order given by this list. For example,
16790 .code
16791 remote_sort_domains = *.cam.ac.uk:*.uk
16792 .endd
16793 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16794 then to those in the &%uk%& domain, then to any others.
16795
16796
16797 .option retry_data_expire main time 7d
16798 .cindex "hints database" "data expiry"
16799 This option sets a &"use before"& time on retry information in Exim's hints
16800 database. Any older retry data is ignored. This means that, for example, once a
16801 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16802 past failures.
16803
16804
16805 .option retry_interval_max main time 24h
16806 .cindex "retry" "limit on interval"
16807 .cindex "limit" "on retry interval"
16808 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16809 intervals between delivery attempts for messages that cannot be delivered
16810 straight away. This option sets an overall limit to the length of time between
16811 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16812 the default value.
16813
16814
16815 .option return_path_remove main boolean true
16816 .cindex "&'Return-path:'& header line" "removing"
16817 RFC 2821, section 4.4, states that an SMTP server must insert a
16818 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16819 The &'Return-path:'& header preserves the sender address as received in the
16820 MAIL command. This description implies that this header should not be present
16821 in an incoming message. If &%return_path_remove%& is true, any existing
16822 &'Return-path:'& headers are removed from messages at the time they are
16823 received. Exim's transports have options for adding &'Return-path:'& headers at
16824 the time of delivery. They are normally used only for final local deliveries.
16825
16826
16827 .option return_size_limit main integer 100K
16828 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16829
16830
16831 .option rfc1413_hosts main "host list&!!" @[]
16832 .cindex "RFC 1413"
16833 .cindex "host" "for RFC 1413 calls"
16834 RFC 1413 identification calls are made to any client host which matches
16835 an item in the list.
16836 The default value specifies just this host, being any local interface
16837 for the system.
16838
16839 .option rfc1413_query_timeout main time 0s
16840 .cindex "RFC 1413" "query timeout"
16841 .cindex "timeout" "for RFC 1413 call"
16842 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16843 no RFC 1413 calls are ever made.
16844
16845
16846 .option sender_unqualified_hosts main "host list&!!" unset
16847 .cindex "unqualified addresses"
16848 .cindex "host" "unqualified addresses from"
16849 This option lists those hosts from which Exim is prepared to accept unqualified
16850 sender addresses. The addresses are made fully qualified by the addition of
16851 &%qualify_domain%&. This option also affects message header lines. Exim does
16852 not reject unqualified addresses in headers that contain sender addresses, but
16853 it qualifies them only if the message came from a host that matches
16854 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16855 using TCP/IP), and the &%-bnq%& option was not set.
16856
16857 .option set_environment main "string list" empty
16858 .cindex "environment"
16859 This option allows to set individual environment variables that the
16860 currently linked libraries and programs in child processes use. The
16861 default list is empty,
16862
16863
16864 .option slow_lookup_log main integer 0
16865 .cindex "logging" "slow lookups"
16866 .cindex "dns" "logging slow lookups"
16867 This option controls logging of slow lookups.
16868 If the value is nonzero it is taken as a number of milliseconds
16869 and lookups taking longer than this are logged.
16870 Currently this applies only to DNS lookups.
16871
16872
16873
16874 .option smtp_accept_keepalive main boolean true
16875 .cindex "keepalive" "on incoming connection"
16876 This option controls the setting of the SO_KEEPALIVE option on incoming
16877 TCP/IP socket connections. When set, it causes the kernel to probe idle
16878 connections periodically, by sending packets with &"old"& sequence numbers. The
16879 other end of the connection should send an acknowledgment if the connection is
16880 still okay or a reset if the connection has been aborted. The reason for doing
16881 this is that it has the beneficial effect of freeing up certain types of
16882 connection that can get stuck when the remote host is disconnected without
16883 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16884 hours to detect unreachable hosts.
16885
16886
16887
16888 .option smtp_accept_max main integer 20
16889 .cindex "limit" "incoming SMTP connections"
16890 .cindex "SMTP" "incoming connection count"
16891 .cindex "inetd"
16892 This option specifies the maximum number of simultaneous incoming SMTP calls
16893 that Exim will accept. It applies only to the listening daemon; there is no
16894 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16895 value is set to zero, no limit is applied. However, it is required to be
16896 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16897 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16898
16899 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16900 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16901 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16902 and &%smtp_load_reserve%& are then checked before accepting the connection.
16903
16904
16905 .option smtp_accept_max_nonmail main integer 10
16906 .cindex "limit" "non-mail SMTP commands"
16907 .cindex "SMTP" "limiting non-mail commands"
16908 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16909 the connection if there are too many. This option defines &"too many"&. The
16910 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16911 client looping sending EHLO, for example. The check is applied only if the
16912 client host matches &%smtp_accept_max_nonmail_hosts%&.
16913
16914 When a new message is expected, one occurrence of RSET is not counted. This
16915 allows a client to send one RSET between messages (this is not necessary,
16916 but some clients do it). Exim also allows one uncounted occurrence of HELO
16917 or EHLO, and one occurrence of STARTTLS between messages. After
16918 starting up a TLS session, another EHLO is expected, and so it too is not
16919 counted. The first occurrence of AUTH in a connection, or immediately
16920 following STARTTLS is not counted. Otherwise, all commands other than
16921 MAIL, RCPT, DATA, and QUIT are counted.
16922
16923
16924 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16925 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16926 check by setting this option. The default value makes it apply to all hosts. By
16927 changing the value, you can exclude any badly-behaved hosts that you have to
16928 live with.
16929
16930
16931 . Allow this long option name to split; give it unsplit as a fifth argument
16932 . for the automatic .oindex that is generated by .option.
16933 . We insert " &~&~" which is both pretty nasty visually and results in
16934 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16935 . zero-width-space, which would be nicer visually and results in (at least)
16936 . html that Firefox will split on when it's forced to reflow (rather than
16937 . inserting a horizontal scrollbar).  However, the text is still not
16938 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16939 . the option name to split.
16940
16941 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16942          smtp_accept_max_per_connection
16943 .cindex "SMTP" "limiting incoming message count"
16944 .cindex "limit" "messages per SMTP connection"
16945 The value of this option limits the number of MAIL commands that Exim is
16946 prepared to accept over a single SMTP connection, whether or not each command
16947 results in the transfer of a message. After the limit is reached, a 421
16948 response is given to subsequent MAIL commands. This limit is a safety
16949 precaution against a client that goes mad (incidents of this type have been
16950 seen).
16951
16952
16953 .option smtp_accept_max_per_host main string&!! unset
16954 .cindex "limit" "SMTP connections from one host"
16955 .cindex "host" "limiting SMTP connections from"
16956 This option restricts the number of simultaneous IP connections from a single
16957 host (strictly, from a single IP address) to the Exim daemon. The option is
16958 expanded, to enable different limits to be applied to different hosts by
16959 reference to &$sender_host_address$&. Once the limit is reached, additional
16960 connection attempts from the same host are rejected with error code 421. This
16961 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16962 of zero imposes no limit. If this option is set greater than zero, it is
16963 required that &%smtp_accept_max%& be non-zero.
16964
16965 &*Warning*&: When setting this option you should not use any expansion
16966 constructions that take an appreciable amount of time. The expansion and test
16967 happen in the main daemon loop, in order to reject additional connections
16968 without forking additional processes (otherwise a denial-of-service attack
16969 could cause a vast number or processes to be created). While the daemon is
16970 doing this processing, it cannot accept any other incoming connections.
16971
16972
16973
16974 .option smtp_accept_queue main integer 0
16975 .cindex "SMTP" "incoming connection count"
16976 .cindex "queueing incoming messages"
16977 .cindex "message" "queueing by SMTP connection count"
16978 If the number of simultaneous incoming SMTP connections being handled via the
16979 listening daemon exceeds this value, messages received by SMTP are just placed
16980 in the queue; no delivery processes are started automatically. The count is
16981 fixed at the start of an SMTP connection. It cannot be updated in the
16982 subprocess that receives messages, and so the queueing or not queueing applies
16983 to all messages received in the same connection.
16984
16985 A value of zero implies no limit, and clearly any non-zero value is useful only
16986 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16987 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16988 various &%-od%&&'x'& command line options.
16989
16990
16991 . See the comment on smtp_accept_max_per_connection
16992
16993 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16994          smtp_accept_queue_per_connection
16995 .cindex "queueing incoming messages"
16996 .cindex "message" "queueing by message count"
16997 This option limits the number of delivery processes that Exim starts
16998 automatically when receiving messages via SMTP, whether via the daemon or by
16999 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17000 and the number of messages received in a single SMTP session exceeds this
17001 number, subsequent messages are placed in the queue, but no delivery processes
17002 are started. This helps to limit the number of Exim processes when a server
17003 restarts after downtime and there is a lot of mail waiting for it on other
17004 systems. On large systems, the default should probably be increased, and on
17005 dial-in client systems it should probably be set to zero (that is, disabled).
17006
17007
17008 .option smtp_accept_reserve main integer 0
17009 .cindex "SMTP" "incoming call count"
17010 .cindex "host" "reserved"
17011 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17012 number of SMTP connections that are reserved for connections from the hosts
17013 that are specified in &%smtp_reserve_hosts%&. The value set in
17014 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17015 restricted to this number of connections; the option specifies a minimum number
17016 of connection slots for them, not a maximum. It is a guarantee that this group
17017 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17018 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17019 individual host.
17020
17021 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17022 set to 5, once there are 45 active connections (from any hosts), new
17023 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17024 provided the other criteria for acceptance are met.
17025
17026
17027 .option smtp_active_hostname main string&!! unset
17028 .cindex "host" "name in SMTP responses"
17029 .cindex "SMTP" "host name in responses"
17030 .vindex "&$primary_hostname$&"
17031 This option is provided for multi-homed servers that want to masquerade as
17032 several different hosts. At the start of an incoming SMTP connection, its value
17033 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17034 responses. For example, it is used as domain name in the response to an
17035 incoming HELO or EHLO command.
17036
17037 .vindex "&$smtp_active_hostname$&"
17038 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17039 is saved with any messages that are received. It is therefore available for use
17040 in routers and transports when the message is later delivered.
17041
17042 If this option is unset, or if its expansion is forced to fail, or if the
17043 expansion results in an empty string, the value of &$primary_hostname$& is
17044 used. Other expansion failures cause a message to be written to the main and
17045 panic logs, and the SMTP command receives a temporary error. Typically, the
17046 value of &%smtp_active_hostname%& depends on the incoming interface address.
17047 For example:
17048 .code
17049 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17050   {cox.mydomain}{box.mydomain}}
17051 .endd
17052
17053 Although &$smtp_active_hostname$& is primarily concerned with incoming
17054 messages, it is also used as the default for HELO commands in callout
17055 verification if there is no remote transport from which to obtain a
17056 &%helo_data%& value.
17057
17058 .option smtp_banner main string&!! "see below"
17059 .cindex "SMTP" "welcome banner"
17060 .cindex "banner for SMTP"
17061 .cindex "welcome banner for SMTP"
17062 .cindex "customizing" "SMTP banner"
17063 This string, which is expanded every time it is used, is output as the initial
17064 positive response to an SMTP connection. The default setting is:
17065 .code
17066 smtp_banner = $smtp_active_hostname ESMTP Exim \
17067   $version_number $tod_full
17068 .endd
17069 Failure to expand the string causes a panic error. If you want to create a
17070 multiline response to the initial SMTP connection, use &"\n"& in the string at
17071 appropriate points, but not at the end. Note that the 220 code is not included
17072 in this string. Exim adds it automatically (several times in the case of a
17073 multiline response).
17074
17075
17076 .option smtp_check_spool_space main boolean true
17077 .cindex "checking disk space"
17078 .cindex "disk space, checking"
17079 .cindex "spool directory" "checking space"
17080 When this option is set, if an incoming SMTP session encounters the SIZE
17081 option on a MAIL command, it checks that there is enough space in the
17082 spool directory's partition to accept a message of that size, while still
17083 leaving free the amount specified by &%check_spool_space%& (even if that value
17084 is zero). If there isn't enough space, a temporary error code is returned.
17085
17086
17087 .option smtp_connect_backlog main integer 20
17088 .cindex "connection backlog"
17089 .cindex "SMTP" "connection backlog"
17090 .cindex "backlog of connections"
17091 This option specifies a maximum number of waiting SMTP connections. Exim passes
17092 this value to the TCP/IP system when it sets up its listener. Once this number
17093 of connections are waiting for the daemon's attention, subsequent connection
17094 attempts are refused at the TCP/IP level. At least, that is what the manuals
17095 say; in some circumstances such connection attempts have been observed to time
17096 out instead. For large systems it is probably a good idea to increase the
17097 value (to 50, say). It also gives some protection against denial-of-service
17098 attacks by SYN flooding.
17099
17100
17101 .option smtp_enforce_sync main boolean true
17102 .cindex "SMTP" "synchronization checking"
17103 .cindex "synchronization checking in SMTP"
17104 The SMTP protocol specification requires the client to wait for a response from
17105 the server at certain points in the dialogue. Without PIPELINING these
17106 synchronization points are after every command; with PIPELINING they are
17107 fewer, but they still exist.
17108
17109 Some spamming sites send out a complete set of SMTP commands without waiting
17110 for any response. Exim protects against this by rejecting a message if the
17111 client has sent further input when it should not have. The error response &"554
17112 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17113 for this error cannot be perfect because of transmission delays (unexpected
17114 input may be on its way but not yet received when Exim checks). However, it
17115 does detect many instances.
17116
17117 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17118 If you want to disable the check selectively (for example, only for certain
17119 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17120 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17121
17122
17123
17124 .option smtp_etrn_command main string&!! unset
17125 .cindex "ETRN" "command to be run"
17126 .vindex "&$domain$&"
17127 If this option is set, the given command is run whenever an SMTP ETRN
17128 command is received from a host that is permitted to issue such commands (see
17129 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17130 are independently expanded. The expansion variable &$domain$& is set to the
17131 argument of the ETRN command, and no syntax checking is done on it. For
17132 example:
17133 .code
17134 smtp_etrn_command = /etc/etrn_command $domain \
17135                     $sender_host_address
17136 .endd
17137 A new process is created to run the command, but Exim does not wait for it to
17138 complete. Consequently, its status cannot be checked. If the command cannot be
17139 run, a line is written to the panic log, but the ETRN caller still receives
17140 a 250 success response. Exim is normally running under its own uid when
17141 receiving SMTP, so it is not possible for it to change the uid before running
17142 the command.
17143
17144
17145 .option smtp_etrn_serialize main boolean true
17146 .cindex "ETRN" "serializing"
17147 When this option is set, it prevents the simultaneous execution of more than
17148 one identical command as a result of ETRN in an SMTP connection. See
17149 section &<<SECTETRN>>& for details.
17150
17151
17152 .option smtp_load_reserve main fixed-point unset
17153 .cindex "load average"
17154 If the system load average ever gets higher than this, incoming SMTP calls are
17155 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17156 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17157 the load is over the limit. The option has no effect on ancient operating
17158 systems on which Exim cannot determine the load average. See also
17159 &%deliver_queue_load_max%& and &%queue_only_load%&.
17160
17161
17162
17163 .option smtp_max_synprot_errors main integer 3
17164 .cindex "SMTP" "limiting syntax and protocol errors"
17165 .cindex "limit" "SMTP syntax and protocol errors"
17166 Exim rejects SMTP commands that contain syntax or protocol errors. In
17167 particular, a syntactically invalid email address, as in this command:
17168 .code
17169 RCPT TO:<abc xyz@a.b.c>
17170 .endd
17171 causes immediate rejection of the command, before any other tests are done.
17172 (The ACL cannot be run if there is no valid address to set up for it.) An
17173 example of a protocol error is receiving RCPT before MAIL. If there are
17174 too many syntax or protocol errors in one SMTP session, the connection is
17175 dropped. The limit is set by this option.
17176
17177 .cindex "PIPELINING" "expected errors"
17178 When the PIPELINING extension to SMTP is in use, some protocol errors are
17179 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17180 Exim assumes that PIPELINING will be used if it advertises it (see
17181 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17182 not count towards the limit.
17183
17184
17185
17186 .option smtp_max_unknown_commands main integer 3
17187 .cindex "SMTP" "limiting unknown commands"
17188 .cindex "limit" "unknown SMTP commands"
17189 If there are too many unrecognized commands in an incoming SMTP session, an
17190 Exim server drops the connection. This is a defence against some kinds of abuse
17191 that subvert web
17192 clients
17193 into making connections to SMTP ports; in these circumstances, a number of
17194 non-SMTP command lines are sent first.
17195
17196
17197
17198 .option smtp_ratelimit_hosts main "host list&!!" unset
17199 .cindex "SMTP" "rate limiting"
17200 .cindex "limit" "rate of message arrival"
17201 .cindex "RCPT" "rate limiting"
17202 Some sites find it helpful to be able to limit the rate at which certain hosts
17203 can send them messages, and the rate at which an individual message can specify
17204 recipients.
17205
17206 Exim has two rate-limiting facilities. This section describes the older
17207 facility, which can limit rates within a single connection. The newer
17208 &%ratelimit%& ACL condition can limit rates across all connections. See section
17209 &<<SECTratelimiting>>& for details of the newer facility.
17210
17211 When a host matches &%smtp_ratelimit_hosts%&, the values of
17212 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17213 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17214 respectively. Each option, if set, must contain a set of four comma-separated
17215 values:
17216
17217 .ilist
17218 A threshold, before which there is no rate limiting.
17219 .next
17220 An initial time delay. Unlike other times in Exim, numbers with decimal
17221 fractional parts are allowed here.
17222 .next
17223 A factor by which to increase the delay each time.
17224 .next
17225 A maximum value for the delay. This should normally be less than 5 minutes,
17226 because after that time, the client is liable to timeout the SMTP command.
17227 .endlist
17228
17229 For example, these settings have been used successfully at the site which
17230 first suggested this feature, for controlling mail from their customers:
17231 .code
17232 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17233 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17234 .endd
17235 The first setting specifies delays that are applied to MAIL commands after
17236 two have been received over a single connection. The initial delay is 0.5
17237 seconds, increasing by a factor of 1.05 each time. The second setting applies
17238 delays to RCPT commands when more than four occur in a single message.
17239
17240
17241 .option smtp_ratelimit_mail main string unset
17242 See &%smtp_ratelimit_hosts%& above.
17243
17244
17245 .option smtp_ratelimit_rcpt main string unset
17246 See &%smtp_ratelimit_hosts%& above.
17247
17248
17249 .option smtp_receive_timeout main time&!! 5m
17250 .cindex "timeout" "for SMTP input"
17251 .cindex "SMTP" "input timeout"
17252 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17253 input, including batch SMTP. If a line of input (either an SMTP command or a
17254 data line) is not received within this time, the SMTP connection is dropped and
17255 the message is abandoned.
17256 A line is written to the log containing one of the following messages:
17257 .code
17258 SMTP command timeout on connection from...
17259 SMTP data timeout on connection from...
17260 .endd
17261 The former means that Exim was expecting to read an SMTP command; the latter
17262 means that it was in the DATA phase, reading the contents of a message.
17263
17264 If the first character of the option is a &"$"& the option is
17265 expanded before use and may depend on
17266 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17267
17268
17269 .oindex "&%-os%&"
17270 The value set by this option can be overridden by the
17271 &%-os%& command-line option. A setting of zero time disables the timeout, but
17272 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17273 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17274 timeout is controlled by &%receive_timeout%& and &%-or%&.
17275
17276
17277 .option smtp_reserve_hosts main "host list&!!" unset
17278 This option defines hosts for which SMTP connections are reserved; see
17279 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17280
17281
17282 .option smtp_return_error_details main boolean false
17283 .cindex "SMTP" "details policy failures"
17284 .cindex "policy control" "rejection, returning details"
17285 In the default state, Exim uses bland messages such as
17286 &"Administrative prohibition"& when it rejects SMTP commands for policy
17287 reasons. Many sysadmins like this because it gives away little information
17288 to spammers. However, some other sysadmins who are applying strict checking
17289 policies want to give out much fuller information about failures. Setting
17290 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17291 example, instead of &"Administrative prohibition"&, it might give:
17292 .code
17293 550-Rejected after DATA: '>' missing at end of address:
17294 550 failing address in "From" header is: <user@dom.ain
17295 .endd
17296
17297
17298 .option smtputf8_advertise_hosts main "host list&!!" *
17299 .cindex "SMTPUTF8" "advertising"
17300 When Exim is built with support for internationalised mail names,
17301 the availability thereof is advertised in
17302 response to EHLO only to those client hosts that match this option. See
17303 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17304
17305
17306 .option spamd_address main string "127.0.0.1 783"
17307 This option is available when Exim is compiled with the content-scanning
17308 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17309 See section &<<SECTscanspamass>>& for more details.
17310
17311
17312
17313 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17314 This option is available when Exim is compiled with SPF support.
17315 See section &<<SECSPF>>& for more details.
17316
17317
17318
17319 .option split_spool_directory main boolean false
17320 .cindex "multiple spool directories"
17321 .cindex "spool directory" "split"
17322 .cindex "directories, multiple"
17323 If this option is set, it causes Exim to split its input directory into 62
17324 subdirectories, each with a single alphanumeric character as its name. The
17325 sixth character of the message id is used to allocate messages to
17326 subdirectories; this is the least significant base-62 digit of the time of
17327 arrival of the message.
17328
17329 Splitting up the spool in this way may provide better performance on systems
17330 where there are long mail queues, by reducing the number of files in any one
17331 directory. The msglog directory is also split up in a similar way to the input
17332 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17333 are still placed in the single directory &_msglog.OLD_&.
17334
17335 It is not necessary to take any special action for existing messages when
17336 changing &%split_spool_directory%&. Exim notices messages that are in the
17337 &"wrong"& place, and continues to process them. If the option is turned off
17338 after a period of being on, the subdirectories will eventually empty and be
17339 automatically deleted.
17340
17341 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17342 changes. Instead of creating a list of all messages in the queue, and then
17343 trying to deliver each one, in turn, it constructs a list of those in one
17344 sub-directory and tries to deliver them, before moving on to the next
17345 sub-directory. The sub-directories are processed in a random order. This
17346 spreads out the scanning of the input directories, and uses less memory. It is
17347 particularly beneficial when there are lots of messages in the queue. However,
17348 if &%queue_run_in_order%& is set, none of this new processing happens. The
17349 entire queue has to be scanned and sorted before any deliveries can start.
17350
17351
17352 .option spool_directory main string&!! "set at compile time"
17353 .cindex "spool directory" "path to"
17354 This defines the directory in which Exim keeps its spool, that is, the messages
17355 it is waiting to deliver. The default value is taken from the compile-time
17356 configuration setting, if there is one. If not, this option must be set. The
17357 string is expanded, so it can contain, for example, a reference to
17358 &$primary_hostname$&.
17359
17360 If the spool directory name is fixed on your installation, it is recommended
17361 that you set it at build time rather than from this option, particularly if the
17362 log files are being written to the spool directory (see &%log_file_path%&).
17363 Otherwise log files cannot be used for errors that are detected early on, such
17364 as failures in the configuration file.
17365
17366 By using this option to override the compiled-in path, it is possible to run
17367 tests of Exim without using the standard spool.
17368
17369 .option spool_wireformat main boolean false
17370 .cindex "spool directory" "file formats"
17371 If this option is set, Exim may for some messages use an alternative format
17372 for data-files in the spool which matches the wire format.
17373 Doing this permits more efficient message reception and transmission.
17374 Currently it is only done for messages received using the ESMTP CHUNKING
17375 option.
17376
17377 The following variables will not have useful values:
17378 .code
17379 $max_received_linelength
17380 $body_linecount
17381 $body_zerocount
17382 .endd
17383
17384 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17385 and any external programs which are passed a reference to a message data file
17386 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17387 will need to be aware of the different formats potentially available.
17388
17389 Using any of the ACL conditions noted will negate the reception benefit
17390 (as a Unix-mbox-format file is constructed for them).
17391 The transmission benefit is maintained.
17392
17393 .option sqlite_lock_timeout main time 5s
17394 .cindex "sqlite lookup type" "lock timeout"
17395 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17396 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17397
17398 .option strict_acl_vars main boolean false
17399 .cindex "&ACL;" "variables, handling unset"
17400 This option controls what happens if a syntactically valid but undefined ACL
17401 variable is referenced. If it is false (the default), an empty string
17402 is substituted; if it is true, an error is generated. See section
17403 &<<SECTaclvariables>>& for details of ACL variables.
17404
17405 .option strip_excess_angle_brackets main boolean false
17406 .cindex "angle brackets, excess"
17407 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17408 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17409 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17410 passed on to another MTA, the excess angle brackets are not passed on. If this
17411 option is not set, multiple pairs of angle brackets cause a syntax error.
17412
17413
17414 .option strip_trailing_dot main boolean false
17415 .cindex "trailing dot on domain"
17416 .cindex "dot" "trailing on domain"
17417 If this option is set, a trailing dot at the end of a domain in an address is
17418 ignored. If this is in the envelope and the message is passed on to another
17419 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17420 domain causes a syntax error.
17421 However, addresses in header lines are checked only when an ACL requests header
17422 syntax checking.
17423
17424
17425 .option syslog_duplication main boolean true
17426 .cindex "syslog" "duplicate log lines; suppressing"
17427 When Exim is logging to syslog, it writes the log lines for its three
17428 separate logs at different syslog priorities so that they can in principle
17429 be separated on the logging hosts. Some installations do not require this
17430 separation, and in those cases, the duplication of certain log lines is a
17431 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17432 particular log line is written to syslog. For lines that normally go to
17433 both the main log and the reject log, the reject log version (possibly
17434 containing message header lines) is written, at LOG_NOTICE priority.
17435 Lines that normally go to both the main and the panic log are written at
17436 the LOG_ALERT priority.
17437
17438
17439 .option syslog_facility main string unset
17440 .cindex "syslog" "facility; setting"
17441 This option sets the syslog &"facility"& name, used when Exim is logging to
17442 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17443 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17444 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17445 details of Exim's logging.
17446
17447
17448 .option syslog_pid main boolean true
17449 .cindex "syslog" "pid"
17450 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17451 omitted when these lines are sent to syslog. (Syslog normally prefixes
17452 the log lines with the PID of the logging process automatically.) You need
17453 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17454 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17455
17456
17457
17458 .option syslog_processname main string &`exim`&
17459 .cindex "syslog" "process name; setting"
17460 This option sets the syslog &"ident"& name, used when Exim is logging to
17461 syslog. The value must be no longer than 32 characters. See chapter
17462 &<<CHAPlog>>& for details of Exim's logging.
17463
17464
17465
17466 .option syslog_timestamp main boolean true
17467 .cindex "syslog" "timestamps"
17468 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17469 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17470 details of Exim's logging.
17471
17472
17473 .option system_filter main string&!! unset
17474 .cindex "filter" "system filter"
17475 .cindex "system filter" "specifying"
17476 .cindex "Sieve filter" "not available for system filter"
17477 This option specifies an Exim filter file that is applied to all messages at
17478 the start of each delivery attempt, before any routing is done. System filters
17479 must be Exim filters; they cannot be Sieve filters. If the system filter
17480 generates any deliveries to files or pipes, or any new mail messages, the
17481 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17482 which transports are to be used. Details of this facility are given in chapter
17483 &<<CHAPsystemfilter>>&.
17484 A forced expansion failure results in no filter operation.
17485
17486
17487 .option system_filter_directory_transport main string&!! unset
17488 .vindex "&$address_file$&"
17489 This sets the name of the transport driver that is to be used when the
17490 &%save%& command in a system message filter specifies a path ending in &"/"&,
17491 implying delivery of each message into a separate file in some directory.
17492 During the delivery, the variable &$address_file$& contains the path name.
17493
17494
17495 .option system_filter_file_transport main string&!! unset
17496 .cindex "file" "transport for system filter"
17497 This sets the name of the transport driver that is to be used when the &%save%&
17498 command in a system message filter specifies a path not ending in &"/"&. During
17499 the delivery, the variable &$address_file$& contains the path name.
17500
17501 .option system_filter_group main string unset
17502 .cindex "gid (group id)" "system filter"
17503 This option is used only when &%system_filter_user%& is also set. It sets the
17504 gid under which the system filter is run, overriding any gid that is associated
17505 with the user. The value may be numerical or symbolic.
17506
17507 .option system_filter_pipe_transport main string&!! unset
17508 .cindex "&(pipe)& transport" "for system filter"
17509 .vindex "&$address_pipe$&"
17510 This specifies the transport driver that is to be used when a &%pipe%& command
17511 is used in a system filter. During the delivery, the variable &$address_pipe$&
17512 contains the pipe command.
17513
17514
17515 .option system_filter_reply_transport main string&!! unset
17516 .cindex "&(autoreply)& transport" "for system filter"
17517 This specifies the transport driver that is to be used when a &%mail%& command
17518 is used in a system filter.
17519
17520
17521 .option system_filter_user main string unset
17522 .cindex "uid (user id)" "system filter"
17523 If this option is set to root, the system filter is run in the main Exim
17524 delivery process, as root.  Otherwise, the system filter runs in a separate
17525 process, as the given user, defaulting to the Exim run-time user.
17526 Unless the string consists entirely of digits, it
17527 is looked up in the password data. Failure to find the named user causes a
17528 configuration error. The gid is either taken from the password data, or
17529 specified by &%system_filter_group%&. When the uid is specified numerically,
17530 &%system_filter_group%& is required to be set.
17531
17532 If the system filter generates any pipe, file, or reply deliveries, the uid
17533 under which the filter is run is used when transporting them, unless a
17534 transport option overrides.
17535
17536
17537 .option tcp_nodelay main boolean true
17538 .cindex "daemon" "TCP_NODELAY on sockets"
17539 .cindex "Nagle algorithm"
17540 .cindex "TCP_NODELAY on listening sockets"
17541 If this option is set false, it stops the Exim daemon setting the
17542 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17543 turns off the &"Nagle algorithm"&, which is a way of improving network
17544 performance in interactive (character-by-character) situations. Turning it off
17545 should improve Exim's performance a bit, so that is what happens by default.
17546 However, it appears that some broken clients cannot cope, and time out. Hence
17547 this option. It affects only those sockets that are set up for listening by the
17548 daemon. Sockets created by the smtp transport for delivering mail always set
17549 TCP_NODELAY.
17550
17551
17552 .option timeout_frozen_after main time 0s
17553 .cindex "frozen messages" "timing out"
17554 .cindex "timeout" "frozen messages"
17555 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17556 message of any kind that has been in the queue for longer than the given time
17557 is automatically cancelled at the next queue run. If the frozen message is a
17558 bounce message, it is just discarded; otherwise, a bounce is sent to the
17559 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17560 If you want to timeout frozen bounce messages earlier than other kinds of
17561 frozen message, see &%ignore_bounce_errors_after%&.
17562
17563 &*Note:*& the default value of zero means no timeouts; with this setting,
17564 frozen messages remain in the queue forever (except for any frozen bounce
17565 messages that are released by &%ignore_bounce_errors_after%&).
17566
17567
17568 .option timezone main string unset
17569 .cindex "timezone, setting"
17570 .cindex "environment" "values from"
17571 The value of &%timezone%& is used to set the environment variable TZ while
17572 running Exim (if it is different on entry). This ensures that all timestamps
17573 created by Exim are in the required timezone. If you want all your timestamps
17574 to be in UTC (aka GMT) you should set
17575 .code
17576 timezone = UTC
17577 .endd
17578 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17579 or, if that is not set, from the value of the TZ environment variable when Exim
17580 is built. If &%timezone%& is set to the empty string, either at build or run
17581 time, any existing TZ variable is removed from the environment when Exim
17582 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17583 unfortunately not all, operating systems.
17584
17585
17586 .option tls_advertise_hosts main "host list&!!" *
17587 .cindex "TLS" "advertising"
17588 .cindex "encryption" "on SMTP connection"
17589 .cindex "SMTP" "encrypted connection"
17590 When Exim is built with support for TLS encrypted connections, the availability
17591 of the STARTTLS command to set up an encrypted session is advertised in
17592 response to EHLO only to those client hosts that match this option. See
17593 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17594 Note that the default value requires that a certificate be supplied
17595 using the &%tls_certificate%& option.  If TLS support for incoming connections
17596 is not required the &%tls_advertise_hosts%& option should be set empty.
17597
17598
17599 .option tls_certificate main string list&!! unset
17600 .cindex "TLS" "server certificate; location of"
17601 .cindex "certificate" "server, location of"
17602 The value of this option is expanded, and must then be a list of absolute paths to
17603 files which contains the server's certificates.  Commonly only one file is
17604 needed.
17605 The server's private key is also
17606 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17607 &<<CHAPTLS>>& for further details.
17608
17609 &*Note*&: The certificates defined by this option are used only when Exim is
17610 receiving incoming messages as a server. If you want to supply certificates for
17611 use when sending messages as a client, you must set the &%tls_certificate%&
17612 option in the relevant &(smtp)& transport.
17613
17614 &*Note*&: If you use filenames based on IP addresses, change the list
17615 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17616
17617 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17618 when a list of more than one
17619 file is used, the &$tls_in_ourcert$& variable is unreliable.
17620
17621 &*Note*&: OCSP stapling is not usable under OpenSSL
17622 when a list of more than one file is used.
17623
17624 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17625 if the OpenSSL build supports TLS extensions and the TLS client sends the
17626 Server Name Indication extension, then this option and others documented in
17627 &<<SECTtlssni>>& will be re-expanded.
17628
17629 If this option is unset or empty a fresh self-signed certificate will be
17630 generated for every connection.
17631
17632 .option tls_crl main string&!! unset
17633 .cindex "TLS" "server certificate revocation list"
17634 .cindex "certificate" "revocation list for server"
17635 This option specifies a certificate revocation list. The expanded value must
17636 be the name of a file that contains CRLs in PEM format.
17637
17638 Under OpenSSL the option can specify a directory with CRL files.
17639
17640 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17641 for each signing element of the certificate chain (i.e. all but the leaf).
17642 For the file variant this can be multiple PEM blocks in the one file.
17643
17644 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17645
17646
17647 .option tls_dh_max_bits main integer 2236
17648 .cindex "TLS" "D-H bit count"
17649 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17650 the chosen TLS library.  That value might prove to be too high for
17651 interoperability.  This option provides a maximum clamp on the value
17652 suggested, trading off security for interoperability.
17653
17654 The value must be at least 1024.
17655
17656 The value 2236 was chosen because, at time of adding the option, it was the
17657 hard-coded maximum value supported by the NSS cryptographic library, as used
17658 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17659
17660 If you prefer more security and are willing to break some clients, raise this
17661 number.
17662
17663 Note that the value passed to GnuTLS for *generating* a new prime may be a
17664 little less than this figure, because GnuTLS is inexact and may produce a
17665 larger prime than requested.
17666
17667
17668 .option tls_dhparam main string&!! unset
17669 .cindex "TLS" "D-H parameters for server"
17670 The value of this option is expanded and indicates the source of DH parameters
17671 to be used by Exim.
17672
17673 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17674 local DH parameters*&, which has been supported across all versions of Exim.  The
17675 other specific constants available are a fallback so that even when
17676 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17677
17678 If &%tls_dhparam%& is a filename starting with a &`/`&,
17679 then it names a file from which DH
17680 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17681 PKCS#3 representation of the DH prime.  If the file does not exist, for
17682 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17683 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17684 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17685 and treated as though the &%tls_dhparam%& were set to "none".
17686
17687 If this option expands to the string "none", then no DH parameters will be
17688 loaded by Exim.
17689
17690 If this option expands to the string "historic" and Exim is using GnuTLS, then
17691 Exim will attempt to load a file from inside the spool directory.  If the file
17692 does not exist, Exim will attempt to create it.
17693 See section &<<SECTgnutlsparam>>& for further details.
17694
17695 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17696 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17697
17698 In older versions of Exim the default was the 2048 bit prime described in section
17699 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17700 in IKE is assigned number 23.
17701
17702 Otherwise, the option must expand to the name used by Exim for any of a number
17703 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17704 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17705 the number used by IKE, or "default" which corresponds to
17706 &`exim.dev.20160529.3`&.
17707
17708 The available standard primes are:
17709 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17710 &`ike1`&, &`ike2`&, &`ike5`&,
17711 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17712 &`ike22`&, &`ike23`& and &`ike24`&.
17713
17714 The available additional primes are:
17715 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17716
17717 Some of these will be too small to be accepted by clients.
17718 Some may be too large to be accepted by clients.
17719 The open cryptographic community has suspicions about the integrity of some
17720 of the later IKE values, which led into RFC7919 providing new fixed constants
17721 (the "ffdhe" identifiers).
17722
17723 At this point, all of the "ike" values should be considered obsolete;
17724 they're still in Exim to avoid breaking unusual configurations, but are
17725 candidates for removal the next time we have backwards-incompatible changes.
17726
17727 The TLS protocol does not negotiate an acceptable size for this; clients tend
17728 to hard-drop connections if what is offered by the server is unacceptable,
17729 whether too large or too small, and there's no provision for the client to
17730 tell the server what these constraints are.  Thus, as a server operator, you
17731 need to make an educated guess as to what is most likely to work for your
17732 userbase.
17733
17734 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17735 is most likely to maximise interoperability.  The upper bound comes from
17736 applications using the Mozilla Network Security Services (NSS) library, which
17737 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17738 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17739 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17740 acceptable bound from 1024 to 2048.
17741
17742
17743 .option tls_eccurve main string&!! &`auto`&
17744 .cindex TLS "EC cryptography"
17745 This option selects a EC curve for use by Exim when used with OpenSSL.
17746 It has no effect when Exim is used with GnuTLS.
17747
17748 After expansion it must contain a valid EC curve parameter, such as
17749 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17750 for valid selections.
17751
17752 For OpenSSL versions before (and not including) 1.0.2, the string
17753 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17754 &`auto`& tells the library to choose.
17755
17756 If the option expands to an empty string, no EC curves will be enabled.
17757
17758
17759 .option tls_ocsp_file main string&!! unset
17760 .cindex TLS "certificate status"
17761 .cindex TLS "OCSP proof file"
17762 This option
17763 must if set expand to the absolute path to a file which contains a current
17764 status proof for the server's certificate, as obtained from the
17765 Certificate Authority.
17766
17767 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17768
17769 For GnuTLS 3.5.6 or later the expanded value of this option can be a list
17770 of files, to match a list given for the &%tls_certificate%& option.
17771 The ordering of the two lists must match.
17772
17773
17774 .option tls_on_connect_ports main "string list" unset
17775 .cindex SSMTP
17776 .cindex SMTPS
17777 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17778 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17779 set up without waiting for the client to issue a STARTTLS command. For
17780 further details, see section &<<SECTsupobssmt>>&.
17781
17782
17783
17784 .option tls_privatekey main string list&!! unset
17785 .cindex "TLS" "server private key; location of"
17786 The value of this option is expanded, and must then be a list of absolute paths to
17787 files which contains the server's private keys.
17788 If this option is unset, or if
17789 the expansion is forced to fail, or the result is an empty string, the private
17790 key is assumed to be in the same file as the server's certificates. See chapter
17791 &<<CHAPTLS>>& for further details.
17792
17793 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17794
17795
17796 .option tls_remember_esmtp main boolean false
17797 .cindex "TLS" "esmtp state; remembering"
17798 .cindex "TLS" "broken clients"
17799 If this option is set true, Exim violates the RFCs by remembering that it is in
17800 &"esmtp"& state after successfully negotiating a TLS session. This provides
17801 support for broken clients that fail to send a new EHLO after starting a
17802 TLS session.
17803
17804
17805 .option tls_require_ciphers main string&!! unset
17806 .cindex "TLS" "requiring specific ciphers"
17807 .cindex "cipher" "requiring specific"
17808 This option controls which ciphers can be used for incoming TLS connections.
17809 The &(smtp)& transport has an option of the same name for controlling outgoing
17810 connections. This option is expanded for each connection, so can be varied for
17811 different clients if required. The value of this option must be a list of
17812 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17813 in somewhat different ways. If GnuTLS is being used, the client controls the
17814 preference order of the available ciphers. Details are given in sections
17815 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17816
17817
17818 .option tls_try_verify_hosts main "host list&!!" unset
17819 .cindex "TLS" "client certificate verification"
17820 .cindex "certificate" "verification of client"
17821 See &%tls_verify_hosts%& below.
17822
17823
17824 .option tls_verify_certificates main string&!! system
17825 .cindex "TLS" "client certificate verification"
17826 .cindex "certificate" "verification of client"
17827 The value of this option is expanded, and must then be either the
17828 word "system"
17829 or the absolute path to
17830 a file or directory containing permitted certificates for clients that
17831 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17832
17833 The "system" value for the option will use a
17834 system default location compiled into the SSL library.
17835 This is not available for GnuTLS versions preceding 3.0.20,
17836 and will be taken as empty; an explicit location
17837 must be specified.
17838
17839 The use of a directory for the option value is not available for GnuTLS versions
17840 preceding 3.3.6 and a single file must be used.
17841
17842 With OpenSSL the certificates specified
17843 explicitly
17844 either by file or directory
17845 are added to those given by the system default location.
17846
17847 These certificates should be for the certificate authorities trusted, rather
17848 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17849 the value is a file then the certificates are sent by Exim as a server to
17850 connecting clients, defining the list of accepted certificate authorities.
17851 Thus the values defined should be considered public data.  To avoid this,
17852 use the explicit directory version.
17853
17854 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17855
17856 A forced expansion failure or setting to an empty string is equivalent to
17857 being unset.
17858
17859
17860 .option tls_verify_hosts main "host list&!!" unset
17861 .cindex "TLS" "client certificate verification"
17862 .cindex "certificate" "verification of client"
17863 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17864 certificates from clients. The expected certificates are defined by
17865 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17866 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17867 &%tls_verify_certificates%& is not set.
17868
17869 Any client that matches &%tls_verify_hosts%& is constrained by
17870 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17871 present one of the listed certificates. If it does not, the connection is
17872 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17873 the host to use TLS. It can still send SMTP commands through unencrypted
17874 connections. Forcing a client to use TLS has to be done separately using an
17875 ACL to reject inappropriate commands when the connection is not encrypted.
17876
17877 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17878 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17879 certificate and checks it against &%tls_verify_certificates%&, but does not
17880 abort the connection if there is no certificate or if it does not match. This
17881 state can be detected in an ACL, which makes it possible to implement policies
17882 such as &"accept for relay only if a verified certificate has been received,
17883 but accept for local delivery if encrypted, even without a verified
17884 certificate"&.
17885
17886 Client hosts that match neither of these lists are not asked to present
17887 certificates.
17888
17889
17890 .option trusted_groups main "string list&!!" unset
17891 .cindex "trusted groups"
17892 .cindex "groups" "trusted"
17893 This option is expanded just once, at the start of Exim's processing. If this
17894 option is set, any process that is running in one of the listed groups, or
17895 which has one of them as a supplementary group, is trusted. The groups can be
17896 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17897 details of what trusted callers are permitted to do. If neither
17898 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17899 are trusted.
17900
17901 .option trusted_users main "string list&!!" unset
17902 .cindex "trusted users"
17903 .cindex "user" "trusted"
17904 This option is expanded just once, at the start of Exim's processing. If this
17905 option is set, any process that is running as one of the listed users is
17906 trusted. The users can be specified numerically or by name. See section
17907 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17908 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17909 Exim user are trusted.
17910
17911 .option unknown_login main string&!! unset
17912 .cindex "uid (user id)" "unknown caller"
17913 .vindex "&$caller_uid$&"
17914 This is a specialized feature for use in unusual configurations. By default, if
17915 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17916 gives up. The &%unknown_login%& option can be used to set a login name to be
17917 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17918 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17919 is used for the user's real name (gecos field), unless this has been set by the
17920 &%-F%& option.
17921
17922 .option unknown_username main string unset
17923 See &%unknown_login%&.
17924
17925 .option untrusted_set_sender main "address list&!!" unset
17926 .cindex "trusted users"
17927 .cindex "sender" "setting by untrusted user"
17928 .cindex "untrusted user setting sender"
17929 .cindex "user" "untrusted setting sender"
17930 .cindex "envelope from"
17931 .cindex "envelope sender"
17932 When an untrusted user submits a message to Exim using the standard input, Exim
17933 normally creates an envelope sender address from the user's login and the
17934 default qualification domain. Data from the &%-f%& option (for setting envelope
17935 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17936 is used) is ignored.
17937
17938 However, untrusted users are permitted to set an empty envelope sender address,
17939 to declare that a message should never generate any bounces. For example:
17940 .code
17941 exim -f '<>' user@domain.example
17942 .endd
17943 .vindex "&$sender_ident$&"
17944 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17945 other envelope sender addresses in a controlled way. When it is set, untrusted
17946 users are allowed to set envelope sender addresses that match any of the
17947 patterns in the list. Like all address lists, the string is expanded. The
17948 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17949 users to setting senders that start with their login ids
17950 followed by a hyphen
17951 by a setting like this:
17952 .code
17953 untrusted_set_sender = ^$sender_ident-
17954 .endd
17955 If you want to allow untrusted users to set envelope sender addresses without
17956 restriction, you can use
17957 .code
17958 untrusted_set_sender = *
17959 .endd
17960 The &%untrusted_set_sender%& option applies to all forms of local input, but
17961 only to the setting of the envelope sender. It does not permit untrusted users
17962 to use the other options which trusted user can use to override message
17963 parameters. Furthermore, it does not stop Exim from removing an existing
17964 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17965 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17966 overriding these actions. The handling of the &'Sender:'& header is also
17967 described in section &<<SECTthesenhea>>&.
17968
17969 The log line for a message's arrival shows the envelope sender following
17970 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17971 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17972 envelope sender address, the user's login is shown in parentheses after the
17973 sender address.
17974
17975
17976 .option uucp_from_pattern main string "see below"
17977 .cindex "&""From""& line"
17978 .cindex "UUCP" "&""From""& line"
17979 Some applications that pass messages to an MTA via a command line interface use
17980 an initial line starting with &"From&~"& to pass the envelope sender. In
17981 particular, this is used by UUCP software. Exim recognizes such a line by means
17982 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17983 matches, the sender address is constructed by expanding the contents of
17984 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17985 default pattern recognizes lines in the following two forms:
17986 .code
17987 From ph10 Fri Jan  5 12:35 GMT 1996
17988 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17989 .endd
17990 The pattern can be seen by running
17991 .code
17992 exim -bP uucp_from_pattern
17993 .endd
17994 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17995 year in the second case. The first word after &"From&~"& is matched in the
17996 regular expression by a parenthesized subpattern. The default value for
17997 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17998 (&"ph10"& in the example above) as the message's sender. See also
17999 &%ignore_fromline_hosts%&.
18000
18001
18002 .option uucp_from_sender main string&!! &`$1`&
18003 See &%uucp_from_pattern%& above.
18004
18005
18006 .option warn_message_file main string unset
18007 .cindex "warning of delay" "customizing the message"
18008 .cindex "customizing" "warning message"
18009 This option defines a template file containing paragraphs of text to be used
18010 for constructing the warning message which is sent by Exim when a message has
18011 been in the queue for a specified amount of time, as specified by
18012 &%delay_warning%&. Details of the file's contents are given in chapter
18013 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18014
18015
18016 .option write_rejectlog main boolean true
18017 .cindex "reject log" "disabling"
18018 If this option is set false, Exim no longer writes anything to the reject log.
18019 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18020 .ecindex IIDconfima
18021 .ecindex IIDmaiconf
18022
18023
18024
18025
18026 . ////////////////////////////////////////////////////////////////////////////
18027 . ////////////////////////////////////////////////////////////////////////////
18028
18029 .chapter "Generic options for routers" "CHAProutergeneric"
18030 .scindex IIDgenoprou1 "options" "generic; for routers"
18031 .scindex IIDgenoprou2 "generic options" "router"
18032 This chapter describes the generic options that apply to all routers.
18033 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18034
18035 For a general description of how a router operates, see sections
18036 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18037 which the preconditions are tested. The order of expansion of the options that
18038 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18039 &%headers_remove%&, &%transport%&.
18040
18041
18042
18043 .option address_data routers string&!! unset
18044 .cindex "router" "data attached to address"
18045 The string is expanded just before the router is run, that is, after all the
18046 precondition tests have succeeded. If the expansion is forced to fail, the
18047 router declines, the value of &%address_data%& remains unchanged, and the
18048 &%more%& option controls what happens next. Other expansion failures cause
18049 delivery of the address to be deferred.
18050
18051 .vindex "&$address_data$&"
18052 When the expansion succeeds, the value is retained with the address, and can be
18053 accessed using the variable &$address_data$& in the current router, subsequent
18054 routers, and the eventual transport.
18055
18056 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18057 that runs a user's filter file, the contents of &$address_data$& are accessible
18058 in the filter. This is not normally a problem, because such data is usually
18059 either not confidential or it &"belongs"& to the current user, but if you do
18060 put confidential data into &$address_data$& you need to remember this point.
18061
18062 Even if the router declines or passes, the value of &$address_data$& remains
18063 with the address, though it can be changed by another &%address_data%& setting
18064 on a subsequent router. If a router generates child addresses, the value of
18065 &$address_data$& propagates to them. This also applies to the special kind of
18066 &"child"& that is generated by a router with the &%unseen%& option.
18067
18068 The idea of &%address_data%& is that you can use it to look up a lot of data
18069 for the address once, and then pick out parts of the data later. For example,
18070 you could use a single LDAP lookup to return a string of the form
18071 .code
18072 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18073 .endd
18074 In the transport you could pick out the mailbox by a setting such as
18075 .code
18076 file = ${extract{mailbox}{$address_data}}
18077 .endd
18078 This makes the configuration file less messy, and also reduces the number of
18079 lookups (though Exim does cache lookups).
18080
18081 .vindex "&$sender_address_data$&"
18082 .vindex "&$address_data$&"
18083 The &%address_data%& facility is also useful as a means of passing information
18084 from one router to another, and from a router to a transport. In addition, if
18085 &$address_data$& is set by a router when verifying a recipient address from an
18086 ACL, it remains available for use in the rest of the ACL statement. After
18087 verifying a sender, the value is transferred to &$sender_address_data$&.
18088
18089
18090
18091 .option address_test routers&!? boolean true
18092 .oindex "&%-bt%&"
18093 .cindex "router" "skipping when address testing"
18094 If this option is set false, the router is skipped when routing is being tested
18095 by means of the &%-bt%& command line option. This can be a convenience when
18096 your first router sends messages to an external scanner, because it saves you
18097 having to set the &"already scanned"& indicator when testing real address
18098 routing.
18099
18100
18101
18102 .option cannot_route_message routers string&!! unset
18103 .cindex "router" "customizing &""cannot route""& message"
18104 .cindex "customizing" "&""cannot route""& message"
18105 This option specifies a text message that is used when an address cannot be
18106 routed because Exim has run out of routers. The default message is
18107 &"Unrouteable address"&. This option is useful only on routers that have
18108 &%more%& set false, or on the very last router in a configuration, because the
18109 value that is used is taken from the last router that is considered. This
18110 includes a router that is skipped because its preconditions are not met, as
18111 well as a router that declines. For example, using the default configuration,
18112 you could put:
18113 .code
18114 cannot_route_message = Remote domain not found in DNS
18115 .endd
18116 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18117 and
18118 .code
18119 cannot_route_message = Unknown local user
18120 .endd
18121 on the final router that checks for local users. If string expansion fails for
18122 this option, the default message is used. Unless the expansion failure was
18123 explicitly forced, a message about the failure is written to the main and panic
18124 logs, in addition to the normal message about the routing failure.
18125
18126
18127 .option caseful_local_part routers boolean false
18128 .cindex "case of local parts"
18129 .cindex "router" "case of local parts"
18130 By default, routers handle the local parts of addresses in a case-insensitive
18131 manner, though the actual case is preserved for transmission with the message.
18132 If you want the case of letters to be significant in a router, you must set
18133 this option true. For individual router options that contain address or local
18134 part lists (for example, &%local_parts%&), case-sensitive matching can be
18135 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18136 more details.
18137
18138 .vindex "&$local_part$&"
18139 .vindex "&$original_local_part$&"
18140 .vindex "&$parent_local_part$&"
18141 The value of the &$local_part$& variable is forced to lower case while a
18142 router is running unless &%caseful_local_part%& is set. When a router assigns
18143 an address to a transport, the value of &$local_part$& when the transport runs
18144 is the same as it was in the router. Similarly, when a router generates child
18145 addresses by aliasing or forwarding, the values of &$original_local_part$&
18146 and &$parent_local_part$& are those that were used by the redirecting router.
18147
18148 This option applies to the processing of an address by a router. When a
18149 recipient address is being processed in an ACL, there is a separate &%control%&
18150 modifier that can be used to specify case-sensitive processing within the ACL
18151 (see section &<<SECTcontrols>>&).
18152
18153
18154
18155 .option check_local_user routers&!? boolean false
18156 .cindex "local user, checking in router"
18157 .cindex "router" "checking for local user"
18158 .cindex "&_/etc/passwd_&"
18159 .vindex "&$home$&"
18160 When this option is true, Exim checks that the local part of the recipient
18161 address (with affixes removed if relevant) is the name of an account on the
18162 local system. The check is done by calling the &[getpwnam()]& function rather
18163 than trying to read &_/etc/passwd_& directly. This means that other methods of
18164 holding password data (such as NIS) are supported. If the local part is a local
18165 user, &$home$& is set from the password data, and can be tested in other
18166 preconditions that are evaluated after this one (the order of evaluation is
18167 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18168 overridden by &%router_home_directory%&. If the local part is not a local user,
18169 the router is skipped.
18170
18171 If you want to check that the local part is either the name of a local user
18172 or matches something else, you cannot combine &%check_local_user%& with a
18173 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18174 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18175 setting to achieve this. For example:
18176 .code
18177 local_parts = passwd;$local_part : lsearch;/etc/other/users
18178 .endd
18179 Note, however, that the side effects of &%check_local_user%& (such as setting
18180 up a home directory) do not occur when a &(passwd)& lookup is used in a
18181 &%local_parts%& (or any other) precondition.
18182
18183
18184
18185 .option condition routers&!? string&!! unset
18186 .cindex "router" "customized precondition"
18187 This option specifies a general precondition test that has to succeed for the
18188 router to be called. The &%condition%& option is the last precondition to be
18189 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18190 result is a forced failure, or an empty string, or one of the strings &"0"& or
18191 &"no"& or &"false"& (checked without regard to the case of the letters), the
18192 router is skipped, and the address is offered to the next one.
18193
18194 If the result is any other value, the router is run (as this is the last
18195 precondition to be evaluated, all the other preconditions must be true).
18196
18197 This option is unusual in that multiple &%condition%& options may be present.
18198 All &%condition%& options must succeed.
18199
18200 The &%condition%& option provides a means of applying custom conditions to the
18201 running of routers. Note that in the case of a simple conditional expansion,
18202 the default expansion values are exactly what is wanted. For example:
18203 .code
18204 condition = ${if >{$message_age}{600}}
18205 .endd
18206 Because of the default behaviour of the string expansion, this is equivalent to
18207 .code
18208 condition = ${if >{$message_age}{600}{true}{}}
18209 .endd
18210
18211 A multiple condition example, which succeeds:
18212 .code
18213 condition = ${if >{$message_age}{600}}
18214 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18215 condition = foobar
18216 .endd
18217
18218 If the expansion fails (other than forced failure) delivery is deferred. Some
18219 of the other precondition options are common special cases that could in fact
18220 be specified using &%condition%&.
18221
18222 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18223 are far older, and use one set of semantics.  ACLs are newer and when
18224 they were created, the ACL &%condition%& process was given far stricter
18225 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18226 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18227 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18228 Router rules processing behavior.
18229
18230 This is best illustrated in an example:
18231 .code
18232 # If used in an ACL condition will fail with a syntax error, but
18233 # in a router condition any extra characters are treated as a string
18234
18235 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18236 true {yes} {no}}
18237
18238 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18239  {yes} {no}}
18240 .endd
18241 In each example above, the &%if%& statement actually ends after
18242 &"{google.com}}"&.  Since no true or false braces were defined, the
18243 default &%if%& behavior is to return a boolean true or a null answer
18244 (which evaluates to false). The rest of the line is then treated as a
18245 string. So the first example resulted in the boolean answer &"true"&
18246 with the string &" {yes} {no}}"& appended to it. The second example
18247 resulted in the null output (indicating false) with the string
18248 &" {yes} {no}}"& appended to it.
18249
18250 In fact you can put excess forward braces in too.  In the router
18251 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18252 mean something, like after a &"$"& or when required as part of a
18253 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18254 string characters.
18255
18256 Thus, in a Router, the above expansion strings will both always evaluate
18257 true, as the result of expansion is a non-empty string which doesn't
18258 match an explicit false value.  This can be tricky to debug.  By
18259 contrast, in an ACL either of those strings will always result in an
18260 expansion error because the result doesn't look sufficiently boolean.
18261
18262
18263 .option debug_print routers string&!! unset
18264 .cindex "testing" "variables in drivers"
18265 If this option is set and debugging is enabled (see the &%-d%& command line
18266 option) or in address-testing mode (see the &%-bt%& command line option),
18267 the string is expanded and included in the debugging output.
18268 If expansion of the string fails, the error message is written to the debugging
18269 output, and Exim carries on processing.
18270 This option is provided to help with checking out the values of variables and
18271 so on when debugging router configurations. For example, if a &%condition%&
18272 option appears not to be working, &%debug_print%& can be used to output the
18273 variables it references. The output happens after checks for &%domains%&,
18274 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18275 are tested. A newline is added to the text if it does not end with one.
18276 The variable &$router_name$& contains the name of the router.
18277
18278
18279
18280 .option disable_logging routers boolean false
18281 If this option is set true, nothing is logged for any routing errors
18282 or for any deliveries caused by this router. You should not set this option
18283 unless you really, really know what you are doing. See also the generic
18284 transport option of the same name.
18285
18286 .option dnssec_request_domains routers "domain list&!!" unset
18287 .cindex "MX record" "security"
18288 .cindex "DNSSEC" "MX lookup"
18289 .cindex "security" "MX lookup"
18290 .cindex "DNS" "DNSSEC"
18291 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18292 the dnssec request bit set.
18293 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18294
18295 .option dnssec_require_domains routers "domain list&!!" unset
18296 .cindex "MX record" "security"
18297 .cindex "DNSSEC" "MX lookup"
18298 .cindex "security" "MX lookup"
18299 .cindex "DNS" "DNSSEC"
18300 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18301 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18302 (AD bit) set will be ignored and logged as a host-lookup failure.
18303 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18304
18305
18306 .option domains routers&!? "domain list&!!" unset
18307 .cindex "router" "restricting to specific domains"
18308 .vindex "&$domain_data$&"
18309 If this option is set, the router is skipped unless the current domain matches
18310 the list. If the match is achieved by means of a file lookup, the data that the
18311 lookup returned for the domain is placed in &$domain_data$& for use in string
18312 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18313 a list of the order in which preconditions are evaluated.
18314
18315
18316
18317 .option driver routers string unset
18318 This option must always be set. It specifies which of the available routers is
18319 to be used.
18320
18321
18322 .option dsn_lasthop routers boolean false
18323 .cindex "DSN" "success"
18324 .cindex "Delivery Status Notification" "success"
18325 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18326 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18327 instead send a success DSN as if the next hop does not support DSN.
18328 Not effective on redirect routers.
18329
18330
18331
18332 .option errors_to routers string&!! unset
18333 .cindex "envelope from"
18334 .cindex "envelope sender"
18335 .cindex "router" "changing address for errors"
18336 If a router successfully handles an address, it may assign the address to a
18337 transport for delivery or it may generate child addresses. In both cases, if
18338 there is a delivery problem during later processing, the resulting bounce
18339 message is sent to the address that results from expanding this string,
18340 provided that the address verifies successfully. The &%errors_to%& option is
18341 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18342
18343 The &%errors_to%& setting associated with an address can be overridden if it
18344 subsequently passes through other routers that have their own &%errors_to%&
18345 settings, or if the message is delivered by a transport with a &%return_path%&
18346 setting.
18347
18348 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18349 the expansion fails to verify, the errors address associated with the incoming
18350 address is used. At top level, this is the envelope sender. A non-forced
18351 expansion failure causes delivery to be deferred.
18352
18353 If an address for which &%errors_to%& has been set ends up being delivered over
18354 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18355 any bounces that are generated by other MTAs on the delivery route are also
18356 sent there. You can set &%errors_to%& to the empty string by either of these
18357 settings:
18358 .code
18359 errors_to =
18360 errors_to = ""
18361 .endd
18362 An expansion item that yields an empty string has the same effect. If you do
18363 this, a locally detected delivery error for addresses processed by this router
18364 no longer gives rise to a bounce message; the error is discarded. If the
18365 address is delivered to a remote host, the return path is set to &`<>`&, unless
18366 overridden by the &%return_path%& option on the transport.
18367
18368 .vindex "&$address_data$&"
18369 If for some reason you want to discard local errors, but use a non-empty
18370 MAIL command for remote delivery, you can preserve the original return
18371 path in &$address_data$& in the router, and reinstate it in the transport by
18372 setting &%return_path%&.
18373
18374 The most common use of &%errors_to%& is to direct mailing list bounces to the
18375 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18376 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18377
18378
18379
18380 .option expn routers&!? boolean true
18381 .cindex "address" "testing"
18382 .cindex "testing" "addresses"
18383 .cindex "EXPN" "router skipping"
18384 .cindex "router" "skipping for EXPN"
18385 If this option is turned off, the router is skipped when testing an address
18386 as a result of processing an SMTP EXPN command. You might, for example,
18387 want to turn it off on a router for users' &_.forward_& files, while leaving it
18388 on for the system alias file.
18389 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18390 are evaluated.
18391
18392 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18393 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18394 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18395
18396
18397
18398 .option fail_verify routers boolean false
18399 .cindex "router" "forcing verification failure"
18400 Setting this option has the effect of setting both &%fail_verify_sender%& and
18401 &%fail_verify_recipient%& to the same value.
18402
18403
18404
18405 .option fail_verify_recipient routers boolean false
18406 If this option is true and an address is accepted by this router when
18407 verifying a recipient, verification fails.
18408
18409
18410
18411 .option fail_verify_sender routers boolean false
18412 If this option is true and an address is accepted by this router when
18413 verifying a sender, verification fails.
18414
18415
18416
18417 .option fallback_hosts routers "string list" unset
18418 .cindex "router" "fallback hosts"
18419 .cindex "fallback" "hosts specified on router"
18420 String expansion is not applied to this option. The argument must be a
18421 colon-separated list of host names or IP addresses. The list separator can be
18422 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18423 each name or address. In fact, the format of each item is exactly the same as
18424 defined for the list of hosts in a &(manualroute)& router (see section
18425 &<<SECTformatonehostitem>>&).
18426
18427 If a router queues an address for a remote transport, this host list is
18428 associated with the address, and used instead of the transport's fallback host
18429 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18430 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18431 transport for further details.
18432
18433
18434 .option group routers string&!! "see below"
18435 .cindex "gid (group id)" "local delivery"
18436 .cindex "local transports" "uid and gid"
18437 .cindex "transport" "local"
18438 .cindex "router" "setting group"
18439 When a router queues an address for a transport, and the transport does not
18440 specify a group, the group given here is used when running the delivery
18441 process.
18442 The group may be specified numerically or by name. If expansion fails, the
18443 error is logged and delivery is deferred.
18444 The default is unset, unless &%check_local_user%& is set, when the default
18445 is taken from the password information. See also &%initgroups%& and &%user%&
18446 and the discussion in chapter &<<CHAPenvironment>>&.
18447
18448
18449
18450 .option headers_add routers list&!! unset
18451 .cindex "header lines" "adding"
18452 .cindex "router" "adding header lines"
18453 This option specifies a list of text headers,
18454 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18455 that is associated with any addresses that are accepted by the router.
18456 Each item is separately expanded, at routing time.  However, this
18457 option has no effect when an address is just being verified. The way in which
18458 the text is used to add header lines at transport time is described in section
18459 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18460 message is in the process of being transported. This means that references to
18461 header lines in string expansions in the transport's configuration do not
18462 &"see"& the added header lines.
18463
18464 The &%headers_add%& option is expanded after &%errors_to%&, but before
18465 &%headers_remove%& and &%transport%&. If an item is empty, or if
18466 an item expansion is forced to fail, the item has no effect. Other expansion
18467 failures are treated as configuration errors.
18468
18469 Unlike most options, &%headers_add%& can be specified multiple times
18470 for a router; all listed headers are added.
18471
18472 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18473 router that has the &%one_time%& option set.
18474
18475 .cindex "duplicate addresses"
18476 .oindex "&%unseen%&"
18477 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18478 additions are deleted when the address is passed on to subsequent routers.
18479 For a &%redirect%& router, if a generated address is the same as the incoming
18480 address, this can lead to duplicate addresses with different header
18481 modifications. Exim does not do duplicate deliveries (except, in certain
18482 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18483 which of the duplicates is discarded, so this ambiguous situation should be
18484 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18485
18486
18487
18488 .option headers_remove routers list&!! unset
18489 .cindex "header lines" "removing"
18490 .cindex "router" "removing header lines"
18491 This option specifies a list of text headers,
18492 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18493 that is associated with any addresses that are accepted by the router.
18494 Each item is separately expanded, at routing time.  However, this
18495 option has no effect when an address is just being verified. The way in which
18496 the text is used to remove header lines at transport time is described in
18497 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18498 the message is in the process of being transported. This means that references
18499 to header lines in string expansions in the transport's configuration still
18500 &"see"& the original header lines.
18501
18502 The &%headers_remove%& option is expanded after &%errors_to%& and
18503 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18504 the item has no effect. Other expansion failures are treated as configuration
18505 errors.
18506
18507 Unlike most options, &%headers_remove%& can be specified multiple times
18508 for a router; all listed headers are removed.
18509
18510 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18511 router that has the &%one_time%& option set.
18512
18513 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18514 removal requests are deleted when the address is passed on to subsequent
18515 routers, and this can lead to problems with duplicates -- see the similar
18516 warning for &%headers_add%& above.
18517
18518 &*Warning 3*&: Because of the separate expansion of the list items,
18519 items that contain a list separator must have it doubled.
18520 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18521
18522
18523
18524 .option ignore_target_hosts routers "host list&!!" unset
18525 .cindex "IP address" "discarding"
18526 .cindex "router" "discarding IP addresses"
18527 Although this option is a host list, it should normally contain IP address
18528 entries rather than names. If any host that is looked up by the router has an
18529 IP address that matches an item in this list, Exim behaves as if that IP
18530 address did not exist. This option allows you to cope with rogue DNS entries
18531 like
18532 .code
18533 remote.domain.example.  A  127.0.0.1
18534 .endd
18535 by setting
18536 .code
18537 ignore_target_hosts = 127.0.0.1
18538 .endd
18539 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18540 discarded in this way, the router declines. In a conventional configuration, an
18541 attempt to mail to such a domain would normally provoke the &"unrouteable
18542 domain"& error, and an attempt to verify an address in the domain would fail.
18543 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18544 router declines if presented with one of the listed addresses.
18545
18546 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18547 means of the first or the second of the following settings, respectively:
18548 .code
18549 ignore_target_hosts = 0.0.0.0/0
18550 ignore_target_hosts = <; 0::0/0
18551 .endd
18552 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18553 in the second line matches all IPv6 addresses.
18554
18555 This option may also be useful for ignoring link-local and site-local IPv6
18556 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18557 is expanded before use as a list, it is possible to make it dependent on the
18558 domain that is being routed.
18559
18560 .vindex "&$host_address$&"
18561 During its expansion, &$host_address$& is set to the IP address that is being
18562 checked.
18563
18564 .option initgroups routers boolean false
18565 .cindex "additional groups"
18566 .cindex "groups" "additional"
18567 .cindex "local transports" "uid and gid"
18568 .cindex "transport" "local"
18569 If the router queues an address for a transport, and this option is true, and
18570 the uid supplied by the router is not overridden by the transport, the
18571 &[initgroups()]& function is called when running the transport to ensure that
18572 any additional groups associated with the uid are set up. See also &%group%&
18573 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18574
18575
18576
18577 .option local_part_prefix routers&!? "string list" unset
18578 .cindex affix "router precondition"
18579 .cindex "router" "prefix for local part"
18580 .cindex "prefix" "for local part, used in router"
18581 If this option is set, the router is skipped unless the local part starts with
18582 one of the given strings, or &%local_part_prefix_optional%& is true. See
18583 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18584 evaluated.
18585
18586 The list is scanned from left to right, and the first prefix that matches is
18587 used. A limited form of wildcard is available; if the prefix begins with an
18588 asterisk, it matches the longest possible sequence of arbitrary characters at
18589 the start of the local part. An asterisk should therefore always be followed by
18590 some character that does not occur in normal local parts.
18591 .cindex "multiple mailboxes"
18592 .cindex "mailbox" "multiple"
18593 Wildcarding can be used to set up multiple user mailboxes, as described in
18594 section &<<SECTmulbox>>&.
18595
18596 .vindex "&$local_part$&"
18597 .vindex "&$local_part_prefix$&"
18598 During the testing of the &%local_parts%& option, and while the router is
18599 running, the prefix is removed from the local part, and is available in the
18600 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18601 the router accepts the address, this remains true during subsequent delivery by
18602 a transport. In particular, the local part that is transmitted in the RCPT
18603 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18604 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18605 the relevant transport.
18606
18607 When an address is being verified, &%local_part_prefix%& affects only the
18608 behaviour of the router. If the callout feature of verification is in use, this
18609 means that the full address, including the prefix, will be used during the
18610 callout.
18611
18612 The prefix facility is commonly used to handle local parts of the form
18613 &%owner-something%&. Another common use is to support local parts of the form
18614 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18615 to tell a user their forwarding is broken &-- by placing a router like this one
18616 immediately before the router that handles &_.forward_& files:
18617 .code
18618 real_localuser:
18619   driver = accept
18620   local_part_prefix = real-
18621   check_local_user
18622   transport = local_delivery
18623 .endd
18624 For security, it would probably be a good idea to restrict the use of this
18625 router to locally-generated messages, using a condition such as this:
18626 .code
18627   condition = ${if match {$sender_host_address}\
18628                          {\N^(|127\.0\.0\.1)$\N}}
18629 .endd
18630
18631 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18632 both conditions must be met if not optional. Care must be taken if wildcards
18633 are used in both a prefix and a suffix on the same router. Different
18634 separator characters must be used to avoid ambiguity.
18635
18636
18637 .option local_part_prefix_optional routers boolean false
18638 See &%local_part_prefix%& above.
18639
18640
18641
18642 .option local_part_suffix routers&!? "string list" unset
18643 .cindex "router" "suffix for local part"
18644 .cindex "suffix for local part" "used in router"
18645 This option operates in the same way as &%local_part_prefix%&, except that the
18646 local part must end (rather than start) with the given string, the
18647 &%local_part_suffix_optional%& option determines whether the suffix is
18648 mandatory, and the wildcard * character, if present, must be the last
18649 character of the suffix. This option facility is commonly used to handle local
18650 parts of the form &%something-request%& and multiple user mailboxes of the form
18651 &%username-foo%&.
18652
18653
18654 .option local_part_suffix_optional routers boolean false
18655 See &%local_part_suffix%& above.
18656
18657
18658
18659 .option local_parts routers&!? "local part list&!!" unset
18660 .cindex "router" "restricting to specific local parts"
18661 .cindex "local part" "checking in router"
18662 The router is run only if the local part of the address matches the list.
18663 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18664 are evaluated, and
18665 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18666 string is expanded, it is possible to make it depend on the domain, for
18667 example:
18668 .code
18669 local_parts = dbm;/usr/local/specials/$domain
18670 .endd
18671 .vindex "&$local_part_data$&"
18672 If the match is achieved by a lookup, the data that the lookup returned
18673 for the local part is placed in the variable &$local_part_data$& for use in
18674 expansions of the router's private options. You might use this option, for
18675 example, if you have a large number of local virtual domains, and you want to
18676 send all postmaster mail to the same place without having to set up an alias in
18677 each virtual domain:
18678 .code
18679 postmaster:
18680   driver = redirect
18681   local_parts = postmaster
18682   data = postmaster@real.domain.example
18683 .endd
18684
18685
18686 .option log_as_local routers boolean "see below"
18687 .cindex "log" "delivery line"
18688 .cindex "delivery" "log line format"
18689 Exim has two logging styles for delivery, the idea being to make local
18690 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18691 recipient address is given just as the local part, without a domain. The use of
18692 this style is controlled by this option. It defaults to true for the &(accept)&
18693 router, and false for all the others. This option applies only when a
18694 router assigns an address to a transport. It has no effect on routers that
18695 redirect addresses.
18696
18697
18698
18699 .option more routers boolean&!! true
18700 The result of string expansion for this option must be a valid boolean value,
18701 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18702 result causes an error, and delivery is deferred. If the expansion is forced to
18703 fail, the default value for the option (true) is used. Other failures cause
18704 delivery to be deferred.
18705
18706 If this option is set false, and the router declines to handle the address, no
18707 further routers are tried, routing fails, and the address is bounced.
18708 .oindex "&%self%&"
18709 However, if the router explicitly passes an address to the following router by
18710 means of the setting
18711 .code
18712 self = pass
18713 .endd
18714 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18715 does not affect the behaviour if one of the precondition tests fails. In that
18716 case, the address is always passed to the next router.
18717
18718 Note that &%address_data%& is not considered to be a precondition. If its
18719 expansion is forced to fail, the router declines, and the value of &%more%&
18720 controls what happens next.
18721
18722
18723 .option pass_on_timeout routers boolean false
18724 .cindex "timeout" "of router"
18725 .cindex "router" "timeout"
18726 If a router times out during a host lookup, it normally causes deferral of the
18727 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18728 router, overriding &%no_more%&. This may be helpful for systems that are
18729 intermittently connected to the Internet, or those that want to pass to a smart
18730 host any messages that cannot immediately be delivered.
18731
18732 There are occasional other temporary errors that can occur while doing DNS
18733 lookups. They are treated in the same way as a timeout, and this option
18734 applies to all of them.
18735
18736
18737
18738 .option pass_router routers string unset
18739 .cindex "router" "go to after &""pass""&"
18740 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18741 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18742 routing to continue, and overriding a false setting of &%more%&. When one of
18743 these routers returns &"pass"&, the address is normally handed on to the next
18744 router in sequence. This can be changed by setting &%pass_router%& to the name
18745 of another router. However (unlike &%redirect_router%&) the named router must
18746 be below the current router, to avoid loops. Note that this option applies only
18747 to the special case of &"pass"&. It does not apply when a router returns
18748 &"decline"& because it cannot handle an address.
18749
18750
18751
18752 .option redirect_router routers string unset
18753 .cindex "router" "start at after redirection"
18754 Sometimes an administrator knows that it is pointless to reprocess addresses
18755 generated from alias or forward files with the same router again. For
18756 example, if an alias file translates real names into login ids there is no
18757 point searching the alias file a second time, especially if it is a large file.
18758
18759 The &%redirect_router%& option can be set to the name of any router instance.
18760 It causes the routing of any generated addresses to start at the named router
18761 instead of at the first router. This option has no effect if the router in
18762 which it is set does not generate new addresses.
18763
18764
18765
18766 .option require_files routers&!? "string list&!!" unset
18767 .cindex "file" "requiring for router"
18768 .cindex "router" "requiring file existence"
18769 This option provides a general mechanism for predicating the running of a
18770 router on the existence or non-existence of certain files or directories.
18771 Before running a router, as one of its precondition tests, Exim works its way
18772 through the &%require_files%& list, expanding each item separately.
18773
18774 Because the list is split before expansion, any colons in expansion items must
18775 be doubled, or the facility for using a different list separator must be used
18776 (&<<SECTlistsepchange>>&).
18777 If any expansion is forced to fail, the item is ignored. Other expansion
18778 failures cause routing of the address to be deferred.
18779
18780 If any expanded string is empty, it is ignored. Otherwise, except as described
18781 below, each string must be a fully qualified file path, optionally preceded by
18782 &"!"&. The paths are passed to the &[stat()]& function to test for the
18783 existence of the files or directories. The router is skipped if any paths not
18784 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18785
18786 .cindex "NFS"
18787 If &[stat()]& cannot determine whether a file exists or not, delivery of
18788 the message is deferred. This can happen when NFS-mounted filesystems are
18789 unavailable.
18790
18791 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18792 options, so you cannot use it to check for the existence of a file in which to
18793 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18794 full list of the order in which preconditions are evaluated.) However, as
18795 these options are all expanded, you can use the &%exists%& expansion condition
18796 to make such tests. The &%require_files%& option is intended for checking files
18797 that the router may be going to use internally, or which are needed by a
18798 transport (e.g., &_.procmailrc_&).
18799
18800 During delivery, the &[stat()]& function is run as root, but there is a
18801 facility for some checking of the accessibility of a file by another user.
18802 This is not a proper permissions check, but just a &"rough"& check that
18803 operates as follows:
18804
18805 If an item in a &%require_files%& list does not contain any forward slash
18806 characters, it is taken to be the user (and optional group, separated by a
18807 comma) to be checked for subsequent files in the list. If no group is specified
18808 but the user is specified symbolically, the gid associated with the uid is
18809 used. For example:
18810 .code
18811 require_files = mail:/some/file
18812 require_files = $local_part:$home/.procmailrc
18813 .endd
18814 If a user or group name in a &%require_files%& list does not exist, the
18815 &%require_files%& condition fails.
18816
18817 Exim performs the check by scanning along the components of the file path, and
18818 checking the access for the given uid and gid. It checks for &"x"& access on
18819 directories, and &"r"& access on the final file. Note that this means that file
18820 access control lists, if the operating system has them, are ignored.
18821
18822 &*Warning 1*&: When the router is being run to verify addresses for an
18823 incoming SMTP message, Exim is not running as root, but under its own uid. This
18824 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18825 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18826 user is not permitted to read one of the directories on the file's path.
18827
18828 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18829 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18830 without root access. In this case, if a check for access by a particular user
18831 is requested, Exim creates a subprocess that runs as that user, and tries the
18832 check again in that process.
18833
18834 The default action for handling an unresolved EACCES is to consider it to
18835 be caused by a configuration error, and routing is deferred because the
18836 existence or non-existence of the file cannot be determined. However, in some
18837 circumstances it may be desirable to treat this condition as if the file did
18838 not exist. If the filename (or the exclamation mark that precedes the filename
18839 for non-existence) is preceded by a plus sign, the EACCES error is treated
18840 as if the file did not exist. For example:
18841 .code
18842 require_files = +/some/file
18843 .endd
18844 If the router is not an essential part of verification (for example, it
18845 handles users' &_.forward_& files), another solution is to set the &%verify%&
18846 option false so that the router is skipped when verifying.
18847
18848
18849
18850 .option retry_use_local_part routers boolean "see below"
18851 .cindex "hints database" "retry keys"
18852 .cindex "local part" "in retry keys"
18853 When a delivery suffers a temporary routing failure, a retry record is created
18854 in Exim's hints database. For addresses whose routing depends only on the
18855 domain, the key for the retry record should not involve the local part, but for
18856 other addresses, both the domain and the local part should be included.
18857 Usually, remote routing is of the former kind, and local routing is of the
18858 latter kind.
18859
18860 This option controls whether the local part is used to form the key for retry
18861 hints for addresses that suffer temporary errors while being handled by this
18862 router. The default value is true for any router that has &%check_local_user%&
18863 set, and false otherwise. Note that this option does not apply to hints keys
18864 for transport delays; they are controlled by a generic transport option of the
18865 same name.
18866
18867 The setting of &%retry_use_local_part%& applies only to the router on which it
18868 appears. If the router generates child addresses, they are routed
18869 independently; this setting does not become attached to them.
18870
18871
18872
18873 .option router_home_directory routers string&!! unset
18874 .cindex "router" "home directory for"
18875 .cindex "home directory" "for router"
18876 .vindex "&$home$&"
18877 This option sets a home directory for use while the router is running. (Compare
18878 &%transport_home_directory%&, which sets a home directory for later
18879 transporting.) In particular, if used on a &(redirect)& router, this option
18880 sets a value for &$home$& while a filter is running. The value is expanded;
18881 forced expansion failure causes the option to be ignored &-- other failures
18882 cause the router to defer.
18883
18884 Expansion of &%router_home_directory%& happens immediately after the
18885 &%check_local_user%& test (if configured), before any further expansions take
18886 place.
18887 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18888 are evaluated.)
18889 While the router is running, &%router_home_directory%& overrides the value of
18890 &$home$& that came from &%check_local_user%&.
18891
18892 When a router accepts an address and assigns it to a local transport (including
18893 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18894 delivery), the home directory setting for the transport is taken from the first
18895 of these values that is set:
18896
18897 .ilist
18898 The &%home_directory%& option on the transport;
18899 .next
18900 The &%transport_home_directory%& option on the router;
18901 .next
18902 The password data if &%check_local_user%& is set on the router;
18903 .next
18904 The &%router_home_directory%& option on the router.
18905 .endlist
18906
18907 In other words, &%router_home_directory%& overrides the password data for the
18908 router, but not for the transport.
18909
18910
18911
18912 .option self routers string freeze
18913 .cindex "MX record" "pointing to local host"
18914 .cindex "local host" "MX pointing to"
18915 This option applies to those routers that use a recipient address to find a
18916 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18917 and &(manualroute)& routers.
18918 Certain configurations of the &(queryprogram)& router can also specify a list
18919 of remote hosts.
18920 Usually such routers are configured to send the message to a remote host via an
18921 &(smtp)& transport. The &%self%& option specifies what happens when the first
18922 host on the list turns out to be the local host.
18923 The way in which Exim checks for the local host is described in section
18924 &<<SECTreclocipadd>>&.
18925
18926 Normally this situation indicates either an error in Exim's configuration (for
18927 example, the router should be configured not to process this domain), or an
18928 error in the DNS (for example, the MX should not point to this host). For this
18929 reason, the default action is to log the incident, defer the address, and
18930 freeze the message. The following alternatives are provided for use in special
18931 cases:
18932
18933 .vlist
18934 .vitem &%defer%&
18935 Delivery of the message is tried again later, but the message is not frozen.
18936
18937 .vitem "&%reroute%&: <&'domain'&>"
18938 The domain is changed to the given domain, and the address is passed back to
18939 be reprocessed by the routers. No rewriting of headers takes place. This
18940 behaviour is essentially a redirection.
18941
18942 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18943 The domain is changed to the given domain, and the address is passed back to be
18944 reprocessed by the routers. Any headers that contain the original domain are
18945 rewritten.
18946
18947 .vitem &%pass%&
18948 .oindex "&%more%&"
18949 .vindex "&$self_hostname$&"
18950 The router passes the address to the next router, or to the router named in the
18951 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18952 subsequent routing and delivery, the variable &$self_hostname$& contains the
18953 name of the local host that the router encountered. This can be used to
18954 distinguish between different cases for hosts with multiple names. The
18955 combination
18956 .code
18957 self = pass
18958 no_more
18959 .endd
18960 ensures that only those addresses that routed to the local host are passed on.
18961 Without &%no_more%&, addresses that were declined for other reasons would also
18962 be passed to the next router.
18963
18964 .vitem &%fail%&
18965 Delivery fails and an error report is generated.
18966
18967 .vitem &%send%&
18968 .cindex "local host" "sending to"
18969 The anomaly is ignored and the address is queued for the transport. This
18970 setting should be used with extreme caution. For an &(smtp)& transport, it
18971 makes sense only in cases where the program that is listening on the SMTP port
18972 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18973 different configuration file that handles the domain in another way.
18974 .endlist
18975
18976
18977
18978 .option senders routers&!? "address list&!!" unset
18979 .cindex "router" "checking senders"
18980 If this option is set, the router is skipped unless the message's sender
18981 address matches something on the list.
18982 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18983 are evaluated.
18984
18985 There are issues concerning verification when the running of routers is
18986 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18987 setting, it sets the sender to the null string. When using the &%-bt%& option
18988 to check a configuration file, it is necessary also to use the &%-f%& option to
18989 set an appropriate sender. For incoming mail, the sender is unset when
18990 verifying the sender, but is available when verifying any recipients. If the
18991 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18992 matters.
18993
18994
18995 .option translate_ip_address routers string&!! unset
18996 .cindex "IP address" "translating"
18997 .cindex "packet radio"
18998 .cindex "router" "IP address translation"
18999 There exist some rare networking situations (for example, packet radio) where
19000 it is helpful to be able to translate IP addresses generated by normal routing
19001 mechanisms into other IP addresses, thus performing a kind of manual IP
19002 routing. This should be done only if the normal IP routing of the TCP/IP stack
19003 is inadequate or broken. Because this is an extremely uncommon requirement, the
19004 code to support this option is not included in the Exim binary unless
19005 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19006
19007 .vindex "&$host_address$&"
19008 The &%translate_ip_address%& string is expanded for every IP address generated
19009 by the router, with the generated address set in &$host_address$&. If the
19010 expansion is forced to fail, no action is taken.
19011 For any other expansion error, delivery of the message is deferred.
19012 If the result of the expansion is an IP address, that replaces the original
19013 address; otherwise the result is assumed to be a host name &-- this is looked
19014 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19015 produce one or more replacement IP addresses. For example, to subvert all IP
19016 addresses in some specific networks, this could be added to a router:
19017 .code
19018 translate_ip_address = \
19019   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19020     {$value}fail}}
19021 .endd
19022 The file would contain lines like
19023 .code
19024 10.2.3.128/26    some.host
19025 10.8.4.34/26     10.44.8.15
19026 .endd
19027 You should not make use of this facility unless you really understand what you
19028 are doing.
19029
19030
19031
19032 .option transport routers string&!! unset
19033 This option specifies the transport to be used when a router accepts an address
19034 and sets it up for delivery. A transport is never needed if a router is used
19035 only for verification. The value of the option is expanded at routing time,
19036 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19037 and result must be the name of one of the configured transports. If it is not,
19038 delivery is deferred.
19039
19040 The &%transport%& option is not used by the &(redirect)& router, but it does
19041 have some private options that set up transports for pipe and file deliveries
19042 (see chapter &<<CHAPredirect>>&).
19043
19044
19045
19046 .option transport_current_directory routers string&!! unset
19047 .cindex "current directory for local transport"
19048 This option associates a current directory with any address that is routed
19049 to a local transport. This can happen either because a transport is
19050 explicitly configured for the router, or because it generates a delivery to a
19051 file or a pipe. During the delivery process (that is, at transport time), this
19052 option string is expanded and is set as the current directory, unless
19053 overridden by a setting on the transport.
19054 If the expansion fails for any reason, including forced failure, an error is
19055 logged, and delivery is deferred.
19056 See chapter &<<CHAPenvironment>>& for details of the local delivery
19057 environment.
19058
19059
19060
19061
19062 .option transport_home_directory routers string&!! "see below"
19063 .cindex "home directory" "for local transport"
19064 This option associates a home directory with any address that is routed to a
19065 local transport. This can happen either because a transport is explicitly
19066 configured for the router, or because it generates a delivery to a file or a
19067 pipe. During the delivery process (that is, at transport time), the option
19068 string is expanded and is set as the home directory, unless overridden by a
19069 setting of &%home_directory%& on the transport.
19070 If the expansion fails for any reason, including forced failure, an error is
19071 logged, and delivery is deferred.
19072
19073 If the transport does not specify a home directory, and
19074 &%transport_home_directory%& is not set for the router, the home directory for
19075 the transport is taken from the password data if &%check_local_user%& is set for
19076 the router. Otherwise it is taken from &%router_home_directory%& if that option
19077 is set; if not, no home directory is set for the transport.
19078
19079 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19080 environment.
19081
19082
19083
19084
19085 .option unseen routers boolean&!! false
19086 .cindex "router" "carrying on after success"
19087 The result of string expansion for this option must be a valid boolean value,
19088 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19089 result causes an error, and delivery is deferred. If the expansion is forced to
19090 fail, the default value for the option (false) is used. Other failures cause
19091 delivery to be deferred.
19092
19093 When this option is set true, routing does not cease if the router accepts the
19094 address. Instead, a copy of the incoming address is passed to the next router,
19095 overriding a false setting of &%more%&. There is little point in setting
19096 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19097 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19098 sometimes true and sometimes false).
19099
19100 .cindex "copy of message (&%unseen%& option)"
19101 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19102 qualifier in filter files. It can be used to cause copies of messages to be
19103 delivered to some other destination, while also carrying out a normal delivery.
19104 In effect, the current address is made into a &"parent"& that has two children
19105 &-- one that is delivered as specified by this router, and a clone that goes on
19106 to be routed further. For this reason, &%unseen%& may not be combined with the
19107 &%one_time%& option in a &(redirect)& router.
19108
19109 &*Warning*&: Header lines added to the address (or specified for removal) by
19110 this router or by previous routers affect the &"unseen"& copy of the message
19111 only. The clone that continues to be processed by further routers starts with
19112 no added headers and none specified for removal. For a &%redirect%& router, if
19113 a generated address is the same as the incoming address, this can lead to
19114 duplicate addresses with different header modifications. Exim does not do
19115 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19116 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19117 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19118 &%redirect%& router may be of help.
19119
19120 Unlike the handling of header modifications, any data that was set by the
19121 &%address_data%& option in the current or previous routers &'is'& passed on to
19122 subsequent routers.
19123
19124
19125 .option user routers string&!! "see below"
19126 .cindex "uid (user id)" "local delivery"
19127 .cindex "local transports" "uid and gid"
19128 .cindex "transport" "local"
19129 .cindex "router" "user for filter processing"
19130 .cindex "filter" "user for processing"
19131 When a router queues an address for a transport, and the transport does not
19132 specify a user, the user given here is used when running the delivery process.
19133 The user may be specified numerically or by name. If expansion fails, the
19134 error is logged and delivery is deferred.
19135 This user is also used by the &(redirect)& router when running a filter file.
19136 The default is unset, except when &%check_local_user%& is set. In this case,
19137 the default is taken from the password information. If the user is specified as
19138 a name, and &%group%& is not set, the group associated with the user is used.
19139 See also &%initgroups%& and &%group%& and the discussion in chapter
19140 &<<CHAPenvironment>>&.
19141
19142
19143
19144 .option verify routers&!? boolean true
19145 Setting this option has the effect of setting &%verify_sender%& and
19146 &%verify_recipient%& to the same value.
19147
19148
19149 .option verify_only routers&!? boolean false
19150 .cindex "EXPN" "with &%verify_only%&"
19151 .oindex "&%-bv%&"
19152 .cindex "router" "used only when verifying"
19153 If this option is set, the router is used only when verifying an address,
19154 delivering in cutthrough mode or
19155 testing with the &%-bv%& option, not when actually doing a delivery, testing
19156 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19157 restricted to verifying only senders or recipients by means of
19158 &%verify_sender%& and &%verify_recipient%&.
19159
19160 &*Warning*&: When the router is being run to verify addresses for an incoming
19161 SMTP message, Exim is not running as root, but under its own uid. If the router
19162 accesses any files, you need to make sure that they are accessible to the Exim
19163 user or group.
19164
19165
19166 .option verify_recipient routers&!? boolean true
19167 If this option is false, the router is skipped when verifying recipient
19168 addresses,
19169 delivering in cutthrough mode
19170 or testing recipient verification using &%-bv%&.
19171 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19172 are evaluated.
19173 See also the &$verify_mode$& variable.
19174
19175
19176 .option verify_sender routers&!? boolean true
19177 If this option is false, the router is skipped when verifying sender addresses
19178 or testing sender verification using &%-bvs%&.
19179 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19180 are evaluated.
19181 See also the &$verify_mode$& variable.
19182 .ecindex IIDgenoprou1
19183 .ecindex IIDgenoprou2
19184
19185
19186
19187
19188
19189
19190 . ////////////////////////////////////////////////////////////////////////////
19191 . ////////////////////////////////////////////////////////////////////////////
19192
19193 .chapter "The accept router" "CHID4"
19194 .cindex "&(accept)& router"
19195 .cindex "routers" "&(accept)&"
19196 The &(accept)& router has no private options of its own. Unless it is being
19197 used purely for verification (see &%verify_only%&) a transport is required to
19198 be defined by the generic &%transport%& option. If the preconditions that are
19199 specified by generic options are met, the router accepts the address and queues
19200 it for the given transport. The most common use of this router is for setting
19201 up deliveries to local mailboxes. For example:
19202 .code
19203 localusers:
19204   driver = accept
19205   domains = mydomain.example
19206   check_local_user
19207   transport = local_delivery
19208 .endd
19209 The &%domains%& condition in this example checks the domain of the address, and
19210 &%check_local_user%& checks that the local part is the login of a local user.
19211 When both preconditions are met, the &(accept)& router runs, and queues the
19212 address for the &(local_delivery)& transport.
19213
19214
19215
19216
19217
19218
19219 . ////////////////////////////////////////////////////////////////////////////
19220 . ////////////////////////////////////////////////////////////////////////////
19221
19222 .chapter "The dnslookup router" "CHAPdnslookup"
19223 .scindex IIDdnsrou1 "&(dnslookup)& router"
19224 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19225 The &(dnslookup)& router looks up the hosts that handle mail for the
19226 recipient's domain in the DNS. A transport must always be set for this router,
19227 unless &%verify_only%& is set.
19228
19229 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19230 SRV records. If none are found, or if SRV support is not configured,
19231 MX records are looked up. If no MX records exist, address records are sought.
19232 However, &%mx_domains%& can be set to disable the direct use of address
19233 records.
19234
19235 MX records of equal priority are sorted by Exim into a random order. Exim then
19236 looks for address records for the host names obtained from MX or SRV records.
19237 When a host has more than one IP address, they are sorted into a random order,
19238 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19239 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19240 generic option, the router declines.
19241
19242 Unless they have the highest priority (lowest MX value), MX records that point
19243 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19244 are discarded, together with any other MX records of equal or lower priority.
19245
19246 .cindex "MX record" "pointing to local host"
19247 .cindex "local host" "MX pointing to"
19248 .oindex "&%self%&" "in &(dnslookup)& router"
19249 If the host pointed to by the highest priority MX record, or looked up as an
19250 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19251 happens is controlled by the generic &%self%& option.
19252
19253
19254 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19255 There have been problems with DNS servers when SRV records are looked up.
19256 Some misbehaving servers return a DNS error or timeout when a non-existent
19257 SRV record is sought. Similar problems have in the past been reported for
19258 MX records. The global &%dns_again_means_nonexist%& option can help with this
19259 problem, but it is heavy-handed because it is a global option.
19260
19261 For this reason, there are two options, &%srv_fail_domains%& and
19262 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19263 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19264 an attempt to look up an SRV or MX record causes one of these results, and the
19265 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19266 such record"&. In the case of an SRV lookup, this means that the router
19267 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19268 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19269 case routing fails.
19270
19271
19272 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19273 .cindex "&(dnslookup)& router" "declines"
19274 There are a few cases where a &(dnslookup)& router will decline to accept
19275 an address; if such a router is expected to handle "all remaining non-local
19276 domains", then it is important to set &%no_more%&.
19277
19278 The router will defer rather than decline if the domain
19279 is found in the &%fail_defer_domains%& router option.
19280
19281 Reasons for a &(dnslookup)& router to decline currently include:
19282 .ilist
19283 The domain does not exist in DNS
19284 .next
19285 The domain exists but the MX record's host part is just "."; this is a common
19286 convention (borrowed from SRV) used to indicate that there is no such service
19287 for this domain and to not fall back to trying A/AAAA records.
19288 .next
19289 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19290 .next
19291 MX record points to a non-existent host.
19292 .next
19293 MX record points to an IP address and the main section option
19294 &%allow_mx_to_ip%& is not set.
19295 .next
19296 MX records exist and point to valid hosts, but all hosts resolve only to
19297 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19298 .next
19299 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19300 &%dns_check_names_pattern%& for handling one variant of this)
19301 .next
19302 &%check_secondary_mx%& is set on this router but the local host can
19303 not be found in the MX records (see below)
19304 .endlist
19305
19306
19307
19308
19309 .section "Private options for dnslookup" "SECID118"
19310 .cindex "options" "&(dnslookup)& router"
19311 The private options for the &(dnslookup)& router are as follows:
19312
19313 .option check_secondary_mx dnslookup boolean false
19314 .cindex "MX record" "checking for secondary"
19315 If this option is set, the router declines unless the local host is found in
19316 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19317 process domains for which the local host is a secondary mail exchanger
19318 differently to other domains. The way in which Exim decides whether a host is
19319 the local host is described in section &<<SECTreclocipadd>>&.
19320
19321
19322 .option check_srv dnslookup string&!! unset
19323 .cindex "SRV record" "enabling use of"
19324 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19325 addition to MX and address records. The support is disabled by default. To
19326 enable SRV support, set the &%check_srv%& option to the name of the service
19327 required. For example,
19328 .code
19329 check_srv = smtp
19330 .endd
19331 looks for SRV records that refer to the normal smtp service. The option is
19332 expanded, so the service name can vary from message to message or address
19333 to address. This might be helpful if SRV records are being used for a
19334 submission service. If the expansion is forced to fail, the &%check_srv%&
19335 option is ignored, and the router proceeds to look for MX records in the
19336 normal way.
19337
19338 When the expansion succeeds, the router searches first for SRV records for
19339 the given service (it assumes TCP protocol). A single SRV record with a
19340 host name that consists of just a single dot indicates &"no such service for
19341 this domain"&; if this is encountered, the router declines. If other kinds of
19342 SRV record are found, they are used to construct a host list for delivery
19343 according to the rules of RFC 2782. MX records are not sought in this case.
19344
19345 When no SRV records are found, MX records (and address records) are sought in
19346 the traditional way. In other words, SRV records take precedence over MX
19347 records, just as MX records take precedence over address records. Note that
19348 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19349 defined it. It is apparently believed that MX records are sufficient for email
19350 and that SRV records should not be used for this purpose. However, SRV records
19351 have an additional &"weight"& feature which some people might find useful when
19352 trying to split an SMTP load between hosts of different power.
19353
19354 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19355 when there is a DNS lookup error.
19356
19357
19358
19359
19360 .option fail_defer_domains dnslookup "domain list&!!" unset
19361 .cindex "MX record" "not found"
19362 DNS lookups for domains matching &%fail_defer_domains%&
19363 which find no matching record will cause the router to defer
19364 rather than the default behaviour of decline.
19365 This maybe be useful for queueing messages for a newly created
19366 domain while the DNS configuration is not ready.
19367 However, it will result in any message with mistyped domains
19368 also being queued.
19369
19370
19371 .option ipv4_only "string&!!" unset
19372 .cindex IPv6 disabling
19373 .cindex DNS "IPv6 disabling"
19374 The string is expanded, and if the result is anything but a forced failure,
19375 or an empty string, or one of the strings “0” or “no” or “false”
19376 (checked without regard to the case of the letters),
19377 only A records are used.
19378
19379 .option ipv4_prefer "string&!!" unset
19380 .cindex IPv4 preference
19381 .cindex DNS "IPv4 preference"
19382 The string is expanded, and if the result is anything but a forced failure,
19383 or an empty string, or one of the strings “0” or “no” or “false”
19384 (checked without regard to the case of the letters),
19385 A records are sorted before AAAA records (inverting the default).
19386
19387 .option mx_domains dnslookup "domain list&!!" unset
19388 .cindex "MX record" "required to exist"
19389 .cindex "SRV record" "required to exist"
19390 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19391 record in order to be recognized. (The name of this option could be improved.)
19392 For example, if all the mail hosts in &'fict.example'& are known to have MX
19393 records, except for those in &'discworld.fict.example'&, you could use this
19394 setting:
19395 .code
19396 mx_domains = ! *.discworld.fict.example : *.fict.example
19397 .endd
19398 This specifies that messages addressed to a domain that matches the list but
19399 has no MX record should be bounced immediately instead of being routed using
19400 the address record.
19401
19402
19403 .option mx_fail_domains dnslookup "domain list&!!" unset
19404 If the DNS lookup for MX records for one of the domains in this list causes a
19405 DNS lookup error, Exim behaves as if no MX records were found. See section
19406 &<<SECTprowitdnsloo>>& for more discussion.
19407
19408
19409
19410
19411 .option qualify_single dnslookup boolean true
19412 .cindex "DNS" "resolver options"
19413 .cindex "DNS" "qualifying single-component names"
19414 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19415 lookups. Typically, but not standardly, this causes the resolver to qualify
19416 single-component names with the default domain. For example, on a machine
19417 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19418 &'thesaurus.ref.example'& inside the resolver. For details of what your
19419 resolver actually does, consult your man pages for &'resolver'& and
19420 &'resolv.conf'&.
19421
19422
19423
19424 .option rewrite_headers dnslookup boolean true
19425 .cindex "rewriting" "header lines"
19426 .cindex "header lines" "rewriting"
19427 If the domain name in the address that is being processed is not fully
19428 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19429 an address is specified as &'dormouse@teaparty'&, the domain might be
19430 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19431 occur as a result of setting the &%widen_domains%& option. If
19432 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19433 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19434 header lines of the message are rewritten with the full domain name.
19435
19436 This option should be turned off only when it is known that no message is
19437 ever going to be sent outside an environment where the abbreviation makes
19438 sense.
19439
19440 When an MX record is looked up in the DNS and matches a wildcard record, name
19441 servers normally return a record containing the name that has been looked up,
19442 making it impossible to detect whether a wildcard was present or not. However,
19443 some name servers have recently been seen to return the wildcard entry. If the
19444 name returned by a DNS lookup begins with an asterisk, it is not used for
19445 header rewriting.
19446
19447
19448 .option same_domain_copy_routing dnslookup boolean false
19449 .cindex "address" "copying routing"
19450 Addresses with the same domain are normally routed by the &(dnslookup)& router
19451 to the same list of hosts. However, this cannot be presumed, because the router
19452 options and preconditions may refer to the local part of the address. By
19453 default, therefore, Exim routes each address in a message independently. DNS
19454 servers run caches, so repeated DNS lookups are not normally expensive, and in
19455 any case, personal messages rarely have more than a few recipients.
19456
19457 If you are running mailing lists with large numbers of subscribers at the same
19458 domain, and you are using a &(dnslookup)& router which is independent of the
19459 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19460 lookups for identical domains in one message. In this case, when &(dnslookup)&
19461 routes an address to a remote transport, any other unrouted addresses in the
19462 message that have the same domain are automatically given the same routing
19463 without processing them independently,
19464 provided the following conditions are met:
19465
19466 .ilist
19467 No router that processed the address specified &%headers_add%& or
19468 &%headers_remove%&.
19469 .next
19470 The router did not change the address in any way, for example, by &"widening"&
19471 the domain.
19472 .endlist
19473
19474
19475
19476
19477 .option search_parents dnslookup boolean false
19478 .cindex "DNS" "resolver options"
19479 When this option is true, the resolver option RES_DNSRCH is set for DNS
19480 lookups. This is different from the &%qualify_single%& option in that it
19481 applies to domains containing dots. Typically, but not standardly, it causes
19482 the resolver to search for the name in the current domain and in parent
19483 domains. For example, on a machine in the &'fict.example'& domain, if looking
19484 up &'teaparty.wonderland'& failed, the resolver would try
19485 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19486 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19487
19488 Setting this option true can cause problems in domains that have a wildcard MX
19489 record, because any domain that does not have its own MX record matches the
19490 local wildcard.
19491
19492
19493
19494 .option srv_fail_domains dnslookup "domain list&!!" unset
19495 If the DNS lookup for SRV records for one of the domains in this list causes a
19496 DNS lookup error, Exim behaves as if no SRV records were found. See section
19497 &<<SECTprowitdnsloo>>& for more discussion.
19498
19499
19500
19501
19502 .option widen_domains dnslookup "string list" unset
19503 .cindex "domain" "partial; widening"
19504 If a DNS lookup fails and this option is set, each of its strings in turn is
19505 added onto the end of the domain, and the lookup is tried again. For example,
19506 if
19507 .code
19508 widen_domains = fict.example:ref.example
19509 .endd
19510 is set and a lookup of &'klingon.dictionary'& fails,
19511 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19512 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19513 and &%search_parents%& options can cause some widening to be undertaken inside
19514 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19515 when verifying, unless &%rewrite_headers%& is false (not the default).
19516
19517
19518 .section "Effect of qualify_single and search_parents" "SECID119"
19519 When a domain from an envelope recipient is changed by the resolver as a result
19520 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19521 corresponding address in the message's header lines unless &%rewrite_headers%&
19522 is set false. Exim then re-routes the address, using the full domain.
19523
19524 These two options affect only the DNS lookup that takes place inside the router
19525 for the domain of the address that is being routed. They do not affect lookups
19526 such as that implied by
19527 .code
19528 domains = @mx_any
19529 .endd
19530 that may happen while processing a router precondition before the router is
19531 entered. No widening ever takes place for these lookups.
19532 .ecindex IIDdnsrou1
19533 .ecindex IIDdnsrou2
19534
19535
19536
19537
19538
19539
19540
19541
19542
19543 . ////////////////////////////////////////////////////////////////////////////
19544 . ////////////////////////////////////////////////////////////////////////////
19545
19546 .chapter "The ipliteral router" "CHID5"
19547 .cindex "&(ipliteral)& router"
19548 .cindex "domain literal" "routing"
19549 .cindex "routers" "&(ipliteral)&"
19550 This router has no private options. Unless it is being used purely for
19551 verification (see &%verify_only%&) a transport is required to be defined by the
19552 generic &%transport%& option. The router accepts the address if its domain part
19553 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19554 router handles the address
19555 .code
19556 root@[192.168.1.1]
19557 .endd
19558 by setting up delivery to the host with that IP address. IPv4 domain literals
19559 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19560 are similar, but the address is preceded by &`ipv6:`&. For example:
19561 .code
19562 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19563 .endd
19564 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19565 grounds that sooner or later somebody will try it.
19566
19567 .oindex "&%self%&" "in &(ipliteral)& router"
19568 If the IP address matches something in &%ignore_target_hosts%&, the router
19569 declines. If an IP literal turns out to refer to the local host, the generic
19570 &%self%& option determines what happens.
19571
19572 The RFCs require support for domain literals; however, their use is
19573 controversial in today's Internet. If you want to use this router, you must
19574 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19575 Exim will not recognize the domain literal syntax in addresses.
19576
19577
19578
19579 . ////////////////////////////////////////////////////////////////////////////
19580 . ////////////////////////////////////////////////////////////////////////////
19581
19582 .chapter "The iplookup router" "CHID6"
19583 .cindex "&(iplookup)& router"
19584 .cindex "routers" "&(iplookup)&"
19585 The &(iplookup)& router was written to fulfil a specific requirement in
19586 Cambridge University (which in fact no longer exists). For this reason, it is
19587 not included in the binary of Exim by default. If you want to include it, you
19588 must set
19589 .code
19590 ROUTER_IPLOOKUP=yes
19591 .endd
19592 in your &_Local/Makefile_& configuration file.
19593
19594 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19595 connection to one or more specific hosts. The host can then return the same or
19596 a different address &-- in effect rewriting the recipient address in the
19597 message's envelope. The new address is then passed on to subsequent routers. If
19598 this process fails, the address can be passed on to other routers, or delivery
19599 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19600 must not be specified for it.
19601
19602 .cindex "options" "&(iplookup)& router"
19603 .option hosts iplookup string unset
19604 This option must be supplied. Its value is a colon-separated list of host
19605 names. The hosts are looked up using &[gethostbyname()]&
19606 (or &[getipnodebyname()]& when available)
19607 and are tried in order until one responds to the query. If none respond, what
19608 happens is controlled by &%optional%&.
19609
19610
19611 .option optional iplookup boolean false
19612 If &%optional%& is true, if no response is obtained from any host, the address
19613 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19614 delivery to the address is deferred.
19615
19616
19617 .option port iplookup integer 0
19618 .cindex "port" "&(iplookup)& router"
19619 This option must be supplied. It specifies the port number for the TCP or UDP
19620 call.
19621
19622
19623 .option protocol iplookup string udp
19624 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19625 protocols is to be used.
19626
19627
19628 .option query iplookup string&!! "see below"
19629 This defines the content of the query that is sent to the remote hosts. The
19630 default value is:
19631 .code
19632 $local_part@$domain $local_part@$domain
19633 .endd
19634 The repetition serves as a way of checking that a response is to the correct
19635 query in the default case (see &%response_pattern%& below).
19636
19637
19638 .option reroute iplookup string&!! unset
19639 If this option is not set, the rerouted address is precisely the byte string
19640 returned by the remote host, up to the first white space, if any. If set, the
19641 string is expanded to form the rerouted address. It can include parts matched
19642 in the response by &%response_pattern%& by means of numeric variables such as
19643 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19644 whether or not a pattern is in use. In all cases, the rerouted address must end
19645 up in the form &'local_part@domain'&.
19646
19647
19648 .option response_pattern iplookup string unset
19649 This option can be set to a regular expression that is applied to the string
19650 returned from the remote host. If the pattern does not match the response, the
19651 router declines. If &%response_pattern%& is not set, no checking of the
19652 response is done, unless the query was defaulted, in which case there is a
19653 check that the text returned after the first white space is the original
19654 address. This checks that the answer that has been received is in response to
19655 the correct question. For example, if the response is just a new domain, the
19656 following could be used:
19657 .code
19658 response_pattern = ^([^@]+)$
19659 reroute = $local_part@$1
19660 .endd
19661
19662 .option timeout iplookup time 5s
19663 This specifies the amount of time to wait for a response from the remote
19664 machine. The same timeout is used for the &[connect()]& function for a TCP
19665 call. It does not apply to UDP.
19666
19667
19668
19669
19670 . ////////////////////////////////////////////////////////////////////////////
19671 . ////////////////////////////////////////////////////////////////////////////
19672
19673 .chapter "The manualroute router" "CHID7"
19674 .scindex IIDmanrou1 "&(manualroute)& router"
19675 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19676 .cindex "domain" "manually routing"
19677 The &(manualroute)& router is so-called because it provides a way of manually
19678 routing an address according to its domain. It is mainly used when you want to
19679 route addresses to remote hosts according to your own rules, bypassing the
19680 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19681 route to local transports, a facility that may be useful if you want to save
19682 messages for dial-in hosts in local files.
19683
19684 The &(manualroute)& router compares a list of domain patterns with the domain
19685 it is trying to route. If there is no match, the router declines. Each pattern
19686 has associated with it a list of hosts and some other optional data, which may
19687 include a transport. The combination of a pattern and its data is called a
19688 &"routing rule"&. For patterns that do not have an associated transport, the
19689 generic &%transport%& option must specify a transport, unless the router is
19690 being used purely for verification (see &%verify_only%&).
19691
19692 .vindex "&$host$&"
19693 In the case of verification, matching the domain pattern is sufficient for the
19694 router to accept the address. When actually routing an address for delivery,
19695 an address that matches a domain pattern is queued for the associated
19696 transport. If the transport is not a local one, a host list must be associated
19697 with the pattern; IP addresses are looked up for the hosts, and these are
19698 passed to the transport along with the mail address. For local transports, a
19699 host list is optional. If it is present, it is passed in &$host$& as a single
19700 text string.
19701
19702 The list of routing rules can be provided as an inline string in
19703 &%route_list%&, or the data can be obtained by looking up the domain in a file
19704 or database by setting &%route_data%&. Only one of these settings may appear in
19705 any one instance of &(manualroute)&. The format of routing rules is described
19706 below, following the list of private options.
19707
19708
19709 .section "Private options for manualroute" "SECTprioptman"
19710
19711 .cindex "options" "&(manualroute)& router"
19712 The private options for the &(manualroute)& router are as follows:
19713
19714 .option host_all_ignored manualroute string defer
19715 See &%host_find_failed%&.
19716
19717 .option host_find_failed manualroute string freeze
19718 This option controls what happens when &(manualroute)& tries to find an IP
19719 address for a host, and the host does not exist. The option can be set to one
19720 of the following values:
19721 .code
19722 decline
19723 defer
19724 fail
19725 freeze
19726 ignore
19727 pass
19728 .endd
19729 The default (&"freeze"&) assumes that this state is a serious configuration
19730 error. The difference between &"pass"& and &"decline"& is that the former
19731 forces the address to be passed to the next router (or the router defined by
19732 &%pass_router%&),
19733 .oindex "&%more%&"
19734 overriding &%no_more%&, whereas the latter passes the address to the next
19735 router only if &%more%& is true.
19736
19737 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19738 cannot be found. If all the hosts in the list are ignored, the behaviour is
19739 controlled by the &%host_all_ignored%& option. This takes the same values
19740 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19741
19742 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19743 state; if a host lookup gets a temporary error, delivery is deferred unless the
19744 generic &%pass_on_timeout%& option is set.
19745
19746
19747 .option hosts_randomize manualroute boolean false
19748 .cindex "randomized host list"
19749 .cindex "host" "list of; randomized"
19750 If this option is set, the order of the items in a host list in a routing rule
19751 is randomized each time the list is used, unless an option in the routing rule
19752 overrides (see below). Randomizing the order of a host list can be used to do
19753 crude load sharing. However, if more than one mail address is routed by the
19754 same router to the same host list, the host lists are considered to be the same
19755 (even though they may be randomized into different orders) for the purpose of
19756 deciding whether to batch the deliveries into a single SMTP transaction.
19757
19758 When &%hosts_randomize%& is true, a host list may be split
19759 into groups whose order is separately randomized. This makes it possible to
19760 set up MX-like behaviour. The boundaries between groups are indicated by an
19761 item that is just &`+`& in the host list. For example:
19762 .code
19763 route_list = * host1:host2:host3:+:host4:host5
19764 .endd
19765 The order of the first three hosts and the order of the last two hosts is
19766 randomized for each use, but the first three always end up before the last two.
19767 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19768 randomized host list is passed to an &(smtp)& transport that also has
19769 &%hosts_randomize set%&, the list is not re-randomized.
19770
19771
19772 .option route_data manualroute string&!! unset
19773 If this option is set, it must expand to yield the data part of a routing rule.
19774 Typically, the expansion string includes a lookup based on the domain. For
19775 example:
19776 .code
19777 route_data = ${lookup{$domain}dbm{/etc/routes}}
19778 .endd
19779 If the expansion is forced to fail, or the result is an empty string, the
19780 router declines. Other kinds of expansion failure cause delivery to be
19781 deferred.
19782
19783
19784 .option route_list manualroute "string list" unset
19785 This string is a list of routing rules, in the form defined below. Note that,
19786 unlike most string lists, the items are separated by semicolons. This is so
19787 that they may contain colon-separated host lists.
19788
19789
19790 .option same_domain_copy_routing manualroute boolean false
19791 .cindex "address" "copying routing"
19792 Addresses with the same domain are normally routed by the &(manualroute)&
19793 router to the same list of hosts. However, this cannot be presumed, because the
19794 router options and preconditions may refer to the local part of the address. By
19795 default, therefore, Exim routes each address in a message independently. DNS
19796 servers run caches, so repeated DNS lookups are not normally expensive, and in
19797 any case, personal messages rarely have more than a few recipients.
19798
19799 If you are running mailing lists with large numbers of subscribers at the same
19800 domain, and you are using a &(manualroute)& router which is independent of the
19801 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19802 lookups for identical domains in one message. In this case, when
19803 &(manualroute)& routes an address to a remote transport, any other unrouted
19804 addresses in the message that have the same domain are automatically given the
19805 same routing without processing them independently. However, this is only done
19806 if &%headers_add%& and &%headers_remove%& are unset.
19807
19808
19809
19810
19811 .section "Routing rules in route_list" "SECID120"
19812 The value of &%route_list%& is a string consisting of a sequence of routing
19813 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19814 entered as two semicolons. Alternatively, the list separator can be changed as
19815 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19816 Empty rules are ignored. The format of each rule is
19817 .display
19818 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19819 .endd
19820 The following example contains two rules, each with a simple domain pattern and
19821 no options:
19822 .code
19823 route_list = \
19824   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19825   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19826 .endd
19827 The three parts of a rule are separated by white space. The pattern and the
19828 list of hosts can be enclosed in quotes if necessary, and if they are, the
19829 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19830 single domain pattern, which is the only mandatory item in the rule. The
19831 pattern is in the same format as one item in a domain list (see section
19832 &<<SECTdomainlist>>&),
19833 except that it may not be the name of an interpolated file.
19834 That is, it may be wildcarded, or a regular expression, or a file or database
19835 lookup (with semicolons doubled, because of the use of semicolon as a separator
19836 in a &%route_list%&).
19837
19838 The rules in &%route_list%& are searched in order until one of the patterns
19839 matches the domain that is being routed. The list of hosts and then options are
19840 then used as described below. If there is no match, the router declines. When
19841 &%route_list%& is set, &%route_data%& must not be set.
19842
19843
19844
19845 .section "Routing rules in route_data" "SECID121"
19846 The use of &%route_list%& is convenient when there are only a small number of
19847 routing rules. For larger numbers, it is easier to use a file or database to
19848 hold the routing information, and use the &%route_data%& option instead.
19849 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19850 Most commonly, &%route_data%& is set as a string that contains an
19851 expansion lookup. For example, suppose we place two routing rules in a file
19852 like this:
19853 .code
19854 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19855 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19856 .endd
19857 This data can be accessed by setting
19858 .code
19859 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19860 .endd
19861 Failure of the lookup results in an empty string, causing the router to
19862 decline. However, you do not have to use a lookup in &%route_data%&. The only
19863 requirement is that the result of expanding the string is a list of hosts,
19864 possibly followed by options, separated by white space. The list of hosts must
19865 be enclosed in quotes if it contains white space.
19866
19867
19868
19869
19870 .section "Format of the list of hosts" "SECID122"
19871 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19872 always separately expanded before use. If the expansion fails, the router
19873 declines. The result of the expansion must be a colon-separated list of names
19874 and/or IP addresses, optionally also including ports.
19875 If the list is written with spaces, it must be protected with quotes.
19876 The format of each item
19877 in the list is described in the next section. The list separator can be changed
19878 as described in section &<<SECTlistsepchange>>&.
19879
19880 If the list of hosts was obtained from a &%route_list%& item, the following
19881 variables are set during its expansion:
19882
19883 .ilist
19884 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19885 If the domain was matched against a regular expression, the numeric variables
19886 &$1$&, &$2$&, etc. may be set. For example:
19887 .code
19888 route_list = ^domain(\d+)   host-$1.text.example
19889 .endd
19890 .next
19891 &$0$& is always set to the entire domain.
19892 .next
19893 &$1$& is also set when partial matching is done in a file lookup.
19894
19895 .next
19896 .vindex "&$value$&"
19897 If the pattern that matched the domain was a lookup item, the data that was
19898 looked up is available in the expansion variable &$value$&. For example:
19899 .code
19900 route_list = lsearch;;/some/file.routes  $value
19901 .endd
19902 .endlist
19903
19904 Note the doubling of the semicolon in the pattern that is necessary because
19905 semicolon is the default route list separator.
19906
19907
19908
19909 .section "Format of one host item" "SECTformatonehostitem"
19910 Each item in the list of hosts is either a host name or an IP address,
19911 optionally with an attached port number. When no port is given, an IP address
19912 is not enclosed in brackets. When a port is specified, it overrides the port
19913 specification on the transport. The port is separated from the name or address
19914 by a colon. This leads to some complications:
19915
19916 .ilist
19917 Because colon is the default separator for the list of hosts, either
19918 the colon that specifies a port must be doubled, or the list separator must
19919 be changed. The following two examples have the same effect:
19920 .code
19921 route_list = * "host1.tld::1225 : host2.tld::1226"
19922 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19923 .endd
19924 .next
19925 When IPv6 addresses are involved, it gets worse, because they contain
19926 colons of their own. To make this case easier, it is permitted to
19927 enclose an IP address (either v4 or v6) in square brackets if a port
19928 number follows. For example:
19929 .code
19930 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19931 .endd
19932 .endlist
19933
19934 .section "How the list of hosts is used" "SECThostshowused"
19935 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19936 the hosts is tried, in the order specified, when carrying out the SMTP
19937 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19938 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19939 transport.
19940
19941 Hosts may be listed by name or by IP address. An unadorned name in the list of
19942 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19943 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19944 records in the DNS. For example:
19945 .code
19946 route_list = *  x.y.z:p.q.r/MX:e.f.g
19947 .endd
19948 If this feature is used with a port specifier, the port must come last. For
19949 example:
19950 .code
19951 route_list = *  dom1.tld/mx::1225
19952 .endd
19953 If the &%hosts_randomize%& option is set, the order of the items in the list is
19954 randomized before any lookups are done. Exim then scans the list; for any name
19955 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19956 be an interface on the local host and the item is not the first in the list,
19957 Exim discards it and any subsequent items. If it is the first item, what
19958 happens is controlled by the
19959 .oindex "&%self%&" "in &(manualroute)& router"
19960 &%self%& option of the router.
19961
19962 A name on the list that is followed by &`/MX`& is replaced with the list of
19963 hosts obtained by looking up MX records for the name. This is always a DNS
19964 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19965 below) are not relevant here. The order of these hosts is determined by the
19966 preference values in the MX records, according to the usual rules. Because
19967 randomizing happens before the MX lookup, it does not affect the order that is
19968 defined by MX preferences.
19969
19970 If the local host is present in the sublist obtained from MX records, but is
19971 not the most preferred host in that list, it and any equally or less
19972 preferred hosts are removed before the sublist is inserted into the main list.
19973
19974 If the local host is the most preferred host in the MX list, what happens
19975 depends on where in the original list of hosts the &`/MX`& item appears. If it
19976 is not the first item (that is, there are previous hosts in the main list),
19977 Exim discards this name and any subsequent items in the main list.
19978
19979 If the MX item is first in the list of hosts, and the local host is the
19980 most preferred host, what happens is controlled by the &%self%& option of the
19981 router.
19982
19983 DNS failures when lookup up the MX records are treated in the same way as DNS
19984 failures when looking up IP addresses: &%pass_on_timeout%& and
19985 &%host_find_failed%& are used when relevant.
19986
19987 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19988 whether obtained from an MX lookup or not.
19989
19990
19991
19992 .section "How the options are used" "SECThowoptused"
19993 The options are a sequence of words, space-separated.
19994 One of the words can be the name of a transport; this overrides the
19995 &%transport%& option on the router for this particular routing rule only. The
19996 other words (if present) control randomization of the list of hosts on a
19997 per-rule basis, and how the IP addresses of the hosts are to be found when
19998 routing to a remote transport. These options are as follows:
19999
20000 .ilist
20001 &%randomize%&: randomize the order of the hosts in this list, overriding the
20002 setting of &%hosts_randomize%& for this routing rule only.
20003 .next
20004 &%no_randomize%&: do not randomize the order of the hosts in this list,
20005 overriding the setting of &%hosts_randomize%& for this routing rule only.
20006 .next
20007 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20008 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20009 also look in &_/etc/hosts_& or other sources of information.
20010 .next
20011 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20012 no address records are found. If there is a temporary DNS error (such as a
20013 timeout), delivery is deferred.
20014 .next
20015 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20016 .next
20017 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20018 .endlist
20019
20020 For example:
20021 .code
20022 route_list = domain1  host1:host2:host3  randomize bydns;\
20023              domain2  host4:host5
20024 .endd
20025 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20026 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20027 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20028 or &[gethostbyname()]&, and the result of the lookup is the result of that
20029 call.
20030
20031 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20032 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20033 instead of TRY_AGAIN. That is why the default action is to try a DNS
20034 lookup first. Only if that gives a definite &"no such host"& is the local
20035 function called.
20036
20037 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20038 inadvertent constraint that a transport name as an option had to be the last
20039 option specified.
20040
20041
20042
20043 If no IP address for a host can be found, what happens is controlled by the
20044 &%host_find_failed%& option.
20045
20046 .vindex "&$host$&"
20047 When an address is routed to a local transport, IP addresses are not looked up.
20048 The host list is passed to the transport in the &$host$& variable.
20049
20050
20051
20052 .section "Manualroute examples" "SECID123"
20053 In some of the examples that follow, the presence of the &%remote_smtp%&
20054 transport, as defined in the default configuration file, is assumed:
20055
20056 .ilist
20057 .cindex "smart host" "example router"
20058 The &(manualroute)& router can be used to forward all external mail to a
20059 &'smart host'&. If you have set up, in the main part of the configuration, a
20060 named domain list that contains your local domains, for example:
20061 .code
20062 domainlist local_domains = my.domain.example
20063 .endd
20064 You can arrange for all other domains to be routed to a smart host by making
20065 your first router something like this:
20066 .code
20067 smart_route:
20068   driver = manualroute
20069   domains = !+local_domains
20070   transport = remote_smtp
20071   route_list = * smarthost.ref.example
20072 .endd
20073 This causes all non-local addresses to be sent to the single host
20074 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20075 they are tried in order
20076 (but you can use &%hosts_randomize%& to vary the order each time).
20077 Another way of configuring the same thing is this:
20078 .code
20079 smart_route:
20080   driver = manualroute
20081   transport = remote_smtp
20082   route_list = !+local_domains  smarthost.ref.example
20083 .endd
20084 There is no difference in behaviour between these two routers as they stand.
20085 However, they behave differently if &%no_more%& is added to them. In the first
20086 example, the router is skipped if the domain does not match the &%domains%&
20087 precondition; the following router is always tried. If the router runs, it
20088 always matches the domain and so can never decline. Therefore, &%no_more%&
20089 would have no effect. In the second case, the router is never skipped; it
20090 always runs. However, if it doesn't match the domain, it declines. In this case
20091 &%no_more%& would prevent subsequent routers from running.
20092
20093 .next
20094 .cindex "mail hub example"
20095 A &'mail hub'& is a host which receives mail for a number of domains via MX
20096 records in the DNS and delivers it via its own private routing mechanism. Often
20097 the final destinations are behind a firewall, with the mail hub being the one
20098 machine that can connect to machines both inside and outside the firewall. The
20099 &(manualroute)& router is usually used on a mail hub to route incoming messages
20100 to the correct hosts. For a small number of domains, the routing can be inline,
20101 using the &%route_list%& option, but for a larger number a file or database
20102 lookup is easier to manage.
20103
20104 If the domain names are in fact the names of the machines to which the mail is
20105 to be sent by the mail hub, the configuration can be quite simple. For
20106 example:
20107 .code
20108 hub_route:
20109   driver = manualroute
20110   transport = remote_smtp
20111   route_list = *.rhodes.tvs.example  $domain
20112 .endd
20113 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20114 whose names are the same as the mail domains. A similar approach can be taken
20115 if the host name can be obtained from the domain name by a string manipulation
20116 that the expansion facilities can handle. Otherwise, a lookup based on the
20117 domain can be used to find the host:
20118 .code
20119 through_firewall:
20120   driver = manualroute
20121   transport = remote_smtp
20122   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20123 .endd
20124 The result of the lookup must be the name or IP address of the host (or
20125 hosts) to which the address is to be routed. If the lookup fails, the route
20126 data is empty, causing the router to decline. The address then passes to the
20127 next router.
20128
20129 .next
20130 .cindex "batched SMTP output example"
20131 .cindex "SMTP" "batched outgoing; example"
20132 You can use &(manualroute)& to deliver messages to pipes or files in batched
20133 SMTP format for onward transportation by some other means. This is one way of
20134 storing mail for a dial-up host when it is not connected. The route list entry
20135 can be as simple as a single domain name in a configuration like this:
20136 .code
20137 save_in_file:
20138   driver = manualroute
20139   transport = batchsmtp_appendfile
20140   route_list = saved.domain.example
20141 .endd
20142 though often a pattern is used to pick up more than one domain. If there are
20143 several domains or groups of domains with different transport requirements,
20144 different transports can be listed in the routing information:
20145 .code
20146 save_in_file:
20147   driver = manualroute
20148   route_list = \
20149     *.saved.domain1.example  $domain  batch_appendfile; \
20150     *.saved.domain2.example  \
20151       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20152       batch_pipe
20153 .endd
20154 .vindex "&$domain$&"
20155 .vindex "&$host$&"
20156 The first of these just passes the domain in the &$host$& variable, which
20157 doesn't achieve much (since it is also in &$domain$&), but the second does a
20158 file lookup to find a value to pass, causing the router to decline to handle
20159 the address if the lookup fails.
20160
20161 .next
20162 .cindex "UUCP" "example of router for"
20163 Routing mail directly to UUCP software is a specific case of the use of
20164 &(manualroute)& in a gateway to another mail environment. This is an example of
20165 one way it can be done:
20166 .code
20167 # Transport
20168 uucp:
20169   driver = pipe
20170   user = nobody
20171   command = /usr/local/bin/uux -r - \
20172     ${substr_-5:$host}!rmail ${local_part}
20173   return_fail_output = true
20174
20175 # Router
20176 uucphost:
20177   transport = uucp
20178   driver = manualroute
20179   route_data = \
20180     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20181 .endd
20182 The file &_/usr/local/exim/uucphosts_& contains entries like
20183 .code
20184 darksite.ethereal.example:           darksite.UUCP
20185 .endd
20186 It can be set up more simply without adding and removing &".UUCP"& but this way
20187 makes clear the distinction between the domain name
20188 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20189 .endlist
20190 .ecindex IIDmanrou1
20191 .ecindex IIDmanrou2
20192
20193
20194
20195
20196
20197
20198
20199
20200 . ////////////////////////////////////////////////////////////////////////////
20201 . ////////////////////////////////////////////////////////////////////////////
20202
20203 .chapter "The queryprogram router" "CHAPdriverlast"
20204 .scindex IIDquerou1 "&(queryprogram)& router"
20205 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20206 .cindex "routing" "by external program"
20207 The &(queryprogram)& router routes an address by running an external command
20208 and acting on its output. This is an expensive way to route, and is intended
20209 mainly for use in lightly-loaded systems, or for performing experiments.
20210 However, if it is possible to use the precondition options (&%domains%&,
20211 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20212 be used in special cases, even on a busy host. There are the following private
20213 options:
20214 .cindex "options" "&(queryprogram)& router"
20215
20216 .option command queryprogram string&!! unset
20217 This option must be set. It specifies the command that is to be run. The
20218 command is split up into a command name and arguments, and then each is
20219 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20220 &<<CHAPpipetransport>>&).
20221
20222
20223 .option command_group queryprogram string unset
20224 .cindex "gid (group id)" "in &(queryprogram)& router"
20225 This option specifies a gid to be set when running the command while routing an
20226 address for deliver. It must be set if &%command_user%& specifies a numerical
20227 uid. If it begins with a digit, it is interpreted as the numerical value of the
20228 gid. Otherwise it is looked up using &[getgrnam()]&.
20229
20230
20231 .option command_user queryprogram string unset
20232 .cindex "uid (user id)" "for &(queryprogram)&"
20233 This option must be set. It specifies the uid which is set when running the
20234 command while routing an address for delivery. If the value begins with a digit,
20235 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20236 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20237 not set, a value for the gid also.
20238
20239 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20240 root, which it does during a normal delivery in a conventional configuration.
20241 However, when an address is being verified during message reception, Exim is
20242 usually running as the Exim user, not as root. If the &(queryprogram)& router
20243 is called from a non-root process, Exim cannot change uid or gid before running
20244 the command. In this circumstance the command runs under the current uid and
20245 gid.
20246
20247
20248 .option current_directory queryprogram string /
20249 This option specifies an absolute path which is made the current directory
20250 before running the command.
20251
20252
20253 .option timeout queryprogram time 1h
20254 If the command does not complete within the timeout period, its process group
20255 is killed and the message is frozen. A value of zero time specifies no
20256 timeout.
20257
20258
20259 The standard output of the command is connected to a pipe, which is read when
20260 the command terminates. It should consist of a single line of output,
20261 containing up to five fields, separated by white space. The maximum length of
20262 the line is 1023 characters. Longer lines are silently truncated. The first
20263 field is one of the following words (case-insensitive):
20264
20265 .ilist
20266 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20267 below).
20268 .next
20269 &'Decline'&: the router declines; pass the address to the next router, unless
20270 &%no_more%& is set.
20271 .next
20272 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20273 subsequent text on the line is an error message. If the router is run as part
20274 of address verification during an incoming SMTP message, the message is
20275 included in the SMTP response.
20276 .next
20277 &'Defer'&: routing could not be completed at this time; try again later. Any
20278 subsequent text on the line is an error message which is logged. It is not
20279 included in any SMTP response.
20280 .next
20281 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20282 .next
20283 &'Pass'&: pass the address to the next router (or the router specified by
20284 &%pass_router%&), overriding &%no_more%&.
20285 .next
20286 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20287 new addresses, which are routed independently, starting with the first router,
20288 or the router specified by &%redirect_router%&, if set.
20289 .endlist
20290
20291 When the first word is &'accept'&, the remainder of the line consists of a
20292 number of keyed data values, as follows (split into two lines here, to fit on
20293 the page):
20294 .code
20295 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20296 LOOKUP=byname|bydns DATA=<text>
20297 .endd
20298 The data items can be given in any order, and all are optional. If no transport
20299 is included, the transport specified by the generic &%transport%& option is
20300 used. The list of hosts and the lookup type are needed only if the transport is
20301 an &(smtp)& transport that does not itself supply a list of hosts.
20302
20303 The format of the list of hosts is the same as for the &(manualroute)& router.
20304 As well as host names and IP addresses with optional port numbers, as described
20305 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20306 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20307 (see section &<<SECThostshowused>>&).
20308
20309 If the lookup type is not specified, Exim behaves as follows when trying to
20310 find an IP address for each host: First, a DNS lookup is done. If this yields
20311 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20312 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20313 result of the lookup is the result of that call.
20314
20315 .vindex "&$address_data$&"
20316 If the DATA field is set, its value is placed in the &$address_data$&
20317 variable. For example, this return line
20318 .code
20319 accept hosts=x1.y.example:x2.y.example data="rule1"
20320 .endd
20321 routes the address to the default transport, passing a list of two hosts. When
20322 the transport runs, the string &"rule1"& is in &$address_data$&.
20323 .ecindex IIDquerou1
20324 .ecindex IIDquerou2
20325
20326
20327
20328
20329 . ////////////////////////////////////////////////////////////////////////////
20330 . ////////////////////////////////////////////////////////////////////////////
20331
20332 .chapter "The redirect router" "CHAPredirect"
20333 .scindex IIDredrou1 "&(redirect)& router"
20334 .scindex IIDredrou2 "routers" "&(redirect)&"
20335 .cindex "alias file" "in a &(redirect)& router"
20336 .cindex "address redirection" "&(redirect)& router"
20337 The &(redirect)& router handles several kinds of address redirection. Its most
20338 common uses are for resolving local part aliases from a central alias file
20339 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20340 files, but it has many other potential uses. The incoming address can be
20341 redirected in several different ways:
20342
20343 .ilist
20344 It can be replaced by one or more new addresses which are themselves routed
20345 independently.
20346 .next
20347 It can be routed to be delivered to a given file or directory.
20348 .next
20349 It can be routed to be delivered to a specified pipe command.
20350 .next
20351 It can cause an automatic reply to be generated.
20352 .next
20353 It can be forced to fail, optionally with a custom error message.
20354 .next
20355 It can be temporarily deferred, optionally with a custom message.
20356 .next
20357 It can be discarded.
20358 .endlist
20359
20360 The generic &%transport%& option must not be set for &(redirect)& routers.
20361 However, there are some private options which define transports for delivery to
20362 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20363 &%pipe_transport%& and &%reply_transport%& descriptions below.
20364
20365 If success DSNs have been requested
20366 .cindex "DSN" "success"
20367 .cindex "Delivery Status Notification" "success"
20368 redirection triggers one and the DSN options are not passed any further.
20369
20370
20371
20372 .section "Redirection data" "SECID124"
20373 The router operates by interpreting a text string which it obtains either by
20374 expanding the contents of the &%data%& option, or by reading the entire
20375 contents of a file whose name is given in the &%file%& option. These two
20376 options are mutually exclusive. The first is commonly used for handling system
20377 aliases, in a configuration like this:
20378 .code
20379 system_aliases:
20380   driver = redirect
20381   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20382 .endd
20383 If the lookup fails, the expanded string in this example is empty. When the
20384 expansion of &%data%& results in an empty string, the router declines. A forced
20385 expansion failure also causes the router to decline; other expansion failures
20386 cause delivery to be deferred.
20387
20388 A configuration using &%file%& is commonly used for handling users'
20389 &_.forward_& files, like this:
20390 .code
20391 userforward:
20392   driver = redirect
20393   check_local_user
20394   file = $home/.forward
20395   no_verify
20396 .endd
20397 If the file does not exist, or causes no action to be taken (for example, it is
20398 empty or consists only of comments), the router declines. &*Warning*&: This
20399 is not the case when the file contains syntactically valid items that happen to
20400 yield empty addresses, for example, items containing only RFC 2822 address
20401 comments.
20402
20403
20404
20405 .section "Forward files and address verification" "SECID125"
20406 .cindex "address redirection" "while verifying"
20407 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20408 &_.forward_& files, as in the example above. There are two reasons for this:
20409
20410 .ilist
20411 When Exim is receiving an incoming SMTP message from a remote host, it is
20412 running under the Exim uid, not as root. Exim is unable to change uid to read
20413 the file as the user, and it may not be able to read it as the Exim user. So in
20414 practice the router may not be able to operate.
20415 .next
20416 However, even when the router can operate, the existence of a &_.forward_& file
20417 is unimportant when verifying an address. What should be checked is whether the
20418 local part is a valid user name or not. Cutting out the redirection processing
20419 saves some resources.
20420 .endlist
20421
20422
20423
20424
20425
20426
20427 .section "Interpreting redirection data" "SECID126"
20428 .cindex "Sieve filter" "specifying in redirection data"
20429 .cindex "filter" "specifying in redirection data"
20430 The contents of the data string, whether obtained from &%data%& or &%file%&,
20431 can be interpreted in two different ways:
20432
20433 .ilist
20434 If the &%allow_filter%& option is set true, and the data begins with the text
20435 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20436 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20437 respectively. Details of the syntax and semantics of filter files are described
20438 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20439 document is intended for use by end users.
20440 .next
20441 Otherwise, the data must be a comma-separated list of redirection items, as
20442 described in the next section.
20443 .endlist
20444
20445 When a message is redirected to a file (a &"mail folder"&), the filename given
20446 in a non-filter redirection list must always be an absolute path. A filter may
20447 generate a relative path &-- how this is handled depends on the transport's
20448 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20449 for the &(appendfile)& transport.
20450
20451
20452
20453 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20454 .cindex "address redirection" "non-filter list items"
20455 When the redirection data is not an Exim or Sieve filter, for example, if it
20456 comes from a conventional alias or forward file, it consists of a list of
20457 addresses, filenames, pipe commands, or certain special items (see section
20458 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20459 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20460 depending on their default values. The items in the list are separated by
20461 commas or newlines.
20462 If a comma is required in an item, the entire item must be enclosed in double
20463 quotes.
20464
20465 Lines starting with a # character are comments, and are ignored, and # may
20466 also appear following a comma, in which case everything between the # and the
20467 next newline character is ignored.
20468
20469 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20470 double quotes are retained because some forms of mail address require their use
20471 (but never to enclose the entire address). In the following description,
20472 &"item"& refers to what remains after any surrounding double quotes have been
20473 removed.
20474
20475 .vindex "&$local_part$&"
20476 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20477 and the expansion contains a reference to &$local_part$&, you should make use
20478 of the &%quote_local_part%& expansion operator, in case the local part contains
20479 special characters. For example, to redirect all mail for the domain
20480 &'obsolete.example'&, retaining the existing local part, you could use this
20481 setting:
20482 .code
20483 data = ${quote_local_part:$local_part}@newdomain.example
20484 .endd
20485
20486
20487 .section "Redirecting to a local mailbox" "SECTredlocmai"
20488 .cindex "routing" "loops in"
20489 .cindex "loop" "while routing, avoidance of"
20490 .cindex "address redirection" "to local mailbox"
20491 A redirection item may safely be the same as the address currently under
20492 consideration. This does not cause a routing loop, because a router is
20493 automatically skipped if any ancestor of the address that is being processed
20494 is the same as the current address and was processed by the current router.
20495 Such an address is therefore passed to the following routers, so it is handled
20496 as if there were no redirection. When making this loop-avoidance test, the
20497 complete local part, including any prefix or suffix, is used.
20498
20499 .cindex "address redirection" "local part without domain"
20500 Specifying the same local part without a domain is a common usage in personal
20501 filter files when the user wants to have messages delivered to the local
20502 mailbox and also forwarded elsewhere. For example, the user whose login is
20503 &'cleo'& might have a &_.forward_& file containing this:
20504 .code
20505 cleo, cleopatra@egypt.example
20506 .endd
20507 .cindex "backslash in alias file"
20508 .cindex "alias file" "backslash in"
20509 For compatibility with other MTAs, such unqualified local parts may be
20510 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20511 it does make a difference if more than one domain is being handled
20512 synonymously.
20513
20514 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20515 2822 address that does not include a domain, the item is qualified using the
20516 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20517 addresses are qualified using the value in &%qualify_recipient%&, but you can
20518 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20519
20520 Care must be taken if there are alias names for local users.
20521 Consider an MTA handling a single local domain where the system alias file
20522 contains:
20523 .code
20524 Sam.Reman: spqr
20525 .endd
20526 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20527 messages in the local mailbox, and also forward copies elsewhere. He creates
20528 this forward file:
20529 .code
20530 Sam.Reman, spqr@reme.elsewhere.example
20531 .endd
20532 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20533 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20534 second time round, because it has previously routed it,
20535 and the following routers presumably cannot handle the alias. The forward file
20536 should really contain
20537 .code
20538 spqr, spqr@reme.elsewhere.example
20539 .endd
20540 but because this is such a common error, the &%check_ancestor%& option (see
20541 below) exists to provide a way to get round it. This is normally set on a
20542 &(redirect)& router that is handling users' &_.forward_& files.
20543
20544
20545
20546 .section "Special items in redirection lists" "SECTspecitredli"
20547 In addition to addresses, the following types of item may appear in redirection
20548 lists (that is, in non-filter redirection data):
20549
20550 .ilist
20551 .cindex "pipe" "in redirection list"
20552 .cindex "address redirection" "to pipe"
20553 An item is treated as a pipe command if it begins with &"|"& and does not parse
20554 as a valid RFC 2822 address that includes a domain. A transport for running the
20555 command must be specified by the &%pipe_transport%& option.
20556 Normally, either the router or the transport specifies a user and a group under
20557 which to run the delivery. The default is to use the Exim user and group.
20558
20559 Single or double quotes can be used for enclosing the individual arguments of
20560 the pipe command; no interpretation of escapes is done for single quotes. If
20561 the command contains a comma character, it is necessary to put the whole item
20562 in double quotes, for example:
20563 .code
20564 "|/some/command ready,steady,go"
20565 .endd
20566 since items in redirection lists are terminated by commas. Do not, however,
20567 quote just the command. An item such as
20568 .code
20569 |"/some/command ready,steady,go"
20570 .endd
20571 is interpreted as a pipe with a rather strange command name, and no arguments.
20572
20573 Note that the above example assumes that the text comes from a lookup source
20574 of some sort, so that the quotes are part of the data.  If composing a
20575 redirect router with a &%data%& option directly specifying this command, the
20576 quotes will be used by the configuration parser to define the extent of one
20577 string, but will not be passed down into the redirect router itself.  There
20578 are two main approaches to get around this: escape quotes to be part of the
20579 data itself, or avoid using this mechanism and instead create a custom
20580 transport with the &%command%& option set and reference that transport from
20581 an &%accept%& router.
20582
20583 .next
20584 .cindex "file" "in redirection list"
20585 .cindex "address redirection" "to file"
20586 An item is interpreted as a path name if it begins with &"/"& and does not
20587 parse as a valid RFC 2822 address that includes a domain. For example,
20588 .code
20589 /home/world/minbari
20590 .endd
20591 is treated as a filename, but
20592 .code
20593 /s=molari/o=babylon/@x400gate.way
20594 .endd
20595 is treated as an address. For a filename, a transport must be specified using
20596 the &%file_transport%& option. However, if the generated path name ends with a
20597 forward slash character, it is interpreted as a directory name rather than a
20598 filename, and &%directory_transport%& is used instead.
20599
20600 Normally, either the router or the transport specifies a user and a group under
20601 which to run the delivery. The default is to use the Exim user and group.
20602
20603 .cindex "&_/dev/null_&"
20604 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20605 bypassed at a high level, and the log entry shows &"**bypassed**"&
20606 instead of a transport name. In this case the user and group are not used.
20607
20608 .next
20609 .cindex "included address list"
20610 .cindex "address redirection" "included external list"
20611 If an item is of the form
20612 .code
20613 :include:<path name>
20614 .endd
20615 a list of further items is taken from the given file and included at that
20616 point. &*Note*&: Such a file can not be a filter file; it is just an
20617 out-of-line addition to the list. The items in the included list are separated
20618 by commas or newlines and are not subject to expansion. If this is the first
20619 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20620 the alias name. This example is incorrect:
20621 .code
20622 list1    :include:/opt/lists/list1
20623 .endd
20624 It must be given as
20625 .code
20626 list1:   :include:/opt/lists/list1
20627 .endd
20628 .next
20629 .cindex "address redirection" "to black hole"
20630 .cindex "delivery" "discard"
20631 .cindex "delivery" "blackhole"
20632 .cindex "black hole"
20633 .cindex "abandoning mail"
20634 Sometimes you want to throw away mail to a particular local part.  Making the
20635 &%data%& option expand to an empty string does not work, because that causes
20636 the router to decline. Instead, the alias item
20637 .code
20638 :blackhole:
20639 .endd
20640 can be used. It does what its name implies. No delivery is
20641 done, and no error message is generated. This has the same effect as specifying
20642 &_/dev/null_& as a destination, but it can be independently disabled.
20643
20644 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20645 delivery is done for the original local part, even if other redirection items
20646 are present. If you are generating a multi-item list (for example, by reading a
20647 database) and need the ability to provide a no-op item, you must use
20648 &_/dev/null_&.
20649
20650 .next
20651 .cindex "delivery" "forcing failure"
20652 .cindex "delivery" "forcing deferral"
20653 .cindex "failing delivery" "forcing"
20654 .cindex "deferred delivery, forcing"
20655 .cindex "customizing" "failure message"
20656 An attempt to deliver a particular address can be deferred or forced to fail by
20657 redirection items of the form
20658 .code
20659 :defer:
20660 :fail:
20661 .endd
20662 respectively. When a redirection list contains such an item, it applies
20663 to the entire redirection; any other items in the list are ignored. Any
20664 text following &':fail:'& or &':defer:'& is placed in the error text
20665 associated with the failure. For example, an alias file might contain:
20666 .code
20667 X.Employee:  :fail: Gone away, no forwarding address
20668 .endd
20669 In the case of an address that is being verified from an ACL or as the subject
20670 of a
20671 .cindex "VRFY" "error text, display of"
20672 VRFY command, the text is included in the SMTP error response by
20673 default.
20674 .cindex "EXPN" "error text, display of"
20675 The text is not included in the response to an EXPN command. In non-SMTP cases
20676 the text is included in the error message that Exim generates.
20677
20678 .cindex "SMTP" "error codes"
20679 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20680 &':fail:'&. However, if the message starts with three digits followed by a
20681 space, optionally followed by an extended code of the form &'n.n.n'&, also
20682 followed by a space, and the very first digit is the same as the default error
20683 code, the code from the message is used instead. If the very first digit is
20684 incorrect, a panic error is logged, and the default code is used. You can
20685 suppress the use of the supplied code in a redirect router by setting the
20686 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20687 ignored.
20688
20689 .vindex "&$acl_verify_message$&"
20690 In an ACL, an explicitly provided message overrides the default, but the
20691 default message is available in the variable &$acl_verify_message$& and can
20692 therefore be included in a custom message if this is desired.
20693
20694 Normally the error text is the rest of the redirection list &-- a comma does
20695 not terminate it &-- but a newline does act as a terminator. Newlines are not
20696 normally present in alias expansions. In &(lsearch)& lookups they are removed
20697 as part of the continuation process, but they may exist in other kinds of
20698 lookup and in &':include:'& files.
20699
20700 During routing for message delivery (as opposed to verification), a redirection
20701 containing &':fail:'& causes an immediate failure of the incoming address,
20702 whereas &':defer:'& causes the message to remain in the queue so that a
20703 subsequent delivery attempt can happen at a later time. If an address is
20704 deferred for too long, it will ultimately fail, because the normal retry
20705 rules still apply.
20706
20707 .next
20708 .cindex "alias file" "exception to default"
20709 Sometimes it is useful to use a single-key search type with a default (see
20710 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20711 for exceptions to the default. These can be handled by aliasing them to
20712 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20713 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20714 results in an empty redirection list has the same effect.
20715 .endlist
20716
20717
20718 .section "Duplicate addresses" "SECTdupaddr"
20719 .cindex "duplicate addresses"
20720 .cindex "address duplicate, discarding"
20721 .cindex "pipe" "duplicated"
20722 Exim removes duplicate addresses from the list to which it is delivering, so as
20723 to deliver just one copy to each address. This does not apply to deliveries
20724 routed to pipes by different immediate parent addresses, but an indirect
20725 aliasing scheme of the type
20726 .code
20727 pipe:       |/some/command $local_part
20728 localpart1: pipe
20729 localpart2: pipe
20730 .endd
20731 does not work with a message that is addressed to both local parts, because
20732 when the second is aliased to the intermediate local part &"pipe"& it gets
20733 discarded as being the same as a previously handled address. However, a scheme
20734 such as
20735 .code
20736 localpart1: |/some/command $local_part
20737 localpart2: |/some/command $local_part
20738 .endd
20739 does result in two different pipe deliveries, because the immediate parents of
20740 the pipes are distinct.
20741
20742
20743
20744 .section "Repeated redirection expansion" "SECID128"
20745 .cindex "repeated redirection expansion"
20746 .cindex "address redirection" "repeated for each delivery attempt"
20747 When a message cannot be delivered to all of its recipients immediately,
20748 leading to two or more delivery attempts, redirection expansion is carried out
20749 afresh each time for those addresses whose children were not all previously
20750 delivered. If redirection is being used as a mailing list, this can lead to new
20751 members of the list receiving copies of old messages. The &%one_time%& option
20752 can be used to avoid this.
20753
20754
20755 .section "Errors in redirection lists" "SECID129"
20756 .cindex "address redirection" "errors"
20757 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20758 error is skipped, and an entry is written to the main log. This may be useful
20759 for mailing lists that are automatically managed. Otherwise, if an error is
20760 detected while generating the list of new addresses, the original address is
20761 deferred. See also &%syntax_errors_to%&.
20762
20763
20764
20765 .section "Private options for the redirect router" "SECID130"
20766
20767 .cindex "options" "&(redirect)& router"
20768 The private options for the &(redirect)& router are as follows:
20769
20770
20771 .option allow_defer redirect boolean false
20772 Setting this option allows the use of &':defer:'& in non-filter redirection
20773 data, or the &%defer%& command in an Exim filter file.
20774
20775
20776 .option allow_fail redirect boolean false
20777 .cindex "failing delivery" "from filter"
20778 If this option is true, the &':fail:'& item can be used in a redirection list,
20779 and the &%fail%& command may be used in an Exim filter file.
20780
20781
20782 .option allow_filter redirect boolean false
20783 .cindex "filter" "enabling use of"
20784 .cindex "Sieve filter" "enabling use of"
20785 Setting this option allows Exim to interpret redirection data that starts with
20786 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20787 are some features of Exim filter files that some administrators may wish to
20788 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20789
20790 It is also possible to lock out Exim filters or Sieve filters while allowing
20791 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20792
20793
20794 The filter is run using the uid and gid set by the generic &%user%& and
20795 &%group%& options. These take their defaults from the password data if
20796 &%check_local_user%& is set, so in the normal case of users' personal filter
20797 files, the filter is run as the relevant user. When &%allow_filter%& is set
20798 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20799
20800
20801
20802 .option allow_freeze redirect boolean false
20803 .cindex "freezing messages" "allowing in filter"
20804 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20805 This command is more normally encountered in system filters, and is disabled by
20806 default for redirection filters because it isn't something you usually want to
20807 let ordinary users do.
20808
20809
20810
20811 .option check_ancestor redirect boolean false
20812 This option is concerned with handling generated addresses that are the same
20813 as some address in the list of redirection ancestors of the current address.
20814 Although it is turned off by default in the code, it is set in the default
20815 configuration file for handling users' &_.forward_& files. It is recommended
20816 for this use of the &(redirect)& router.
20817
20818 When &%check_ancestor%& is set, if a generated address (including the domain)
20819 is the same as any ancestor of the current address, it is replaced by a copy of
20820 the current address. This helps in the case where local part A is aliased to B,
20821 and B has a &_.forward_& file pointing back to A. For example, within a single
20822 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20823 &_&~jb/.forward_& contains:
20824 .code
20825 \Joe.Bloggs, <other item(s)>
20826 .endd
20827 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20828 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20829 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20830 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20831 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20832 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20833 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20834 original address. See also the &%repeat_use%& option below.
20835
20836
20837 .option check_group redirect boolean "see below"
20838 When the &%file%& option is used, the group owner of the file is checked only
20839 when this option is set. The permitted groups are those listed in the
20840 &%owngroups%& option, together with the user's default group if
20841 &%check_local_user%& is set. If the file has the wrong group, routing is
20842 deferred. The default setting for this option is true if &%check_local_user%&
20843 is set and the &%modemask%& option permits the group write bit, or if the
20844 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20845
20846
20847
20848 .option check_owner redirect boolean "see below"
20849 When the &%file%& option is used, the owner of the file is checked only when
20850 this option is set. If &%check_local_user%& is set, the local user is
20851 permitted; otherwise the owner must be one of those listed in the &%owners%&
20852 option. The default value for this option is true if &%check_local_user%& or
20853 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20854
20855
20856 .option data redirect string&!! unset
20857 This option is mutually exclusive with &%file%&. One or other of them must be
20858 set, but not both. The contents of &%data%& are expanded, and then used as the
20859 list of forwarding items, or as a set of filtering instructions. If the
20860 expansion is forced to fail, or the result is an empty string or a string that
20861 has no effect (consists entirely of comments), the router declines.
20862
20863 When filtering instructions are used, the string must begin with &"#Exim
20864 filter"&, and all comments in the string, including this initial one, must be
20865 terminated with newline characters. For example:
20866 .code
20867 data = #Exim filter\n\
20868        if $h_to: contains Exim then save $home/mail/exim endif
20869 .endd
20870 If you are reading the data from a database where newlines cannot be included,
20871 you can use the &${sg}$& expansion item to turn the escape string of your
20872 choice into a newline.
20873
20874
20875 .option directory_transport redirect string&!! unset
20876 A &(redirect)& router sets up a direct delivery to a directory when a path name
20877 ending with a slash is specified as a new &"address"&. The transport used is
20878 specified by this option, which, after expansion, must be the name of a
20879 configured transport. This should normally be an &(appendfile)& transport.
20880
20881
20882 .option file redirect string&!! unset
20883 This option specifies the name of a file that contains the redirection data. It
20884 is mutually exclusive with the &%data%& option. The string is expanded before
20885 use; if the expansion is forced to fail, the router declines. Other expansion
20886 failures cause delivery to be deferred. The result of a successful expansion
20887 must be an absolute path. The entire file is read and used as the redirection
20888 data. If the data is an empty string or a string that has no effect (consists
20889 entirely of comments), the router declines.
20890
20891 .cindex "NFS" "checking for file existence"
20892 If the attempt to open the file fails with a &"does not exist"& error, Exim
20893 runs a check on the containing directory,
20894 unless &%ignore_enotdir%& is true (see below).
20895 If the directory does not appear to exist, delivery is deferred. This can
20896 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20897 is a mount problem. If the containing directory does exist, but the file does
20898 not, the router declines.
20899
20900
20901 .option file_transport redirect string&!! unset
20902 .vindex "&$address_file$&"
20903 A &(redirect)& router sets up a direct delivery to a file when a path name not
20904 ending in a slash is specified as a new &"address"&. The transport used is
20905 specified by this option, which, after expansion, must be the name of a
20906 configured transport. This should normally be an &(appendfile)& transport. When
20907 it is running, the filename is in &$address_file$&.
20908
20909
20910 .option filter_prepend_home redirect boolean true
20911 When this option is true, if a &(save)& command in an Exim filter specifies a
20912 relative path, and &$home$& is defined, it is automatically prepended to the
20913 relative path. If this option is set false, this action does not happen. The
20914 relative path is then passed to the transport unmodified.
20915
20916
20917 .option forbid_blackhole redirect boolean false
20918 .cindex "restricting access to features"
20919 .cindex "filter" "locking out certain features"
20920 If this option is true, the &':blackhole:'& item may not appear in a
20921 redirection list.
20922
20923
20924 .option forbid_exim_filter redirect boolean false
20925 .cindex "restricting access to features"
20926 .cindex "filter" "locking out certain features"
20927 If this option is set true, only Sieve filters are permitted when
20928 &%allow_filter%& is true.
20929
20930
20931
20932
20933 .option forbid_file redirect boolean false
20934 .cindex "restricting access to features"
20935 .cindex "delivery" "to file; forbidding"
20936 .cindex "filter" "locking out certain features"
20937 .cindex "Sieve filter" "forbidding delivery to a file"
20938 .cindex "Sieve filter" "&""keep""& facility; disabling"
20939 If this option is true, this router may not generate a new address that
20940 specifies delivery to a local file or directory, either from a filter or from a
20941 conventional forward file. This option is forced to be true if &%one_time%& is
20942 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20943 locks out the Sieve's &"keep"& facility.
20944
20945
20946 .option forbid_filter_dlfunc redirect boolean false
20947 .cindex "restricting access to features"
20948 .cindex "filter" "locking out certain features"
20949 If this option is true, string expansions in Exim filters are not allowed to
20950 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20951 functions.
20952
20953 .option forbid_filter_existstest redirect boolean false
20954 .cindex "restricting access to features"
20955 .cindex "filter" "locking out certain features"
20956 .cindex "expansion" "statting a file"
20957 If this option is true, string expansions in Exim filters are not allowed to
20958 make use of the &%exists%& condition or the &%stat%& expansion item.
20959
20960 .option forbid_filter_logwrite redirect boolean false
20961 .cindex "restricting access to features"
20962 .cindex "filter" "locking out certain features"
20963 If this option is true, use of the logging facility in Exim filters is not
20964 permitted. Logging is in any case available only if the filter is being run
20965 under some unprivileged uid (which is normally the case for ordinary users'
20966 &_.forward_& files).
20967
20968
20969 .option forbid_filter_lookup redirect boolean false
20970 .cindex "restricting access to features"
20971 .cindex "filter" "locking out certain features"
20972 If this option is true, string expansions in Exim filter files are not allowed
20973 to make use of &%lookup%& items.
20974
20975
20976 .option forbid_filter_perl redirect boolean false
20977 .cindex "restricting access to features"
20978 .cindex "filter" "locking out certain features"
20979 This option has an effect only if Exim is built with embedded Perl support. If
20980 it is true, string expansions in Exim filter files are not allowed to make use
20981 of the embedded Perl support.
20982
20983
20984 .option forbid_filter_readfile redirect boolean false
20985 .cindex "restricting access to features"
20986 .cindex "filter" "locking out certain features"
20987 If this option is true, string expansions in Exim filter files are not allowed
20988 to make use of &%readfile%& items.
20989
20990
20991 .option forbid_filter_readsocket redirect boolean false
20992 .cindex "restricting access to features"
20993 .cindex "filter" "locking out certain features"
20994 If this option is true, string expansions in Exim filter files are not allowed
20995 to make use of &%readsocket%& items.
20996
20997
20998 .option forbid_filter_reply redirect boolean false
20999 .cindex "restricting access to features"
21000 .cindex "filter" "locking out certain features"
21001 If this option is true, this router may not generate an automatic reply
21002 message. Automatic replies can be generated only from Exim or Sieve filter
21003 files, not from traditional forward files. This option is forced to be true if
21004 &%one_time%& is set.
21005
21006
21007 .option forbid_filter_run redirect boolean false
21008 .cindex "restricting access to features"
21009 .cindex "filter" "locking out certain features"
21010 If this option is true, string expansions in Exim filter files are not allowed
21011 to make use of &%run%& items.
21012
21013
21014 .option forbid_include redirect boolean false
21015 .cindex "restricting access to features"
21016 .cindex "filter" "locking out certain features"
21017 If this option is true, items of the form
21018 .code
21019 :include:<path name>
21020 .endd
21021 are not permitted in non-filter redirection lists.
21022
21023
21024 .option forbid_pipe redirect boolean false
21025 .cindex "restricting access to features"
21026 .cindex "filter" "locking out certain features"
21027 .cindex "delivery" "to pipe; forbidding"
21028 If this option is true, this router may not generate a new address which
21029 specifies delivery to a pipe, either from an Exim filter or from a conventional
21030 forward file. This option is forced to be true if &%one_time%& is set.
21031
21032
21033 .option forbid_sieve_filter redirect boolean false
21034 .cindex "restricting access to features"
21035 .cindex "filter" "locking out certain features"
21036 If this option is set true, only Exim filters are permitted when
21037 &%allow_filter%& is true.
21038
21039
21040 .cindex "SMTP" "error codes"
21041 .option forbid_smtp_code redirect boolean false
21042 If this option is set true, any SMTP error codes that are present at the start
21043 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21044 the default codes (451 and 550, respectively) are always used.
21045
21046
21047
21048
21049 .option hide_child_in_errmsg redirect boolean false
21050 .cindex "bounce message" "redirection details; suppressing"
21051 If this option is true, it prevents Exim from quoting a child address if it
21052 generates a bounce or delay message for it. Instead it says &"an address
21053 generated from <&'the top level address'&>"&. Of course, this applies only to
21054 bounces generated locally. If a message is forwarded to another host, &'its'&
21055 bounce may well quote the generated address.
21056
21057
21058 .option ignore_eacces redirect boolean false
21059 .cindex "EACCES"
21060 If this option is set and an attempt to open a redirection file yields the
21061 EACCES error (permission denied), the &(redirect)& router behaves as if the
21062 file did not exist.
21063
21064
21065 .option ignore_enotdir redirect boolean false
21066 .cindex "ENOTDIR"
21067 If this option is set and an attempt to open a redirection file yields the
21068 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21069 router behaves as if the file did not exist.
21070
21071 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21072 router that has the &%file%& option set discovers that the file does not exist
21073 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21074 against unmounted NFS directories. If the parent can not be statted, delivery
21075 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21076 is set, because that option tells Exim to ignore &"something on the path is not
21077 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21078 that some operating systems give ENOENT where others give ENOTDIR.
21079
21080
21081
21082 .option include_directory redirect string unset
21083 If this option is set, the path names of any &':include:'& items in a
21084 redirection list must start with this directory.
21085
21086
21087 .option modemask redirect "octal integer" 022
21088 This specifies mode bits which must not be set for a file specified by the
21089 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21090
21091
21092 .option one_time redirect boolean false
21093 .cindex "one-time aliasing/forwarding expansion"
21094 .cindex "alias file" "one-time expansion"
21095 .cindex "forward file" "one-time expansion"
21096 .cindex "mailing lists" "one-time expansion"
21097 .cindex "address redirection" "one-time expansion"
21098 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21099 files each time it tries to deliver a message causes a problem when one or more
21100 of the generated addresses fails be delivered at the first attempt. The problem
21101 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21102 but of what happens when the redirection list changes during the time that the
21103 message is on Exim's queue. This is particularly true in the case of mailing
21104 lists, where new subscribers might receive copies of messages that were posted
21105 before they subscribed.
21106
21107 If &%one_time%& is set and any addresses generated by the router fail to
21108 deliver at the first attempt, the failing addresses are added to the message as
21109 &"top level"& addresses, and the parent address that generated them is marked
21110 &"delivered"&. Thus, redirection does not happen again at the next delivery
21111 attempt.
21112
21113 &*Warning 1*&: Any header line addition or removal that is specified by this
21114 router would be lost if delivery did not succeed at the first attempt. For this
21115 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21116 permitted when &%one_time%& is set.
21117
21118 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21119 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21120 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21121
21122 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21123 &%one_time%&.
21124
21125 The original top-level address is remembered with each of the generated
21126 addresses, and is output in any log messages. However, any intermediate parent
21127 addresses are not recorded. This makes a difference to the log only if
21128 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21129 typically be used for mailing lists, where there is normally just one level of
21130 expansion.
21131
21132
21133 .option owners redirect "string list" unset
21134 .cindex "ownership" "alias file"
21135 .cindex "ownership" "forward file"
21136 .cindex "alias file" "ownership"
21137 .cindex "forward file" "ownership"
21138 This specifies a list of permitted owners for the file specified by &%file%&.
21139 This list is in addition to the local user when &%check_local_user%& is set.
21140 See &%check_owner%& above.
21141
21142
21143 .option owngroups redirect "string list" unset
21144 This specifies a list of permitted groups for the file specified by &%file%&.
21145 The list is in addition to the local user's primary group when
21146 &%check_local_user%& is set. See &%check_group%& above.
21147
21148
21149 .option pipe_transport redirect string&!! unset
21150 .vindex "&$address_pipe$&"
21151 A &(redirect)& router sets up a direct delivery to a pipe when a string
21152 starting with a vertical bar character is specified as a new &"address"&. The
21153 transport used is specified by this option, which, after expansion, must be the
21154 name of a configured transport. This should normally be a &(pipe)& transport.
21155 When the transport is run, the pipe command is in &$address_pipe$&.
21156
21157
21158 .option qualify_domain redirect string&!! unset
21159 .vindex "&$qualify_recipient$&"
21160 If this option is set, and an unqualified address (one without a domain) is
21161 generated, and that address would normally be qualified by the global setting
21162 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21163 expanding this string. If the expansion fails, the router declines. If you want
21164 to revert to the default, you can have the expansion generate
21165 &$qualify_recipient$&.
21166
21167 This option applies to all unqualified addresses generated by Exim filters,
21168 but for traditional &_.forward_& files, it applies only to addresses that are
21169 not preceded by a backslash. Sieve filters cannot generate unqualified
21170 addresses.
21171
21172 .option qualify_preserve_domain redirect boolean false
21173 .cindex "domain" "in redirection; preserving"
21174 .cindex "preserving domain in redirection"
21175 .cindex "address redirection" "domain; preserving"
21176 If this option is set, the router's local &%qualify_domain%& option must not be
21177 set (a configuration error occurs if it is). If an unqualified address (one
21178 without a domain) is generated, it is qualified with the domain of the parent
21179 address (the immediately preceding ancestor) instead of the global
21180 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21181 this applies whether or not the address is preceded by a backslash.
21182
21183
21184 .option repeat_use redirect boolean true
21185 If this option is set false, the router is skipped for a child address that has
21186 any ancestor that was routed by this router. This test happens before any of
21187 the other preconditions are tested. Exim's default anti-looping rules skip
21188 only when the ancestor is the same as the current address. See also
21189 &%check_ancestor%& above and the generic &%redirect_router%& option.
21190
21191
21192 .option reply_transport redirect string&!! unset
21193 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21194 &%vacation%& command is used in a filter file. The transport used is specified
21195 by this option, which, after expansion, must be the name of a configured
21196 transport. This should normally be an &(autoreply)& transport. Other transports
21197 are unlikely to do anything sensible or useful.
21198
21199
21200 .option rewrite redirect boolean true
21201 .cindex "address redirection" "disabling rewriting"
21202 If this option is set false, addresses generated by the router are not
21203 subject to address rewriting. Otherwise, they are treated like new addresses
21204 and are rewritten according to the global rewriting rules.
21205
21206
21207 .option sieve_subaddress redirect string&!! unset
21208 The value of this option is passed to a Sieve filter to specify the
21209 :subaddress part of an address.
21210
21211 .option sieve_useraddress redirect string&!! unset
21212 The value of this option is passed to a Sieve filter to specify the :user part
21213 of an address. However, if it is unset, the entire original local part
21214 (including any prefix or suffix) is used for :user.
21215
21216
21217 .option sieve_vacation_directory redirect string&!! unset
21218 .cindex "Sieve filter" "vacation directory"
21219 To enable the &"vacation"& extension for Sieve filters, you must set
21220 &%sieve_vacation_directory%& to the directory where vacation databases are held
21221 (do not put anything else in that directory), and ensure that the
21222 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21223 needs their own directory; Exim will create it if necessary.
21224
21225
21226
21227 .option skip_syntax_errors redirect boolean false
21228 .cindex "forward file" "broken"
21229 .cindex "address redirection" "broken files"
21230 .cindex "alias file" "broken"
21231 .cindex "broken alias or forward files"
21232 .cindex "ignoring faulty addresses"
21233 .cindex "skipping faulty addresses"
21234 .cindex "error" "skipping bad syntax"
21235 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21236 non-filter redirection data are skipped, and each failing address is logged. If
21237 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21238 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21239 are expanded and placed at the head of the error message generated by
21240 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21241 be the same address as the generic &%errors_to%& option. The
21242 &%skip_syntax_errors%& option is often used when handling mailing lists.
21243
21244 If all the addresses in a redirection list are skipped because of syntax
21245 errors, the router declines to handle the original address, and it is passed to
21246 the following routers.
21247
21248 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21249 error in the filter causes filtering to be abandoned without any action being
21250 taken. The incident is logged, and the router declines to handle the address,
21251 so it is passed to the following routers.
21252
21253 .cindex "Sieve filter" "syntax errors in"
21254 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21255 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21256 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21257
21258 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21259 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21260 option, used with an address that does not get redirected, can be used to
21261 notify users of these errors, by means of a router like this:
21262 .code
21263 userforward:
21264   driver = redirect
21265   allow_filter
21266   check_local_user
21267   file = $home/.forward
21268   file_transport = address_file
21269   pipe_transport = address_pipe
21270   reply_transport = address_reply
21271   no_verify
21272   skip_syntax_errors
21273   syntax_errors_to = real-$local_part@$domain
21274   syntax_errors_text = \
21275    This is an automatically generated message. An error has\n\
21276    been found in your .forward file. Details of the error are\n\
21277    reported below. While this error persists, you will receive\n\
21278    a copy of this message for every message that is addressed\n\
21279    to you. If your .forward file is a filter file, or if it is\n\
21280    a non-filter file containing no valid forwarding addresses,\n\
21281    a copy of each incoming message will be put in your normal\n\
21282    mailbox. If a non-filter file contains at least one valid\n\
21283    forwarding address, forwarding to the valid addresses will\n\
21284    happen, and those will be the only deliveries that occur.
21285 .endd
21286 You also need a router to ensure that local addresses that are prefixed by
21287 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21288 put this immediately before the &(userforward)& router:
21289 .code
21290 real_localuser:
21291   driver = accept
21292   check_local_user
21293   local_part_prefix = real-
21294   transport = local_delivery
21295 .endd
21296 For security, it would probably be a good idea to restrict the use of this
21297 router to locally-generated messages, using a condition such as this:
21298 .code
21299   condition = ${if match {$sender_host_address}\
21300                          {\N^(|127\.0\.0\.1)$\N}}
21301 .endd
21302
21303
21304 .option syntax_errors_text redirect string&!! unset
21305 See &%skip_syntax_errors%& above.
21306
21307
21308 .option syntax_errors_to redirect string unset
21309 See &%skip_syntax_errors%& above.
21310 .ecindex IIDredrou1
21311 .ecindex IIDredrou2
21312
21313
21314
21315
21316
21317
21318 . ////////////////////////////////////////////////////////////////////////////
21319 . ////////////////////////////////////////////////////////////////////////////
21320
21321 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21322          "Environment for local transports"
21323 .scindex IIDenvlotra1 "local transports" "environment for"
21324 .scindex IIDenvlotra2 "environment" "local transports"
21325 .scindex IIDenvlotra3 "transport" "local; environment for"
21326 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21327 transport can be thought of as similar to a pipe.) Exim always runs transports
21328 in subprocesses, under specified uids and gids. Typical deliveries to local
21329 mailboxes run under the uid and gid of the local user.
21330
21331 Exim also sets a specific current directory while running the transport; for
21332 some transports a home directory setting is also relevant. The &(pipe)&
21333 transport is the only one that sets up environment variables; see section
21334 &<<SECTpipeenv>>& for details.
21335
21336 The values used for the uid, gid, and the directories may come from several
21337 different places. In many cases, the router that handles the address associates
21338 settings with that address as a result of its &%check_local_user%&, &%group%&,
21339 or &%user%& options. However, values may also be given in the transport's own
21340 configuration, and these override anything that comes from the router.
21341
21342
21343
21344 .section "Concurrent deliveries" "SECID131"
21345 .cindex "concurrent deliveries"
21346 .cindex "simultaneous deliveries"
21347 If two different messages for the same local recipient arrive more or less
21348 simultaneously, the two delivery processes are likely to run concurrently. When
21349 the &(appendfile)& transport is used to write to a file, Exim applies locking
21350 rules to stop concurrent processes from writing to the same file at the same
21351 time.
21352
21353 However, when you use a &(pipe)& transport, it is up to you to arrange any
21354 locking that is needed. Here is a silly example:
21355 .code
21356 my_transport:
21357   driver = pipe
21358   command = /bin/sh -c 'cat >>/some/file'
21359 .endd
21360 This is supposed to write the message at the end of the file. However, if two
21361 messages arrive at the same time, the file will be scrambled. You can use the
21362 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21363 file using the same algorithm that Exim itself uses.
21364
21365
21366
21367
21368 .section "Uids and gids" "SECTenvuidgid"
21369 .cindex "local transports" "uid and gid"
21370 .cindex "transport" "local; uid and gid"
21371 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21372 overrides any group that the router set in the address, even if &%user%& is not
21373 set for the transport. This makes it possible, for example, to run local mail
21374 delivery under the uid of the recipient (set by the router), but in a special
21375 group (set by the transport). For example:
21376 .code
21377 # Routers ...
21378 # User/group are set by check_local_user in this router
21379 local_users:
21380   driver = accept
21381   check_local_user
21382   transport = group_delivery
21383
21384 # Transports ...
21385 # This transport overrides the group
21386 group_delivery:
21387   driver = appendfile
21388   file = /var/spool/mail/$local_part
21389   group = mail
21390 .endd
21391 If &%user%& is set for a transport, its value overrides what is set in the
21392 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21393 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21394 set.
21395
21396 .oindex "&%initgroups%&"
21397 When the uid is taken from the transport's configuration, the &[initgroups()]&
21398 function is called for the groups associated with that uid if the
21399 &%initgroups%& option is set for the transport. When the uid is not specified
21400 by the transport, but is associated with the address by a router, the option
21401 for calling &[initgroups()]& is taken from the router configuration.
21402
21403 .cindex "&(pipe)& transport" "uid for"
21404 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21405 is set and &%user%& is not set, the uid of the process that called Exim to
21406 receive the message is used, and if &%group%& is not set, the corresponding
21407 original gid is also used.
21408
21409 This is the detailed preference order for obtaining a gid; the first of the
21410 following that is set is used:
21411
21412 .ilist
21413 A &%group%& setting of the transport;
21414 .next
21415 A &%group%& setting of the router;
21416 .next
21417 A gid associated with a user setting of the router, either as a result of
21418 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21419 .next
21420 The group associated with a non-numeric &%user%& setting of the transport;
21421 .next
21422 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21423 the uid is the creator's uid;
21424 .next
21425 The Exim gid if the Exim uid is being used as a default.
21426 .endlist
21427
21428 If, for example, the user is specified numerically on the router and there are
21429 no group settings, no gid is available. In this situation, an error occurs.
21430 This is different for the uid, for which there always is an ultimate default.
21431 The first of the following that is set is used:
21432
21433 .ilist
21434 A &%user%& setting of the transport;
21435 .next
21436 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21437 .next
21438 A &%user%& setting of the router;
21439 .next
21440 A &%check_local_user%& setting of the router;
21441 .next
21442 The Exim uid.
21443 .endlist
21444
21445 Of course, an error will still occur if the uid that is chosen is on the
21446 &%never_users%& list.
21447
21448
21449
21450
21451
21452 .section "Current and home directories" "SECID132"
21453 .cindex "current directory for local transport"
21454 .cindex "home directory" "for local transport"
21455 .cindex "transport" "local; home directory for"
21456 .cindex "transport" "local; current directory for"
21457 Routers may set current and home directories for local transports by means of
21458 the &%transport_current_directory%& and &%transport_home_directory%& options.
21459 However, if the transport's &%current_directory%& or &%home_directory%& options
21460 are set, they override the router's values. In detail, the home directory
21461 for a local transport is taken from the first of these values that is set:
21462
21463 .ilist
21464 The &%home_directory%& option on the transport;
21465 .next
21466 The &%transport_home_directory%& option on the router;
21467 .next
21468 The password data if &%check_local_user%& is set on the router;
21469 .next
21470 The &%router_home_directory%& option on the router.
21471 .endlist
21472
21473 The current directory is taken from the first of these values that is set:
21474
21475 .ilist
21476 The &%current_directory%& option on the transport;
21477 .next
21478 The &%transport_current_directory%& option on the router.
21479 .endlist
21480
21481
21482 If neither the router nor the transport sets a current directory, Exim uses the
21483 value of the home directory, if it is set. Otherwise it sets the current
21484 directory to &_/_& before running a local transport.
21485
21486
21487
21488 .section "Expansion variables derived from the address" "SECID133"
21489 .vindex "&$domain$&"
21490 .vindex "&$local_part$&"
21491 .vindex "&$original_domain$&"
21492 Normally a local delivery is handling a single address, and in that case the
21493 variables such as &$domain$& and &$local_part$& are set during local
21494 deliveries. However, in some circumstances more than one address may be handled
21495 at once (for example, while writing batch SMTP for onward transmission by some
21496 other means). In this case, the variables associated with the local part are
21497 never set, &$domain$& is set only if all the addresses have the same domain,
21498 and &$original_domain$& is never set.
21499 .ecindex IIDenvlotra1
21500 .ecindex IIDenvlotra2
21501 .ecindex IIDenvlotra3
21502
21503
21504
21505
21506
21507
21508
21509 . ////////////////////////////////////////////////////////////////////////////
21510 . ////////////////////////////////////////////////////////////////////////////
21511
21512 .chapter "Generic options for transports" "CHAPtransportgeneric"
21513 .scindex IIDgenoptra1 "generic options" "transport"
21514 .scindex IIDgenoptra2 "options" "generic; for transports"
21515 .scindex IIDgenoptra3 "transport" "generic options for"
21516 The following generic options apply to all transports:
21517
21518
21519 .option body_only transports boolean false
21520 .cindex "transport" "body only"
21521 .cindex "message" "transporting body only"
21522 .cindex "body of message" "transporting"
21523 If this option is set, the message's headers are not transported. It is
21524 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21525 or &(pipe)& transports, the settings of &%message_prefix%& and
21526 &%message_suffix%& should be checked, because this option does not
21527 automatically suppress them.
21528
21529
21530 .option current_directory transports string&!! unset
21531 .cindex "transport" "current directory for"
21532 This specifies the current directory that is to be set while running the
21533 transport, overriding any value that may have been set by the router.
21534 If the expansion fails for any reason, including forced failure, an error is
21535 logged, and delivery is deferred.
21536
21537
21538 .option disable_logging transports boolean false
21539 If this option is set true, nothing is logged for any
21540 deliveries by the transport or for any
21541 transport errors. You should not set this option unless you really, really know
21542 what you are doing.
21543
21544
21545 .option debug_print transports string&!! unset
21546 .cindex "testing" "variables in drivers"
21547 If this option is set and debugging is enabled (see the &%-d%& command line
21548 option), the string is expanded and included in the debugging output when the
21549 transport is run.
21550 If expansion of the string fails, the error message is written to the debugging
21551 output, and Exim carries on processing.
21552 This facility is provided to help with checking out the values of variables and
21553 so on when debugging driver configurations. For example, if a &%headers_add%&
21554 option is not working properly, &%debug_print%& could be used to output the
21555 variables it references. A newline is added to the text if it does not end with
21556 one.
21557 The variables &$transport_name$& and &$router_name$& contain the name of the
21558 transport and the router that called it.
21559
21560 .option delivery_date_add transports boolean false
21561 .cindex "&'Delivery-date:'& header line"
21562 If this option is true, a &'Delivery-date:'& header is added to the message.
21563 This gives the actual time the delivery was made. As this is not a standard
21564 header, Exim has a configuration option (&%delivery_date_remove%&) which
21565 requests its removal from incoming messages, so that delivered messages can
21566 safely be resent to other recipients.
21567
21568
21569 .option driver transports string unset
21570 This specifies which of the available transport drivers is to be used.
21571 There is no default, and this option must be set for every transport.
21572
21573
21574 .option envelope_to_add transports boolean false
21575 .cindex "&'Envelope-to:'& header line"
21576 If this option is true, an &'Envelope-to:'& header is added to the message.
21577 This gives the original address(es) in the incoming envelope that caused this
21578 delivery to happen. More than one address may be present if the transport is
21579 configured to handle several addresses at once, or if more than one original
21580 address was redirected to the same final address. As this is not a standard
21581 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21582 its removal from incoming messages, so that delivered messages can safely be
21583 resent to other recipients.
21584
21585
21586 .option event_action transports string&!! unset
21587 .cindex events
21588 This option declares a string to be expanded for Exim's events mechanism.
21589 For details see chapter &<<CHAPevents>>&.
21590
21591
21592 .option group transports string&!! "Exim group"
21593 .cindex "transport" "group; specifying"
21594 This option specifies a gid for running the transport process, overriding any
21595 value that the router supplies, and also overriding any value associated with
21596 &%user%& (see below).
21597
21598
21599 .option headers_add transports list&!! unset
21600 .cindex "header lines" "adding in transport"
21601 .cindex "transport" "header lines; adding"
21602 This option specifies a list of text headers,
21603 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21604 which are (separately) expanded and added to the header
21605 portion of a message as it is transported, as described in section
21606 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21607 routers. If the result of the expansion is an empty string, or if the expansion
21608 is forced to fail, no action is taken. Other expansion failures are treated as
21609 errors and cause the delivery to be deferred.
21610
21611 Unlike most options, &%headers_add%& can be specified multiple times
21612 for a transport; all listed headers are added.
21613
21614
21615 .option headers_only transports boolean false
21616 .cindex "transport" "header lines only"
21617 .cindex "message" "transporting headers only"
21618 .cindex "header lines" "transporting"
21619 If this option is set, the message's body is not transported. It is mutually
21620 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21621 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21622 checked, since this option does not automatically suppress them.
21623
21624
21625 .option headers_remove transports list&!! unset
21626 .cindex "header lines" "removing"
21627 .cindex "transport" "header lines; removing"
21628 This option specifies a list of header names,
21629 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21630 these headers are omitted from the message as it is transported, as described
21631 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21632 routers.
21633 Each list item is separately expanded.
21634 If the result of the expansion is an empty string, or if the expansion
21635 is forced to fail, no action is taken. Other expansion failures are treated as
21636 errors and cause the delivery to be deferred.
21637
21638 Unlike most options, &%headers_remove%& can be specified multiple times
21639 for a transport; all listed headers are removed.
21640
21641 &*Warning*&: Because of the separate expansion of the list items,
21642 items that contain a list separator must have it doubled.
21643 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21644
21645
21646
21647 .option headers_rewrite transports string unset
21648 .cindex "transport" "header lines; rewriting"
21649 .cindex "rewriting" "at transport time"
21650 This option allows addresses in header lines to be rewritten at transport time,
21651 that is, as the message is being copied to its destination. The contents of the
21652 option are a colon-separated list of rewriting rules. Each rule is in exactly
21653 the same form as one of the general rewriting rules that are applied when a
21654 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21655 example,
21656 .code
21657 headers_rewrite = a@b c@d f : \
21658                   x@y w@z
21659 .endd
21660 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21661 &'w@z'& in all address-bearing header lines. The rules are applied to the
21662 header lines just before they are written out at transport time, so they affect
21663 only those copies of the message that pass through the transport. However, only
21664 the message's original header lines, and any that were added by a system
21665 filter, are rewritten. If a router or transport adds header lines, they are not
21666 affected by this option. These rewriting rules are &'not'& applied to the
21667 envelope. You can change the return path using &%return_path%&, but you cannot
21668 change envelope recipients at this time.
21669
21670
21671 .option home_directory transports string&!! unset
21672 .cindex "transport" "home directory for"
21673 .vindex "&$home$&"
21674 This option specifies a home directory setting for a local transport,
21675 overriding any value that may be set by the router. The home directory is
21676 placed in &$home$& while expanding the transport's private options. It is also
21677 used as the current directory if no current directory is set by the
21678 &%current_directory%& option on the transport or the
21679 &%transport_current_directory%& option on the router. If the expansion fails
21680 for any reason, including forced failure, an error is logged, and delivery is
21681 deferred.
21682
21683
21684 .option initgroups transports boolean false
21685 .cindex "additional groups"
21686 .cindex "groups" "additional"
21687 .cindex "transport" "group; additional"
21688 If this option is true and the uid for the delivery process is provided by the
21689 transport, the &[initgroups()]& function is called when running the transport
21690 to ensure that any additional groups associated with the uid are set up.
21691
21692
21693 .option max_parallel transports integer&!! unset
21694 .cindex limit "transport parallelism"
21695 .cindex transport "parallel processes"
21696 .cindex transport "concurrency limit"
21697 .cindex "delivery" "parallelism for transport"
21698 If this option is set and expands to an integer greater than zero
21699 it limits the number of concurrent runs of the transport.
21700 The control does not apply to shadow transports.
21701
21702 .cindex "hints database" "transport concurrency control"
21703 Exim implements this control by means of a hints database in which a record is
21704 incremented whenever a transport process is being created. The record
21705 is decremented and possibly removed when the process terminates.
21706 Obviously there is scope for
21707 records to get left lying around if there is a system or program crash. To
21708 guard against this, Exim ignores any records that are more than six hours old.
21709
21710 If you use this option, you should also arrange to delete the
21711 relevant hints database whenever your system reboots. The names of the files
21712 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21713 may be one or two files, depending on the type of DBM in use. The same files
21714 are used for ETRN and smtp transport serialization.
21715
21716
21717 .option message_size_limit transports string&!! 0
21718 .cindex "limit" "message size per transport"
21719 .cindex "size" "of message, limit"
21720 .cindex "transport" "message size; limiting"
21721 This option controls the size of messages passed through the transport. It is
21722 expanded before use; the result of the expansion must be a sequence of decimal
21723 digits, optionally followed by K or M. If the expansion fails for any reason,
21724 including forced failure, or if the result is not of the required form,
21725 delivery is deferred. If the value is greater than zero and the size of a
21726 message exceeds this limit, the address is failed. If there is any chance that
21727 the resulting bounce message could be routed to the same transport, you should
21728 ensure that &%return_size_limit%& is less than the transport's
21729 &%message_size_limit%&, as otherwise the bounce message will fail to get
21730 delivered.
21731
21732
21733
21734 .option rcpt_include_affixes transports boolean false
21735 .cindex "prefix" "for local part, including in envelope"
21736 .cindex "suffix for local part" "including in envelope"
21737 .cindex "local part" "prefix"
21738 .cindex "local part" "suffix"
21739 When this option is false (the default), and an address that has had any
21740 affixes (prefixes or suffixes) removed from the local part is delivered by any
21741 form of SMTP or LMTP, the affixes are not included. For example, if a router
21742 that contains
21743 .code
21744 local_part_prefix = *-
21745 .endd
21746 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21747 is delivered with
21748 .code
21749 RCPT TO:<xyz@some.domain>
21750 .endd
21751 This is also the case when an ACL-time callout is being used to verify a
21752 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21753 whole local part is included in the RCPT command. This option applies to BSMTP
21754 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21755 &(lmtp)& and &(smtp)& transports.
21756
21757
21758 .option retry_use_local_part transports boolean "see below"
21759 .cindex "hints database" "retry keys"
21760 When a delivery suffers a temporary failure, a retry record is created
21761 in Exim's hints database. For remote deliveries, the key for the retry record
21762 is based on the name and/or IP address of the failing remote host. For local
21763 deliveries, the key is normally the entire address, including both the local
21764 part and the domain. This is suitable for most common cases of local delivery
21765 temporary failure &-- for example, exceeding a mailbox quota should delay only
21766 deliveries to that mailbox, not to the whole domain.
21767
21768 However, in some special cases you may want to treat a temporary local delivery
21769 as a failure associated with the domain, and not with a particular local part.
21770 (For example, if you are storing all mail for some domain in files.) You can do
21771 this by setting &%retry_use_local_part%& false.
21772
21773 For all the local transports, its default value is true. For remote transports,
21774 the default value is false for tidiness, but changing the value has no effect
21775 on a remote transport in the current implementation.
21776
21777
21778 .option return_path transports string&!! unset
21779 .cindex "envelope sender"
21780 .cindex "envelope from"
21781 .cindex "transport" "return path; changing"
21782 .cindex "return path" "changing in transport"
21783 If this option is set, the string is expanded at transport time and replaces
21784 the existing return path (envelope sender) value in the copy of the message
21785 that is being delivered. An empty return path is permitted. This feature is
21786 designed for remote deliveries, where the value of this option is used in the
21787 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21788 only effect is to change the address that is placed in the &'Return-path:'&
21789 header line, if one is added to the message (see the next option).
21790
21791 &*Note:*& A changed return path is not logged unless you add
21792 &%return_path_on_delivery%& to the log selector.
21793
21794 .vindex "&$return_path$&"
21795 The expansion can refer to the existing value via &$return_path$&. This is
21796 either the message's envelope sender, or an address set by the
21797 &%errors_to%& option on a router. If the expansion is forced to fail, no
21798 replacement occurs; if it fails for another reason, delivery is deferred. This
21799 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21800 section &<<SECTverp>>&.
21801
21802 &*Note*&: If a delivery error is detected locally, including the case when a
21803 remote server rejects a message at SMTP time, the bounce message is not sent to
21804 the value of this option. It is sent to the previously set errors address.
21805 This defaults to the incoming sender address, but can be changed by setting
21806 &%errors_to%& in a router.
21807
21808
21809
21810 .option return_path_add transports boolean false
21811 .cindex "&'Return-path:'& header line"
21812 If this option is true, a &'Return-path:'& header is added to the message.
21813 Although the return path is normally available in the prefix line of BSD
21814 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21815 have easy access to it.
21816
21817 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21818 the delivery SMTP server makes the final delivery"&. This implies that this
21819 header should not be present in incoming messages. Exim has a configuration
21820 option, &%return_path_remove%&, which requests removal of this header from
21821 incoming messages, so that delivered messages can safely be resent to other
21822 recipients.
21823
21824
21825 .option shadow_condition transports string&!! unset
21826 See &%shadow_transport%& below.
21827
21828
21829 .option shadow_transport transports string unset
21830 .cindex "shadow transport"
21831 .cindex "transport" "shadow"
21832 A local transport may set the &%shadow_transport%& option to the name of
21833 another local transport. Shadow remote transports are not supported.
21834
21835 Whenever a delivery to the main transport succeeds, and either
21836 &%shadow_condition%& is unset, or its expansion does not result in the empty
21837 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21838 passed to the shadow transport, with the same delivery address or addresses. If
21839 expansion fails, no action is taken except that non-forced expansion failures
21840 cause a log line to be written.
21841
21842 The result of the shadow transport is discarded and does not affect the
21843 subsequent processing of the message. Only a single level of shadowing is
21844 provided; the &%shadow_transport%& option is ignored on any transport when it
21845 is running as a shadow. Options concerned with output from pipes are also
21846 ignored. The log line for the successful delivery has an item added on the end,
21847 of the form
21848 .code
21849 ST=<shadow transport name>
21850 .endd
21851 If the shadow transport did not succeed, the error message is put in
21852 parentheses afterwards. Shadow transports can be used for a number of different
21853 purposes, including keeping more detailed log information than Exim normally
21854 provides, and implementing automatic acknowledgment policies based on message
21855 headers that some sites insist on.
21856
21857
21858 .option transport_filter transports string&!! unset
21859 .cindex "transport" "filter"
21860 .cindex "filter" "transport filter"
21861 This option sets up a filtering (in the Unix shell sense) process for messages
21862 at transport time. It should not be confused with mail filtering as set up by
21863 individual users or via a system filter.
21864 If unset, or expanding to an empty string, no filtering is done.
21865
21866 When the message is about to be written out, the command specified by
21867 &%transport_filter%& is started up in a separate, parallel process, and
21868 the entire message, including the header lines, is passed to it on its standard
21869 input (this in fact is done from a third process, to avoid deadlock). The
21870 command must be specified as an absolute path.
21871
21872 The lines of the message that are written to the transport filter are
21873 terminated by newline (&"\n"&). The message is passed to the filter before any
21874 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21875 lines beginning with a dot, and also before any processing implied by the
21876 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21877 &(pipe)& transports.
21878
21879 The standard error for the filter process is set to the same destination as its
21880 standard output; this is read and written to the message's ultimate
21881 destination. The process that writes the message to the filter, the
21882 filter itself, and the original process that reads the result and delivers it
21883 are all run in parallel, like a shell pipeline.
21884
21885 The filter can perform any transformations it likes, but of course should take
21886 care not to break RFC 2822 syntax. Exim does not check the result, except to
21887 test for a final newline when SMTP is in use. All messages transmitted over
21888 SMTP must end with a newline, so Exim supplies one if it is missing.
21889
21890 .cindex "content scanning" "per user"
21891 A transport filter can be used to provide content-scanning on a per-user basis
21892 at delivery time if the only required effect of the scan is to modify the
21893 message. For example, a content scan could insert a new header line containing
21894 a spam score. This could be interpreted by a filter in the user's MUA. It is
21895 not possible to discard a message at this stage.
21896
21897 .cindex "SMTP" "SIZE"
21898 A problem might arise if the filter increases the size of a message that is
21899 being sent down an SMTP connection. If the receiving SMTP server has indicated
21900 support for the SIZE parameter, Exim will have sent the size of the message
21901 at the start of the SMTP session. If what is actually sent is substantially
21902 more, the server might reject the message. This can be worked round by setting
21903 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21904 additions to the message, or to disable the use of SIZE altogether.
21905
21906 .vindex "&$pipe_addresses$&"
21907 The value of the &%transport_filter%& option is the command string for starting
21908 the filter, which is run directly from Exim, not under a shell. The string is
21909 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21910 Exim breaks it up into arguments and then expands each argument separately (see
21911 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21912 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21913 of arguments, one for each address that applies to this delivery. (This isn't
21914 an ideal name for this feature here, but as it was already implemented for the
21915 &(pipe)& transport, it seemed sensible not to change it.)
21916
21917 .vindex "&$host$&"
21918 .vindex "&$host_address$&"
21919 The expansion variables &$host$& and &$host_address$& are available when the
21920 transport is a remote one. They contain the name and IP address of the host to
21921 which the message is being sent. For example:
21922 .code
21923 transport_filter = /some/directory/transport-filter.pl \
21924   $host $host_address $sender_address $pipe_addresses
21925 .endd
21926
21927 Two problems arise if you want to use more complicated expansion items to
21928 generate transport filter commands, both of which due to the fact that the
21929 command is split up &'before'& expansion.
21930 .ilist
21931 If an expansion item contains white space, you must quote it, so that it is all
21932 part of the same command item. If the entire option setting is one such
21933 expansion item, you have to take care what kind of quoting you use. For
21934 example:
21935 .code
21936 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21937 .endd
21938 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21939 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21940 stripped by Exim when it read the option's value. When the value is used, if
21941 the single quotes were missing, the line would be split into two items,
21942 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21943 Exim tried to expand the first one.
21944 .next
21945 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21946 expansion cannot generate multiple arguments, or a command name followed by
21947 arguments. Consider this example:
21948 .code
21949 transport_filter = ${lookup{$host}lsearch{/a/file}\
21950                     {$value}{/bin/cat}}
21951 .endd
21952 The result of the lookup is interpreted as the name of the command, even
21953 if it contains white space. The simplest way round this is to use a shell:
21954 .code
21955 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21956                                {$value}{/bin/cat}}
21957 .endd
21958 .endlist
21959
21960 The filter process is run under the same uid and gid as the normal delivery.
21961 For remote deliveries this is the Exim uid/gid by default. The command should
21962 normally yield a zero return code. Transport filters are not supposed to fail.
21963 A non-zero code is taken to mean that the transport filter encountered some
21964 serious problem. Delivery of the message is deferred; the message remains on
21965 the queue and is tried again later. It is not possible to cause a message to be
21966 bounced from a transport filter.
21967
21968 If a transport filter is set on an autoreply transport, the original message is
21969 passed through the filter as it is being copied into the newly generated
21970 message, which happens if the &%return_message%& option is set.
21971
21972
21973 .option transport_filter_timeout transports time 5m
21974 .cindex "transport" "filter, timeout"
21975 When Exim is reading the output of a transport filter, it applies a timeout
21976 that can be set by this option. Exceeding the timeout is normally treated as a
21977 temporary delivery failure. However, if a transport filter is used with a
21978 &(pipe)& transport, a timeout in the transport filter is treated in the same
21979 way as a timeout in the pipe command itself. By default, a timeout is a hard
21980 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21981 becomes a temporary error.
21982
21983
21984 .option user transports string&!! "Exim user"
21985 .cindex "uid (user id)" "local delivery"
21986 .cindex "transport" "user, specifying"
21987 This option specifies the user under whose uid the delivery process is to be
21988 run, overriding any uid that may have been set by the router. If the user is
21989 given as a name, the uid is looked up from the password data, and the
21990 associated group is taken as the value of the gid to be used if the &%group%&
21991 option is not set.
21992
21993 For deliveries that use local transports, a user and group are normally
21994 specified explicitly or implicitly (for example, as a result of
21995 &%check_local_user%&) by the router or transport.
21996
21997 .cindex "hints database" "access by remote transport"
21998 For remote transports, you should leave this option unset unless you really are
21999 sure you know what you are doing. When a remote transport is running, it needs
22000 to be able to access Exim's hints databases, because each host may have its own
22001 retry data.
22002 .ecindex IIDgenoptra1
22003 .ecindex IIDgenoptra2
22004 .ecindex IIDgenoptra3
22005
22006
22007
22008
22009
22010
22011 . ////////////////////////////////////////////////////////////////////////////
22012 . ////////////////////////////////////////////////////////////////////////////
22013
22014 .chapter "Address batching in local transports" "CHAPbatching" &&&
22015          "Address batching"
22016 .cindex "transport" "local; address batching in"
22017 The only remote transport (&(smtp)&) is normally configured to handle more than
22018 one address at a time, so that when several addresses are routed to the same
22019 remote host, just one copy of the message is sent. Local transports, however,
22020 normally handle one address at a time. That is, a separate instance of the
22021 transport is run for each address that is routed to the transport. A separate
22022 copy of the message is delivered each time.
22023
22024 .cindex "batched local delivery"
22025 .oindex "&%batch_max%&"
22026 .oindex "&%batch_id%&"
22027 In special cases, it may be desirable to handle several addresses at once in a
22028 local transport, for example:
22029
22030 .ilist
22031 In an &(appendfile)& transport, when storing messages in files for later
22032 delivery by some other means, a single copy of the message with multiple
22033 recipients saves space.
22034 .next
22035 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22036 a single copy saves time, and is the normal way LMTP is expected to work.
22037 .next
22038 In a &(pipe)& transport, when passing the message
22039 to a scanner program or
22040 to some other delivery mechanism such as UUCP, multiple recipients may be
22041 acceptable.
22042 .endlist
22043
22044 These three local transports all have the same options for controlling multiple
22045 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22046 repeating the information for each transport, these options are described here.
22047
22048 The &%batch_max%& option specifies the maximum number of addresses that can be
22049 delivered together in a single run of the transport. Its default value is one
22050 (no batching). When more than one address is routed to a transport that has a
22051 &%batch_max%& value greater than one, the addresses are delivered in a batch
22052 (that is, in a single run of the transport with multiple recipients), subject
22053 to certain conditions:
22054
22055 .ilist
22056 .vindex "&$local_part$&"
22057 If any of the transport's options contain a reference to &$local_part$&, no
22058 batching is possible.
22059 .next
22060 .vindex "&$domain$&"
22061 If any of the transport's options contain a reference to &$domain$&, only
22062 addresses with the same domain are batched.
22063 .next
22064 .cindex "customizing" "batching condition"
22065 If &%batch_id%& is set, it is expanded for each address, and only those
22066 addresses with the same expanded value are batched. This allows you to specify
22067 customized batching conditions. Failure of the expansion for any reason,
22068 including forced failure, disables batching, but it does not stop the delivery
22069 from taking place.
22070 .next
22071 Batched addresses must also have the same errors address (where to send
22072 delivery errors), the same header additions and removals, the same user and
22073 group for the transport, and if a host list is present, the first host must
22074 be the same.
22075 .endlist
22076
22077 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22078 both when the file or pipe command is specified in the transport, and when it
22079 is specified by a &(redirect)& router, but all the batched addresses must of
22080 course be routed to the same file or pipe command. These two transports have an
22081 option called &%use_bsmtp%&, which causes them to deliver the message in
22082 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22083 &%check_string%& and &%escape_string%& options are forced to the values
22084 .code
22085 check_string = "."
22086 escape_string = ".."
22087 .endd
22088 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22089 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22090 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22091
22092 .cindex "&'Envelope-to:'& header line"
22093 If the generic &%envelope_to_add%& option is set for a batching transport, the
22094 &'Envelope-to:'& header that is added to the message contains all the addresses
22095 that are being processed together. If you are using a batching &(appendfile)&
22096 transport without &%use_bsmtp%&, the only way to preserve the recipient
22097 addresses is to set the &%envelope_to_add%& option.
22098
22099 .cindex "&(pipe)& transport" "with multiple addresses"
22100 .vindex "&$pipe_addresses$&"
22101 If you are using a &(pipe)& transport without BSMTP, and setting the
22102 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22103 the command. This is not a true variable; it is a bit of magic that causes each
22104 of the recipient addresses to be inserted into the command as a separate
22105 argument. This provides a way of accessing all the addresses that are being
22106 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22107 are specified by a &(redirect)& router.
22108
22109
22110
22111
22112 . ////////////////////////////////////////////////////////////////////////////
22113 . ////////////////////////////////////////////////////////////////////////////
22114
22115 .chapter "The appendfile transport" "CHAPappendfile"
22116 .scindex IIDapptra1 "&(appendfile)& transport"
22117 .scindex IIDapptra2 "transports" "&(appendfile)&"
22118 .cindex "directory creation"
22119 .cindex "creating directories"
22120 The &(appendfile)& transport delivers a message by appending it to an existing
22121 file, or by creating an entirely new file in a specified directory. Single
22122 files to which messages are appended can be in the traditional Unix mailbox
22123 format, or optionally in the MBX format supported by the Pine MUA and
22124 University of Washington IMAP daemon, &'inter alia'&. When each message is
22125 being delivered as a separate file, &"maildir"& format can optionally be used
22126 to give added protection against failures that happen part-way through the
22127 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22128 supported. For all file formats, Exim attempts to create as many levels of
22129 directory as necessary, provided that &%create_directory%& is set.
22130
22131 The code for the optional formats is not included in the Exim binary by
22132 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22133 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22134 included.
22135
22136 .cindex "quota" "system"
22137 Exim recognizes system quota errors, and generates an appropriate message. Exim
22138 also supports its own quota control within the transport, for use when the
22139 system facility is unavailable or cannot be used for some reason.
22140
22141 If there is an error while appending to a file (for example, quota exceeded or
22142 partition filled), Exim attempts to reset the file's length and last
22143 modification time back to what they were before. If there is an error while
22144 creating an entirely new file, the new file is removed.
22145
22146 Before appending to a file, a number of security checks are made, and the
22147 file is locked. A detailed description is given below, after the list of
22148 private options.
22149
22150 The &(appendfile)& transport is most commonly used for local deliveries to
22151 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22152 putting messages into files for remote delivery by some means other than Exim.
22153 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22154 option).
22155
22156
22157
22158 .section "The file and directory options" "SECTfildiropt"
22159 The &%file%& option specifies a single file, to which the message is appended;
22160 the &%directory%& option specifies a directory, in which a new file containing
22161 the message is created. Only one of these two options can be set, and for
22162 normal deliveries to mailboxes, one of them &'must'& be set.
22163
22164 .vindex "&$address_file$&"
22165 .vindex "&$local_part$&"
22166 However, &(appendfile)& is also used for delivering messages to files or
22167 directories whose names (or parts of names) are obtained from alias,
22168 forwarding, or filtering operations (for example, a &%save%& command in a
22169 user's Exim filter). When such a transport is running, &$local_part$& contains
22170 the local part that was aliased or forwarded, and &$address_file$& contains the
22171 name (or partial name) of the file or directory generated by the redirection
22172 operation. There are two cases:
22173
22174 .ilist
22175 If neither &%file%& nor &%directory%& is set, the redirection operation
22176 must specify an absolute path (one that begins with &`/`&). This is the most
22177 common case when users with local accounts use filtering to sort mail into
22178 different folders. See for example, the &(address_file)& transport in the
22179 default configuration. If the path ends with a slash, it is assumed to be the
22180 name of a directory. A delivery to a directory can also be forced by setting
22181 &%maildir_format%& or &%mailstore_format%&.
22182 .next
22183 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22184 used to determine the file or directory name for the delivery. Normally, the
22185 contents of &$address_file$& are used in some way in the string expansion.
22186 .endlist
22187
22188
22189 .cindex "Sieve filter" "configuring &(appendfile)&"
22190 .cindex "Sieve filter" "relative mailbox path handling"
22191 As an example of the second case, consider an environment where users do not
22192 have home directories. They may be permitted to use Exim filter commands of the
22193 form:
22194 .code
22195 save folder23
22196 .endd
22197 or Sieve filter commands of the form:
22198 .code
22199 require "fileinto";
22200 fileinto "folder23";
22201 .endd
22202 In this situation, the expansion of &%file%& or &%directory%& in the transport
22203 must transform the relative path into an appropriate absolute filename. In the
22204 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22205 is used as a result of a &"keep"& action in the filter. This example shows one
22206 way of handling this requirement:
22207 .code
22208 file = ${if eq{$address_file}{inbox} \
22209             {/var/mail/$local_part} \
22210             {${if eq{${substr_0_1:$address_file}}{/} \
22211                   {$address_file} \
22212                   {$home/mail/$address_file} \
22213             }} \
22214        }
22215 .endd
22216 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22217 location, absolute paths are used without change, and other folders are in the
22218 &_mail_& directory within the home directory.
22219
22220 &*Note 1*&: While processing an Exim filter, a relative path such as
22221 &_folder23_& is turned into an absolute path if a home directory is known to
22222 the router. In particular, this is the case if &%check_local_user%& is set. If
22223 you want to prevent this happening at routing time, you can set
22224 &%router_home_directory%& empty. This forces the router to pass the relative
22225 path to the transport.
22226
22227 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22228 the &%file%& or &%directory%& option is still used if it is set.
22229
22230
22231
22232
22233 .section "Private options for appendfile" "SECID134"
22234 .cindex "options" "&(appendfile)& transport"
22235
22236
22237
22238 .option allow_fifo appendfile boolean false
22239 .cindex "fifo (named pipe)"
22240 .cindex "named pipe (fifo)"
22241 .cindex "pipe" "named (fifo)"
22242 Setting this option permits delivery to named pipes (FIFOs) as well as to
22243 regular files. If no process is reading the named pipe at delivery time, the
22244 delivery is deferred.
22245
22246
22247 .option allow_symlink appendfile boolean false
22248 .cindex "symbolic link" "to mailbox"
22249 .cindex "mailbox" "symbolic link"
22250 By default, &(appendfile)& will not deliver if the path name for the file is
22251 that of a symbolic link. Setting this option relaxes that constraint, but there
22252 are security issues involved in the use of symbolic links. Be sure you know
22253 what you are doing if you set this. Details of exactly what this option affects
22254 are included in the discussion which follows this list of options.
22255
22256
22257 .option batch_id appendfile string&!! unset
22258 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22259 However, batching is automatically disabled for &(appendfile)& deliveries that
22260 happen as a result of forwarding or aliasing or other redirection directly to a
22261 file.
22262
22263
22264 .option batch_max appendfile integer 1
22265 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22266
22267
22268 .option check_group appendfile boolean false
22269 When this option is set, the group owner of the file defined by the &%file%&
22270 option is checked to see that it is the same as the group under which the
22271 delivery process is running. The default setting is false because the default
22272 file mode is 0600, which means that the group is irrelevant.
22273
22274
22275 .option check_owner appendfile boolean true
22276 When this option is set, the owner of the file defined by the &%file%& option
22277 is checked to ensure that it is the same as the user under which the delivery
22278 process is running.
22279
22280
22281 .option check_string appendfile string "see below"
22282 .cindex "&""From""& line"
22283 As &(appendfile)& writes the message, the start of each line is tested for
22284 matching &%check_string%&, and if it does, the initial matching characters are
22285 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22286 a literal string, not a regular expression, and the case of any letters it
22287 contains is significant.
22288
22289 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22290 are forced to &"."& and &".."& respectively, and any settings in the
22291 configuration are ignored. Otherwise, they default to &"From&~"& and
22292 &">From&~"& when the &%file%& option is set, and unset when any of the
22293 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22294
22295 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22296 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22297 &"From&~"& indicates the start of a new message. All four options need changing
22298 if another format is used. For example, to deliver to mailboxes in MMDF format:
22299 .cindex "MMDF format mailbox"
22300 .cindex "mailbox" "MMDF format"
22301 .code
22302 check_string = "\1\1\1\1\n"
22303 escape_string = "\1\1\1\1 \n"
22304 message_prefix = "\1\1\1\1\n"
22305 message_suffix = "\1\1\1\1\n"
22306 .endd
22307 .option create_directory appendfile boolean true
22308 .cindex "directory creation"
22309 When this option is true, Exim attempts to create any missing superior
22310 directories for the file that it is about to write. A created directory's mode
22311 is given by the &%directory_mode%& option.
22312
22313 The group ownership of a newly created directory is highly dependent on the
22314 operating system (and possibly the file system) that is being used. For
22315 example, in Solaris, if the parent directory has the setgid bit set, its group
22316 is propagated to the child; if not, the currently set group is used. However,
22317 in FreeBSD, the parent's group is always used.
22318
22319
22320
22321 .option create_file appendfile string anywhere
22322 This option constrains the location of files and directories that are created
22323 by this transport. It applies to files defined by the &%file%& option and
22324 directories defined by the &%directory%& option. In the case of maildir
22325 delivery, it applies to the top level directory, not the maildir directories
22326 beneath.
22327
22328 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22329 &"belowhome"&. In the second and third cases, a home directory must have been
22330 set for the transport. This option is not useful when an explicit filename is
22331 given for normal mailbox deliveries. It is intended for the case when filenames
22332 are generated from users' &_.forward_& files. These are usually handled
22333 by an &(appendfile)& transport called &%address_file%&. See also
22334 &%file_must_exist%&.
22335
22336
22337 .option directory appendfile string&!! unset
22338 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22339 or &%directory%& must be set, unless the delivery is the direct result of a
22340 redirection (see section &<<SECTfildiropt>>&).
22341
22342 When &%directory%& is set, the string is expanded, and the message is delivered
22343 into a new file or files in or below the given directory, instead of being
22344 appended to a single mailbox file. A number of different formats are provided
22345 (see &%maildir_format%& and &%mailstore_format%&), and see section
22346 &<<SECTopdir>>& for further details of this form of delivery.
22347
22348
22349 .option directory_file appendfile string&!! "see below"
22350 .cindex "base62"
22351 .vindex "&$inode$&"
22352 When &%directory%& is set, but neither &%maildir_format%& nor
22353 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22354 whose name is obtained by expanding this string. The default value is:
22355 .code
22356 q${base62:$tod_epoch}-$inode
22357 .endd
22358 This generates a unique name from the current time, in base 62 form, and the
22359 inode of the file. The variable &$inode$& is available only when expanding this
22360 option.
22361
22362
22363 .option directory_mode appendfile "octal integer" 0700
22364 If &(appendfile)& creates any directories as a result of the
22365 &%create_directory%& option, their mode is specified by this option.
22366
22367
22368 .option escape_string appendfile string "see description"
22369 See &%check_string%& above.
22370
22371
22372 .option file appendfile string&!! unset
22373 This option is mutually exclusive with the &%directory%& option, but one of
22374 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22375 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22376 specifies a single file, to which the message is appended. One or more of
22377 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22378 &%file%&.
22379
22380 .cindex "NFS" "lock file"
22381 .cindex "locking files"
22382 .cindex "lock files"
22383 If you are using more than one host to deliver over NFS into the same
22384 mailboxes, you should always use lock files.
22385
22386 The string value is expanded for each delivery, and must yield an absolute
22387 path. The most common settings of this option are variations on one of these
22388 examples:
22389 .code
22390 file = /var/spool/mail/$local_part
22391 file = /home/$local_part/inbox
22392 file = $home/inbox
22393 .endd
22394 .cindex "&""sticky""& bit"
22395 In the first example, all deliveries are done into the same directory. If Exim
22396 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22397 create a file in the directory, so the &"sticky"& bit must be turned on for
22398 deliveries to be possible, or alternatively the &%group%& option can be used to
22399 run the delivery under a group id which has write access to the directory.
22400
22401
22402
22403 .option file_format appendfile string unset
22404 .cindex "file" "mailbox; checking existing format"
22405 This option requests the transport to check the format of an existing file
22406 before adding to it. The check consists of matching a specific string at the
22407 start of the file. The value of the option consists of an even number of
22408 colon-separated strings. The first of each pair is the test string, and the
22409 second is the name of a transport. If the transport associated with a matched
22410 string is not the current transport, control is passed over to the other
22411 transport. For example, suppose the standard &(local_delivery)& transport has
22412 this added to it:
22413 .code
22414 file_format = "From       : local_delivery :\
22415                \1\1\1\1\n : local_mmdf_delivery"
22416 .endd
22417 Mailboxes that begin with &"From"& are still handled by this transport, but if
22418 a mailbox begins with four binary ones followed by a newline, control is passed
22419 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22420 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22421 is assumed to match the current transport. If the start of a mailbox doesn't
22422 match any string, or if the transport named for a given string is not defined,
22423 delivery is deferred.
22424
22425
22426 .option file_must_exist appendfile boolean false
22427 If this option is true, the file specified by the &%file%& option must exist.
22428 A temporary error occurs if it does not, causing delivery to be deferred.
22429 If this option is false, the file is created if it does not exist.
22430
22431
22432 .option lock_fcntl_timeout appendfile time 0s
22433 .cindex "timeout" "mailbox locking"
22434 .cindex "mailbox" "locking, blocking and non-blocking"
22435 .cindex "locking files"
22436 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22437 when locking an open mailbox file. If the call fails, the delivery process
22438 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22439 Non-blocking calls are used so that the file is not kept open during the wait
22440 for the lock; the reason for this is to make it as safe as possible for
22441 deliveries over NFS in the case when processes might be accessing an NFS
22442 mailbox without using a lock file. This should not be done, but
22443 misunderstandings and hence misconfigurations are not unknown.
22444
22445 On a busy system, however, the performance of a non-blocking lock approach is
22446 not as good as using a blocking lock with a timeout. In this case, the waiting
22447 is done inside the system call, and Exim's delivery process acquires the lock
22448 and can proceed as soon as the previous lock holder releases it.
22449
22450 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22451 timeout, are used. There may still be some retrying: the maximum number of
22452 retries is
22453 .code
22454 (lock_retries * lock_interval) / lock_fcntl_timeout
22455 .endd
22456 rounded up to the next whole number. In other words, the total time during
22457 which &(appendfile)& is trying to get a lock is roughly the same, unless
22458 &%lock_fcntl_timeout%& is set very large.
22459
22460 You should consider setting this option if you are getting a lot of delayed
22461 local deliveries because of errors of the form
22462 .code
22463 failed to lock mailbox /some/file (fcntl)
22464 .endd
22465
22466 .option lock_flock_timeout appendfile time 0s
22467 This timeout applies to file locking when using &[flock()]& (see
22468 &%use_flock%&); the timeout operates in a similar manner to
22469 &%lock_fcntl_timeout%&.
22470
22471
22472 .option lock_interval appendfile time 3s
22473 This specifies the time to wait between attempts to lock the file. See below
22474 for details of locking.
22475
22476
22477 .option lock_retries appendfile integer 10
22478 This specifies the maximum number of attempts to lock the file. A value of zero
22479 is treated as 1. See below for details of locking.
22480
22481
22482 .option lockfile_mode appendfile "octal integer" 0600
22483 This specifies the mode of the created lock file, when a lock file is being
22484 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22485
22486
22487 .option lockfile_timeout appendfile time 30m
22488 .cindex "timeout" "mailbox locking"
22489 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22490 exists and is older than this value, it is assumed to have been left behind by
22491 accident, and Exim attempts to remove it.
22492
22493
22494 .option mailbox_filecount appendfile string&!! unset
22495 .cindex "mailbox" "specifying size of"
22496 .cindex "size" "of mailbox"
22497 If this option is set, it is expanded, and the result is taken as the current
22498 number of files in the mailbox. It must be a decimal number, optionally
22499 followed by K or M. This provides a way of obtaining this information from an
22500 external source that maintains the data.
22501
22502
22503 .option mailbox_size appendfile string&!! unset
22504 .cindex "mailbox" "specifying size of"
22505 .cindex "size" "of mailbox"
22506 If this option is set, it is expanded, and the result is taken as the current
22507 size the mailbox. It must be a decimal number, optionally followed by K or M.
22508 This provides a way of obtaining this information from an external source that
22509 maintains the data. This is likely to be helpful for maildir deliveries where
22510 it is computationally expensive to compute the size of a mailbox.
22511
22512
22513
22514 .option maildir_format appendfile boolean false
22515 .cindex "maildir format" "specifying"
22516 If this option is set with the &%directory%& option, the delivery is into a new
22517 file, in the &"maildir"& format that is used by other mail software. When the
22518 transport is activated directly from a &(redirect)& router (for example, the
22519 &(address_file)& transport in the default configuration), setting
22520 &%maildir_format%& causes the path received from the router to be treated as a
22521 directory, whether or not it ends with &`/`&. This option is available only if
22522 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22523 &<<SECTmaildirdelivery>>& below for further details.
22524
22525
22526 .option maildir_quota_directory_regex appendfile string "See below"
22527 .cindex "maildir format" "quota; directories included in"
22528 .cindex "quota" "maildir; directories included in"
22529 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22530 a regular expression for specifying directories, relative to the quota
22531 directory (see &%quota_directory%&), that should be included in the quota
22532 calculation. The default value is:
22533 .code
22534 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22535 .endd
22536 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22537 (directories whose names begin with a dot). If you want to exclude the
22538 &_Trash_&
22539 folder from the count (as some sites do), you need to change this setting to
22540 .code
22541 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22542 .endd
22543 This uses a negative lookahead in the regular expression to exclude the
22544 directory whose name is &_.Trash_&. When a directory is excluded from quota
22545 calculations, quota processing is bypassed for any messages that are delivered
22546 directly into that directory.
22547
22548
22549 .option maildir_retries appendfile integer 10
22550 This option specifies the number of times to retry when writing a file in
22551 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22552
22553
22554 .option maildir_tag appendfile string&!! unset
22555 This option applies only to deliveries in maildir format, and is described in
22556 section &<<SECTmaildirdelivery>>& below.
22557
22558
22559 .option maildir_use_size_file appendfile&!! boolean false
22560 .cindex "maildir format" "&_maildirsize_& file"
22561 The result of string expansion for this option must be a valid boolean value.
22562 If it is true, it enables support for &_maildirsize_& files. Exim
22563 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22564 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22565 value is zero. See &%maildir_quota_directory_regex%& above and section
22566 &<<SECTmaildirdelivery>>& below for further details.
22567
22568 .option maildirfolder_create_regex appendfile string unset
22569 .cindex "maildir format" "&_maildirfolder_& file"
22570 .cindex "&_maildirfolder_&, creating"
22571 The value of this option is a regular expression. If it is unset, it has no
22572 effect. Otherwise, before a maildir delivery takes place, the pattern is
22573 matched against the name of the maildir directory, that is, the directory
22574 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22575 delivery. If there is a match, Exim checks for the existence of a file called
22576 &_maildirfolder_& in the directory, and creates it if it does not exist.
22577 See section &<<SECTmaildirdelivery>>& for more details.
22578
22579
22580 .option mailstore_format appendfile boolean false
22581 .cindex "mailstore format" "specifying"
22582 If this option is set with the &%directory%& option, the delivery is into two
22583 new files in  &"mailstore"& format. The option is available only if
22584 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22585 below for further details.
22586
22587
22588 .option mailstore_prefix appendfile string&!! unset
22589 This option applies only to deliveries in mailstore format, and is described in
22590 section &<<SECTopdir>>& below.
22591
22592
22593 .option mailstore_suffix appendfile string&!! unset
22594 This option applies only to deliveries in mailstore format, and is described in
22595 section &<<SECTopdir>>& below.
22596
22597
22598 .option mbx_format appendfile boolean false
22599 .cindex "locking files"
22600 .cindex "file" "locking"
22601 .cindex "file" "MBX format"
22602 .cindex "MBX format, specifying"
22603 This option is available only if Exim has been compiled with SUPPORT_MBX
22604 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22605 the message is appended to the mailbox file in MBX format instead of
22606 traditional Unix format. This format is supported by Pine4 and its associated
22607 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22608
22609 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22610 automatically changed by the use of &%mbx_format%&. They should normally be set
22611 empty when using MBX format, so this option almost always appears in this
22612 combination:
22613 .code
22614 mbx_format = true
22615 message_prefix =
22616 message_suffix =
22617 .endd
22618 If none of the locking options are mentioned in the configuration,
22619 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22620 is possible to specify the other kinds of locking with &%mbx_format%&, but
22621 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22622 interworks with &'c-client'&, providing for shared access to the mailbox. It
22623 should not be used if any program that does not use this form of locking is
22624 going to access the mailbox, nor should it be used if the mailbox file is NFS
22625 mounted, because it works only when the mailbox is accessed from a single host.
22626
22627 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22628 the standard version of &'c-client'&, because as long as it has a mailbox open
22629 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22630 append messages to it.
22631
22632
22633 .option message_prefix appendfile string&!! "see below"
22634 .cindex "&""From""& line"
22635 The string specified here is expanded and output at the start of every message.
22636 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22637 in which case it is:
22638 .code
22639 message_prefix = "From ${if def:return_path{$return_path}\
22640   {MAILER-DAEMON}} $tod_bsdinbox\n"
22641 .endd
22642 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22643 &`\n`& to &`\r\n`& in &%message_prefix%&.
22644
22645 .option message_suffix appendfile string&!! "see below"
22646 The string specified here is expanded and output at the end of every message.
22647 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22648 in which case it is a single newline character. The suffix can be suppressed by
22649 setting
22650 .code
22651 message_suffix =
22652 .endd
22653 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22654 &`\n`& to &`\r\n`& in &%message_suffix%&.
22655
22656 .option mode appendfile "octal integer" 0600
22657 If the output file is created, it is given this mode. If it already exists and
22658 has wider permissions, they are reduced to this mode. If it has narrower
22659 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22660 if the delivery is the result of a &%save%& command in a filter file specifying
22661 a particular mode, the mode of the output file is always forced to take that
22662 value, and this option is ignored.
22663
22664
22665 .option mode_fail_narrower appendfile boolean true
22666 This option applies in the case when an existing mailbox file has a narrower
22667 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22668 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22669 continues with the delivery attempt, using the existing mode of the file.
22670
22671
22672 .option notify_comsat appendfile boolean false
22673 If this option is true, the &'comsat'& daemon is notified after every
22674 successful delivery to a user mailbox. This is the daemon that notifies logged
22675 on users about incoming mail.
22676
22677
22678 .option quota appendfile string&!! unset
22679 .cindex "quota" "imposed by Exim"
22680 This option imposes a limit on the size of the file to which Exim is appending,
22681 or to the total space used in the directory tree when the &%directory%& option
22682 is set. In the latter case, computation of the space used is expensive, because
22683 all the files in the directory (and any sub-directories) have to be
22684 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22685 &%maildir_use_size_file%& for ways to avoid this in environments where users
22686 have no shell access to their mailboxes).
22687
22688 As there is no interlock against two simultaneous deliveries into a
22689 multi-file mailbox, it is possible for the quota to be overrun in this case.
22690 For single-file mailboxes, of course, an interlock is a necessity.
22691
22692 A file's size is taken as its &'used'& value. Because of blocking effects, this
22693 may be a lot less than the actual amount of disk space allocated to the file.
22694 If the sizes of a number of files are being added up, the rounding effect can
22695 become quite noticeable, especially on systems that have large block sizes.
22696 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22697 the obvious value which users understand most easily.
22698
22699 The value of the option is expanded, and must then be a numerical value
22700 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22701 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22702 and further option modifiers. If Exim is running on a system with
22703 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22704 be handled.
22705
22706 The option modifier &%no_check%& can be used to force delivery even if the over
22707 quota condition is met. The quota gets updated as usual.
22708
22709 &*Note*&: A value of zero is interpreted as &"no quota"&.
22710
22711 The expansion happens while Exim is running as root, before it changes uid for
22712 the delivery. This means that files that are inaccessible to the end user can
22713 be used to hold quota values that are looked up in the expansion. When delivery
22714 fails because this quota is exceeded, the handling of the error is as for
22715 system quota failures.
22716
22717 By default, Exim's quota checking mimics system quotas, and restricts the
22718 mailbox to the specified maximum size, though the value is not accurate to the
22719 last byte, owing to separator lines and additional headers that may get added
22720 during message delivery. When a mailbox is nearly full, large messages may get
22721 refused even though small ones are accepted, because the size of the current
22722 message is added to the quota when the check is made. This behaviour can be
22723 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22724 for exceeding the quota does not include the current message. Thus, deliveries
22725 continue until the quota has been exceeded; thereafter, no further messages are
22726 delivered. See also &%quota_warn_threshold%&.
22727
22728
22729 .option quota_directory appendfile string&!! unset
22730 This option defines the directory to check for quota purposes when delivering
22731 into individual files. The default is the delivery directory, or, if a file
22732 called &_maildirfolder_& exists in a maildir directory, the parent of the
22733 delivery directory.
22734
22735
22736 .option quota_filecount appendfile string&!! 0
22737 This option applies when the &%directory%& option is set. It limits the total
22738 number of files in the directory (compare the inode limit in system quotas). It
22739 can only be used if &%quota%& is also set. The value is expanded; an expansion
22740 failure causes delivery to be deferred. A value of zero is interpreted as
22741 &"no quota"&.
22742
22743 The option modifier &%no_check%& can be used to force delivery even if the over
22744 quota condition is met. The quota gets updated as usual.
22745
22746 .option quota_is_inclusive appendfile boolean true
22747 See &%quota%& above.
22748
22749
22750 .option quota_size_regex appendfile string unset
22751 This option applies when one of the delivery modes that writes a separate file
22752 for each message is being used. When Exim wants to find the size of one of
22753 these files in order to test the quota, it first checks &%quota_size_regex%&.
22754 If this is set to a regular expression that matches the filename, and it
22755 captures one string, that string is interpreted as a representation of the
22756 file's size. The value of &%quota_size_regex%& is not expanded.
22757
22758 This feature is useful only when users have no shell access to their mailboxes
22759 &-- otherwise they could defeat the quota simply by renaming the files. This
22760 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22761 the file length to the filename. For example:
22762 .code
22763 maildir_tag = ,S=$message_size
22764 quota_size_regex = ,S=(\d+)
22765 .endd
22766 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22767 number of lines in the message.
22768
22769 The regular expression should not assume that the length is at the end of the
22770 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22771 sometimes add other information onto the ends of message filenames.
22772
22773 Section &<<SECID136>>& contains further information.
22774
22775
22776 .option quota_warn_message appendfile string&!! "see below"
22777 See below for the use of this option. If it is not set when
22778 &%quota_warn_threshold%& is set, it defaults to
22779 .code
22780 quota_warn_message = "\
22781   To: $local_part@$domain\n\
22782   Subject: Your mailbox\n\n\
22783   This message is automatically created \
22784   by mail delivery software.\n\n\
22785   The size of your mailbox has exceeded \
22786   a warning threshold that is\n\
22787   set by the system administrator.\n"
22788 .endd
22789
22790
22791 .option quota_warn_threshold appendfile string&!! 0
22792 .cindex "quota" "warning threshold"
22793 .cindex "mailbox" "size warning"
22794 .cindex "size" "of mailbox"
22795 This option is expanded in the same way as &%quota%& (see above). If the
22796 resulting value is greater than zero, and delivery of the message causes the
22797 size of the file or total space in the directory tree to cross the given
22798 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22799 may be specified as a percentage of it by following the value with a percent
22800 sign. For example:
22801 .code
22802 quota = 10M
22803 quota_warn_threshold = 75%
22804 .endd
22805 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22806 percent sign is ignored.
22807
22808 The warning message itself is specified by the &%quota_warn_message%& option,
22809 and it must start with a &'To:'& header line containing the recipient(s) of the
22810 warning message. These do not necessarily have to include the recipient(s) of
22811 the original message. A &'Subject:'& line should also normally be supplied. You
22812 can include any other header lines that you want. If you do not include a
22813 &'From:'& line, the default is:
22814 .code
22815 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22816 .endd
22817 .oindex &%errors_reply_to%&
22818 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22819 option.
22820
22821 The &%quota%& option does not have to be set in order to use this option; they
22822 are independent of one another except when the threshold is specified as a
22823 percentage.
22824
22825
22826 .option use_bsmtp appendfile boolean false
22827 .cindex "envelope from"
22828 .cindex "envelope sender"
22829 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22830 format, with the envelope sender and recipient(s) included as SMTP commands. If
22831 you want to include a leading HELO command with such messages, you can do
22832 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22833 for details of batch SMTP.
22834
22835
22836 .option use_crlf appendfile boolean false
22837 .cindex "carriage return"
22838 .cindex "linefeed"
22839 This option causes lines to be terminated with the two-character CRLF sequence
22840 (carriage return, linefeed) instead of just a linefeed character. In the case
22841 of batched SMTP, the byte sequence written to the file is then an exact image
22842 of what would be sent down a real SMTP connection.
22843
22844 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22845 (which are used to supply the traditional &"From&~"& and blank line separators
22846 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22847 carriage return characters if these are needed. In cases where these options
22848 have non-empty defaults, the values end with a single linefeed, so they must be
22849 changed to end with &`\r\n`& if &%use_crlf%& is set.
22850
22851
22852 .option use_fcntl_lock appendfile boolean "see below"
22853 This option controls the use of the &[fcntl()]& function to lock a file for
22854 exclusive use when a message is being appended. It is set by default unless
22855 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22856 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22857 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22858
22859
22860 .option use_flock_lock appendfile boolean false
22861 This option is provided to support the use of &[flock()]& for file locking, for
22862 the few situations where it is needed. Most modern operating systems support
22863 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22864 each other. Exim uses &[fcntl()]& locking by default.
22865
22866 This option is required only if you are using an operating system where
22867 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22868 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22869 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22870
22871 .cindex "Solaris" "&[flock()]& support"
22872 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22873 have it (and some, I think, provide a not quite right version built on top of
22874 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22875 the ability to use it, and any attempt to do so will cause a configuration
22876 error.
22877
22878 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22879 is just being mapped onto &[fcntl()]& by the OS).
22880
22881
22882 .option use_lockfile appendfile boolean "see below"
22883 If this option is turned off, Exim does not attempt to create a lock file when
22884 appending to a mailbox file. In this situation, the only locking is by
22885 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22886 sure that every MUA that is ever going to look at your users' mailboxes uses
22887 &[fcntl()]& rather than a lock file, and even then only when you are not
22888 delivering over NFS from more than one host.
22889
22890 .cindex "NFS" "lock file"
22891 In order to append to an NFS file safely from more than one host, it is
22892 necessary to take out a lock &'before'& opening the file, and the lock file
22893 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22894 file corruption.
22895
22896 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22897 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22898 except when &%mbx_format%& is set.
22899
22900
22901 .option use_mbx_lock appendfile boolean "see below"
22902 This option is available only if Exim has been compiled with SUPPORT_MBX
22903 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22904 locking rules be used. It is set by default if &%mbx_format%& is set and none
22905 of the locking options are mentioned in the configuration. The locking rules
22906 are the same as are used by the &'c-client'& library that underlies Pine and
22907 the IMAP4 and POP daemons that come with it (see the discussion below). The
22908 rules allow for shared access to the mailbox. However, this kind of locking
22909 does not work when the mailbox is NFS mounted.
22910
22911 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22912 &%use_flock_lock%& to control what kind of locking is used in implementing the
22913 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22914 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22915
22916
22917
22918
22919 .section "Operational details for appending" "SECTopappend"
22920 .cindex "appending to a file"
22921 .cindex "file" "appending"
22922 Before appending to a file, the following preparations are made:
22923
22924 .ilist
22925 If the name of the file is &_/dev/null_&, no action is taken, and a success
22926 return is given.
22927
22928 .next
22929 .cindex "directory creation"
22930 If any directories on the file's path are missing, Exim creates them if the
22931 &%create_directory%& option is set. A created directory's mode is given by the
22932 &%directory_mode%& option.
22933
22934 .next
22935 If &%file_format%& is set, the format of an existing file is checked. If this
22936 indicates that a different transport should be used, control is passed to that
22937 transport.
22938
22939 .next
22940 .cindex "file" "locking"
22941 .cindex "locking files"
22942 .cindex "NFS" "lock file"
22943 If &%use_lockfile%& is set, a lock file is built in a way that will work
22944 reliably over NFS, as follows:
22945
22946 .olist
22947 Create a &"hitching post"& file whose name is that of the lock file with the
22948 current time, primary host name, and process id added, by opening for writing
22949 as a new file. If this fails with an access error, delivery is deferred.
22950 .next
22951 Close the hitching post file, and hard link it to the lock filename.
22952 .next
22953 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22954 Unlink the hitching post name.
22955 .next
22956 Otherwise, use &[stat()]& to get information about the hitching post file, and
22957 then unlink hitching post name. If the number of links is exactly two, creation
22958 of the lock file succeeded but something (for example, an NFS server crash and
22959 restart) caused this fact not to be communicated to the &[link()]& call.
22960 .next
22961 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22962 up to &%lock_retries%& times. However, since any program that writes to a
22963 mailbox should complete its task very quickly, it is reasonable to time out old
22964 lock files that are normally the result of user agent and system crashes. If an
22965 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22966 it before trying again.
22967 .endlist olist
22968
22969 .next
22970 A call is made to &[lstat()]& to discover whether the main file exists, and if
22971 so, what its characteristics are. If &[lstat()]& fails for any reason other
22972 than non-existence, delivery is deferred.
22973
22974 .next
22975 .cindex "symbolic link" "to mailbox"
22976 .cindex "mailbox" "symbolic link"
22977 If the file does exist and is a symbolic link, delivery is deferred, unless the
22978 &%allow_symlink%& option is set, in which case the ownership of the link is
22979 checked, and then &[stat()]& is called to find out about the real file, which
22980 is then subjected to the checks below. The check on the top-level link
22981 ownership prevents one user creating a link for another's mailbox in a sticky
22982 directory, though allowing symbolic links in this case is definitely not a good
22983 idea. If there is a chain of symbolic links, the intermediate ones are not
22984 checked.
22985
22986 .next
22987 If the file already exists but is not a regular file, or if the file's owner
22988 and group (if the group is being checked &-- see &%check_group%& above) are
22989 different from the user and group under which the delivery is running,
22990 delivery is deferred.
22991
22992 .next
22993 If the file's permissions are more generous than specified, they are reduced.
22994 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22995 is set false, in which case the delivery is tried using the existing
22996 permissions.
22997
22998 .next
22999 The file's inode number is saved, and the file is then opened for appending.
23000 If this fails because the file has vanished, &(appendfile)& behaves as if it
23001 hadn't existed (see below). For any other failures, delivery is deferred.
23002
23003 .next
23004 If the file is opened successfully, check that the inode number hasn't
23005 changed, that it is still a regular file, and that the owner and permissions
23006 have not changed. If anything is wrong, defer delivery and freeze the message.
23007
23008 .next
23009 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23010 option is set. Otherwise, check that the file is being created in a permitted
23011 directory if the &%create_file%& option is set (deferring on failure), and then
23012 open for writing as a new file, with the O_EXCL and O_CREAT options,
23013 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23014 set). In this case, which can happen if the link points to a non-existent file,
23015 the file is opened for writing using O_CREAT but not O_EXCL, because
23016 that prevents link following.
23017
23018 .next
23019 .cindex "loop" "while file testing"
23020 If opening fails because the file exists, obey the tests given above for
23021 existing files. However, to avoid looping in a situation where the file is
23022 being continuously created and destroyed, the exists/not-exists loop is broken
23023 after 10 repetitions, and the message is then frozen.
23024
23025 .next
23026 If opening fails with any other error, defer delivery.
23027
23028 .next
23029 .cindex "file" "locking"
23030 .cindex "locking files"
23031 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23032 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23033 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23034 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23035 file, and an exclusive lock on the file whose name is
23036 .code
23037 /tmp/.<device-number>.<inode-number>
23038 .endd
23039 using the device and inode numbers of the open mailbox file, in accordance with
23040 the MBX locking rules. This file is created with a mode that is specified by
23041 the &%lockfile_mode%& option.
23042
23043 If Exim fails to lock the file, there are two possible courses of action,
23044 depending on the value of the locking timeout. This is obtained from
23045 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23046
23047 If the timeout value is zero, the file is closed, Exim waits for
23048 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23049 to lock it again. This happens up to &%lock_retries%& times, after which the
23050 delivery is deferred.
23051
23052 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23053 &[flock()]& are used (with the given timeout), so there has already been some
23054 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23055 immediately. It retries up to
23056 .code
23057 (lock_retries * lock_interval) / <timeout>
23058 .endd
23059 times (rounded up).
23060 .endlist
23061
23062 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23063 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23064
23065
23066 .section "Operational details for delivery to a new file" "SECTopdir"
23067 .cindex "delivery" "to single file"
23068 .cindex "&""From""& line"
23069 When the &%directory%& option is set instead of &%file%&, each message is
23070 delivered into a newly-created file or set of files. When &(appendfile)& is
23071 activated directly from a &(redirect)& router, neither &%file%& nor
23072 &%directory%& is normally set, because the path for delivery is supplied by the
23073 router. (See for example, the &(address_file)& transport in the default
23074 configuration.) In this case, delivery is to a new file if either the path name
23075 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23076
23077 No locking is required while writing the message to a new file, so the various
23078 locking options of the transport are ignored. The &"From"& line that by default
23079 separates messages in a single file is not normally needed, nor is the escaping
23080 of message lines that start with &"From"&, and there is no need to ensure a
23081 newline at the end of each message. Consequently, the default values for
23082 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23083 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23084
23085 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23086 the files in the delivery directory by default. However, you can specify a
23087 different directory by setting &%quota_directory%&. Also, for maildir
23088 deliveries (see below) the &_maildirfolder_& convention is honoured.
23089
23090
23091 .cindex "maildir format"
23092 .cindex "mailstore format"
23093 There are three different ways in which delivery to individual files can be
23094 done, controlled by the settings of the &%maildir_format%& and
23095 &%mailstore_format%& options. Note that code to support maildir or mailstore
23096 formats is not included in the binary unless SUPPORT_MAILDIR or
23097 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23098
23099 .cindex "directory creation"
23100 In all three cases an attempt is made to create the directory and any necessary
23101 sub-directories if they do not exist, provided that the &%create_directory%&
23102 option is set (the default). The location of a created directory can be
23103 constrained by setting &%create_file%&. A created directory's mode is given by
23104 the &%directory_mode%& option. If creation fails, or if the
23105 &%create_directory%& option is not set when creation is required, delivery is
23106 deferred.
23107
23108
23109
23110 .section "Maildir delivery" "SECTmaildirdelivery"
23111 .cindex "maildir format" "description of"
23112 If the &%maildir_format%& option is true, Exim delivers each message by writing
23113 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23114 directory that is defined by the &%directory%& option (the &"delivery
23115 directory"&). If the delivery is successful, the file is renamed into the
23116 &_new_& subdirectory.
23117
23118 In the filename, <&'stime'&> is the current time of day in seconds, and
23119 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23120 Exim checks that the time-of-day clock has moved on by at least one microsecond
23121 before terminating the delivery process. This guarantees uniqueness for the
23122 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23123 opening it. If any response other than ENOENT (does not exist) is given,
23124 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23125
23126 Before Exim carries out a maildir delivery, it ensures that subdirectories
23127 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23128 do not exist, Exim tries to create them and any superior directories in their
23129 path, subject to the &%create_directory%& and &%create_file%& options. If the
23130 &%maildirfolder_create_regex%& option is set, and the regular expression it
23131 contains matches the delivery directory, Exim also ensures that a file called
23132 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23133 &_maildirfolder_& file cannot be created, delivery is deferred.
23134
23135 These features make it possible to use Exim to create all the necessary files
23136 and directories in a maildir mailbox, including subdirectories for maildir++
23137 folders. Consider this example:
23138 .code
23139 maildir_format = true
23140 directory = /var/mail/$local_part\
23141            ${if eq{$local_part_suffix}{}{}\
23142            {/.${substr_1:$local_part_suffix}}}
23143 maildirfolder_create_regex = /\.[^/]+$
23144 .endd
23145 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23146 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23147 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23148 not match this name, so Exim will not look for or create the file
23149 &_/var/mail/pimbo/maildirfolder_&, though it will create
23150 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23151
23152 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23153 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23154 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23155 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23156 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23157
23158 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23159 not inadvertently match the toplevel maildir directory, because a
23160 &_maildirfolder_& file at top level would completely break quota calculations.
23161
23162 .cindex "quota" "in maildir delivery"
23163 .cindex "maildir++"
23164 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23165 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23166 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23167 Exim assumes the directory is a maildir++ folder directory, which is one level
23168 down from the user's top level mailbox directory. This causes it to start at
23169 the parent directory instead of the current directory when calculating the
23170 amount of space used.
23171
23172 One problem with delivering into a multi-file mailbox is that it is
23173 computationally expensive to compute the size of the mailbox for quota
23174 checking. Various approaches have been taken to reduce the amount of work
23175 needed. The next two sections describe two of them. A third alternative is to
23176 use some external process for maintaining the size data, and use the expansion
23177 of the &%mailbox_size%& option as a way of importing it into Exim.
23178
23179
23180
23181
23182 .section "Using tags to record message sizes" "SECID135"
23183 If &%maildir_tag%& is set, the string is expanded for each delivery.
23184 When the maildir file is renamed into the &_new_& sub-directory, the
23185 tag is added to its name. However, if adding the tag takes the length of the
23186 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23187 the tag is dropped and the maildir file is created with no tag.
23188
23189
23190 .vindex "&$message_size$&"
23191 Tags can be used to encode the size of files in their names; see
23192 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23193 happens after the message has been written. The value of the &$message_size$&
23194 variable is set to the number of bytes actually written. If the expansion is
23195 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23196 be deferred. The expanded tag may contain any printing characters except &"/"&.
23197 Non-printing characters in the string are ignored; if the resulting string is
23198 empty, it is ignored. If it starts with an alphanumeric character, a leading
23199 colon is inserted; this default has not proven to be the path that popular
23200 maildir implementations have chosen (but changing it in Exim would break
23201 backwards compatibility).
23202
23203 For one common implementation, you might set:
23204 .code
23205 maildir_tag = ,S=${message_size}
23206 .endd
23207 but you should check the documentation of the other software to be sure.
23208
23209 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23210 as this allows Exim to extract the size from your tag, instead of having to
23211 &[stat()]& each message file.
23212
23213
23214 .section "Using a maildirsize file" "SECID136"
23215 .cindex "quota" "in maildir delivery"
23216 .cindex "maildir format" "&_maildirsize_& file"
23217 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23218 storing quota and message size information in a file called &_maildirsize_&
23219 within the toplevel maildir directory. If this file does not exist, Exim
23220 creates it, setting the quota from the &%quota%& option of the transport. If
23221 the maildir directory itself does not exist, it is created before any attempt
23222 to write a &_maildirsize_& file.
23223
23224 The &_maildirsize_& file is used to hold information about the sizes of
23225 messages in the maildir, thus speeding up quota calculations. The quota value
23226 in the file is just a cache; if the quota is changed in the transport, the new
23227 value overrides the cached value when the next message is delivered. The cache
23228 is maintained for the benefit of other programs that access the maildir and
23229 need to know the quota.
23230
23231 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23232 file is maintained (with a zero quota setting), but no quota is imposed.
23233
23234 A regular expression is available for controlling which directories in the
23235 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23236 See the description of the &%maildir_quota_directory_regex%& option above for
23237 details.
23238
23239
23240 .section "Mailstore delivery" "SECID137"
23241 .cindex "mailstore format" "description of"
23242 If the &%mailstore_format%& option is true, each message is written as two
23243 files in the given directory. A unique base name is constructed from the
23244 message id and the current delivery process, and the files that are written use
23245 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23246 contains the message's envelope, and the &_.msg_& file contains the message
23247 itself. The base name is placed in the variable &$mailstore_basename$&.
23248
23249 During delivery, the envelope is first written to a file with the suffix
23250 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23251 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23252 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23253 file before accessing either of them. An alternative approach is to wait for
23254 the absence of a &_.tmp_& file.
23255
23256 The envelope file starts with any text defined by the &%mailstore_prefix%&
23257 option, expanded and terminated by a newline if there isn't one. Then follows
23258 the sender address on one line, then all the recipient addresses, one per line.
23259 There can be more than one recipient only if the &%batch_max%& option is set
23260 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23261 appended to the file, followed by a newline if it does not end with one.
23262
23263 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23264 failure, it is ignored. Other expansion errors are treated as serious
23265 configuration errors, and delivery is deferred. The variable
23266 &$mailstore_basename$& is available for use during these expansions.
23267
23268
23269 .section "Non-special new file delivery" "SECID138"
23270 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23271 file is created directly in the named directory. For example, when delivering
23272 messages into files in batched SMTP format for later delivery to some host (see
23273 section &<<SECTbatchSMTP>>&), a setting such as
23274 .code
23275 directory = /var/bsmtp/$host
23276 .endd
23277 might be used. A message is written to a file with a temporary name, which is
23278 then renamed when the delivery is complete. The final name is obtained by
23279 expanding the contents of the &%directory_file%& option.
23280 .ecindex IIDapptra1
23281 .ecindex IIDapptra2
23282
23283
23284
23285
23286
23287
23288 . ////////////////////////////////////////////////////////////////////////////
23289 . ////////////////////////////////////////////////////////////////////////////
23290
23291 .chapter "The autoreply transport" "CHID8"
23292 .scindex IIDauttra1 "transports" "&(autoreply)&"
23293 .scindex IIDauttra2 "&(autoreply)& transport"
23294 The &(autoreply)& transport is not a true transport in that it does not cause
23295 the message to be transmitted. Instead, it generates a new mail message as an
23296 automatic reply to the incoming message. &'References:'& and
23297 &'Auto-Submitted:'& header lines are included. These are constructed according
23298 to the rules in RFCs 2822 and 3834, respectively.
23299
23300 If the router that passes the message to this transport does not have the
23301 &%unseen%& option set, the original message (for the current recipient) is not
23302 delivered anywhere. However, when the &%unseen%& option is set on the router
23303 that passes the message to this transport, routing of the address continues, so
23304 another router can set up a normal message delivery.
23305
23306
23307 The &(autoreply)& transport is usually run as the result of mail filtering, a
23308 &"vacation"& message being the standard example. However, it can also be run
23309 directly from a router like any other transport. To reduce the possibility of
23310 message cascades, messages created by the &(autoreply)& transport always have
23311 empty envelope sender addresses, like bounce messages.
23312
23313 The parameters of the message to be sent can be specified in the configuration
23314 by options described below. However, these are used only when the address
23315 passed to the transport does not contain its own reply information. When the
23316 transport is run as a consequence of a
23317 &%mail%&
23318 or &%vacation%& command in a filter file, the parameters of the message are
23319 supplied by the filter, and passed with the address. The transport's options
23320 that define the message are then ignored (so they are not usually set in this
23321 case). The message is specified entirely by the filter or by the transport; it
23322 is never built from a mixture of options. However, the &%file_optional%&,
23323 &%mode%&, and &%return_message%& options apply in all cases.
23324
23325 &(Autoreply)& is implemented as a local transport. When used as a result of a
23326 command in a user's filter file, &(autoreply)& normally runs under the uid and
23327 gid of the user, and with appropriate current and home directories (see chapter
23328 &<<CHAPenvironment>>&).
23329
23330 There is a subtle difference between routing a message to a &(pipe)& transport
23331 that generates some text to be returned to the sender, and routing it to an
23332 &(autoreply)& transport. This difference is noticeable only if more than one
23333 address from the same message is so handled. In the case of a pipe, the
23334 separate outputs from the different addresses are gathered up and returned to
23335 the sender in a single message, whereas if &(autoreply)& is used, a separate
23336 message is generated for each address that is passed to it.
23337
23338 Non-printing characters are not permitted in the header lines generated for the
23339 message that &(autoreply)& creates, with the exception of newlines that are
23340 immediately followed by white space. If any non-printing characters are found,
23341 the transport defers.
23342 Whether characters with the top bit set count as printing characters or not is
23343 controlled by the &%print_topbitchars%& global option.
23344
23345 If any of the generic options for manipulating headers (for example,
23346 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23347 of the original message that is included in the generated message when
23348 &%return_message%& is set. They do not apply to the generated message itself.
23349
23350 .vindex "&$sender_address$&"
23351 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23352 the message, indicating that there were no recipients, it does not treat this
23353 as an error. This means that autoreplies sent to &$sender_address$& when this
23354 is empty (because the incoming message is a bounce message) do not cause
23355 problems. They are just discarded.
23356
23357
23358
23359 .section "Private options for autoreply" "SECID139"
23360 .cindex "options" "&(autoreply)& transport"
23361
23362 .option bcc autoreply string&!! unset
23363 This specifies the addresses that are to receive &"blind carbon copies"& of the
23364 message when the message is specified by the transport.
23365
23366
23367 .option cc autoreply string&!! unset
23368 This specifies recipients of the message and the contents of the &'Cc:'& header
23369 when the message is specified by the transport.
23370
23371
23372 .option file autoreply string&!! unset
23373 The contents of the file are sent as the body of the message when the message
23374 is specified by the transport. If both &%file%& and &%text%& are set, the text
23375 string comes first.
23376
23377
23378 .option file_expand autoreply boolean false
23379 If this is set, the contents of the file named by the &%file%& option are
23380 subjected to string expansion as they are added to the message.
23381
23382
23383 .option file_optional autoreply boolean false
23384 If this option is true, no error is generated if the file named by the &%file%&
23385 option or passed with the address does not exist or cannot be read.
23386
23387
23388 .option from autoreply string&!! unset
23389 This specifies the contents of the &'From:'& header when the message is
23390 specified by the transport.
23391
23392
23393 .option headers autoreply string&!! unset
23394 This specifies additional RFC 2822 headers that are to be added to the message
23395 when the message is specified by the transport. Several can be given by using
23396 &"\n"& to separate them. There is no check on the format.
23397
23398
23399 .option log autoreply string&!! unset
23400 This option names a file in which a record of every message sent is logged when
23401 the message is specified by the transport.
23402
23403
23404 .option mode autoreply "octal integer" 0600
23405 If either the log file or the &"once"& file has to be created, this mode is
23406 used.
23407
23408
23409 .option never_mail autoreply "address list&!!" unset
23410 If any run of the transport creates a message with a recipient that matches any
23411 item in the list, that recipient is quietly discarded. If all recipients are
23412 discarded, no message is created. This applies both when the recipients are
23413 generated by a filter and when they are specified in the transport.
23414
23415
23416
23417 .option once autoreply string&!! unset
23418 This option names a file or DBM database in which a record of each &'To:'&
23419 recipient is kept when the message is specified by the transport. &*Note*&:
23420 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23421
23422 If &%once%& is unset, or is set to an empty string, the message is always sent.
23423 By default, if &%once%& is set to a non-empty filename, the message
23424 is not sent if a potential recipient is already listed in the database.
23425 However, if the &%once_repeat%& option specifies a time greater than zero, the
23426 message is sent if that much time has elapsed since a message was last sent to
23427 this recipient. A setting of zero time for &%once_repeat%& (the default)
23428 prevents a message from being sent a second time &-- in this case, zero means
23429 infinity.
23430
23431 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23432 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23433 greater than zero, it changes the way Exim implements the &%once%& option.
23434 Instead of using a DBM file to record every recipient it sends to, it uses a
23435 regular file, whose size will never get larger than the given value.
23436
23437 In the file, Exim keeps a linear list of recipient addresses and the times at
23438 which they were sent messages. If the file is full when a new address needs to
23439 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23440 means that a given recipient may receive multiple messages, but at
23441 unpredictable intervals that depend on the rate of turnover of addresses in the
23442 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23443
23444
23445 .option once_file_size autoreply integer 0
23446 See &%once%& above.
23447
23448
23449 .option once_repeat autoreply time&!! 0s
23450 See &%once%& above.
23451 After expansion, the value of this option must be a valid time value.
23452
23453
23454 .option reply_to autoreply string&!! unset
23455 This specifies the contents of the &'Reply-To:'& header when the message is
23456 specified by the transport.
23457
23458
23459 .option return_message autoreply boolean false
23460 If this is set, a copy of the original message is returned with the new
23461 message, subject to the maximum size set in the &%return_size_limit%& global
23462 configuration option.
23463
23464
23465 .option subject autoreply string&!! unset
23466 This specifies the contents of the &'Subject:'& header when the message is
23467 specified by the transport. It is tempting to quote the original subject in
23468 automatic responses. For example:
23469 .code
23470 subject = Re: $h_subject:
23471 .endd
23472 There is a danger in doing this, however. It may allow a third party to
23473 subscribe your users to an opt-in mailing list, provided that the list accepts
23474 bounce messages as subscription confirmations. Well-managed lists require a
23475 non-bounce message to confirm a subscription, so the danger is relatively
23476 small.
23477
23478
23479
23480 .option text autoreply string&!! unset
23481 This specifies a single string to be used as the body of the message when the
23482 message is specified by the transport. If both &%text%& and &%file%& are set,
23483 the text comes first.
23484
23485
23486 .option to autoreply string&!! unset
23487 This specifies recipients of the message and the contents of the &'To:'& header
23488 when the message is specified by the transport.
23489 .ecindex IIDauttra1
23490 .ecindex IIDauttra2
23491
23492
23493
23494
23495 . ////////////////////////////////////////////////////////////////////////////
23496 . ////////////////////////////////////////////////////////////////////////////
23497
23498 .chapter "The lmtp transport" "CHAPLMTP"
23499 .cindex "transports" "&(lmtp)&"
23500 .cindex "&(lmtp)& transport"
23501 .cindex "LMTP" "over a pipe"
23502 .cindex "LMTP" "over a socket"
23503 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23504 specified command
23505 or by interacting with a Unix domain socket.
23506 This transport is something of a cross between the &(pipe)& and &(smtp)&
23507 transports. Exim also has support for using LMTP over TCP/IP; this is
23508 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23509 to be of minority interest, the default build-time configure in &_src/EDITME_&
23510 has it commented out. You need to ensure that
23511 .code
23512 TRANSPORT_LMTP=yes
23513 .endd
23514 .cindex "options" "&(lmtp)& transport"
23515 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23516 included in the Exim binary. The private options of the &(lmtp)& transport are
23517 as follows:
23518
23519 .option batch_id lmtp string&!! unset
23520 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23521
23522
23523 .option batch_max lmtp integer 1
23524 This limits the number of addresses that can be handled in a single delivery.
23525 Most LMTP servers can handle several addresses at once, so it is normally a
23526 good idea to increase this value. See the description of local delivery
23527 batching in chapter &<<CHAPbatching>>&.
23528
23529
23530 .option command lmtp string&!! unset
23531 This option must be set if &%socket%& is not set. The string is a command which
23532 is run in a separate process. It is split up into a command name and list of
23533 arguments, each of which is separately expanded (so expansion cannot change the
23534 number of arguments). The command is run directly, not via a shell. The message
23535 is passed to the new process using the standard input and output to operate the
23536 LMTP protocol.
23537
23538 .option ignore_quota lmtp boolean false
23539 .cindex "LMTP" "ignoring quota errors"
23540 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23541 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23542 in its response to the LHLO command.
23543
23544 .option socket lmtp string&!! unset
23545 This option must be set if &%command%& is not set. The result of expansion must
23546 be the name of a Unix domain socket. The transport connects to the socket and
23547 delivers the message to it using the LMTP protocol.
23548
23549
23550 .option timeout lmtp time 5m
23551 The transport is aborted if the created process or Unix domain socket does not
23552 respond to LMTP commands or message input within this timeout. Delivery
23553 is deferred, and will be tried again later. Here is an example of a typical
23554 LMTP transport:
23555 .code
23556 lmtp:
23557   driver = lmtp
23558   command = /some/local/lmtp/delivery/program
23559   batch_max = 20
23560   user = exim
23561 .endd
23562 This delivers up to 20 addresses at a time, in a mixture of domains if
23563 necessary, running as the user &'exim'&.
23564
23565
23566
23567 . ////////////////////////////////////////////////////////////////////////////
23568 . ////////////////////////////////////////////////////////////////////////////
23569
23570 .chapter "The pipe transport" "CHAPpipetransport"
23571 .scindex IIDpiptra1 "transports" "&(pipe)&"
23572 .scindex IIDpiptra2 "&(pipe)& transport"
23573 The &(pipe)& transport is used to deliver messages via a pipe to a command
23574 running in another process. One example is the use of &(pipe)& as a
23575 pseudo-remote transport for passing messages to some other delivery mechanism
23576 (such as UUCP). Another is the use by individual users to automatically process
23577 their incoming messages. The &(pipe)& transport can be used in one of the
23578 following ways:
23579
23580 .ilist
23581 .vindex "&$local_part$&"
23582 A router routes one address to a transport in the normal way, and the
23583 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23584 contains the local part of the address (as usual), and the command that is run
23585 is specified by the &%command%& option on the transport.
23586 .next
23587 .vindex "&$pipe_addresses$&"
23588 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23589 transport can handle more than one address in a single run. In this case, when
23590 more than one address is routed to the transport, &$local_part$& is not set
23591 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23592 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23593 that are routed to the transport.
23594 .next
23595 .vindex "&$address_pipe$&"
23596 A router redirects an address directly to a pipe command (for example, from an
23597 alias or forward file). In this case, &$address_pipe$& contains the text of the
23598 pipe command, and the &%command%& option on the transport is ignored unless
23599 &%force_command%& is set. If only one address is being transported
23600 (&%batch_max%& is not greater than one, or only one address was redirected to
23601 this pipe command), &$local_part$& contains the local part that was redirected.
23602 .endlist
23603
23604
23605 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23606 deliver messages over pipes using the LMTP interactive protocol. This is
23607 implemented by the &(lmtp)& transport.
23608
23609 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23610 &_.forward_& file, the command runs under the uid and gid of that user. In
23611 other cases, the uid and gid have to be specified explicitly, either on the
23612 transport or on the router that handles the address. Current and &"home"&
23613 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23614 details of the local delivery environment and chapter &<<CHAPbatching>>&
23615 for a discussion of local delivery batching.
23616
23617
23618 .section "Concurrent delivery" "SECID140"
23619 If two messages arrive at almost the same time, and both are routed to a pipe
23620 delivery, the two pipe transports may be run concurrently. You must ensure that
23621 any pipe commands you set up are robust against this happening. If the commands
23622 write to a file, the &%exim_lock%& utility might be of use.
23623 Alternatively the &%max_parallel%& option could be used with a value
23624 of "1" to enforce serialization.
23625
23626
23627
23628
23629 .section "Returned status and data" "SECID141"
23630 .cindex "&(pipe)& transport" "returned data"
23631 If the command exits with a non-zero return code, the delivery is deemed to
23632 have failed, unless either the &%ignore_status%& option is set (in which case
23633 the return code is treated as zero), or the return code is one of those listed
23634 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23635 later"&. In this case, delivery is deferred. Details of a permanent failure are
23636 logged, but are not included in the bounce message, which merely contains
23637 &"local delivery failed"&.
23638
23639 If the command exits on a signal and the &%freeze_signal%& option is set then
23640 the message will be frozen in the queue. If that option is not set, a bounce
23641 will be sent as normal.
23642
23643 If the return code is greater than 128 and the command being run is a shell
23644 script, it normally means that the script was terminated by a signal whose
23645 value is the return code minus 128. The &%freeze_signal%& option does not
23646 apply in this case.
23647
23648 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23649 return code is set to 127. This is the value that a shell returns if it is
23650 asked to run a non-existent command. The wording for the log line suggests that
23651 a non-existent command may be the problem.
23652
23653 The &%return_output%& option can affect the result of a pipe delivery. If it is
23654 set and the command produces any output on its standard output or standard
23655 error streams, the command is considered to have failed, even if it gave a zero
23656 return code or if &%ignore_status%& is set. The output from the command is
23657 included as part of the bounce message. The &%return_fail_output%& option is
23658 similar, except that output is returned only when the command exits with a
23659 failure return code, that is, a value other than zero or a code that matches
23660 &%temp_errors%&.
23661
23662
23663
23664 .section "How the command is run" "SECThowcommandrun"
23665 .cindex "&(pipe)& transport" "path for command"
23666 The command line is (by default) broken down into a command name and arguments
23667 by the &(pipe)& transport itself. The &%allow_commands%& and
23668 &%restrict_to_path%& options can be used to restrict the commands that may be
23669 run.
23670
23671 .cindex "quoting" "in pipe command"
23672 Unquoted arguments are delimited by white space. If an argument appears in
23673 double quotes, backslash is interpreted as an escape character in the usual
23674 way. If an argument appears in single quotes, no escaping is done.
23675
23676 String expansion is applied to the command line except when it comes from a
23677 traditional &_.forward_& file (commands from a filter file are expanded). The
23678 expansion is applied to each argument in turn rather than to the whole line.
23679 For this reason, any string expansion item that contains white space must be
23680 quoted so as to be contained within a single argument. A setting such as
23681 .code
23682 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23683 .endd
23684 will not work, because the expansion item gets split between several
23685 arguments. You have to write
23686 .code
23687 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23688 .endd
23689 to ensure that it is all in one argument. The expansion is done in this way,
23690 argument by argument, so that the number of arguments cannot be changed as a
23691 result of expansion, and quotes or backslashes in inserted variables do not
23692 interact with external quoting. However, this leads to problems if you want to
23693 generate multiple arguments (or the command name plus arguments) from a single
23694 expansion. In this situation, the simplest solution is to use a shell. For
23695 example:
23696 .code
23697 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23698 .endd
23699
23700 .cindex "transport" "filter"
23701 .cindex "filter" "transport filter"
23702 .vindex "&$pipe_addresses$&"
23703 Special handling takes place when an argument consists of precisely the text
23704 &`$pipe_addresses`& (no quotes).
23705 This is not a general expansion variable; the only
23706 place this string is recognized is when it appears as an argument for a pipe or
23707 transport filter command. It causes each address that is being handled to be
23708 inserted in the argument list at that point &'as a separate argument'&. This
23709 avoids any problems with spaces or shell metacharacters, and is of use when a
23710 &(pipe)& transport is handling groups of addresses in a batch.
23711
23712 If &%force_command%& is enabled on the transport, special handling takes place
23713 for an argument that consists of precisely the text &`$address_pipe`&.  It
23714 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23715 argument is inserted in the argument list at that point
23716 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23717 the only item in the argument; in fact, if it were then &%force_command%&
23718 should behave as a no-op.  Rather, it should be used to adjust the command
23719 run while preserving the argument vector separation.
23720
23721 After splitting up into arguments and expansion, the resulting command is run
23722 in a subprocess directly from the transport, &'not'& under a shell. The
23723 message that is being delivered is supplied on the standard input, and the
23724 standard output and standard error are both connected to a single pipe that is
23725 read by Exim. The &%max_output%& option controls how much output the command
23726 may produce, and the &%return_output%& and &%return_fail_output%& options
23727 control what is done with it.
23728
23729 Not running the command under a shell (by default) lessens the security risks
23730 in cases when a command from a user's filter file is built out of data that was
23731 taken from an incoming message. If a shell is required, it can of course be
23732 explicitly specified as the command to be run. However, there are circumstances
23733 where existing commands (for example, in &_.forward_& files) expect to be run
23734 under a shell and cannot easily be modified. To allow for these cases, there is
23735 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23736 works. Instead of breaking up the command line as just described, it expands it
23737 as a single string and passes the result to &_/bin/sh_&. The
23738 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23739 with &%use_shell%&, and the whole mechanism is inherently less secure.
23740
23741
23742
23743 .section "Environment variables" "SECTpipeenv"
23744 .cindex "&(pipe)& transport" "environment for command"
23745 .cindex "environment" "&(pipe)& transport"
23746 The environment variables listed below are set up when the command is invoked.
23747 This list is a compromise for maximum compatibility with other MTAs. Note that
23748 the &%environment%& option can be used to add additional variables to this
23749 environment. The environment for the &(pipe)& transport is not subject
23750 to the &%add_environment%& and &%keep_environment%& main config options.
23751 .display
23752 &`DOMAIN            `&   the domain of the address
23753 &`HOME              `&   the home directory, if set
23754 &`HOST              `&   the host name when called from a router (see below)
23755 &`LOCAL_PART        `&   see below
23756 &`LOCAL_PART_PREFIX `&   see below
23757 &`LOCAL_PART_SUFFIX `&   see below
23758 &`LOGNAME           `&   see below
23759 &`MESSAGE_ID        `&   Exim's local ID for the message
23760 &`PATH              `&   as specified by the &%path%& option below
23761 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23762 &`RECIPIENT         `&   the complete recipient address
23763 &`SENDER            `&   the sender of the message (empty if a bounce)
23764 &`SHELL             `&   &`/bin/sh`&
23765 &`TZ                `&   the value of the &%timezone%& option, if set
23766 &`USER              `&   see below
23767 .endd
23768 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23769 router, LOCAL_PART is set to the local part of the address. When it is
23770 called as a result of a forward or alias expansion, LOCAL_PART is set to
23771 the local part of the address that was expanded. In both cases, any affixes are
23772 removed from the local part, and made available in LOCAL_PART_PREFIX and
23773 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23774 same value as LOCAL_PART for compatibility with other MTAs.
23775
23776 .cindex "HOST"
23777 HOST is set only when a &(pipe)& transport is called from a router that
23778 associates hosts with an address, typically when using &(pipe)& as a
23779 pseudo-remote transport. HOST is set to the first host name specified by
23780 the router.
23781
23782 .cindex "HOME"
23783 If the transport's generic &%home_directory%& option is set, its value is used
23784 for the HOME environment variable. Otherwise, a home directory may be set
23785 by the router's &%transport_home_directory%& option, which defaults to the
23786 user's home directory if &%check_local_user%& is set.
23787
23788
23789 .section "Private options for pipe" "SECID142"
23790 .cindex "options" "&(pipe)& transport"
23791
23792
23793
23794 .option allow_commands pipe "string list&!!" unset
23795 .cindex "&(pipe)& transport" "permitted commands"
23796 The string is expanded, and is then interpreted as a colon-separated list of
23797 permitted commands. If &%restrict_to_path%& is not set, the only commands
23798 permitted are those in the &%allow_commands%& list. They need not be absolute
23799 paths; the &%path%& option is still used for relative paths. If
23800 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23801 in the &%allow_commands%& list, or a name without any slashes that is found on
23802 the path. In other words, if neither &%allow_commands%& nor
23803 &%restrict_to_path%& is set, there is no restriction on the command, but
23804 otherwise only commands that are permitted by one or the other are allowed. For
23805 example, if
23806 .code
23807 allow_commands = /usr/bin/vacation
23808 .endd
23809 and &%restrict_to_path%& is not set, the only permitted command is
23810 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23811 &%use_shell%& is set.
23812
23813
23814 .option batch_id pipe string&!! unset
23815 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23816
23817
23818 .option batch_max pipe integer 1
23819 This limits the number of addresses that can be handled in a single delivery.
23820 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23821
23822
23823 .option check_string pipe string unset
23824 As &(pipe)& writes the message, the start of each line is tested for matching
23825 &%check_string%&, and if it does, the initial matching characters are replaced
23826 by the contents of &%escape_string%&, provided both are set. The value of
23827 &%check_string%& is a literal string, not a regular expression, and the case of
23828 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23829 of &%check_string%& and &%escape_string%& are forced to values that implement
23830 the SMTP escaping protocol. Any settings made in the configuration file are
23831 ignored.
23832
23833
23834 .option command pipe string&!! unset
23835 This option need not be set when &(pipe)& is being used to deliver to pipes
23836 obtained directly from address redirections. In other cases, the option must be
23837 set, to provide a command to be run. It need not yield an absolute path (see
23838 the &%path%& option below). The command is split up into separate arguments by
23839 Exim, and each argument is separately expanded, as described in section
23840 &<<SECThowcommandrun>>& above.
23841
23842
23843 .option environment pipe string&!! unset
23844 .cindex "&(pipe)& transport" "environment for command"
23845 .cindex "environment" "&(pipe)& transport"
23846 This option is used to add additional variables to the environment in which the
23847 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23848 a string which is expanded, and then interpreted as a colon-separated list of
23849 environment settings of the form <&'name'&>=<&'value'&>.
23850
23851
23852 .option escape_string pipe string unset
23853 See &%check_string%& above.
23854
23855
23856 .option freeze_exec_fail pipe boolean false
23857 .cindex "exec failure"
23858 .cindex "failure of exec"
23859 .cindex "&(pipe)& transport" "failure of exec"
23860 Failure to exec the command in a pipe transport is by default treated like
23861 any other failure while running the command. However, if &%freeze_exec_fail%&
23862 is set, failure to exec is treated specially, and causes the message to be
23863 frozen, whatever the setting of &%ignore_status%&.
23864
23865
23866 .option freeze_signal pipe boolean false
23867 .cindex "signal exit"
23868 .cindex "&(pipe)& transport", "signal exit"
23869 Normally if the process run by a command in a pipe transport exits on a signal,
23870 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23871 frozen in Exim's queue instead.
23872
23873
23874 .option force_command pipe boolean false
23875 .cindex "force command"
23876 .cindex "&(pipe)& transport", "force command"
23877 Normally when a router redirects an address directly to a pipe command
23878 the &%command%& option on the transport is ignored.  If &%force_command%&
23879 is set, the &%command%& option will used. This is especially
23880 useful for forcing a wrapper or additional argument to be added to the
23881 command. For example:
23882 .code
23883 command = /usr/bin/remote_exec myhost -- $address_pipe
23884 force_command
23885 .endd
23886
23887 Note that &$address_pipe$& is handled specially in &%command%& when
23888 &%force_command%& is set, expanding out to the original argument vector as
23889 separate items, similarly to a Unix shell &`"$@"`& construct.
23890
23891
23892 .option ignore_status pipe boolean false
23893 If this option is true, the status returned by the subprocess that is set up to
23894 run the command is ignored, and Exim behaves as if zero had been returned.
23895 Otherwise, a non-zero status or termination by signal causes an error return
23896 from the transport unless the status value is one of those listed in
23897 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23898
23899 &*Note*&: This option does not apply to timeouts, which do not return a status.
23900 See the &%timeout_defer%& option for how timeouts are handled.
23901
23902
23903 .option log_defer_output pipe boolean false
23904 .cindex "&(pipe)& transport" "logging output"
23905 If this option is set, and the status returned by the command is
23906 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23907 and any output was produced on stdout or stderr, the first line of it is
23908 written to the main log.
23909
23910
23911 .option log_fail_output pipe boolean false
23912 If this option is set, and the command returns any output on stdout or
23913 stderr, and also ends with a return code that is neither zero nor one of
23914 the return codes listed in &%temp_errors%& (that is, the delivery
23915 failed), the first line of output is written to the main log. This
23916 option and &%log_output%& are mutually exclusive.  Only one of them may
23917 be set.
23918
23919
23920 .option log_output pipe boolean false
23921 If this option is set and the command returns any output on stdout or
23922 stderr, the first line of output is written to the main log, whatever
23923 the return code. This option and &%log_fail_output%& are mutually
23924 exclusive. Only one of them may be set.
23925
23926
23927 .option max_output pipe integer 20K
23928 This specifies the maximum amount of output that the command may produce on its
23929 standard output and standard error file combined. If the limit is exceeded, the
23930 process running the command is killed. This is intended as a safety measure to
23931 catch runaway processes. The limit is applied independently of the settings of
23932 the options that control what is done with such output (for example,
23933 &%return_output%&). Because of buffering effects, the amount of output may
23934 exceed the limit by a small amount before Exim notices.
23935
23936
23937 .option message_prefix pipe string&!! "see below"
23938 The string specified here is expanded and output at the start of every message.
23939 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23940 .code
23941 message_prefix = \
23942   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23943   ${tod_bsdinbox}\n
23944 .endd
23945 .cindex "Cyrus"
23946 .cindex "&%tmail%&"
23947 .cindex "&""From""& line"
23948 This is required by the commonly used &_/usr/bin/vacation_& program.
23949 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23950 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23951 setting
23952 .code
23953 message_prefix =
23954 .endd
23955 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23956 &`\n`& to &`\r\n`& in &%message_prefix%&.
23957
23958
23959 .option message_suffix pipe string&!! "see below"
23960 The string specified here is expanded and output at the end of every message.
23961 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23962 The suffix can be suppressed by setting
23963 .code
23964 message_suffix =
23965 .endd
23966 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23967 &`\n`& to &`\r\n`& in &%message_suffix%&.
23968
23969
23970 .option path pipe string&!! "/bin:/usr/bin"
23971 This option is expanded and
23972 specifies the string that is set up in the PATH environment
23973 variable of the subprocess.
23974 If the &%command%& option does not yield an absolute path name, the command is
23975 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23976 apply to a command specified as a transport filter.
23977
23978
23979 .option permit_coredump pipe boolean false
23980 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23981 a core-dump of a pipe command, enable this command.  This enables core-dumps
23982 during delivery and affects both the Exim binary and the pipe command run.
23983 It is recommended that this option remain off unless and until you have a need
23984 for it and that this only be enabled when needed, as the risk of excessive
23985 resource consumption can be quite high.  Note also that Exim is typically
23986 installed as a setuid binary and most operating systems will inhibit coredumps
23987 of these by default, so further OS-specific action may be required.
23988
23989
23990 .option pipe_as_creator pipe boolean false
23991 .cindex "uid (user id)" "local delivery"
23992 If the generic &%user%& option is not set and this option is true, the delivery
23993 process is run under the uid that was in force when Exim was originally called
23994 to accept the message. If the group id is not otherwise set (via the generic
23995 &%group%& option), the gid that was in force when Exim was originally called to
23996 accept the message is used.
23997
23998
23999 .option restrict_to_path pipe boolean false
24000 When this option is set, any command name not listed in &%allow_commands%& must
24001 contain no slashes. The command is searched for only in the directories listed
24002 in the &%path%& option. This option is intended for use in the case when a pipe
24003 command has been generated from a user's &_.forward_& file. This is usually
24004 handled by a &(pipe)& transport called &%address_pipe%&.
24005
24006
24007 .option return_fail_output pipe boolean false
24008 If this option is true, and the command produced any output and ended with a
24009 return code other than zero or one of the codes listed in &%temp_errors%& (that
24010 is, the delivery failed), the output is returned in the bounce message.
24011 However, if the message has a null sender (that is, it is itself a bounce
24012 message), output from the command is discarded. This option and
24013 &%return_output%& are mutually exclusive. Only one of them may be set.
24014
24015
24016
24017 .option return_output pipe boolean false
24018 If this option is true, and the command produced any output, the delivery is
24019 deemed to have failed whatever the return code from the command, and the output
24020 is returned in the bounce message. Otherwise, the output is just discarded.
24021 However, if the message has a null sender (that is, it is a bounce message),
24022 output from the command is always discarded, whatever the setting of this
24023 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24024 of them may be set.
24025
24026
24027
24028 .option temp_errors pipe "string list" "see below"
24029 .cindex "&(pipe)& transport" "temporary failure"
24030 This option contains either a colon-separated list of numbers, or a single
24031 asterisk. If &%ignore_status%& is false
24032 and &%return_output%& is not set,
24033 and the command exits with a non-zero return code, the failure is treated as
24034 temporary and the delivery is deferred if the return code matches one of the
24035 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24036 codes are treated as permanent errors. The default setting contains the codes
24037 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24038 compiled on a system that does not define these macros, it assumes values of 75
24039 and 73, respectively.
24040
24041
24042 .option timeout pipe time 1h
24043 If the command fails to complete within this time, it is killed. This normally
24044 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24045 specifies no timeout. In order to ensure that any subprocesses created by the
24046 command are also killed, Exim makes the initial process a process group leader,
24047 and kills the whole process group on a timeout. However, this can be defeated
24048 if one of the processes starts a new process group.
24049
24050 .option timeout_defer pipe boolean false
24051 A timeout in a &(pipe)& transport, either in the command that the transport
24052 runs, or in a transport filter that is associated with it, is by default
24053 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24054 is set true, both kinds of timeout become temporary errors, causing the
24055 delivery to be deferred.
24056
24057 .option umask pipe "octal integer" 022
24058 This specifies the umask setting for the subprocess that runs the command.
24059
24060
24061 .option use_bsmtp pipe boolean false
24062 .cindex "envelope sender"
24063 If this option is set true, the &(pipe)& transport writes messages in &"batch
24064 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24065 commands. If you want to include a leading HELO command with such messages,
24066 you can do so by setting the &%message_prefix%& option. See section
24067 &<<SECTbatchSMTP>>& for details of batch SMTP.
24068
24069 .option use_classresources pipe boolean false
24070 .cindex "class resources (BSD)"
24071 This option is available only when Exim is running on FreeBSD, NetBSD, or
24072 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24073 resource limits when a &(pipe)& transport is run to perform a delivery. The
24074 limits for the uid under which the pipe is to run are obtained from the login
24075 class database.
24076
24077
24078 .option use_crlf pipe boolean false
24079 .cindex "carriage return"
24080 .cindex "linefeed"
24081 This option causes lines to be terminated with the two-character CRLF sequence
24082 (carriage return, linefeed) instead of just a linefeed character. In the case
24083 of batched SMTP, the byte sequence written to the pipe is then an exact image
24084 of what would be sent down a real SMTP connection.
24085
24086 The contents of the &%message_prefix%& and &%message_suffix%& options are
24087 written verbatim, so must contain their own carriage return characters if these
24088 are needed. When &%use_bsmtp%& is not set, the default values for both
24089 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24090 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24091
24092
24093 .option use_shell pipe boolean false
24094 .vindex "&$pipe_addresses$&"
24095 If this option is set, it causes the command to be passed to &_/bin/sh_&
24096 instead of being run directly from the transport, as described in section
24097 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24098 where the command is expected to be run under a shell and cannot easily be
24099 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24100 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24101 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24102 its &%-c%& option.
24103
24104
24105
24106 .section "Using an external local delivery agent" "SECID143"
24107 .cindex "local delivery" "using an external agent"
24108 .cindex "&'procmail'&"
24109 .cindex "external local delivery"
24110 .cindex "delivery" "&'procmail'&"
24111 .cindex "delivery" "by external agent"
24112 The &(pipe)& transport can be used to pass all messages that require local
24113 delivery to a separate local delivery agent such as &%procmail%&. When doing
24114 this, care must be taken to ensure that the pipe is run under an appropriate
24115 uid and gid. In some configurations one wants this to be a uid that is trusted
24116 by the delivery agent to supply the correct sender of the message. It may be
24117 necessary to recompile or reconfigure the delivery agent so that it trusts an
24118 appropriate user. The following is an example transport and router
24119 configuration for &%procmail%&:
24120 .code
24121 # transport
24122 procmail_pipe:
24123   driver = pipe
24124   command = /usr/local/bin/procmail -d $local_part
24125   return_path_add
24126   delivery_date_add
24127   envelope_to_add
24128   check_string = "From "
24129   escape_string = ">From "
24130   umask = 077
24131   user = $local_part
24132   group = mail
24133
24134 # router
24135 procmail:
24136   driver = accept
24137   check_local_user
24138   transport = procmail_pipe
24139 .endd
24140 In this example, the pipe is run as the local user, but with the group set to
24141 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24142 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24143 user to supply a correct sender address. If you do not specify either a
24144 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24145 home directory is the user's home directory by default.
24146
24147 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24148 .code
24149 IFS=" "
24150 .endd
24151 as shown in some &%procmail%& documentation, because Exim does not by default
24152 use a shell to run pipe commands.
24153
24154 .cindex "Cyrus"
24155 The next example shows a transport and a router for a system where local
24156 deliveries are handled by the Cyrus IMAP server.
24157 .code
24158 # transport
24159 local_delivery_cyrus:
24160   driver = pipe
24161   command = /usr/cyrus/bin/deliver \
24162             -m ${substr_1:$local_part_suffix} -- $local_part
24163   user = cyrus
24164   group = mail
24165   return_output
24166   log_output
24167   message_prefix =
24168   message_suffix =
24169
24170 # router
24171 local_user_cyrus:
24172   driver = accept
24173   check_local_user
24174   local_part_suffix = .*
24175   transport = local_delivery_cyrus
24176 .endd
24177 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24178 &%return_output%& to cause any text written by Cyrus to be returned to the
24179 sender.
24180 .ecindex IIDpiptra1
24181 .ecindex IIDpiptra2
24182
24183
24184 . ////////////////////////////////////////////////////////////////////////////
24185 . ////////////////////////////////////////////////////////////////////////////
24186
24187 .chapter "The smtp transport" "CHAPsmtptrans"
24188 .scindex IIDsmttra1 "transports" "&(smtp)&"
24189 .scindex IIDsmttra2 "&(smtp)& transport"
24190 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24191 or LMTP protocol. The list of hosts to try can either be taken from the address
24192 that is being processed (having been set up by the router), or specified
24193 explicitly for the transport. Timeout and retry processing (see chapter
24194 &<<CHAPretry>>&) is applied to each IP address independently.
24195
24196
24197 .section "Multiple messages on a single connection" "SECID144"
24198 The sending of multiple messages over a single TCP/IP connection can arise in
24199 two ways:
24200
24201 .ilist
24202 If a message contains more than &%max_rcpt%& (see below) addresses that are
24203 routed to the same host, more than one copy of the message has to be sent to
24204 that host. In this situation, multiple copies may be sent in a single run of
24205 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24206 does when it has too many addresses to send in one message also depends on the
24207 value of the global &%remote_max_parallel%& option. Details are given in
24208 section &<<SECToutSMTPTCP>>&.)
24209 .next
24210 .cindex "hints database" "remembering routing"
24211 When a message has been successfully delivered over a TCP/IP connection, Exim
24212 looks in its hints database to see if there are any other messages awaiting a
24213 connection to the same host. If there are, a new delivery process is started
24214 for one of them, and the current TCP/IP connection is passed on to it. The new
24215 process may in turn send multiple copies and possibly create yet another
24216 process.
24217 .endlist
24218
24219
24220 For each copy sent over the same TCP/IP connection, a sequence counter is
24221 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24222 no further messages are sent over that connection.
24223
24224
24225
24226 .section "Use of the $host and $host_address variables" "SECID145"
24227 .vindex "&$host$&"
24228 .vindex "&$host_address$&"
24229 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24230 &$host_address$& are the name and IP address of the first host on the host list
24231 passed by the router. However, when the transport is about to connect to a
24232 specific host, and while it is connected to that host, &$host$& and
24233 &$host_address$& are set to the values for that host. These are the values
24234 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24235 &%serialize_hosts%&, and the various TLS options are expanded.
24236
24237
24238 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24239 .vindex &$tls_bits$&
24240 .vindex &$tls_cipher$&
24241 .vindex &$tls_peerdn$&
24242 .vindex &$tls_sni$&
24243 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24244 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24245 are the values that were set when the message was received.
24246 These are the values that are used for options that are expanded before any
24247 SMTP connections are made. Just before each connection is made, these four
24248 variables are emptied. If TLS is subsequently started, they are set to the
24249 appropriate values for the outgoing connection, and these are the values that
24250 are in force when any authenticators are run and when the
24251 &%authenticated_sender%& option is expanded.
24252
24253 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24254 and will be removed in a future release.
24255
24256
24257 .section "Private options for smtp" "SECID146"
24258 .cindex "options" "&(smtp)& transport"
24259 The private options of the &(smtp)& transport are as follows:
24260
24261
24262 .option address_retry_include_sender smtp boolean true
24263 .cindex "4&'xx'& responses" "retrying after"
24264 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24265 is the combination of sender and recipient that is delayed in subsequent queue
24266 runs until the retry time is reached. You can delay the recipient without
24267 reference to the sender (which is what earlier versions of Exim did), by
24268 setting &%address_retry_include_sender%& false. However, this can lead to
24269 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24270
24271 .option allow_localhost smtp boolean false
24272 .cindex "local host" "sending to"
24273 .cindex "fallback" "hosts specified on transport"
24274 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24275 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24276 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24277 the delivery anyway. This should be used only in special cases when the
24278 configuration ensures that no looping will result (for example, a differently
24279 configured Exim is listening on the port to which the message is sent).
24280
24281
24282 .option authenticated_sender smtp string&!! unset
24283 .cindex "Cyrus"
24284 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24285 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24286 overriding any existing authenticated sender value. If the string expansion is
24287 forced to fail, the option is ignored. Other expansion failures cause delivery
24288 to be deferred. If the result of expansion is an empty string, that is also
24289 ignored.
24290
24291 The expansion happens after the outgoing connection has been made and TLS
24292 started, if required. This means that the &$host$&, &$host_address$&,
24293 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24294 particular connection.
24295
24296 If the SMTP session is not authenticated, the expansion of
24297 &%authenticated_sender%& still happens (and can cause the delivery to be
24298 deferred if it fails), but no AUTH= item is added to MAIL commands
24299 unless &%authenticated_sender_force%& is true.
24300
24301 This option allows you to use the &(smtp)& transport in LMTP mode to
24302 deliver mail to Cyrus IMAP and provide the proper local part as the
24303 &"authenticated sender"&, via a setting such as:
24304 .code
24305 authenticated_sender = $local_part
24306 .endd
24307 This removes the need for IMAP subfolders to be assigned special ACLs to
24308 allow direct delivery to those subfolders.
24309
24310 Because of expected uses such as that just described for Cyrus (when no
24311 domain is involved), there is no checking on the syntax of the provided
24312 value.
24313
24314
24315 .option authenticated_sender_force smtp boolean false
24316 If this option is set true, the &%authenticated_sender%& option's value
24317 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24318 authenticated as a client.
24319
24320
24321 .option command_timeout smtp time 5m
24322 This sets a timeout for receiving a response to an SMTP command that has been
24323 sent out. It is also used when waiting for the initial banner line from the
24324 remote host. Its value must not be zero.
24325
24326
24327 .option connect_timeout smtp time 5m
24328 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24329 to a remote host. A setting of zero allows the system timeout (typically
24330 several minutes) to act. To have any effect, the value of this option must be
24331 less than the system timeout. However, it has been observed that on some
24332 systems there is no system timeout, which is why the default value for this
24333 option is 5 minutes, a value recommended by RFC 1123.
24334
24335
24336 .option connection_max_messages smtp integer 500
24337 .cindex "SMTP" "passed connection"
24338 .cindex "SMTP" "multiple deliveries"
24339 .cindex "multiple SMTP deliveries"
24340 This controls the maximum number of separate message deliveries that are sent
24341 over a single TCP/IP connection. If the value is zero, there is no limit.
24342 For testing purposes, this value can be overridden by the &%-oB%& command line
24343 option.
24344
24345
24346 .option dane_require_tls_ciphers smtp string&!! unset
24347 .cindex "TLS" "requiring specific ciphers for DANE"
24348 .cindex "cipher" "requiring specific"
24349 .cindex DANE "TLS ciphers"
24350 This option may be used to override &%tls_require_ciphers%& for connections
24351 where DANE has been determined to be in effect.
24352 If not set, then &%tls_require_ciphers%& will be used.
24353 Normal SMTP delivery is not able to make strong demands of TLS cipher
24354 configuration, because delivery will fall back to plaintext.  Once DANE has
24355 been determined to be in effect, there is no plaintext fallback and making the
24356 TLS cipherlist configuration stronger will increase security, rather than
24357 counter-intuitively decreasing it.
24358 If the option expands to be empty or is forced to fail, then it will
24359 be treated as unset and &%tls_require_ciphers%& will be used instead.
24360
24361
24362 .option data_timeout smtp time 5m
24363 This sets a timeout for the transmission of each block in the data portion of
24364 the message. As a result, the overall timeout for a message depends on the size
24365 of the message. Its value must not be zero. See also &%final_timeout%&.
24366
24367
24368 .option dkim_canon smtp string&!! unset
24369 .option dkim_domain smtp string list&!! unset
24370 .option dkim_hash smtp string&!! sha256
24371 .option dkim_identity smtp string&!! unset
24372 .option dkim_private_key smtp string&!! unset
24373 .option dkim_selector smtp string&!! unset
24374 .option dkim_strict smtp string&!! unset
24375 .option dkim_sign_headers smtp string&!! "per RFC"
24376 .option dkim_timestamps smtp string&!! unset
24377 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
24378
24379
24380 .option delay_after_cutoff smtp boolean true
24381 .cindex "final cutoff" "retries, controlling"
24382 .cindex retry "final cutoff"
24383 This option controls what happens when all remote IP addresses for a given
24384 domain have been inaccessible for so long that they have passed their retry
24385 cutoff times.
24386
24387 In the default state, if the next retry time has not been reached for any of
24388 them, the address is bounced without trying any deliveries. In other words,
24389 Exim delays retrying an IP address after the final cutoff time until a new
24390 retry time is reached, and can therefore bounce an address without ever trying
24391 a delivery, when machines have been down for a long time. Some people are
24392 unhappy at this prospect, so...
24393
24394 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24395 addresses are past their final cutoff time, Exim tries to deliver to those
24396 IP addresses that have not been tried since the message arrived. If there are
24397 none, of if they all fail, the address is bounced. In other words, it does not
24398 delay when a new message arrives, but immediately tries those expired IP
24399 addresses that haven't been tried since the message arrived. If there is a
24400 continuous stream of messages for the dead hosts, unsetting
24401 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24402 to them.
24403
24404
24405 .option dns_qualify_single smtp boolean true
24406 If the &%hosts%& or &%fallback_hosts%& option is being used,
24407 and the &%gethostbyname%& option is false,
24408 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24409 in chapter &<<CHAPdnslookup>>& for more details.
24410
24411
24412 .option dns_search_parents smtp boolean false
24413 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24414 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24415 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24416 details.
24417
24418
24419 .option dnssec_request_domains smtp "domain list&!!" unset
24420 .cindex "MX record" "security"
24421 .cindex "DNSSEC" "MX lookup"
24422 .cindex "security" "MX lookup"
24423 .cindex "DNS" "DNSSEC"
24424 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24425 the dnssec request bit set.
24426 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24427
24428
24429
24430 .option dnssec_require_domains smtp "domain list&!!" unset
24431 .cindex "MX record" "security"
24432 .cindex "DNSSEC" "MX lookup"
24433 .cindex "security" "MX lookup"
24434 .cindex "DNS" "DNSSEC"
24435 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24436 the dnssec request bit set.  Any returns not having the Authenticated Data bit
24437 (AD bit) set will be ignored and logged as a host-lookup failure.
24438 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24439
24440
24441
24442 .option dscp smtp string&!! unset
24443 .cindex "DCSP" "outbound"
24444 This option causes the DSCP value associated with a socket to be set to one
24445 of a number of fixed strings or to numeric value.
24446 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24447 Common values include &`throughput`&, &`mincost`&, and on newer systems
24448 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24449
24450 The outbound packets from Exim will be marked with this value in the header
24451 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24452 that these values will have any effect, not be stripped by networking
24453 equipment, or do much of anything without cooperation with your Network
24454 Engineer and those of all network operators between the source and destination.
24455
24456
24457 .option fallback_hosts smtp "string list" unset
24458 .cindex "fallback" "hosts specified on transport"
24459 String expansion is not applied to this option. The argument must be a
24460 colon-separated list of host names or IP addresses, optionally also including
24461 port numbers, though the separator can be changed, as described in section
24462 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24463 item in a &%route_list%& setting for the &(manualroute)& router, as described
24464 in section &<<SECTformatonehostitem>>&.
24465
24466 Fallback hosts can also be specified on routers, which associate them with the
24467 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24468 &%fallback_hosts%& specified on the transport is used only if the address does
24469 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24470 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24471 However, &%hosts_randomize%& does apply to fallback host lists.
24472
24473 If Exim is unable to deliver to any of the hosts for a particular address, and
24474 the errors are not permanent rejections, the address is put on a separate
24475 transport queue with its host list replaced by the fallback hosts, unless the
24476 address was routed via MX records and the current host was in the original MX
24477 list. In that situation, the fallback host list is not used.
24478
24479 Once normal deliveries are complete, the fallback queue is delivered by
24480 re-running the same transports with the new host lists. If several failing
24481 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24482 copy of the message is sent.
24483
24484 The resolution of the host names on the fallback list is controlled by the
24485 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24486 both to cases when the host list comes with the address and when it is taken
24487 from &%hosts%&. This option provides a &"use a smart host only if delivery
24488 fails"& facility.
24489
24490
24491 .option final_timeout smtp time 10m
24492 This is the timeout that applies while waiting for the response to the final
24493 line containing just &"."& that terminates a message. Its value must not be
24494 zero.
24495
24496 .option gethostbyname smtp boolean false
24497 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24498 being used, names are looked up using &[gethostbyname()]&
24499 (or &[getipnodebyname()]& when available)
24500 instead of using the DNS. Of course, that function may in fact use the DNS, but
24501 it may also consult other sources of information such as &_/etc/hosts_&.
24502
24503 .option gnutls_compat_mode smtp boolean unset
24504 This option controls whether GnuTLS is used in compatibility mode in an Exim
24505 server. This reduces security slightly, but improves interworking with older
24506 implementations of TLS.
24507
24508 .option helo_data smtp string&!! "see below"
24509 .cindex "HELO" "argument, setting"
24510 .cindex "EHLO" "argument, setting"
24511 .cindex "LHLO argument setting"
24512 The value of this option is expanded after a connection to a another host has
24513 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24514 command that starts the outgoing SMTP or LMTP session. The default value of the
24515 option is:
24516 .code
24517 $primary_hostname
24518 .endd
24519 During the expansion, the variables &$host$& and &$host_address$& are set to
24520 the identity of the remote host, and the variables &$sending_ip_address$& and
24521 &$sending_port$& are set to the local IP address and port number that are being
24522 used. These variables can be used to generate different values for different
24523 servers or different local IP addresses. For example, if you want the string
24524 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24525 interface address, you could use this:
24526 .code
24527 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24528   {$primary_hostname}}
24529 .endd
24530 The use of &%helo_data%& applies both to sending messages and when doing
24531 callouts.
24532
24533 .option hosts smtp "string list&!!" unset
24534 Hosts are associated with an address by a router such as &(dnslookup)&, which
24535 finds the hosts by looking up the address domain in the DNS, or by
24536 &(manualroute)&, which has lists of hosts in its configuration. However,
24537 email addresses can be passed to the &(smtp)& transport by any router, and not
24538 all of them can provide an associated list of hosts.
24539
24540 The &%hosts%& option specifies a list of hosts to be used if the address being
24541 processed does not have any hosts associated with it. The hosts specified by
24542 &%hosts%& are also used, whether or not the address has its own hosts, if
24543 &%hosts_override%& is set.
24544
24545 The string is first expanded, before being interpreted as a colon-separated
24546 list of host names or IP addresses, possibly including port numbers. The
24547 separator may be changed to something other than colon, as described in section
24548 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24549 item in a &%route_list%& setting for the &(manualroute)& router, as described
24550 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24551 of the &(manualroute)& router is not available here.
24552
24553 If the expansion fails, delivery is deferred. Unless the failure was caused by
24554 the inability to complete a lookup, the error is logged to the panic log as
24555 well as the main log. Host names are looked up either by searching directly for
24556 address records in the DNS or by calling &[gethostbyname()]& (or
24557 &[getipnodebyname()]& when available), depending on the setting of the
24558 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24559 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24560 address are used.
24561
24562 During delivery, the hosts are tried in order, subject to their retry status,
24563 unless &%hosts_randomize%& is set.
24564
24565
24566 .option hosts_avoid_esmtp smtp "host list&!!" unset
24567 .cindex "ESMTP, avoiding use of"
24568 .cindex "HELO" "forcing use of"
24569 .cindex "EHLO" "avoiding use of"
24570 .cindex "PIPELINING" "avoiding the use of"
24571 This option is for use with broken hosts that announce ESMTP facilities (for
24572 example, PIPELINING) and then fail to implement them properly. When a host
24573 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24574 start of the SMTP session. This means that it cannot use any of the ESMTP
24575 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24576
24577
24578 .option hosts_avoid_pipelining smtp "host list&!!" unset
24579 .cindex "PIPELINING" "avoiding the use of"
24580 Exim will not use the SMTP PIPELINING extension when delivering to any host
24581 that matches this list, even if the server host advertises PIPELINING support.
24582
24583 .new
24584 .option hosts_pipe_connect smtp "host list&!!" unset
24585 .cindex "pipelining" "early connection"
24586 .cindex "pipelining" PIPE_CONNECT
24587 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24588 this option controls which to hosts the facility watched for
24589 and recorded, and used for subsequent connections.
24590
24591 The retry hints database is used for the record,
24592 and records are subject to the &%retry_data_expire%& option.
24593 When used, the pipelining saves on roundtrip times.
24594 It also turns SMTP into a client-first protocol
24595 so combines well with TCP Fast Open.
24596
24597 Note:
24598 When the facility is used, the transport &%helo_data%& option
24599 will be expanded before the &$sending_ip_address$& variable
24600 is filled in.
24601 A check is made for the use of that variable, without the
24602 presence of a &"def:"& test on it, but suitably complex coding
24603 can avoid the check and produce unexpected results.
24604 You have been warned.
24605 .wen
24606
24607
24608 .option hosts_avoid_tls smtp "host list&!!" unset
24609 .cindex "TLS" "avoiding for certain hosts"
24610 Exim will not try to start a TLS session when delivering to any host that
24611 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24612
24613 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24614 .cindex "TLS" "avoiding for certain hosts"
24615 Exim will not try to start a TLS session for a verify callout,
24616 or when delivering in cutthrough mode,
24617 to any host that matches this list.
24618
24619
24620 .option hosts_max_try smtp integer 5
24621 .cindex "host" "maximum number to try"
24622 .cindex "limit" "number of hosts tried"
24623 .cindex "limit" "number of MX tried"
24624 .cindex "MX record" "maximum tried"
24625 This option limits the number of IP addresses that are tried for any one
24626 delivery in cases where there are temporary delivery errors. Section
24627 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24628
24629
24630 .option hosts_max_try_hardlimit smtp integer 50
24631 This is an additional check on the maximum number of IP addresses that Exim
24632 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24633 why it exists.
24634
24635
24636
24637 .option hosts_nopass_tls smtp "host list&!!" unset
24638 .cindex "TLS" "passing connection"
24639 .cindex "multiple SMTP deliveries"
24640 .cindex "TLS" "multiple message deliveries"
24641 For any host that matches this list, a connection on which a TLS session has
24642 been started will not be passed to a new delivery process for sending another
24643 message on the same connection. See section &<<SECTmulmessam>>& for an
24644 explanation of when this might be needed.
24645
24646 .new
24647 .option hosts_noproxy_tls smtp "host list&!!" unset
24648 .cindex "TLS" "passing connection"
24649 .cindex "multiple SMTP deliveries"
24650 .cindex "TLS" "multiple message deliveries"
24651 For any host that matches this list, a TLS session which has
24652 been started will not be passed to a new delivery process for sending another
24653 message on the same session.
24654 .wen
24655
24656 The traditional implementation closes down TLS and re-starts it in the new
24657 process, on the same open TCP connection, for each successive message
24658 sent.  If permitted by this option a pipe to to the new process is set up
24659 instead, and the original process maintains the TLS connection and proxies
24660 the SMTP connection from and to the new process and any subsequents.
24661 The new process has no access to TLS information, so cannot include it in
24662 logging.
24663
24664
24665
24666 .option hosts_override smtp boolean false
24667 If this option is set and the &%hosts%& option is also set, any hosts that are
24668 attached to the address are ignored, and instead the hosts specified by the
24669 &%hosts%& option are always used. This option does not apply to
24670 &%fallback_hosts%&.
24671
24672
24673 .option hosts_randomize smtp boolean false
24674 .cindex "randomized host list"
24675 .cindex "host" "list of; randomized"
24676 .cindex "fallback" "randomized hosts"
24677 If this option is set, and either the list of hosts is taken from the
24678 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24679 were not obtained from MX records (this includes fallback hosts from the
24680 router), and were not randomized by the router, the order of trying the hosts
24681 is randomized each time the transport runs. Randomizing the order of a host
24682 list can be used to do crude load sharing.
24683
24684 When &%hosts_randomize%& is true, a host list may be split into groups whose
24685 order is separately randomized. This makes it possible to set up MX-like
24686 behaviour. The boundaries between groups are indicated by an item that is just
24687 &`+`& in the host list. For example:
24688 .code
24689 hosts = host1:host2:host3:+:host4:host5
24690 .endd
24691 The order of the first three hosts and the order of the last two hosts is
24692 randomized for each use, but the first three always end up before the last two.
24693 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24694
24695 .option hosts_require_auth smtp "host list&!!" unset
24696 .cindex "authentication" "required by client"
24697 This option provides a list of servers for which authentication must succeed
24698 before Exim will try to transfer a message. If authentication fails for
24699 servers which are not in this list, Exim tries to send unauthenticated. If
24700 authentication fails for one of these servers, delivery is deferred. This
24701 temporary error is detectable in the retry rules, so it can be turned into a
24702 hard failure if required. See also &%hosts_try_auth%&, and chapter
24703 &<<CHAPSMTPAUTH>>& for details of authentication.
24704
24705
24706 .option hosts_request_ocsp smtp "host list&!!" *
24707 .cindex "TLS" "requiring for certain servers"
24708 Exim will request a Certificate Status on a
24709 TLS session for any host that matches this list.
24710 &%tls_verify_certificates%& should also be set for the transport.
24711
24712 .option hosts_require_dane smtp "host list&!!" unset
24713 .cindex DANE "transport options"
24714 .cindex DANE "requiring for certain servers"
24715 If built with DANE support, Exim  will require that a DNSSEC-validated
24716 TLSA record is present for any host matching the list,
24717 and that a DANE-verified TLS connection is made.
24718 There will be no fallback to in-clear communication.
24719 See section &<<SECDANE>>&.
24720
24721 .option hosts_require_ocsp smtp "host list&!!" unset
24722 .cindex "TLS" "requiring for certain servers"
24723 Exim will request, and check for a valid Certificate Status being given, on a
24724 TLS session for any host that matches this list.
24725 &%tls_verify_certificates%& should also be set for the transport.
24726
24727 .option hosts_require_tls smtp "host list&!!" unset
24728 .cindex "TLS" "requiring for certain servers"
24729 Exim will insist on using a TLS session when delivering to any host that
24730 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24731 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24732 incoming messages, use an appropriate ACL.
24733
24734 .option hosts_try_auth smtp "host list&!!" unset
24735 .cindex "authentication" "optional in client"
24736 This option provides a list of servers to which, provided they announce
24737 authentication support, Exim will attempt to authenticate as a client when it
24738 connects. If authentication fails, Exim will try to transfer the message
24739 unauthenticated. See also &%hosts_require_auth%&, and chapter
24740 &<<CHAPSMTPAUTH>>& for details of authentication.
24741
24742 .option hosts_try_chunking smtp "host list&!!" *
24743 .cindex CHUNKING "enabling, in client"
24744 .cindex BDAT "SMTP command"
24745 .cindex "RFC 3030" "CHUNKING"
24746 This option provides a list of servers to which, provided they announce
24747 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24748 BDAT will not be used in conjunction with a transport filter.
24749
24750 .option hosts_try_dane smtp "host list&!!" *
24751 .cindex DANE "transport options"
24752 .cindex DANE "attempting for certain servers"
24753 If built with DANE support, Exim  will lookup a
24754 TLSA record for any host matching the list.
24755 If found and verified by DNSSEC,
24756 a DANE-verified TLS connection is made to that host;
24757 there will be no fallback to in-clear communication.
24758 See section &<<SECDANE>>&.
24759
24760 .option hosts_try_fastopen smtp "host list&!!" *
24761 .cindex "fast open, TCP" "enabling, in client"
24762 .cindex "TCP Fast Open" "enabling, in client"
24763 .cindex "RFC 7413" "TCP Fast Open"
24764 This option provides a list of servers to which, provided
24765 the facility is supported by this system, Exim will attempt to
24766 perform a TCP Fast Open.
24767 No data is sent on the SYN segment but, if the remote server also
24768 supports the facility, it can send its SMTP banner immediately after
24769 the SYN,ACK segment.  This can save up to one round-trip time.
24770
24771 The facility is only active for previously-contacted servers,
24772 as the initiator must present a cookie in the SYN segment.
24773
24774 On (at least some) current Linux distributions the facility must be enabled
24775 in the kernel by the sysadmin before the support is usable.
24776 There is no option for control of the server side; if the system supports
24777 it it is always enabled.  Note that lengthy operations in the connect ACL,
24778 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24779
24780 .option hosts_try_prdr smtp "host list&!!" *
24781 .cindex "PRDR" "enabling, optional in client"
24782 This option provides a list of servers to which, provided they announce
24783 PRDR support, Exim will attempt to negotiate PRDR
24784 for multi-recipient messages.
24785 The option can usually be left as default.
24786
24787 .option interface smtp "string list&!!" unset
24788 .cindex "bind IP address"
24789 .cindex "IP address" "binding"
24790 .vindex "&$host$&"
24791 .vindex "&$host_address$&"
24792 This option specifies which interface to bind to when making an outgoing SMTP
24793 call. The value is an IP address, not an interface name such as
24794 &`eth0`&. Do not confuse this with the interface address that was used when a
24795 message was received, which is in &$received_ip_address$&, formerly known as
24796 &$interface_address$&. The name was changed to minimize confusion with the
24797 outgoing interface address. There is no variable that contains an outgoing
24798 interface address because, unless it is set by this option, its value is
24799 unknown.
24800
24801 During the expansion of the &%interface%& option the variables &$host$& and
24802 &$host_address$& refer to the host to which a connection is about to be made
24803 during the expansion of the string. Forced expansion failure, or an empty
24804 string result causes the option to be ignored. Otherwise, after expansion, the
24805 string must be a list of IP addresses, colon-separated by default, but the
24806 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
24807 For example:
24808 .code
24809 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24810 .endd
24811 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24812 connection. If none of them are the correct type, the option is ignored. If
24813 &%interface%& is not set, or is ignored, the system's IP functions choose which
24814 interface to use if the host has more than one.
24815
24816
24817 .option keepalive smtp boolean true
24818 .cindex "keepalive" "on outgoing connection"
24819 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24820 connections. When set, it causes the kernel to probe idle connections
24821 periodically, by sending packets with &"old"& sequence numbers. The other end
24822 of the connection should send a acknowledgment if the connection is still okay
24823 or a reset if the connection has been aborted. The reason for doing this is
24824 that it has the beneficial effect of freeing up certain types of connection
24825 that can get stuck when the remote host is disconnected without tidying up the
24826 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24827 unreachable hosts.
24828
24829
24830 .option lmtp_ignore_quota smtp boolean false
24831 .cindex "LMTP" "ignoring quota errors"
24832 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24833 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24834 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24835
24836 .option max_rcpt smtp integer 100
24837 .cindex "RCPT" "maximum number of outgoing"
24838 This option limits the number of RCPT commands that are sent in a single
24839 SMTP message transaction. Each set of addresses is treated independently, and
24840 so can cause parallel connections to the same host if &%remote_max_parallel%&
24841 permits this.
24842
24843
24844 .option multi_domain smtp boolean&!! true
24845 .vindex "&$domain$&"
24846 When this option is set, the &(smtp)& transport can handle a number of
24847 addresses containing a mixture of different domains provided they all resolve
24848 to the same list of hosts. Turning the option off restricts the transport to
24849 handling only one domain at a time. This is useful if you want to use
24850 &$domain$& in an expansion for the transport, because it is set only when there
24851 is a single domain involved in a remote delivery.
24852
24853 It is expanded per-address and can depend on any of
24854 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24855 &$host$&, &$host_address$& and &$host_port$&.
24856
24857 .option port smtp string&!! "see below"
24858 .cindex "port" "sending TCP/IP"
24859 .cindex "TCP/IP" "setting outgoing port"
24860 This option specifies the TCP/IP port on the server to which Exim connects.
24861 &*Note:*& Do not confuse this with the port that was used when a message was
24862 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24863 The name was changed to minimize confusion with the outgoing port. There is no
24864 variable that contains an outgoing port.
24865
24866 If the value of this option begins with a digit it is taken as a port number;
24867 otherwise it is looked up using &[getservbyname()]&. The default value is
24868 normally &"smtp"&,
24869 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
24870 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
24871 If the expansion fails, or if a port number cannot be found, delivery
24872 is deferred.
24873
24874 Note that at least one Linux distribution has been seen failing
24875 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
24876
24877
24878
24879 .option protocol smtp string smtp
24880 .cindex "LMTP" "over TCP/IP"
24881 .cindex "ssmtp protocol" "outbound"
24882 .cindex "TLS" "SSL-on-connect outbound"
24883 .vindex "&$port$&"
24884 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24885 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24886 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24887 deliveries into closed message stores. Exim also has support for running LMTP
24888 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24889
24890 If this option is set to &"smtps"&, the default value for the &%port%& option
24891 changes to &"smtps"&, and the transport initiates TLS immediately after
24892 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24893 The Internet standards bodies used to strongly discourage use of this mode,
24894 but as of RFC 8314 it is perferred over STARTTLS for message submission
24895 (as distinct from MTA-MTA communication).
24896
24897
24898 .option retry_include_ip_address smtp boolean&!! true
24899 Exim normally includes both the host name and the IP address in the key it
24900 constructs for indexing retry data after a temporary delivery failure. This
24901 means that when one of several IP addresses for a host is failing, it gets
24902 tried periodically (controlled by the retry rules), but use of the other IP
24903 addresses is not affected.
24904
24905 However, in some dialup environments hosts are assigned a different IP address
24906 each time they connect. In this situation the use of the IP address as part of
24907 the retry key leads to undesirable behaviour. Setting this option false causes
24908 Exim to use only the host name.
24909 Since it is expanded it can be made to depend on the host or domain.
24910
24911
24912 .option serialize_hosts smtp "host list&!!" unset
24913 .cindex "serializing connections"
24914 .cindex "host" "serializing connections"
24915 Because Exim operates in a distributed manner, if several messages for the same
24916 host arrive at around the same time, more than one simultaneous connection to
24917 the remote host can occur. This is not usually a problem except when there is a
24918 slow link between the hosts. In that situation it may be helpful to restrict
24919 Exim to one connection at a time. This can be done by setting
24920 &%serialize_hosts%& to match the relevant hosts.
24921
24922 .cindex "hints database" "serializing deliveries to a host"
24923 Exim implements serialization by means of a hints database in which a record is
24924 written whenever a process connects to one of the restricted hosts. The record
24925 is deleted when the connection is completed. Obviously there is scope for
24926 records to get left lying around if there is a system or program crash. To
24927 guard against this, Exim ignores any records that are more than six hours old.
24928
24929 If you set up this kind of serialization, you should also arrange to delete the
24930 relevant hints database whenever your system reboots. The names of the files
24931 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24932 may be one or two files, depending on the type of DBM in use. The same files
24933 are used for ETRN serialization.
24934
24935 See also the &%max_parallel%& generic transport option.
24936
24937
24938 .option size_addition smtp integer 1024
24939 .cindex "SMTP" "SIZE"
24940 .cindex "message" "size issue for transport filter"
24941 .cindex "size" "of message"
24942 .cindex "transport" "filter"
24943 .cindex "filter" "transport filter"
24944 If a remote SMTP server indicates that it supports the SIZE option of the
24945 MAIL command, Exim uses this to pass over the message size at the start of
24946 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24947 sends, to allow for headers and other text that may be added during delivery by
24948 configuration options or in a transport filter. It may be necessary to increase
24949 this if a lot of text is added to messages.
24950
24951 Alternatively, if the value of &%size_addition%& is set negative, it disables
24952 the use of the SIZE option altogether.
24953
24954
24955 .option socks_proxy smtp string&!! unset
24956 .cindex proxy SOCKS
24957 This option enables use of SOCKS proxies for connections made by the
24958 transport.  For details see section &<<SECTproxySOCKS>>&.
24959
24960
24961 .option tls_certificate smtp string&!! unset
24962 .cindex "TLS" "client certificate, location of"
24963 .cindex "certificate" "client, location of"
24964 .vindex "&$host$&"
24965 .vindex "&$host_address$&"
24966 The value of this option must be the absolute path to a file which contains the
24967 client's certificate, for possible use when sending a message over an encrypted
24968 connection. The values of &$host$& and &$host_address$& are set to the name and
24969 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24970 details of TLS.
24971
24972 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24973 certificate when sending messages as a client. The global option of the same
24974 name specifies the certificate for Exim as a server; it is not automatically
24975 assumed that the same certificate should be used when Exim is operating as a
24976 client.
24977
24978
24979 .option tls_crl smtp string&!! unset
24980 .cindex "TLS" "client certificate revocation list"
24981 .cindex "certificate" "revocation list for client"
24982 This option specifies a certificate revocation list. The expanded value must
24983 be the name of a file that contains a CRL in PEM format.
24984
24985
24986 .option tls_dh_min_bits smtp integer 1024
24987 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24988 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24989 key agreement is negotiated, the server will provide a large prime number
24990 for use.  This option establishes the minimum acceptable size of that number.
24991 If the parameter offered by the server is too small, then the TLS handshake
24992 will fail.
24993
24994 Only supported when using GnuTLS.
24995
24996
24997 .option tls_privatekey smtp string&!! unset
24998 .cindex "TLS" "client private key, location of"
24999 .vindex "&$host$&"
25000 .vindex "&$host_address$&"
25001 The value of this option must be the absolute path to a file which contains the
25002 client's private key. This is used when sending a message over an encrypted
25003 connection using a client certificate. The values of &$host$& and
25004 &$host_address$& are set to the name and address of the server during the
25005 expansion. If this option is unset, or the expansion is forced to fail, or the
25006 result is an empty string, the private key is assumed to be in the same file as
25007 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25008
25009
25010 .option tls_require_ciphers smtp string&!! unset
25011 .cindex "TLS" "requiring specific ciphers"
25012 .cindex "cipher" "requiring specific"
25013 .vindex "&$host$&"
25014 .vindex "&$host_address$&"
25015 The value of this option must be a list of permitted cipher suites, for use
25016 when setting up an outgoing encrypted connection. (There is a global option of
25017 the same name for controlling incoming connections.) The values of &$host$& and
25018 &$host_address$& are set to the name and address of the server during the
25019 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25020 is used in different ways by OpenSSL and GnuTLS (see sections
25021 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25022 ciphers is a preference order.
25023
25024
25025
25026 .option tls_sni smtp string&!! unset
25027 .cindex "TLS" "Server Name Indication"
25028 .vindex "&$tls_sni$&"
25029 If this option is set then it sets the $tls_out_sni variable and causes any
25030 TLS session to pass this value as the Server Name Indication extension to
25031 the remote side, which can be used by the remote side to select an appropriate
25032 certificate and private key for the session.
25033
25034 See &<<SECTtlssni>>& for more information.
25035
25036 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25037 TLS extensions.
25038
25039
25040
25041
25042 .option tls_tempfail_tryclear smtp boolean true
25043 .cindex "4&'xx'& responses" "to STARTTLS"
25044 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25045 setting up a TLS session, this option determines whether or not Exim should try
25046 to deliver the message unencrypted. If it is set false, delivery to the
25047 current host is deferred; if there are other hosts, they are tried. If this
25048 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25049 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25050 TLS negotiation fails, Exim closes the current connection (because it is in an
25051 unknown state), opens a new one to the same host, and then tries the delivery
25052 in clear.
25053
25054
25055 .option tls_try_verify_hosts smtp "host list&!!" *
25056 .cindex "TLS" "server certificate verification"
25057 .cindex "certificate" "verification of server"
25058 This option gives a list of hosts for which, on encrypted connections,
25059 certificate verification will be tried but need not succeed.
25060 The &%tls_verify_certificates%& option must also be set.
25061 Note that unless the host is in this list
25062 TLS connections will be denied to hosts using self-signed certificates
25063 when &%tls_verify_certificates%& is matched.
25064 The &$tls_out_certificate_verified$& variable is set when
25065 certificate verification succeeds.
25066
25067
25068 .option tls_verify_cert_hostnames smtp "host list&!!" *
25069 .cindex "TLS" "server certificate hostname verification"
25070 .cindex "certificate" "verification of server"
25071 This option give a list of hosts for which,
25072 while verifying the server certificate,
25073 checks will be included on the host name
25074 (note that this will generally be the result of a DNS MX lookup)
25075 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25076 limited to being the initial component of a 3-or-more component FQDN.
25077
25078 There is no equivalent checking on client certificates.
25079
25080
25081 .option tls_verify_certificates smtp string&!! system
25082 .cindex "TLS" "server certificate verification"
25083 .cindex "certificate" "verification of server"
25084 .vindex "&$host$&"
25085 .vindex "&$host_address$&"
25086 The value of this option must be either the
25087 word "system"
25088 or the absolute path to
25089 a file or directory containing permitted certificates for servers,
25090 for use when setting up an encrypted connection.
25091
25092 The "system" value for the option will use a location compiled into the SSL library.
25093 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25094 is taken as empty and an explicit location
25095 must be specified.
25096
25097 The use of a directory for the option value is not available for GnuTLS versions
25098 preceding 3.3.6 and a single file must be used.
25099
25100 With OpenSSL the certificates specified
25101 explicitly
25102 either by file or directory
25103 are added to those given by the system default location.
25104
25105 The values of &$host$& and
25106 &$host_address$& are set to the name and address of the server during the
25107 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25108
25109 For back-compatibility,
25110 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25111 (a single-colon empty list counts as being set)
25112 and certificate verification fails the TLS connection is closed.
25113
25114
25115 .option tls_verify_hosts smtp "host list&!!" unset
25116 .cindex "TLS" "server certificate verification"
25117 .cindex "certificate" "verification of server"
25118 This option gives a list of hosts for which, on encrypted connections,
25119 certificate verification must succeed.
25120 The &%tls_verify_certificates%& option must also be set.
25121 If both this option and &%tls_try_verify_hosts%& are unset
25122 operation is as if this option selected all hosts.
25123
25124 .option utf8_downconvert smtp integer!! unset
25125 .cindex utf8 "address downconversion"
25126 .cindex i18n "utf8 address downconversion"
25127 If built with internationalization support,
25128 this option controls conversion of UTF-8 in message addresses
25129 to a-label form.
25130 For details see section &<<SECTi18nMTA>>&.
25131
25132
25133
25134
25135 .section "How the limits for the number of hosts to try are used" &&&
25136          "SECTvalhosmax"
25137 .cindex "host" "maximum number to try"
25138 .cindex "limit" "hosts; maximum number tried"
25139 There are two options that are concerned with the number of hosts that are
25140 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25141 &%hosts_max_try_hardlimit%&.
25142
25143
25144 The &%hosts_max_try%& option limits the number of hosts that are tried
25145 for a single delivery. However, despite the term &"host"& in its name, the
25146 option actually applies to each IP address independently. In other words, a
25147 multihomed host is treated as several independent hosts, just as it is for
25148 retrying.
25149
25150 Many of the larger ISPs have multiple MX records which often point to
25151 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25152 created as a result of routing one of these domains.
25153
25154 Trying every single IP address on such a long list does not seem sensible; if
25155 several at the top of the list fail, it is reasonable to assume there is some
25156 problem that is likely to affect all of them. Roughly speaking, the value of
25157 &%hosts_max_try%& is the maximum number that are tried before deferring the
25158 delivery. However, the logic cannot be quite that simple.
25159
25160 Firstly, IP addresses that are skipped because their retry times have not
25161 arrived do not count, and in addition, addresses that are past their retry
25162 limits are also not counted, even when they are tried. This means that when
25163 some IP addresses are past their retry limits, more than the value of
25164 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25165 that all IP addresses are considered before timing out an email address (but
25166 see below for an exception).
25167
25168 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25169 list to see if there is a subsequent host with a different (higher valued) MX.
25170 If there is, that host is considered next, and the current IP address is used
25171 but not counted. This behaviour helps in the case of a domain with a retry rule
25172 that hardly ever delays any hosts, as is now explained:
25173
25174 Consider the case of a long list of hosts with one MX value, and a few with a
25175 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25176 hosts at the top of the list are tried at first. With the default retry rule,
25177 which specifies increasing retry times, the higher MX hosts are eventually
25178 tried when those at the top of the list are skipped because they have not
25179 reached their retry times.
25180
25181 However, it is common practice to put a fixed short retry time on domains for
25182 large ISPs, on the grounds that their servers are rarely down for very long.
25183 Unfortunately, these are exactly the domains that tend to resolve to long lists
25184 of hosts. The short retry time means that the lowest MX hosts are tried every
25185 time. The attempts may be in a different order because of random sorting, but
25186 without the special MX check, the higher MX hosts would never be tried until
25187 all the lower MX hosts had timed out (which might be several days), because
25188 there are always some lower MX hosts that have reached their retry times. With
25189 the special check, Exim considers at least one IP address from each MX value at
25190 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25191 reached.
25192
25193 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25194 particular, Exim normally eventually tries all the IP addresses before timing
25195 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25196 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25197 been set up with hundreds of IP addresses for some domains. It can
25198 take a very long time indeed for an address to time out in these cases.
25199
25200 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25201 Exim never tries more than this number of IP addresses; if it hits this limit
25202 and they are all timed out, the email address is bounced, even though not all
25203 possible IP addresses have been tried.
25204 .ecindex IIDsmttra1
25205 .ecindex IIDsmttra2
25206
25207
25208
25209
25210
25211 . ////////////////////////////////////////////////////////////////////////////
25212 . ////////////////////////////////////////////////////////////////////////////
25213
25214 .chapter "Address rewriting" "CHAPrewrite"
25215 .scindex IIDaddrew "rewriting" "addresses"
25216 There are some circumstances in which Exim automatically rewrites domains in
25217 addresses. The two most common are when an address is given without a domain
25218 (referred to as an &"unqualified address"&) or when an address contains an
25219 abbreviated domain that is expanded by DNS lookup.
25220
25221 Unqualified envelope addresses are accepted only for locally submitted
25222 messages, or for messages that are received from hosts matching
25223 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25224 appropriate. Unqualified addresses in header lines are qualified if they are in
25225 locally submitted messages, or messages from hosts that are permitted to send
25226 unqualified envelope addresses. Otherwise, unqualified addresses in header
25227 lines are neither qualified nor rewritten.
25228
25229 One situation in which Exim does &'not'& automatically rewrite a domain is
25230 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25231 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25232 do this. The new RFCs do not contain this suggestion.
25233
25234
25235 .section "Explicitly configured address rewriting" "SECID147"
25236 This chapter describes the rewriting rules that can be used in the
25237 main rewrite section of the configuration file, and also in the generic
25238 &%headers_rewrite%& option that can be set on any transport.
25239
25240 Some people believe that configured address rewriting is a Mortal Sin.
25241 Others believe that life is not possible without it. Exim provides the
25242 facility; you do not have to use it.
25243
25244 The main rewriting rules that appear in the &"rewrite"& section of the
25245 configuration file are applied to addresses in incoming messages, both envelope
25246 addresses and addresses in header lines. Each rule specifies the types of
25247 address to which it applies.
25248
25249 Whether or not addresses in header lines are rewritten depends on the origin of
25250 the headers and the type of rewriting. Global rewriting, that is, rewriting
25251 rules from the rewrite section of the configuration file, is applied only to
25252 those headers that were received with the message. Header lines that are added
25253 by ACLs or by a system filter or by individual routers or transports (which
25254 are specific to individual recipient addresses) are not rewritten by the global
25255 rules.
25256
25257 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25258 applies all headers except those added by routers and transports. That is, as
25259 well as the headers that were received with the message, it also applies to
25260 headers that were added by an ACL or a system filter.
25261
25262
25263 In general, rewriting addresses from your own system or domain has some
25264 legitimacy. Rewriting other addresses should be done only with great care and
25265 in special circumstances. The author of Exim believes that rewriting should be
25266 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25267 Although it can sometimes be used as a routing tool, this is very strongly
25268 discouraged.
25269
25270 There are two commonly encountered circumstances where rewriting is used, as
25271 illustrated by these examples:
25272
25273 .ilist
25274 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25275 exchange mail with each other behind a firewall, but there is only a single
25276 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25277 &'hitch.fict.example'& when sending mail off-site.
25278 .next
25279 A host rewrites the local parts of its own users so that, for example,
25280 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25281 .endlist
25282
25283
25284
25285 .section "When does rewriting happen?" "SECID148"
25286 .cindex "rewriting" "timing of"
25287 .cindex "&ACL;" "rewriting addresses in"
25288 Configured address rewriting can take place at several different stages of a
25289 message's processing.
25290
25291 .vindex "&$sender_address$&"
25292 At the start of an ACL for MAIL, the sender address may have been rewritten
25293 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25294 ordinary rewrite rules have yet been applied. If, however, the sender address
25295 is verified in the ACL, it is rewritten before verification, and remains
25296 rewritten thereafter. The subsequent value of &$sender_address$& is the
25297 rewritten address. This also applies if sender verification happens in a
25298 RCPT ACL. Otherwise, when the sender address is not verified, it is
25299 rewritten as soon as a message's header lines have been received.
25300
25301 .vindex "&$domain$&"
25302 .vindex "&$local_part$&"
25303 Similarly, at the start of an ACL for RCPT, the current recipient's address
25304 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25305 rewrite rules have yet been applied to it. However, the behaviour is different
25306 from the sender address when a recipient is verified. The address is rewritten
25307 for the verification, but the rewriting is not remembered at this stage. The
25308 value of &$local_part$& and &$domain$& after verification are always the same
25309 as they were before (that is, they contain the unrewritten &-- except for
25310 SMTP-time rewriting &-- address).
25311
25312 As soon as a message's header lines have been received, all the envelope
25313 recipient addresses are permanently rewritten, and rewriting is also applied to
25314 the addresses in the header lines (if configured). This happens before adding
25315 any header lines that were specified in MAIL or RCPT ACLs, and
25316 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25317 before the DATA ACL and &[local_scan()]& functions are run.
25318
25319 When an address is being routed, either for delivery or for verification,
25320 rewriting is applied immediately to child addresses that are generated by
25321 redirection, unless &%no_rewrite%& is set on the router.
25322
25323 .cindex "envelope from"
25324 .cindex "envelope sender" "rewriting at transport time"
25325 .cindex "rewriting" "at transport time"
25326 .cindex "header lines" "rewriting at transport time"
25327 At transport time, additional rewriting of addresses in header lines can be
25328 specified by setting the generic &%headers_rewrite%& option on a transport.
25329 This option contains rules that are identical in form to those in the rewrite
25330 section of the configuration file. They are applied to the original message
25331 header lines and any that were added by ACLs or a system filter. They are not
25332 applied to header lines that are added by routers or the transport.
25333
25334 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25335 transport option. However, it is not possible to rewrite envelope recipients at
25336 transport time.
25337
25338
25339
25340
25341 .section "Testing the rewriting rules that apply on input" "SECID149"
25342 .cindex "rewriting" "testing"
25343 .cindex "testing" "rewriting"
25344 Exim's input rewriting configuration appears in a part of the runtime
25345 configuration file headed by &"begin rewrite"&. It can be tested by the
25346 &%-brw%& command line option. This takes an address (which can be a full RFC
25347 2822 address) as its argument. The output is a list of how the address would be
25348 transformed by the rewriting rules for each of the different places it might
25349 appear in an incoming message, that is, for each different header and for the
25350 envelope sender and recipient fields. For example,
25351 .code
25352 exim -brw ph10@exim.workshop.example
25353 .endd
25354 might produce the output
25355 .code
25356 sender: Philip.Hazel@exim.workshop.example
25357 from: Philip.Hazel@exim.workshop.example
25358 to: ph10@exim.workshop.example
25359 cc: ph10@exim.workshop.example
25360 bcc: ph10@exim.workshop.example
25361 reply-to: Philip.Hazel@exim.workshop.example
25362 env-from: Philip.Hazel@exim.workshop.example
25363 env-to: ph10@exim.workshop.example
25364 .endd
25365 which shows that rewriting has been set up for that address when used in any of
25366 the source fields, but not when it appears as a recipient address. At the
25367 present time, there is no equivalent way of testing rewriting rules that are
25368 set for a particular transport.
25369
25370
25371 .section "Rewriting rules" "SECID150"
25372 .cindex "rewriting" "rules"
25373 The rewrite section of the configuration file consists of lines of rewriting
25374 rules in the form
25375 .display
25376 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25377 .endd
25378 Rewriting rules that are specified for the &%headers_rewrite%& generic
25379 transport option are given as a colon-separated list. Each item in the list
25380 takes the same form as a line in the main rewriting configuration (except that
25381 any colons must be doubled, of course).
25382
25383 The formats of source patterns and replacement strings are described below.
25384 Each is terminated by white space, unless enclosed in double quotes, in which
25385 case normal quoting conventions apply inside the quotes. The flags are single
25386 characters which may appear in any order. Spaces and tabs between them are
25387 ignored.
25388
25389 For each address that could potentially be rewritten, the rules are scanned in
25390 order, and replacements for the address from earlier rules can themselves be
25391 replaced by later rules (but see the &"q"& and &"R"& flags).
25392
25393 The order in which addresses are rewritten is undefined, may change between
25394 releases, and must not be relied on, with one exception: when a message is
25395 received, the envelope sender is always rewritten first, before any header
25396 lines are rewritten. For example, the replacement string for a rewrite of an
25397 address in &'To:'& must not assume that the message's address in &'From:'& has
25398 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25399 that the envelope sender has already been rewritten.
25400
25401 .vindex "&$domain$&"
25402 .vindex "&$local_part$&"
25403 The variables &$local_part$& and &$domain$& can be used in the replacement
25404 string to refer to the address that is being rewritten. Note that lookup-driven
25405 rewriting can be done by a rule of the form
25406 .code
25407 *@*   ${lookup ...
25408 .endd
25409 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25410 refer to the address that is being rewritten.
25411
25412
25413 .section "Rewriting patterns" "SECID151"
25414 .cindex "rewriting" "patterns"
25415 .cindex "address list" "in a rewriting pattern"
25416 The source pattern in a rewriting rule is any item which may appear in an
25417 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25418 single-item address list, which means that it is expanded before being tested
25419 against the address. As always, if you use a regular expression as a pattern,
25420 you must take care to escape dollar and backslash characters, or use the &`\N`&
25421 facility to suppress string expansion within the regular expression.
25422
25423 Domains in patterns should be given in lower case. Local parts in patterns are
25424 case-sensitive. If you want to do case-insensitive matching of local parts, you
25425 can use a regular expression that starts with &`^(?i)`&.
25426
25427 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25428 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25429 depending on the type of match which occurred. These can be used in the
25430 replacement string to insert portions of the incoming address. &$0$& always
25431 refers to the complete incoming address. When a regular expression is used, the
25432 numerical variables are set from its capturing subexpressions. For other types
25433 of pattern they are set as follows:
25434
25435 .ilist
25436 If a local part or domain starts with an asterisk, the numerical variables
25437 refer to the character strings matched by asterisks, with &$1$& associated with
25438 the first asterisk, and &$2$& with the second, if present. For example, if the
25439 pattern
25440 .code
25441 *queen@*.fict.example
25442 .endd
25443 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25444 .code
25445 $0 = hearts-queen@wonderland.fict.example
25446 $1 = hearts-
25447 $2 = wonderland
25448 .endd
25449 Note that if the local part does not start with an asterisk, but the domain
25450 does, it is &$1$& that contains the wild part of the domain.
25451
25452 .next
25453 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25454 of the domain are placed in the next available numerical variables. Suppose,
25455 for example, that the address &'foo@bar.baz.example'& is processed by a
25456 rewriting rule of the form
25457 .display
25458 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25459 .endd
25460 and the key in the file that matches the domain is &`*.baz.example`&. Then
25461 .code
25462 $1 = foo
25463 $2 = bar
25464 $3 = baz.example
25465 .endd
25466 If the address &'foo@baz.example'& is looked up, this matches the same
25467 wildcard file entry, and in this case &$2$& is set to the empty string, but
25468 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25469 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25470 whole domain. For non-partial domain lookups, no numerical variables are set.
25471 .endlist
25472
25473
25474 .section "Rewriting replacements" "SECID152"
25475 .cindex "rewriting" "replacements"
25476 If the replacement string for a rule is a single asterisk, addresses that
25477 match the pattern and the flags are &'not'& rewritten, and no subsequent
25478 rewriting rules are scanned. For example,
25479 .code
25480 hatta@lookingglass.fict.example  *  f
25481 .endd
25482 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25483 &'From:'& headers.
25484
25485 .vindex "&$domain$&"
25486 .vindex "&$local_part$&"
25487 If the replacement string is not a single asterisk, it is expanded, and must
25488 yield a fully qualified address. Within the expansion, the variables
25489 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25490 Any letters they contain retain their original case &-- they are not lower
25491 cased. The numerical variables are set up according to the type of pattern that
25492 matched the address, as described above. If the expansion is forced to fail by
25493 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25494 current rule is abandoned, but subsequent rules may take effect. Any other
25495 expansion failure causes the entire rewriting operation to be abandoned, and an
25496 entry written to the panic log.
25497
25498
25499
25500 .section "Rewriting flags" "SECID153"
25501 There are three different kinds of flag that may appear on rewriting rules:
25502
25503 .ilist
25504 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25505 c, f, h, r, s, t.
25506 .next
25507 A flag that specifies rewriting at SMTP time: S.
25508 .next
25509 Flags that control the rewriting process: Q, q, R, w.
25510 .endlist
25511
25512 For rules that are part of the &%headers_rewrite%& generic transport option,
25513 E, F, T, and S are not permitted.
25514
25515
25516
25517 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25518          "SECID154"
25519 .cindex "rewriting" "flags"
25520 If none of the following flag letters, nor the &"S"& flag (see section
25521 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25522 and to both the sender and recipient fields of the envelope, whereas a
25523 transport-time rewriting rule just applies to all headers. Otherwise, the
25524 rewriting rule is skipped unless the relevant addresses are being processed.
25525 .display
25526 &`E`&       rewrite all envelope fields
25527 &`F`&       rewrite the envelope From field
25528 &`T`&       rewrite the envelope To field
25529 &`b`&       rewrite the &'Bcc:'& header
25530 &`c`&       rewrite the &'Cc:'& header
25531 &`f`&       rewrite the &'From:'& header
25532 &`h`&       rewrite all headers
25533 &`r`&       rewrite the &'Reply-To:'& header
25534 &`s`&       rewrite the &'Sender:'& header
25535 &`t`&       rewrite the &'To:'& header
25536 .endd
25537 "All headers" means all of the headers listed above that can be selected
25538 individually, plus their &'Resent-'& versions. It does not include
25539 other headers such as &'Subject:'& etc.
25540
25541 You should be particularly careful about rewriting &'Sender:'& headers, and
25542 restrict this to special known cases in your own domains.
25543
25544
25545 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25546 .cindex "SMTP" "rewriting malformed addresses"
25547 .cindex "RCPT" "rewriting argument of"
25548 .cindex "MAIL" "rewriting argument of"
25549 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25550 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25551 before any other processing; even before syntax checking. The pattern is
25552 required to be a regular expression, and it is matched against the whole of the
25553 data for the command, including any surrounding angle brackets.
25554
25555 .vindex "&$domain$&"
25556 .vindex "&$local_part$&"
25557 This form of rewrite rule allows for the handling of addresses that are not
25558 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25559 input). Because the input is not required to be a syntactically valid address,
25560 the variables &$local_part$& and &$domain$& are not available during the
25561 expansion of the replacement string. The result of rewriting replaces the
25562 original address in the MAIL or RCPT command.
25563
25564
25565 .section "Flags controlling the rewriting process" "SECID155"
25566 There are four flags which control the way the rewriting process works. These
25567 take effect only when a rule is invoked, that is, when the address is of the
25568 correct type (matches the flags) and matches the pattern:
25569
25570 .ilist
25571 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25572 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25573 absence of &"Q"& the rewritten address must always include a domain.
25574 .next
25575 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25576 even if no rewriting actually takes place because of a &"fail"& in the
25577 expansion. The &"q"& flag is not effective if the address is of the wrong type
25578 (does not match the flags) or does not match the pattern.
25579 .next
25580 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25581 address, up to ten times. It can be combined with the &"q"& flag, to stop
25582 rewriting once it fails to match (after at least one successful rewrite).
25583 .next
25584 .cindex "rewriting" "whole addresses"
25585 When an address in a header is rewritten, the rewriting normally applies only
25586 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25587 left unchanged. For example, rewriting might change
25588 .code
25589 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25590 .endd
25591 into
25592 .code
25593 From: Ford Prefect <prefectf@hitch.fict.example>
25594 .endd
25595 .cindex "RFC 2047"
25596 Sometimes there is a need to replace the whole address item, and this can be
25597 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25598 causes an address in a header line to be rewritten, the entire address is
25599 replaced, not just the working part. The replacement must be a complete RFC
25600 2822 address, including the angle brackets if necessary. If text outside angle
25601 brackets contains a character whose value is greater than 126 or less than 32
25602 (except for tab), the text is encoded according to RFC 2047. The character set
25603 is taken from &%headers_charset%&, which gets its default at build time.
25604
25605 When the &"w"& flag is set on a rule that causes an envelope address to be
25606 rewritten, all but the working part of the replacement address is discarded.
25607 .endlist
25608
25609
25610 .section "Rewriting examples" "SECID156"
25611 Here is an example of the two common rewriting paradigms:
25612 .code
25613 *@*.hitch.fict.example  $1@hitch.fict.example
25614 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25615                      {$value}fail}@hitch.fict.example bctfrF
25616 .endd
25617 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25618 the string expansion to fail if the lookup does not succeed. In this context it
25619 has the effect of leaving the original address unchanged, but Exim goes on to
25620 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25621 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25622 explicitly, which would cause the rewritten address to be the same as before,
25623 at the cost of a small bit of processing. Not supplying either of these is an
25624 error, since the rewritten address would then contain no local part.
25625
25626 The first example above replaces the domain with a superior, more general
25627 domain. This may not be desirable for certain local parts. If the rule
25628 .code
25629 root@*.hitch.fict.example  *
25630 .endd
25631 were inserted before the first rule, rewriting would be suppressed for the
25632 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25633
25634 Rewriting can be made conditional on a number of tests, by making use of
25635 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25636 messages that originate outside the local host:
25637 .code
25638 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25639                          {$1@hitch.fict.example}fail}"
25640 .endd
25641 The replacement string is quoted in this example because it contains white
25642 space.
25643
25644 .cindex "rewriting" "bang paths"
25645 .cindex "bang paths" "rewriting"
25646 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25647 an address it treats it as an unqualified local part which it qualifies with
25648 the local qualification domain (if the source of the message is local or if the
25649 remote host is permitted to send unqualified addresses). Rewriting can
25650 sometimes be used to handle simple bang paths with a fixed number of
25651 components. For example, the rule
25652 .code
25653 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25654 .endd
25655 rewrites a two-component bang path &'host.name!user'& as the domain address
25656 &'user@host.name'&. However, there is a security implication in using this as
25657 a global rewriting rule for envelope addresses. It can provide a backdoor
25658 method for using your system as a relay, because the incoming addresses appear
25659 to be local. If the bang path addresses are received via SMTP, it is safer to
25660 use the &"S"& flag to rewrite them as they are received, so that relay checking
25661 can be done on the rewritten addresses.
25662 .ecindex IIDaddrew
25663
25664
25665
25666
25667
25668 . ////////////////////////////////////////////////////////////////////////////
25669 . ////////////////////////////////////////////////////////////////////////////
25670
25671 .chapter "Retry configuration" "CHAPretry"
25672 .scindex IIDretconf1 "retry" "configuration, description of"
25673 .scindex IIDregconf2 "configuration file" "retry section"
25674 The &"retry"& section of the runtime configuration file contains a list of
25675 retry rules that control how often Exim tries to deliver messages that cannot
25676 be delivered at the first attempt. If there are no retry rules (the section is
25677 empty or not present), there are no retries. In this situation, temporary
25678 errors are treated as permanent. The default configuration contains a single,
25679 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25680 line option can be used to test which retry rule will be used for a given
25681 address, domain and error.
25682
25683 The most common cause of retries is temporary failure to deliver to a remote
25684 host because the host is down, or inaccessible because of a network problem.
25685 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25686 address) basis, not on a per-message basis. Thus, if one message has recently
25687 been delayed, delivery of a new message to the same host is not immediately
25688 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25689 log selector is set, the message
25690 .cindex "retry" "time not reached"
25691 &"retry time not reached"& is written to the main log whenever a delivery is
25692 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25693 the handling of errors during remote deliveries.
25694
25695 Retry processing applies to routing as well as to delivering, except as covered
25696 in the next paragraph. The retry rules do not distinguish between these
25697 actions. It is not possible, for example, to specify different behaviour for
25698 failures to route the domain &'snark.fict.example'& and failures to deliver to
25699 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25700 added complication, so did not implement it. However, although they share the
25701 same retry rule, the actual retry times for routing and transporting a given
25702 domain are maintained independently.
25703
25704 When a delivery is not part of a queue run (typically an immediate delivery on
25705 receipt of a message), the routers are always run, and local deliveries are
25706 always attempted, even if retry times are set for them. This makes for better
25707 behaviour if one particular message is causing problems (for example, causing
25708 quota overflow, or provoking an error in a filter file). If such a delivery
25709 suffers a temporary failure, the retry data is updated as normal, and
25710 subsequent delivery attempts from queue runs occur only when the retry time for
25711 the local address is reached.
25712
25713 .section "Changing retry rules" "SECID157"
25714 If you change the retry rules in your configuration, you should consider
25715 whether or not to delete the retry data that is stored in Exim's spool area in
25716 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25717 always safe; that is why they are called &"hints"&.
25718
25719 The hints retry data contains suggested retry times based on the previous
25720 rules. In the case of a long-running problem with a remote host, it might
25721 record the fact that the host has timed out. If your new rules increase the
25722 timeout time for such a host, you should definitely remove the old retry data
25723 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25724 messages that it should now be retaining.
25725
25726
25727
25728 .section "Format of retry rules" "SECID158"
25729 .cindex "retry" "rules"
25730 Each retry rule occupies one line and consists of three or four parts,
25731 separated by white space: a pattern, an error name, an optional list of sender
25732 addresses, and a list of retry parameters. The pattern and sender lists must be
25733 enclosed in double quotes if they contain white space. The rules are searched
25734 in order until one is found where the pattern, error name, and sender list (if
25735 present) match the failing host or address, the error that occurred, and the
25736 message's sender, respectively.
25737
25738
25739 The pattern is any single item that may appear in an address list (see section
25740 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25741 which means that it is expanded before being tested against the address that
25742 has been delayed. A negated address list item is permitted. Address
25743 list processing treats a plain domain name as if it were preceded by &"*@"&,
25744 which makes it possible for many retry rules to start with just a domain. For
25745 example,
25746 .code
25747 lookingglass.fict.example        *  F,24h,30m;
25748 .endd
25749 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25750 whereas
25751 .code
25752 alice@lookingglass.fict.example  *  F,24h,30m;
25753 .endd
25754 applies only to temporary failures involving the local part &%alice%&.
25755 In practice, almost all rules start with a domain name pattern without a local
25756 part.
25757
25758 .cindex "regular expressions" "in retry rules"
25759 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25760 must match a complete address, not just a domain, because that is how regular
25761 expressions work in address lists.
25762 .display
25763 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25764 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25765 .endd
25766
25767
25768 .section "Choosing which retry rule to use for address errors" "SECID159"
25769 When Exim is looking for a retry rule after a routing attempt has failed (for
25770 example, after a DNS timeout), each line in the retry configuration is tested
25771 against the complete address only if &%retry_use_local_part%& is set for the
25772 router. Otherwise, only the domain is used, except when matching against a
25773 regular expression, when the local part of the address is replaced with &"*"&.
25774 A domain on its own can match a domain pattern, or a pattern that starts with
25775 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25776 &%check_local_user%& is true, and false for other routers.
25777
25778 Similarly, when Exim is looking for a retry rule after a local delivery has
25779 failed (for example, after a mailbox full error), each line in the retry
25780 configuration is tested against the complete address only if
25781 &%retry_use_local_part%& is set for the transport (it defaults true for all
25782 local transports).
25783
25784 .cindex "4&'xx'& responses" "retry rules for"
25785 However, when Exim is looking for a retry rule after a remote delivery attempt
25786 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25787 whole address is always used as the key when searching the retry rules. The
25788 rule that is found is used to create a retry time for the combination of the
25789 failing address and the message's sender. It is the combination of sender and
25790 recipient that is delayed in subsequent queue runs until its retry time is
25791 reached. You can delay the recipient without regard to the sender by setting
25792 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25793 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25794 commands.
25795
25796
25797
25798 .section "Choosing which retry rule to use for host and message errors" &&&
25799          "SECID160"
25800 For a temporary error that is not related to an individual address (for
25801 example, a connection timeout), each line in the retry configuration is checked
25802 twice. First, the name of the remote host is used as a domain name (preceded by
25803 &"*@"& when matching a regular expression). If this does not match the line,
25804 the domain from the email address is tried in a similar fashion. For example,
25805 suppose the MX records for &'a.b.c.example'& are
25806 .code
25807 a.b.c.example  MX  5  x.y.z.example
25808                MX  6  p.q.r.example
25809                MX  7  m.n.o.example
25810 .endd
25811 and the retry rules are
25812 .code
25813 p.q.r.example    *      F,24h,30m;
25814 a.b.c.example    *      F,4d,45m;
25815 .endd
25816 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25817 first rule matches neither the host nor the domain, so Exim looks at the second
25818 rule. This does not match the host, but it does match the domain, so it is used
25819 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25820 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25821 first retry rule is used, because it matches the host.
25822
25823 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25824 first rule to determine retry times, but for all the other hosts for the domain
25825 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25826 routing to &'a.b.c.example'& suffers a temporary failure.
25827
25828 &*Note*&: The host name is used when matching the patterns, not its IP address.
25829 However, if a message is routed directly to an IP address without the use of a
25830 host name, for example, if a &(manualroute)& router contains a setting such as:
25831 .code
25832 route_list = *.a.example  192.168.34.23
25833 .endd
25834 then the &"host name"& that is used when searching for a retry rule is the
25835 textual form of the IP address.
25836
25837 .section "Retry rules for specific errors" "SECID161"
25838 .cindex "retry" "specific errors; specifying"
25839 The second field in a retry rule is the name of a particular error, or an
25840 asterisk, which matches any error. The errors that can be tested for are:
25841
25842 .vlist
25843 .vitem &%auth_failed%&
25844 Authentication failed when trying to send to a host in the
25845 &%hosts_require_auth%& list in an &(smtp)& transport.
25846
25847 .vitem &%data_4xx%&
25848 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25849 after the command, or after sending the message's data.
25850
25851 .vitem &%mail_4xx%&
25852 A 4&'xx'& error was received for an outgoing MAIL command.
25853
25854 .vitem &%rcpt_4xx%&
25855 A 4&'xx'& error was received for an outgoing RCPT command.
25856 .endlist
25857
25858 For the three 4&'xx'& errors, either the first or both of the x's can be given
25859 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25860 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25861 and have retries every ten minutes with a one-hour timeout, you could set up a
25862 retry rule of this form:
25863 .code
25864 the.domain.name  rcpt_452   F,1h,10m
25865 .endd
25866 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25867 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25868
25869 .vlist
25870 .vitem &%lost_connection%&
25871 A server unexpectedly closed the SMTP connection. There may, of course,
25872 legitimate reasons for this (host died, network died), but if it repeats a lot
25873 for the same host, it indicates something odd.
25874
25875 .vitem &%lookup%&
25876 A DNS lookup for a host failed.
25877 Note that a &%dnslookup%& router will need to have matched
25878 its &%fail_defer_domains%& option for this retry type to be usable.
25879 Also note that a &%manualroute%& router will probably need
25880 its &%host_find_failed%& option set to &%defer%&.
25881
25882 .vitem &%refused_MX%&
25883 A connection to a host obtained from an MX record was refused.
25884
25885 .vitem &%refused_A%&
25886 A connection to a host not obtained from an MX record was refused.
25887
25888 .vitem &%refused%&
25889 A connection was refused.
25890
25891 .vitem &%timeout_connect_MX%&
25892 A connection attempt to a host obtained from an MX record timed out.
25893
25894 .vitem &%timeout_connect_A%&
25895 A connection attempt to a host not obtained from an MX record timed out.
25896
25897 .vitem &%timeout_connect%&
25898 A connection attempt timed out.
25899
25900 .vitem &%timeout_MX%&
25901 There was a timeout while connecting or during an SMTP session with a host
25902 obtained from an MX record.
25903
25904 .vitem &%timeout_A%&
25905 There was a timeout while connecting or during an SMTP session with a host not
25906 obtained from an MX record.
25907
25908 .vitem &%timeout%&
25909 There was a timeout while connecting or during an SMTP session.
25910
25911 .vitem &%tls_required%&
25912 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25913 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25914 to STARTTLS, or there was a problem setting up the TLS connection.
25915
25916 .vitem &%quota%&
25917 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25918 transport.
25919
25920 .vitem &%quota_%&<&'time'&>
25921 .cindex "quota" "error testing in retry rule"
25922 .cindex "retry" "quota error testing"
25923 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25924 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25925 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25926 for four days.
25927 .endlist
25928
25929 .cindex "mailbox" "time of last read"
25930 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25931 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25932 it should be based on the last time that the user accessed the mailbox.
25933 However, it is not always possible to determine this. Exim uses the following
25934 heuristic rules:
25935
25936 .ilist
25937 If the mailbox is a single file, the time of last access (the &"atime"&) is
25938 used. As no new messages are being delivered (because the mailbox is over
25939 quota), Exim does not access the file, so this is the time of last user access.
25940 .next
25941 .cindex "maildir format" "time of last read"
25942 For a maildir delivery, the time of last modification of the &_new_&
25943 subdirectory is used. As the mailbox is over quota, no new files are created in
25944 the &_new_& subdirectory, because no new messages are being delivered. Any
25945 change to the &_new_& subdirectory is therefore assumed to be the result of an
25946 MUA moving a new message to the &_cur_& directory when it is first read. The
25947 time that is used is therefore the last time that the user read a new message.
25948 .next
25949 For other kinds of multi-file mailbox, the time of last access cannot be
25950 obtained, so a retry rule that uses this type of error field is never matched.
25951 .endlist
25952
25953 The quota errors apply both to system-enforced quotas and to Exim's own quota
25954 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25955 when a local delivery is deferred because a partition is full (the ENOSPC
25956 error).
25957
25958
25959
25960 .section "Retry rules for specified senders" "SECID162"
25961 .cindex "retry" "rules; sender-specific"
25962 You can specify retry rules that apply only when the failing message has a
25963 specific sender. In particular, this can be used to define retry rules that
25964 apply only to bounce messages. The third item in a retry rule can be of this
25965 form:
25966 .display
25967 &`senders=`&<&'address list'&>
25968 .endd
25969 The retry timings themselves are then the fourth item. For example:
25970 .code
25971 *   rcpt_4xx   senders=:   F,1h,30m
25972 .endd
25973 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25974 host. If the address list contains white space, it must be enclosed in quotes.
25975 For example:
25976 .code
25977 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25978 .endd
25979 &*Warning*&: This facility can be unhelpful if it is used for host errors
25980 (which do not depend on the recipient). The reason is that the sender is used
25981 only to match the retry rule. Once the rule has been found for a host error,
25982 its contents are used to set a retry time for the host, and this will apply to
25983 all messages, not just those with specific senders.
25984
25985 When testing retry rules using &%-brt%&, you can supply a sender using the
25986 &%-f%& command line option, like this:
25987 .code
25988 exim -f "" -brt user@dom.ain
25989 .endd
25990 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25991 list is never matched.
25992
25993
25994
25995
25996
25997 .section "Retry parameters" "SECID163"
25998 .cindex "retry" "parameters in rules"
25999 The third (or fourth, if a senders list is present) field in a retry rule is a
26000 sequence of retry parameter sets, separated by semicolons. Each set consists of
26001 .display
26002 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26003 .endd
26004 The letter identifies the algorithm for computing a new retry time; the cutoff
26005 time is the time beyond which this algorithm no longer applies, and the
26006 arguments vary the algorithm's action. The cutoff time is measured from the
26007 time that the first failure for the domain (combined with the local part if
26008 relevant) was detected, not from the time the message was received.
26009
26010 .cindex "retry" "algorithms"
26011 .cindex "retry" "fixed intervals"
26012 .cindex "retry" "increasing intervals"
26013 .cindex "retry" "random intervals"
26014 The available algorithms are:
26015
26016 .ilist
26017 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26018 the interval.
26019 .next
26020 &'G'&: retry at geometrically increasing intervals. The first argument
26021 specifies a starting value for the interval, and the second a multiplier, which
26022 is used to increase the size of the interval at each retry.
26023 .next
26024 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26025 retry, the previous interval is multiplied by the factor in order to get a
26026 maximum for the next interval. The minimum interval is the first argument of
26027 the parameter, and an actual interval is chosen randomly between them. Such a
26028 rule has been found to be helpful in cluster configurations when all the
26029 members of the cluster restart at once, and may therefore synchronize their
26030 queue processing times.
26031 .endlist
26032
26033 When computing the next retry time, the algorithm definitions are scanned in
26034 order until one whose cutoff time has not yet passed is reached. This is then
26035 used to compute a new retry time that is later than the current time. In the
26036 case of fixed interval retries, this simply means adding the interval to the
26037 current time. For geometrically increasing intervals, retry intervals are
26038 computed from the rule's parameters until one that is greater than the previous
26039 interval is found. The main configuration variable
26040 .cindex "limit" "retry interval"
26041 .cindex "retry" "interval, maximum"
26042 .oindex "&%retry_interval_max%&"
26043 &%retry_interval_max%& limits the maximum interval between retries. It
26044 cannot be set greater than &`24h`&, which is its default value.
26045
26046 A single remote domain may have a number of hosts associated with it, and each
26047 host may have more than one IP address. Retry algorithms are selected on the
26048 basis of the domain name, but are applied to each IP address independently. If,
26049 for example, a host has two IP addresses and one is unusable, Exim will
26050 generate retry times for it and will not try to use it until its next retry
26051 time comes. Thus the good IP address is likely to be tried first most of the
26052 time.
26053
26054 .cindex "hints database" "use for retrying"
26055 Retry times are hints rather than promises. Exim does not make any attempt to
26056 run deliveries exactly at the computed times. Instead, a queue runner process
26057 starts delivery processes for delayed messages periodically, and these attempt
26058 new deliveries only for those addresses that have passed their next retry time.
26059 If a new message arrives for a deferred address, an immediate delivery attempt
26060 occurs only if the address has passed its retry time. In the absence of new
26061 messages, the minimum time between retries is the interval between queue runner
26062 processes. There is not much point in setting retry times of five minutes if
26063 your queue runners happen only once an hour, unless there are a significant
26064 number of incoming messages (which might be the case on a system that is
26065 sending everything to a smart host, for example).
26066
26067 The data in the retry hints database can be inspected by using the
26068 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26069 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26070 &'exinext'& utility script can be used to find out what the next retry times
26071 are for the hosts associated with a particular mail domain, and also for local
26072 deliveries that have been deferred.
26073
26074
26075 .section "Retry rule examples" "SECID164"
26076 Here are some example retry rules:
26077 .code
26078 alice@wonderland.fict.example quota_5d  F,7d,3h
26079 wonderland.fict.example       quota_5d
26080 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26081 lookingglass.fict.example     *         F,24h,30m;
26082 *                 refused_A   F,2h,20m;
26083 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26084 .endd
26085 The first rule sets up special handling for mail to
26086 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26087 mailbox has not been read for at least 5 days. Retries continue every three
26088 hours for 7 days. The second rule handles over-quota errors for all other local
26089 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26090 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26091 fail are bounced immediately if the mailbox has not been read for at least 5
26092 days.
26093
26094 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26095 happen every 15 minutes for an hour, then with geometrically increasing
26096 intervals until two days have passed since a delivery first failed. After the
26097 first hour there is a delay of one hour, then two hours, then four hours, and
26098 so on (this is a rather extreme example).
26099
26100 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26101 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26102 all other domains, with special action for connection refusal from hosts that
26103 were not obtained from an MX record.
26104
26105 The final rule in a retry configuration should always have asterisks in the
26106 first two fields so as to provide a general catch-all for any addresses that do
26107 not have their own special handling. This example tries every 15 minutes for 2
26108 hours, then with intervals starting at one hour and increasing by a factor of
26109 1.5 up to 16 hours, then every 8 hours up to 5 days.
26110
26111
26112
26113 .section "Timeout of retry data" "SECID165"
26114 .cindex "timeout" "of retry data"
26115 .oindex "&%retry_data_expire%&"
26116 .cindex "hints database" "data expiry"
26117 .cindex "retry" "timeout of data"
26118 Exim timestamps the data that it writes to its retry hints database. When it
26119 consults the data during a delivery it ignores any that is older than the value
26120 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26121 been tried for 7 days, Exim will try to deliver to it immediately a message
26122 arrives, and if that fails, it will calculate a retry time as if it were
26123 failing for the first time.
26124
26125 This improves the behaviour for messages routed to rarely-used hosts such as MX
26126 backups. If such a host was down at one time, and happens to be down again when
26127 Exim tries a month later, using the old retry data would imply that it had been
26128 down all the time, which is not a justified assumption.
26129
26130 If a host really is permanently dead, this behaviour causes a burst of retries
26131 every now and again, but only if messages routed to it are rare. If there is a
26132 message at least once every 7 days the retry data never expires.
26133
26134
26135
26136
26137 .section "Long-term failures" "SECID166"
26138 .cindex "delivery failure, long-term"
26139 .cindex "retry" "after long-term failure"
26140 Special processing happens when an email address has been failing for so long
26141 that the cutoff time for the last algorithm is reached. For example, using the
26142 default retry rule:
26143 .code
26144 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26145 .endd
26146 the cutoff time is four days. Reaching the retry cutoff is independent of how
26147 long any specific message has been failing; it is the length of continuous
26148 failure for the recipient address that counts.
26149
26150 When the cutoff time is reached for a local delivery, or for all the IP
26151 addresses associated with a remote delivery, a subsequent delivery failure
26152 causes Exim to give up on the address, and a bounce message is generated.
26153 In order to cater for new messages that use the failing address, a next retry
26154 time is still computed from the final algorithm, and is used as follows:
26155
26156 For local deliveries, one delivery attempt is always made for any subsequent
26157 messages. If this delivery fails, the address fails immediately. The
26158 post-cutoff retry time is not used.
26159
26160 .cindex "final cutoff" "retries, controlling"
26161 .cindex retry "final cutoff"
26162 If the delivery is remote, there are two possibilities, controlled by the
26163 .oindex "&%delay_after_cutoff%&"
26164 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26165 default. Until the post-cutoff retry time for one of the IP addresses,
26166 as set by the &%retry_data_expire%& option, is
26167 reached, the failing email address is bounced immediately, without a delivery
26168 attempt taking place. After that time, one new delivery attempt is made to
26169 those IP addresses that are past their retry times, and if that still fails,
26170 the address is bounced and new retry times are computed.
26171
26172 In other words, when all the hosts for a given email address have been failing
26173 for a long time, Exim bounces rather then defers until one of the hosts' retry
26174 times is reached. Then it tries once, and bounces if that attempt fails. This
26175 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26176 to a broken destination, but if the host does recover, Exim will eventually
26177 notice.
26178
26179 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26180 addresses are past their final cutoff time, Exim tries to deliver to those IP
26181 addresses that have not been tried since the message arrived. If there are
26182 no suitable IP addresses, or if they all fail, the address is bounced. In other
26183 words, it does not delay when a new message arrives, but tries the expired
26184 addresses immediately, unless they have been tried since the message arrived.
26185 If there is a continuous stream of messages for the failing domains, setting
26186 &%delay_after_cutoff%& false means that there will be many more attempts to
26187 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26188 true.
26189
26190 .section "Deliveries that work intermittently" "SECID167"
26191 .cindex "retry" "intermittently working deliveries"
26192 Some additional logic is needed to cope with cases where a host is
26193 intermittently available, or when a message has some attribute that prevents
26194 its delivery when others to the same address get through. In this situation,
26195 because some messages are successfully delivered, the &"retry clock"& for the
26196 host or address keeps getting reset by the successful deliveries, and so
26197 failing messages remain in the queue for ever because the cutoff time is never
26198 reached.
26199
26200 Two exceptional actions are applied to prevent this happening. The first
26201 applies to errors that are related to a message rather than a remote host.
26202 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26203 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26204 commands, and quota failures. For this type of error, if a message's arrival
26205 time is earlier than the &"first failed"& time for the error, the earlier time
26206 is used when scanning the retry rules to decide when to try next and when to
26207 time out the address.
26208
26209 The exceptional second action applies in all cases. If a message has been on
26210 the queue for longer than the cutoff time of any applicable retry rule for a
26211 given address, a delivery is attempted for that address, even if it is not yet
26212 time, and if this delivery fails, the address is timed out. A new retry time is
26213 not computed in this case, so that other messages for the same address are
26214 considered immediately.
26215 .ecindex IIDretconf1
26216 .ecindex IIDregconf2
26217
26218
26219
26220
26221
26222
26223 . ////////////////////////////////////////////////////////////////////////////
26224 . ////////////////////////////////////////////////////////////////////////////
26225
26226 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26227 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26228 .scindex IIDauthconf2 "authentication"
26229 The &"authenticators"& section of Exim's runtime configuration is concerned
26230 with SMTP authentication. This facility is an extension to the SMTP protocol,
26231 described in RFC 2554, which allows a client SMTP host to authenticate itself
26232 to a server. This is a common way for a server to recognize clients that are
26233 permitted to use it as a relay. SMTP authentication is not of relevance to the
26234 transfer of mail between servers that have no managerial connection with each
26235 other.
26236
26237 .cindex "AUTH" "description of"
26238 Very briefly, the way SMTP authentication works is as follows:
26239
26240 .ilist
26241 The server advertises a number of authentication &'mechanisms'& in response to
26242 the client's EHLO command.
26243 .next
26244 The client issues an AUTH command, naming a specific mechanism. The command
26245 may, optionally, contain some authentication data.
26246 .next
26247 The server may issue one or more &'challenges'&, to which the client must send
26248 appropriate responses. In simple authentication mechanisms, the challenges are
26249 just prompts for user names and passwords. The server does not have to issue
26250 any challenges &-- in some mechanisms the relevant data may all be transmitted
26251 with the AUTH command.
26252 .next
26253 The server either accepts or denies authentication.
26254 .next
26255 If authentication succeeds, the client may optionally make use of the AUTH
26256 option on the MAIL command to pass an authenticated sender in subsequent
26257 mail transactions. Authentication lasts for the remainder of the SMTP
26258 connection.
26259 .next
26260 If authentication fails, the client may give up, or it may try a different
26261 authentication mechanism, or it may try transferring mail over the
26262 unauthenticated connection.
26263 .endlist
26264
26265 If you are setting up a client, and want to know which authentication
26266 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26267 SMTP port) on the server, and issue an EHLO command. The response to this
26268 includes the list of supported mechanisms. For example:
26269 .display
26270 &`$ `&&*&`telnet server.example 25`&*&
26271 &`Trying 192.168.34.25...`&
26272 &`Connected to server.example.`&
26273 &`Escape character is &#x0027;^]&#x0027;.`&
26274 &`220 server.example ESMTP Exim 4.20 ...`&
26275 &*&`ehlo client.example`&*&
26276 &`250-server.example Hello client.example [10.8.4.5]`&
26277 &`250-SIZE 52428800`&
26278 &`250-PIPELINING`&
26279 &`250-AUTH PLAIN`&
26280 &`250 HELP`&
26281 .endd
26282 The second-last line of this example output shows that the server supports
26283 authentication using the PLAIN mechanism. In Exim, the different authentication
26284 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26285 routers and transports, which authenticators are included in the binary is
26286 controlled by build-time definitions. The following are currently available,
26287 included by setting
26288 .code
26289 AUTH_CRAM_MD5=yes
26290 AUTH_CYRUS_SASL=yes
26291 AUTH_DOVECOT=yes
26292 AUTH_EXTERNAL=yes
26293 AUTH_GSASL=yes
26294 AUTH_HEIMDAL_GSSAPI=yes
26295 AUTH_PLAINTEXT=yes
26296 AUTH_SPA=yes
26297 AUTH_TLS=yes
26298 .endd
26299 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26300 authentication mechanism (RFC 2195), and the second provides an interface to
26301 the Cyrus SASL authentication library.
26302 The third is an interface to Dovecot's authentication system, delegating the
26303 work via a socket interface.
26304 .new
26305 The fourth provides for negotiation of authentication done via non-SMTP means,
26306 as defined by RFC 4422 Appendix A.
26307 .wen
26308 The fifth provides an interface to the GNU SASL authentication library, which
26309 provides mechanisms but typically not data sources.
26310 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26311 supporting setting a server keytab.
26312 The seventh can be configured to support
26313 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26314 not formally documented, but used by several MUAs.
26315 The eighth authenticator
26316 supports Microsoft's &'Secure Password Authentication'& mechanism.
26317 The last is an Exim authenticator but not an SMTP one;
26318 instead it can use information from a TLS negotiation.
26319
26320 The authenticators are configured using the same syntax as other drivers (see
26321 section &<<SECTfordricon>>&). If no authenticators are required, no
26322 authentication section need be present in the configuration file. Each
26323 authenticator can in principle have both server and client functions. When Exim
26324 is receiving SMTP mail, it is acting as a server; when it is sending out
26325 messages over SMTP, it is acting as a client. Authenticator configuration
26326 options are provided for use in both these circumstances.
26327
26328 To make it clear which options apply to which situation, the prefixes
26329 &%server_%& and &%client_%& are used on option names that are specific to
26330 either the server or the client function, respectively. Server and client
26331 functions are disabled if none of their options are set. If an authenticator is
26332 to be used for both server and client functions, a single definition, using
26333 both sets of options, is required. For example:
26334 .code
26335 cram:
26336   driver = cram_md5
26337   public_name = CRAM-MD5
26338   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26339   client_name = ph10
26340   client_secret = secret2
26341 .endd
26342 The &%server_%& option is used when Exim is acting as a server, and the
26343 &%client_%& options when it is acting as a client.
26344
26345 Descriptions of the individual authenticators are given in subsequent chapters.
26346 The remainder of this chapter covers the generic options for the
26347 authenticators, followed by general discussion of the way authentication works
26348 in Exim.
26349
26350 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26351 per-mechanism basis.  Please read carefully to determine which variables hold
26352 account labels such as usercodes and which hold passwords or other
26353 authenticating data.
26354
26355 Note that some mechanisms support two different identifiers for accounts: the
26356 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26357 and &'authz'& are commonly encountered.  The American spelling is standard here.
26358 Conceptually, authentication data such as passwords are tied to the identifier
26359 used to authenticate; servers may have rules to permit one user to act as a
26360 second user, so that after login the session is treated as though that second
26361 user had logged in.  That second user is the &'authorization id'&.  A robust
26362 configuration might confirm that the &'authz'& field is empty or matches the
26363 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26364 as verified data, the &'authz'& as an unverified request which the server might
26365 choose to honour.
26366
26367 A &'realm'& is a text string, typically a domain name, presented by a server
26368 to a client to help it select an account and credentials to use.  In some
26369 mechanisms, the client and server provably agree on the realm, but clients
26370 typically can not treat the realm as secure data to be blindly trusted.
26371
26372
26373
26374 .section "Generic options for authenticators" "SECID168"
26375 .cindex "authentication" "generic options"
26376 .cindex "options" "generic; for authenticators"
26377
26378 .option client_condition authenticators string&!! unset
26379 When Exim is authenticating as a client, it skips any authenticator whose
26380 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26381 used, for example, to skip plain text authenticators when the connection is not
26382 encrypted by a setting such as:
26383 .code
26384 client_condition = ${if !eq{$tls_out_cipher}{}}
26385 .endd
26386
26387
26388 .option client_set_id authenticators string&!! unset
26389 When client authentication succeeds, this condition is expanded; the
26390 result is used in the log lines for outbound messages.
26391 Typically it will be the user name used for authentication.
26392
26393
26394 .option driver authenticators string unset
26395 This option must always be set. It specifies which of the available
26396 authenticators is to be used.
26397
26398
26399 .option public_name authenticators string unset
26400 This option specifies the name of the authentication mechanism that the driver
26401 implements, and by which it is known to the outside world. These names should
26402 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26403 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26404 defaults to the driver's instance name.
26405
26406
26407 .option server_advertise_condition authenticators string&!! unset
26408 When a server is about to advertise an authentication mechanism, the condition
26409 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26410 mechanism is not advertised.
26411 If the expansion fails, the mechanism is not advertised. If the failure was not
26412 forced, and was not caused by a lookup defer, the incident is logged.
26413 See section &<<SECTauthexiser>>& below for further discussion.
26414
26415
26416 .option server_condition authenticators string&!! unset
26417 This option must be set for a &%plaintext%& server authenticator, where it
26418 is used directly to control authentication. See section &<<SECTplainserver>>&
26419 for details.
26420
26421 For the &(gsasl)& authenticator, this option is required for various
26422 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26423
26424 For the other authenticators, &%server_condition%& can be used as an additional
26425 authentication or authorization mechanism that is applied after the other
26426 authenticator conditions succeed. If it is set, it is expanded when the
26427 authenticator would otherwise return a success code. If the expansion is forced
26428 to fail, authentication fails. Any other expansion failure causes a temporary
26429 error code to be returned. If the result of a successful expansion is an empty
26430 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26431 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26432 other result, a temporary error code is returned, with the expanded string as
26433 the error text.
26434
26435
26436 .option server_debug_print authenticators string&!! unset
26437 If this option is set and authentication debugging is enabled (see the &%-d%&
26438 command line option), the string is expanded and included in the debugging
26439 output when the authenticator is run as a server. This can help with checking
26440 out the values of variables.
26441 If expansion of the string fails, the error message is written to the debugging
26442 output, and Exim carries on processing.
26443
26444
26445 .option server_set_id authenticators string&!! unset
26446 .vindex "&$authenticated_id$&"
26447 .vindex "&$authenticated_fail_id$&"
26448 When an Exim server successfully authenticates a client, this string is
26449 expanded using data from the authentication, and preserved for any incoming
26450 messages in the variable &$authenticated_id$&. It is also included in the log
26451 lines for incoming messages. For example, a user/password authenticator
26452 configuration might preserve the user name that was used to authenticate, and
26453 refer to it subsequently during delivery of the message.
26454 On a failing authentication the expansion result is instead saved in
26455 the &$authenticated_fail_id$& variable.
26456 If expansion fails, the option is ignored.
26457
26458
26459 .option server_mail_auth_condition authenticators string&!! unset
26460 This option allows a server to discard authenticated sender addresses supplied
26461 as part of MAIL commands in SMTP connections that are authenticated by the
26462 driver on which &%server_mail_auth_condition%& is set. The option is not used
26463 as part of the authentication process; instead its (unexpanded) value is
26464 remembered for later use.
26465 How it is used is described in the following section.
26466
26467
26468
26469
26470
26471 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26472 .cindex "authentication" "sender; authenticated"
26473 .cindex "AUTH" "on MAIL command"
26474 When a client supplied an AUTH= item on a MAIL command, Exim applies
26475 the following checks before accepting it as the authenticated sender of the
26476 message:
26477
26478 .ilist
26479 If the connection is not using extended SMTP (that is, HELO was used rather
26480 than EHLO), the use of AUTH= is a syntax error.
26481 .next
26482 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26483 .next
26484 .vindex "&$authenticated_sender$&"
26485 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26486 running, the value of &$authenticated_sender$& is set to the value obtained
26487 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26488 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26489 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26490 given for the MAIL command.
26491 .next
26492 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26493 is accepted and placed in &$authenticated_sender$& only if the client has
26494 authenticated.
26495 .next
26496 If the AUTH= value was accepted by either of the two previous rules, and
26497 the client has authenticated, and the authenticator has a setting for the
26498 &%server_mail_auth_condition%&, the condition is checked at this point. The
26499 valued that was saved from the authenticator is expanded. If the expansion
26500 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26501 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26502 the value of &$authenticated_sender$& is retained and passed on with the
26503 message.
26504 .endlist
26505
26506
26507 When &$authenticated_sender$& is set for a message, it is passed on to other
26508 hosts to which Exim authenticates as a client. Do not confuse this value with
26509 &$authenticated_id$&, which is a string obtained from the authentication
26510 process, and which is not usually a complete email address.
26511
26512 .vindex "&$sender_address$&"
26513 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26514 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26515 therefore make use of &$authenticated_sender$&. The converse is not true: the
26516 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26517 ACL is run.
26518
26519
26520
26521 .section "Authentication on an Exim server" "SECTauthexiser"
26522 .cindex "authentication" "on an Exim server"
26523 When Exim receives an EHLO command, it advertises the public names of those
26524 authenticators that are configured as servers, subject to the following
26525 conditions:
26526
26527 .ilist
26528 The client host must match &%auth_advertise_hosts%& (default *).
26529 .next
26530 It the &%server_advertise_condition%& option is set, its expansion must not
26531 yield the empty string, &"0"&, &"no"&, or &"false"&.
26532 .endlist
26533
26534 The order in which the authenticators are defined controls the order in which
26535 the mechanisms are advertised.
26536
26537 Some mail clients (for example, some versions of Netscape) require the user to
26538 provide a name and password for authentication whenever AUTH is advertised,
26539 even though authentication may not in fact be needed (for example, Exim may be
26540 set up to allow unconditional relaying from the client by an IP address check).
26541 You can make such clients more friendly by not advertising AUTH to them.
26542 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26543 that runs for RCPT) to relay without authentication, you should set
26544 .code
26545 auth_advertise_hosts = ! 10.9.8.0/24
26546 .endd
26547 so that no authentication mechanisms are advertised to them.
26548
26549 The &%server_advertise_condition%& controls the advertisement of individual
26550 authentication mechanisms. For example, it can be used to restrict the
26551 advertisement of a particular mechanism to encrypted connections, by a setting
26552 such as:
26553 .code
26554 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26555 .endd
26556 .vindex "&$tls_in_cipher$&"
26557 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26558 yields &"yes"&, which allows the advertisement to happen.
26559
26560 When an Exim server receives an AUTH command from a client, it rejects it
26561 immediately if AUTH was not advertised in response to an earlier EHLO
26562 command. This is the case if
26563
26564 .ilist
26565 The client host does not match &%auth_advertise_hosts%&; or
26566 .next
26567 No authenticators are configured with server options; or
26568 .next
26569 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26570 server authenticators.
26571 .endlist
26572
26573
26574 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26575 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26576 AUTH is accepted from any client host.
26577
26578 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26579 server authentication mechanism that was advertised in response to EHLO and
26580 that matches the one named in the AUTH command. If it finds one, it runs
26581 the appropriate authentication protocol, and authentication either succeeds or
26582 fails. If there is no matching advertised mechanism, the AUTH command is
26583 rejected with a 504 error.
26584
26585 .vindex "&$received_protocol$&"
26586 .vindex "&$sender_host_authenticated$&"
26587 When a message is received from an authenticated host, the value of
26588 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26589 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26590 public name) of the authenticator driver that successfully authenticated the
26591 client from which the message was received. This variable is empty if there was
26592 no successful authentication.
26593
26594 .cindex authentication "expansion item"
26595 Successful authentication sets up information used by the
26596 &$authresults$& expansion item.
26597
26598
26599
26600
26601 .section "Testing server authentication" "SECID169"
26602 .cindex "authentication" "testing a server"
26603 .cindex "AUTH" "testing a server"
26604 .cindex "base64 encoding" "creating authentication test data"
26605 Exim's &%-bh%& option can be useful for testing server authentication
26606 configurations. The data for the AUTH command has to be sent using base64
26607 encoding. A quick way to produce such data for testing is the following Perl
26608 script:
26609 .code
26610 use MIME::Base64;
26611 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26612 .endd
26613 .cindex "binary zero" "in authentication data"
26614 This interprets its argument as a Perl string, and then encodes it. The
26615 interpretation as a Perl string allows binary zeros, which are required for
26616 some kinds of authentication, to be included in the data. For example, a
26617 command line to run this script on such data might be
26618 .code
26619 encode '\0user\0password'
26620 .endd
26621 Note the use of single quotes to prevent the shell interpreting the
26622 backslashes, so that they can be interpreted by Perl to specify characters
26623 whose code value is zero.
26624
26625 &*Warning 1*&: If either of the user or password strings starts with an octal
26626 digit, you must use three zeros instead of one after the leading backslash. If
26627 you do not, the octal digit that starts your string will be incorrectly
26628 interpreted as part of the code for the first character.
26629
26630 &*Warning 2*&: If there are characters in the strings that Perl interprets
26631 specially, you must use a Perl escape to prevent them being misinterpreted. For
26632 example, a command such as
26633 .code
26634 encode '\0user@domain.com\0pas$$word'
26635 .endd
26636 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26637
26638 If you have the &%mimencode%& command installed, another way to do produce
26639 base64-encoded strings is to run the command
26640 .code
26641 echo -e -n `\0user\0password' | mimencode
26642 .endd
26643 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26644 in the argument, and the &%-n%& option specifies no newline at the end of its
26645 output. However, not all versions of &%echo%& recognize these options, so you
26646 should check your version before relying on this suggestion.
26647
26648
26649
26650 .section "Authentication by an Exim client" "SECID170"
26651 .cindex "authentication" "on an Exim client"
26652 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26653 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26654 announces support for authentication, and the host matches an entry in either
26655 of these options, Exim (as a client) tries to authenticate as follows:
26656
26657 .ilist
26658 For each authenticator that is configured as a client, in the order in which
26659 they are defined in the configuration, it searches the authentication
26660 mechanisms announced by the server for one whose name matches the public name
26661 of the authenticator.
26662 .next
26663 .vindex "&$host$&"
26664 .vindex "&$host_address$&"
26665 When it finds one that matches, it runs the authenticator's client code. The
26666 variables &$host$& and &$host_address$& are available for any string expansions
26667 that the client might do. They are set to the server's name and IP address. If
26668 any expansion is forced to fail, the authentication attempt is abandoned, and
26669 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26670 delivery to be deferred.
26671 .next
26672 If the result of the authentication attempt is a temporary error or a timeout,
26673 Exim abandons trying to send the message to the host for the moment. It will
26674 try again later. If there are any backup hosts available, they are tried in the
26675 usual way.
26676 .next
26677 If the response to authentication is a permanent error (5&'xx'& code), Exim
26678 carries on searching the list of authenticators and tries another one if
26679 possible. If all authentication attempts give permanent errors, or if there are
26680 no attempts because no mechanisms match (or option expansions force failure),
26681 what happens depends on whether the host matches &%hosts_require_auth%& or
26682 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26683 delivery is deferred. The error can be detected in the retry rules, and thereby
26684 turned into a permanent error if you wish. In the second case, Exim tries to
26685 deliver the message unauthenticated.
26686 .endlist
26687
26688 Note that the hostlist test for whether to do authentication can be
26689 confused if name-IP lookups change between the time the peer is decided
26690 upon and the time that the transport runs.  For example, with a manualroute
26691 router given a host name, and with DNS "round-robin" used by that name: if
26692 the local resolver cache times out between the router and the transport
26693 running, the transport may get an IP for the name for its authentication
26694 check which does not match the connection peer IP.
26695 No authentication will then be done, despite the names being identical.
26696
26697 For such cases use a separate transport which always authenticates.
26698
26699 .cindex "AUTH" "on MAIL command"
26700 When Exim has authenticated itself to a remote server, it adds the AUTH
26701 parameter to the MAIL commands it sends, if it has an authenticated sender for
26702 the message. If the message came from a remote host, the authenticated sender
26703 is the one that was receiving on an incoming MAIL command, provided that the
26704 incoming connection was authenticated and the &%server_mail_auth%& condition
26705 allowed the authenticated sender to be retained. If a local process calls Exim
26706 to send a message, the sender address that is built from the login name and
26707 &%qualify_domain%& is treated as authenticated. However, if the
26708 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26709 the authenticated sender that was received with the message.
26710 .ecindex IIDauthconf1
26711 .ecindex IIDauthconf2
26712
26713
26714
26715
26716
26717
26718 . ////////////////////////////////////////////////////////////////////////////
26719 . ////////////////////////////////////////////////////////////////////////////
26720
26721 .chapter "The plaintext authenticator" "CHAPplaintext"
26722 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26723 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26724 The &(plaintext)& authenticator can be configured to support the PLAIN and
26725 LOGIN authentication mechanisms, both of which transfer authentication data as
26726 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26727 security risk; you are strongly advised to insist on the use of SMTP encryption
26728 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26729 use unencrypted plain text, you should not use the same passwords for SMTP
26730 connections as you do for login accounts.
26731
26732 .section "Plaintext options" "SECID171"
26733 .cindex "options" "&(plaintext)& authenticator (server)"
26734 When configured as a server, &(plaintext)& uses the following options:
26735
26736 .option server_condition authenticators string&!! unset
26737 This is actually a global authentication option, but it must be set in order to
26738 configure the &(plaintext)& driver as a server. Its use is described below.
26739
26740 .option server_prompts plaintext string&!! unset
26741 The contents of this option, after expansion, must be a colon-separated list of
26742 prompt strings. If expansion fails, a temporary authentication rejection is
26743 given.
26744
26745 .section "Using plaintext in a server" "SECTplainserver"
26746 .cindex "AUTH" "in &(plaintext)& authenticator"
26747 .cindex "binary zero" "in &(plaintext)& authenticator"
26748 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26749         "in &(plaintext)& authenticator"
26750 .vindex "&$auth1$&, &$auth2$&, etc"
26751 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26752
26753 When running as a server, &(plaintext)& performs the authentication test by
26754 expanding a string. The data sent by the client with the AUTH command, or in
26755 response to subsequent prompts, is base64 encoded, and so may contain any byte
26756 values when decoded. If any data is supplied with the command, it is treated as
26757 a list of strings, separated by NULs (binary zeros), the first three of which
26758 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26759 (neither LOGIN nor PLAIN uses more than three strings).
26760
26761 For compatibility with previous releases of Exim, the values are also placed in
26762 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26763 variables for this purpose is now deprecated, as it can lead to confusion in
26764 string expansions that also use them for other things.
26765
26766 If there are more strings in &%server_prompts%& than the number of strings
26767 supplied with the AUTH command, the remaining prompts are used to obtain more
26768 data. Each response from the client may be a list of NUL-separated strings.
26769
26770 .vindex "&$authenticated_id$&"
26771 Once a sufficient number of data strings have been received,
26772 &%server_condition%& is expanded. If the expansion is forced to fail,
26773 authentication fails. Any other expansion failure causes a temporary error code
26774 to be returned. If the result of a successful expansion is an empty string,
26775 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26776 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26777 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26778 For any other result, a temporary error code is returned, with the expanded
26779 string as the error text.
26780
26781 &*Warning*&: If you use a lookup in the expansion to find the user's
26782 password, be sure to make the authentication fail if the user is unknown.
26783 There are good and bad examples at the end of the next section.
26784
26785
26786
26787 .section "The PLAIN authentication mechanism" "SECID172"
26788 .cindex "PLAIN authentication mechanism"
26789 .cindex "authentication" "PLAIN mechanism"
26790 .cindex "binary zero" "in &(plaintext)& authenticator"
26791 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26792 sent as one item of data (that is, one combined string containing two NUL
26793 separators). The data is sent either as part of the AUTH command, or
26794 subsequently in response to an empty prompt from the server.
26795
26796 The second and third strings are a user name and a corresponding password.
26797 Using a single fixed user name and password as an example, this could be
26798 configured as follows:
26799 .code
26800 fixed_plain:
26801   driver = plaintext
26802   public_name = PLAIN
26803   server_prompts = :
26804   server_condition = \
26805     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26806   server_set_id = $auth2
26807 .endd
26808 Note that the default result strings from &%if%& (&"true"& or an empty string)
26809 are exactly what we want here, so they need not be specified. Obviously, if the
26810 password contains expansion-significant characters such as dollar, backslash,
26811 or closing brace, they have to be escaped.
26812
26813 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26814 the end of a string list are ignored). If all the data comes as part of the
26815 AUTH command, as is commonly the case, the prompt is not used. This
26816 authenticator is advertised in the response to EHLO as
26817 .code
26818 250-AUTH PLAIN
26819 .endd
26820 and a client host can authenticate itself by sending the command
26821 .code
26822 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26823 .endd
26824 As this contains three strings (more than the number of prompts), no further
26825 data is required from the client. Alternatively, the client may just send
26826 .code
26827 AUTH PLAIN
26828 .endd
26829 to initiate authentication, in which case the server replies with an empty
26830 prompt. The client must respond with the combined data string.
26831
26832 The data string is base64 encoded, as required by the RFC. This example,
26833 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26834 represents a zero byte. This is split up into three strings, the first of which
26835 is empty. The &%server_condition%& option in the authenticator checks that the
26836 second two are &`username`& and &`mysecret`& respectively.
26837
26838 Having just one fixed user name and password, as in this example, is not very
26839 realistic, though for a small organization with only a handful of
26840 authenticating clients it could make sense.
26841
26842 A more sophisticated instance of this authenticator could use the user name in
26843 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26844 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26845 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26846 This is an incorrect example:
26847 .code
26848 server_condition = \
26849   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26850 .endd
26851 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26852 which it then compares to the supplied password (&$auth3$&). Why is this example
26853 incorrect? It works fine for existing users, but consider what happens if a
26854 non-existent user name is given. The lookup fails, but as no success/failure
26855 strings are given for the lookup, it yields an empty string. Thus, to defeat
26856 the authentication, all a client has to do is to supply a non-existent user
26857 name and an empty password. The correct way of writing this test is:
26858 .code
26859 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26860   {${if eq{$value}{$auth3}}} {false}}
26861 .endd
26862 In this case, if the lookup succeeds, the result is checked; if the lookup
26863 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26864 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26865 always fails if its second argument is empty. However, the second way of
26866 writing the test makes the logic clearer.
26867
26868
26869 .section "The LOGIN authentication mechanism" "SECID173"
26870 .cindex "LOGIN authentication mechanism"
26871 .cindex "authentication" "LOGIN mechanism"
26872 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26873 in a number of programs. No data is sent with the AUTH command. Instead, a
26874 user name and password are supplied separately, in response to prompts. The
26875 plaintext authenticator can be configured to support this as in this example:
26876 .code
26877 fixed_login:
26878   driver = plaintext
26879   public_name = LOGIN
26880   server_prompts = User Name : Password
26881   server_condition = \
26882     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26883   server_set_id = $auth1
26884 .endd
26885 Because of the way plaintext operates, this authenticator accepts data supplied
26886 with the AUTH command (in contravention of the specification of LOGIN), but
26887 if the client does not supply it (as is the case for LOGIN clients), the prompt
26888 strings are used to obtain two data items.
26889
26890 Some clients are very particular about the precise text of the prompts. For
26891 example, Outlook Express is reported to recognize only &"Username:"& and
26892 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26893 strings. It uses the &%ldapauth%& expansion condition to check the user
26894 name and password by binding to an LDAP server:
26895 .code
26896 login:
26897   driver = plaintext
26898   public_name = LOGIN
26899   server_prompts = Username:: : Password::
26900   server_condition = ${if and{{ \
26901     !eq{}{$auth1} }{ \
26902     ldapauth{\
26903       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26904       pass=${quote:$auth2} \
26905       ldap://ldap.example.org/} }} }
26906   server_set_id = uid=$auth1,ou=people,o=example.org
26907 .endd
26908 We have to check that the username is not empty before using it, because LDAP
26909 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26910 operator to correctly quote the DN for authentication. However, the basic
26911 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26912 correct one to use for the password, because quoting is needed only to make
26913 the password conform to the Exim syntax. At the LDAP level, the password is an
26914 uninterpreted string.
26915
26916
26917 .section "Support for different kinds of authentication" "SECID174"
26918 A number of string expansion features are provided for the purpose of
26919 interfacing to different ways of user authentication. These include checking
26920 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26921 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26922 &<<SECTexpcond>>&.
26923
26924
26925
26926
26927 .section "Using plaintext in a client" "SECID175"
26928 .cindex "options" "&(plaintext)& authenticator (client)"
26929 The &(plaintext)& authenticator has two client options:
26930
26931 .option client_ignore_invalid_base64 plaintext boolean false
26932 If the client receives a server prompt that is not a valid base64 string,
26933 authentication is abandoned by default. However, if this option is set true,
26934 the error in the challenge is ignored and the client sends the response as
26935 usual.
26936
26937 .option client_send plaintext string&!! unset
26938 The string is a colon-separated list of authentication data strings. Each
26939 string is independently expanded before being sent to the server. The first
26940 string is sent with the AUTH command; any more strings are sent in response
26941 to prompts from the server. Before each string is expanded, the value of the
26942 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26943 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26944 way. Thus, the prompt that is received in response to sending the first string
26945 (with the AUTH command) can be used in the expansion of the second string, and
26946 so on. If an invalid base64 string is received when
26947 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26948 &$auth$&<&'n'&> variable.
26949
26950 &*Note*&: You cannot use expansion to create multiple strings, because
26951 splitting takes priority and happens first.
26952
26953 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26954 the data, further processing is applied to each string before it is sent. If
26955 there are any single circumflex characters in the string, they are converted to
26956 NULs. Should an actual circumflex be required as data, it must be doubled in
26957 the string.
26958
26959 This is an example of a client configuration that implements the PLAIN
26960 authentication mechanism with a fixed user name and password:
26961 .code
26962 fixed_plain:
26963   driver = plaintext
26964   public_name = PLAIN
26965   client_send = ^username^mysecret
26966 .endd
26967 The lack of colons means that the entire text is sent with the AUTH
26968 command, with the circumflex characters converted to NULs. A similar example
26969 that uses the LOGIN mechanism is:
26970 .code
26971 fixed_login:
26972   driver = plaintext
26973   public_name = LOGIN
26974   client_send = : username : mysecret
26975 .endd
26976 The initial colon means that the first string is empty, so no data is sent with
26977 the AUTH command itself. The remaining strings are sent in response to
26978 prompts.
26979 .ecindex IIDplaiauth1
26980 .ecindex IIDplaiauth2
26981
26982
26983
26984
26985 . ////////////////////////////////////////////////////////////////////////////
26986 . ////////////////////////////////////////////////////////////////////////////
26987
26988 .chapter "The cram_md5 authenticator" "CHID9"
26989 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26990 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26991 .cindex "CRAM-MD5 authentication mechanism"
26992 .cindex "authentication" "CRAM-MD5 mechanism"
26993 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26994 sends a challenge string to the client, and the response consists of a user
26995 name and the CRAM-MD5 digest of the challenge string combined with a secret
26996 string (password) which is known to both server and client. Thus, the secret
26997 is not sent over the network as plain text, which makes this authenticator more
26998 secure than &(plaintext)&. However, the downside is that the secret has to be
26999 available in plain text at either end.
27000
27001
27002 .section "Using cram_md5 as a server" "SECID176"
27003 .cindex "options" "&(cram_md5)& authenticator (server)"
27004 This authenticator has one server option, which must be set to configure the
27005 authenticator as a server:
27006
27007 .option server_secret cram_md5 string&!! unset
27008 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27009 When the server receives the client's response, the user name is placed in
27010 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27011 obtain the password for that user. The server then computes the CRAM-MD5 digest
27012 that the client should have sent, and checks that it received the correct
27013 string. If the expansion of &%server_secret%& is forced to fail, authentication
27014 fails. If the expansion fails for some other reason, a temporary error code is
27015 returned to the client.
27016
27017 For compatibility with previous releases of Exim, the user name is also placed
27018 in &$1$&. However, the use of this variables for this purpose is now
27019 deprecated, as it can lead to confusion in string expansions that also use
27020 numeric variables for other things.
27021
27022 For example, the following authenticator checks that the user name given by the
27023 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27024 user name, authentication fails.
27025 .code
27026 fixed_cram:
27027   driver = cram_md5
27028   public_name = CRAM-MD5
27029   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27030   server_set_id = $auth1
27031 .endd
27032 .vindex "&$authenticated_id$&"
27033 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27034 name in &$authenticated_id$&. A more typical configuration might look up the
27035 secret string in a file, using the user name as the key. For example:
27036 .code
27037 lookup_cram:
27038   driver = cram_md5
27039   public_name = CRAM-MD5
27040   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27041                   {$value}fail}
27042   server_set_id = $auth1
27043 .endd
27044 Note that this expansion explicitly forces failure if the lookup fails
27045 because &$auth1$& contains an unknown user name.
27046
27047 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27048 using the relevant libraries, you need to know the realm to specify in the
27049 lookup and then ask for the &"userPassword"& attribute for that user in that
27050 realm, with:
27051 .code
27052 cyrusless_crammd5:
27053   driver = cram_md5
27054   public_name = CRAM-MD5
27055   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27056                   dbmjz{/etc/sasldb2}{$value}fail}
27057   server_set_id = $auth1
27058 .endd
27059
27060 .section "Using cram_md5 as a client" "SECID177"
27061 .cindex "options" "&(cram_md5)& authenticator (client)"
27062 When used as a client, the &(cram_md5)& authenticator has two options:
27063
27064
27065
27066 .option client_name cram_md5 string&!! "the primary host name"
27067 This string is expanded, and the result used as the user name data when
27068 computing the response to the server's challenge.
27069
27070
27071 .option client_secret cram_md5 string&!! unset
27072 This option must be set for the authenticator to work as a client. Its value is
27073 expanded and the result used as the secret string when computing the response.
27074
27075
27076 .vindex "&$host$&"
27077 .vindex "&$host_address$&"
27078 Different user names and secrets can be used for different servers by referring
27079 to &$host$& or &$host_address$& in the options. Forced failure of either
27080 expansion string is treated as an indication that this authenticator is not
27081 prepared to handle this case. Exim moves on to the next configured client
27082 authenticator. Any other expansion failure causes Exim to give up trying to
27083 send the message to the current server.
27084
27085 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27086 strings, is:
27087 .code
27088 fixed_cram:
27089   driver = cram_md5
27090   public_name = CRAM-MD5
27091   client_name = ph10
27092   client_secret = secret
27093 .endd
27094 .ecindex IIDcramauth1
27095 .ecindex IIDcramauth2
27096
27097
27098
27099 . ////////////////////////////////////////////////////////////////////////////
27100 . ////////////////////////////////////////////////////////////////////////////
27101
27102 .chapter "The cyrus_sasl authenticator" "CHID10"
27103 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27104 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27105 .cindex "Cyrus" "SASL library"
27106 .cindex "Kerberos"
27107 The code for this authenticator was provided by Matthew Byng-Maddick while
27108 at A L Digital Ltd.
27109
27110 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27111 library implementation of the RFC 2222 (&"Simple Authentication and Security
27112 Layer"&). This library supports a number of authentication mechanisms,
27113 including PLAIN and LOGIN, but also several others that Exim does not support
27114 directly. In particular, there is support for Kerberos authentication.
27115
27116 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27117 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27118 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27119 name of the driver to determine which mechanism to support.
27120
27121 Where access to some kind of secret file is required, for example, in GSSAPI
27122 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27123 user, and that the Cyrus SASL library has no way of escalating privileges
27124 by default. You may also find you need to set environment variables,
27125 depending on the driver you are using.
27126
27127 The application name provided by Exim is &"exim"&, so various SASL options may
27128 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27129 Kerberos, note that because of limitations in the GSSAPI interface,
27130 changing the server keytab might need to be communicated down to the Kerberos
27131 layer independently. The mechanism for doing so is dependent upon the Kerberos
27132 implementation.
27133
27134 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27135 may be set to point to an alternative keytab file. Exim will pass this
27136 variable through from its own inherited environment when started as root or the
27137 Exim user. The keytab file needs to be readable by the Exim user.
27138 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27139 environment variable.  In practice, for those releases, the Cyrus authenticator
27140 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27141 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27142
27143
27144 .section "Using cyrus_sasl as a server" "SECID178"
27145 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27146 (on a successful authentication) into &$auth1$&. For compatibility with
27147 previous releases of Exim, the username is also placed in &$1$&. However, the
27148 use of this variable for this purpose is now deprecated, as it can lead to
27149 confusion in string expansions that also use numeric variables for other
27150 things.
27151
27152
27153 .option server_hostname cyrus_sasl string&!! "see below"
27154 This option selects the hostname that is used when communicating with the
27155 library. The default value is &`$primary_hostname`&. It is up to the underlying
27156 SASL plug-in what it does with this data.
27157
27158
27159 .option server_mech cyrus_sasl string "see below"
27160 This option selects the authentication mechanism this driver should use. The
27161 default is the value of the generic &%public_name%& option. This option allows
27162 you to use a different underlying mechanism from the advertised name. For
27163 example:
27164 .code
27165 sasl:
27166   driver = cyrus_sasl
27167   public_name = X-ANYTHING
27168   server_mech = CRAM-MD5
27169   server_set_id = $auth1
27170 .endd
27171
27172 .option server_realm cyrus_sasl string&!! unset
27173 This specifies the SASL realm that the server claims to be in.
27174
27175
27176 .option server_service cyrus_sasl string &`smtp`&
27177 This is the SASL service that the server claims to implement.
27178
27179
27180 For straightforward cases, you do not need to set any of the authenticator's
27181 private options. All you need to do is to specify an appropriate mechanism as
27182 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27183 PLAIN, you could have two authenticators as follows:
27184 .code
27185 sasl_cram_md5:
27186   driver = cyrus_sasl
27187   public_name = CRAM-MD5
27188   server_set_id = $auth1
27189
27190 sasl_plain:
27191   driver = cyrus_sasl
27192   public_name = PLAIN
27193   server_set_id = $auth2
27194 .endd
27195 Cyrus SASL does implement the LOGIN authentication method, even though it is
27196 not a standard method. It is disabled by default in the source distribution,
27197 but it is present in many binary distributions.
27198 .ecindex IIDcyrauth1
27199 .ecindex IIDcyrauth2
27200
27201
27202
27203
27204 . ////////////////////////////////////////////////////////////////////////////
27205 . ////////////////////////////////////////////////////////////////////////////
27206 .chapter "The dovecot authenticator" "CHAPdovecot"
27207 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27208 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27209 This authenticator is an interface to the authentication facility of the
27210 Dovecot POP/IMAP server, which can support a number of authentication methods.
27211 Note that Dovecot must be configured to use auth-client not auth-userdb.
27212 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27213 to use the same mechanisms for SMTP authentication. This is a server
27214 authenticator only. There is only one option:
27215
27216 .option server_socket dovecot string unset
27217
27218 This option must specify the UNIX socket that is the interface to Dovecot
27219 authentication. The &%public_name%& option must specify an authentication
27220 mechanism that Dovecot is configured to support. You can have several
27221 authenticators for different mechanisms. For example:
27222 .code
27223 dovecot_plain:
27224   driver = dovecot
27225   public_name = PLAIN
27226   server_socket = /var/run/dovecot/auth-client
27227   server_set_id = $auth1
27228
27229 dovecot_ntlm:
27230   driver = dovecot
27231   public_name = NTLM
27232   server_socket = /var/run/dovecot/auth-client
27233   server_set_id = $auth1
27234 .endd
27235 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27236 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27237 option is passed in the Dovecot authentication command. If, for a TLS
27238 connection, a client certificate has been verified, the &"valid-client-cert"&
27239 option is passed. When authentication succeeds, the identity of the user
27240 who authenticated is placed in &$auth1$&.
27241 .ecindex IIDdcotauth1
27242 .ecindex IIDdcotauth2
27243
27244
27245 . ////////////////////////////////////////////////////////////////////////////
27246 . ////////////////////////////////////////////////////////////////////////////
27247 .chapter "The gsasl authenticator" "CHAPgsasl"
27248 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27249 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27250 .cindex "authentication" "GNU SASL"
27251 .cindex "authentication" "SASL"
27252 .cindex "authentication" "EXTERNAL"
27253 .cindex "authentication" "ANONYMOUS"
27254 .cindex "authentication" "PLAIN"
27255 .cindex "authentication" "LOGIN"
27256 .cindex "authentication" "DIGEST-MD5"
27257 .cindex "authentication" "CRAM-MD5"
27258 .cindex "authentication" "SCRAM-SHA-1"
27259 The &(gsasl)& authenticator provides server integration for the GNU SASL
27260 library and the mechanisms it provides.  This is new as of the 4.80 release
27261 and there are a few areas where the library does not let Exim smoothly
27262 scale to handle future authentication mechanisms, so no guarantee can be
27263 made that any particular new authentication mechanism will be supported
27264 without code changes in Exim.
27265
27266 Exim's &(gsasl)& authenticator does not have client-side support at this
27267 time; only the server-side support is implemented.  Patches welcome.
27268
27269
27270 .option server_channelbinding gsasl boolean false
27271 Do not set this true without consulting a cryptographic engineer.
27272
27273 Some authentication mechanisms are able to use external context at both ends
27274 of the session to bind the authentication to that context, and fail the
27275 authentication process if that context differs.  Specifically, some TLS
27276 ciphersuites can provide identifying information about the cryptographic
27277 context.
27278
27279 This should have meant that certificate identity and verification becomes a
27280 non-issue, as a man-in-the-middle attack will cause the correct client and
27281 server to see different identifiers and authentication will fail.
27282
27283 This is currently only supported when using the GnuTLS library.  This is
27284 only usable by mechanisms which support "channel binding"; at time of
27285 writing, that's the SCRAM family.
27286
27287 This defaults off to ensure smooth upgrade across Exim releases, in case
27288 this option causes some clients to start failing.  Some future release
27289 of Exim might have switched the default to be true.
27290
27291 However, Channel Binding in TLS has proven to be broken in current versions.
27292 Do not plan to rely upon this feature for security, ever, without consulting
27293 with a subject matter expert (a cryptographic engineer).
27294
27295
27296 .option server_hostname gsasl string&!! "see below"
27297 This option selects the hostname that is used when communicating with the
27298 library. The default value is &`$primary_hostname`&.
27299 Some mechanisms will use this data.
27300
27301
27302 .option server_mech gsasl string "see below"
27303 This option selects the authentication mechanism this driver should use. The
27304 default is the value of the generic &%public_name%& option. This option allows
27305 you to use a different underlying mechanism from the advertised name. For
27306 example:
27307 .code
27308 sasl:
27309   driver = gsasl
27310   public_name = X-ANYTHING
27311   server_mech = CRAM-MD5
27312   server_set_id = $auth1
27313 .endd
27314
27315
27316 .option server_password gsasl string&!! unset
27317 Various mechanisms need access to the cleartext password on the server, so
27318 that proof-of-possession can be demonstrated on the wire, without sending
27319 the password itself.
27320
27321 The data available for lookup varies per mechanism.
27322 In all cases, &$auth1$& is set to the &'authentication id'&.
27323 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27324 if available, else the empty string.
27325 The &$auth3$& variable will always be the &'realm'& if available,
27326 else the empty string.
27327
27328 A forced failure will cause authentication to defer.
27329
27330 If using this option, it may make sense to set the &%server_condition%&
27331 option to be simply "true".
27332
27333
27334 .option server_realm gsasl string&!! unset
27335 This specifies the SASL realm that the server claims to be in.
27336 Some mechanisms will use this data.
27337
27338
27339 .option server_scram_iter gsasl string&!! unset
27340 This option provides data for the SCRAM family of mechanisms.
27341 &$auth1$& is not available at evaluation time.
27342 (This may change, as we receive feedback on use)
27343
27344
27345 .option server_scram_salt gsasl string&!! unset
27346 This option provides data for the SCRAM family of mechanisms.
27347 &$auth1$& is not available at evaluation time.
27348 (This may change, as we receive feedback on use)
27349
27350
27351 .option server_service gsasl string &`smtp`&
27352 This is the SASL service that the server claims to implement.
27353 Some mechanisms will use this data.
27354
27355
27356 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27357 .vindex "&$auth1$&, &$auth2$&, etc"
27358 These may be set when evaluating specific options, as detailed above.
27359 They will also be set when evaluating &%server_condition%&.
27360
27361 Unless otherwise stated below, the &(gsasl)& integration will use the following
27362 meanings for these variables:
27363
27364 .ilist
27365 .vindex "&$auth1$&"
27366 &$auth1$&: the &'authentication id'&
27367 .next
27368 .vindex "&$auth2$&"
27369 &$auth2$&: the &'authorization id'&
27370 .next
27371 .vindex "&$auth3$&"
27372 &$auth3$&: the &'realm'&
27373 .endlist
27374
27375 On a per-mechanism basis:
27376
27377 .ilist
27378 .cindex "authentication" "EXTERNAL"
27379 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27380 the &%server_condition%& option must be present.
27381 .next
27382 .cindex "authentication" "ANONYMOUS"
27383 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27384 the &%server_condition%& option must be present.
27385 .next
27386 .cindex "authentication" "GSSAPI"
27387 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27388 &$auth2$& will be set to the &'authorization id'&,
27389 the &%server_condition%& option must be present.
27390 .endlist
27391
27392 An &'anonymous token'& is something passed along as an unauthenticated
27393 identifier; this is analogous to FTP anonymous authentication passing an
27394 email address, or software-identifier@, as the "password".
27395
27396
27397 An example showing the password having the realm specified in the callback
27398 and demonstrating a Cyrus SASL to GSASL migration approach is:
27399 .code
27400 gsasl_cyrusless_crammd5:
27401   driver = gsasl
27402   public_name = CRAM-MD5
27403   server_realm = imap.example.org
27404   server_password = ${lookup{$auth1:$auth3:userPassword}\
27405                     dbmjz{/etc/sasldb2}{$value}fail}
27406   server_set_id = ${quote:$auth1}
27407   server_condition = yes
27408 .endd
27409
27410
27411 . ////////////////////////////////////////////////////////////////////////////
27412 . ////////////////////////////////////////////////////////////////////////////
27413
27414 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27415 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27416 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27417 .cindex "authentication" "GSSAPI"
27418 .cindex "authentication" "Kerberos"
27419 The &(heimdal_gssapi)& authenticator provides server integration for the
27420 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27421 reliably.
27422
27423 .option server_hostname heimdal_gssapi string&!! "see below"
27424 This option selects the hostname that is used, with &%server_service%&,
27425 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27426 identifier.  The default value is &`$primary_hostname`&.
27427
27428 .option server_keytab heimdal_gssapi string&!! unset
27429 If set, then Heimdal will not use the system default keytab (typically
27430 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27431 The value should be a pathname, with no &"file:"& prefix.
27432
27433 .option server_service heimdal_gssapi string&!! "smtp"
27434 This option specifies the service identifier used, in conjunction with
27435 &%server_hostname%&, for building the identifier for finding credentials
27436 from the keytab.
27437
27438
27439 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27440 Beware that these variables will typically include a realm, thus will appear
27441 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27442 not verified, so a malicious client can set it to anything.
27443
27444 The &$auth1$& field should be safely trustable as a value from the Key
27445 Distribution Center.  Note that these are not quite email addresses.
27446 Each identifier is for a role, and so the left-hand-side may include a
27447 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27448
27449 .vindex "&$auth1$&, &$auth2$&, etc"
27450 .ilist
27451 .vindex "&$auth1$&"
27452 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27453 .next
27454 .vindex "&$auth2$&"
27455 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27456 authentication.  If that was empty, this will also be set to the
27457 GSS Display Name.
27458 .endlist
27459
27460
27461 . ////////////////////////////////////////////////////////////////////////////
27462 . ////////////////////////////////////////////////////////////////////////////
27463
27464 .chapter "The spa authenticator" "CHAPspa"
27465 .scindex IIDspaauth1 "&(spa)& authenticator"
27466 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27467 .cindex "authentication" "Microsoft Secure Password"
27468 .cindex "authentication" "NTLM"
27469 .cindex "Microsoft Secure Password Authentication"
27470 .cindex "NTLM authentication"
27471 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27472 Password Authentication'& mechanism,
27473 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27474 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27475 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27476 server side was subsequently contributed by Tom Kistner. The mechanism works as
27477 follows:
27478
27479 .ilist
27480 After the AUTH command has been accepted, the client sends an SPA
27481 authentication request based on the user name and optional domain.
27482 .next
27483 The server sends back a challenge.
27484 .next
27485 The client builds a challenge response which makes use of the user's password
27486 and sends it to the server, which then accepts or rejects it.
27487 .endlist
27488
27489 Encryption is used to protect the password in transit.
27490
27491
27492
27493 .section "Using spa as a server" "SECID179"
27494 .cindex "options" "&(spa)& authenticator (server)"
27495 The &(spa)& authenticator has just one server option:
27496
27497 .option server_password spa string&!! unset
27498 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27499 This option is expanded, and the result must be the cleartext password for the
27500 authenticating user, whose name is at this point in &$auth1$&. For
27501 compatibility with previous releases of Exim, the user name is also placed in
27502 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27503 it can lead to confusion in string expansions that also use numeric variables
27504 for other things. For example:
27505 .code
27506 spa:
27507   driver = spa
27508   public_name = NTLM
27509   server_password = \
27510     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27511 .endd
27512 If the expansion is forced to fail, authentication fails. Any other expansion
27513 failure causes a temporary error code to be returned.
27514
27515
27516
27517
27518
27519 .section "Using spa as a client" "SECID180"
27520 .cindex "options" "&(spa)& authenticator (client)"
27521 The &(spa)& authenticator has the following client options:
27522
27523
27524
27525 .option client_domain spa string&!! unset
27526 This option specifies an optional domain for the authentication.
27527
27528
27529 .option client_password spa string&!! unset
27530 This option specifies the user's password, and must be set.
27531
27532
27533 .option client_username spa string&!! unset
27534 This option specifies the user name, and must be set. Here is an example of a
27535 configuration of this authenticator for use with the mail servers at
27536 &'msn.com'&:
27537 .code
27538 msn:
27539   driver = spa
27540   public_name = MSN
27541   client_username = msn/msn_username
27542   client_password = msn_plaintext_password
27543   client_domain = DOMAIN_OR_UNSET
27544 .endd
27545 .ecindex IIDspaauth1
27546 .ecindex IIDspaauth2
27547
27548
27549
27550
27551
27552 . ////////////////////////////////////////////////////////////////////////////
27553 . ////////////////////////////////////////////////////////////////////////////
27554
27555 .chapter "The external authenticator" "CHAPexternauth"
27556 .scindex IIDexternauth1 "&(external)& authenticator"
27557 .scindex IIDexternauth2 "authenticators" "&(external)&"
27558 .cindex "authentication" "Client Certificate"
27559 .cindex "authentication" "X509"
27560 .cindex "Certificate-based authentication"
27561 The &(external)& authenticator provides support for
27562 authentication based on non-SMTP information.
27563 The specification is in RFC 4422 Appendix A
27564 (&url(https://tools.ietf.org/html/rfc4422)).
27565 It is only a transport and negotiation mechanism;
27566 the process of authentication is entirely controlled
27567 by the server configuration.
27568
27569 The client presents an identity in-clear.
27570 It is probably wise for a server to only advertise,
27571 and for clients to only attempt,
27572 this authentication method on a secure (eg. under TLS) connection.
27573
27574 One possible use, compatible with the
27575 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27576 is for using X509 client certificates.
27577
27578 It thus overlaps in function with the TLS authenticator
27579 (see &<<CHAPtlsauth>>&)
27580 but is a full SMTP SASL authenticator
27581 rather than being implicit for TLS-connection carried
27582 client certificates only.
27583
27584 The examples and discussion in this chapter assume that
27585 client-certificate authentication is being done.
27586
27587 The client must present a certificate,
27588 for which it must have been requested via the
27589 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27590 (see &<<CHAPTLS>>&).
27591 For authentication to be effective the certificate should be
27592 verifiable against a trust-anchor certificate known to the server.
27593
27594 .section "External options" "SECTexternsoptions"
27595 .cindex "options" "&(external)& authenticator (server)"
27596 The &(external)& authenticator has two server options:
27597
27598 .option server_param2 external string&!! unset
27599 .option server_param3 external string&!! unset
27600 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27601 These options are expanded before the &%server_condition%& option
27602 and the result are placed in &$auth2$& and &$auth3$& resectively.
27603 If the expansion is forced to fail, authentication fails. Any other expansion
27604 failure causes a temporary error code to be returned.
27605
27606 They can be used to clarify the coding of a complex &%server_condition%&.
27607
27608 .section "Using external in a server" "SECTexternserver"
27609 .cindex "AUTH" "in &(external)& authenticator"
27610 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27611         "in &(external)& authenticator"
27612 .vindex "&$auth1$&, &$auth2$&, etc"
27613 .cindex "base64 encoding" "in &(external)& authenticator"
27614
27615 When running as a server, &(external)& performs the authentication test by
27616 expanding a string. The data sent by the client with the AUTH command, or in
27617 response to subsequent prompts, is base64 encoded, and so may contain any byte
27618 values when decoded. The decoded value is treated as
27619 an identity for authentication and
27620 placed in the expansion variable &$auth1$&.
27621
27622 For compatibility with previous releases of Exim, the value is also placed in
27623 the expansion variable &$1$&. However, the use of this
27624 variable for this purpose is now deprecated, as it can lead to confusion in
27625 string expansions that also use them for other things.
27626
27627 .vindex "&$authenticated_id$&"
27628 Once an identity has been received,
27629 &%server_condition%& is expanded. If the expansion is forced to fail,
27630 authentication fails. Any other expansion failure causes a temporary error code
27631 to be returned. If the result of a successful expansion is an empty string,
27632 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27633 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27634 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27635 For any other result, a temporary error code is returned, with the expanded
27636 string as the error text.
27637
27638 Example:
27639 .code
27640 ext_ccert_san_mail:
27641   driver =            external
27642   public_name =       EXTERNAL
27643
27644   server_advertise_condition = $tls_in_certificate_verified
27645   server_param2 =     ${certextract {subj_altname,mail,>:} \
27646                                     {$tls_in_peercert}}
27647   server_condition =  ${if forany {$auth2} \
27648                             {eq {$item}{$auth1}}}
27649   server_set_id =     $auth1
27650 .endd
27651 This accepts a client certificate that is verifiable against any
27652 of your configured trust-anchors
27653 (which usually means the full set of public CAs)
27654 and which has a mail-SAN matching the claimed identity sent by the client.
27655
27656 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27657 The account name is therefore guessable by an opponent.
27658 TLS 1.3 protects both server and client certificates, and is not vulnerable
27659 in this way.
27660 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27661
27662
27663 .section "Using external in a client" "SECTexternclient"
27664 .cindex "options" "&(external)& authenticator (client)"
27665 The &(external)& authenticator has one client option:
27666
27667 .option client_send external string&!! unset
27668 This option is expanded and sent with the AUTH command as the
27669 identity being asserted.
27670
27671 Example:
27672 .code
27673 ext_ccert:
27674   driver =      external
27675   public_name = EXTERNAL
27676
27677   client_condition = ${if !eq{$tls_out_cipher}{}}
27678   client_send = myaccount@smarthost.example.net
27679 .endd
27680
27681
27682 .ecindex IIDexternauth1
27683 .ecindex IIDexternauth2
27684
27685
27686
27687
27688
27689 . ////////////////////////////////////////////////////////////////////////////
27690 . ////////////////////////////////////////////////////////////////////////////
27691
27692 .chapter "The tls authenticator" "CHAPtlsauth"
27693 .scindex IIDtlsauth1 "&(tls)& authenticator"
27694 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27695 .cindex "authentication" "Client Certificate"
27696 .cindex "authentication" "X509"
27697 .cindex "Certificate-based authentication"
27698 The &(tls)& authenticator provides server support for
27699 authentication based on client certificates.
27700
27701 It is not an SMTP authentication mechanism and is not
27702 advertised by the server as part of the SMTP EHLO response.
27703 It is an Exim authenticator in the sense that it affects
27704 the protocol element of the log line, can be tested for
27705 by the &%authenticated%& ACL condition, and can set
27706 the &$authenticated_id$& variable.
27707
27708 The client must present a verifiable certificate,
27709 for which it must have been requested via the
27710 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27711 (see &<<CHAPTLS>>&).
27712
27713 If an authenticator of this type is configured it is
27714 run before any SMTP-level communication is done,
27715 and can authenticate the connection.
27716 If it does, SMTP authentication is not offered.
27717
27718 A maximum of one authenticator of this type may be present.
27719
27720
27721 .cindex "options" "&(tls)& authenticator (server)"
27722 The &(tls)& authenticator has three server options:
27723
27724 .option server_param1 tls string&!! unset
27725 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27726 This option is expanded after the TLS negotiation and
27727 the result is placed in &$auth1$&.
27728 If the expansion is forced to fail, authentication fails. Any other expansion
27729 failure causes a temporary error code to be returned.
27730
27731 .option server_param2 tls string&!! unset
27732 .option server_param3 tls string&!! unset
27733 As above, for &$auth2$& and &$auth3$&.
27734
27735 &%server_param1%& may also be spelled &%server_param%&.
27736
27737
27738 Example:
27739 .code
27740 tls:
27741   driver = tls
27742   server_param1 =     ${certextract {subj_altname,mail,>:} \
27743                                     {$tls_in_peercert}}
27744   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
27745                                  {forany {$auth1} \
27746                             {!= {0} \
27747                                 {${lookup ldap{ldap:///\
27748                          mailname=${quote_ldap_dn:${lc:$item}},\
27749                          ou=users,LDAP_DC?mailid} {$value}{0} \
27750                        }    }  } }}}
27751   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27752 .endd
27753 This accepts a client certificate that is verifiable against any
27754 of your configured trust-anchors
27755 (which usually means the full set of public CAs)
27756 and which has a SAN with a good account name.
27757
27758 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27759 The account name is therefore guessable by an opponent.
27760 TLS 1.3 protects both server and client certificates, and is not vulnerable
27761 in this way.
27762 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27763
27764 . An alternative might use
27765 . .code
27766 .   server_param1 = ${sha256:$tls_in_peercert}
27767 . .endd
27768 . to require one of a set of specific certs that define a given account
27769 . (the verification is still required, but mostly irrelevant).
27770 . This would help for per-device use.
27771 .
27772 . However, for the future we really need support for checking a
27773 . user cert in LDAP - which probably wants a base-64 DER.
27774
27775 .ecindex IIDtlsauth1
27776 .ecindex IIDtlsauth2
27777
27778
27779 Note that because authentication is traditionally an SMTP operation,
27780 the &%authenticated%& ACL condition cannot be used in
27781 a connect- or helo-ACL.
27782
27783
27784
27785 . ////////////////////////////////////////////////////////////////////////////
27786 . ////////////////////////////////////////////////////////////////////////////
27787
27788 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27789          "Encrypted SMTP connections"
27790 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27791 .scindex IIDencsmtp2 "SMTP" "encryption"
27792 .cindex "TLS" "on SMTP connection"
27793 .cindex "OpenSSL"
27794 .cindex "GnuTLS"
27795 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27796 Sockets Layer), is implemented by making use of the OpenSSL library or the
27797 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27798 cryptographic code in the Exim distribution itself for implementing TLS. In
27799 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27800 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27801 You also need to understand the basic concepts of encryption at a managerial
27802 level, and in particular, the way that public keys, private keys, and
27803 certificates are used.
27804
27805 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27806 connection is established, the client issues a STARTTLS command. If the
27807 server accepts this, the client and the server negotiate an encryption
27808 mechanism. If the negotiation succeeds, the data that subsequently passes
27809 between them is encrypted.
27810
27811 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27812 and if so, what cipher suite is in use, whether the client supplied a
27813 certificate, and whether or not that certificate was verified. This makes it
27814 possible for an Exim server to deny or accept certain commands based on the
27815 encryption state.
27816
27817 &*Warning*&: Certain types of firewall and certain anti-virus products can
27818 disrupt TLS connections. You need to turn off SMTP scanning for these products
27819 in order to get TLS to work.
27820
27821
27822
27823 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
27824          "SECID284"
27825 .cindex "submissions protocol"
27826 .cindex "ssmtp protocol"
27827 .cindex "smtps protocol"
27828 .cindex "SMTP" "submissions protocol"
27829 .cindex "SMTP" "ssmtp protocol"
27830 .cindex "SMTP" "smtps protocol"
27831 The history of port numbers for TLS in SMTP is a little messy and has been
27832 contentious.  As of RFC 8314, the common practice of using the historically
27833 allocated port 465 for "email submission but with TLS immediately upon connect
27834 instead of using STARTTLS" is officially blessed by the IETF, and recommended
27835 by them in preference to STARTTLS.
27836
27837 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
27838 clarity emerged over the dual roles of SMTP, for MX delivery and Email
27839 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
27840
27841 This approach was, for a while, officially abandoned when encrypted SMTP was
27842 standardized, but many clients kept using it, even as the TCP port number was
27843 reassigned for other use.
27844 Thus you may encounter guidance claiming that you shouldn't enable use of
27845 this port.
27846 In practice, a number of mail-clients have only ever supported submissions,
27847 not submission with STARTTLS upgrade.
27848 Ideally, offer both submission (587) and submissions (465) service.
27849
27850 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
27851 global option. Its value must be a list of port numbers;
27852 the most common use is expected to be:
27853 .code
27854 tls_on_connect_ports = 465
27855 .endd
27856 The port numbers specified by this option apply to all SMTP connections, both
27857 via the daemon and via &'inetd'&. You still need to specify all the ports that
27858 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27859 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27860 an extra port &-- rather, it specifies different behaviour on a port that is
27861 defined elsewhere.
27862
27863 There is also a &%-tls-on-connect%& command line option. This overrides
27864 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
27865
27866
27867
27868
27869
27870
27871 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27872 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27873 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27874 followed later, when the first versions of GnuTLS were released. To build Exim
27875 to use GnuTLS, you need to set
27876 .code
27877 USE_GNUTLS=yes
27878 .endd
27879 in Local/Makefile, in addition to
27880 .code
27881 SUPPORT_TLS=yes
27882 .endd
27883 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27884 include files and libraries for GnuTLS can be found.
27885
27886 There are some differences in usage when using GnuTLS instead of OpenSSL:
27887
27888 .ilist
27889 The &%tls_verify_certificates%& option
27890 cannot be the path of a directory
27891 for GnuTLS versions before 3.3.6
27892 (for later versions, or OpenSSL, it can be either).
27893 .next
27894 The default value for &%tls_dhparam%& differs for historical reasons.
27895 .next
27896 .vindex "&$tls_in_peerdn$&"
27897 .vindex "&$tls_out_peerdn$&"
27898 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27899 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27900 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27901 .next
27902 OpenSSL identifies cipher suites using hyphens as separators, for example:
27903 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
27904 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
27905 in a cipher list. To make life simpler, Exim changes underscores to hyphens
27906 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
27907 to handle its own older variants) when processing lists of cipher suites in the
27908 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
27909 option).
27910 .next
27911 The &%tls_require_ciphers%& options operate differently, as described in the
27912 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27913 .next
27914 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27915 When using OpenSSL, this option is ignored.
27916 (If an API is found to let OpenSSL be configured in this way,
27917 let the Exim Maintainers know and we'll likely use it).
27918 .next
27919 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
27920 main option, it must be ordered to match the &%tls_certificate%& list.
27921 .next
27922 Some other recently added features may only be available in one or the other.
27923 This should be documented with the feature.  If the documentation does not
27924 explicitly state that the feature is infeasible in the other TLS
27925 implementation, then patches are welcome.
27926 .endlist
27927
27928
27929 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27930 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27931 an explicit path; if the latter, then the text about generation still applies,
27932 but not the chosen filename.
27933 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27934 See the documentation of &%tls_dhparam%& for more information.
27935
27936 GnuTLS uses D-H parameters that may take a substantial amount of time
27937 to compute. It is unreasonable to re-compute them for every TLS session.
27938 Therefore, Exim keeps this data in a file in its spool directory, called
27939 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27940 of bits requested.
27941 The file is owned by the Exim user and is readable only by
27942 its owner. Every Exim process that start up GnuTLS reads the D-H
27943 parameters from this file. If the file does not exist, the first Exim process
27944 that needs it computes the data and writes it to a temporary file which is
27945 renamed once it is complete. It does not matter if several Exim processes do
27946 this simultaneously (apart from wasting a few resources). Once a file is in
27947 place, new Exim processes immediately start using it.
27948
27949 For maximum security, the parameters that are stored in this file should be
27950 recalculated periodically, the frequency depending on your paranoia level.
27951 If you are avoiding using the fixed D-H primes published in RFCs, then you
27952 are concerned about some advanced attacks and will wish to do this; if you do
27953 not regenerate then you might as well stick to the standard primes.
27954
27955 Arranging this is easy in principle; just delete the file when you want new
27956 values to be computed. However, there may be a problem. The calculation of new
27957 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27958 If the system is not very active, &_/dev/random_& may delay returning data
27959 until enough randomness (entropy) is available. This may cause Exim to hang for
27960 a substantial amount of time, causing timeouts on incoming connections.
27961
27962 The solution is to generate the parameters externally to Exim. They are stored
27963 in &_gnutls-params-N_& in PEM format, which means that they can be
27964 generated externally using the &(certtool)& command that is part of GnuTLS.
27965
27966 To replace the parameters with new ones, instead of deleting the file
27967 and letting Exim re-create it, you can generate new parameters using
27968 &(certtool)& and, when this has been done, replace Exim's cache file by
27969 renaming. The relevant commands are something like this:
27970 .code
27971 # ls
27972 [ look for file; assume gnutls-params-2236 is the most recent ]
27973 # rm -f new-params
27974 # touch new-params
27975 # chown exim:exim new-params
27976 # chmod 0600 new-params
27977 # certtool --generate-dh-params --bits 2236 >>new-params
27978 # openssl dhparam -noout -text -in new-params | head
27979 [ check the first line, make sure it's not more than 2236;
27980   if it is, then go back to the start ("rm") and repeat
27981   until the size generated is at most the size requested ]
27982 # chmod 0400 new-params
27983 # mv new-params gnutls-params-2236
27984 .endd
27985 If Exim never has to generate the parameters itself, the possibility of
27986 stalling is removed.
27987
27988 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27989 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27990 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27991 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27992 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27993 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27994 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27995 which applies to all D-H usage, client or server.  If the value returned by
27996 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27997 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27998 limit, which is still much higher than Exim historically used.
27999
28000 The filename and bits used will change as the GnuTLS maintainers change the
28001 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28002 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28003 2432 bits, while NSS is limited to 2236 bits.
28004
28005 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28006 increase the chance of the generated prime actually being within acceptable
28007 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28008 procedure above.  There is no sane procedure available to Exim to double-check
28009 the size of the generated prime, so it might still be too large.
28010
28011
28012 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28013 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28014 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28015 There is a function in the OpenSSL library that can be passed a list of cipher
28016 suites before the cipher negotiation takes place. This specifies which ciphers
28017 are acceptable for TLS versions prior to 1.3.
28018 The list is colon separated and may contain names like
28019 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28020 directly to this function call.
28021 Many systems will install the OpenSSL manual-pages, so you may have
28022 &'ciphers(1)'& available to you.
28023 The following quotation from the OpenSSL
28024 documentation specifies what forms of item are allowed in the cipher string:
28025
28026 .ilist
28027 It can consist of a single cipher suite such as RC4-SHA.
28028 .next
28029 It can represent a list of cipher suites containing a certain algorithm,
28030 or cipher suites of a certain type. For example SHA1 represents all
28031 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28032 SSL v3 algorithms.
28033 .next
28034 Lists of cipher suites can be combined in a single cipher string using
28035 the + character. This is used as a logical and operation. For example
28036 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28037 algorithms.
28038 .endlist
28039
28040 Each cipher string can be optionally preceded by one of the characters &`!`&,
28041 &`-`& or &`+`&.
28042 .ilist
28043 If &`!`& is used, the ciphers are permanently deleted from the list. The
28044 ciphers deleted can never reappear in the list even if they are explicitly
28045 stated.
28046 .next
28047 If &`-`& is used, the ciphers are deleted from the list, but some or all
28048 of the ciphers can be added again by later options.
28049 .next
28050 If &`+`& is used, the ciphers are moved to the end of the list. This
28051 option does not add any new ciphers; it just moves matching existing ones.
28052 .endlist
28053
28054 If none of these characters is present, the string is interpreted as
28055 a list of ciphers to be appended to the current preference list. If the list
28056 includes any ciphers already present they will be ignored: that is, they will
28057 not be moved to the end of the list.
28058 .endlist
28059
28060 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28061 string:
28062 .code
28063 # note single-quotes to get ! past any shell history expansion
28064 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28065 .endd
28066
28067 This example will let the library defaults be permitted on the MX port, where
28068 there's probably no identity verification anyway, but ups the ante on the
28069 submission ports where the administrator might have some influence on the
28070 choice of clients used:
28071 .code
28072 # OpenSSL variant; see man ciphers(1)
28073 tls_require_ciphers = ${if =={$received_port}{25}\
28074                            {DEFAULT}\
28075                            {HIGH:!MD5:!SHA1}}
28076 .endd
28077
28078 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28079 .code
28080 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28081 .endd
28082
28083 For TLS version 1.3 the control available is less fine-grained
28084 and Exim does not provide access to it at present.
28085 The value of the &%tls_require_ciphers%& option is ignored when
28086 TLS version 1.3 is negotiated.
28087
28088 As of writing the library default cipher suite list for TLSv1.3 is
28089 .code
28090 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28091 .endd
28092
28093
28094 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28095          "SECTreqciphgnu"
28096 .cindex "GnuTLS" "specifying parameters for"
28097 .cindex "TLS" "specifying ciphers (GnuTLS)"
28098 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28099 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28100 .cindex "TLS" "specifying protocols (GnuTLS)"
28101 .cindex "TLS" "specifying priority string (GnuTLS)"
28102 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28103 The GnuTLS library allows the caller to provide a "priority string", documented
28104 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28105 ciphersuite specification in OpenSSL.
28106
28107 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28108 and controls both protocols and ciphers.
28109
28110 The &%tls_require_ciphers%& option is available both as an global option,
28111 controlling how Exim behaves as a server, and also as an option of the
28112 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28113 the value is string expanded.  The resulting string is not an Exim list and
28114 the string is given to the GnuTLS library, so that Exim does not need to be
28115 aware of future feature enhancements of GnuTLS.
28116
28117 Documentation of the strings accepted may be found in the GnuTLS manual, under
28118 "Priority strings".  This is online as
28119 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28120 but beware that this relates to GnuTLS 3, which may be newer than the version
28121 installed on your system.  If you are using GnuTLS 3,
28122 then the example code
28123 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28124 on that site can be used to test a given string.
28125
28126 For example:
28127 .code
28128 # Disable older versions of protocols
28129 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28130 .endd
28131
28132 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28133 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28134 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28135
28136 This example will let the library defaults be permitted on the MX port, where
28137 there's probably no identity verification anyway, and lowers security further
28138 by increasing compatibility; but this ups the ante on the submission ports
28139 where the administrator might have some influence on the choice of clients
28140 used:
28141 .code
28142 # GnuTLS variant
28143 tls_require_ciphers = ${if =={$received_port}{25}\
28144                            {NORMAL:%COMPAT}\
28145                            {SECURE128}}
28146 .endd
28147
28148
28149 .section "Configuring an Exim server to use TLS" "SECID182"
28150 .cindex "TLS" "configuring an Exim server"
28151 When Exim has been built with TLS support, it advertises the availability of
28152 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28153 but not to any others. The default value of this option is *, which means
28154 that STARTTLS is always advertised.  Set it to blank to never advertise;
28155 this is reasonable for systems that want to use TLS only as a client.
28156
28157 If STARTTLS is to be used you
28158 need to set some other options in order to make TLS available.
28159
28160 If a client issues a STARTTLS command and there is some configuration
28161 problem in the server, the command is rejected with a 454 error. If the client
28162 persists in trying to issue SMTP commands, all except QUIT are rejected
28163 with the error
28164 .code
28165 554 Security failure
28166 .endd
28167 If a STARTTLS command is issued within an existing TLS session, it is
28168 rejected with a 554 error code.
28169
28170 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28171 must be set to match some hosts. The default is * which matches all hosts.
28172
28173 If this is all you do, TLS encryption will be enabled but not authentication -
28174 meaning that the peer has no assurance it is actually you he is talking to.
28175 You gain protection from a passive sniffer listening on the wire but not
28176 from someone able to intercept the communication.
28177
28178 Further protection requires some further configuration at the server end.
28179
28180 To make TLS work you need to set, in the server,
28181 .code
28182 tls_certificate = /some/file/name
28183 tls_privatekey = /some/file/name
28184 .endd
28185 These options are, in fact, expanded strings, so you can make them depend on
28186 the identity of the client that is connected if you wish. The first file
28187 contains the server's X509 certificate, and the second contains the private key
28188 that goes with it. These files need to be
28189 PEM format and readable by the Exim user, and must
28190 always be given as full path names.
28191 The key must not be password-protected.
28192 They can be the same file if both the
28193 certificate and the key are contained within it. If &%tls_privatekey%& is not
28194 set, or if its expansion is forced to fail or results in an empty string, this
28195 is assumed to be the case. The certificate file may also contain intermediate
28196 certificates that need to be sent to the client to enable it to authenticate
28197 the server's certificate.
28198
28199 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28200 colon-separated lists of file paths.  Ciphers using given authentication
28201 algorithms require the presence of a suitable certificate to supply the
28202 public-key.  The server selects among the certificates to present to the
28203 client depending on the selected cipher, hence the priority ordering for
28204 ciphers will affect which certificate is used.
28205
28206 If you do not understand about certificates and keys, please try to find a
28207 source of this background information, which is not Exim-specific. (There are a
28208 few comments below in section &<<SECTcerandall>>&.)
28209
28210 &*Note*&: These options do not apply when Exim is operating as a client &--
28211 they apply only in the case of a server. If you need to use a certificate in an
28212 Exim client, you must set the options of the same names in an &(smtp)&
28213 transport.
28214
28215 With just these options, an Exim server will be able to use TLS. It does not
28216 require the client to have a certificate (but see below for how to insist on
28217 this). There is one other option that may be needed in other situations. If
28218 .code
28219 tls_dhparam = /some/file/name
28220 .endd
28221 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28222 with the parameters contained in the file.
28223 Set this to &`none`& to disable use of DH entirely, by making no prime
28224 available:
28225 .code
28226 tls_dhparam = none
28227 .endd
28228 This may also be set to a string identifying a standard prime to be used for
28229 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28230 used is &`ike23`&.  There are a few standard primes available, see the
28231 documentation for &%tls_dhparam%& for the complete list.
28232
28233 See the command
28234 .code
28235 openssl dhparam
28236 .endd
28237 for a way of generating file data.
28238
28239 The strings supplied for these three options are expanded every time a client
28240 host connects. It is therefore possible to use different certificates and keys
28241 for different hosts, if you so wish, by making use of the client's IP address
28242 in &$sender_host_address$& to control the expansion. If a string expansion is
28243 forced to fail, Exim behaves as if the option is not set.
28244
28245 .cindex "cipher" "logging"
28246 .cindex "log" "TLS cipher"
28247 .vindex "&$tls_in_cipher$&"
28248 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28249 an incoming TLS connection. It is included in the &'Received:'& header of an
28250 incoming message (by default &-- you can, of course, change this), and it is
28251 also included in the log line that records a message's arrival, keyed by
28252 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28253 condition can be used to test for specific cipher suites in ACLs.
28254
28255 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28256 can check the name of the cipher suite and vary their actions accordingly. The
28257 cipher suite names vary, depending on which TLS library is being used. For
28258 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28259 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28260 documentation for more details.
28261
28262 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28263 (again depending on the &%tls_cipher%& log selector).
28264
28265
28266 .section "Requesting and verifying client certificates" "SECID183"
28267 .cindex "certificate" "verification of client"
28268 .cindex "TLS" "client certificate verification"
28269 If you want an Exim server to request a certificate when negotiating a TLS
28270 session with a client, you must set either &%tls_verify_hosts%& or
28271 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28272 apply to all TLS connections. For any host that matches one of these options,
28273 Exim requests a certificate as part of the setup of the TLS session. The
28274 contents of the certificate are verified by comparing it with a list of
28275 expected trust-anchors or certificates.
28276 These may be the system default set (depending on library version),
28277 an explicit file or,
28278 depending on library version, a directory, identified by
28279 &%tls_verify_certificates%&.
28280
28281 A file can contain multiple certificates, concatenated end to end. If a
28282 directory is used
28283 (OpenSSL only),
28284 each certificate must be in a separate file, with a name (or a symbolic link)
28285 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28286 certificate. You can compute the relevant hash by running the command
28287 .code
28288 openssl x509 -hash -noout -in /cert/file
28289 .endd
28290 where &_/cert/file_& contains a single certificate.
28291
28292 There is no checking of names of the client against the certificate
28293 Subject Name or Subject Alternate Names.
28294
28295 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28296 what happens if the client does not supply a certificate, or if the certificate
28297 does not match any of the certificates in the collection named by
28298 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28299 attempt to set up a TLS session is aborted, and the incoming connection is
28300 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28301 session continues. ACLs that run for subsequent SMTP commands can detect the
28302 fact that no certificate was verified, and vary their actions accordingly. For
28303 example, you can insist on a certificate before accepting a message for
28304 relaying, but not when the message is destined for local delivery.
28305
28306 .vindex "&$tls_in_peerdn$&"
28307 When a client supplies a certificate (whether it verifies or not), the value of
28308 the Distinguished Name of the certificate is made available in the variable
28309 &$tls_in_peerdn$& during subsequent processing of the message.
28310
28311 .cindex "log" "distinguished name"
28312 Because it is often a long text string, it is not included in the log line or
28313 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28314 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28315 &%received_header_text%& to change the &'Received:'& header. When no
28316 certificate is supplied, &$tls_in_peerdn$& is empty.
28317
28318
28319 .section "Revoked certificates" "SECID184"
28320 .cindex "TLS" "revoked certificates"
28321 .cindex "revocation list"
28322 .cindex "certificate" "revocation list"
28323 .cindex "OCSP" "stapling"
28324 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28325 certificates are revoked. If you have such a list, you can pass it to an Exim
28326 server using the global option called &%tls_crl%& and to an Exim client using
28327 an identically named option for the &(smtp)& transport. In each case, the value
28328 of the option is expanded and must then be the name of a file that contains a
28329 CRL in PEM format.
28330 The downside is that clients have to periodically re-download a potentially huge
28331 file from every certificate authority they know of.
28332
28333 The way with most moving parts at query time is Online Certificate
28334 Status Protocol (OCSP), where the client verifies the certificate
28335 against an OCSP server run by the CA.  This lets the CA track all
28336 usage of the certs.  It requires running software with access to the
28337 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28338 is based on HTTP and can be proxied accordingly.
28339
28340 The only widespread OCSP server implementation (known to this writer)
28341 comes as part of OpenSSL and aborts on an invalid request, such as
28342 connecting to the port and then disconnecting.  This requires
28343 re-entering the passphrase each time some random client does this.
28344
28345 The third way is OCSP Stapling; in this, the server using a certificate
28346 issued by the CA periodically requests an OCSP proof of validity from
28347 the OCSP server, then serves it up inline as part of the TLS
28348 negotiation.   This approach adds no extra round trips, does not let the
28349 CA track users, scales well with number of certs issued by the CA and is
28350 resilient to temporary OCSP server failures, as long as the server
28351 starts retrying to fetch an OCSP proof some time before its current
28352 proof expires.  The downside is that it requires server support.
28353
28354 Unless Exim is built with the support disabled,
28355 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28356 support for OCSP stapling is included.
28357
28358 There is a global option called &%tls_ocsp_file%&.
28359 The file specified therein is expected to be in DER format, and contain
28360 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28361 option will be re-expanded for SNI, if the &%tls_certificate%& option
28362 contains &`tls_in_sni`&, as per other TLS options.
28363
28364 Exim does not at this time implement any support for fetching a new OCSP
28365 proof.  The burden is on the administrator to handle this, outside of
28366 Exim.  The file specified should be replaced atomically, so that the
28367 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28368 on each connection, so a new file will be handled transparently on the
28369 next connection.
28370
28371 When built with OpenSSL Exim will check for a valid next update timestamp
28372 in the OCSP proof; if not present, or if the proof has expired, it will be
28373 ignored.
28374
28375 For the client to be able to verify the stapled OCSP the server must
28376 also supply, in its stapled information, any intermediate
28377 certificates for the chain leading to the OCSP proof from the signer
28378 of the server certificate.  There may be zero or one such. These
28379 intermediate certificates should be added to the server OCSP stapling
28380 file named by &%tls_ocsp_file%&.
28381
28382 Note that the proof only covers the terminal server certificate,
28383 not any of the chain from CA to it.
28384
28385 There is no current way to staple a proof for a client certificate.
28386
28387 .code
28388   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28389   OCSP server is supplied.  The server URL may be included in the
28390   server certificate, if the CA is helpful.
28391
28392   One failure mode seen was the OCSP Signer cert expiring before the end
28393   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28394   noted this as invalid overall, but the re-fetch script did not.
28395 .endd
28396
28397
28398
28399
28400 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28401 .cindex "cipher" "logging"
28402 .cindex "log" "TLS cipher"
28403 .cindex "log" "distinguished name"
28404 .cindex "TLS" "configuring an Exim client"
28405 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28406 deliveries as well as to incoming, the latter one causing logging of the
28407 server certificate's DN. The remaining client configuration for TLS is all
28408 within the &(smtp)& transport.
28409
28410 It is not necessary to set any options to have TLS work in the &(smtp)&
28411 transport. If Exim is built with TLS support, and TLS is advertised by a
28412 server, the &(smtp)& transport always tries to start a TLS session. However,
28413 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28414 transport) to a list of server hosts for which TLS should not be used.
28415
28416 If you do not want Exim to attempt to send messages unencrypted when an attempt
28417 to set up an encrypted connection fails in any way, you can set
28418 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28419 those hosts, delivery is always deferred if an encrypted connection cannot be
28420 set up. If there are any other hosts for the address, they are tried in the
28421 usual way.
28422
28423 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28424 the message unencrypted. It always does this if the response to STARTTLS is
28425 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28426 session after a success response code, what happens is controlled by the
28427 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28428 delivery to this host is deferred, and other hosts (if available) are tried. If
28429 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28430 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28431 negotiation fails, Exim closes the current connection (because it is in an
28432 unknown state), opens a new one to the same host, and then tries the delivery
28433 unencrypted.
28434
28435 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28436 transport provide the client with a certificate, which is passed to the server
28437 if it requests it. If the server is Exim, it will request a certificate only if
28438 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28439
28440 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28441 specifies a collection of expected server certificates.
28442 These may be
28443 the system default set (depending on library version),
28444 a file,
28445 or (depending on library version) a directory.
28446 The client verifies the server's certificate
28447 against this collection, taking into account any revoked certificates that are
28448 in the list defined by &%tls_crl%&.
28449 Failure to verify fails the TLS connection unless either of the
28450 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28451
28452 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28453 certificate verification to the listed servers.  Verification either must
28454 or need not succeed respectively.
28455
28456 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28457 checks are made: that the host name (the one in the DNS A record)
28458 is valid for the certificate.
28459 The option defaults to always checking.
28460
28461 The &(smtp)& transport has two OCSP-related options:
28462 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28463 is requested and required for the connection to proceed.  The default
28464 value is empty.
28465 &%hosts_request_ocsp%&; a host-list for which (additionally)
28466 a Certificate Status is requested (but not necessarily verified).  The default
28467 value is "*" meaning that requests are made unless configured
28468 otherwise.
28469
28470 The host(s) should also be in &%hosts_require_tls%&, and
28471 &%tls_verify_certificates%& configured for the transport,
28472 for OCSP to be relevant.
28473
28474 If
28475 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28476 list of permitted cipher suites. If either of these checks fails, delivery to
28477 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28478 alternative hosts, if any.
28479
28480  &*Note*&:
28481 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28482 is operating as a client. Exim does not assume that a server certificate (set
28483 by the global options of the same name) should also be used when operating as a
28484 client.
28485
28486 .vindex "&$host$&"
28487 .vindex "&$host_address$&"
28488 All the TLS options in the &(smtp)& transport are expanded before use, with
28489 &$host$& and &$host_address$& containing the name and address of the server to
28490 which the client is connected. Forced failure of an expansion causes Exim to
28491 behave as if the relevant option were unset.
28492
28493 .vindex &$tls_out_bits$&
28494 .vindex &$tls_out_cipher$&
28495 .vindex &$tls_out_peerdn$&
28496 .vindex &$tls_out_sni$&
28497 Before an SMTP connection is established, the
28498 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28499 variables are emptied. (Until the first connection, they contain the values
28500 that were set when the message was received.) If STARTTLS is subsequently
28501 successfully obeyed, these variables are set to the relevant values for the
28502 outgoing connection.
28503
28504
28505
28506 .section "Use of TLS Server Name Indication" "SECTtlssni"
28507 .cindex "TLS" "Server Name Indication"
28508 .vindex "&$tls_in_sni$&"
28509 .oindex "&%tls_in_sni%&"
28510 With TLS1.0 or above, there is an extension mechanism by which extra
28511 information can be included at various points in the protocol.  One of these
28512 extensions, documented in RFC 6066 (and before that RFC 4366) is
28513 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28514 client in the initial handshake, so that the server can examine the servername
28515 within and possibly choose to use different certificates and keys (and more)
28516 for this session.
28517
28518 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28519 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28520 address.
28521
28522 With SMTP to MX, there are the same problems here as in choosing the identity
28523 against which to validate a certificate: you can't rely on insecure DNS to
28524 provide the identity which you then cryptographically verify.  So this will
28525 be of limited use in that environment.
28526
28527 With SMTP to Submission, there is a well-defined hostname which clients are
28528 connecting to and can validate certificates against.  Thus clients &*can*&
28529 choose to include this information in the TLS negotiation.  If this becomes
28530 wide-spread, then hosters can choose to present different certificates to
28531 different clients.  Or even negotiate different cipher suites.
28532
28533 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28534 if not empty, will be sent on a TLS session as part of the handshake.  There's
28535 nothing more to it.  Choosing a sensible value not derived insecurely is the
28536 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28537 for the lifetime of the client connection (including during authentication).
28538
28539 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28540 received from a client.
28541 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28542
28543 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28544 option (prior to expansion) then the following options will be re-expanded
28545 during TLS session handshake, to permit alternative values to be chosen:
28546
28547 .ilist
28548 &%tls_certificate%&
28549 .next
28550 &%tls_crl%&
28551 .next
28552 &%tls_privatekey%&
28553 .next
28554 &%tls_verify_certificates%&
28555 .next
28556 &%tls_ocsp_file%&
28557 .endlist
28558
28559 Great care should be taken to deal with matters of case, various injection
28560 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28561 can always be referenced; it is important to remember that &$tls_in_sni$& is
28562 arbitrary unverified data provided prior to authentication.
28563 Further, the initial certificate is loaded before SNI is arrived, so
28564 an expansion for &%tls_certificate%& must have a default which is used
28565 when &$tls_in_sni$& is empty.
28566
28567 The Exim developers are proceeding cautiously and so far no other TLS options
28568 are re-expanded.
28569
28570 When Exim is built against OpenSSL, OpenSSL must have been built with support
28571 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28572 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28573 see &`-servername`& in the output, then OpenSSL has support.
28574
28575 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28576 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28577 built, then you have SNI support).
28578
28579
28580
28581 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28582          "SECTmulmessam"
28583 .cindex "multiple SMTP deliveries with TLS"
28584 .cindex "TLS" "multiple message deliveries"
28585 Exim sends multiple messages down the same TCP/IP connection by starting up
28586 an entirely new delivery process for each message, passing the socket from
28587 one process to the next. This implementation does not fit well with the use
28588 of TLS, because there is quite a lot of state information associated with a TLS
28589 connection, not just a socket identification. Passing all the state information
28590 to a new process is not feasible. Consequently, for sending using TLS Exim
28591 starts an additional proxy process for handling the encryption, piping the
28592 unencrypted data stream from and to the delivery processes.
28593
28594 An older mode of operation can be enabled on a per-host basis by the
28595 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28596 this list the proxy process described above is not used; instead Exim
28597 shuts down an existing TLS session being run by the delivery process
28598 before passing the socket to a new process. The new process may then
28599 try to start a new TLS session, and if successful, may try to re-authenticate
28600 if AUTH is in use, before sending the next message.
28601
28602 The RFC is not clear as to whether or not an SMTP session continues in clear
28603 after TLS has been shut down, or whether TLS may be restarted again later, as
28604 just described. However, if the server is Exim, this shutdown and
28605 reinitialization works. It is not known which (if any) other servers operate
28606 successfully if the client closes a TLS session and continues with unencrypted
28607 SMTP, but there are certainly some that do not work. For such servers, Exim
28608 should not pass the socket to another process, because the failure of the
28609 subsequent attempt to use it would cause Exim to record a temporary host error,
28610 and delay other deliveries to that host.
28611
28612 To test for this case, Exim sends an EHLO command to the server after
28613 closing down the TLS session. If this fails in any way, the connection is
28614 closed instead of being passed to a new delivery process, but no retry
28615 information is recorded.
28616
28617 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28618 &(smtp)& transport to match those hosts for which Exim should not pass
28619 connections to new processes if TLS has been used.
28620
28621
28622
28623
28624 .section "Certificates and all that" "SECTcerandall"
28625 .cindex "certificate" "references to discussion"
28626 In order to understand fully how TLS works, you need to know about
28627 certificates, certificate signing, and certificate authorities.
28628 This is a large topic and an introductory guide is unsuitable for the Exim
28629 reference manual, so instead we provide pointers to existing documentation.
28630
28631 The Apache web-server was for a long time the canonical guide, so their
28632 documentation is a good place to start; their SSL module's Introduction
28633 document is currently at
28634 .display
28635 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28636 .endd
28637 and their FAQ is at
28638 .display
28639 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28640 .endd
28641
28642 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28643 0-201-61598-3) in 2001, contains both introductory and more in-depth
28644 descriptions.
28645 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28646 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28647 Ivan is the author of the popular TLS testing tools at
28648 &url(https://www.ssllabs.com/).
28649
28650
28651 .section "Certificate chains" "SECID186"
28652 The file named by &%tls_certificate%& may contain more than one
28653 certificate. This is useful in the case where the certificate that is being
28654 sent is validated by an intermediate certificate which the other end does
28655 not have. Multiple certificates must be in the correct order in the file.
28656 First the host's certificate itself, then the first intermediate
28657 certificate to validate the issuer of the host certificate, then the next
28658 intermediate certificate to validate the issuer of the first intermediate
28659 certificate, and so on, until finally (optionally) the root certificate.
28660 The root certificate must already be trusted by the recipient for
28661 validation to succeed, of course, but if it's not preinstalled, sending the
28662 root certificate along with the rest makes it available for the user to
28663 install if the receiving end is a client MUA that can interact with a user.
28664
28665 Note that certificates using MD5 are unlikely to work on today's Internet;
28666 even if your libraries allow loading them for use in Exim when acting as a
28667 server, increasingly clients will not accept such certificates.  The error
28668 diagnostics in such a case can be frustratingly vague.
28669
28670
28671
28672 .section "Self-signed certificates" "SECID187"
28673 .cindex "certificate" "self-signed"
28674 You can create a self-signed certificate using the &'req'& command provided
28675 with OpenSSL, like this:
28676 . ==== Do not shorten the duration here without reading and considering
28677 . ==== the text below.  Please leave it at 9999 days.
28678 .code
28679 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28680             -days 9999 -nodes
28681 .endd
28682 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28683 delimited and so can be identified independently. The &%-days%& option
28684 specifies a period for which the certificate is valid. The &%-nodes%& option is
28685 important: if you do not set it, the key is encrypted with a passphrase
28686 that you are prompted for, and any use that is made of the key causes more
28687 prompting for the passphrase. This is not helpful if you are going to use
28688 this certificate and key in an MTA, where prompting is not possible.
28689
28690 . ==== I expect to still be working 26 years from now.  The less technical
28691 . ==== debt I create, in terms of storing up trouble for my later years, the
28692 . ==== happier I will be then.  We really have reached the point where we
28693 . ==== should start, at the very least, provoking thought and making folks
28694 . ==== pause before proceeding, instead of leaving all the fixes until two
28695 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28696 . ==== -pdp, 2012
28697 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28698 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28699 the above command might produce a date in the past.  Think carefully about
28700 the lifetime of the systems you're deploying, and either reduce the duration
28701 of the certificate or reconsider your platform deployment.  (At time of
28702 writing, reducing the duration is the most likely choice, but the inexorable
28703 progression of time takes us steadily towards an era where this will not
28704 be a sensible resolution).
28705
28706 A self-signed certificate made in this way is sufficient for testing, and
28707 may be adequate for all your requirements if you are mainly interested in
28708 encrypting transfers, and not in secure identification.
28709
28710 However, many clients require that the certificate presented by the server be a
28711 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28712 certificate. In this situation, the self-signed certificate described above
28713 must be installed on the client host as a trusted root &'certification
28714 authority'& (CA), and the certificate used by Exim must be a user certificate
28715 signed with that self-signed certificate.
28716
28717 For information on creating self-signed CA certificates and using them to sign
28718 user certificates, see the &'General implementation overview'& chapter of the
28719 Open-source PKI book, available online at
28720 &url(https://sourceforge.net/projects/ospkibook/).
28721 .ecindex IIDencsmtp1
28722 .ecindex IIDencsmtp2
28723
28724
28725
28726 .section DANE "SECDANE"
28727 .cindex DANE
28728 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28729 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28730 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28731 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28732 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28733 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28734
28735 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28736 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28737 by (a) is thought to be smaller than that of the set of root CAs.
28738
28739 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28740 fail to pass on a server's STARTTLS.
28741
28742 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28743 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28744 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28745
28746 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28747 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28748 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28749 DNSSEC.
28750 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28751 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28752
28753 There are no changes to Exim specific to server-side operation of DANE.
28754 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28755 in &_Local/Makefile_&.
28756 If it has been included, the macro "_HAVE_DANE" will be defined.
28757
28758 The TLSA record for the server may have "certificate usage" of DANE-TA(2) or DANE-EE(3).
28759 These are the "Trust Anchor" and "End Entity" variants.
28760 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28761 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28762 this is appropriate for a single system, using a self-signed certificate.
28763 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28764 well-known one.
28765 A private CA at simplest is just a self-signed certificate (with certain
28766 attributes) which is used to sign server certificates, but running one securely
28767 does require careful arrangement.
28768 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28769 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28770 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28771 all of which point to a single TLSA record.
28772 DANE-TA and DANE-EE can both be used together.
28773
28774 Our recommendation is to use DANE with a certificate from a public CA,
28775 because this enables a variety of strategies for remote clients to verify
28776 your certificate.
28777 You can then publish information both via DANE and another technology,
28778 "MTA-STS", described below.
28779
28780 When you use DANE-TA to publish trust anchor information, you ask entities
28781 outside your administrative control to trust the Certificate Authority for
28782 connections to you.
28783 If using a private CA then you should expect others to still apply the
28784 technical criteria they'd use for a public CA to your certificates.
28785 In particular, you should probably try to follow current best practices for CA
28786 operation around hash algorithms and key sizes.
28787 Do not expect other organizations to lower their security expectations just
28788 because a particular profile might be reasonable for your own internal use.
28789
28790 When this text was last updated, this in practice means to avoid use of SHA-1
28791 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28792 than 4096, for interoperability); to use keyUsage fields correctly; to use
28793 random serial numbers.
28794 The list of requirements is subject to change as best practices evolve.
28795 If you're not already using a private CA, or it doesn't meet these
28796 requirements, then we encourage you to avoid all these issues and use a public
28797 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28798
28799 The TLSA record should have a Selector field of SPKI(1) and a Matching Type field of SHA2-512(2).
28800
28801 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
28802 is useful for quickly generating TLSA records; and commands like
28803
28804 .code
28805   openssl x509 -in -pubkey -noout <certificate.pem \
28806   | openssl rsa -outform der -pubin 2>/dev/null \
28807   | openssl sha512 \
28808   | awk '{print $2}'
28809 .endd
28810
28811 are workable for 4th-field hashes.
28812
28813 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
28814
28815 The Certificate issued by the CA published in the DANE-TA model should be
28816 issued using a strong hash algorithm.
28817 Exim, and importantly various other MTAs sending to you, will not
28818 re-enable hash algorithms which have been disabled by default in TLS
28819 libraries.
28820 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
28821 interoperability (and probably the maximum too, in 2018).
28822
28823 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
28824 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
28825 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
28826
28827 .code
28828   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
28829                                  {= {4}{$tls_out_tlsa_usage}} } \
28830                          {*}{}}
28831 .endd
28832
28833 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
28834 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
28835 found. If the definition of &%hosts_request_ocsp%& includes the
28836 string "tls_out_tlsa_usage", they are re-expanded in time to
28837 control the OCSP request.
28838
28839 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
28840 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
28841
28842
28843 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
28844 and &%dane_require_tls_ciphers%&.
28845 The require variant will result in failure if the target host is not DNSSEC-secured.
28846
28847 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
28848
28849 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
28850 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
28851 will be required for the host.  If it does not, the host will not
28852 be used; there is no fallback to non-DANE or non-TLS.
28853
28854 If DANE is requested and usable, then the TLS cipher list configuration
28855 prefers to use the option &%dane_require_tls_ciphers%& and falls
28856 back to &%tls_require_ciphers%& only if that is unset.
28857 This lets you configure "decent crypto" for DANE and "better than nothing
28858 crypto" as the default.  Note though that while GnuTLS lets the string control
28859 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
28860 limited to ciphersuite constraints.
28861
28862 If DANE is requested and useable (see above) the following transport options are ignored:
28863 .code
28864   hosts_require_tls
28865   tls_verify_hosts
28866   tls_try_verify_hosts
28867   tls_verify_certificates
28868   tls_crl
28869   tls_verify_cert_hostnames
28870 .endd
28871
28872 If DANE is not usable, whether requested or not, and CA-anchored
28873 verification evaluation is wanted, the above variables should be set appropriately.
28874
28875 Currently the &%dnssec_request_domains%& must be active and &%dnssec_require_domains%& is ignored.
28876
28877 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
28878
28879 There is a new variable &$tls_out_dane$& which will have "yes" if
28880 verification succeeded using DANE and "no" otherwise (only useful
28881 in combination with events; see &<<CHAPevents>>&),
28882 and a new variable &$tls_out_tlsa_usage$& (detailed above).
28883
28884 .cindex DANE reporting
28885 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
28886 to achieve DANE-verified connection, if one was either requested and offered, or
28887 required.  This is intended to support TLS-reporting as defined in
28888 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
28889 The &$event_data$& will be one of the Result Types defined in
28890 Section 4.3 of that document.
28891
28892 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
28893
28894 DANE is specified in published RFCs and decouples certificate authority trust
28895 selection from a "race to the bottom" of "you must trust everything for mail
28896 to get through".  There is an alternative technology called MTA-STS, which
28897 instead publishes MX trust anchor information on an HTTPS website.  At the
28898 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
28899 Exim has no support for MTA-STS as a client, but Exim mail server operators
28900 can choose to publish information describing their TLS configuration using
28901 MTA-STS to let those clients who do use that protocol derive trust
28902 information.
28903
28904 The MTA-STS design requires a certificate from a public Certificate Authority
28905 which is recognized by clients sending to you.
28906 That selection of which CAs are trusted by others is outside your control.
28907
28908 The most interoperable course of action is probably to use
28909 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
28910 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
28911 records for DANE clients (such as Exim and Postfix) and to publish anchor
28912 information for MTA-STS as well.  This is what is done for the &'exim.org'&
28913 domain itself (with caveats around occasionally broken MTA-STS because of
28914 incompatible specification changes prior to reaching RFC status).
28915
28916
28917
28918 . ////////////////////////////////////////////////////////////////////////////
28919 . ////////////////////////////////////////////////////////////////////////////
28920
28921 .chapter "Access control lists" "CHAPACL"
28922 .scindex IIDacl "&ACL;" "description"
28923 .cindex "control of incoming mail"
28924 .cindex "message" "controlling incoming"
28925 .cindex "policy control" "access control lists"
28926 Access Control Lists (ACLs) are defined in a separate section of the runtime
28927 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
28928 name, terminated by a colon. Here is a complete ACL section that contains just
28929 one very small ACL:
28930 .code
28931 begin acl
28932 small_acl:
28933   accept   hosts = one.host.only
28934 .endd
28935 You can have as many lists as you like in the ACL section, and the order in
28936 which they appear does not matter. The lists are self-terminating.
28937
28938 The majority of ACLs are used to control Exim's behaviour when it receives
28939 certain SMTP commands. This applies both to incoming TCP/IP connections, and
28940 when a local process submits a message using SMTP by specifying the &%-bs%&
28941 option. The most common use is for controlling which recipients are accepted
28942 in incoming messages. In addition, you can define an ACL that is used to check
28943 local non-SMTP messages. The default configuration file contains an example of
28944 a realistic ACL for checking RCPT commands. This is discussed in chapter
28945 &<<CHAPdefconfil>>&.
28946
28947
28948 .section "Testing ACLs" "SECID188"
28949 The &%-bh%& command line option provides a way of testing your ACL
28950 configuration locally by running a fake SMTP session with which you interact.
28951
28952
28953 .section "Specifying when ACLs are used" "SECID189"
28954 .cindex "&ACL;" "options for specifying"
28955 In order to cause an ACL to be used, you have to name it in one of the relevant
28956 options in the main part of the configuration. These options are:
28957 .cindex "AUTH" "ACL for"
28958 .cindex "DATA" "ACLs for"
28959 .cindex "ETRN" "ACL for"
28960 .cindex "EXPN" "ACL for"
28961 .cindex "HELO" "ACL for"
28962 .cindex "EHLO" "ACL for"
28963 .cindex "DKIM" "ACL for"
28964 .cindex "MAIL" "ACL for"
28965 .cindex "QUIT, ACL for"
28966 .cindex "RCPT" "ACL for"
28967 .cindex "STARTTLS, ACL for"
28968 .cindex "VRFY" "ACL for"
28969 .cindex "SMTP" "connection, ACL for"
28970 .cindex "non-SMTP messages" "ACLs for"
28971 .cindex "MIME content scanning" "ACL for"
28972 .cindex "PRDR" "ACL for"
28973
28974 .table2 140pt
28975 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
28976 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
28977 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
28978 .irow &%acl_smtp_auth%&        "ACL for AUTH"
28979 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
28980 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
28981 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
28982 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
28983 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
28984 .irow &%acl_smtp_expn%&        "ACL for EXPN"
28985 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
28986 .irow &%acl_smtp_mail%&        "ACL for MAIL"
28987 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
28988 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
28989 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
28990 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
28991 .irow &%acl_smtp_quit%&        "ACL for QUIT"
28992 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
28993 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
28994 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
28995 .endtable
28996
28997 For example, if you set
28998 .code
28999 acl_smtp_rcpt = small_acl
29000 .endd
29001 the little ACL defined above is used whenever Exim receives a RCPT command
29002 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29003 done when RCPT commands arrive. A rejection of RCPT should cause the
29004 sending MTA to give up on the recipient address contained in the RCPT
29005 command, whereas rejection at other times may cause the client MTA to keep on
29006 trying to deliver the message. It is therefore recommended that you do as much
29007 testing as possible at RCPT time.
29008
29009
29010 .section "The non-SMTP ACLs" "SECID190"
29011 .cindex "non-SMTP messages" "ACLs for"
29012 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29013 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29014 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29015 the state of the SMTP connection such as encryption and authentication) are not
29016 relevant and are forbidden in these ACLs. However, the sender and recipients
29017 are known, so the &%senders%& and &%sender_domains%& conditions and the
29018 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29019 &$authenticated_sender$& are also available. You can specify added header lines
29020 in any of these ACLs.
29021
29022 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29023 non-SMTP message, before any of the message has been read. (This is the
29024 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29025 batched SMTP input, it runs after the DATA command has been reached. The
29026 result of this ACL is ignored; it cannot be used to reject a message. If you
29027 really need to, you could set a value in an ACL variable here and reject based
29028 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29029 controls, and in particular, it can be used to set
29030 .code
29031 control = suppress_local_fixups
29032 .endd
29033 This cannot be used in the other non-SMTP ACLs because by the time they are
29034 run, it is too late.
29035
29036 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29037 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29038
29039 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29040 kind of rejection is treated as permanent, because there is no way of sending a
29041 temporary error for these kinds of message.
29042
29043
29044 .section "The SMTP connect ACL" "SECID191"
29045 .cindex "SMTP" "connection, ACL for"
29046 .oindex &%smtp_banner%&
29047 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29048 session, after the test specified by &%host_reject_connection%& (which is now
29049 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29050 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29051 the message override the banner message that is otherwise specified by the
29052 &%smtp_banner%& option.
29053
29054
29055 .section "The EHLO/HELO ACL" "SECID192"
29056 .cindex "EHLO" "ACL for"
29057 .cindex "HELO" "ACL for"
29058 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29059 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29060 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29061 Note that a client may issue more than one EHLO or HELO command in an SMTP
29062 session, and indeed is required to issue a new EHLO or HELO after successfully
29063 setting up encryption following a STARTTLS command.
29064
29065 Note also that a deny neither forces the client to go away nor means that
29066 mail will be refused on the connection.  Consider checking for
29067 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29068
29069 If the command is accepted by an &%accept%& verb that has a &%message%&
29070 modifier, the message may not contain more than one line (it will be truncated
29071 at the first newline and a panic logged if it does). Such a message cannot
29072 affect the EHLO options that are listed on the second and subsequent lines of
29073 an EHLO response.
29074
29075
29076 .section "The DATA ACLs" "SECID193"
29077 .cindex "DATA" "ACLs for"
29078 Two ACLs are associated with the DATA command, because it is two-stage
29079 command, with two responses being sent to the client.
29080 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29081 is obeyed. This gives you control after all the RCPT commands, but before
29082 the message itself is received. It offers the opportunity to give a negative
29083 response to the DATA command before the data is transmitted. Header lines
29084 added by MAIL or RCPT ACLs are not visible at this time, but any that
29085 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29086
29087 You cannot test the contents of the message, for example, to verify addresses
29088 in the headers, at RCPT time or when the DATA command is received. Such
29089 tests have to appear in the ACL that is run after the message itself has been
29090 received, before the final response to the DATA command is sent. This is
29091 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29092 associated with the DATA command.
29093
29094 .cindex CHUNKING "BDAT command"
29095 .cindex BDAT "SMTP command"
29096 .cindex "RFC 3030" CHUNKING
29097 If CHUNKING was advertised and a BDAT command sequence is received,
29098 the &%acl_smtp_predata%& ACL is not run.
29099 . XXX why not?  It should be possible, for the first BDAT.
29100 The &%acl_smtp_data%& is run after the last BDAT command and all of
29101 the data specified is received.
29102
29103 For both of these ACLs, it is not possible to reject individual recipients. An
29104 error response rejects the entire message. Unfortunately, it is known that some
29105 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29106 before or after the data) correctly &-- they keep the message on their queues
29107 and try again later, but that is their problem, though it does waste some of
29108 your resources.
29109
29110 The &%acl_smtp_data%& ACL is run after
29111 the &%acl_smtp_data_prdr%&,
29112 the &%acl_smtp_dkim%&
29113 and the &%acl_smtp_mime%& ACLs.
29114
29115 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29116 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29117 enabled (which is the default).
29118
29119 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29120 received, and is executed for each DKIM signature found in a message.  If not
29121 otherwise specified, the default action is to accept.
29122
29123 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29124
29125 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29126
29127
29128 .section "The SMTP MIME ACL" "SECID194"
29129 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29130 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29131
29132 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29133
29134
29135 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29136 .cindex "PRDR" "ACL for"
29137 .oindex "&%prdr_enable%&"
29138 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29139 with PRDR support enabled (which is the default).
29140 It becomes active only when the PRDR feature is negotiated between
29141 client and server for a message, and more than one recipient
29142 has been accepted.
29143
29144 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29145 has been received, and is executed once for each recipient of the message
29146 with &$local_part$& and &$domain$& valid.
29147 The test may accept, defer or deny for individual recipients.
29148 The &%acl_smtp_data%& will still be called after this ACL and
29149 can reject the message overall, even if this ACL has accepted it
29150 for some or all recipients.
29151
29152 PRDR may be used to support per-user content filtering.  Without it
29153 one must defer any recipient after the first that has a different
29154 content-filter configuration.  With PRDR, the RCPT-time check
29155 .cindex "PRDR" "variable for"
29156 for this can be disabled when the variable &$prdr_requested$&
29157 is &"yes"&.
29158 Any required difference in behaviour of the main DATA-time
29159 ACL should however depend on the PRDR-time ACL having run, as Exim
29160 will avoid doing so in some situations (e.g. single-recipient mails).
29161
29162 See also the &%prdr_enable%& global option
29163 and the &%hosts_try_prdr%& smtp transport option.
29164
29165 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29166 If the ACL is not defined, processing completes as if
29167 the feature was not requested by the client.
29168
29169 .section "The QUIT ACL" "SECTQUITACL"
29170 .cindex "QUIT, ACL for"
29171 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29172 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29173 does not in fact control any access.
29174 For this reason, it may only accept
29175 or warn as its final result.
29176
29177 This ACL can be used for tasks such as custom logging at the end of an SMTP
29178 session. For example, you can use ACL variables in other ACLs to count
29179 messages, recipients, etc., and log the totals at QUIT time using one or
29180 more &%logwrite%& modifiers on a &%warn%& verb.
29181
29182 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29183 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29184
29185 You do not need to have a final &%accept%&, but if you do, you can use a
29186 &%message%& modifier to specify custom text that is sent as part of the 221
29187 response to QUIT.
29188
29189 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29190 failure (for example, failure to open a log file, or when Exim is bombing out
29191 because it has detected an unrecoverable error), all SMTP commands from the
29192 client are given temporary error responses until QUIT is received or the
29193 connection is closed. In these special cases, the QUIT ACL does not run.
29194
29195
29196 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29197 .vindex &$acl_smtp_notquit$&
29198 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29199 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29200 trouble, such as being unable to write to its log files, this ACL is not run,
29201 because it might try to do things (such as write to log files) that make the
29202 situation even worse.
29203
29204 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29205 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29206 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29207 and &%warn%&.
29208
29209 .vindex &$smtp_notquit_reason$&
29210 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29211 to a string that indicates the reason for the termination of the SMTP
29212 connection. The possible values are:
29213 .table2
29214 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29215 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29216 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29217 .irow &`connection-lost`&          "The SMTP connection has been lost"
29218 .irow &`data-timeout`&             "Timeout while reading message data"
29219 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29220 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29221 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29222 .irow &`synchronization-error`&    "SMTP synchronization error"
29223 .irow &`tls-failed`&               "TLS failed to start"
29224 .endtable
29225 In most cases when an SMTP connection is closed without having received QUIT,
29226 Exim sends an SMTP response message before actually closing the connection.
29227 With the exception of the &`acl-drop`& case, the default message can be
29228 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29229 &%drop%& verb in another ACL, it is the message from the other ACL that is
29230 used.
29231
29232
29233 .section "Finding an ACL to use" "SECID195"
29234 .cindex "&ACL;" "finding which to use"
29235 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29236 you can use different ACLs in different circumstances. For example,
29237 .code
29238 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29239                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29240 .endd
29241 In the default configuration file there are some example settings for
29242 providing an RFC 4409 message &"submission"& service on port 587 and
29243 an RFC 8314 &"submissions"& service on port 465. You can use a string
29244 expansion like this to choose an ACL for MUAs on these ports which is
29245 more appropriate for this purpose than the default ACL on port 25.
29246
29247 The expanded string does not have to be the name of an ACL in the
29248 configuration file; there are other possibilities. Having expanded the
29249 string, Exim searches for an ACL as follows:
29250
29251 .ilist
29252 If the string begins with a slash, Exim uses it as a filename, and reads its
29253 contents as an ACL. The lines are processed in the same way as lines in the
29254 Exim configuration file. In particular, continuation lines are supported, blank
29255 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29256 If the file does not exist or cannot be read, an error occurs (typically
29257 causing a temporary failure of whatever caused the ACL to be run). For example:
29258 .code
29259 acl_smtp_data = /etc/acls/\
29260   ${lookup{$sender_host_address}lsearch\
29261   {/etc/acllist}{$value}{default}}
29262 .endd
29263 This looks up an ACL file to use on the basis of the host's IP address, falling
29264 back to a default if the lookup fails. If an ACL is successfully read from a
29265 file, it is retained in memory for the duration of the Exim process, so that it
29266 can be re-used without having to re-read the file.
29267 .next
29268 If the string does not start with a slash, and does not contain any spaces,
29269 Exim searches the ACL section of the configuration for an ACL whose name
29270 matches the string.
29271 .next
29272 If no named ACL is found, or if the string contains spaces, Exim parses
29273 the string as an inline ACL. This can save typing in cases where you just
29274 want to have something like
29275 .code
29276 acl_smtp_vrfy = accept
29277 .endd
29278 in order to allow free use of the VRFY command. Such a string may contain
29279 newlines; it is processed in the same way as an ACL that is read from a file.
29280 .endlist
29281
29282
29283
29284
29285 .section "ACL return codes" "SECID196"
29286 .cindex "&ACL;" "return codes"
29287 Except for the QUIT ACL, which does not affect the SMTP return code (see
29288 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29289 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29290 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29291 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29292 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29293 This also causes a 4&'xx'& return code.
29294
29295 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29296 &"deny"&, because there is no mechanism for passing temporary errors to the
29297 submitters of non-SMTP messages.
29298
29299
29300 ACLs that are relevant to message reception may also return &"discard"&. This
29301 has the effect of &"accept"&, but causes either the entire message or an
29302 individual recipient address to be discarded. In other words, it is a
29303 blackholing facility. Use it with care.
29304
29305 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29306 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29307 RCPT ACL is to discard just the one recipient address. If there are no
29308 recipients left when the message's data is received, the DATA ACL is not
29309 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29310 remaining recipients. The &"discard"& return is not permitted for the
29311 &%acl_smtp_predata%& ACL.
29312
29313 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29314 is done on the address and the result determines the SMTP response.
29315
29316
29317 .cindex "&[local_scan()]& function" "when all recipients discarded"
29318 The &[local_scan()]& function is always run, even if there are no remaining
29319 recipients; it may create new recipients.
29320
29321
29322
29323 .section "Unset ACL options" "SECID197"
29324 .cindex "&ACL;" "unset options"
29325 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29326 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29327 not defined at all. For any defined ACL, the default action when control
29328 reaches the end of the ACL statements is &"deny"&.
29329
29330 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29331 these two are ACLs that are used only for their side effects. They cannot be
29332 used to accept or reject anything.
29333
29334 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29335 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29336 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29337 when the ACL is not defined is &"accept"&.
29338
29339 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29340 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29341 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29342 messages over an SMTP connection. For an example, see the ACL in the default
29343 configuration file.
29344
29345
29346
29347
29348 .section "Data for message ACLs" "SECID198"
29349 .cindex "&ACL;" "data for message ACL"
29350 .vindex &$domain$&
29351 .vindex &$local_part$&
29352 .vindex &$sender_address$&
29353 .vindex &$sender_host_address$&
29354 .vindex &$smtp_command$&
29355 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29356 that contain information about the host and the message's sender (for example,
29357 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29358 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29359 &$local_part$& are set from the argument address. The entire SMTP command
29360 is available in &$smtp_command$&.
29361
29362 When an ACL for the AUTH parameter of MAIL is running, the variables that
29363 contain information about the host are set, but &$sender_address$& is not yet
29364 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29365 how it is used.
29366
29367 .vindex "&$message_size$&"
29368 The &$message_size$& variable is set to the value of the SIZE parameter on
29369 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29370 that parameter is not given. The value is updated to the true message size by
29371 the time the final DATA ACL is run (after the message data has been
29372 received).
29373
29374 .vindex "&$rcpt_count$&"
29375 .vindex "&$recipients_count$&"
29376 The &$rcpt_count$& variable increases by one for each RCPT command received.
29377 The &$recipients_count$& variable increases by one each time a RCPT command is
29378 accepted, so while an ACL for RCPT is being processed, it contains the number
29379 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29380 &$rcpt_count$& contains the total number of RCPT commands, and
29381 &$recipients_count$& contains the total number of accepted recipients.
29382
29383
29384
29385
29386
29387 .section "Data for non-message ACLs" "SECTdatfornon"
29388 .cindex "&ACL;" "data for non-message ACL"
29389 .vindex &$smtp_command_argument$&
29390 .vindex &$smtp_command$&
29391 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29392 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29393 and the entire SMTP command is available in &$smtp_command$&.
29394 These variables can be tested using a &%condition%& condition. For example,
29395 here is an ACL for use with AUTH, which insists that either the session is
29396 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29397 does not permit authentication methods that use cleartext passwords on
29398 unencrypted connections.
29399 .code
29400 acl_check_auth:
29401   accept encrypted = *
29402   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29403                      {CRAM-MD5}}
29404   deny   message   = TLS encryption or CRAM-MD5 required
29405 .endd
29406 (Another way of applying this restriction is to arrange for the authenticators
29407 that use cleartext passwords not to be advertised when the connection is not
29408 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29409 option to do this.)
29410
29411
29412
29413 .section "Format of an ACL" "SECID199"
29414 .cindex "&ACL;" "format of"
29415 .cindex "&ACL;" "verbs, definition of"
29416 An individual ACL consists of a number of statements. Each statement starts
29417 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29418 Modifiers can change the way the verb operates, define error and log messages,
29419 set variables, insert delays, and vary the processing of accepted messages.
29420
29421 If all the conditions are met, the verb is obeyed. The same condition may be
29422 used (with different arguments) more than once in the same statement. This
29423 provides a means of specifying an &"and"& conjunction between conditions. For
29424 example:
29425 .code
29426 deny  dnslists = list1.example
29427       dnslists = list2.example
29428 .endd
29429 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29430 the conditions and modifiers when it reaches a condition that fails. What
29431 happens then depends on the verb (and in one case, on a special modifier). Not
29432 all the conditions make sense at every testing point. For example, you cannot
29433 test a sender address in the ACL that is run for a VRFY command.
29434
29435
29436 .section "ACL verbs" "SECID200"
29437 The ACL verbs are as follows:
29438
29439 .ilist
29440 .cindex "&%accept%& ACL verb"
29441 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29442 of the conditions are not met, what happens depends on whether &%endpass%&
29443 appears among the conditions (for syntax see below). If the failing condition
29444 is before &%endpass%&, control is passed to the next ACL statement; if it is
29445 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29446 check a RCPT command:
29447 .code
29448 accept domains = +local_domains
29449        endpass
29450        verify = recipient
29451 .endd
29452 If the recipient domain does not match the &%domains%& condition, control
29453 passes to the next statement. If it does match, the recipient is verified, and
29454 the command is accepted if verification succeeds. However, if verification
29455 fails, the ACL yields &"deny"&, because the failing condition is after
29456 &%endpass%&.
29457
29458 The &%endpass%& feature has turned out to be confusing to many people, so its
29459 use is not recommended nowadays. It is always possible to rewrite an ACL so
29460 that &%endpass%& is not needed, and it is no longer used in the default
29461 configuration.
29462
29463 .cindex "&%message%& ACL modifier" "with &%accept%&"
29464 If a &%message%& modifier appears on an &%accept%& statement, its action
29465 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29466 (when an &%accept%& verb either accepts or passes control to the next
29467 statement), &%message%& can be used to vary the message that is sent when an
29468 SMTP command is accepted. For example, in a RCPT ACL you could have:
29469 .display
29470 &`accept  `&<&'some conditions'&>
29471 &`        message = OK, I will allow you through today`&
29472 .endd
29473 You can specify an SMTP response code, optionally followed by an &"extended
29474 response code"& at the start of the message, but the first digit must be the
29475 same as would be sent by default, which is 2 for an &%accept%& verb.
29476
29477 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29478 an error message that is used when access is denied. This behaviour is retained
29479 for backward compatibility, but current &"best practice"& is to avoid the use
29480 of &%endpass%&.
29481
29482
29483 .next
29484 .cindex "&%defer%& ACL verb"
29485 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29486 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29487 &%defer%& is the same as &%deny%&, because there is no way of sending a
29488 temporary error. For a RCPT command, &%defer%& is much the same as using a
29489 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29490 be used in any ACL, and even for a recipient it might be a simpler approach.
29491
29492
29493 .next
29494 .cindex "&%deny%& ACL verb"
29495 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29496 the conditions are not met, control is passed to the next ACL statement. For
29497 example,
29498 .code
29499 deny dnslists = blackholes.mail-abuse.org
29500 .endd
29501 rejects commands from hosts that are on a DNS black list.
29502
29503
29504 .next
29505 .cindex "&%discard%& ACL verb"
29506 &%discard%&: This verb behaves like &%accept%&, except that it returns
29507 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29508 that are concerned with receiving messages. When all the conditions are true,
29509 the sending entity receives a &"success"& response. However, &%discard%& causes
29510 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29511 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29512 message's recipients are discarded. Recipients that are discarded before DATA
29513 do not appear in the log line when the &%received_recipients%& log selector is set.
29514
29515 If the &%log_message%& modifier is set when &%discard%& operates,
29516 its contents are added to the line that is automatically written to the log.
29517 The &%message%& modifier operates exactly as it does for &%accept%&.
29518
29519
29520 .next
29521 .cindex "&%drop%& ACL verb"
29522 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29523 forcibly closed after the 5&'xx'& error message has been sent. For example:
29524 .code
29525 drop   message   = I don't take more than 20 RCPTs
29526        condition = ${if > {$rcpt_count}{20}}
29527 .endd
29528 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29529 The connection is always dropped after sending a 550 response.
29530
29531 .next
29532 .cindex "&%require%& ACL verb"
29533 &%require%&: If all the conditions are met, control is passed to the next ACL
29534 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29535 example, when checking a RCPT command,
29536 .code
29537 require message = Sender did not verify
29538         verify  = sender
29539 .endd
29540 passes control to subsequent statements only if the message's sender can be
29541 verified. Otherwise, it rejects the command. Note the positioning of the
29542 &%message%& modifier, before the &%verify%& condition. The reason for this is
29543 discussed in section &<<SECTcondmodproc>>&.
29544
29545 .next
29546 .cindex "&%warn%& ACL verb"
29547 &%warn%&: If all the conditions are true, a line specified by the
29548 &%log_message%& modifier is written to Exim's main log. Control always passes
29549 to the next ACL statement. If any condition is false, the log line is not
29550 written. If an identical log line is requested several times in the same
29551 message, only one copy is actually written to the log. If you want to force
29552 duplicates to be written, use the &%logwrite%& modifier instead.
29553
29554 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29555 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29556 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29557 first failing condition. There is more about adding header lines in section
29558 &<<SECTaddheadacl>>&.
29559
29560 If any condition on a &%warn%& statement cannot be completed (that is, there is
29561 some sort of defer), the log line specified by &%log_message%& is not written.
29562 This does not include the case of a forced failure from a lookup, which
29563 is considered to be a successful completion. After a defer, no further
29564 conditions or modifiers in the &%warn%& statement are processed. The incident
29565 is logged, and the ACL continues to be processed, from the next statement
29566 onwards.
29567
29568
29569 .vindex "&$acl_verify_message$&"
29570 When one of the &%warn%& conditions is an address verification that fails, the
29571 text of the verification failure message is in &$acl_verify_message$&. If you
29572 want this logged, you must set it up explicitly. For example:
29573 .code
29574 warn   !verify = sender
29575        log_message = sender verify failed: $acl_verify_message
29576 .endd
29577 .endlist
29578
29579 At the end of each ACL there is an implicit unconditional &%deny%&.
29580
29581 As you can see from the examples above, the conditions and modifiers are
29582 written one to a line, with the first one on the same line as the verb, and
29583 subsequent ones on following lines. If you have a very long condition, you can
29584 continue it onto several physical lines by the usual backslash continuation
29585 mechanism. It is conventional to align the conditions vertically.
29586
29587
29588
29589 .section "ACL variables" "SECTaclvariables"
29590 .cindex "&ACL;" "variables"
29591 There are some special variables that can be set during ACL processing. They
29592 can be used to pass information between different ACLs, different invocations
29593 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29594 transports, and filters that are used to deliver a message. The names of these
29595 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29596 an underscore, but the remainder of the name can be any sequence of
29597 alphanumeric characters and underscores that you choose. There is no limit on
29598 the number of ACL variables. The two sets act as follows:
29599 .ilist
29600 The values of those variables whose names begin with &$acl_c$& persist
29601 throughout an SMTP connection. They are never reset. Thus, a value that is set
29602 while receiving one message is still available when receiving the next message
29603 on the same SMTP connection.
29604 .next
29605 The values of those variables whose names begin with &$acl_m$& persist only
29606 while a message is being received. They are reset afterwards. They are also
29607 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29608 .endlist
29609
29610 When a message is accepted, the current values of all the ACL variables are
29611 preserved with the message and are subsequently made available at delivery
29612 time. The ACL variables are set by a modifier called &%set%&. For example:
29613 .code
29614 accept hosts = whatever
29615        set acl_m4 = some value
29616 accept authenticated = *
29617        set acl_c_auth = yes
29618 .endd
29619 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29620 be set. If you want to set a variable without taking any action, you can use a
29621 &%warn%& verb without any other modifiers or conditions.
29622
29623 .oindex &%strict_acl_vars%&
29624 What happens if a syntactically valid but undefined ACL variable is
29625 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29626 false (the default), an empty string is substituted; if it is true, an
29627 error is generated.
29628
29629 Versions of Exim before 4.64 have a limited set of numbered variables, but
29630 their names are compatible, so there is no problem with upgrading.
29631
29632
29633 .section "Condition and modifier processing" "SECTcondmodproc"
29634 .cindex "&ACL;" "conditions; processing"
29635 .cindex "&ACL;" "modifiers; processing"
29636 An exclamation mark preceding a condition negates its result. For example:
29637 .code
29638 deny   domains = *.dom.example
29639       !verify  = recipient
29640 .endd
29641 causes the ACL to return &"deny"& if the recipient domain ends in
29642 &'dom.example'& and the recipient address cannot be verified. Sometimes
29643 negation can be used on the right-hand side of a condition. For example, these
29644 two statements are equivalent:
29645 .code
29646 deny  hosts = !192.168.3.4
29647 deny !hosts =  192.168.3.4
29648 .endd
29649 However, for many conditions (&%verify%& being a good example), only left-hand
29650 side negation of the whole condition is possible.
29651
29652 The arguments of conditions and modifiers are expanded. A forced failure
29653 of an expansion causes a condition to be ignored, that is, it behaves as if the
29654 condition is true. Consider these two statements:
29655 .code
29656 accept  senders = ${lookup{$host_name}lsearch\
29657                   {/some/file}{$value}fail}
29658 accept  senders = ${lookup{$host_name}lsearch\
29659                   {/some/file}{$value}{}}
29660 .endd
29661 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29662 the returned list is searched, but if the lookup fails the behaviour is
29663 different in the two cases. The &%fail%& in the first statement causes the
29664 condition to be ignored, leaving no further conditions. The &%accept%& verb
29665 therefore succeeds. The second statement, however, generates an empty list when
29666 the lookup fails. No sender can match an empty list, so the condition fails,
29667 and therefore the &%accept%& also fails.
29668
29669 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29670 specify actions that are taken as the conditions for a statement are checked;
29671 others specify text for messages that are used when access is denied or a
29672 warning is generated. The &%control%& modifier affects the way an incoming
29673 message is handled.
29674
29675 The positioning of the modifiers in an ACL statement is important, because the
29676 processing of a verb ceases as soon as its outcome is known. Only those
29677 modifiers that have already been encountered will take effect. For example,
29678 consider this use of the &%message%& modifier:
29679 .code
29680 require message = Can't verify sender
29681         verify  = sender
29682         message = Can't verify recipient
29683         verify  = recipient
29684         message = This message cannot be used
29685 .endd
29686 If sender verification fails, Exim knows that the result of the statement is
29687 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29688 so its text is used as the error message. If sender verification succeeds, but
29689 recipient verification fails, the second message is used. If recipient
29690 verification succeeds, the third message becomes &"current"&, but is never used
29691 because there are no more conditions to cause failure.
29692
29693 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29694 modifier that is used, because all the conditions must be true for rejection to
29695 happen. Specifying more than one &%message%& modifier does not make sense, and
29696 the message can even be specified after all the conditions. For example:
29697 .code
29698 deny   hosts = ...
29699       !senders = *@my.domain.example
29700        message = Invalid sender from client host
29701 .endd
29702 The &"deny"& result does not happen until the end of the statement is reached,
29703 by which time Exim has set up the message.
29704
29705
29706
29707 .section "ACL modifiers" "SECTACLmodi"
29708 .cindex "&ACL;" "modifiers; list of"
29709 The ACL modifiers are as follows:
29710
29711 .vlist
29712 .vitem &*add_header*&&~=&~<&'text'&>
29713 This modifier specifies one or more header lines that are to be added to an
29714 incoming message, assuming, of course, that the message is ultimately
29715 accepted. For details, see section &<<SECTaddheadacl>>&.
29716
29717 .vitem &*continue*&&~=&~<&'text'&>
29718 .cindex "&%continue%& ACL modifier"
29719 .cindex "database" "updating in ACL"
29720 This modifier does nothing of itself, and processing of the ACL always
29721 continues with the next condition or modifier. The value of &%continue%& is in
29722 the side effects of expanding its argument. Typically this could be used to
29723 update a database. It is really just a syntactic tidiness, to avoid having to
29724 write rather ugly lines like this:
29725 .display
29726 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29727 .endd
29728 Instead, all you need is
29729 .display
29730 &`continue = `&<&'some expansion'&>
29731 .endd
29732
29733 .vitem &*control*&&~=&~<&'text'&>
29734 .cindex "&%control%& ACL modifier"
29735 This modifier affects the subsequent processing of the SMTP connection or of an
29736 incoming message that is accepted. The effect of the first type of control
29737 lasts for the duration of the connection, whereas the effect of the second type
29738 lasts only until the current message has been received. The message-specific
29739 controls always apply to the whole message, not to individual recipients,
29740 even if the &%control%& modifier appears in a RCPT ACL.
29741
29742 As there are now quite a few controls that can be applied, they are described
29743 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29744 in several different ways. For example:
29745
29746 . ==== As this is a nested list, any displays it contains must be indented
29747 . ==== as otherwise they are too far to the left. That comment applies only
29748 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29749 . ==== way.
29750
29751 .ilist
29752 It can be at the end of an &%accept%& statement:
29753 .code
29754     accept  ...some conditions
29755             control = queue_only
29756 .endd
29757 In this case, the control is applied when this statement yields &"accept"&, in
29758 other words, when the conditions are all true.
29759
29760 .next
29761 It can be in the middle of an &%accept%& statement:
29762 .code
29763     accept  ...some conditions...
29764             control = queue_only
29765             ...some more conditions...
29766 .endd
29767 If the first set of conditions are true, the control is applied, even if the
29768 statement does not accept because one of the second set of conditions is false.
29769 In this case, some subsequent statement must yield &"accept"& for the control
29770 to be relevant.
29771
29772 .next
29773 It can be used with &%warn%& to apply the control, leaving the
29774 decision about accepting or denying to a subsequent verb. For
29775 example:
29776 .code
29777     warn    ...some conditions...
29778             control = freeze
29779     accept  ...
29780 .endd
29781 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29782 &%logwrite%&, so it does not add anything to the message and does not write a
29783 log entry.
29784
29785 .next
29786 If you want to apply a control unconditionally, you can use it with a
29787 &%require%& verb. For example:
29788 .code
29789     require  control = no_multiline_responses
29790 .endd
29791 .endlist
29792
29793 .vitem &*delay*&&~=&~<&'time'&>
29794 .cindex "&%delay%& ACL modifier"
29795 .oindex "&%-bh%&"
29796 This modifier may appear in any ACL except notquit. It causes Exim to wait for
29797 the time interval before proceeding. However, when testing Exim using the
29798 &%-bh%& option, the delay is not actually imposed (an appropriate message is
29799 output instead). The time is given in the usual Exim notation, and the delay
29800 happens as soon as the modifier is processed. In an SMTP session, pending
29801 output is flushed before the delay is imposed.
29802
29803 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
29804 example:
29805 .code
29806 deny    ...some conditions...
29807         delay = 30s
29808 .endd
29809 The delay happens if all the conditions are true, before the statement returns
29810 &"deny"&. Compare this with:
29811 .code
29812 deny    delay = 30s
29813         ...some conditions...
29814 .endd
29815 which waits for 30s before processing the conditions. The &%delay%& modifier
29816 can also be used with &%warn%& and together with &%control%&:
29817 .code
29818 warn    ...some conditions...
29819         delay = 2m
29820         control = freeze
29821 accept  ...
29822 .endd
29823
29824 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
29825 responses to several commands are no longer buffered and sent in one packet (as
29826 they would normally be) because all output is flushed before imposing the
29827 delay. This optimization is disabled so that a number of small delays do not
29828 appear to the client as one large aggregated delay that might provoke an
29829 unwanted timeout. You can, however, disable output flushing for &%delay%& by
29830 using a &%control%& modifier to set &%no_delay_flush%&.
29831
29832
29833 .vitem &*endpass*&
29834 .cindex "&%endpass%& ACL modifier"
29835 This modifier, which has no argument, is recognized only in &%accept%& and
29836 &%discard%& statements. It marks the boundary between the conditions whose
29837 failure causes control to pass to the next statement, and the conditions whose
29838 failure causes the ACL to return &"deny"&. This concept has proved to be
29839 confusing to some people, so the use of &%endpass%& is no longer recommended as
29840 &"best practice"&. See the description of &%accept%& above for more details.
29841
29842
29843 .vitem &*log_message*&&~=&~<&'text'&>
29844 .cindex "&%log_message%& ACL modifier"
29845 This modifier sets up a message that is used as part of the log message if the
29846 ACL denies access or a &%warn%& statement's conditions are true. For example:
29847 .code
29848 require log_message = wrong cipher suite $tls_in_cipher
29849         encrypted   = DES-CBC3-SHA
29850 .endd
29851 &%log_message%& is also used when recipients are discarded by &%discard%&. For
29852 example:
29853 .display
29854 &`discard `&<&'some conditions'&>
29855 &`        log_message = Discarded $local_part@$domain because...`&
29856 .endd
29857 When access is denied, &%log_message%& adds to any underlying error message
29858 that may exist because of a condition failure. For example, while verifying a
29859 recipient address, a &':fail:'& redirection might have already set up a
29860 message.
29861
29862 The message may be defined before the conditions to which it applies, because
29863 the string expansion does not happen until Exim decides that access is to be
29864 denied. This means that any variables that are set by the condition are
29865 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
29866 variables are set after a DNS black list lookup succeeds. If the expansion of
29867 &%log_message%& fails, or if the result is an empty string, the modifier is
29868 ignored.
29869
29870 .vindex "&$acl_verify_message$&"
29871 If you want to use a &%warn%& statement to log the result of an address
29872 verification, you can use &$acl_verify_message$& to include the verification
29873 error message.
29874
29875 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
29876 the start of the logged message. If the same warning log message is requested
29877 more than once while receiving  a single email message, only one copy is
29878 actually logged. If you want to log multiple copies, use &%logwrite%& instead
29879 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
29880 is logged for a successful &%warn%& statement.
29881
29882 If &%log_message%& is not present and there is no underlying error message (for
29883 example, from the failure of address verification), but &%message%& is present,
29884 the &%message%& text is used for logging rejections. However, if any text for
29885 logging contains newlines, only the first line is logged. In the absence of
29886 both &%log_message%& and &%message%&, a default built-in message is used for
29887 logging rejections.
29888
29889
29890 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
29891 .cindex "&%log_reject_target%& ACL modifier"
29892 .cindex "logging in ACL" "specifying which log"
29893 This modifier makes it possible to specify which logs are used for messages
29894 about ACL rejections. Its argument is a colon-separated list of words that can
29895 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
29896 may be empty, in which case a rejection is not logged at all. For example, this
29897 ACL fragment writes no logging information when access is denied:
29898 .display
29899 &`deny `&<&'some conditions'&>
29900 &`     log_reject_target =`&
29901 .endd
29902 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
29903 permanent and temporary rejections. Its effect lasts for the rest of the
29904 current ACL.
29905
29906
29907 .vitem &*logwrite*&&~=&~<&'text'&>
29908 .cindex "&%logwrite%& ACL modifier"
29909 .cindex "logging in ACL" "immediate"
29910 This modifier writes a message to a log file as soon as it is encountered when
29911 processing an ACL. (Compare &%log_message%&, which, except in the case of
29912 &%warn%& and &%discard%&, is used only if the ACL statement denies
29913 access.) The &%logwrite%& modifier can be used to log special incidents in
29914 ACLs. For example:
29915 .display
29916 &`accept `&<&'some special conditions'&>
29917 &`       control  = freeze`&
29918 &`       logwrite = froze message because ...`&
29919 .endd
29920 By default, the message is written to the main log. However, it may begin
29921 with a colon, followed by a comma-separated list of log names, and then
29922 another colon, to specify exactly which logs are to be written. For
29923 example:
29924 .code
29925 logwrite = :main,reject: text for main and reject logs
29926 logwrite = :panic: text for panic log only
29927 .endd
29928
29929
29930 .vitem &*message*&&~=&~<&'text'&>
29931 .cindex "&%message%& ACL modifier"
29932 This modifier sets up a text string that is expanded and used as a response
29933 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
29934 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
29935 there is some complication if &%endpass%& is involved; see the description of
29936 &%accept%& for details.)
29937
29938 The expansion of the message happens at the time Exim decides that the ACL is
29939 to end, not at the time it processes &%message%&. If the expansion fails, or
29940 generates an empty string, the modifier is ignored. Here is an example where
29941 &%message%& must be specified first, because the ACL ends with a rejection if
29942 the &%hosts%& condition fails:
29943 .code
29944 require  message = Host not recognized
29945          hosts = 10.0.0.0/8
29946 .endd
29947 (Once a condition has failed, no further conditions or modifiers are
29948 processed.)
29949
29950 .cindex "SMTP" "error codes"
29951 .oindex "&%smtp_banner%&
29952 For ACLs that are triggered by SMTP commands, the message is returned as part
29953 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
29954 is meaningful only for SMTP, as no message is returned when a non-SMTP message
29955 is accepted. In the case of the connect ACL, accepting with a message modifier
29956 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
29957 accept message may not contain more than one line (otherwise it will be
29958 truncated at the first newline and a panic logged), and it cannot affect the
29959 EHLO options.
29960
29961 When SMTP is involved, the message may begin with an overriding response code,
29962 consisting of three digits optionally followed by an &"extended response code"&
29963 of the form &'n.n.n'&, each code being followed by a space. For example:
29964 .code
29965 deny  message = 599 1.2.3 Host not welcome
29966       hosts = 192.168.34.0/24
29967 .endd
29968 The first digit of the supplied response code must be the same as would be sent
29969 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
29970 access, but for the predata ACL, note that the default success code is 354, not
29971 2&'xx'&.
29972
29973 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
29974 the message modifier cannot override the 221 response code.
29975
29976 The text in a &%message%& modifier is literal; any quotes are taken as
29977 literals, but because the string is expanded, backslash escapes are processed
29978 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
29979 response.
29980
29981 .vindex "&$acl_verify_message$&"
29982 For ACLs that are called by an &%acl =%& ACL condition, the message is
29983 stored in &$acl_verify_message$&, from which the calling ACL may use it.
29984
29985 If &%message%& is used on a statement that verifies an address, the message
29986 specified overrides any message that is generated by the verification process.
29987 However, the original message is available in the variable
29988 &$acl_verify_message$&, so you can incorporate it into your message if you
29989 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
29990 routers to be passed back as part of the SMTP response, you should either not
29991 use a &%message%& modifier, or make use of &$acl_verify_message$&.
29992
29993 For compatibility with previous releases of Exim, a &%message%& modifier that
29994 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
29995 modifier, but this usage is now deprecated. However, &%message%& acts only when
29996 all the conditions are true, wherever it appears in an ACL command, whereas
29997 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
29998 &%warn%& in an ACL that is not concerned with receiving a message, it has no
29999 effect.
30000
30001
30002 .vitem &*queue*&&~=&~<&'text'&>
30003 .cindex "&%queue%& ACL modifier"
30004 .cindex "named queues" "selecting in ACL"
30005 This modifier specifies the use of a named queue for spool files
30006 for the message.
30007 It can only be used before the message is received (i.e. not in
30008 the DATA ACL).
30009 This could be used, for example, for known high-volume burst sources
30010 of traffic, or for quarantine of messages.
30011 Separate queue-runner processes will be needed for named queues.
30012 If the text after expansion is empty, the default queue is used.
30013
30014
30015 .vitem &*remove_header*&&~=&~<&'text'&>
30016 This modifier specifies one or more header names in a colon-separated list
30017  that are to be removed from an incoming message, assuming, of course, that
30018 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30019
30020
30021 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30022 .cindex "&%set%& ACL modifier"
30023 This modifier puts a value into one of the ACL variables (see section
30024 &<<SECTaclvariables>>&).
30025
30026
30027 .vitem &*udpsend*&&~=&~<&'parameters'&>
30028 .cindex "UDP communications"
30029 This modifier sends a UDP packet, for purposes such as statistics
30030 collection or behaviour monitoring. The parameters are expanded, and
30031 the result of the expansion must be a colon-separated list consisting
30032 of a destination server, port number, and the packet contents. The
30033 server can be specified as a host name or IPv4 or IPv6 address. The
30034 separator can be changed with the usual angle bracket syntax. For
30035 example, you might want to collect information on which hosts connect
30036 when:
30037 .code
30038 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30039              $tod_zulu $sender_host_address
30040 .endd
30041 .endlist
30042
30043
30044
30045
30046 .section "Use of the control modifier" "SECTcontrols"
30047 .cindex "&%control%& ACL modifier"
30048 The &%control%& modifier supports the following settings:
30049
30050 .vlist
30051 .vitem &*control&~=&~allow_auth_unadvertised*&
30052 This modifier allows a client host to use the SMTP AUTH command even when it
30053 has not been advertised in response to EHLO. Furthermore, because there are
30054 apparently some really broken clients that do this, Exim will accept AUTH after
30055 HELO (rather than EHLO) when this control is set. It should be used only if you
30056 really need it, and you should limit its use to those broken clients that do
30057 not work without it. For example:
30058 .code
30059 warn hosts   = 192.168.34.25
30060      control = allow_auth_unadvertised
30061 .endd
30062 Normally, when an Exim server receives an AUTH command, it checks the name of
30063 the authentication mechanism that is given in the command to ensure that it
30064 matches an advertised mechanism. When this control is set, the check that a
30065 mechanism has been advertised is bypassed. Any configured mechanism can be used
30066 by the client. This control is permitted only in the connection and HELO ACLs.
30067
30068
30069 .vitem &*control&~=&~caseful_local_part*& &&&
30070        &*control&~=&~caselower_local_part*&
30071 .cindex "&ACL;" "case of local part in"
30072 .cindex "case of local parts"
30073 .vindex "&$local_part$&"
30074 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30075 (that is, during RCPT processing). By default, the contents of &$local_part$&
30076 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30077 any uppercase letters in the original local part are restored in &$local_part$&
30078 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30079 is encountered.
30080
30081 These controls affect only the current recipient. Moreover, they apply only to
30082 local part handling that takes place directly in the ACL (for example, as a key
30083 in lookups). If a test to verify the recipient is obeyed, the case-related
30084 handling of the local part during the verification is controlled by the router
30085 configuration (see the &%caseful_local_part%& generic router option).
30086
30087 This facility could be used, for example, to add a spam score to local parts
30088 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30089 spam score:
30090 .code
30091 warn  control = caseful_local_part
30092       set acl_m4 = ${eval:\
30093                      $acl_m4 + \
30094                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30095                     }
30096       control = caselower_local_part
30097 .endd
30098 Notice that we put back the lower cased version afterwards, assuming that
30099 is what is wanted for subsequent tests.
30100
30101
30102 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30103 .cindex "&ACL;" "cutthrough routing"
30104 .cindex "cutthrough" "requesting"
30105 This option requests delivery be attempted while the item is being received.
30106
30107 The option is usable in the RCPT ACL.
30108 If enabled for a message received via smtp and routed to an smtp transport,
30109 and only one transport, interface, destination host and port combination
30110 is used for all recipients of the message,
30111 then the delivery connection is made while the receiving connection is open
30112 and data is copied from one to the other.
30113
30114 An attempt to set this option for any recipient but the first
30115 for a mail will be quietly ignored.
30116 If a recipient-verify callout
30117 (with use_sender)
30118 connection is subsequently
30119 requested in the same ACL it is held open and used for
30120 any subsequent recipients and the data,
30121 otherwise one is made after the initial RCPT ACL completes.
30122
30123 Note that routers are used in verify mode,
30124 and cannot depend on content of received headers.
30125 Note also that headers cannot be
30126 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30127 Headers may be modified by routers (subject to the above) and transports.
30128 The &'Received-By:'& header is generated as soon as the body reception starts,
30129 rather than the traditional time after the full message is received;
30130 this will affect the timestamp.
30131
30132 All the usual ACLs are called; if one results in the message being
30133 rejected, all effort spent in delivery (including the costs on
30134 the ultimate destination) will be wasted.
30135 Note that in the case of data-time ACLs this includes the entire
30136 message body.
30137
30138 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30139 of outgoing messages is done, because it sends data to the ultimate destination
30140 before the entire message has been received from the source.
30141 It is not supported for messages received with the SMTP PRDR
30142 or CHUNKING
30143 options in use.
30144
30145 Should the ultimate destination system positively accept or reject the mail,
30146 a corresponding indication is given to the source system and nothing is queued.
30147 If the item is successfully delivered in cutthrough mode
30148 the delivery log lines are tagged with ">>" rather than "=>" and appear
30149 before the acceptance "<=" line.
30150
30151 If there is a temporary error the item is queued for later delivery in the
30152 usual fashion.
30153 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30154 to the control; the default value is &"spool"& and the alternate value
30155 &"pass"& copies an SMTP defer response from the target back to the initiator
30156 and does not queue the message.
30157 Note that this is independent of any recipient verify conditions in the ACL.
30158
30159 Delivery in this mode avoids the generation of a bounce mail to a
30160 (possibly faked)
30161 sender when the destination system is doing content-scan based rejection.
30162
30163
30164 .vitem &*control&~=&~debug/*&<&'options'&>
30165 .cindex "&ACL;" "enabling debug logging"
30166 .cindex "debugging" "enabling from an ACL"
30167 This control turns on debug logging, almost as though Exim had been invoked
30168 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30169 by default called &'debuglog'&.
30170 The filename can be adjusted with the &'tag'& option, which
30171 may access any variables already defined.  The logging may be adjusted with
30172 the &'opts'& option, which takes the same values as the &`-d`& command-line
30173 option.
30174 Logging started this way may be stopped, and the file removed,
30175 with the &'kill'& option.
30176 Some examples (which depend on variables that don't exist in all
30177 contexts):
30178 .code
30179       control = debug
30180       control = debug/tag=.$sender_host_address
30181       control = debug/opts=+expand+acl
30182       control = debug/tag=.$message_exim_id/opts=+expand
30183       control = debug/kill
30184 .endd
30185
30186
30187 .vitem &*control&~=&~dkim_disable_verify*&
30188 .cindex "disable DKIM verify"
30189 .cindex "DKIM" "disable verify"
30190 This control turns off DKIM verification processing entirely.  For details on
30191 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30192
30193
30194 .vitem &*control&~=&~dscp/*&<&'value'&>
30195 .cindex "&ACL;" "setting DSCP value"
30196 .cindex "DSCP" "inbound"
30197 This option causes the DSCP value associated with the socket for the inbound
30198 connection to be adjusted to a given value, given as one of a number of fixed
30199 strings or to numeric value.
30200 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30201 Common values include &`throughput`&, &`mincost`&, and on newer systems
30202 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30203
30204 The outbound packets from Exim will be marked with this value in the header
30205 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30206 that these values will have any effect, not be stripped by networking
30207 equipment, or do much of anything without cooperation with your Network
30208 Engineer and those of all network operators between the source and destination.
30209
30210
30211 .vitem &*control&~=&~enforce_sync*& &&&
30212        &*control&~=&~no_enforce_sync*&
30213 .cindex "SMTP" "synchronization checking"
30214 .cindex "synchronization checking in SMTP"
30215 These controls make it possible to be selective about when SMTP synchronization
30216 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30217 state of the switch (it is true by default). See the description of this option
30218 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30219
30220 The effect of these two controls lasts for the remainder of the SMTP
30221 connection. They can appear in any ACL except the one for the non-SMTP
30222 messages. The most straightforward place to put them is in the ACL defined by
30223 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30224 before the first synchronization check. The expected use is to turn off the
30225 synchronization checks for badly-behaved hosts that you nevertheless need to
30226 work with.
30227
30228
30229 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30230 .cindex "fake defer"
30231 .cindex "defer, fake"
30232 This control works in exactly the same way as &%fakereject%& (described below)
30233 except that it causes an SMTP 450 response after the message data instead of a
30234 550 response. You must take care when using &%fakedefer%& because it causes the
30235 messages to be duplicated when the sender retries. Therefore, you should not
30236 use &%fakedefer%& if the message is to be delivered normally.
30237
30238 .vitem &*control&~=&~fakereject/*&<&'message'&>
30239 .cindex "fake rejection"
30240 .cindex "rejection, fake"
30241 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30242 words, only when an SMTP message is being received. If Exim accepts the
30243 message, instead the final 250 response, a 550 rejection message is sent.
30244 However, Exim proceeds to deliver the message as normal. The control applies
30245 only to the current message, not to any subsequent ones that may be received in
30246 the same SMTP connection.
30247
30248 The text for the 550 response is taken from the &%control%& modifier. If no
30249 message is supplied, the following is used:
30250 .code
30251 550-Your message has been rejected but is being
30252 550-kept for evaluation.
30253 550-If it was a legitimate message, it may still be
30254 550 delivered to the target recipient(s).
30255 .endd
30256 This facility should be used with extreme caution.
30257
30258 .vitem &*control&~=&~freeze*&
30259 .cindex "frozen messages" "forcing in ACL"
30260 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30261 other words, only when a message is being received. If the message is accepted,
30262 it is placed on Exim's queue and frozen. The control applies only to the
30263 current message, not to any subsequent ones that may be received in the same
30264 SMTP connection.
30265
30266 This modifier can optionally be followed by &`/no_tell`&. If the global option
30267 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30268 is told about the freezing), provided all the &*control=freeze*& modifiers that
30269 are obeyed for the current message have the &`/no_tell`& option.
30270
30271 .vitem &*control&~=&~no_delay_flush*&
30272 .cindex "SMTP" "output flushing, disabling for delay"
30273 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30274 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30275 use. This control, as long as it is encountered before the &%delay%& modifier,
30276 disables such output flushing.
30277
30278 .vitem &*control&~=&~no_callout_flush*&
30279 .cindex "SMTP" "output flushing, disabling for callout"
30280 Exim normally flushes SMTP output before performing a callout in an ACL, to
30281 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30282 use. This control, as long as it is encountered before the &%verify%& condition
30283 that causes the callout, disables such output flushing.
30284
30285 .vitem &*control&~=&~no_mbox_unspool*&
30286 This control is available when Exim is compiled with the content scanning
30287 extension. Content scanning may require a copy of the current message, or parts
30288 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30289 or spam scanner. Normally, such copies are deleted when they are no longer
30290 needed. If this control is set, the copies are not deleted. The control applies
30291 only to the current message, not to any subsequent ones that may be received in
30292 the same SMTP connection. It is provided for debugging purposes and is unlikely
30293 to be useful in production.
30294
30295 .vitem &*control&~=&~no_multiline_responses*&
30296 .cindex "multiline responses, suppressing"
30297 This control is permitted for any ACL except the one for non-SMTP messages.
30298 It seems that there are broken clients in use that cannot handle multiline
30299 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30300
30301 If this control is set, multiline SMTP responses from ACL rejections are
30302 suppressed. One way of doing this would have been to put out these responses as
30303 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30304 (&"use multiline responses for more"& it says &-- ha!), and some of the
30305 responses might get close to that. So this facility, which is after all only a
30306 sop to broken clients, is implemented by doing two very easy things:
30307
30308 .ilist
30309 Extra information that is normally output as part of a rejection caused by
30310 sender verification failure is omitted. Only the final line (typically &"sender
30311 verification failed"&) is sent.
30312 .next
30313 If a &%message%& modifier supplies a multiline response, only the first
30314 line is output.
30315 .endlist
30316
30317 The setting of the switch can, of course, be made conditional on the
30318 calling host. Its effect lasts until the end of the SMTP connection.
30319
30320 .vitem &*control&~=&~no_pipelining*&
30321 .cindex "PIPELINING" "suppressing advertising"
30322 This control turns off the advertising of the PIPELINING extension to SMTP in
30323 the current session. To be useful, it must be obeyed before Exim sends its
30324 response to an EHLO command. Therefore, it should normally appear in an ACL
30325 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30326 &%pipelining_advertise_hosts%&.
30327
30328 .vitem &*control&~=&~queue_only*&
30329 .oindex "&%queue_only%&"
30330 .cindex "queueing incoming messages"
30331 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30332 other words, only when a message is being received. If the message is accepted,
30333 it is placed on Exim's queue and left there for delivery by a subsequent queue
30334 runner. No immediate delivery process is started. In other words, it has the
30335 effect as the &%queue_only%& global option. However, the control applies only
30336 to the current message, not to any subsequent ones that may be received in the
30337 same SMTP connection.
30338
30339 .vitem &*control&~=&~submission/*&<&'options'&>
30340 .cindex "message" "submission"
30341 .cindex "submission mode"
30342 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30343 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30344 the current message is a submission from a local MUA. In this case, Exim
30345 operates in &"submission mode"&, and applies certain fixups to the message if
30346 necessary. For example, it adds a &'Date:'& header line if one is not present.
30347 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30348 late (the message has already been created).
30349
30350 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30351 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30352 submission mode; the available options for this control are described there.
30353 The control applies only to the current message, not to any subsequent ones
30354 that may be received in the same SMTP connection.
30355
30356 .vitem &*control&~=&~suppress_local_fixups*&
30357 .cindex "submission fixups, suppressing"
30358 This control applies to locally submitted (non TCP/IP) messages, and is the
30359 complement of &`control = submission`&. It disables the fixups that are
30360 normally applied to locally-submitted messages. Specifically:
30361
30362 .ilist
30363 Any &'Sender:'& header line is left alone (in this respect, it is a
30364 dynamic version of &%local_sender_retain%&).
30365 .next
30366 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30367 .next
30368 There is no check that &'From:'& corresponds to the actual sender.
30369 .endlist ilist
30370
30371 This control may be useful when a remotely-originated message is accepted,
30372 passed to some scanning program, and then re-submitted for delivery. It can be
30373 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30374 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30375 data is read.
30376
30377 &*Note:*& This control applies only to the current message, not to any others
30378 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30379
30380 .vitem &*control&~=&~utf8_downconvert*&
30381 This control enables conversion of UTF-8 in message addresses
30382 to a-label form.
30383 For details see section &<<SECTi18nMTA>>&.
30384 .endlist vlist
30385
30386
30387 .section "Summary of message fixup control" "SECTsummesfix"
30388 All four possibilities for message fixups can be specified:
30389
30390 .ilist
30391 Locally submitted, fixups applied: the default.
30392 .next
30393 Locally submitted, no fixups applied: use
30394 &`control = suppress_local_fixups`&.
30395 .next
30396 Remotely submitted, no fixups applied: the default.
30397 .next
30398 Remotely submitted, fixups applied: use &`control = submission`&.
30399 .endlist
30400
30401
30402
30403 .section "Adding header lines in ACLs" "SECTaddheadacl"
30404 .cindex "header lines" "adding in an ACL"
30405 .cindex "header lines" "position of added lines"
30406 .cindex "&%add_header%& ACL modifier"
30407 The &%add_header%& modifier can be used to add one or more extra header lines
30408 to an incoming message, as in this example:
30409 .code
30410 warn dnslists = sbl.spamhaus.org : \
30411                 dialup.mail-abuse.org
30412      add_header = X-blacklisted-at: $dnslist_domain
30413 .endd
30414 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30415 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30416 receiving a message). The message must ultimately be accepted for
30417 &%add_header%& to have any significant effect. You can use &%add_header%& with
30418 any ACL verb, including &%deny%& (though this is potentially useful only in a
30419 RCPT ACL).
30420
30421 Headers will not be added to the message if the modifier is used in
30422 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30423
30424 Leading and trailing newlines are removed from
30425 the data for the &%add_header%& modifier; if it then
30426 contains one or more newlines that
30427 are not followed by a space or a tab, it is assumed to contain multiple header
30428 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30429 front of any line that is not a valid header line.
30430
30431 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30432 They are added to the message before processing the DATA and MIME ACLs.
30433 However, if an identical header line is requested more than once, only one copy
30434 is actually added to the message. Further header lines may be accumulated
30435 during the DATA and MIME ACLs, after which they are added to the message, again
30436 with duplicates suppressed. Thus, it is possible to add two identical header
30437 lines to an SMTP message, but only if one is added before DATA and one after.
30438 In the case of non-SMTP messages, new headers are accumulated during the
30439 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30440 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30441 are included in the entry that is written to the reject log.
30442
30443 .cindex "header lines" "added; visibility of"
30444 Header lines are not visible in string expansions
30445 of message headers
30446 until they are added to the
30447 message. It follows that header lines defined in the MAIL, RCPT, and predata
30448 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30449 header lines that are added by the DATA or MIME ACLs are not visible in those
30450 ACLs. Because of this restriction, you cannot use header lines as a way of
30451 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30452 this, you can use ACL variables, as described in section
30453 &<<SECTaclvariables>>&.
30454
30455 The list of headers yet to be added is given by the &%$headers_added%& variable.
30456
30457 The &%add_header%& modifier acts immediately as it is encountered during the
30458 processing of an ACL. Notice the difference between these two cases:
30459 .display
30460 &`accept add_header = ADDED: some text`&
30461 &`       `&<&'some condition'&>
30462
30463 &`accept `&<&'some condition'&>
30464 &`       add_header = ADDED: some text`&
30465 .endd
30466 In the first case, the header line is always added, whether or not the
30467 condition is true. In the second case, the header line is added only if the
30468 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30469 ACL statement. All those that are encountered before a condition fails are
30470 honoured.
30471
30472 .cindex "&%warn%& ACL verb"
30473 For compatibility with previous versions of Exim, a &%message%& modifier for a
30474 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30475 effect only if all the conditions are true, even if it appears before some of
30476 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30477 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30478 are present on a &%warn%& verb, both are processed according to their
30479 specifications.
30480
30481 By default, new header lines are added to a message at the end of the existing
30482 header lines. However, you can specify that any particular header line should
30483 be added right at the start (before all the &'Received:'& lines), immediately
30484 after the first block of &'Received:'& lines, or immediately before any line
30485 that is not a &'Received:'& or &'Resent-something:'& header.
30486
30487 This is done by specifying &":at_start:"&, &":after_received:"&, or
30488 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30489 header line, respectively. (Header text cannot start with a colon, as there has
30490 to be a header name first.) For example:
30491 .code
30492 warn add_header = \
30493        :after_received:X-My-Header: something or other...
30494 .endd
30495 If more than one header line is supplied in a single &%add_header%& modifier,
30496 each one is treated independently and can therefore be placed differently. If
30497 you add more than one line at the start, or after the Received: block, they end
30498 up in reverse order.
30499
30500 &*Warning*&: This facility currently applies only to header lines that are
30501 added in an ACL. It does NOT work for header lines that are added in a
30502 system filter or in a router or transport.
30503
30504
30505
30506 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30507 .cindex "header lines" "removing in an ACL"
30508 .cindex "header lines" "position of removed lines"
30509 .cindex "&%remove_header%& ACL modifier"
30510 The &%remove_header%& modifier can be used to remove one or more header lines
30511 from an incoming message, as in this example:
30512 .code
30513 warn   message        = Remove internal headers
30514        remove_header  = x-route-mail1 : x-route-mail2
30515 .endd
30516 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30517 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30518 receiving a message). The message must ultimately be accepted for
30519 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30520 with any ACL verb, including &%deny%&, though this is really not useful for
30521 any verb that doesn't result in a delivered message.
30522
30523 Headers will not be removed from the message if the modifier is used in
30524 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30525
30526 More than one header can be removed at the same time by using a colon separated
30527 list of header names. The header matching is case insensitive. Wildcards are
30528 not permitted, nor is list expansion performed, so you cannot use hostlists to
30529 create a list of headers, however both connection and message variable expansion
30530 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30531 .code
30532 warn   hosts           = +internal_hosts
30533        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30534 warn   message         = Remove internal headers
30535        remove_header   = $acl_c_ihdrs
30536 .endd
30537 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30538 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30539 If multiple header lines match, all are removed.
30540 There is no harm in attempting to remove the same header twice nor in removing
30541 a non-existent header. Further header lines to be removed may be accumulated
30542 during the DATA and MIME ACLs, after which they are removed from the message,
30543 if present. In the case of non-SMTP messages, headers to be removed are
30544 accumulated during the non-SMTP ACLs, and are removed from the message after
30545 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30546 ACL, there really is no effect because there is no logging of what headers
30547 would have been removed.
30548
30549 .cindex "header lines" "removed; visibility of"
30550 Header lines are not visible in string expansions until the DATA phase when it
30551 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30552 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30553 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30554 this restriction, you cannot use header lines as a way of controlling data
30555 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30556 you should instead use ACL variables, as described in section
30557 &<<SECTaclvariables>>&.
30558
30559 The &%remove_header%& modifier acts immediately as it is encountered during the
30560 processing of an ACL. Notice the difference between these two cases:
30561 .display
30562 &`accept remove_header = X-Internal`&
30563 &`       `&<&'some condition'&>
30564
30565 &`accept `&<&'some condition'&>
30566 &`       remove_header = X-Internal`&
30567 .endd
30568 In the first case, the header line is always removed, whether or not the
30569 condition is true. In the second case, the header line is removed only if the
30570 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30571 same ACL statement. All those that are encountered before a condition fails
30572 are honoured.
30573
30574 &*Warning*&: This facility currently applies only to header lines that are
30575 present during ACL processing. It does NOT remove header lines that are added
30576 in a system filter or in a router or transport.
30577
30578
30579
30580
30581 .section "ACL conditions" "SECTaclconditions"
30582 .cindex "&ACL;" "conditions; list of"
30583 Some of the conditions listed in this section are available only when Exim is
30584 compiled with the content-scanning extension. They are included here briefly
30585 for completeness. More detailed descriptions can be found in the discussion on
30586 content scanning in chapter &<<CHAPexiscan>>&.
30587
30588 Not all conditions are relevant in all circumstances. For example, testing
30589 senders and recipients does not make sense in an ACL that is being run as the
30590 result of the arrival of an ETRN command, and checks on message headers can be
30591 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30592 can use the same condition (with different parameters) more than once in the
30593 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30594 The conditions are as follows:
30595
30596
30597 .vlist
30598 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30599 .cindex "&ACL;" "nested"
30600 .cindex "&ACL;" "indirect"
30601 .cindex "&ACL;" "arguments"
30602 .cindex "&%acl%& ACL condition"
30603 The possible values of the argument are the same as for the
30604 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30605 &"accept"& the condition is true; if it returns &"deny"& the condition is
30606 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30607 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30608 condition false. This means that further processing of the &%warn%& verb
30609 ceases, but processing of the ACL continues.
30610
30611 If the argument is a named ACL, up to nine space-separated optional values
30612 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30613 and $acl_narg is set to the count of values.
30614 Previous values of these variables are restored after the call returns.
30615 The name and values are expanded separately.
30616 Note that spaces in complex expansions which are used as arguments
30617 will act as argument separators.
30618
30619 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30620 the connection is dropped. If it returns &"discard"&, the verb must be
30621 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30622 conditions are tested.
30623
30624 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30625 loops. This condition allows you to use different ACLs in different
30626 circumstances. For example, different ACLs can be used to handle RCPT commands
30627 for different local users or different local domains.
30628
30629 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30630 .cindex "&%authenticated%& ACL condition"
30631 .cindex "authentication" "ACL checking"
30632 .cindex "&ACL;" "testing for authentication"
30633 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30634 the name of the authenticator is tested against the list. To test for
30635 authentication by any authenticator, you can set
30636 .code
30637 authenticated = *
30638 .endd
30639
30640 .vitem &*condition&~=&~*&<&'string'&>
30641 .cindex "&%condition%& ACL condition"
30642 .cindex "customizing" "ACL condition"
30643 .cindex "&ACL;" "customized test"
30644 .cindex "&ACL;" "testing, customized"
30645 This feature allows you to make up custom conditions. If the result of
30646 expanding the string is an empty string, the number zero, or one of the strings
30647 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30648 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30649 any other value, some error is assumed to have occurred, and the ACL returns
30650 &"defer"&. However, if the expansion is forced to fail, the condition is
30651 ignored. The effect is to treat it as true, whether it is positive or
30652 negative.
30653
30654 .vitem &*decode&~=&~*&<&'location'&>
30655 .cindex "&%decode%& ACL condition"
30656 This condition is available only when Exim is compiled with the
30657 content-scanning extension, and it is allowed only in the ACL defined by
30658 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30659 If all goes well, the condition is true. It is false only if there are
30660 problems such as a syntax error or a memory shortage. For more details, see
30661 chapter &<<CHAPexiscan>>&.
30662
30663 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30664 .cindex "&%dnslists%& ACL condition"
30665 .cindex "DNS list" "in ACL"
30666 .cindex "black list (DNS)"
30667 .cindex "&ACL;" "testing a DNS list"
30668 This condition checks for entries in DNS black lists. These are also known as
30669 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30670 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30671 different variants of this condition to describe briefly here. See sections
30672 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30673
30674 .vitem &*domains&~=&~*&<&'domain&~list'&>
30675 .cindex "&%domains%& ACL condition"
30676 .cindex "domain" "ACL checking"
30677 .cindex "&ACL;" "testing a recipient domain"
30678 .vindex "&$domain_data$&"
30679 This condition is relevant only after a RCPT command. It checks that the domain
30680 of the recipient address is in the domain list. If percent-hack processing is
30681 enabled, it is done before this test is done. If the check succeeds with a
30682 lookup, the result of the lookup is placed in &$domain_data$& until the next
30683 &%domains%& test.
30684
30685 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30686 use &%domains%& in a DATA ACL.
30687
30688
30689 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30690 .cindex "&%encrypted%& ACL condition"
30691 .cindex "encryption" "checking in an ACL"
30692 .cindex "&ACL;" "testing for encryption"
30693 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30694 name of the cipher suite in use is tested against the list. To test for
30695 encryption without testing for any specific cipher suite(s), set
30696 .code
30697 encrypted = *
30698 .endd
30699
30700
30701 .vitem &*hosts&~=&~*&<&'host&~list'&>
30702 .cindex "&%hosts%& ACL condition"
30703 .cindex "host" "ACL checking"
30704 .cindex "&ACL;" "testing the client host"
30705 This condition tests that the calling host matches the host list. If you have
30706 name lookups or wildcarded host names and IP addresses in the same host list,
30707 you should normally put the IP addresses first. For example, you could have:
30708 .code
30709 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30710 .endd
30711 The lookup in this example uses the host name for its key. This is implied by
30712 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30713 and it wouldn't matter which way round you had these two items.)
30714
30715 The reason for the problem with host names lies in the left-to-right way that
30716 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30717 but when it reaches an item that requires a host name, it fails if it cannot
30718 find a host name to compare with the pattern. If the above list is given in the
30719 opposite order, the &%accept%& statement fails for a host whose name cannot be
30720 found, even if its IP address is 10.9.8.7.
30721
30722 If you really do want to do the name check first, and still recognize the IP
30723 address even if the name lookup fails, you can rewrite the ACL like this:
30724 .code
30725 accept hosts = dbm;/etc/friendly/hosts
30726 accept hosts = 10.9.8.7
30727 .endd
30728 The default action on failing to find the host name is to assume that the host
30729 is not in the list, so the first &%accept%& statement fails. The second
30730 statement can then check the IP address.
30731
30732 .vindex "&$host_data$&"
30733 If a &%hosts%& condition is satisfied by means of a lookup, the result
30734 of the lookup is made available in the &$host_data$& variable. This
30735 allows you, for example, to set up a statement like this:
30736 .code
30737 deny  hosts = net-lsearch;/some/file
30738 message = $host_data
30739 .endd
30740 which gives a custom error message for each denied host.
30741
30742 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30743 .cindex "&%local_parts%& ACL condition"
30744 .cindex "local part" "ACL checking"
30745 .cindex "&ACL;" "testing a local part"
30746 .vindex "&$local_part_data$&"
30747 This condition is relevant only after a RCPT command. It checks that the local
30748 part of the recipient address is in the list. If percent-hack processing is
30749 enabled, it is done before this test. If the check succeeds with a lookup, the
30750 result of the lookup is placed in &$local_part_data$&, which remains set until
30751 the next &%local_parts%& test.
30752
30753 .vitem &*malware&~=&~*&<&'option'&>
30754 .cindex "&%malware%& ACL condition"
30755 .cindex "&ACL;" "virus scanning"
30756 .cindex "&ACL;" "scanning for viruses"
30757 This condition is available only when Exim is compiled with the
30758 content-scanning extension. It causes the incoming message to be scanned for
30759 viruses. For details, see chapter &<<CHAPexiscan>>&.
30760
30761 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30762 .cindex "&%mime_regex%& ACL condition"
30763 .cindex "&ACL;" "testing by regex matching"
30764 This condition is available only when Exim is compiled with the
30765 content-scanning extension, and it is allowed only in the ACL defined by
30766 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30767 with any of the regular expressions. For details, see chapter
30768 &<<CHAPexiscan>>&.
30769
30770 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30771 .cindex "rate limiting"
30772 This condition can be used to limit the rate at which a user or host submits
30773 messages. Details are given in section &<<SECTratelimiting>>&.
30774
30775 .vitem &*recipients&~=&~*&<&'address&~list'&>
30776 .cindex "&%recipients%& ACL condition"
30777 .cindex "recipient" "ACL checking"
30778 .cindex "&ACL;" "testing a recipient"
30779 This condition is relevant only after a RCPT command. It checks the entire
30780 recipient address against a list of recipients.
30781
30782 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30783 .cindex "&%regex%& ACL condition"
30784 .cindex "&ACL;" "testing by regex matching"
30785 This condition is available only when Exim is compiled with the
30786 content-scanning extension, and is available only in the DATA, MIME, and
30787 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30788 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30789
30790 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
30791 .cindex "&%sender_domains%& ACL condition"
30792 .cindex "sender" "ACL checking"
30793 .cindex "&ACL;" "testing a sender domain"
30794 .vindex "&$domain$&"
30795 .vindex "&$sender_address_domain$&"
30796 This condition tests the domain of the sender of the message against the given
30797 domain list. &*Note*&: The domain of the sender address is in
30798 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
30799 of this condition. This is an exception to the general rule for testing domain
30800 lists. It is done this way so that, if this condition is used in an ACL for a
30801 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
30802 influence the sender checking.
30803
30804 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30805 relaying, because sender addresses are easily, and commonly, forged.
30806
30807 .vitem &*senders&~=&~*&<&'address&~list'&>
30808 .cindex "&%senders%& ACL condition"
30809 .cindex "sender" "ACL checking"
30810 .cindex "&ACL;" "testing a sender"
30811 This condition tests the sender of the message against the given list. To test
30812 for a bounce message, which has an empty sender, set
30813 .code
30814 senders = :
30815 .endd
30816 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30817 relaying, because sender addresses are easily, and commonly, forged.
30818
30819 .vitem &*spam&~=&~*&<&'username'&>
30820 .cindex "&%spam%& ACL condition"
30821 .cindex "&ACL;" "scanning for spam"
30822 This condition is available only when Exim is compiled with the
30823 content-scanning extension. It causes the incoming message to be scanned by
30824 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
30825
30826 .vitem &*verify&~=&~certificate*&
30827 .cindex "&%verify%& ACL condition"
30828 .cindex "TLS" "client certificate verification"
30829 .cindex "certificate" "verification of client"
30830 .cindex "&ACL;" "certificate verification"
30831 .cindex "&ACL;" "testing a TLS certificate"
30832 This condition is true in an SMTP session if the session is encrypted, and a
30833 certificate was received from the client, and the certificate was verified. The
30834 server requests a certificate only if the client matches &%tls_verify_hosts%&
30835 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
30836
30837 .vitem &*verify&~=&~csa*&
30838 .cindex "CSA verification"
30839 This condition checks whether the sending host (the client) is authorized to
30840 send email. Details of how this works are given in section
30841 &<<SECTverifyCSA>>&.
30842
30843 .vitem &*verify&~=&~header_names_ascii*&
30844 .cindex "&%verify%& ACL condition"
30845 .cindex "&ACL;" "verifying header names only ASCII"
30846 .cindex "header lines" "verifying header names only ASCII"
30847 .cindex "verifying" "header names only ASCII"
30848 This condition is relevant only in an ACL that is run after a message has been
30849 received, that is, in an ACL specified by &%acl_smtp_data%& or
30850 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
30851 there are no non-ASCII characters, also excluding control characters.  The
30852 allowable characters are decimal ASCII values 33 through 126.
30853
30854 Exim itself will handle headers with non-ASCII characters, but it can cause
30855 problems for downstream applications, so this option will allow their
30856 detection and rejection in the DATA ACL's.
30857
30858 .vitem &*verify&~=&~header_sender/*&<&'options'&>
30859 .cindex "&%verify%& ACL condition"
30860 .cindex "&ACL;" "verifying sender in the header"
30861 .cindex "header lines" "verifying the sender in"
30862 .cindex "sender" "verifying in header"
30863 .cindex "verifying" "sender in header"
30864 This condition is relevant only in an ACL that is run after a message has been
30865 received, that is, in an ACL specified by &%acl_smtp_data%& or
30866 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
30867 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
30868 is loosely thought of as a &"sender"& address (hence the name of the test).
30869 However, an address that appears in one of these headers need not be an address
30870 that accepts bounce messages; only sender addresses in envelopes are required
30871 to accept bounces. Therefore, if you use the callout option on this check, you
30872 might want to arrange for a non-empty address in the MAIL command.
30873
30874 Details of address verification and the options are given later, starting at
30875 section &<<SECTaddressverification>>& (callouts are described in section
30876 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
30877 condition to restrict it to bounce messages only:
30878 .code
30879 deny    senders = :
30880         message = A valid sender header is required for bounces
30881        !verify  = header_sender
30882 .endd
30883
30884 .vitem &*verify&~=&~header_syntax*&
30885 .cindex "&%verify%& ACL condition"
30886 .cindex "&ACL;" "verifying header syntax"
30887 .cindex "header lines" "verifying syntax"
30888 .cindex "verifying" "header syntax"
30889 This condition is relevant only in an ACL that is run after a message has been
30890 received, that is, in an ACL specified by &%acl_smtp_data%& or
30891 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
30892 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
30893 and &'Bcc:'&), returning true if there are no problems.
30894 Unqualified addresses (local parts without domains) are
30895 permitted only in locally generated messages and from hosts that match
30896 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
30897 appropriate.
30898
30899 Note that this condition is a syntax check only. However, a common spamming
30900 ploy used to be to send syntactically invalid headers such as
30901 .code
30902 To: @
30903 .endd
30904 and this condition can be used to reject such messages, though they are not as
30905 common as they used to be.
30906
30907 .vitem &*verify&~=&~helo*&
30908 .cindex "&%verify%& ACL condition"
30909 .cindex "&ACL;" "verifying HELO/EHLO"
30910 .cindex "HELO" "verifying"
30911 .cindex "EHLO" "verifying"
30912 .cindex "verifying" "EHLO"
30913 .cindex "verifying" "HELO"
30914 This condition is true if a HELO or EHLO command has been received from the
30915 client host, and its contents have been verified. If there has been no previous
30916 attempt to verify the HELO/EHLO contents, it is carried out when this
30917 condition is encountered. See the description of the &%helo_verify_hosts%& and
30918 &%helo_try_verify_hosts%& options for details of how to request verification
30919 independently of this condition, and for detail of the verification.
30920
30921 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
30922 option), this condition is always true.
30923
30924
30925 .vitem &*verify&~=&~not_blind/*&<&'options'&>
30926 .cindex "verifying" "not blind"
30927 .cindex "bcc recipients, verifying none"
30928 This condition checks that there are no blind (bcc) recipients in the message.
30929 Every envelope recipient must appear either in a &'To:'& header line or in a
30930 &'Cc:'& header line for this condition to be true. Local parts are checked
30931 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
30932 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
30933 used only in a DATA or non-SMTP ACL.
30934
30935 .new
30936 There is one possible option, &`case_insensitive`&.  If this is present then
30937 local parts are checked case-insensitively.
30938 .wen
30939
30940 There are, of course, many legitimate messages that make use of blind (bcc)
30941 recipients. This check should not be used on its own for blocking messages.
30942
30943
30944 .vitem &*verify&~=&~recipient/*&<&'options'&>
30945 .cindex "&%verify%& ACL condition"
30946 .cindex "&ACL;" "verifying recipient"
30947 .cindex "recipient" "verifying"
30948 .cindex "verifying" "recipient"
30949 .vindex "&$address_data$&"
30950 This condition is relevant only after a RCPT command. It verifies the current
30951 recipient. Details of address verification are given later, starting at section
30952 &<<SECTaddressverification>>&. After a recipient has been verified, the value
30953 of &$address_data$& is the last value that was set while routing the address.
30954 This applies even if the verification fails. When an address that is being
30955 verified is redirected to a single address, verification continues with the new
30956 address, and in that case, the subsequent value of &$address_data$& is the
30957 value for the child address.
30958
30959 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
30960 .cindex "&%verify%& ACL condition"
30961 .cindex "&ACL;" "verifying host reverse lookup"
30962 .cindex "host" "verifying reverse lookup"
30963 This condition ensures that a verified host name has been looked up from the IP
30964 address of the client host. (This may have happened already if the host name
30965 was needed for checking a host list, or if the host matched &%host_lookup%&.)
30966 Verification ensures that the host name obtained from a reverse DNS lookup, or
30967 one of its aliases, does, when it is itself looked up in the DNS, yield the
30968 original IP address.
30969
30970 There is one possible option, &`defer_ok`&.  If this is present and a
30971 DNS operation returns a temporary error, the verify condition succeeds.
30972
30973 If this condition is used for a locally generated message (that is, when there
30974 is no client host involved), it always succeeds.
30975
30976 .vitem &*verify&~=&~sender/*&<&'options'&>
30977 .cindex "&%verify%& ACL condition"
30978 .cindex "&ACL;" "verifying sender"
30979 .cindex "sender" "verifying"
30980 .cindex "verifying" "sender"
30981 This condition is relevant only after a MAIL or RCPT command, or after a
30982 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
30983 the message's sender is empty (that is, this is a bounce message), the
30984 condition is true. Otherwise, the sender address is verified.
30985
30986 .vindex "&$address_data$&"
30987 .vindex "&$sender_address_data$&"
30988 If there is data in the &$address_data$& variable at the end of routing, its
30989 value is placed in &$sender_address_data$& at the end of verification. This
30990 value can be used in subsequent conditions and modifiers in the same ACL
30991 statement. It does not persist after the end of the current statement. If you
30992 want to preserve the value for longer, you can save it in an ACL variable.
30993
30994 Details of verification are given later, starting at section
30995 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
30996 to avoid doing it more than once per message.
30997
30998 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
30999 .cindex "&%verify%& ACL condition"
31000 This is a variation of the previous option, in which a modified address is
31001 verified as a sender.
31002
31003 Note that '/' is legal in local-parts; if the address may have such
31004 (eg. is generated from the received message)
31005 they must be protected from the options parsing by doubling:
31006 .code
31007 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31008 .endd
31009 .endlist
31010
31011
31012
31013 .section "Using DNS lists" "SECTmorednslists"
31014 .cindex "DNS list" "in ACL"
31015 .cindex "black list (DNS)"
31016 .cindex "&ACL;" "testing a DNS list"
31017 In its simplest form, the &%dnslists%& condition tests whether the calling host
31018 is on at least one of a number of DNS lists by looking up the inverted IP
31019 address in one or more DNS domains. (Note that DNS list domains are not mail
31020 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31021 special options instead.) For example, if the calling host's IP
31022 address is 192.168.62.43, and the ACL statement is
31023 .code
31024 deny dnslists = blackholes.mail-abuse.org : \
31025                 dialups.mail-abuse.org
31026 .endd
31027 the following records are looked up:
31028 .code
31029 43.62.168.192.blackholes.mail-abuse.org
31030 43.62.168.192.dialups.mail-abuse.org
31031 .endd
31032 As soon as Exim finds an existing DNS record, processing of the list stops.
31033 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31034 to test that a host is on more than one list (an &"and"& conjunction), you can
31035 use two separate conditions:
31036 .code
31037 deny dnslists = blackholes.mail-abuse.org
31038      dnslists = dialups.mail-abuse.org
31039 .endd
31040 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31041 behaves as if the host does not match the list item, that is, as if the DNS
31042 record does not exist. If there are further items in the DNS list, they are
31043 processed.
31044
31045 This is usually the required action when &%dnslists%& is used with &%deny%&
31046 (which is the most common usage), because it prevents a DNS failure from
31047 blocking mail. However, you can change this behaviour by putting one of the
31048 following special items in the list:
31049 .display
31050 &`+include_unknown `&   behave as if the item is on the list
31051 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31052 &`+defer_unknown   `&   give a temporary error
31053 .endd
31054 .cindex "&`+include_unknown`&"
31055 .cindex "&`+exclude_unknown`&"
31056 .cindex "&`+defer_unknown`&"
31057 Each of these applies to any subsequent items on the list. For example:
31058 .code
31059 deny dnslists = +defer_unknown : foo.bar.example
31060 .endd
31061 Testing the list of domains stops as soon as a match is found. If you want to
31062 warn for one list and block for another, you can use two different statements:
31063 .code
31064 deny  dnslists = blackholes.mail-abuse.org
31065 warn  message  = X-Warn: sending host is on dialups list
31066       dnslists = dialups.mail-abuse.org
31067 .endd
31068 .cindex caching "of dns lookup"
31069 .cindex DNS TTL
31070 DNS list lookups are cached by Exim for the duration of the SMTP session
31071 (but limited by the DNS return TTL value),
31072 so a lookup based on the IP address is done at most once for any incoming
31073 connection (assuming long-enough TTL).
31074 Exim does not share information between multiple incoming
31075 connections (but your local name server cache should be active).
31076
31077 There are a number of DNS lists to choose from, some commercial, some free,
31078 or free for small deployments.  An overview can be found at
31079 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31080
31081
31082
31083 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31084 .cindex "DNS list" "keyed by explicit IP address"
31085 By default, the IP address that is used in a DNS list lookup is the IP address
31086 of the calling host. However, you can specify another IP address by listing it
31087 after the domain name, introduced by a slash. For example:
31088 .code
31089 deny dnslists = black.list.tld/192.168.1.2
31090 .endd
31091 This feature is not very helpful with explicit IP addresses; it is intended for
31092 use with IP addresses that are looked up, for example, the IP addresses of the
31093 MX hosts or nameservers of an email sender address. For an example, see section
31094 &<<SECTmulkeyfor>>& below.
31095
31096
31097
31098
31099 .section "DNS lists keyed on domain names" "SECID202"
31100 .cindex "DNS list" "keyed by domain name"
31101 There are some lists that are keyed on domain names rather than inverted IP
31102 addresses (see, e.g., the &'domain based zones'& link at
31103 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31104 with these lists. You can change the name that is looked up in a DNS list by
31105 listing it after the domain name, introduced by a slash. For example,
31106 .code
31107 deny  message  = Sender's domain is listed at $dnslist_domain
31108       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31109 .endd
31110 This particular example is useful only in ACLs that are obeyed after the
31111 RCPT or DATA commands, when a sender address is available. If (for
31112 example) the message's sender is &'user@tld.example'& the name that is looked
31113 up by this example is
31114 .code
31115 tld.example.dsn.rfc-ignorant.org
31116 .endd
31117 A single &%dnslists%& condition can contain entries for both names and IP
31118 addresses. For example:
31119 .code
31120 deny dnslists = sbl.spamhaus.org : \
31121                 dsn.rfc-ignorant.org/$sender_address_domain
31122 .endd
31123 The first item checks the sending host's IP address; the second checks a domain
31124 name. The whole condition is true if either of the DNS lookups succeeds.
31125
31126
31127
31128
31129 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31130 .cindex "DNS list" "multiple keys for"
31131 The syntax described above for looking up explicitly-defined values (either
31132 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31133 name for the DNS list, what follows the slash can in fact be a list of items.
31134 As with all lists in Exim, the default separator is a colon. However, because
31135 this is a sublist within the list of DNS blacklist domains, it is necessary
31136 either to double the separators like this:
31137 .code
31138 dnslists = black.list.tld/name.1::name.2
31139 .endd
31140 or to change the separator character, like this:
31141 .code
31142 dnslists = black.list.tld/<;name.1;name.2
31143 .endd
31144 If an item in the list is an IP address, it is inverted before the DNS
31145 blacklist domain is appended. If it is not an IP address, no inversion
31146 occurs. Consider this condition:
31147 .code
31148 dnslists = black.list.tld/<;192.168.1.2;a.domain
31149 .endd
31150 The DNS lookups that occur are:
31151 .code
31152 2.1.168.192.black.list.tld
31153 a.domain.black.list.tld
31154 .endd
31155 Once a DNS record has been found (that matches a specific IP return
31156 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31157 are done. If there is a temporary DNS error, the rest of the sublist of domains
31158 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31159 only if no other DNS lookup in this sublist succeeds. In other words, a
31160 successful lookup for any of the items in the sublist overrides a temporary
31161 error for a previous item.
31162
31163 The ability to supply a list of items after the slash is in some sense just a
31164 syntactic convenience. These two examples have the same effect:
31165 .code
31166 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31167 dnslists = black.list.tld/a.domain::b.domain
31168 .endd
31169 However, when the data for the list is obtained from a lookup, the second form
31170 is usually much more convenient. Consider this example:
31171 .code
31172 deny message  = The mail servers for the domain \
31173                 $sender_address_domain \
31174                 are listed at $dnslist_domain ($dnslist_value); \
31175                 see $dnslist_text.
31176      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31177                                    ${lookup dnsdb {>|mxh=\
31178                                    $sender_address_domain} }} }
31179 .endd
31180 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31181 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31182 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31183 of expanding the condition might be something like this:
31184 .code
31185 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31186 .endd
31187 Thus, this example checks whether or not the IP addresses of the sender
31188 domain's mail servers are on the Spamhaus black list.
31189
31190 The key that was used for a successful DNS list lookup is put into the variable
31191 &$dnslist_matched$& (see section &<<SECID204>>&).
31192
31193
31194
31195
31196 .section "Data returned by DNS lists" "SECID203"
31197 .cindex "DNS list" "data returned from"
31198 DNS lists are constructed using address records in the DNS. The original RBL
31199 just used the address 127.0.0.1 on the right hand side of each record, but the
31200 RBL+ list and some other lists use a number of values with different meanings.
31201 The values used on the RBL+ list are:
31202 .display
31203 127.1.0.1  RBL
31204 127.1.0.2  DUL
31205 127.1.0.3  DUL and RBL
31206 127.1.0.4  RSS
31207 127.1.0.5  RSS and RBL
31208 127.1.0.6  RSS and DUL
31209 127.1.0.7  RSS and DUL and RBL
31210 .endd
31211 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31212 different values. Some DNS lists may return more than one address record;
31213 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31214
31215
31216 .section "Variables set from DNS lists" "SECID204"
31217 .cindex "expansion" "variables, set from DNS list"
31218 .cindex "DNS list" "variables set from"
31219 .vindex "&$dnslist_domain$&"
31220 .vindex "&$dnslist_matched$&"
31221 .vindex "&$dnslist_text$&"
31222 .vindex "&$dnslist_value$&"
31223 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31224 the name of the overall domain that matched (for example,
31225 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31226 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31227 the DNS record. When the key is an IP address, it is not reversed in
31228 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31229 cases, for example:
31230 .code
31231 deny dnslists = spamhaus.example
31232 .endd
31233 the key is also available in another variable (in this case,
31234 &$sender_host_address$&). In more complicated cases, however, this is not true.
31235 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31236 might generate a dnslists lookup like this:
31237 .code
31238 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31239 .endd
31240 If this condition succeeds, the value in &$dnslist_matched$& might be
31241 &`192.168.6.7`& (for example).
31242
31243 If more than one address record is returned by the DNS lookup, all the IP
31244 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31245 The variable &$dnslist_text$& contains the contents of any associated TXT
31246 record. For lists such as RBL+ the TXT record for a merged entry is often not
31247 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31248 information.
31249
31250 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31251 &-- although these appear before the condition in the ACL, they are not
31252 expanded until after it has failed. For example:
31253 .code
31254 deny    hosts = !+local_networks
31255         message = $sender_host_address is listed \
31256                   at $dnslist_domain
31257         dnslists = rbl-plus.mail-abuse.example
31258 .endd
31259
31260
31261
31262 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31263 .cindex "DNS list" "matching specific returned data"
31264 You can add an equals sign and an IP address after a &%dnslists%& domain name
31265 in order to restrict its action to DNS records with a matching right hand side.
31266 For example,
31267 .code
31268 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31269 .endd
31270 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31271 any address record is considered to be a match. For the moment, we assume
31272 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31273 describes how multiple records are handled.
31274
31275 More than one IP address may be given for checking, using a comma as a
31276 separator. These are alternatives &-- if any one of them matches, the
31277 &%dnslists%& condition is true. For example:
31278 .code
31279 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31280 .endd
31281 If you want to specify a constraining address list and also specify names or IP
31282 addresses to be looked up, the constraining address list must be specified
31283 first. For example:
31284 .code
31285 deny dnslists = dsn.rfc-ignorant.org\
31286                 =127.0.0.2/$sender_address_domain
31287 .endd
31288
31289 If the character &`&&`& is used instead of &`=`&, the comparison for each
31290 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31291 In other words, the listed addresses are used as bit masks. The comparison is
31292 true if all the bits in the mask are present in the address that is being
31293 tested. For example:
31294 .code
31295 dnslists = a.b.c&0.0.0.3
31296 .endd
31297 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31298 want to test whether one bit or another bit is present (as opposed to both
31299 being present), you must use multiple values. For example:
31300 .code
31301 dnslists = a.b.c&0.0.0.1,0.0.0.2
31302 .endd
31303 matches if the final component of the address is an odd number or two times
31304 an odd number.
31305
31306
31307
31308 .section "Negated DNS matching conditions" "SECID205"
31309 You can supply a negative list of IP addresses as part of a &%dnslists%&
31310 condition. Whereas
31311 .code
31312 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31313 .endd
31314 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31315 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31316 .code
31317 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31318 .endd
31319 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31320 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31321 words, the result of the test is inverted if an exclamation mark appears before
31322 the &`=`& (or the &`&&`&) sign.
31323
31324 &*Note*&: This kind of negation is not the same as negation in a domain,
31325 host, or address list (which is why the syntax is different).
31326
31327 If you are using just one list, the negation syntax does not gain you much. The
31328 previous example is precisely equivalent to
31329 .code
31330 deny  dnslists = a.b.c
31331      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31332 .endd
31333 However, if you are using multiple lists, the negation syntax is clearer.
31334 Consider this example:
31335 .code
31336 deny  dnslists = sbl.spamhaus.org : \
31337                  list.dsbl.org : \
31338                  dnsbl.njabl.org!=127.0.0.3 : \
31339                  relays.ordb.org
31340 .endd
31341 Using only positive lists, this would have to be:
31342 .code
31343 deny  dnslists = sbl.spamhaus.org : \
31344                  list.dsbl.org
31345 deny  dnslists = dnsbl.njabl.org
31346      !dnslists = dnsbl.njabl.org=127.0.0.3
31347 deny  dnslists = relays.ordb.org
31348 .endd
31349 which is less clear, and harder to maintain.
31350
31351
31352
31353
31354 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31355 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31356 thereby providing more than one IP address. When an item in a &%dnslists%& list
31357 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31358 the match to specific results from the DNS lookup, there are two ways in which
31359 the checking can be handled. For example, consider the condition:
31360 .code
31361 dnslists = a.b.c=127.0.0.1
31362 .endd
31363 What happens if the DNS lookup for the incoming IP address yields both
31364 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31365 condition true because at least one given value was found, or is it false
31366 because at least one of the found values was not listed? And how does this
31367 affect negated conditions? Both possibilities are provided for with the help of
31368 additional separators &`==`& and &`=&&`&.
31369
31370 .ilist
31371 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31372 IP addresses matches one of the listed addresses. For the example above, the
31373 condition is true because 127.0.0.1 matches.
31374 .next
31375 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31376 looked up IP addresses matches one of the listed addresses. If the condition is
31377 changed to:
31378 .code
31379 dnslists = a.b.c==127.0.0.1
31380 .endd
31381 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31382 false because 127.0.0.2 is not listed. You would need to have:
31383 .code
31384 dnslists = a.b.c==127.0.0.1,127.0.0.2
31385 .endd
31386 for the condition to be true.
31387 .endlist
31388
31389 When &`!`& is used to negate IP address matching, it inverts the result, giving
31390 the precise opposite of the behaviour above. Thus:
31391 .ilist
31392 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31393 addresses matches one of the listed addresses. Consider:
31394 .code
31395 dnslists = a.b.c!&0.0.0.1
31396 .endd
31397 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31398 false because 127.0.0.1 matches.
31399 .next
31400 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31401 looked up IP address that does not match. Consider:
31402 .code
31403 dnslists = a.b.c!=&0.0.0.1
31404 .endd
31405 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31406 true, because 127.0.0.2 does not match. You would need to have:
31407 .code
31408 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31409 .endd
31410 for the condition to be false.
31411 .endlist
31412 When the DNS lookup yields only a single IP address, there is no difference
31413 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31414
31415
31416
31417
31418 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31419 .cindex "DNS list" "information from merged"
31420 When the facility for restricting the matching IP values in a DNS list is used,
31421 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31422 the true reason for rejection. This happens when lists are merged and the IP
31423 address in the A record is used to distinguish them; unfortunately there is
31424 only one TXT record. One way round this is not to use merged lists, but that
31425 can be inefficient because it requires multiple DNS lookups where one would do
31426 in the vast majority of cases when the host of interest is not on any of the
31427 lists.
31428
31429 A less inefficient way of solving this problem is available. If
31430 two domain names, comma-separated, are given, the second is used first to
31431 do an initial check, making use of any IP value restrictions that are set.
31432 If there is a match, the first domain is used, without any IP value
31433 restrictions, to get the TXT record. As a byproduct of this, there is also
31434 a check that the IP being tested is indeed on the first list. The first
31435 domain is the one that is put in &$dnslist_domain$&. For example:
31436 .code
31437 deny message  = \
31438          rejected because $sender_host_address is blacklisted \
31439          at $dnslist_domain\n$dnslist_text
31440        dnslists = \
31441          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31442          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31443 .endd
31444 For the first blacklist item, this starts by doing a lookup in
31445 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31446 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31447 value, and as long as something is found, it looks for the corresponding TXT
31448 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31449 The second blacklist item is processed similarly.
31450
31451 If you are interested in more than one merged list, the same list must be
31452 given several times, but because the results of the DNS lookups are cached,
31453 the DNS calls themselves are not repeated. For example:
31454 .code
31455 deny dnslists = \
31456          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31457          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31458          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31459          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31460 .endd
31461 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31462 values matches (or if no record is found), this is the only lookup that is
31463 done. Only if there is a match is one of the more specific lists consulted.
31464
31465
31466
31467 .section "DNS lists and IPv6" "SECTmorednslistslast"
31468 .cindex "IPv6" "DNS black lists"
31469 .cindex "DNS list" "IPv6 usage"
31470 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31471 nibble by nibble. For example, if the calling host's IP address is
31472 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31473 .code
31474 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31475   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31476 .endd
31477 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31478 lists contain wildcard records, intended for IPv4, that interact badly with
31479 IPv6. For example, the DNS entry
31480 .code
31481 *.3.some.list.example.    A    127.0.0.1
31482 .endd
31483 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31484 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31485
31486 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31487 &%condition%& condition, as in this example:
31488 .code
31489 deny   condition = ${if isip4{$sender_host_address}}
31490        dnslists  = some.list.example
31491 .endd
31492
31493 If an explicit key is being used for a DNS lookup and it may be an IPv6
31494 address you should specify alternate list separators for both the outer
31495 (DNS list name) list and inner (lookup keys) list:
31496 .code
31497        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31498 .endd
31499
31500 .section "Rate limiting incoming messages" "SECTratelimiting"
31501 .cindex "rate limiting" "client sending"
31502 .cindex "limiting client sending rates"
31503 .oindex "&%smtp_ratelimit_*%&"
31504 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31505 which clients can send email. This is more powerful than the
31506 &%smtp_ratelimit_*%& options, because those options control the rate of
31507 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31508 works across all connections (concurrent and sequential) from the same client
31509 host. The syntax of the &%ratelimit%& condition is:
31510 .display
31511 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31512 .endd
31513 If the average client sending rate is less than &'m'& messages per time
31514 period &'p'& then the condition is false; otherwise it is true.
31515
31516 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31517 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31518 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31519 of &'p'&.
31520
31521 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31522 time interval, for example, &`8h`& for eight hours. A larger time constant
31523 means that it takes Exim longer to forget a client's past behaviour. The
31524 parameter &'m'& is the maximum number of messages that a client is permitted to
31525 send in each time interval. It also specifies the number of messages permitted
31526 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31527 constant, you can allow a client to send more messages in a burst without
31528 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31529 both small, messages must be sent at an even rate.
31530
31531 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31532 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31533 when deploying the &%ratelimit%& ACL condition. The script prints usage
31534 instructions when it is run with no arguments.
31535
31536 The key is used to look up the data for calculating the client's average
31537 sending rate. This data is stored in Exim's spool directory, alongside the
31538 retry and other hints databases. The default key is &$sender_host_address$&,
31539 which means Exim computes the sending rate of each client host IP address.
31540 By changing the key you can change how Exim identifies clients for the purpose
31541 of ratelimiting. For example, to limit the sending rate of each authenticated
31542 user, independent of the computer they are sending from, set the key to
31543 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31544 example, &$authenticated_id$& is only meaningful if the client has
31545 authenticated (which you can check with the &%authenticated%& ACL condition).
31546
31547 The lookup key does not have to identify clients: If you want to limit the
31548 rate at which a recipient receives messages, you can use the key
31549 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31550 ACL.
31551
31552 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31553 specifies what Exim measures the rate of, for example, messages or recipients
31554 or bytes. You can adjust the measurement using the &%unique=%& and/or
31555 &%count=%& options. You can also control when Exim updates the recorded rate
31556 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31557 separated by a slash, like the other parameters. They may appear in any order.
31558
31559 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31560 any options that alter the meaning of the stored data. The limit &'m'& is not
31561 stored, so you can alter the configured maximum rate and Exim will still
31562 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31563 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31564 behaviour. The lookup key is not affected by changes to the update mode and
31565 the &%count=%& option.
31566
31567
31568 .section "Ratelimit options for what is being measured" "ratoptmea"
31569 .cindex "rate limiting" "per_* options"
31570 The &%per_conn%& option limits the client's connection rate. It is not
31571 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31572 &%acl_not_smtp_start%& ACLs.
31573
31574 The &%per_mail%& option limits the client's rate of sending messages. This is
31575 the default if none of the &%per_*%& options is specified. It can be used in
31576 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31577 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31578
31579 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31580 the same ACLs as the &%per_mail%& option, though it is best to use this option
31581 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31582 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31583 in its MAIL command, which may be inaccurate or completely missing. You can
31584 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31585 in kilobytes, megabytes, or gigabytes, respectively.
31586
31587 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31588 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31589 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31590 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31591 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31592 in either case the rate limiting engine will see a message with many
31593 recipients as a large high-speed burst.
31594
31595 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31596 number of different recipients that the client has sent messages to in the
31597 last time period. That is, if the client repeatedly sends messages to the same
31598 recipient, its measured rate is not increased. This option can only be used in
31599 &%acl_smtp_rcpt%&.
31600
31601 The &%per_cmd%& option causes Exim to recompute the rate every time the
31602 condition is processed. This can be used to limit the rate of any SMTP
31603 command. If it is used in multiple ACLs it can limit the aggregate rate of
31604 multiple different commands.
31605
31606 The &%count=%& option can be used to alter how much Exim adds to the client's
31607 measured rate. For example, the &%per_byte%& option is equivalent to
31608 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31609 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31610 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31611
31612 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31613
31614
31615 .section "Ratelimit update modes" "ratoptupd"
31616 .cindex "rate limiting" "reading data without updating"
31617 You can specify one of three options with the &%ratelimit%& condition to
31618 control when its database is updated. This section describes the &%readonly%&
31619 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31620
31621 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31622 previously-computed rate to check against the limit.
31623
31624 For example, you can test the client's sending rate and deny it access (when
31625 it is too fast) in the connect ACL. If the client passes this check then it
31626 can go on to send a message, in which case its recorded rate will be updated
31627 in the MAIL ACL. Subsequent connections from the same client will check this
31628 new rate.
31629 .code
31630 acl_check_connect:
31631  deny ratelimit = 100 / 5m / readonly
31632     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31633                   (max $sender_rate_limit)
31634 # ...
31635 acl_check_mail:
31636  warn ratelimit = 100 / 5m / strict
31637     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31638                   (max $sender_rate_limit)
31639 .endd
31640
31641 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31642 processing a message then it may increase the client's measured rate more than
31643 it should. For example, this will happen if you check the &%per_rcpt%& option
31644 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31645 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31646 multiple update problems by using the &%readonly%& option on later ratelimit
31647 checks.
31648
31649 The &%per_*%& options described above do not make sense in some ACLs. If you
31650 use a &%per_*%& option in an ACL where it is not normally permitted then the
31651 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31652 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31653 next section) so you must specify the &%readonly%& option explicitly.
31654
31655
31656 .section "Ratelimit options for handling fast clients" "ratoptfast"
31657 .cindex "rate limiting" "strict and leaky modes"
31658 If a client's average rate is greater than the maximum, the rate limiting
31659 engine can react in two possible ways, depending on the presence of the
31660 &%strict%& or &%leaky%& update modes. This is independent of the other
31661 counter-measures (such as rejecting the message) that may be specified by the
31662 rest of the ACL.
31663
31664 The &%leaky%& (default) option means that the client's recorded rate is not
31665 updated if it is above the limit. The effect of this is that Exim measures the
31666 client's average rate of successfully sent email,
31667 up to the given limit.
31668 This is appropriate if the countermeasure when the condition is true
31669 consists of refusing the message, and
31670 is generally the better choice if you have clients that retry automatically.
31671 If the action when true is anything more complex then this option is
31672 likely not what is wanted.
31673
31674 The &%strict%& option means that the client's recorded rate is always
31675 updated. The effect of this is that Exim measures the client's average rate
31676 of attempts to send email, which can be much higher than the maximum it is
31677 actually allowed. If the client is over the limit it may be subjected to
31678 counter-measures by the ACL. It must slow down and allow sufficient time to
31679 pass that its computed rate falls below the maximum before it can send email
31680 again. The time (the number of smoothing periods) it must wait and not
31681 attempt to send mail can be calculated with this formula:
31682 .code
31683         ln(peakrate/maxrate)
31684 .endd
31685
31686
31687 .section "Limiting the rate of different events" "ratoptuniq"
31688 .cindex "rate limiting" "counting unique events"
31689 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31690 rate of different events. For example, the &%per_addr%& option uses this
31691 mechanism to count the number of different recipients that the client has
31692 sent messages to in the last time period; it is equivalent to
31693 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31694 measure the rate that a client uses different sender addresses with the
31695 options &`per_mail/unique=$sender_address`&.
31696
31697 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31698 has seen for that key. The whole set is thrown away when it is older than the
31699 rate smoothing period &'p'&, so each different event is counted at most once
31700 per period. In the &%leaky%& update mode, an event that causes the client to
31701 go over the limit is not added to the set, in the same way that the client's
31702 recorded rate is not updated in the same situation.
31703
31704 When you combine the &%unique=%& and &%readonly%& options, the specific
31705 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31706 rate.
31707
31708 The &%unique=%& mechanism needs more space in the ratelimit database than the
31709 other &%ratelimit%& options in order to store the event set. The number of
31710 unique values is potentially as large as the rate limit, so the extra space
31711 required increases with larger limits.
31712
31713 The uniqueification is not perfect: there is a small probability that Exim
31714 will think a new event has happened before. If the sender's rate is less than
31715 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31716 the measured rate can go above the limit, in which case Exim may under-count
31717 events by a significant margin. Fortunately, if the rate is high enough (2.7
31718 times the limit) that the false positive rate goes above 9%, then Exim will
31719 throw away the over-full event set before the measured rate falls below the
31720 limit. Therefore the only harm should be that exceptionally high sending rates
31721 are logged incorrectly; any countermeasures you configure will be as effective
31722 as intended.
31723
31724
31725 .section "Using rate limiting" "useratlim"
31726 Exim's other ACL facilities are used to define what counter-measures are taken
31727 when the rate limit is exceeded. This might be anything from logging a warning
31728 (for example, while measuring existing sending rates in order to define
31729 policy), through time delays to slow down fast senders, up to rejecting the
31730 message. For example:
31731 .code
31732 # Log all senders' rates
31733 warn ratelimit = 0 / 1h / strict
31734      log_message = Sender rate $sender_rate / $sender_rate_period
31735
31736 # Slow down fast senders; note the need to truncate $sender_rate
31737 # at the decimal point.
31738 warn ratelimit = 100 / 1h / per_rcpt / strict
31739      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31740                    $sender_rate_limit }s
31741
31742 # Keep authenticated users under control
31743 deny authenticated = *
31744      ratelimit = 100 / 1d / strict / $authenticated_id
31745
31746 # System-wide rate limit
31747 defer message = Sorry, too busy. Try again later.
31748      ratelimit = 10 / 1s / $primary_hostname
31749
31750 # Restrict incoming rate from each host, with a default
31751 # set using a macro and special cases looked up in a table.
31752 defer message = Sender rate exceeds $sender_rate_limit \
31753                messages per $sender_rate_period
31754      ratelimit = ${lookup {$sender_host_address} \
31755                    cdb {DB/ratelimits.cdb} \
31756                    {$value} {RATELIMIT} }
31757 .endd
31758 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31759 especially with the &%per_rcpt%& option, you may suffer from a performance
31760 bottleneck caused by locking on the ratelimit hints database. Apart from
31761 making your ACLs less complicated, you can reduce the problem by using a
31762 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31763 this means that Exim will lose its hints data after a reboot (including retry
31764 hints, the callout cache, and ratelimit data).
31765
31766
31767
31768 .section "Address verification" "SECTaddressverification"
31769 .cindex "verifying address" "options for"
31770 .cindex "policy control" "address verification"
31771 Several of the &%verify%& conditions described in section
31772 &<<SECTaclconditions>>& cause addresses to be verified. Section
31773 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31774 The verification conditions can be followed by options that modify the
31775 verification process. The options are separated from the keyword and from each
31776 other by slashes, and some of them contain parameters. For example:
31777 .code
31778 verify = sender/callout
31779 verify = recipient/defer_ok/callout=10s,defer_ok
31780 .endd
31781 The first stage of address verification, which always happens, is to run the
31782 address through the routers, in &"verify mode"&. Routers can detect the
31783 difference between verification and routing for delivery, and their actions can
31784 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31785 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31786 The available options are as follows:
31787
31788 .ilist
31789 If the &%callout%& option is specified, successful routing to one or more
31790 remote hosts is followed by a &"callout"& to those hosts as an additional
31791 check. Callouts and their sub-options are discussed in the next section.
31792 .next
31793 If there is a defer error while doing verification routing, the ACL
31794 normally returns &"defer"&. However, if you include &%defer_ok%& in the
31795 options, the condition is forced to be true instead. Note that this is a main
31796 verification option as well as a suboption for callouts.
31797 .next
31798 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
31799 discusses the reporting of sender address verification failures.
31800 .next
31801 The &%success_on_redirect%& option causes verification always to succeed
31802 immediately after a successful redirection. By default, if a redirection
31803 generates just one address, that address is also verified. See further
31804 discussion in section &<<SECTredirwhilveri>>&.
31805 .endlist
31806
31807 .cindex "verifying address" "differentiating failures"
31808 .vindex "&$recipient_verify_failure$&"
31809 .vindex "&$sender_verify_failure$&"
31810 .vindex "&$acl_verify_message$&"
31811 After an address verification failure, &$acl_verify_message$& contains the
31812 error message that is associated with the failure. It can be preserved by
31813 coding like this:
31814 .code
31815 warn  !verify = sender
31816        set acl_m0 = $acl_verify_message
31817 .endd
31818 If you are writing your own custom rejection message or log message when
31819 denying access, you can use this variable to include information about the
31820 verification failure.
31821
31822 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
31823 appropriate) contains one of the following words:
31824
31825 .ilist
31826 &%qualify%&: The address was unqualified (no domain), and the message
31827 was neither local nor came from an exempted host.
31828 .next
31829 &%route%&: Routing failed.
31830 .next
31831 &%mail%&: Routing succeeded, and a callout was attempted; rejection
31832 occurred at or before the MAIL command (that is, on initial
31833 connection, HELO, or MAIL).
31834 .next
31835 &%recipient%&: The RCPT command in a callout was rejected.
31836 .next
31837 &%postmaster%&: The postmaster check in a callout was rejected.
31838 .endlist
31839
31840 The main use of these variables is expected to be to distinguish between
31841 rejections of MAIL and rejections of RCPT in callouts.
31842
31843 The above variables may also be set after a &*successful*&
31844 address verification to:
31845
31846 .ilist
31847 &%random%&: A random local-part callout succeeded
31848 .endlist
31849
31850
31851
31852
31853 .section "Callout verification" "SECTcallver"
31854 .cindex "verifying address" "by callout"
31855 .cindex "callout" "verification"
31856 .cindex "SMTP" "callout verification"
31857 For non-local addresses, routing verifies the domain, but is unable to do any
31858 checking of the local part. There are situations where some means of verifying
31859 the local part is desirable. One way this can be done is to make an SMTP
31860 &'callback'& to a delivery host for the sender address or a &'callforward'& to
31861 a subsequent host for a recipient address, to see if the host accepts the
31862 address. We use the term &'callout'& to cover both cases. Note that for a
31863 sender address, the callback is not to the client host that is trying to
31864 deliver the message, but to one of the hosts that accepts incoming mail for the
31865 sender's domain.
31866
31867 Exim does not do callouts by default. If you want them to happen, you must
31868 request them by setting appropriate options on the &%verify%& condition, as
31869 described below. This facility should be used with care, because it can add a
31870 lot of resource usage to the cost of verifying an address. However, Exim does
31871 cache the results of callouts, which helps to reduce the cost. Details of
31872 caching are in section &<<SECTcallvercache>>&.
31873
31874 Recipient callouts are usually used only between hosts that are controlled by
31875 the same administration. For example, a corporate gateway host could use
31876 callouts to check for valid recipients on an internal mailserver. A successful
31877 callout does not guarantee that a real delivery to the address would succeed;
31878 on the other hand, a failing callout does guarantee that a delivery would fail.
31879
31880 If the &%callout%& option is present on a condition that verifies an address, a
31881 second stage of verification occurs if the address is successfully routed to
31882 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
31883 &(manualroute)& router, where the router specifies the hosts. However, if a
31884 router that does not set up hosts routes to an &(smtp)& transport with a
31885 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
31886 &%hosts_override%& set, its hosts are always used, whether or not the router
31887 supplies a host list.
31888 Callouts are only supported on &(smtp)& transports.
31889
31890 The port that is used is taken from the transport, if it is specified and is a
31891 remote transport. (For routers that do verification only, no transport need be
31892 specified.) Otherwise, the default SMTP port is used. If a remote transport
31893 specifies an outgoing interface, this is used; otherwise the interface is not
31894 specified. Likewise, the text that is used for the HELO command is taken from
31895 the transport's &%helo_data%& option; if there is no transport, the value of
31896 &$smtp_active_hostname$& is used.
31897
31898 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
31899 test whether a bounce message could be delivered to the sender address. The
31900 following SMTP commands are sent:
31901 .display
31902 &`HELO `&<&'local host name'&>
31903 &`MAIL FROM:<>`&
31904 &`RCPT TO:`&<&'the address to be tested'&>
31905 &`QUIT`&
31906 .endd
31907 LHLO is used instead of HELO if the transport's &%protocol%& option is
31908 set to &"lmtp"&.
31909
31910 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
31911 settings.
31912
31913 A recipient callout check is similar. By default, it also uses an empty address
31914 for the sender. This default is chosen because most hosts do not make use of
31915 the sender address when verifying a recipient. Using the same address means
31916 that a single cache entry can be used for each recipient. Some sites, however,
31917 do make use of the sender address when verifying. These are catered for by the
31918 &%use_sender%& and &%use_postmaster%& options, described in the next section.
31919
31920 If the response to the RCPT command is a 2&'xx'& code, the verification
31921 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
31922 Exim tries the next host, if any. If there is a problem with all the remote
31923 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
31924 &%callout%& option is given, in which case the condition is forced to succeed.
31925
31926 .cindex "SMTP" "output flushing, disabling for callout"
31927 A callout may take a little time. For this reason, Exim normally flushes SMTP
31928 output before performing a callout in an ACL, to avoid unexpected timeouts in
31929 clients when the SMTP PIPELINING extension is in use. The flushing can be
31930 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
31931
31932
31933
31934
31935 .section "Additional parameters for callouts" "CALLaddparcall"
31936 .cindex "callout" "additional parameters for"
31937 The &%callout%& option can be followed by an equals sign and a number of
31938 optional parameters, separated by commas. For example:
31939 .code
31940 verify = recipient/callout=10s,defer_ok
31941 .endd
31942 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
31943 separate verify options, is retained for backwards compatibility, but is now
31944 deprecated. The additional parameters for &%callout%& are as follows:
31945
31946
31947 .vlist
31948 .vitem <&'a&~time&~interval'&>
31949 .cindex "callout" "timeout, specifying"
31950 This specifies the timeout that applies for the callout attempt to each host.
31951 For example:
31952 .code
31953 verify = sender/callout=5s
31954 .endd
31955 The default is 30 seconds. The timeout is used for each response from the
31956 remote host. It is also used for the initial connection, unless overridden by
31957 the &%connect%& parameter.
31958
31959
31960 .vitem &*connect&~=&~*&<&'time&~interval'&>
31961 .cindex "callout" "connection timeout, specifying"
31962 This parameter makes it possible to set a different (usually smaller) timeout
31963 for making the SMTP connection. For example:
31964 .code
31965 verify = sender/callout=5s,connect=1s
31966 .endd
31967 If not specified, this timeout defaults to the general timeout value.
31968
31969 .vitem &*defer_ok*&
31970 .cindex "callout" "defer, action on"
31971 When this parameter is present, failure to contact any host, or any other kind
31972 of temporary error, is treated as success by the ACL. However, the cache is not
31973 updated in this circumstance.
31974
31975 .vitem &*fullpostmaster*&
31976 .cindex "callout" "full postmaster check"
31977 This operates like the &%postmaster%& option (see below), but if the check for
31978 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
31979 accordance with the specification in RFC 2821. The RFC states that the
31980 unqualified address &'postmaster'& should be accepted.
31981
31982
31983 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
31984 .cindex "callout" "sender when verifying header"
31985 When verifying addresses in header lines using the &%header_sender%&
31986 verification option, Exim behaves by default as if the addresses are envelope
31987 sender addresses from a message. Callout verification therefore tests to see
31988 whether a bounce message could be delivered, by using an empty address in the
31989 MAIL command. However, it is arguable that these addresses might never be used
31990 as envelope senders, and could therefore justifiably reject bounce messages
31991 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
31992 address to use in the MAIL command. For example:
31993 .code
31994 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
31995 .endd
31996 This parameter is available only for the &%header_sender%& verification option.
31997
31998
31999 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32000 .cindex "callout" "overall timeout, specifying"
32001 This parameter sets an overall timeout for performing a callout verification.
32002 For example:
32003 .code
32004 verify = sender/callout=5s,maxwait=30s
32005 .endd
32006 This timeout defaults to four times the callout timeout for individual SMTP
32007 commands. The overall timeout applies when there is more than one host that can
32008 be tried. The timeout is checked before trying the next host. This prevents
32009 very long delays if there are a large number of hosts and all are timing out
32010 (for example, when network connections are timing out).
32011
32012
32013 .vitem &*no_cache*&
32014 .cindex "callout" "cache, suppressing"
32015 .cindex "caching callout, suppressing"
32016 When this parameter is given, the callout cache is neither read nor updated.
32017
32018 .vitem &*postmaster*&
32019 .cindex "callout" "postmaster; checking"
32020 When this parameter is set, a successful callout check is followed by a similar
32021 check for the local part &'postmaster'& at the same domain. If this address is
32022 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32023 the postmaster check is recorded in a cache record; if it is a failure, this is
32024 used to fail subsequent callouts for the domain without a connection being
32025 made, until the cache record expires.
32026
32027 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32028 The postmaster check uses an empty sender in the MAIL command by default.
32029 You can use this parameter to do a postmaster check using a different address.
32030 For example:
32031 .code
32032 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32033 .endd
32034 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32035 one overrides. The &%postmaster%& parameter is equivalent to this example:
32036 .code
32037 require  verify = sender/callout=postmaster_mailfrom=
32038 .endd
32039 &*Warning*&: The caching arrangements for postmaster checking do not take
32040 account of the sender address. It is assumed that either the empty address or
32041 a fixed non-empty address will be used. All that Exim remembers is that the
32042 postmaster check for the domain succeeded or failed.
32043
32044
32045 .vitem &*random*&
32046 .cindex "callout" "&""random""& check"
32047 When this parameter is set, before doing the normal callout check, Exim does a
32048 check for a &"random"& local part at the same domain. The local part is not
32049 really random &-- it is defined by the expansion of the option
32050 &%callout_random_local_part%&, which defaults to
32051 .code
32052 $primary_hostname-$tod_epoch-testing
32053 .endd
32054 The idea here is to try to determine whether the remote host accepts all local
32055 parts without checking. If it does, there is no point in doing callouts for
32056 specific local parts. If the &"random"& check succeeds, the result is saved in
32057 a cache record, and used to force the current and subsequent callout checks to
32058 succeed without a connection being made, until the cache record expires.
32059
32060 .vitem &*use_postmaster*&
32061 .cindex "callout" "sender for recipient check"
32062 This parameter applies to recipient callouts only. For example:
32063 .code
32064 deny  !verify = recipient/callout=use_postmaster
32065 .endd
32066 .vindex "&$qualify_domain$&"
32067 It causes a non-empty postmaster address to be used in the MAIL command when
32068 performing the callout for the recipient, and also for a &"random"& check if
32069 that is configured. The local part of the address is &`postmaster`& and the
32070 domain is the contents of &$qualify_domain$&.
32071
32072 .vitem &*use_sender*&
32073 This option applies to recipient callouts only. For example:
32074 .code
32075 require  verify = recipient/callout=use_sender
32076 .endd
32077 It causes the message's actual sender address to be used in the MAIL
32078 command when performing the callout, instead of an empty address. There is no
32079 need to use this option unless you know that the called hosts make use of the
32080 sender when checking recipients. If used indiscriminately, it reduces the
32081 usefulness of callout caching.
32082
32083 .vitem &*hold*&
32084 This option applies to recipient callouts only. For example:
32085 .code
32086 require  verify = recipient/callout=use_sender,hold
32087 .endd
32088 It causes the connection to be held open and used for any further recipients
32089 and for eventual delivery (should that be done quickly).
32090 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32091 when that is used for the connections.
32092 The advantage is only gained if there are no callout cache hits
32093 (which could be enforced by the no_cache option),
32094 if the use_sender option is used,
32095 if neither the random nor the use_postmaster option is used,
32096 and if no other callouts intervene.
32097 .endlist
32098
32099 If you use any of the parameters that set a non-empty sender for the MAIL
32100 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32101 &%use_sender%&), you should think about possible loops. Recipient checking is
32102 usually done between two hosts that are under the same management, and the host
32103 that receives the callouts is not normally configured to do callouts itself.
32104 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32105 these circumstances.
32106
32107 However, if you use a non-empty sender address for a callout to an arbitrary
32108 host, there is the likelihood that the remote host will itself initiate a
32109 callout check back to your host. As it is checking what appears to be a message
32110 sender, it is likely to use an empty address in MAIL, thus avoiding a
32111 callout loop. However, to be on the safe side it would be best to set up your
32112 own ACLs so that they do not do sender verification checks when the recipient
32113 is the address you use for header sender or postmaster callout checking.
32114
32115 Another issue to think about when using non-empty senders for callouts is
32116 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32117 by the sender/recipient combination; thus, for any given recipient, many more
32118 actual callouts are performed than when an empty sender or postmaster is used.
32119
32120
32121
32122
32123 .section "Callout caching" "SECTcallvercache"
32124 .cindex "hints database" "callout cache"
32125 .cindex "callout" "cache, description of"
32126 .cindex "caching" "callout"
32127 Exim caches the results of callouts in order to reduce the amount of resources
32128 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32129 option. A hints database called &"callout"& is used for the cache. Two
32130 different record types are used: one records the result of a callout check for
32131 a specific address, and the other records information that applies to the
32132 entire domain (for example, that it accepts the local part &'postmaster'&).
32133
32134 When an original callout fails, a detailed SMTP error message is given about
32135 the failure. However, for subsequent failures use the cache data, this message
32136 is not available.
32137
32138 The expiry times for negative and positive address cache records are
32139 independent, and can be set by the global options &%callout_negative_expire%&
32140 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32141
32142 If a host gives a negative response to an SMTP connection, or rejects any
32143 commands up to and including
32144 .code
32145 MAIL FROM:<>
32146 .endd
32147 (but not including the MAIL command with a non-empty address),
32148 any callout attempt is bound to fail. Exim remembers such failures in a
32149 domain cache record, which it uses to fail callouts for the domain without
32150 making new connections, until the domain record times out. There are two
32151 separate expiry times for domain cache records:
32152 &%callout_domain_negative_expire%& (default 3h) and
32153 &%callout_domain_positive_expire%& (default 7d).
32154
32155 Domain records expire when the negative expiry time is reached if callouts
32156 cannot be made for the domain, or if the postmaster check failed.
32157 Otherwise, they expire when the positive expiry time is reached. This
32158 ensures that, for example, a host that stops accepting &"random"& local parts
32159 will eventually be noticed.
32160
32161 The callout caching mechanism is based on the domain of the address that is
32162 being tested. If the domain routes to several hosts, it is assumed that their
32163 behaviour will be the same.
32164
32165
32166
32167 .section "Sender address verification reporting" "SECTsenaddver"
32168 .cindex "verifying" "suppressing error details"
32169 See section &<<SECTaddressverification>>& for a general discussion of
32170 verification. When sender verification fails in an ACL, the details of the
32171 failure are given as additional output lines before the 550 response to the
32172 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32173 you might see:
32174 .code
32175 MAIL FROM:<xyz@abc.example>
32176 250 OK
32177 RCPT TO:<pqr@def.example>
32178 550-Verification failed for <xyz@abc.example>
32179 550-Called:   192.168.34.43
32180 550-Sent:     RCPT TO:<xyz@abc.example>
32181 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32182 550 Sender verification failed
32183 .endd
32184 If more than one RCPT command fails in the same way, the details are given
32185 only for the first of them. However, some administrators do not want to send
32186 out this much information. You can suppress the details by adding
32187 &`/no_details`& to the ACL statement that requests sender verification. For
32188 example:
32189 .code
32190 verify = sender/no_details
32191 .endd
32192
32193 .section "Redirection while verifying" "SECTredirwhilveri"
32194 .cindex "verifying" "redirection while"
32195 .cindex "address redirection" "while verifying"
32196 A dilemma arises when a local address is redirected by aliasing or forwarding
32197 during verification: should the generated addresses themselves be verified,
32198 or should the successful expansion of the original address be enough to verify
32199 it? By default, Exim takes the following pragmatic approach:
32200
32201 .ilist
32202 When an incoming address is redirected to just one child address, verification
32203 continues with the child address, and if that fails to verify, the original
32204 verification also fails.
32205 .next
32206 When an incoming address is redirected to more than one child address,
32207 verification does not continue. A success result is returned.
32208 .endlist
32209
32210 This seems the most reasonable behaviour for the common use of aliasing as a
32211 way of redirecting different local parts to the same mailbox. It means, for
32212 example, that a pair of alias entries of the form
32213 .code
32214 A.Wol:   aw123
32215 aw123:   :fail: Gone away, no forwarding address
32216 .endd
32217 work as expected, with both local parts causing verification failure. When a
32218 redirection generates more than one address, the behaviour is more like a
32219 mailing list, where the existence of the alias itself is sufficient for
32220 verification to succeed.
32221
32222 It is possible, however, to change the default behaviour so that all successful
32223 redirections count as successful verifications, however many new addresses are
32224 generated. This is specified by the &%success_on_redirect%& verification
32225 option. For example:
32226 .code
32227 require verify = recipient/success_on_redirect/callout=10s
32228 .endd
32229 In this example, verification succeeds if a router generates a new address, and
32230 the callout does not occur, because no address was routed to a remote host.
32231
32232 When verification is being tested via the &%-bv%& option, the treatment of
32233 redirections is as just described, unless the &%-v%& or any debugging option is
32234 also specified. In that case, full verification is done for every generated
32235 address and a report is output for each of them.
32236
32237
32238
32239 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32240 .cindex "CSA" "verifying"
32241 Client SMTP Authorization is a system that allows a site to advertise
32242 which machines are and are not permitted to send email. This is done by placing
32243 special SRV records in the DNS; these are looked up using the client's HELO
32244 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32245 Authorization checks in Exim are performed by the ACL condition:
32246 .code
32247 verify = csa
32248 .endd
32249 This fails if the client is not authorized. If there is a DNS problem, or if no
32250 valid CSA SRV record is found, or if the client is authorized, the condition
32251 succeeds. These three cases can be distinguished using the expansion variable
32252 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32253 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32254 be likely to cause problems for legitimate email.
32255
32256 The error messages produced by the CSA code include slightly more
32257 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32258 looking up the CSA SRV record, or problems looking up the CSA target
32259 address record. There are four reasons for &$csa_status$& being &"fail"&:
32260
32261 .ilist
32262 The client's host name is explicitly not authorized.
32263 .next
32264 The client's IP address does not match any of the CSA target IP addresses.
32265 .next
32266 The client's host name is authorized but it has no valid target IP addresses
32267 (for example, the target's addresses are IPv6 and the client is using IPv4).
32268 .next
32269 The client's host name has no CSA SRV record but a parent domain has asserted
32270 that all subdomains must be explicitly authorized.
32271 .endlist
32272
32273 The &%csa%& verification condition can take an argument which is the domain to
32274 use for the DNS query. The default is:
32275 .code
32276 verify = csa/$sender_helo_name
32277 .endd
32278 This implementation includes an extension to CSA. If the query domain
32279 is an address literal such as [192.0.2.95], or if it is a bare IP
32280 address, Exim searches for CSA SRV records in the reverse DNS as if
32281 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32282 meaningful to say:
32283 .code
32284 verify = csa/$sender_host_address
32285 .endd
32286 In fact, this is the check that Exim performs if the client does not say HELO.
32287 This extension can be turned off by setting the main configuration option
32288 &%dns_csa_use_reverse%& to be false.
32289
32290 If a CSA SRV record is not found for the domain itself, a search
32291 is performed through its parent domains for a record which might be
32292 making assertions about subdomains. The maximum depth of this search is limited
32293 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32294 default. Exim does not look for CSA SRV records in a top level domain, so the
32295 default settings handle HELO domains as long as seven
32296 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32297 of legitimate HELO domains.
32298
32299 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32300 direct SRV lookups, this is not sufficient because of the extra parent domain
32301 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32302 addresses into lookups in the reverse DNS space. The result of a successful
32303 lookup such as:
32304 .code
32305 ${lookup dnsdb {csa=$sender_helo_name}}
32306 .endd
32307 has two space-separated fields: an authorization code and a target host name.
32308 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32309 authorization required but absent, or &"?"& for unknown.
32310
32311
32312
32313
32314 .section "Bounce address tag validation" "SECTverifyPRVS"
32315 .cindex "BATV, verifying"
32316 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32317 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32318 Genuine incoming bounce messages should therefore always be addressed to
32319 recipients that have a valid tag. This scheme is a way of detecting unwanted
32320 bounce messages caused by sender address forgeries (often called &"collateral
32321 spam"&), because the recipients of such messages do not include valid tags.
32322
32323 There are two expansion items to help with the implementation of the BATV
32324 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32325 the original envelope sender address by using a simple key to add a hash of the
32326 address and some time-based randomizing information. The &%prvs%& expansion
32327 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32328 The syntax of these expansion items is described in section
32329 &<<SECTexpansionitems>>&.
32330 The validity period on signed addresses is seven days.
32331
32332 As an example, suppose the secret per-address keys are stored in an MySQL
32333 database. A query to look up the key for an address could be defined as a macro
32334 like this:
32335 .code
32336 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32337                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32338                 }{$value}}
32339 .endd
32340 Suppose also that the senders who make use of BATV are defined by an address
32341 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32342 use this:
32343 .code
32344 # Bounces: drop unsigned addresses for BATV senders
32345 deny message = This address does not send an unsigned reverse path
32346      senders = :
32347      recipients = +batv_senders
32348
32349 # Bounces: In case of prvs-signed address, check signature.
32350 deny message = Invalid reverse path signature.
32351      senders = :
32352      condition  = ${prvscheck {$local_part@$domain}\
32353                   {PRVSCHECK_SQL}{1}}
32354      !condition = $prvscheck_result
32355 .endd
32356 The first statement rejects recipients for bounce messages that are addressed
32357 to plain BATV sender addresses, because it is known that BATV senders do not
32358 send out messages with plain sender addresses. The second statement rejects
32359 recipients that are prvs-signed, but with invalid signatures (either because
32360 the key is wrong, or the signature has timed out).
32361
32362 A non-prvs-signed address is not rejected by the second statement, because the
32363 &%prvscheck%& expansion yields an empty string if its first argument is not a
32364 prvs-signed address, thus causing the &%condition%& condition to be false. If
32365 the first argument is a syntactically valid prvs-signed address, the yield is
32366 the third string (in this case &"1"&), whether or not the cryptographic and
32367 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32368 of the checks (empty for failure, &"1"& for success).
32369
32370 There is one more issue you must consider when implementing prvs-signing:
32371 you have to ensure that the routers accept prvs-signed addresses and
32372 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32373 router to remove the signature with a configuration along these lines:
32374 .code
32375 batv_redirect:
32376   driver = redirect
32377   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32378 .endd
32379 This works because, if the third argument of &%prvscheck%& is empty, the result
32380 of the expansion of a prvs-signed address is the decoded value of the original
32381 address. This router should probably be the first of your routers that handles
32382 local addresses.
32383
32384 To create BATV-signed addresses in the first place, a transport of this form
32385 can be used:
32386 .code
32387 external_smtp_batv:
32388   driver = smtp
32389   return_path = ${prvs {$return_path} \
32390                        {${lookup mysql{SELECT \
32391                        secret FROM batv_prvs WHERE \
32392                        sender='${quote_mysql:$sender_address}'} \
32393                        {$value}fail}}}
32394 .endd
32395 If no key can be found for the existing return path, no signing takes place.
32396
32397
32398
32399 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32400 .cindex "&ACL;" "relay control"
32401 .cindex "relaying" "control by ACL"
32402 .cindex "policy control" "relay control"
32403 An MTA is said to &'relay'& a message if it receives it from some host and
32404 delivers it directly to another host as a result of a remote address contained
32405 within it. Redirecting a local address via an alias or forward file and then
32406 passing the message on to another host is not relaying,
32407 .cindex "&""percent hack""&"
32408 but a redirection as a result of the &"percent hack"& is.
32409
32410 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32411 A host which is acting as a gateway or an MX backup is concerned with incoming
32412 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32413 a host which is acting as a smart host for a number of clients is concerned
32414 with outgoing relaying from those clients to the Internet at large. Often the
32415 same host is fulfilling both functions,
32416 . ///
32417 . as illustrated in the diagram below,
32418 . ///
32419 but in principle these two kinds of relaying are entirely independent. What is
32420 not wanted is the transmission of mail from arbitrary remote hosts through your
32421 system to arbitrary domains.
32422
32423
32424 You can implement relay control by means of suitable statements in the ACL that
32425 runs for each RCPT command. For convenience, it is often easiest to use
32426 Exim's named list facility to define the domains and hosts involved. For
32427 example, suppose you want to do the following:
32428
32429 .ilist
32430 Deliver a number of domains to mailboxes on the local host (or process them
32431 locally in some other way). Let's say these are &'my.dom1.example'& and
32432 &'my.dom2.example'&.
32433 .next
32434 Relay mail for a number of other domains for which you are the secondary MX.
32435 These might be &'friend1.example'& and &'friend2.example'&.
32436 .next
32437 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32438 Suppose your LAN is 192.168.45.0/24.
32439 .endlist
32440
32441
32442 In the main part of the configuration, you put the following definitions:
32443 .code
32444 domainlist local_domains    = my.dom1.example : my.dom2.example
32445 domainlist relay_to_domains = friend1.example : friend2.example
32446 hostlist   relay_from_hosts = 192.168.45.0/24
32447 .endd
32448 Now you can use these definitions in the ACL that is run for every RCPT
32449 command:
32450 .code
32451 acl_check_rcpt:
32452   accept domains = +local_domains : +relay_to_domains
32453   accept hosts   = +relay_from_hosts
32454 .endd
32455 The first statement accepts any RCPT command that contains an address in
32456 the local or relay domains. For any other domain, control passes to the second
32457 statement, which accepts the command only if it comes from one of the relay
32458 hosts. In practice, you will probably want to make your ACL more sophisticated
32459 than this, for example, by including sender and recipient verification. The
32460 default configuration includes a more comprehensive example, which is described
32461 in chapter &<<CHAPdefconfil>>&.
32462
32463
32464
32465 .section "Checking a relay configuration" "SECTcheralcon"
32466 .cindex "relaying" "checking control of"
32467 You can check the relay characteristics of your configuration in the same way
32468 that you can test any ACL behaviour for an incoming SMTP connection, by using
32469 the &%-bh%& option to run a fake SMTP session with which you interact.
32470 .ecindex IIDacl
32471
32472
32473
32474 . ////////////////////////////////////////////////////////////////////////////
32475 . ////////////////////////////////////////////////////////////////////////////
32476
32477 .chapter "Content scanning at ACL time" "CHAPexiscan"
32478 .scindex IIDcosca "content scanning" "at ACL time"
32479 The extension of Exim to include content scanning at ACL time, formerly known
32480 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32481 was integrated into the main source for Exim release 4.50, and Tom continues to
32482 maintain it. Most of the wording of this chapter is taken from Tom's
32483 specification.
32484
32485 It is also possible to scan the content of messages at other times. The
32486 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32487 scanning after all the ACLs have run. A transport filter can be used to scan
32488 messages at delivery time (see the &%transport_filter%& option, described in
32489 chapter &<<CHAPtransportgeneric>>&).
32490
32491 If you want to include the ACL-time content-scanning features when you compile
32492 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32493 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32494
32495 .ilist
32496 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32497 for all MIME parts for SMTP and non-SMTP messages, respectively.
32498 .next
32499 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32500 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32501 run at the end of message reception (the &%acl_smtp_data%& ACL).
32502 .next
32503 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32504 of messages, or parts of messages, for debugging purposes.
32505 .next
32506 Additional expansion variables that are set in the new ACL and by the new
32507 conditions.
32508 .next
32509 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32510 .endlist
32511
32512 Content-scanning is continually evolving, and new features are still being
32513 added. While such features are still unstable and liable to incompatible
32514 changes, they are made available in Exim by setting options whose names begin
32515 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32516 this manual. You can find out about them by reading the file called
32517 &_doc/experimental.txt_&.
32518
32519 All the content-scanning facilities work on a MBOX copy of the message that is
32520 temporarily created in a file called:
32521 .display
32522 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32523 .endd
32524 The &_.eml_& extension is a friendly hint to virus scanners that they can
32525 expect an MBOX-like structure inside that file. The file is created when the
32526 first content scanning facility is called. Subsequent calls to content
32527 scanning conditions open the same file again. The directory is recursively
32528 removed when the &%acl_smtp_data%& ACL has finished running, unless
32529 .code
32530 control = no_mbox_unspool
32531 .endd
32532 has been encountered. When the MIME ACL decodes files, they are put into the
32533 same directory by default.
32534
32535
32536
32537 .section "Scanning for viruses" "SECTscanvirus"
32538 .cindex "virus scanning"
32539 .cindex "content scanning" "for viruses"
32540 .cindex "content scanning" "the &%malware%& condition"
32541 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32542 It supports a &"generic"& interface to scanners called via the shell, and
32543 specialized interfaces for &"daemon"& type virus scanners, which are resident
32544 in memory and thus are much faster.
32545
32546 A timeout of 2 minutes is applied to a scanner call (by default);
32547 if it expires then a defer action is taken.
32548
32549 .oindex "&%av_scanner%&"
32550 You can set the &%av_scanner%& option in the main part of the configuration
32551 to specify which scanner to use, together with any additional options that
32552 are needed. The basic syntax is as follows:
32553 .display
32554 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32555 .endd
32556 If you do not set &%av_scanner%&, it defaults to
32557 .code
32558 av_scanner = sophie:/var/run/sophie
32559 .endd
32560 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32561 before use.
32562 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32563 The following scanner types are supported in this release,
32564 though individual ones can be included or not at build time:
32565
32566 .vlist
32567 .vitem &%avast%&
32568 .cindex "virus scanners" "avast"
32569 This is the scanner daemon of Avast. It has been tested with Avast Core
32570 Security (currently at version 2.2.0).
32571 You can get a trial version at &url(https://www.avast.com) or for Linux
32572 at &url(https://www.avast.com/linux-server-antivirus).
32573 This scanner type takes one option,
32574 which can be either a full path to a UNIX socket,
32575 or host and port specifiers separated by white space.
32576 The host may be a name or an IP address; the port is either a
32577 single number or a pair of numbers with a dash between.
32578 A list of options may follow. These options are interpreted on the
32579 Exim's side of the malware scanner, or are given on separate lines to
32580 the daemon as options before the main scan command.
32581
32582 .cindex &`pass_unscanned`& "avast"
32583 If &`pass_unscanned`&
32584 is set, any files the Avast scanner can't scan (e.g.
32585 decompression bombs, or invalid archives) are considered clean. Use with
32586 care.
32587
32588 For example:
32589 .code
32590 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32591 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32592 av_scanner = avast:192.168.2.22 5036
32593 .endd
32594 If you omit the argument, the default path
32595 &_/var/run/avast/scan.sock_&
32596 is used.
32597 If you use a remote host,
32598 you need to make Exim's spool directory available to it,
32599 as the scanner is passed a file path, not file contents.
32600 For information about available commands and their options you may use
32601 .code
32602 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32603     FLAGS
32604     SENSITIVITY
32605     PACK
32606 .endd
32607
32608 If the scanner returns a temporary failure (e.g. license issues, or
32609 permission problems), the message is deferred and a paniclog entry is
32610 written.  The usual &`defer_ok`& option is available.
32611
32612 .vitem &%aveserver%&
32613 .cindex "virus scanners" "Kaspersky"
32614 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32615 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32616 which is the path to the daemon's UNIX socket. The default is shown in this
32617 example:
32618 .code
32619 av_scanner = aveserver:/var/run/aveserver
32620 .endd
32621
32622
32623 .vitem &%clamd%&
32624 .cindex "virus scanners" "clamd"
32625 This daemon-type scanner is GPL and free. You can get it at
32626 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32627 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32628 in the MIME ACL. This is no longer believed to be necessary.
32629
32630 The options are a list of server specifiers, which may be
32631 a UNIX socket specification,
32632 a TCP socket specification,
32633 or a (global) option.
32634
32635 A socket specification consists of a space-separated list.
32636 For a Unix socket the first element is a full path for the socket,
32637 for a TCP socket the first element is the IP address
32638 and the second a port number,
32639 Any further elements are per-server (non-global) options.
32640 These per-server options are supported:
32641 .code
32642 retry=<timespec>        Retry on connect fail
32643 .endd
32644
32645 The &`retry`& option specifies a time after which a single retry for
32646 a failed connect is made.  The default is to not retry.
32647
32648 If a Unix socket file is specified, only one server is supported.
32649
32650 Examples:
32651 .code
32652 av_scanner = clamd:/opt/clamd/socket
32653 av_scanner = clamd:192.0.2.3 1234
32654 av_scanner = clamd:192.0.2.3 1234:local
32655 av_scanner = clamd:192.0.2.3 1234 retry=10s
32656 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32657 .endd
32658 If the value of av_scanner points to a UNIX socket file or contains the
32659 &`local`&
32660 option, then the ClamAV interface will pass a filename containing the data
32661 to be scanned, which should normally result in less I/O happening and be
32662 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32663 Exim does not assume that there is a common filesystem with the remote host.
32664
32665 The final example shows that multiple TCP targets can be specified.  Exim will
32666 randomly use one for each incoming email (i.e. it load balances them).  Note
32667 that only TCP targets may be used if specifying a list of scanners; a UNIX
32668 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32669 unavailable, Exim will try the remaining one(s) until it finds one that works.
32670 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32671 not keep track of scanner state between multiple messages, and the scanner
32672 selection is random, so the message will get logged in the mainlog for each
32673 email that the down scanner gets chosen first (message wrapped to be readable):
32674 .code
32675 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32676    clamd: connection to localhost, port 3310 failed
32677    (Connection refused)
32678 .endd
32679
32680 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32681 contributing the code for this scanner.
32682
32683 .vitem &%cmdline%&
32684 .cindex "virus scanners" "command line interface"
32685 This is the keyword for the generic command line scanner interface. It can be
32686 used to attach virus scanners that are invoked from the shell. This scanner
32687 type takes 3 mandatory options:
32688
32689 .olist
32690 The full path and name of the scanner binary, with all command line options,
32691 and a placeholder (&`%s`&) for the directory to scan.
32692
32693 .next
32694 A regular expression to match against the STDOUT and STDERR output of the
32695 virus scanner. If the expression matches, a virus was found. You must make
32696 absolutely sure that this expression matches on &"virus found"&. This is called
32697 the &"trigger"& expression.
32698
32699 .next
32700 Another regular expression, containing exactly one pair of parentheses, to
32701 match the name of the virus found in the scanners output. This is called the
32702 &"name"& expression.
32703 .endlist olist
32704
32705 For example, Sophos Sweep reports a virus on a line like this:
32706 .code
32707 Virus 'W32/Magistr-B' found in file ./those.bat
32708 .endd
32709 For the trigger expression, we can match the phrase &"found in file"&. For the
32710 name expression, we want to extract the W32/Magistr-B string, so we can match
32711 for the single quotes left and right of it. Altogether, this makes the
32712 configuration setting:
32713 .code
32714 av_scanner = cmdline:\
32715              /path/to/sweep -ss -all -rec -archive %s:\
32716              found in file:'(.+)'
32717 .endd
32718 .vitem &%drweb%&
32719 .cindex "virus scanners" "DrWeb"
32720 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32721 takes one option,
32722 either a full path to a UNIX socket,
32723 or host and port specifiers separated by white space.
32724 The host may be a name or an IP address; the port is either a
32725 single number or a pair of numbers with a dash between.
32726 For example:
32727 .code
32728 av_scanner = drweb:/var/run/drwebd.sock
32729 av_scanner = drweb:192.168.2.20 31337
32730 .endd
32731 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32732 is used. Thanks to Alex Miller for contributing the code for this scanner.
32733
32734 .vitem &%f-protd%&
32735 .cindex "virus scanners" "f-protd"
32736 The f-protd scanner is accessed via HTTP over TCP.
32737 One argument is taken, being a space-separated hostname and port number
32738 (or port-range).
32739 For example:
32740 .code
32741 av_scanner = f-protd:localhost 10200-10204
32742 .endd
32743 If you omit the argument, the default values shown above are used.
32744
32745 .vitem &%f-prot6d%&
32746 .cindex "virus scanners" "f-prot6d"
32747 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32748 One argument is taken, being a space-separated hostname and port number.
32749 For example:
32750 .code
32751 av_scanner = f-prot6d:localhost 10200
32752 .endd
32753 If you omit the argument, the default values show above are used.
32754
32755 .vitem &%fsecure%&
32756 .cindex "virus scanners" "F-Secure"
32757 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32758 argument which is the path to a UNIX socket. For example:
32759 .code
32760 av_scanner = fsecure:/path/to/.fsav
32761 .endd
32762 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32763 Thelmen for contributing the code for this scanner.
32764
32765 .vitem &%kavdaemon%&
32766 .cindex "virus scanners" "Kaspersky"
32767 This is the scanner daemon of Kaspersky Version 4. This version of the
32768 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32769 scanner type takes one option, which is the path to the daemon's UNIX socket.
32770 For example:
32771 .code
32772 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32773 .endd
32774 The default path is &_/var/run/AvpCtl_&.
32775
32776 .vitem &%mksd%&
32777 .cindex "virus scanners" "mksd"
32778 This was a daemon type scanner that is aimed mainly at Polish users,
32779 though some documentation was available in English.
32780 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
32781 and this appears to be a candidate for removal from Exim, unless
32782 we are informed of other virus scanners which use the same protocol
32783 to integrate.
32784 The only option for this scanner type is
32785 the maximum number of processes used simultaneously to scan the attachments,
32786 provided that mksd has
32787 been run with at least the same number of child processes. For example:
32788 .code
32789 av_scanner = mksd:2
32790 .endd
32791 You can safely omit this option (the default value is 1).
32792
32793 .vitem &%sock%&
32794 .cindex "virus scanners" "simple socket-connected"
32795 This is a general-purpose way of talking to simple scanner daemons
32796 running on the local machine.
32797 There are four options:
32798 an address (which may be an IP address and port, or the path of a Unix socket),
32799 a commandline to send (may include a single %s which will be replaced with
32800 the path to the mail file to be scanned),
32801 an RE to trigger on from the returned data,
32802 and an RE to extract malware_name from the returned data.
32803 For example:
32804 .code
32805 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
32806 .endd
32807 Note that surrounding whitespace is stripped from each option, meaning
32808 there is no way to specify a trailing newline.
32809 The socket specifier and both regular-expressions are required.
32810 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
32811 specify an empty element to get this.
32812
32813 .vitem &%sophie%&
32814 .cindex "virus scanners" "Sophos and Sophie"
32815 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
32816 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
32817 for this scanner type is the path to the UNIX socket that Sophie uses for
32818 client communication. For example:
32819 .code
32820 av_scanner = sophie:/tmp/sophie
32821 .endd
32822 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
32823 the option.
32824 .endlist
32825
32826 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
32827 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
32828 ACL.
32829
32830 The &%av_scanner%& option is expanded each time &%malware%& is called. This
32831 makes it possible to use different scanners. See further below for an example.
32832 The &%malware%& condition caches its results, so when you use it multiple times
32833 for the same message, the actual scanning process is only carried out once.
32834 However, using expandable items in &%av_scanner%& disables this caching, in
32835 which case each use of the &%malware%& condition causes a new scan of the
32836 message.
32837
32838 The &%malware%& condition takes a right-hand argument that is expanded before
32839 use and taken as a list, slash-separated by default.
32840 The first element can then be one of
32841
32842 .ilist
32843 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
32844 The condition succeeds if a virus was found, and fail otherwise. This is the
32845 recommended usage.
32846 .next
32847 &"false"& or &"0"& or an empty string, in which case no scanning is done and
32848 the condition fails immediately.
32849 .next
32850 A regular expression, in which case the message is scanned for viruses. The
32851 condition succeeds if a virus is found and its name matches the regular
32852 expression. This allows you to take special actions on certain types of virus.
32853 Note that &"/"& characters in the RE must be doubled due to the list-processing,
32854 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
32855 .endlist
32856
32857 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
32858 messages even if there is a problem with the virus scanner.
32859 Otherwise, such a problem causes the ACL to defer.
32860
32861 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
32862 specify a non-default timeout.  The default is two minutes.
32863 For example:
32864 .code
32865 malware = * / defer_ok / tmo=10s
32866 .endd
32867 A timeout causes the ACL to defer.
32868
32869 .vindex "&$callout_address$&"
32870 When a connection is made to the scanner the expansion variable &$callout_address$&
32871 is set to record the actual address used.
32872
32873 .vindex "&$malware_name$&"
32874 When a virus is found, the condition sets up an expansion variable called
32875 &$malware_name$& that contains the name of the virus. You can use it in a
32876 &%message%& modifier that specifies the error returned to the sender, and/or in
32877 logging data.
32878
32879 Beware the interaction of Exim's &%message_size_limit%& with any size limits
32880 imposed by your anti-virus scanner.
32881
32882 Here is a very simple scanning example:
32883 .code
32884 deny message = This message contains malware ($malware_name)
32885      malware = *
32886 .endd
32887 The next example accepts messages when there is a problem with the scanner:
32888 .code
32889 deny message = This message contains malware ($malware_name)
32890      malware = */defer_ok
32891 .endd
32892 The next example shows how to use an ACL variable to scan with both sophie and
32893 aveserver. It assumes you have set:
32894 .code
32895 av_scanner = $acl_m0
32896 .endd
32897 in the main Exim configuration.
32898 .code
32899 deny message = This message contains malware ($malware_name)
32900      set acl_m0 = sophie
32901      malware = *
32902
32903 deny message = This message contains malware ($malware_name)
32904      set acl_m0 = aveserver
32905      malware = *
32906 .endd
32907
32908
32909 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
32910 .cindex "content scanning" "for spam"
32911 .cindex "spam scanning"
32912 .cindex "SpamAssassin"
32913 .cindex "Rspamd"
32914 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
32915 score and a report for the message.
32916 Support is also provided for Rspamd.
32917
32918 For more information about installation and configuration of SpamAssassin or
32919 Rspamd refer to their respective websites at
32920 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
32921
32922 SpamAssassin can be installed with CPAN by running:
32923 .code
32924 perl -MCPAN -e 'install Mail::SpamAssassin'
32925 .endd
32926 SpamAssassin has its own set of configuration files. Please review its
32927 documentation to see how you can tweak it. The default installation should work
32928 nicely, however.
32929
32930 .oindex "&%spamd_address%&"
32931 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
32932 intend to use an instance running on the local host you do not need to set
32933 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
32934 you must set the &%spamd_address%& option in the global part of the Exim
32935 configuration as follows (example):
32936 .code
32937 spamd_address = 192.168.99.45 783
32938 .endd
32939 The SpamAssassin protocol relies on a TCP half-close from the client.
32940 If your SpamAssassin client side is running a Linux system with an
32941 iptables firewall, consider setting
32942 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
32943 timeout, Exim uses when waiting for a response from the SpamAssassin
32944 server (currently defaulting to 120s).  With a lower value the Linux
32945 connection tracking may consider your half-closed connection as dead too
32946 soon.
32947
32948
32949 To use Rspamd (which by default listens on all local addresses
32950 on TCP port 11333)
32951 you should add &%variant=rspamd%& after the address/port pair, for example:
32952 .code
32953 spamd_address = 127.0.0.1 11333 variant=rspamd
32954 .endd
32955
32956 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
32957 sockets. If you want to us these, supply &%spamd_address%& with an absolute
32958 filename instead of an address/port pair:
32959 .code
32960 spamd_address = /var/run/spamd_socket
32961 .endd
32962 You can have multiple &%spamd%& servers to improve scalability. These can
32963 reside on other hardware reachable over the network. To specify multiple
32964 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
32965 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
32966 .code
32967 spamd_address = 192.168.2.10 783 : \
32968                 192.168.2.11 783 : \
32969                 192.168.2.12 783
32970 .endd
32971 Up to 32 &%spamd%& servers are supported.
32972 When a server fails to respond to the connection attempt, all other
32973 servers are tried until one succeeds. If no server responds, the &%spam%&
32974 condition defers.
32975
32976 Unix and TCP socket specifications may be mixed in any order.
32977 Each element of the list is a list itself, space-separated by default
32978 and changeable in the usual way (&<<SECTlistsepchange>>&);
32979 take care to not double the separator.
32980
32981 For TCP socket specifications a host name or IP (v4 or v6, but
32982 subject to list-separator quoting rules) address can be used,
32983 and the port can be one or a dash-separated pair.
32984 In the latter case, the range is tried in strict order.
32985
32986 Elements after the first for Unix sockets, or second for TCP socket,
32987 are options.
32988 The supported options are:
32989 .code
32990 pri=<priority>      Selection priority
32991 weight=<value>      Selection bias
32992 time=<start>-<end>  Use only between these times of day
32993 retry=<timespec>    Retry on connect fail
32994 tmo=<timespec>      Connection time limit
32995 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
32996 .endd
32997
32998 The &`pri`& option specifies a priority for the server within the list,
32999 higher values being tried first.
33000 The default priority is 1.
33001
33002 The &`weight`& option specifies a selection bias.
33003 Within a priority set
33004 servers are queried in a random fashion, weighted by this value.
33005 The default value for selection bias is 1.
33006
33007 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33008 in the local time zone; each element being one or more digits.
33009 Either the seconds or both minutes and seconds, plus the leading &`.`&
33010 characters, may be omitted and will be taken as zero.
33011
33012 Timeout specifications for the &`retry`& and &`tmo`& options
33013 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33014
33015 The &`tmo`& option specifies an overall timeout for communication.
33016 The default value is two minutes.
33017
33018 The &`retry`& option specifies a time after which a single retry for
33019 a failed connect is made.
33020 The default is to not retry.
33021
33022 The &%spamd_address%& variable is expanded before use if it starts with
33023 a dollar sign. In this case, the expansion may return a string that is
33024 used as the list so that multiple spamd servers can be the result of an
33025 expansion.
33026
33027 .vindex "&$callout_address$&"
33028 When a connection is made to the server the expansion variable &$callout_address$&
33029 is set to record the actual address used.
33030
33031 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33032 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33033 .code
33034 deny message = This message was classified as SPAM
33035      spam = joe
33036 .endd
33037 The right-hand side of the &%spam%& condition specifies a name. This is
33038 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33039 to scan using a specific profile, but rather use the SpamAssassin system-wide
33040 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33041 Rspamd does not use this setting. However, you must put something on the
33042 right-hand side.
33043
33044 The name allows you to use per-domain or per-user antispam profiles in
33045 principle, but this is not straightforward in practice, because a message may
33046 have multiple recipients, not necessarily all in the same domain. Because the
33047 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33048 read the contents of the message, the variables &$local_part$& and &$domain$&
33049 are not set.
33050 Careful enforcement of single-recipient messages
33051 (e.g. by responding with defer in the recipient ACL for all recipients
33052 after the first),
33053 or the use of PRDR,
33054 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33055 are needed to use this feature.
33056
33057 The right-hand side of the &%spam%& condition is expanded before being used, so
33058 you can put lookups or conditions there. When the right-hand side evaluates to
33059 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33060
33061
33062 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33063 large ones may cause significant performance degradation. As most spam messages
33064 are quite small, it is recommended that you do not scan the big ones. For
33065 example:
33066 .code
33067 deny message = This message was classified as SPAM
33068      condition = ${if < {$message_size}{10K}}
33069      spam = nobody
33070 .endd
33071
33072 The &%spam%& condition returns true if the threshold specified in the user's
33073 SpamAssassin profile has been matched or exceeded. If you want to use the
33074 &%spam%& condition for its side effects (see the variables below), you can make
33075 it always return &"true"& by appending &`:true`& to the username.
33076
33077 .cindex "spam scanning" "returned variables"
33078 When the &%spam%& condition is run, it sets up a number of expansion
33079 variables.
33080 Except for &$spam_report$&,
33081 these variables are saved with the received message so are
33082 available for use at delivery time.
33083
33084 .vlist
33085 .vitem &$spam_score$&
33086 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33087 for inclusion in log or reject messages.
33088
33089 .vitem &$spam_score_int$&
33090 The spam score of the message, multiplied by ten, as an integer value. For
33091 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33092 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33093 The integer value is useful for numeric comparisons in conditions.
33094
33095 .vitem &$spam_bar$&
33096 A string consisting of a number of &"+"& or &"-"& characters, representing the
33097 integer part of the spam score value. A spam score of 4.4 would have a
33098 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33099 headers, since MUAs can match on such strings. The maximum length of the
33100 spam bar is 50 characters.
33101
33102 .vitem &$spam_report$&
33103 A multiline text table, containing the full SpamAssassin report for the
33104 message. Useful for inclusion in headers or reject messages.
33105 This variable is only usable in a DATA-time ACL.
33106 Beware that SpamAssassin may return non-ASCII characters, especially
33107 when running in country-specific locales, which are not legal
33108 unencoded in headers.
33109
33110 .vitem &$spam_action$&
33111 For SpamAssassin either 'reject' or 'no action' depending on the
33112 spam score versus threshold.
33113 For Rspamd, the recommended action.
33114
33115 .endlist
33116
33117 The &%spam%& condition caches its results unless expansion in
33118 spamd_address was used. If you call it again with the same user name, it
33119 does not scan again, but rather returns the same values as before.
33120
33121 The &%spam%& condition returns DEFER if there is any error while running
33122 the message through SpamAssassin or if the expansion of spamd_address
33123 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33124 statement block), append &`/defer_ok`& to the right-hand side of the
33125 spam condition, like this:
33126 .code
33127 deny message = This message was classified as SPAM
33128      spam    = joe/defer_ok
33129 .endd
33130 This causes messages to be accepted even if there is a problem with &%spamd%&.
33131
33132 Here is a longer, commented example of the use of the &%spam%&
33133 condition:
33134 .code
33135 # put headers in all messages (no matter if spam or not)
33136 warn  spam = nobody:true
33137       add_header = X-Spam-Score: $spam_score ($spam_bar)
33138       add_header = X-Spam-Report: $spam_report
33139
33140 # add second subject line with *SPAM* marker when message
33141 # is over threshold
33142 warn  spam = nobody
33143       add_header = Subject: *SPAM* $h_Subject:
33144
33145 # reject spam at high scores (> 12)
33146 deny  message = This message scored $spam_score spam points.
33147       spam = nobody:true
33148       condition = ${if >{$spam_score_int}{120}{1}{0}}
33149 .endd
33150
33151
33152
33153 .section "Scanning MIME parts" "SECTscanmimepart"
33154 .cindex "content scanning" "MIME parts"
33155 .cindex "MIME content scanning"
33156 .oindex "&%acl_smtp_mime%&"
33157 .oindex "&%acl_not_smtp_mime%&"
33158 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33159 each MIME part of an SMTP message, including multipart types, in the sequence
33160 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33161 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33162 options may both refer to the same ACL if you want the same processing in both
33163 cases.
33164
33165 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33166 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33167 the case of a non-SMTP message. However, a MIME ACL is called only if the
33168 message contains a &'Content-Type:'& header line. When a call to a MIME
33169 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33170 result code is sent to the client. In the case of an SMTP message, the
33171 &%acl_smtp_data%& ACL is not called when this happens.
33172
33173 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33174 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33175 condition to match against the raw MIME part. You can also use the
33176 &%mime_regex%& condition to match against the decoded MIME part (see section
33177 &<<SECTscanregex>>&).
33178
33179 At the start of a MIME ACL, a number of variables are set from the header
33180 information for the relevant MIME part. These are described below. The contents
33181 of the MIME part are not by default decoded into a disk file except for MIME
33182 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33183 part into a disk file, you can use the &%decode%& condition. The general
33184 syntax is:
33185 .display
33186 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33187 .endd
33188 The right hand side is expanded before use. After expansion,
33189 the value can be:
33190
33191 .olist
33192 &"0"& or &"false"&, in which case no decoding is done.
33193 .next
33194 The string &"default"&. In that case, the file is put in the temporary
33195 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33196 a sequential filename consisting of the message id and a sequence number. The
33197 full path and name is available in &$mime_decoded_filename$& after decoding.
33198 .next
33199 A full path name starting with a slash. If the full name is an existing
33200 directory, it is used as a replacement for the default directory. The filename
33201 is then sequentially assigned. If the path does not exist, it is used as
33202 the full path and filename.
33203 .next
33204 If the string does not start with a slash, it is used as the
33205 filename, and the default path is then used.
33206 .endlist
33207 The &%decode%& condition normally succeeds. It is only false for syntax
33208 errors or unusual circumstances such as memory shortages. You can easily decode
33209 a file with its original, proposed filename using
33210 .code
33211 decode = $mime_filename
33212 .endd
33213 However, you should keep in mind that &$mime_filename$& might contain
33214 anything. If you place files outside of the default path, they are not
33215 automatically unlinked.
33216
33217 For RFC822 attachments (these are messages attached to messages, with a
33218 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33219 as for the primary message, only that the &$mime_is_rfc822$& expansion
33220 variable is set (see below). Attached messages are always decoded to disk
33221 before being checked, and the files are unlinked once the check is done.
33222
33223 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33224 used to match regular expressions against raw and decoded MIME parts,
33225 respectively. They are described in section &<<SECTscanregex>>&.
33226
33227 .cindex "MIME content scanning" "returned variables"
33228 The following list describes all expansion variables that are
33229 available in the MIME ACL:
33230
33231 .vlist
33232 .vitem &$mime_boundary$&
33233 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33234 have a boundary string, which is stored in this variable. If the current part
33235 has no boundary parameter in the &'Content-Type:'& header, this variable
33236 contains the empty string.
33237
33238 .vitem &$mime_charset$&
33239 This variable contains the character set identifier, if one was found in the
33240 &'Content-Type:'& header. Examples for charset identifiers are:
33241 .code
33242 us-ascii
33243 gb2312 (Chinese)
33244 iso-8859-1
33245 .endd
33246 Please note that this value is not normalized, so you should do matches
33247 case-insensitively.
33248
33249 .vitem &$mime_content_description$&
33250 This variable contains the normalized content of the &'Content-Description:'&
33251 header. It can contain a human-readable description of the parts content. Some
33252 implementations repeat the filename for attachments here, but they are usually
33253 only used for display purposes.
33254
33255 .vitem &$mime_content_disposition$&
33256 This variable contains the normalized content of the &'Content-Disposition:'&
33257 header. You can expect strings like &"attachment"& or &"inline"& here.
33258
33259 .vitem &$mime_content_id$&
33260 This variable contains the normalized content of the &'Content-ID:'& header.
33261 This is a unique ID that can be used to reference a part from another part.
33262
33263 .vitem &$mime_content_size$&
33264 This variable is set only after the &%decode%& modifier (see above) has been
33265 successfully run. It contains the size of the decoded part in kilobytes. The
33266 size is always rounded up to full kilobytes, so only a completely empty part
33267 has a &$mime_content_size$& of zero.
33268
33269 .vitem &$mime_content_transfer_encoding$&
33270 This variable contains the normalized content of the
33271 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33272 type. Typical values are &"base64"& and &"quoted-printable"&.
33273
33274 .vitem &$mime_content_type$&
33275 If the MIME part has a &'Content-Type:'& header, this variable contains its
33276 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33277 are some examples of popular MIME types, as they may appear in this variable:
33278 .code
33279 text/plain
33280 text/html
33281 application/octet-stream
33282 image/jpeg
33283 audio/midi
33284 .endd
33285 If the MIME part has no &'Content-Type:'& header, this variable contains the
33286 empty string.
33287
33288 .vitem &$mime_decoded_filename$&
33289 This variable is set only after the &%decode%& modifier (see above) has been
33290 successfully run. It contains the full path and filename of the file
33291 containing the decoded data.
33292 .endlist
33293
33294 .cindex "RFC 2047"
33295 .vlist
33296 .vitem &$mime_filename$&
33297 This is perhaps the most important of the MIME variables. It contains a
33298 proposed filename for an attachment, if one was found in either the
33299 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33300 RFC2047
33301 or RFC2231
33302 decoded, but no additional sanity checks are done.
33303  If no filename was
33304 found, this variable contains the empty string.
33305
33306 .vitem &$mime_is_coverletter$&
33307 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33308 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33309 content in the cover letter, while not restricting attachments at all.
33310
33311 The variable contains 1 (true) for a MIME part believed to be part of the
33312 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33313 follows:
33314
33315 .olist
33316 The outermost MIME part of a message is always a cover letter.
33317
33318 .next
33319 If a multipart/alternative or multipart/related MIME part is a cover letter,
33320 so are all MIME subparts within that multipart.
33321
33322 .next
33323 If any other multipart is a cover letter, the first subpart is a cover letter,
33324 and the rest are attachments.
33325
33326 .next
33327 All parts contained within an attachment multipart are attachments.
33328 .endlist olist
33329
33330 As an example, the following will ban &"HTML mail"& (including that sent with
33331 alternative plain text), while allowing HTML files to be attached. HTML
33332 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33333 .code
33334 deny message = HTML mail is not accepted here
33335 !condition = $mime_is_rfc822
33336 condition = $mime_is_coverletter
33337 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33338 .endd
33339 .vitem &$mime_is_multipart$&
33340 This variable has the value 1 (true) when the current part has the main type
33341 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33342 Since multipart entities only serve as containers for other parts, you may not
33343 want to carry out specific actions on them.
33344
33345 .vitem &$mime_is_rfc822$&
33346 This variable has the value 1 (true) if the current part is not a part of the
33347 checked message itself, but part of an attached message. Attached message
33348 decoding is fully recursive.
33349
33350 .vitem &$mime_part_count$&
33351 This variable is a counter that is raised for each processed MIME part. It
33352 starts at zero for the very first part (which is usually a multipart). The
33353 counter is per-message, so it is reset when processing RFC822 attachments (see
33354 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33355 complete, so you can use it in the DATA ACL to determine the number of MIME
33356 parts of a message. For non-MIME messages, this variable contains the value -1.
33357 .endlist
33358
33359
33360
33361 .section "Scanning with regular expressions" "SECTscanregex"
33362 .cindex "content scanning" "with regular expressions"
33363 .cindex "regular expressions" "content scanning with"
33364 You can specify your own custom regular expression matches on the full body of
33365 the message, or on individual MIME parts.
33366
33367 The &%regex%& condition takes one or more regular expressions as arguments and
33368 matches them against the full message (when called in the DATA ACL) or a raw
33369 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33370 linewise, with a maximum line length of 32K characters. That means you cannot
33371 have multiline matches with the &%regex%& condition.
33372
33373 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33374 to 32K of decoded content (the whole content at once, not linewise). If the
33375 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33376 is decoded automatically when &%mime_regex%& is executed (using default path
33377 and filename values). If the decoded data is larger than  32K, only the first
33378 32K characters are checked.
33379
33380 The regular expressions are passed as a colon-separated list. To include a
33381 literal colon, you must double it. Since the whole right-hand side string is
33382 expanded before being used, you must also escape dollar signs and backslashes
33383 with more backslashes, or use the &`\N`& facility to disable expansion.
33384 Here is a simple example that contains two regular expressions:
33385 .code
33386 deny message = contains blacklisted regex ($regex_match_string)
33387      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33388 .endd
33389 The conditions returns true if any one of the regular expressions matches. The
33390 &$regex_match_string$& expansion variable is then set up and contains the
33391 matching regular expression.
33392 The expansion variables &$regex1$& &$regex2$& etc
33393 are set to any substrings captured by the regular expression.
33394
33395 &*Warning*&: With large messages, these conditions can be fairly
33396 CPU-intensive.
33397
33398 .ecindex IIDcosca
33399
33400
33401
33402
33403 . ////////////////////////////////////////////////////////////////////////////
33404 . ////////////////////////////////////////////////////////////////////////////
33405
33406 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33407          "Local scan function"
33408 .scindex IIDlosca "&[local_scan()]& function" "description of"
33409 .cindex "customizing" "input scan using C function"
33410 .cindex "policy control" "by local scan function"
33411 In these days of email worms, viruses, and ever-increasing spam, some sites
33412 want to apply a lot of checking to messages before accepting them.
33413
33414 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33415 passing messages to external virus and spam scanning software. You can also do
33416 a certain amount in Exim itself through string expansions and the &%condition%&
33417 condition in the ACL that runs after the SMTP DATA command or the ACL for
33418 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33419
33420 To allow for further customization to a site's own requirements, there is the
33421 possibility of linking Exim with a private message scanning function, written
33422 in C. If you want to run code that is written in something other than C, you
33423 can of course use a little C stub to call it.
33424
33425 The local scan function is run once for every incoming message, at the point
33426 when Exim is just about to accept the message.
33427 It can therefore be used to control non-SMTP messages from local processes as
33428 well as messages arriving via SMTP.
33429
33430 Exim applies a timeout to calls of the local scan function, and there is an
33431 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33432 Zero means &"no timeout"&.
33433 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33434 before calling the local scan function, so that the most common types of crash
33435 are caught. If the timeout is exceeded or one of those signals is caught, the
33436 incoming message is rejected with a temporary error if it is an SMTP message.
33437 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33438 code. The incident is logged on the main and reject logs.
33439
33440
33441
33442 .section "Building Exim to use a local scan function" "SECID207"
33443 .cindex "&[local_scan()]& function" "building Exim to use"
33444 To make use of the local scan function feature, you must tell Exim where your
33445 function is before building Exim, by setting
33446 both HAVE_LOCAL_SCAN and
33447 LOCAL_SCAN_SOURCE in your
33448 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33449 directory, so you might set
33450 .code
33451 HAVE_LOCAL_SCAN=yes
33452 LOCAL_SCAN_SOURCE=Local/local_scan.c
33453 .endd
33454 for example. The function must be called &[local_scan()]&. It is called by
33455 Exim after it has received a message, when the success return code is about to
33456 be sent. This is after all the ACLs have been run. The return code from your
33457 function controls whether the message is actually accepted or not. There is a
33458 commented template function (that just accepts the message) in the file
33459 _src/local_scan.c_.
33460
33461 If you want to make use of Exim's runtime configuration file to set options
33462 for your &[local_scan()]& function, you must also set
33463 .code
33464 LOCAL_SCAN_HAS_OPTIONS=yes
33465 .endd
33466 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33467
33468
33469
33470
33471 .section "API for local_scan()" "SECTapiforloc"
33472 .cindex "&[local_scan()]& function" "API description"
33473 .cindex &%dlfunc%& "API description"
33474 You must include this line near the start of your code:
33475 .code
33476 #include "local_scan.h"
33477 .endd
33478 This header file defines a number of variables and other values, and the
33479 prototype for the function itself. Exim is coded to use unsigned char values
33480 almost exclusively, and one of the things this header defines is a shorthand
33481 for &`unsigned char`& called &`uschar`&.
33482 It also contains the following macro definitions, to simplify casting character
33483 strings and pointers to character strings:
33484 .code
33485 #define CS   (char *)
33486 #define CCS  (const char *)
33487 #define CSS  (char **)
33488 #define US   (unsigned char *)
33489 #define CUS  (const unsigned char *)
33490 #define USS  (unsigned char **)
33491 .endd
33492 The function prototype for &[local_scan()]& is:
33493 .code
33494 extern int local_scan(int fd, uschar **return_text);
33495 .endd
33496 The arguments are as follows:
33497
33498 .ilist
33499 &%fd%& is a file descriptor for the file that contains the body of the message
33500 (the -D file). The file is open for reading and writing, but updating it is not
33501 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33502
33503 The descriptor is positioned at character 19 of the file, which is the first
33504 character of the body itself, because the first 19 characters are the message
33505 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33506 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33507 case this changes in some future version.
33508 .next
33509 &%return_text%& is an address which you can use to return a pointer to a text
33510 string at the end of the function. The value it points to on entry is NULL.
33511 .endlist
33512
33513 The function must return an &%int%& value which is one of the following macros:
33514
33515 .vlist
33516 .vitem &`LOCAL_SCAN_ACCEPT`&
33517 .vindex "&$local_scan_data$&"
33518 The message is accepted. If you pass back a string of text, it is saved with
33519 the message, and made available in the variable &$local_scan_data$&. No
33520 newlines are permitted (if there are any, they are turned into spaces) and the
33521 maximum length of text is 1000 characters.
33522
33523 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33524 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33525 queued without immediate delivery, and is frozen.
33526
33527 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33528 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33529 queued without immediate delivery.
33530
33531 .vitem &`LOCAL_SCAN_REJECT`&
33532 The message is rejected; the returned text is used as an error message which is
33533 passed back to the sender and which is also logged. Newlines are permitted &--
33534 they cause a multiline response for SMTP rejections, but are converted to
33535 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33536 used.
33537
33538 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33539 The message is temporarily rejected; the returned text is used as an error
33540 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33541 problem"& is used.
33542
33543 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33544 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33545 message is not written to the reject log. It has the effect of unsetting the
33546 &%rejected_header%& log selector for just this rejection. If
33547 &%rejected_header%& is already unset (see the discussion of the
33548 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33549 same as LOCAL_SCAN_REJECT.
33550
33551 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33552 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33553 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33554 .endlist
33555
33556 If the message is not being received by interactive SMTP, rejections are
33557 reported by writing to &%stderr%& or by sending an email, as configured by the
33558 &%-oe%& command line options.
33559
33560
33561
33562 .section "Configuration options for local_scan()" "SECTconoptloc"
33563 .cindex "&[local_scan()]& function" "configuration options"
33564 It is possible to have option settings in the main configuration file
33565 that set values in static variables in the &[local_scan()]& module. If you
33566 want to do this, you must have the line
33567 .code
33568 LOCAL_SCAN_HAS_OPTIONS=yes
33569 .endd
33570 in your &_Local/Makefile_& when you build Exim. (This line is in
33571 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33572 file, you must define static variables to hold the option values, and a table
33573 to define them.
33574
33575 The table must be a vector called &%local_scan_options%&, of type
33576 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33577 and a pointer to the variable that holds the value. The entries must appear in
33578 alphabetical order. Following &%local_scan_options%& you must also define a
33579 variable called &%local_scan_options_count%& that contains the number of
33580 entries in the table. Here is a short example, showing two kinds of option:
33581 .code
33582 static int my_integer_option = 42;
33583 static uschar *my_string_option = US"a default string";
33584
33585 optionlist local_scan_options[] = {
33586   { "my_integer", opt_int,       &my_integer_option },
33587   { "my_string",  opt_stringptr, &my_string_option }
33588 };
33589
33590 int local_scan_options_count =
33591   sizeof(local_scan_options)/sizeof(optionlist);
33592 .endd
33593 The values of the variables can now be changed from Exim's runtime
33594 configuration file by including a local scan section as in this example:
33595 .code
33596 begin local_scan
33597 my_integer = 99
33598 my_string = some string of text...
33599 .endd
33600 The available types of option data are as follows:
33601
33602 .vlist
33603 .vitem &*opt_bool*&
33604 This specifies a boolean (true/false) option. The address should point to a
33605 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33606 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33607 whether such a variable has been set at all, you can initialize it to
33608 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33609 values.)
33610
33611 .vitem &*opt_fixed*&
33612 This specifies a fixed point number, such as is used for load averages.
33613 The address should point to a variable of type &`int`&. The value is stored
33614 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33615
33616 .vitem &*opt_int*&
33617 This specifies an integer; the address should point to a variable of type
33618 &`int`&. The value may be specified in any of the integer formats accepted by
33619 Exim.
33620
33621 .vitem &*opt_mkint*&
33622 This is the same as &%opt_int%&, except that when such a value is output in a
33623 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33624 printed with the suffix K or M.
33625
33626 .vitem &*opt_octint*&
33627 This also specifies an integer, but the value is always interpreted as an
33628 octal integer, whether or not it starts with the digit zero, and it is
33629 always output in octal.
33630
33631 .vitem &*opt_stringptr*&
33632 This specifies a string value; the address must be a pointer to a
33633 variable that points to a string (for example, of type &`uschar *`&).
33634
33635 .vitem &*opt_time*&
33636 This specifies a time interval value. The address must point to a variable of
33637 type &`int`&. The value that is placed there is a number of seconds.
33638 .endlist
33639
33640 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33641 out the values of all the &[local_scan()]& options.
33642
33643
33644
33645 .section "Available Exim variables" "SECID208"
33646 .cindex "&[local_scan()]& function" "available Exim variables"
33647 The header &_local_scan.h_& gives you access to a number of C variables. These
33648 are the only ones that are guaranteed to be maintained from release to release.
33649 Note, however, that you can obtain the value of any Exim expansion variable,
33650 including &$recipients$&, by calling &'expand_string()'&. The exported
33651 C variables are as follows:
33652
33653 .vlist
33654 .vitem &*int&~body_linecount*&
33655 This variable contains the number of lines in the message's body.
33656 It is not valid if the &%spool_files_wireformat%& option is used.
33657
33658 .vitem &*int&~body_zerocount*&
33659 This variable contains the number of binary zero bytes in the message's body.
33660 It is not valid if the &%spool_files_wireformat%& option is used.
33661
33662 .vitem &*unsigned&~int&~debug_selector*&
33663 This variable is set to zero when no debugging is taking place. Otherwise, it
33664 is a bitmap of debugging selectors. Two bits are identified for use in
33665 &[local_scan()]&; they are defined as macros:
33666
33667 .ilist
33668 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33669 testing option that is not privileged &-- any caller may set it. All the
33670 other selector bits can be set only by admin users.
33671
33672 .next
33673 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33674 by the &`+local_scan`& debug selector. It is not included in the default set
33675 of debugging bits.
33676 .endlist ilist
33677
33678 Thus, to write to the debugging output only when &`+local_scan`& has been
33679 selected, you should use code like this:
33680 .code
33681 if ((debug_selector & D_local_scan) != 0)
33682   debug_printf("xxx", ...);
33683 .endd
33684 .vitem &*uschar&~*expand_string_message*&
33685 After a failing call to &'expand_string()'& (returned value NULL), the
33686 variable &%expand_string_message%& contains the error message, zero-terminated.
33687
33688 .vitem &*header_line&~*header_list*&
33689 A pointer to a chain of header lines. The &%header_line%& structure is
33690 discussed below.
33691
33692 .vitem &*header_line&~*header_last*&
33693 A pointer to the last of the header lines.
33694
33695 .vitem &*uschar&~*headers_charset*&
33696 The value of the &%headers_charset%& configuration option.
33697
33698 .vitem &*BOOL&~host_checking*&
33699 This variable is TRUE during a host checking session that is initiated by the
33700 &%-bh%& command line option.
33701
33702 .vitem &*uschar&~*interface_address*&
33703 The IP address of the interface that received the message, as a string. This
33704 is NULL for locally submitted messages.
33705
33706 .vitem &*int&~interface_port*&
33707 The port on which this message was received. When testing with the &%-bh%&
33708 command line option, the value of this variable is -1 unless a port has been
33709 specified via the &%-oMi%& option.
33710
33711 .vitem &*uschar&~*message_id*&
33712 This variable contains Exim's message id for the incoming message (the value of
33713 &$message_exim_id$&) as a zero-terminated string.
33714
33715 .vitem &*uschar&~*received_protocol*&
33716 The name of the protocol by which the message was received.
33717
33718 .vitem &*int&~recipients_count*&
33719 The number of accepted recipients.
33720
33721 .vitem &*recipient_item&~*recipients_list*&
33722 .cindex "recipient" "adding in local scan"
33723 .cindex "recipient" "removing in local scan"
33724 The list of accepted recipients, held in a vector of length
33725 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33726 can add additional recipients by calling &'receive_add_recipient()'& (see
33727 below). You can delete recipients by removing them from the vector and
33728 adjusting the value in &%recipients_count%&. In particular, by setting
33729 &%recipients_count%& to zero you remove all recipients. If you then return the
33730 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33731 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33732 and then call &'receive_add_recipient()'& as often as needed.
33733
33734 .vitem &*uschar&~*sender_address*&
33735 The envelope sender address. For bounce messages this is the empty string.
33736
33737 .vitem &*uschar&~*sender_host_address*&
33738 The IP address of the sending host, as a string. This is NULL for
33739 locally-submitted messages.
33740
33741 .vitem &*uschar&~*sender_host_authenticated*&
33742 The name of the authentication mechanism that was used, or NULL if the message
33743 was not received over an authenticated SMTP connection.
33744
33745 .vitem &*uschar&~*sender_host_name*&
33746 The name of the sending host, if known.
33747
33748 .vitem &*int&~sender_host_port*&
33749 The port on the sending host.
33750
33751 .vitem &*BOOL&~smtp_input*&
33752 This variable is TRUE for all SMTP input, including BSMTP.
33753
33754 .vitem &*BOOL&~smtp_batched_input*&
33755 This variable is TRUE for BSMTP input.
33756
33757 .vitem &*int&~store_pool*&
33758 The contents of this variable control which pool of memory is used for new
33759 requests. See section &<<SECTmemhanloc>>& for details.
33760 .endlist
33761
33762
33763 .section "Structure of header lines" "SECID209"
33764 The &%header_line%& structure contains the members listed below.
33765 You can add additional header lines by calling the &'header_add()'& function
33766 (see below). You can cause header lines to be ignored (deleted) by setting
33767 their type to *.
33768
33769
33770 .vlist
33771 .vitem &*struct&~header_line&~*next*&
33772 A pointer to the next header line, or NULL for the last line.
33773
33774 .vitem &*int&~type*&
33775 A code identifying certain headers that Exim recognizes. The codes are printing
33776 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33777 Notice in particular that any header line whose type is * is not transmitted
33778 with the message. This flagging is used for header lines that have been
33779 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33780 lines.) Effectively, * means &"deleted"&.
33781
33782 .vitem &*int&~slen*&
33783 The number of characters in the header line, including the terminating and any
33784 internal newlines.
33785
33786 .vitem &*uschar&~*text*&
33787 A pointer to the text of the header. It always ends with a newline, followed by
33788 a zero byte. Internal newlines are preserved.
33789 .endlist
33790
33791
33792
33793 .section "Structure of recipient items" "SECID210"
33794 The &%recipient_item%& structure contains these members:
33795
33796 .vlist
33797 .vitem &*uschar&~*address*&
33798 This is a pointer to the recipient address as it was received.
33799
33800 .vitem &*int&~pno*&
33801 This is used in later Exim processing when top level addresses are created by
33802 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
33803 and must always contain -1 at this stage.
33804
33805 .vitem &*uschar&~*errors_to*&
33806 If this value is not NULL, bounce messages caused by failing to deliver to the
33807 recipient are sent to the address it contains. In other words, it overrides the
33808 envelope sender for this one recipient. (Compare the &%errors_to%& generic
33809 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
33810 an unqualified address, Exim qualifies it using the domain from
33811 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
33812 is NULL for all recipients.
33813 .endlist
33814
33815
33816
33817 .section "Available Exim functions" "SECID211"
33818 .cindex "&[local_scan()]& function" "available Exim functions"
33819 The header &_local_scan.h_& gives you access to a number of Exim functions.
33820 These are the only ones that are guaranteed to be maintained from release to
33821 release:
33822
33823 .vlist
33824 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
33825        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
33826
33827 This function creates a child process that runs the command specified by
33828 &%argv%&. The environment for the process is specified by &%envp%&, which can
33829 be NULL if no environment variables are to be passed. A new umask is supplied
33830 for the process in &%newumask%&.
33831
33832 Pipes to the standard input and output of the new process are set up
33833 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
33834 standard error is cloned to the standard output. If there are any file
33835 descriptors &"in the way"& in the new process, they are closed. If the final
33836 argument is TRUE, the new process is made into a process group leader.
33837
33838 The function returns the pid of the new process, or -1 if things go wrong.
33839
33840 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
33841 This function waits for a child process to terminate, or for a timeout (in
33842 seconds) to expire. A timeout value of zero means wait as long as it takes. The
33843 return value is as follows:
33844
33845 .ilist
33846 >= 0
33847
33848 The process terminated by a normal exit and the value is the process
33849 ending status.
33850
33851 .next
33852 < 0 and > &--256
33853
33854 The process was terminated by a signal and the value is the negation of the
33855 signal number.
33856
33857 .next
33858 &--256
33859
33860 The process timed out.
33861 .next
33862 &--257
33863
33864 The was some other error in wait(); &%errno%& is still set.
33865 .endlist
33866
33867 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
33868 This function provide you with a means of submitting a new message to
33869 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
33870 want, but this packages it all up for you.) The function creates a pipe,
33871 forks a subprocess that is running
33872 .code
33873 exim -t -oem -oi -f <>
33874 .endd
33875 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
33876 that is connected to the standard input. The yield of the function is the PID
33877 of the subprocess. You can then write a message to the file descriptor, with
33878 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
33879
33880 When you have finished, call &'child_close()'& to wait for the process to
33881 finish and to collect its ending status. A timeout value of zero is usually
33882 fine in this circumstance. Unless you have made a mistake with the recipient
33883 addresses, you should get a return code of zero.
33884
33885
33886 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
33887        *sender_authentication)*&
33888 This function is a more sophisticated version of &'child_open()'&. The command
33889 that it runs is:
33890 .display
33891 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
33892 .endd
33893 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
33894
33895
33896 .vitem &*void&~debug_printf(char&~*,&~...)*&
33897 This is Exim's debugging function, with arguments as for &'(printf()'&. The
33898 output is written to the standard error stream. If no debugging is selected,
33899 calls to &'debug_printf()'& have no effect. Normally, you should make calls
33900 conditional on the &`local_scan`& debug selector by coding like this:
33901 .code
33902 if ((debug_selector & D_local_scan) != 0)
33903   debug_printf("xxx", ...);
33904 .endd
33905
33906 .vitem &*uschar&~*expand_string(uschar&~*string)*&
33907 This is an interface to Exim's string expansion code. The return value is the
33908 expanded string, or NULL if there was an expansion failure.
33909 The C variable &%expand_string_message%& contains an error message after an
33910 expansion failure. If expansion does not change the string, the return value is
33911 the pointer to the input string. Otherwise, the return value points to a new
33912 block of memory that was obtained by a call to &'store_get()'&. See section
33913 &<<SECTmemhanloc>>& below for a discussion of memory handling.
33914
33915 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
33916 This function allows you to an add additional header line at the end of the
33917 existing ones. The first argument is the type, and should normally be a space
33918 character. The second argument is a format string and any number of
33919 substitution arguments as for &[sprintf()]&. You may include internal newlines
33920 if you want, and you must ensure that the string ends with a newline.
33921
33922 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
33923         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
33924 This function adds a new header line at a specified point in the header
33925 chain. The header itself is specified as for &'header_add()'&.
33926
33927 If &%name%& is NULL, the new header is added at the end of the chain if
33928 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
33929 NULL, the header lines are searched for the first non-deleted header that
33930 matches the name. If one is found, the new header is added before it if
33931 &%after%& is false. If &%after%& is true, the new header is added after the
33932 found header and any adjacent subsequent ones with the same name (even if
33933 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
33934 option controls where the header is added. If it is true, addition is at the
33935 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
33936 headers, or at the top if there are no &'Received:'& headers, you could use
33937 .code
33938 header_add_at_position(TRUE, US"Received", TRUE,
33939   ' ', "X-xxx: ...");
33940 .endd
33941 Normally, there is always at least one non-deleted &'Received:'& header, but
33942 there may not be if &%received_header_text%& expands to an empty string.
33943
33944
33945 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
33946 This function removes header lines. If &%occurrence%& is zero or negative, all
33947 occurrences of the header are removed. If occurrence is greater than zero, that
33948 particular instance of the header is removed. If no header(s) can be found that
33949 match the specification, the function does nothing.
33950
33951
33952 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
33953         int&~length,&~BOOL&~notdel)*&"
33954 This function tests whether the given header has the given name. It is not just
33955 a string comparison, because white space is permitted between the name and the
33956 colon. If the &%notdel%& argument is true, a false return is forced for all
33957 &"deleted"& headers; otherwise they are not treated specially. For example:
33958 .code
33959 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
33960 .endd
33961 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
33962 .cindex "base64 encoding" "functions for &[local_scan()]& use"
33963 This function base64-encodes a string, which is passed by address and length.
33964 The text may contain bytes of any value, including zero. The result is passed
33965 back in dynamic memory that is obtained by calling &'store_get()'&. It is
33966 zero-terminated.
33967
33968 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
33969 This function decodes a base64-encoded string. Its arguments are a
33970 zero-terminated base64-encoded string and the address of a variable that is set
33971 to point to the result, which is in dynamic memory. The length of the decoded
33972 string is the yield of the function. If the input is invalid base64 data, the
33973 yield is -1. A zero byte is added to the end of the output string to make it
33974 easy to interpret as a C string (assuming it contains no zeros of its own). The
33975 added zero byte is not included in the returned count.
33976
33977 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
33978 This function checks for a match in a domain list. Domains are always
33979 matched caselessly. The return value is one of the following:
33980 .display
33981 &`OK     `& match succeeded
33982 &`FAIL   `& match failed
33983 &`DEFER  `& match deferred
33984 .endd
33985 DEFER is usually caused by some kind of lookup defer, such as the
33986 inability to contact a database.
33987
33988 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
33989         BOOL&~caseless)*&"
33990 This function checks for a match in a local part list. The third argument
33991 controls case-sensitivity. The return values are as for
33992 &'lss_match_domain()'&.
33993
33994 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
33995         BOOL&~caseless)*&"
33996 This function checks for a match in an address list. The third argument
33997 controls the case-sensitivity of the local part match. The domain is always
33998 matched caselessly. The return values are as for &'lss_match_domain()'&.
33999
34000 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34001         uschar&~*list)*&"
34002 This function checks for a match in a host list. The most common usage is
34003 expected to be
34004 .code
34005 lss_match_host(sender_host_name, sender_host_address, ...)
34006 .endd
34007 .vindex "&$sender_host_address$&"
34008 An empty address field matches an empty item in the host list. If the host name
34009 is NULL, the name corresponding to &$sender_host_address$& is automatically
34010 looked up if a host name is required to match an item in the list. The return
34011 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34012 returns ERROR in the case when it had to look up a host name, but the lookup
34013 failed.
34014
34015 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34016         *format,&~...)*&"
34017 This function writes to Exim's log files. The first argument should be zero (it
34018 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34019 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34020 them. It specifies to which log or logs the message is written. The remaining
34021 arguments are a format and relevant insertion arguments. The string should not
34022 contain any newlines, not even at the end.
34023
34024
34025 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34026 This function adds an additional recipient to the message. The first argument
34027 is the recipient address. If it is unqualified (has no domain), it is qualified
34028 with the &%qualify_recipient%& domain. The second argument must always be -1.
34029
34030 This function does not allow you to specify a private &%errors_to%& address (as
34031 described with the structure of &%recipient_item%& above), because it pre-dates
34032 the addition of that field to the structure. However, it is easy to add such a
34033 value afterwards. For example:
34034 .code
34035  receive_add_recipient(US"monitor@mydom.example", -1);
34036  recipients_list[recipients_count-1].errors_to =
34037    US"postmaster@mydom.example";
34038 .endd
34039
34040 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34041 This is a convenience function to remove a named recipient from the list of
34042 recipients. It returns true if a recipient was removed, and false if no
34043 matching recipient could be found. The argument must be a complete email
34044 address.
34045 .endlist
34046
34047
34048 .cindex "RFC 2047"
34049 .vlist
34050 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34051   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34052 This function decodes strings that are encoded according to RFC 2047. Typically
34053 these are the contents of header lines. First, each &"encoded word"& is decoded
34054 from the Q or B encoding into a byte-string. Then, if provided with the name of
34055 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34056 made  to translate the result to the named character set. If this fails, the
34057 binary string is returned with an error message.
34058
34059 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34060 maximum MIME word length is enforced. The third argument is the target
34061 encoding, or NULL if no translation is wanted.
34062
34063 .cindex "binary zero" "in RFC 2047 decoding"
34064 .cindex "RFC 2047" "binary zero in"
34065 If a binary zero is encountered in the decoded string, it is replaced by the
34066 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34067 not be 0 because header lines are handled as zero-terminated strings.
34068
34069 The function returns the result of processing the string, zero-terminated; if
34070 &%lenptr%& is not NULL, the length of the result is set in the variable to
34071 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34072
34073 If an error is encountered, the function returns NULL and uses the &%error%&
34074 argument to return an error message. The variable pointed to by &%error%& is
34075 set to NULL if there is no error; it may be set non-NULL even when the function
34076 returns a non-NULL value if decoding was successful, but there was a problem
34077 with translation.
34078
34079
34080 .vitem &*int&~smtp_fflush(void)*&
34081 This function is used in conjunction with &'smtp_printf()'&, as described
34082 below.
34083
34084 .vitem &*void&~smtp_printf(char&~*,&~...)*&
34085 The arguments of this function are like &[printf()]&; it writes to the SMTP
34086 output stream. You should use this function only when there is an SMTP output
34087 stream, that is, when the incoming message is being received via interactive
34088 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34089 is FALSE. If you want to test for an incoming message from another host (as
34090 opposed to a local process that used the &%-bs%& command line option), you can
34091 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34092 is involved.
34093
34094 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34095 output function, so it can be used for all forms of SMTP connection.
34096
34097 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34098 must start with an appropriate response code: 550 if you are going to return
34099 LOCAL_SCAN_REJECT, 451 if you are going to return
34100 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34101 initial lines of a multi-line response, the code must be followed by a hyphen
34102 to indicate that the line is not the final response line. You must also ensure
34103 that the lines you write terminate with CRLF. For example:
34104 .code
34105 smtp_printf("550-this is some extra info\r\n");
34106 return LOCAL_SCAN_REJECT;
34107 .endd
34108 Note that you can also create multi-line responses by including newlines in
34109 the data returned via the &%return_text%& argument. The added value of using
34110 &'smtp_printf()'& is that, for instance, you could introduce delays between
34111 multiple output lines.
34112
34113 The &'smtp_printf()'& function does not return any error indication, because it
34114 does not automatically flush pending output, and therefore does not test
34115 the state of the stream. (In the main code of Exim, flushing and error
34116 detection is done when Exim is ready for the next SMTP input command.) If
34117 you want to flush the output and check for an error (for example, the
34118 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34119 arguments. It flushes the output stream, and returns a non-zero value if there
34120 is an error.
34121
34122 .vitem &*void&~*store_get(int)*&
34123 This function accesses Exim's internal store (memory) manager. It gets a new
34124 chunk of memory whose size is given by the argument. Exim bombs out if it ever
34125 runs out of memory. See the next section for a discussion of memory handling.
34126
34127 .vitem &*void&~*store_get_perm(int)*&
34128 This function is like &'store_get()'&, but it always gets memory from the
34129 permanent pool. See the next section for a discussion of memory handling.
34130
34131 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34132 See below.
34133
34134 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34135 See below.
34136
34137 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34138 These three functions create strings using Exim's dynamic memory facilities.
34139 The first makes a copy of an entire string. The second copies up to a maximum
34140 number of characters, indicated by the second argument. The third uses a format
34141 and insertion arguments to create a new string. In each case, the result is a
34142 pointer to a new string in the current memory pool. See the next section for
34143 more discussion.
34144 .endlist
34145
34146
34147
34148 .section "More about Exim's memory handling" "SECTmemhanloc"
34149 .cindex "&[local_scan()]& function" "memory handling"
34150 No function is provided for freeing memory, because that is never needed.
34151 The dynamic memory that Exim uses when receiving a message is automatically
34152 recycled if another message is received by the same process (this applies only
34153 to incoming SMTP connections &-- other input methods can supply only one
34154 message at a time). After receiving the last message, a reception process
34155 terminates.
34156
34157 Because it is recycled, the normal dynamic memory cannot be used for holding
34158 data that must be preserved over a number of incoming messages on the same SMTP
34159 connection. However, Exim in fact uses two pools of dynamic memory; the second
34160 one is not recycled, and can be used for this purpose.
34161
34162 If you want to allocate memory that remains available for subsequent messages
34163 in the same SMTP connection, you should set
34164 .code
34165 store_pool = POOL_PERM
34166 .endd
34167 before calling the function that does the allocation. There is no need to
34168 restore the value if you do not need to; however, if you do want to revert to
34169 the normal pool, you can either restore the previous value of &%store_pool%& or
34170 set it explicitly to POOL_MAIN.
34171
34172 The pool setting applies to all functions that get dynamic memory, including
34173 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34174 There is also a convenience function called &'store_get_perm()'& that gets a
34175 block of memory from the permanent pool while preserving the value of
34176 &%store_pool%&.
34177 .ecindex IIDlosca
34178
34179
34180
34181
34182 . ////////////////////////////////////////////////////////////////////////////
34183 . ////////////////////////////////////////////////////////////////////////////
34184
34185 .chapter "System-wide message filtering" "CHAPsystemfilter"
34186 .scindex IIDsysfil1 "filter" "system filter"
34187 .scindex IIDsysfil2 "filtering all mail"
34188 .scindex IIDsysfil3 "system filter"
34189 The previous chapters (on ACLs and the local scan function) describe checks
34190 that can be applied to messages before they are accepted by a host. There is
34191 also a mechanism for checking messages once they have been received, but before
34192 they are delivered. This is called the &'system filter'&.
34193
34194 The system filter operates in a similar manner to users' filter files, but it
34195 is run just once per message (however many recipients the message has).
34196 It should not normally be used as a substitute for routing, because &%deliver%&
34197 commands in a system router provide new envelope recipient addresses.
34198 The system filter must be an Exim filter. It cannot be a Sieve filter.
34199
34200 The system filter is run at the start of a delivery attempt, before any routing
34201 is done. If a message fails to be completely delivered at the first attempt,
34202 the system filter is run again at the start of every retry.
34203 If you want your filter to do something only once per message, you can make use
34204 of the &%first_delivery%& condition in an &%if%& command in the filter to
34205 prevent it happening on retries.
34206
34207 .vindex "&$domain$&"
34208 .vindex "&$local_part$&"
34209 &*Warning*&: Because the system filter runs just once, variables that are
34210 specific to individual recipient addresses, such as &$local_part$& and
34211 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34212 you want to run a centrally-specified filter for each recipient address
34213 independently, you can do so by setting up a suitable &(redirect)& router, as
34214 described in section &<<SECTperaddfil>>& below.
34215
34216
34217 .section "Specifying a system filter" "SECID212"
34218 .cindex "uid (user id)" "system filter"
34219 .cindex "gid (group id)" "system filter"
34220 The name of the file that contains the system filter must be specified by
34221 setting &%system_filter%&. If you want the filter to run under a uid and gid
34222 other than root, you must also set &%system_filter_user%& and
34223 &%system_filter_group%& as appropriate. For example:
34224 .code
34225 system_filter = /etc/mail/exim.filter
34226 system_filter_user = exim
34227 .endd
34228 If a system filter generates any deliveries directly to files or pipes (via the
34229 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34230 specified by setting &%system_filter_file_transport%& and
34231 &%system_filter_pipe_transport%&, respectively. Similarly,
34232 &%system_filter_reply_transport%& must be set to handle any messages generated
34233 by the &%reply%& command.
34234
34235
34236 .section "Testing a system filter" "SECID213"
34237 You can run simple tests of a system filter in the same way as for a user
34238 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34239 are permitted only in system filters are recognized.
34240
34241 If you want to test the combined effect of a system filter and a user filter,
34242 you can use both &%-bF%& and &%-bf%& on the same command line.
34243
34244
34245
34246 .section "Contents of a system filter" "SECID214"
34247 The language used to specify system filters is the same as for users' filter
34248 files. It is described in the separate end-user document &'Exim's interface to
34249 mail filtering'&. However, there are some additional features that are
34250 available only in system filters; these are described in subsequent sections.
34251 If they are encountered in a user's filter file or when testing with &%-bf%&,
34252 they cause errors.
34253
34254 .cindex "frozen messages" "manual thaw; testing in filter"
34255 There are two special conditions which, though available in users' filter
34256 files, are designed for use in system filters. The condition &%first_delivery%&
34257 is true only for the first attempt at delivering a message, and
34258 &%manually_thawed%& is true only if the message has been frozen, and
34259 subsequently thawed by an admin user. An explicit forced delivery counts as a
34260 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34261
34262 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34263 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34264 succeed, it will not be tried again.
34265 If you want Exim to retry an unseen delivery until it succeeds, you should
34266 arrange to set it up every time the filter runs.
34267
34268 When a system filter finishes running, the values of the variables &$n0$& &--
34269 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34270 users' filter files. Thus a system filter can, for example, set up &"scores"&
34271 to which users' filter files can refer.
34272
34273
34274
34275 .section "Additional variable for system filters" "SECID215"
34276 .vindex "&$recipients$&"
34277 The expansion variable &$recipients$&, containing a list of all the recipients
34278 of the message (separated by commas and white space), is available in system
34279 filters. It is not available in users' filters for privacy reasons.
34280
34281
34282
34283 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34284 .cindex "freezing messages"
34285 .cindex "message" "freezing"
34286 .cindex "message" "forced failure"
34287 .cindex "&%fail%&" "in system filter"
34288 .cindex "&%freeze%& in system filter"
34289 .cindex "&%defer%& in system filter"
34290 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34291 always available in system filters, but are not normally enabled in users'
34292 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34293 for the &(redirect)& router.) These commands can optionally be followed by the
34294 word &%text%& and a string containing an error message, for example:
34295 .code
34296 fail text "this message looks like spam to me"
34297 .endd
34298 The keyword &%text%& is optional if the next character is a double quote.
34299
34300 The &%defer%& command defers delivery of the original recipients of the
34301 message. The &%fail%& command causes all the original recipients to be failed,
34302 and a bounce message to be created. The &%freeze%& command suspends all
34303 delivery attempts for the original recipients. In all cases, any new deliveries
34304 that are specified by the filter are attempted as normal after the filter has
34305 run.
34306
34307 The &%freeze%& command is ignored if the message has been manually unfrozen and
34308 not manually frozen since. This means that automatic freezing by a system
34309 filter can be used as a way of checking out suspicious messages. If a message
34310 is found to be all right, manually unfreezing it allows it to be delivered.
34311
34312 .cindex "log" "&%fail%& command log line"
34313 .cindex "&%fail%&" "log line; reducing"
34314 The text given with a fail command is used as part of the bounce message as
34315 well as being written to the log. If the message is quite long, this can fill
34316 up a lot of log space when such failures are common. To reduce the size of the
34317 log message, Exim interprets the text in a special way if it starts with the
34318 two characters &`<<`& and contains &`>>`& later. The text between these two
34319 strings is written to the log, and the rest of the text is used in the bounce
34320 message. For example:
34321 .code
34322 fail "<<filter test 1>>Your message is rejected \
34323      because it contains attachments that we are \
34324      not prepared to receive."
34325 .endd
34326
34327 .cindex "loop" "caused by &%fail%&"
34328 Take great care with the &%fail%& command when basing the decision to fail on
34329 the contents of the message, because the bounce message will of course include
34330 the contents of the original message and will therefore trigger the &%fail%&
34331 command again (causing a mail loop) unless steps are taken to prevent this.
34332 Testing the &%error_message%& condition is one way to prevent this. You could
34333 use, for example
34334 .code
34335 if $message_body contains "this is spam" and not error_message
34336 then fail text "spam is not wanted here" endif
34337 .endd
34338 though of course that might let through unwanted bounce messages. The
34339 alternative is clever checking of the body and/or headers to detect bounces
34340 generated by the filter.
34341
34342 The interpretation of a system filter file ceases after a
34343 &%defer%&,
34344 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34345 set up earlier in the filter file are honoured, so you can use a sequence such
34346 as
34347 .code
34348 mail ...
34349 freeze
34350 .endd
34351 to send a specified message when the system filter is freezing (or deferring or
34352 failing) a message. The normal deliveries for the message do not, of course,
34353 take place.
34354
34355
34356
34357 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34358 .cindex "header lines" "adding; in system filter"
34359 .cindex "header lines" "removing; in system filter"
34360 .cindex "filter" "header lines; adding/removing"
34361 Two filter commands that are available only in system filters are:
34362 .code
34363 headers add <string>
34364 headers remove <string>
34365 .endd
34366 The argument for the &%headers add%& is a string that is expanded and then
34367 added to the end of the message's headers. It is the responsibility of the
34368 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34369 space is ignored, and if the string is otherwise empty, or if the expansion is
34370 forced to fail, the command has no effect.
34371
34372 You can use &"\n"& within the string, followed by white space, to specify
34373 continued header lines. More than one header may be added in one command by
34374 including &"\n"& within the string without any following white space. For
34375 example:
34376 .code
34377 headers add "X-header-1: ....\n  \
34378              continuation of X-header-1 ...\n\
34379              X-header-2: ...."
34380 .endd
34381 Note that the header line continuation white space after the first newline must
34382 be placed before the backslash that continues the input string, because white
34383 space after input continuations is ignored.
34384
34385 The argument for &%headers remove%& is a colon-separated list of header names.
34386 This command applies only to those headers that are stored with the message;
34387 those that are added at delivery time (such as &'Envelope-To:'& and
34388 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34389 header with the same name, they are all removed.
34390
34391 The &%headers%& command in a system filter makes an immediate change to the set
34392 of header lines that was received with the message (with possible additions
34393 from ACL processing). Subsequent commands in the system filter operate on the
34394 modified set, which also forms the basis for subsequent message delivery.
34395 Unless further modified during routing or transporting, this set of headers is
34396 used for all recipients of the message.
34397
34398 During routing and transporting, the variables that refer to the contents of
34399 header lines refer only to those lines that are in this set. Thus, header lines
34400 that are added by a system filter are visible to users' filter files and to all
34401 routers and transports. This contrasts with the manipulation of header lines by
34402 routers and transports, which is not immediate, but which instead is saved up
34403 until the message is actually being written (see section
34404 &<<SECTheadersaddrem>>&).
34405
34406 If the message is not delivered at the first attempt, header lines that were
34407 added by the system filter are stored with the message, and so are still
34408 present at the next delivery attempt. Header lines that were removed are still
34409 present, but marked &"deleted"& so that they are not transported with the
34410 message. For this reason, it is usual to make the &%headers%& command
34411 conditional on &%first_delivery%& so that the set of header lines is not
34412 modified more than once.
34413
34414 Because header modification in a system filter acts immediately, you have to
34415 use an indirect approach if you want to modify the contents of a header line.
34416 For example:
34417 .code
34418 headers add "Old-Subject: $h_subject:"
34419 headers remove "Subject"
34420 headers add "Subject: new subject (was: $h_old-subject:)"
34421 headers remove "Old-Subject"
34422 .endd
34423
34424
34425
34426 .section "Setting an errors address in a system filter" "SECID217"
34427 .cindex "envelope from"
34428 .cindex "envelope sender"
34429 In a system filter, if a &%deliver%& command is followed by
34430 .code
34431 errors_to <some address>
34432 .endd
34433 in order to change the envelope sender (and hence the error reporting) for that
34434 delivery, any address may be specified. (In a user filter, only the current
34435 user's address can be set.) For example, if some mail is being monitored, you
34436 might use
34437 .code
34438 unseen deliver monitor@spying.example errors_to root@local.example
34439 .endd
34440 to take a copy which would not be sent back to the normal error reporting
34441 address if its delivery failed.
34442
34443
34444
34445 .section "Per-address filtering" "SECTperaddfil"
34446 .vindex "&$domain$&"
34447 .vindex "&$local_part$&"
34448 In contrast to the system filter, which is run just once per message for each
34449 delivery attempt, it is also possible to set up a system-wide filtering
34450 operation that runs once for each recipient address. In this case, variables
34451 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34452 filter file could be made dependent on them. This is an example of a router
34453 which implements such a filter:
34454 .code
34455 central_filter:
34456   check_local_user
34457   driver = redirect
34458   domains = +local_domains
34459   file = /central/filters/$local_part
34460   no_verify
34461   allow_filter
34462   allow_freeze
34463 .endd
34464 The filter is run in a separate process under its own uid. Therefore, either
34465 &%check_local_user%& must be set (as above), in which case the filter is run as
34466 the local user, or the &%user%& option must be used to specify which user to
34467 use. If both are set, &%user%& overrides.
34468
34469 Care should be taken to ensure that none of the commands in the filter file
34470 specify a significant delivery if the message is to go on to be delivered to
34471 its intended recipient. The router will not then claim to have dealt with the
34472 address, so it will be passed on to subsequent routers to be delivered in the
34473 normal way.
34474 .ecindex IIDsysfil1
34475 .ecindex IIDsysfil2
34476 .ecindex IIDsysfil3
34477
34478
34479
34480
34481
34482
34483 . ////////////////////////////////////////////////////////////////////////////
34484 . ////////////////////////////////////////////////////////////////////////////
34485
34486 .chapter "Message processing" "CHAPmsgproc"
34487 .scindex IIDmesproc "message" "general processing"
34488 Exim performs various transformations on the sender and recipient addresses of
34489 all messages that it handles, and also on the messages' header lines. Some of
34490 these are optional and configurable, while others always take place. All of
34491 this processing, except rewriting as a result of routing, and the addition or
34492 removal of header lines while delivering, happens when a message is received,
34493 before it is placed on Exim's queue.
34494
34495 Some of the automatic processing takes place by default only for
34496 &"locally-originated"& messages. This adjective is used to describe messages
34497 that are not received over TCP/IP, but instead are passed to an Exim process on
34498 its standard input. This includes the interactive &"local SMTP"& case that is
34499 set up by the &%-bs%& command line option.
34500
34501 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34502 or ::1) are not considered to be locally-originated. Exim does not treat the
34503 loopback interface specially in any way.
34504
34505 If you want the loopback interface to be treated specially, you must ensure
34506 that there are appropriate entries in your ACLs.
34507
34508
34509
34510
34511 .section "Submission mode for non-local messages" "SECTsubmodnon"
34512 .cindex "message" "submission"
34513 .cindex "submission mode"
34514 Processing that happens automatically for locally-originated messages (unless
34515 &%suppress_local_fixups%& is set) can also be requested for messages that are
34516 received over TCP/IP. The term &"submission mode"& is used to describe this
34517 state. Submission mode is set by the modifier
34518 .code
34519 control = submission
34520 .endd
34521 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34522 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34523 a local submission, and is normally used when the source of the message is
34524 known to be an MUA running on a client host (as opposed to an MTA). For
34525 example, to set submission mode for messages originating on the IPv4 loopback
34526 interface, you could include the following in the MAIL ACL:
34527 .code
34528 warn  hosts = 127.0.0.1
34529       control = submission
34530 .endd
34531 .cindex "&%sender_retain%& submission option"
34532 There are some options that can be used when setting submission mode. A slash
34533 is used to separate options. For example:
34534 .code
34535 control = submission/sender_retain
34536 .endd
34537 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34538 true and &%local_from_check%& false for the current incoming message. The first
34539 of these allows an existing &'Sender:'& header in the message to remain, and
34540 the second suppresses the check to ensure that &'From:'& matches the
34541 authenticated sender. With this setting, Exim still fixes up messages by adding
34542 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34543 attempt to check sender authenticity in header lines.
34544
34545 When &%sender_retain%& is not set, a submission mode setting may specify a
34546 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34547 example:
34548 .code
34549 control = submission/domain=some.domain
34550 .endd
34551 The domain may be empty. How this value is used is described in sections
34552 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34553 that allows you to specify the user's full name for inclusion in a created
34554 &'Sender:'& or &'From:'& header line. For example:
34555 .code
34556 accept authenticated = *
34557        control = submission/domain=wonderland.example/\
34558                             name=${lookup {$authenticated_id} \
34559                                    lsearch {/etc/exim/namelist}}
34560 .endd
34561 Because the name may contain any characters, including slashes, the &%name%&
34562 option must be given last. The remainder of the string is used as the name. For
34563 the example above, if &_/etc/exim/namelist_& contains:
34564 .code
34565 bigegg:  Humpty Dumpty
34566 .endd
34567 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34568 line would be:
34569 .code
34570 Sender: Humpty Dumpty <bigegg@wonderland.example>
34571 .endd
34572 .cindex "return path" "in submission mode"
34573 By default, submission mode forces the return path to the same address as is
34574 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34575 specified, the return path is also left unchanged.
34576
34577 &*Note*&: The changes caused by submission mode take effect after the predata
34578 ACL. This means that any sender checks performed before the fix-ups use the
34579 untrusted sender address specified by the user, not the trusted sender address
34580 specified by submission mode. Although this might be slightly unexpected, it
34581 does mean that you can configure ACL checks to spot that a user is trying to
34582 spoof another's address.
34583
34584 .section "Line endings" "SECTlineendings"
34585 .cindex "line endings"
34586 .cindex "carriage return"
34587 .cindex "linefeed"
34588 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34589 linefeed) is the line ending for messages transmitted over the Internet using
34590 SMTP over TCP/IP. However, within individual operating systems, different
34591 conventions are used. For example, Unix-like systems use just LF, but others
34592 use CRLF or just CR.
34593
34594 Exim was designed for Unix-like systems, and internally, it stores messages
34595 using the system's convention of a single LF as a line terminator. When
34596 receiving a message, all line endings are translated to this standard format.
34597 Originally, it was thought that programs that passed messages directly to an
34598 MTA within an operating system would use that system's convention. Experience
34599 has shown that this is not the case; for example, there are Unix applications
34600 that use CRLF in this circumstance. For this reason, and for compatibility with
34601 other MTAs, the way Exim handles line endings for all messages is now as
34602 follows:
34603
34604 .ilist
34605 LF not preceded by CR is treated as a line ending.
34606 .next
34607 CR is treated as a line ending; if it is immediately followed by LF, the LF
34608 is ignored.
34609 .next
34610 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34611 nor a local message in the state where a line containing only a dot is a
34612 terminator.
34613 .next
34614 If a bare CR is encountered within a header line, an extra space is added after
34615 the line terminator so as not to end the header line. The reasoning behind this
34616 is that bare CRs in header lines are most likely either to be mistakes, or
34617 people trying to play silly games.
34618 .next
34619 If the first header line received in a message ends with CRLF, a subsequent
34620 bare LF in a header line is treated in the same way as a bare CR in a header
34621 line.
34622 .endlist
34623
34624
34625
34626
34627
34628 .section "Unqualified addresses" "SECID218"
34629 .cindex "unqualified addresses"
34630 .cindex "address" "qualification"
34631 By default, Exim expects every envelope address it receives from an external
34632 host to be fully qualified. Unqualified addresses cause negative responses to
34633 SMTP commands. However, because SMTP is used as a means of transporting
34634 messages from MUAs running on personal workstations, there is sometimes a
34635 requirement to accept unqualified addresses from specific hosts or IP networks.
34636
34637 Exim has two options that separately control which hosts may send unqualified
34638 sender or recipient addresses in SMTP commands, namely
34639 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34640 cases, if an unqualified address is accepted, it is qualified by adding the
34641 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34642
34643 .oindex "&%qualify_domain%&"
34644 .oindex "&%qualify_recipient%&"
34645 Unqualified addresses in header lines are automatically qualified for messages
34646 that are locally originated, unless the &%-bnq%& option is given on the command
34647 line. For messages received over SMTP, unqualified addresses in header lines
34648 are qualified only if unqualified addresses are permitted in SMTP commands. In
34649 other words, such qualification is also controlled by
34650 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34651
34652
34653
34654
34655 .section "The UUCP From line" "SECID219"
34656 .cindex "&""From""& line"
34657 .cindex "UUCP" "&""From""& line"
34658 .cindex "sender" "address"
34659 .oindex "&%uucp_from_pattern%&"
34660 .oindex "&%uucp_from_sender%&"
34661 .cindex "envelope from"
34662 .cindex "envelope sender"
34663 .cindex "Sendmail compatibility" "&""From""& line"
34664 Messages that have come from UUCP (and some other applications) often begin
34665 with a line containing the envelope sender and a timestamp, following the word
34666 &"From"&. Examples of two common formats are:
34667 .code
34668 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34669 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34670 .endd
34671 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34672 Exim recognizes such lines at the start of messages that are submitted to it
34673 via the command line (that is, on the standard input). It does not recognize
34674 such lines in incoming SMTP messages, unless the sending host matches
34675 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34676 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34677 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34678 default value matches the two common cases shown above and puts the address
34679 that follows &"From"& into &$1$&.
34680
34681 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34682 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34683 a trusted user, the message's sender address is constructed by expanding the
34684 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34685 then parsed as an RFC 2822 address. If there is no domain, the local part is
34686 qualified with &%qualify_domain%& unless it is the empty string. However, if
34687 the command line &%-f%& option is used, it overrides the &"From"& line.
34688
34689 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34690 sender address is not changed. This is also the case for incoming SMTP messages
34691 that are permitted to contain &"From"& lines.
34692
34693 Only one &"From"& line is recognized. If there is more than one, the second is
34694 treated as a data line that starts the body of the message, as it is not valid
34695 as a header line. This also happens if a &"From"& line is present in an
34696 incoming SMTP message from a source that is not permitted to send them.
34697
34698
34699
34700 .section "Resent- header lines" "SECID220"
34701 .cindex "&%Resent-%& header lines"
34702 .cindex "header lines" "Resent-"
34703 RFC 2822 makes provision for sets of header lines starting with the string
34704 &`Resent-`& to be added to a message when it is resent by the original
34705 recipient to somebody else. These headers are &'Resent-Date:'&,
34706 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34707 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34708
34709 .blockquote
34710 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34711 processing of replies or other such automatic actions on messages.'&
34712 .endblockquote
34713
34714 This leaves things a bit vague as far as other processing actions such as
34715 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34716 follows:
34717
34718 .ilist
34719 A &'Resent-From:'& line that just contains the login id of the submitting user
34720 is automatically rewritten in the same way as &'From:'& (see below).
34721 .next
34722 If there's a rewriting rule for a particular header line, it is also applied to
34723 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34724 &'From:'& also rewrites &'Resent-From:'&.
34725 .next
34726 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34727 also removed.
34728 .next
34729 For a locally-submitted message,
34730 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34731 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34732 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34733 included in log lines in this case.
34734 .next
34735 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34736 &%Resent-%& header lines are present.
34737 .endlist
34738
34739
34740
34741
34742 .section "The Auto-Submitted: header line" "SECID221"
34743 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34744 includes the header line:
34745 .code
34746 Auto-Submitted: auto-replied
34747 .endd
34748
34749 .section "The Bcc: header line" "SECID222"
34750 .cindex "&'Bcc:'& header line"
34751 If Exim is called with the &%-t%& option, to take recipient addresses from a
34752 message's header, it removes any &'Bcc:'& header line that may exist (after
34753 extracting its addresses). If &%-t%& is not present on the command line, any
34754 existing &'Bcc:'& is not removed.
34755
34756
34757 .section "The Date: header line" "SECID223"
34758 .cindex "&'Date:'& header line"
34759 .cindex "header lines" "Date:"
34760 If a locally-generated or submission-mode message has no &'Date:'& header line,
34761 Exim adds one, using the current date and time, unless the
34762 &%suppress_local_fixups%& control has been specified.
34763
34764 .section "The Delivery-date: header line" "SECID224"
34765 .cindex "&'Delivery-date:'& header line"
34766 .oindex "&%delivery_date_remove%&"
34767 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34768 set. Exim can be configured to add them to the final delivery of messages. (See
34769 the generic &%delivery_date_add%& transport option.) They should not be present
34770 in messages in transit. If the &%delivery_date_remove%& configuration option is
34771 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34772 messages.
34773
34774
34775 .section "The Envelope-to: header line" "SECID225"
34776 .cindex "&'Envelope-to:'& header line"
34777 .cindex "header lines" "Envelope-to:"
34778 .oindex "&%envelope_to_remove%&"
34779 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34780 Exim can be configured to add them to the final delivery of messages. (See the
34781 generic &%envelope_to_add%& transport option.) They should not be present in
34782 messages in transit. If the &%envelope_to_remove%& configuration option is set
34783 (the default), Exim removes &'Envelope-to:'& header lines from incoming
34784 messages.
34785
34786
34787 .section "The From: header line" "SECTthefrohea"
34788 .cindex "&'From:'& header line"
34789 .cindex "header lines" "From:"
34790 .cindex "Sendmail compatibility" "&""From""& line"
34791 .cindex "message" "submission"
34792 .cindex "submission mode"
34793 If a submission-mode message does not contain a &'From:'& header line, Exim
34794 adds one if either of the following conditions is true:
34795
34796 .ilist
34797 The envelope sender address is not empty (that is, this is not a bounce
34798 message). The added header line copies the envelope sender address.
34799 .next
34800 .vindex "&$authenticated_id$&"
34801 The SMTP session is authenticated and &$authenticated_id$& is not empty.
34802 .olist
34803 .vindex "&$qualify_domain$&"
34804 If no domain is specified by the submission control, the local part is
34805 &$authenticated_id$& and the domain is &$qualify_domain$&.
34806 .next
34807 If a non-empty domain is specified by the submission control, the local
34808 part is &$authenticated_id$&, and the domain is the specified domain.
34809 .next
34810 If an empty domain is specified by the submission control,
34811 &$authenticated_id$& is assumed to be the complete address.
34812 .endlist
34813 .endlist
34814
34815 A non-empty envelope sender takes precedence.
34816
34817 If a locally-generated incoming message does not contain a &'From:'& header
34818 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
34819 containing the sender's address. The calling user's login name and full name
34820 are used to construct the address, as described in section &<<SECTconstr>>&.
34821 They are obtained from the password data by calling &[getpwuid()]& (but see the
34822 &%unknown_login%& configuration option). The address is qualified with
34823 &%qualify_domain%&.
34824
34825 For compatibility with Sendmail, if an incoming, non-SMTP message has a
34826 &'From:'& header line containing just the unqualified login name of the calling
34827 user, this is replaced by an address containing the user's login name and full
34828 name as described in section &<<SECTconstr>>&.
34829
34830
34831 .section "The Message-ID: header line" "SECID226"
34832 .cindex "&'Message-ID:'& header line"
34833 .cindex "header lines" "Message-ID:"
34834 .cindex "message" "submission"
34835 .oindex "&%message_id_header_text%&"
34836 If a locally-generated or submission-mode incoming message does not contain a
34837 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
34838 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
34839 to the message. If there are any &'Resent-:'& headers in the message, it
34840 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
34841 message id, preceded by the letter E to ensure it starts with a letter, and
34842 followed by @ and the primary host name. Additional information can be included
34843 in this header line by setting the &%message_id_header_text%& and/or
34844 &%message_id_header_domain%& options.
34845
34846
34847 .section "The Received: header line" "SECID227"
34848 .cindex "&'Received:'& header line"
34849 .cindex "header lines" "Received:"
34850 A &'Received:'& header line is added at the start of every message. The
34851 contents are defined by the &%received_header_text%& configuration option, and
34852 Exim automatically adds a semicolon and a timestamp to the configured string.
34853
34854 The &'Received:'& header is generated as soon as the message's header lines
34855 have been received. At this stage, the timestamp in the &'Received:'& header
34856 line is the time that the message started to be received. This is the value
34857 that is seen by the DATA ACL and by the &[local_scan()]& function.
34858
34859 Once a message is accepted, the timestamp in the &'Received:'& header line is
34860 changed to the time of acceptance, which is (apart from a small delay while the
34861 -H spool file is written) the earliest time at which delivery could start.
34862
34863
34864 .section "The References: header line" "SECID228"
34865 .cindex "&'References:'& header line"
34866 .cindex "header lines" "References:"
34867 Messages created by the &(autoreply)& transport include a &'References:'&
34868 header line. This is constructed according to the rules that are described in
34869 section 3.64 of RFC 2822 (which states that replies should contain such a
34870 header line), and section 3.14 of RFC 3834 (which states that automatic
34871 responses are not different in this respect). However, because some mail
34872 processing software does not cope well with very long header lines, no more
34873 than 12 message IDs are copied from the &'References:'& header line in the
34874 incoming message. If there are more than 12, the first one and then the final
34875 11 are copied, before adding the message ID of the incoming message.
34876
34877
34878
34879 .section "The Return-path: header line" "SECID229"
34880 .cindex "&'Return-path:'& header line"
34881 .cindex "header lines" "Return-path:"
34882 .oindex "&%return_path_remove%&"
34883 &'Return-path:'& header lines are defined as something an MTA may insert when
34884 it does the final delivery of messages. (See the generic &%return_path_add%&
34885 transport option.) Therefore, they should not be present in messages in
34886 transit. If the &%return_path_remove%& configuration option is set (the
34887 default), Exim removes &'Return-path:'& header lines from incoming messages.
34888
34889
34890
34891 .section "The Sender: header line" "SECTthesenhea"
34892 .cindex "&'Sender:'& header line"
34893 .cindex "message" "submission"
34894 .cindex "header lines" "Sender:"
34895 For a locally-originated message from an untrusted user, Exim may remove an
34896 existing &'Sender:'& header line, and it may add a new one. You can modify
34897 these actions by setting the &%local_sender_retain%& option true, the
34898 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
34899 control setting.
34900
34901 When a local message is received from an untrusted user and
34902 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
34903 control has not been set, a check is made to see if the address given in the
34904 &'From:'& header line is the correct (local) sender of the message. The address
34905 that is expected has the login name as the local part and the value of
34906 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
34907 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
34908 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
34909 line is added to the message.
34910
34911 If you set &%local_from_check%& false, this checking does not occur. However,
34912 the removal of an existing &'Sender:'& line still happens, unless you also set
34913 &%local_sender_retain%& to be true. It is not possible to set both of these
34914 options true at the same time.
34915
34916 .cindex "submission mode"
34917 By default, no processing of &'Sender:'& header lines is done for messages
34918 received over TCP/IP or for messages submitted by trusted users. However, when
34919 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
34920 not specified on the submission control, the following processing takes place:
34921
34922 .vindex "&$authenticated_id$&"
34923 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
34924 authenticated, and &$authenticated_id$& is not empty, a sender address is
34925 created as follows:
34926
34927 .ilist
34928 .vindex "&$qualify_domain$&"
34929 If no domain is specified by the submission control, the local part is
34930 &$authenticated_id$& and the domain is &$qualify_domain$&.
34931 .next
34932 If a non-empty domain is specified by the submission control, the local part
34933 is &$authenticated_id$&, and the domain is the specified domain.
34934 .next
34935 If an empty domain is specified by the submission control,
34936 &$authenticated_id$& is assumed to be the complete address.
34937 .endlist
34938
34939 This address is compared with the address in the &'From:'& header line. If they
34940 are different, a &'Sender:'& header line containing the created address is
34941 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
34942 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
34943
34944 .cindex "return path" "created from &'Sender:'&"
34945 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
34946 the message (the envelope sender address) is changed to be the same address,
34947 except in the case of submission mode when &%sender_retain%& is specified.
34948
34949
34950
34951 .section "Adding and removing header lines in routers and transports" &&&
34952          "SECTheadersaddrem"
34953 .cindex "header lines" "adding; in router or transport"
34954 .cindex "header lines" "removing; in router or transport"
34955 When a message is delivered, the addition and removal of header lines can be
34956 specified in a system filter, or on any of the routers and transports that
34957 process the message. Section &<<SECTaddremheasys>>& contains details about
34958 modifying headers in a system filter. Header lines can also be added in an ACL
34959 as a message is received (see section &<<SECTaddheadacl>>&).
34960
34961 In contrast to what happens in a system filter, header modifications that are
34962 specified on routers and transports apply only to the particular recipient
34963 addresses that are being processed by those routers and transports. These
34964 changes do not actually take place until a copy of the message is being
34965 transported. Therefore, they do not affect the basic set of header lines, and
34966 they do not affect the values of the variables that refer to header lines.
34967
34968 &*Note*&: In particular, this means that any expansions in the configuration of
34969 the transport cannot refer to the modified header lines, because such
34970 expansions all occur before the message is actually transported.
34971
34972 For both routers and transports, the argument of a &%headers_add%&
34973 option must be in the form of one or more RFC 2822 header lines, separated by
34974 newlines (coded as &"\n"&). For example:
34975 .code
34976 headers_add = X-added-header: added by $primary_hostname\n\
34977               X-added-second: another added header line
34978 .endd
34979 Exim does not check the syntax of these added header lines.
34980
34981 Multiple &%headers_add%& options for a single router or transport can be
34982 specified; the values will append to a single list of header lines.
34983 Each header-line is separately expanded.
34984
34985 The argument of a &%headers_remove%& option must consist of a colon-separated
34986 list of header names. This is confusing, because header names themselves are
34987 often terminated by colons. In this case, the colons are the list separators,
34988 not part of the names. For example:
34989 .code
34990 headers_remove = return-receipt-to:acknowledge-to
34991 .endd
34992
34993 Multiple &%headers_remove%& options for a single router or transport can be
34994 specified; the arguments will append to a single header-names list.
34995 Each item is separately expanded.
34996 Note that colons in complex expansions which are used to
34997 form all or part of a &%headers_remove%& list
34998 will act as list separators.
34999
35000 When &%headers_add%& or &%headers_remove%& is specified on a router,
35001 items are expanded at routing time,
35002 and then associated with all addresses that are
35003 accepted by that router, and also with any new addresses that it generates. If
35004 an address passes through several routers as a result of aliasing or
35005 forwarding, the changes are cumulative.
35006
35007 .oindex "&%unseen%&"
35008 However, this does not apply to multiple routers that result from the use of
35009 the &%unseen%& option. Any header modifications that were specified by the
35010 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35011
35012 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35013 settings cannot be delivered together in a batch, so a transport is always
35014 dealing with a set of addresses that have the same header-processing
35015 requirements.
35016
35017 The transport starts by writing the original set of header lines that arrived
35018 with the message, possibly modified by the system filter. As it writes out
35019 these lines, it consults the list of header names that were attached to the
35020 recipient address(es) by &%headers_remove%& options in routers, and it also
35021 consults the transport's own &%headers_remove%& option. Header lines whose
35022 names are on either of these lists are not written out. If there are multiple
35023 instances of any listed header, they are all skipped.
35024
35025 After the remaining original header lines have been written, new header
35026 lines that were specified by routers' &%headers_add%& options are written, in
35027 the order in which they were attached to the address. These are followed by any
35028 header lines specified by the transport's &%headers_add%& option.
35029
35030 This way of handling header line modifications in routers and transports has
35031 the following consequences:
35032
35033 .ilist
35034 The original set of header lines, possibly modified by the system filter,
35035 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35036 to it, at all times.
35037 .next
35038 Header lines that are added by a router's
35039 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35040 expansion syntax in subsequent routers or the transport.
35041 .next
35042 Conversely, header lines that are specified for removal by &%headers_remove%&
35043 in a router remain visible to subsequent routers and the transport.
35044 .next
35045 Headers added to an address by &%headers_add%& in a router cannot be removed by
35046 a later router or by a transport.
35047 .next
35048 An added header can refer to the contents of an original header that is to be
35049 removed, even it has the same name as the added header. For example:
35050 .code
35051 headers_remove = subject
35052 headers_add = Subject: new subject (was: $h_subject:)
35053 .endd
35054 .endlist
35055
35056 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35057 for a &(redirect)& router that has the &%one_time%& option set.
35058
35059
35060
35061
35062
35063 .section "Constructed addresses" "SECTconstr"
35064 .cindex "address" "constructed"
35065 .cindex "constructed address"
35066 When Exim constructs a sender address for a locally-generated message, it uses
35067 the form
35068 .display
35069 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35070 .endd
35071 For example:
35072 .code
35073 Zaphod Beeblebrox <zaphod@end.univ.example>
35074 .endd
35075 The user name is obtained from the &%-F%& command line option if set, or
35076 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35077 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35078 ampersand character, this is replaced by the login name with the first letter
35079 upper cased, as is conventional in a number of operating systems. See the
35080 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35081 The &%unknown_username%& option can be used to specify user names in cases when
35082 there is no password file entry.
35083
35084 .cindex "RFC 2047"
35085 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35086 parts of it if necessary. In addition, if it contains any non-printing
35087 characters, it is encoded as described in RFC 2047, which defines a way of
35088 including non-ASCII characters in header lines. The value of the
35089 &%headers_charset%& option specifies the name of the encoding that is used (the
35090 characters are assumed to be in this encoding). The setting of
35091 &%print_topbitchars%& controls whether characters with the top bit set (that
35092 is, with codes greater than 127) count as printing characters or not.
35093
35094
35095
35096 .section "Case of local parts" "SECID230"
35097 .cindex "case of local parts"
35098 .cindex "local part" "case of"
35099 RFC 2822 states that the case of letters in the local parts of addresses cannot
35100 be assumed to be non-significant. Exim preserves the case of local parts of
35101 addresses, but by default it uses a lower-cased form when it is routing,
35102 because on most Unix systems, usernames are in lower case and case-insensitive
35103 routing is required. However, any particular router can be made to use the
35104 original case for local parts by setting the &%caseful_local_part%& generic
35105 router option.
35106
35107 .cindex "mixed-case login names"
35108 If you must have mixed-case user names on your system, the best way to proceed,
35109 assuming you want case-independent handling of incoming email, is to set up
35110 your first router to convert incoming local parts in your domains to the
35111 correct case by means of a file lookup. For example:
35112 .code
35113 correct_case:
35114   driver = redirect
35115   domains = +local_domains
35116   data = ${lookup{$local_part}cdb\
35117               {/etc/usercased.cdb}{$value}fail}\
35118               @$domain
35119 .endd
35120 For this router, the local part is forced to lower case by the default action
35121 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35122 up a new local part in the correct case. If you then set &%caseful_local_part%&
35123 on any subsequent routers which process your domains, they will operate on
35124 local parts with the correct case in a case-sensitive manner.
35125
35126
35127
35128 .section "Dots in local parts" "SECID231"
35129 .cindex "dot" "in local part"
35130 .cindex "local part" "dots in"
35131 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35132 part may not begin or end with a dot, nor have two consecutive dots in the
35133 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35134 empty components for compatibility.
35135
35136
35137
35138 .section "Rewriting addresses" "SECID232"
35139 .cindex "rewriting" "addresses"
35140 Rewriting of sender and recipient addresses, and addresses in headers, can
35141 happen automatically, or as the result of configuration options, as described
35142 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35143 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35144
35145 Automatic rewriting includes qualification, as mentioned above. The other case
35146 in which it can happen is when an incomplete non-local domain is given. The
35147 routing process may cause this to be expanded into the full domain name. For
35148 example, a header such as
35149 .code
35150 To: hare@teaparty
35151 .endd
35152 might get rewritten as
35153 .code
35154 To: hare@teaparty.wonderland.fict.example
35155 .endd
35156 Rewriting as a result of routing is the one kind of message processing that
35157 does not happen at input time, as it cannot be done until the address has
35158 been routed.
35159
35160 Strictly, one should not do &'any'& deliveries of a message until all its
35161 addresses have been routed, in case any of the headers get changed as a
35162 result of routing. However, doing this in practice would hold up many
35163 deliveries for unreasonable amounts of time, just because one address could not
35164 immediately be routed. Exim therefore does not delay other deliveries when
35165 routing of one or more addresses is deferred.
35166 .ecindex IIDmesproc
35167
35168
35169
35170 . ////////////////////////////////////////////////////////////////////////////
35171 . ////////////////////////////////////////////////////////////////////////////
35172
35173 .chapter "SMTP processing" "CHAPSMTP"
35174 .scindex IIDsmtpproc1 "SMTP" "processing details"
35175 .scindex IIDsmtpproc2 "LMTP" "processing details"
35176 Exim supports a number of different ways of using the SMTP protocol, and its
35177 LMTP variant, which is an interactive protocol for transferring messages into a
35178 closed mail store application. This chapter contains details of how SMTP is
35179 processed. For incoming mail, the following are available:
35180
35181 .ilist
35182 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35183 .next
35184 SMTP over the standard input and output (the &%-bs%& option);
35185 .next
35186 Batched SMTP on the standard input (the &%-bS%& option).
35187 .endlist
35188
35189 For mail delivery, the following are available:
35190
35191 .ilist
35192 SMTP over TCP/IP (the &(smtp)& transport);
35193 .next
35194 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35195 &"lmtp"&);
35196 .next
35197 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35198 transport);
35199 .next
35200 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35201 the &%use_bsmtp%& option set).
35202 .endlist
35203
35204 &'Batched SMTP'& is the name for a process in which batches of messages are
35205 stored in or read from files (or pipes), in a format in which SMTP commands are
35206 used to contain the envelope information.
35207
35208
35209
35210 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35211 .cindex "SMTP" "outgoing over TCP/IP"
35212 .cindex "outgoing SMTP over TCP/IP"
35213 .cindex "LMTP" "over TCP/IP"
35214 .cindex "outgoing LMTP over TCP/IP"
35215 .cindex "EHLO"
35216 .cindex "HELO"
35217 .cindex "SIZE option on MAIL command"
35218 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35219 The &%protocol%& option selects which protocol is to be used, but the actual
35220 processing is the same in both cases.
35221
35222 If, in response to its EHLO command, Exim is told that the SIZE
35223 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35224 command. The value of <&'n'&> is the message size plus the value of the
35225 &%size_addition%& option (default 1024) to allow for additions to the message
35226 such as per-transport header lines, or changes made in a
35227 .cindex "transport" "filter"
35228 .cindex "filter" "transport filter"
35229 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35230 suppressed.
35231
35232 If the remote server advertises support for PIPELINING, Exim uses the
35233 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35234 required for the transaction.
35235
35236 If the remote server advertises support for the STARTTLS command, and Exim
35237 was built to support TLS encryption, it tries to start a TLS session unless the
35238 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35239 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35240 is called for verification.
35241
35242 If the remote server advertises support for the AUTH command, Exim scans
35243 the authenticators configuration for any suitable client settings, as described
35244 in chapter &<<CHAPSMTPAUTH>>&.
35245
35246 .cindex "carriage return"
35247 .cindex "linefeed"
35248 Responses from the remote host are supposed to be terminated by CR followed by
35249 LF. However, there are known to be hosts that do not send CR characters, so in
35250 order to be able to interwork with such hosts, Exim treats LF on its own as a
35251 line terminator.
35252
35253 If a message contains a number of different addresses, all those with the same
35254 characteristics (for example, the same envelope sender) that resolve to the
35255 same set of hosts, in the same order, are sent in a single SMTP transaction,
35256 even if they are for different domains, unless there are more than the setting
35257 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35258 they are split into groups containing no more than &%max_rcpt%&s addresses
35259 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35260 in parallel sessions. The order of hosts with identical MX values is not
35261 significant when checking whether addresses can be batched in this way.
35262
35263 When the &(smtp)& transport suffers a temporary failure that is not
35264 message-related, Exim updates its transport-specific database, which contains
35265 records indexed by host name that remember which messages are waiting for each
35266 particular host. It also updates the retry database with new retry times.
35267
35268 .cindex "hints database" "retry keys"
35269 Exim's retry hints are based on host name plus IP address, so if one address of
35270 a multi-homed host is broken, it will soon be skipped most of the time.
35271 See the next section for more detail about error handling.
35272
35273 .cindex "SMTP" "passed connection"
35274 .cindex "SMTP" "batching over TCP/IP"
35275 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35276 looks in the hints database for the transport to see if there are any queued
35277 messages waiting for the host to which it is connected. If it finds one, it
35278 creates a new Exim process using the &%-MC%& option (which can only be used by
35279 a process running as root or the Exim user) and passes the TCP/IP socket to it
35280 so that it can deliver another message using the same socket. The new process
35281 does only those deliveries that are routed to the connected host, and may in
35282 turn pass the socket on to a third process, and so on.
35283
35284 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35285 limit the number of messages sent down a single TCP/IP connection.
35286
35287 .cindex "asterisk" "after IP address"
35288 The second and subsequent messages delivered down an existing connection are
35289 identified in the main log by the addition of an asterisk after the closing
35290 square bracket of the IP address.
35291
35292
35293
35294
35295 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35296 .cindex "error" "in outgoing SMTP"
35297 .cindex "SMTP" "errors in outgoing"
35298 .cindex "host" "error"
35299 Three different kinds of error are recognized for outgoing SMTP: host errors,
35300 message errors, and recipient errors.
35301
35302 .vlist
35303 .vitem "&*Host errors*&"
35304 A host error is not associated with a particular message or with a
35305 particular recipient of a message. The host errors are:
35306
35307 .ilist
35308 Connection refused or timed out,
35309 .next
35310 Any error response code on connection,
35311 .next
35312 Any error response code to EHLO or HELO,
35313 .next
35314 Loss of connection at any time, except after &"."&,
35315 .next
35316 I/O errors at any time,
35317 .next
35318 Timeouts during the session, other than in response to MAIL, RCPT or
35319 the &"."& at the end of the data.
35320 .endlist ilist
35321
35322 For a host error, a permanent error response on connection, or in response to
35323 EHLO, causes all addresses routed to the host to be failed. Any other host
35324 error causes all addresses to be deferred, and retry data to be created for the
35325 host. It is not tried again, for any message, until its retry time arrives. If
35326 the current set of addresses are not all delivered in this run (to some
35327 alternative host), the message is added to the list of those waiting for this
35328 host, so if it is still undelivered when a subsequent successful delivery is
35329 made to the host, it will be sent down the same SMTP connection.
35330
35331 .vitem "&*Message errors*&"
35332 .cindex "message" "error"
35333 A message error is associated with a particular message when sent to a
35334 particular host, but not with a particular recipient of the message. The
35335 message errors are:
35336
35337 .ilist
35338 Any error response code to MAIL, DATA, or the &"."& that terminates
35339 the data,
35340 .next
35341 Timeout after MAIL,
35342 .next
35343 Timeout or loss of connection after the &"."& that terminates the data. A
35344 timeout after the DATA command itself is treated as a host error, as is loss of
35345 connection at any other time.
35346 .endlist ilist
35347
35348 For a message error, a permanent error response (5&'xx'&) causes all addresses
35349 to be failed, and a delivery error report to be returned to the sender. A
35350 temporary error response (4&'xx'&), or one of the timeouts, causes all
35351 addresses to be deferred. Retry data is not created for the host, but instead,
35352 a retry record for the combination of host plus message id is created. The
35353 message is not added to the list of those waiting for this host. This ensures
35354 that the failing message will not be sent to this host again until the retry
35355 time arrives. However, other messages that are routed to the host are not
35356 affected, so if it is some property of the message that is causing the error,
35357 it will not stop the delivery of other mail.
35358
35359 If the remote host specified support for the SIZE parameter in its response
35360 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35361 over-large message will cause a message error because the error arrives as a
35362 response to MAIL.
35363
35364 .vitem "&*Recipient errors*&"
35365 .cindex "recipient" "error"
35366 A recipient error is associated with a particular recipient of a message. The
35367 recipient errors are:
35368
35369 .ilist
35370 Any error response to RCPT,
35371 .next
35372 Timeout after RCPT.
35373 .endlist
35374
35375 For a recipient error, a permanent error response (5&'xx'&) causes the
35376 recipient address to be failed, and a bounce message to be returned to the
35377 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35378 address to be deferred, and routing retry data to be created for it. This is
35379 used to delay processing of the address in subsequent queue runs, until its
35380 routing retry time arrives. This applies to all messages, but because it
35381 operates only in queue runs, one attempt will be made to deliver a new message
35382 to the failing address before the delay starts to operate. This ensures that,
35383 if the failure is really related to the message rather than the recipient
35384 (&"message too big for this recipient"& is a possible example), other messages
35385 have a chance of getting delivered. If a delivery to the address does succeed,
35386 the retry information gets cleared, so all stuck messages get tried again, and
35387 the retry clock is reset.
35388
35389 The message is not added to the list of those waiting for this host. Use of the
35390 host for other messages is unaffected, and except in the case of a timeout,
35391 other recipients are processed independently, and may be successfully delivered
35392 in the current SMTP session. After a timeout it is of course impossible to
35393 proceed with the session, so all addresses get deferred. However, those other
35394 than the one that failed do not suffer any subsequent retry delays. Therefore,
35395 if one recipient is causing trouble, the others have a chance of getting
35396 through when a subsequent delivery attempt occurs before the failing
35397 recipient's retry time.
35398 .endlist
35399
35400 In all cases, if there are other hosts (or IP addresses) available for the
35401 current set of addresses (for example, from multiple MX records), they are
35402 tried in this run for any undelivered addresses, subject of course to their
35403 own retry data. In other words, recipient error retry data does not take effect
35404 until the next delivery attempt.
35405
35406 Some hosts have been observed to give temporary error responses to every
35407 MAIL command at certain times (&"insufficient space"& has been seen). It
35408 would be nice if such circumstances could be recognized, and defer data for the
35409 host itself created, but this is not possible within the current Exim design.
35410 What actually happens is that retry data for every (host, message) combination
35411 is created.
35412
35413 The reason that timeouts after MAIL and RCPT are treated specially is that
35414 these can sometimes arise as a result of the remote host's verification
35415 procedures. Exim makes this assumption, and treats them as if a temporary error
35416 response had been received. A timeout after &"."& is treated specially because
35417 it is known that some broken implementations fail to recognize the end of the
35418 message if the last character of the last line is a binary zero. Thus, it is
35419 helpful to treat this case as a message error.
35420
35421 Timeouts at other times are treated as host errors, assuming a problem with the
35422 host, or the connection to it. If a timeout after MAIL, RCPT,
35423 or &"."& is really a connection problem, the assumption is that at the next try
35424 the timeout is likely to occur at some other point in the dialogue, causing it
35425 then to be treated as a host error.
35426
35427 There is experimental evidence that some MTAs drop the connection after the
35428 terminating &"."& if they do not like the contents of the message for some
35429 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35430 should be given. That is why Exim treats this case as a message rather than a
35431 host error, in order not to delay other messages to the same host.
35432
35433
35434
35435
35436 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35437 .cindex "SMTP" "incoming over TCP/IP"
35438 .cindex "incoming SMTP over TCP/IP"
35439 .cindex "inetd"
35440 .cindex "daemon"
35441 Incoming SMTP messages can be accepted in one of two ways: by running a
35442 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35443 &_/etc/inetd.conf_& should be like this:
35444 .code
35445 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35446 .endd
35447 Exim distinguishes between this case and the case of a locally running user
35448 agent using the &%-bs%& option by checking whether or not the standard input is
35449 a socket. When it is, either the port must be privileged (less than 1024), or
35450 the caller must be root or the Exim user. If any other user passes a socket
35451 with an unprivileged port number, Exim prints a message on the standard error
35452 stream and exits with an error code.
35453
35454 By default, Exim does not make a log entry when a remote host connects or
35455 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35456 unexpected. It can be made to write such log entries by setting the
35457 &%smtp_connection%& log selector.
35458
35459 .cindex "carriage return"
35460 .cindex "linefeed"
35461 Commands from the remote host are supposed to be terminated by CR followed by
35462 LF. However, there are known to be hosts that do not send CR characters. In
35463 order to be able to interwork with such hosts, Exim treats LF on its own as a
35464 line terminator.
35465 Furthermore, because common code is used for receiving messages from all
35466 sources, a CR on its own is also interpreted as a line terminator. However, the
35467 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35468
35469 .cindex "EHLO" "invalid data"
35470 .cindex "HELO" "invalid data"
35471 One area that sometimes gives rise to problems concerns the EHLO or
35472 HELO commands. Some clients send syntactically invalid versions of these
35473 commands, which Exim rejects by default. (This is nothing to do with verifying
35474 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35475 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35476 match the broken hosts that send invalid commands.
35477
35478 .cindex "SIZE option on MAIL command"
35479 .cindex "MAIL" "SIZE option"
35480 The amount of disk space available is checked whenever SIZE is received on
35481 a MAIL command, independently of whether &%message_size_limit%& or
35482 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35483 false. A temporary error is given if there is not enough space. If
35484 &%check_spool_space%& is set, the check is for that amount of space plus the
35485 value given with SIZE, that is, it checks that the addition of the incoming
35486 message will not reduce the space below the threshold.
35487
35488 When a message is successfully received, Exim includes the local message id in
35489 its response to the final &"."& that terminates the data. If the remote host
35490 logs this text it can help with tracing what has happened to a message.
35491
35492 The Exim daemon can limit the number of simultaneous incoming connections it is
35493 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35494 number of simultaneous incoming connections from a single remote host (see the
35495 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35496 rejected using the SMTP temporary error code 421.
35497
35498 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35499 subprocess has finished, as this can get lost at busy times. Instead, it looks
35500 for completed subprocesses every time it wakes up. Provided there are other
35501 things happening (new incoming calls, starts of queue runs), completed
35502 processes will be noticed and tidied away. On very quiet systems you may
35503 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35504 it will be noticed when the daemon next wakes up.
35505
35506 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35507 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35508 high system load &-- for details see the &%smtp_accept_reserve%&,
35509 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35510 applies in both the daemon and &'inetd'& cases.
35511
35512 Exim normally starts a delivery process for each message received, though this
35513 can be varied by means of the &%-odq%& command line option and the
35514 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35515 number of simultaneously running delivery processes started in this way from
35516 SMTP input can be limited by the &%smtp_accept_queue%& and
35517 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35518 subsequently received messages are just put on the input queue without starting
35519 a delivery process.
35520
35521 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35522 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35523 started up from the &'inetd'& daemon, because in that case each connection is
35524 handled by an entirely independent Exim process. Control by load average is,
35525 however, available with &'inetd'&.
35526
35527 Exim can be configured to verify addresses in incoming SMTP commands as they
35528 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35529 to rewrite addresses at this time &-- before any syntax checking is done. See
35530 section &<<SECTrewriteS>>&.
35531
35532 Exim can also be configured to limit the rate at which a client host submits
35533 MAIL and RCPT commands in a single SMTP session. See the
35534 &%smtp_ratelimit_hosts%& option.
35535
35536
35537
35538 .section "Unrecognized SMTP commands" "SECID234"
35539 .cindex "SMTP" "unrecognized commands"
35540 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35541 commands during a single SMTP connection, it drops the connection after sending
35542 the error response to the last command. The default value for
35543 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35544 abuse that subvert web servers into making connections to SMTP ports; in these
35545 circumstances, a number of non-SMTP lines are sent first.
35546
35547
35548 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35549 .cindex "SMTP" "syntax errors"
35550 .cindex "SMTP" "protocol errors"
35551 A syntax error is detected if an SMTP command is recognized, but there is
35552 something syntactically wrong with its data, for example, a malformed email
35553 address in a RCPT command. Protocol errors include invalid command
35554 sequencing such as RCPT before MAIL. If Exim receives more than
35555 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35556 drops the connection after sending the error response to the last command. The
35557 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35558 broken clients that loop sending bad commands (yes, it has been seen).
35559
35560
35561
35562 .section "Use of non-mail SMTP commands" "SECID236"
35563 .cindex "SMTP" "non-mail commands"
35564 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35565 DATA. Exim counts such commands, and drops the connection if there are too
35566 many of them in a single SMTP session. This action catches some
35567 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35568 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35569 defines what &"too many"& means. Its default value is 10.
35570
35571 When a new message is expected, one occurrence of RSET is not counted. This
35572 allows a client to send one RSET between messages (this is not necessary,
35573 but some clients do it). Exim also allows one uncounted occurrence of HELO
35574 or EHLO, and one occurrence of STARTTLS between messages. After
35575 starting up a TLS session, another EHLO is expected, and so it too is not
35576 counted.
35577
35578 The first occurrence of AUTH in a connection, or immediately following
35579 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35580 RCPT, DATA, and QUIT are counted.
35581
35582 You can control which hosts are subject to the limit set by
35583 &%smtp_accept_max_nonmail%& by setting
35584 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35585 the limit apply to all hosts. This option means that you can exclude any
35586 specific badly-behaved hosts that you have to live with.
35587
35588
35589
35590
35591 .section "The VRFY and EXPN commands" "SECID237"
35592 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35593 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35594 appropriate) in order to decide whether the command should be accepted or not.
35595
35596 .cindex "VRFY" "processing"
35597 When no ACL is defined for VRFY, or if it rejects without
35598 setting an explicit response code, the command is accepted
35599 (with a 252 SMTP response code)
35600 in order to support awkward clients that do a VRFY before every RCPT.
35601 When VRFY is accepted, it runs exactly the same code as when Exim is
35602 called with the &%-bv%& option, and returns 250/451/550
35603 SMTP response codes.
35604
35605 .cindex "EXPN" "processing"
35606 If no ACL for EXPN is defined, the command is rejected.
35607 When EXPN is accepted, a single-level expansion of the address is done.
35608 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35609 than a verification (the &%-bv%& option). If an unqualified local part is given
35610 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35611 of VRFY and EXPN commands are logged on the main and reject logs, and
35612 VRFY verification failures are logged on the main log for consistency with
35613 RCPT failures.
35614
35615
35616
35617 .section "The ETRN command" "SECTETRN"
35618 .cindex "ETRN" "processing"
35619 RFC 1985 describes an SMTP command called ETRN that is designed to
35620 overcome the security problems of the TURN command (which has fallen into
35621 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35622 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35623 should be accepted or not. If no ACL is defined, the command is rejected.
35624
35625 The ETRN command is concerned with &"releasing"& messages that are awaiting
35626 delivery to certain hosts. As Exim does not organize its message queue by host,
35627 the only form of ETRN that is supported by default is the one where the
35628 text starts with the &"#"& prefix, in which case the remainder of the text is
35629 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35630 the &%-R%& option to happen, with the remainder of the ETRN text as its
35631 argument. For example,
35632 .code
35633 ETRN #brigadoon
35634 .endd
35635 runs the command
35636 .code
35637 exim -R brigadoon
35638 .endd
35639 which causes a delivery attempt on all messages with undelivered addresses
35640 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35641 default), Exim prevents the simultaneous execution of more than one queue run
35642 for the same argument string as a result of an ETRN command. This stops
35643 a misbehaving client from starting more than one queue runner at once.
35644
35645 .cindex "hints database" "ETRN serialization"
35646 Exim implements the serialization by means of a hints database in which a
35647 record is written whenever a process is started by ETRN, and deleted when
35648 the process completes. However, Exim does not keep the SMTP session waiting for
35649 the ETRN process to complete. Once ETRN is accepted, the client is sent
35650 a &"success"& return code. Obviously there is scope for hints records to get
35651 left lying around if there is a system or program crash. To guard against this,
35652 Exim ignores any records that are more than six hours old.
35653
35654 .oindex "&%smtp_etrn_command%&"
35655 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35656 used. This specifies a command that is run whenever ETRN is received,
35657 whatever the form of its argument. For
35658 example:
35659 .code
35660 smtp_etrn_command = /etc/etrn_command $domain \
35661                     $sender_host_address
35662 .endd
35663 .vindex "&$domain$&"
35664 The string is split up into arguments which are independently expanded. The
35665 expansion variable &$domain$& is set to the argument of the ETRN command,
35666 and no syntax checking is done on the contents of this argument. Exim does not
35667 wait for the command to complete, so its status code is not checked. Exim runs
35668 under its own uid and gid when receiving incoming SMTP, so it is not possible
35669 for it to change them before running the command.
35670
35671
35672
35673 .section "Incoming local SMTP" "SECID238"
35674 .cindex "SMTP" "local incoming"
35675 Some user agents use SMTP to pass messages to their local MTA using the
35676 standard input and output, as opposed to passing the envelope on the command
35677 line and writing the message to the standard input. This is supported by the
35678 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35679 messages over TCP/IP (including the use of ACLs), except that the envelope
35680 sender given in a MAIL command is ignored unless the caller is trusted. In
35681 an ACL you can detect this form of SMTP input by testing for an empty host
35682 identification. It is common to have this as the first line in the ACL that
35683 runs for RCPT commands:
35684 .code
35685 accept hosts = :
35686 .endd
35687 This accepts SMTP messages from local processes without doing any other tests.
35688
35689
35690
35691 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35692 .cindex "SMTP" "batched outgoing"
35693 .cindex "batched SMTP output"
35694 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35695 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35696 be output in BSMTP format. No SMTP responses are possible for this form of
35697 delivery. All it is doing is using SMTP commands as a way of transmitting the
35698 envelope along with the message.
35699
35700 The message is written to the file or pipe preceded by the SMTP commands
35701 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35702 the message that start with a dot have an extra dot added. The SMTP command
35703 HELO is not normally used. If it is required, the &%message_prefix%& option
35704 can be used to specify it.
35705
35706 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35707 one recipient address at a time by default. However, you can arrange for them
35708 to handle several addresses at once by setting the &%batch_max%& option. When
35709 this is done for BSMTP, messages may contain multiple RCPT commands. See
35710 chapter &<<CHAPbatching>>& for more details.
35711
35712 .vindex "&$host$&"
35713 When one or more addresses are routed to a BSMTP transport by a router that
35714 sets up a host list, the name of the first host on the list is available to the
35715 transport in the variable &$host$&. Here is an example of such a transport and
35716 router:
35717 .code
35718 begin routers
35719 route_append:
35720   driver = manualroute
35721   transport = smtp_appendfile
35722   route_list = domain.example  batch.host.example
35723
35724 begin transports
35725 smtp_appendfile:
35726   driver = appendfile
35727   directory = /var/bsmtp/$host
35728   batch_max = 1000
35729   use_bsmtp
35730   user = exim
35731 .endd
35732 This causes messages addressed to &'domain.example'& to be written in BSMTP
35733 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35734 message (unless there are more than 1000 recipients).
35735
35736
35737
35738 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35739 .cindex "SMTP" "batched incoming"
35740 .cindex "batched SMTP input"
35741 The &%-bS%& command line option causes Exim to accept one or more messages by
35742 reading SMTP on the standard input, but to generate no responses. If the caller
35743 is trusted, the senders in the MAIL commands are believed; otherwise the
35744 sender is always the caller of Exim. Unqualified senders and receivers are not
35745 rejected (there seems little point) but instead just get qualified. HELO
35746 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35747 as NOOP; QUIT quits.
35748
35749 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35750 ACL is run in the same way as for non-SMTP local input.
35751
35752 If an error is detected while reading a message, including a missing &"."& at
35753 the end, Exim gives up immediately. It writes details of the error to the
35754 standard output in a stylized way that the calling program should be able to
35755 make some use of automatically, for example:
35756 .code
35757 554 Unexpected end of file
35758 Transaction started in line 10
35759 Error detected in line 14
35760 .endd
35761 It writes a more verbose version, for human consumption, to the standard error
35762 file, for example:
35763 .code
35764 An error was detected while processing a file of BSMTP input.
35765 The error message was:
35766
35767 501 '>' missing at end of address
35768
35769 The SMTP transaction started in line 10.
35770 The error was detected in line 12.
35771 The SMTP command at fault was:
35772
35773 rcpt to:<malformed@in.com.plete
35774
35775 1 previous message was successfully processed.
35776 The rest of the batch was abandoned.
35777 .endd
35778 The return code from Exim is zero only if there were no errors. It is 1 if some
35779 messages were accepted before an error was detected, and 2 if no messages were
35780 accepted.
35781 .ecindex IIDsmtpproc1
35782 .ecindex IIDsmtpproc2
35783
35784
35785
35786 . ////////////////////////////////////////////////////////////////////////////
35787 . ////////////////////////////////////////////////////////////////////////////
35788
35789 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
35790          "Customizing messages"
35791 When a message fails to be delivered, or remains in the queue for more than a
35792 configured amount of time, Exim sends a message to the original sender, or
35793 to an alternative configured address. The text of these messages is built into
35794 the code of Exim, but it is possible to change it, either by adding a single
35795 string, or by replacing each of the paragraphs by text supplied in a file.
35796
35797 The &'From:'& and &'To:'& header lines are automatically generated; you can
35798 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
35799 option. Exim also adds the line
35800 .code
35801 Auto-Submitted: auto-generated
35802 .endd
35803 to all warning and bounce messages,
35804
35805
35806 .section "Customizing bounce messages" "SECID239"
35807 .cindex "customizing" "bounce message"
35808 .cindex "bounce message" "customizing"
35809 If &%bounce_message_text%& is set, its contents are included in the default
35810 message immediately after &"This message was created automatically by mail
35811 delivery software."& The string is not expanded. It is not used if
35812 &%bounce_message_file%& is set.
35813
35814 When &%bounce_message_file%& is set, it must point to a template file for
35815 constructing error messages. The file consists of a series of text items,
35816 separated by lines consisting of exactly four asterisks. If the file cannot be
35817 opened, default text is used and a message is written to the main and panic
35818 logs. If any text item in the file is empty, default text is used for that
35819 item.
35820
35821 .vindex "&$bounce_recipient$&"
35822 .vindex "&$bounce_return_size_limit$&"
35823 Each item of text that is read from the file is expanded, and there are two
35824 expansion variables which can be of use here: &$bounce_recipient$& is set to
35825 the recipient of an error message while it is being created, and
35826 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
35827 option, rounded to a whole number.
35828
35829 The items must appear in the file in the following order:
35830
35831 .ilist
35832 The first item is included in the headers, and should include at least a
35833 &'Subject:'& header. Exim does not check the syntax of these headers.
35834 .next
35835 The second item forms the start of the error message. After it, Exim lists the
35836 failing addresses with their error messages.
35837 .next
35838 The third item is used to introduce any text from pipe transports that is to be
35839 returned to the sender. It is omitted if there is no such text.
35840 .next
35841 The fourth, fifth and sixth items will be ignored and may be empty.
35842 The fields exist for back-compatibility
35843 .endlist
35844
35845 The default state (&%bounce_message_file%& unset) is equivalent to the
35846 following file, in which the sixth item is empty. The &'Subject:'& and some
35847 other lines have been split in order to fit them on the page:
35848 .code
35849 Subject: Mail delivery failed
35850   ${if eq{$sender_address}{$bounce_recipient}
35851   {: returning message to sender}}
35852 ****
35853 This message was created automatically by mail delivery software.
35854
35855 A message ${if eq{$sender_address}{$bounce_recipient}
35856   {that you sent }{sent by
35857
35858 <$sender_address>
35859
35860 }}could not be delivered to all of its recipients.
35861 This is a permanent error. The following address(es) failed:
35862 ****
35863 The following text was generated during the delivery attempt(s):
35864 ****
35865 ------ This is a copy of the message, including all the headers.
35866   ------
35867 ****
35868 ------ The body of the message is $message_size characters long;
35869   only the first
35870 ------ $bounce_return_size_limit or so are included here.
35871 ****
35872 .endd
35873 .section "Customizing warning messages" "SECTcustwarn"
35874 .cindex "customizing" "warning message"
35875 .cindex "warning of delay" "customizing the message"
35876 The option &%warn_message_file%& can be pointed at a template file for use when
35877 warnings about message delays are created. In this case there are only three
35878 text sections:
35879
35880 .ilist
35881 The first item is included in the headers, and should include at least a
35882 &'Subject:'& header. Exim does not check the syntax of these headers.
35883 .next
35884 The second item forms the start of the warning message. After it, Exim lists
35885 the delayed addresses.
35886 .next
35887 The third item then ends the message.
35888 .endlist
35889
35890 The default state is equivalent to the following file, except that some lines
35891 have been split here, in order to fit them on the page:
35892 .code
35893 Subject: Warning: message $message_exim_id delayed
35894   $warn_message_delay
35895 ****
35896 This message was created automatically by mail delivery software.
35897
35898 A message ${if eq{$sender_address}{$warn_message_recipients}
35899 {that you sent }{sent by
35900
35901 <$sender_address>
35902
35903 }}has not been delivered to all of its recipients after
35904 more than $warn_message_delay in the queue on $primary_hostname.
35905
35906 The message identifier is:     $message_exim_id
35907 The subject of the message is: $h_subject
35908 The date of the message is:    $h_date
35909
35910 The following address(es) have not yet been delivered:
35911 ****
35912 No action is required on your part. Delivery attempts will
35913 continue for some time, and this warning may be repeated at
35914 intervals if the message remains undelivered. Eventually the
35915 mail delivery software will give up, and when that happens,
35916 the message will be returned to you.
35917 .endd
35918 .vindex "&$warn_message_delay$&"
35919 .vindex "&$warn_message_recipients$&"
35920 However, in the default state the subject and date lines are omitted if no
35921 appropriate headers exist. During the expansion of this file,
35922 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
35923 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
35924 of recipients for the warning message. There may be more than one if there are
35925 multiple addresses with different &%errors_to%& settings on the routers that
35926 handled them.
35927
35928
35929
35930
35931 . ////////////////////////////////////////////////////////////////////////////
35932 . ////////////////////////////////////////////////////////////////////////////
35933
35934 .chapter "Some common configuration settings" "CHAPcomconreq"
35935 This chapter discusses some configuration settings that seem to be fairly
35936 common. More examples and discussion can be found in the Exim book.
35937
35938
35939
35940 .section "Sending mail to a smart host" "SECID240"
35941 .cindex "smart host" "example router"
35942 If you want to send all mail for non-local domains to a &"smart host"&, you
35943 should replace the default &(dnslookup)& router with a router which does the
35944 routing explicitly:
35945 .code
35946 send_to_smart_host:
35947   driver = manualroute
35948   route_list = !+local_domains smart.host.name
35949   transport = remote_smtp
35950 .endd
35951 You can use the smart host's IP address instead of the name if you wish.
35952 If you are using Exim only to submit messages to a smart host, and not for
35953 receiving incoming messages, you can arrange for it to do the submission
35954 synchronously by setting the &%mua_wrapper%& option (see chapter
35955 &<<CHAPnonqueueing>>&).
35956
35957
35958
35959
35960 .section "Using Exim to handle mailing lists" "SECTmailinglists"
35961 .cindex "mailing lists"
35962 Exim can be used to run simple mailing lists, but for large and/or complicated
35963 requirements, the use of additional specialized mailing list software such as
35964 Majordomo or Mailman is recommended.
35965
35966 The &(redirect)& router can be used to handle mailing lists where each list
35967 is maintained in a separate file, which can therefore be managed by an
35968 independent manager. The &%domains%& router option can be used to run these
35969 lists in a separate domain from normal mail. For example:
35970 .code
35971 lists:
35972   driver = redirect
35973   domains = lists.example
35974   file = /usr/lists/$local_part
35975   forbid_pipe
35976   forbid_file
35977   errors_to = $local_part-request@lists.example
35978   no_more
35979 .endd
35980 This router is skipped for domains other than &'lists.example'&. For addresses
35981 in that domain, it looks for a file that matches the local part. If there is no
35982 such file, the router declines, but because &%no_more%& is set, no subsequent
35983 routers are tried, and so the whole delivery fails.
35984
35985 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
35986 expanded into a filename or a pipe delivery, which is usually inappropriate in
35987 a mailing list.
35988
35989 .oindex "&%errors_to%&"
35990 The &%errors_to%& option specifies that any delivery errors caused by addresses
35991 taken from a mailing list are to be sent to the given address rather than the
35992 original sender of the message. However, before acting on this, Exim verifies
35993 the error address, and ignores it if verification fails.
35994
35995 For example, using the configuration above, mail sent to
35996 &'dicts@lists.example'& is passed on to those addresses contained in
35997 &_/usr/lists/dicts_&, with error reports directed to
35998 &'dicts-request@lists.example'&, provided that this address can be verified.
35999 There could be a file called &_/usr/lists/dicts-request_& containing
36000 the address(es) of this particular list's manager(s), but other approaches,
36001 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36002 or &%local_part_suffix%& options) to handle addresses of the form
36003 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36004
36005
36006
36007 .section "Syntax errors in mailing lists" "SECID241"
36008 .cindex "mailing lists" "syntax errors in"
36009 If an entry in redirection data contains a syntax error, Exim normally defers
36010 delivery of the original address. That means that a syntax error in a mailing
36011 list holds up all deliveries to the list. This may not be appropriate when a
36012 list is being maintained automatically from data supplied by users, and the
36013 addresses are not rigorously checked.
36014
36015 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36016 entries that fail to parse, noting the incident in the log. If in addition
36017 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36018 whenever a broken address is skipped. It is usually appropriate to set
36019 &%syntax_errors_to%& to the same address as &%errors_to%&.
36020
36021
36022
36023 .section "Re-expansion of mailing lists" "SECID242"
36024 .cindex "mailing lists" "re-expansion of"
36025 Exim remembers every individual address to which a message has been delivered,
36026 in order to avoid duplication, but it normally stores only the original
36027 recipient addresses with a message. If all the deliveries to a mailing list
36028 cannot be done at the first attempt, the mailing list is re-expanded when the
36029 delivery is next tried. This means that alterations to the list are taken into
36030 account at each delivery attempt, so addresses that have been added to
36031 the list since the message arrived will therefore receive a copy of the
36032 message, even though it pre-dates their subscription.
36033
36034 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36035 on the &(redirect)& router. If this is done, any addresses generated by the
36036 router that fail to deliver at the first attempt are added to the message as
36037 &"top level"& addresses, and the parent address that generated them is marked
36038 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36039 subsequent delivery attempts. The disadvantage of this is that if any of the
36040 failing addresses are incorrect, correcting them in the file has no effect on
36041 pre-existing messages.
36042
36043 The original top-level address is remembered with each of the generated
36044 addresses, and is output in any log messages. However, any intermediate parent
36045 addresses are not recorded. This makes a difference to the log only if the
36046 &%all_parents%& selector is set, but for mailing lists there is normally only
36047 one level of expansion anyway.
36048
36049
36050
36051 .section "Closed mailing lists" "SECID243"
36052 .cindex "mailing lists" "closed"
36053 The examples so far have assumed open mailing lists, to which anybody may
36054 send mail. It is also possible to set up closed lists, where mail is accepted
36055 from specified senders only. This is done by making use of the generic
36056 &%senders%& option to restrict the router that handles the list.
36057
36058 The following example uses the same file as a list of recipients and as a list
36059 of permitted senders. It requires three routers:
36060 .code
36061 lists_request:
36062   driver = redirect
36063   domains = lists.example
36064   local_part_suffix = -request
36065   file = /usr/lists/$local_part$local_part_suffix
36066   no_more
36067
36068 lists_post:
36069   driver = redirect
36070   domains = lists.example
36071   senders = ${if exists {/usr/lists/$local_part}\
36072              {lsearch;/usr/lists/$local_part}{*}}
36073   file = /usr/lists/$local_part
36074   forbid_pipe
36075   forbid_file
36076   errors_to = $local_part-request@lists.example
36077   no_more
36078
36079 lists_closed:
36080   driver = redirect
36081   domains = lists.example
36082   allow_fail
36083   data = :fail: $local_part@lists.example is a closed mailing list
36084 .endd
36085 All three routers have the same &%domains%& setting, so for any other domains,
36086 they are all skipped. The first router runs only if the local part ends in
36087 &%-request%&. It handles messages to the list manager(s) by means of an open
36088 mailing list.
36089
36090 The second router runs only if the &%senders%& precondition is satisfied. It
36091 checks for the existence of a list that corresponds to the local part, and then
36092 checks that the sender is on the list by means of a linear search. It is
36093 necessary to check for the existence of the file before trying to search it,
36094 because otherwise Exim thinks there is a configuration error. If the file does
36095 not exist, the expansion of &%senders%& is *, which matches all senders. This
36096 means that the router runs, but because there is no list, declines, and
36097 &%no_more%& ensures that no further routers are run. The address fails with an
36098 &"unrouteable address"& error.
36099
36100 The third router runs only if the second router is skipped, which happens when
36101 a mailing list exists, but the sender is not on it. This router forcibly fails
36102 the address, giving a suitable error message.
36103
36104
36105
36106
36107 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36108 .cindex "VERP"
36109 .cindex "Variable Envelope Return Paths"
36110 .cindex "envelope from"
36111 .cindex "envelope sender"
36112 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36113 are a way of helping mailing list administrators discover which subscription
36114 address is the cause of a particular delivery failure. The idea is to encode
36115 the original recipient address in the outgoing envelope sender address, so that
36116 if the message is forwarded by another host and then subsequently bounces, the
36117 original recipient can be extracted from the recipient address of the bounce.
36118
36119 .oindex &%errors_to%&
36120 .oindex &%return_path%&
36121 Envelope sender addresses can be modified by Exim using two different
36122 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36123 list examples), or the &%return_path%& option on a transport. The second of
36124 these is effective only if the message is successfully delivered to another
36125 host; it is not used for errors detected on the local host (see the description
36126 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36127 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36128 .code
36129 verp_smtp:
36130   driver = smtp
36131   max_rcpt = 1
36132   return_path = \
36133     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36134       {$1-request+$local_part=$domain@your.dom.example}fail}
36135 .endd
36136 This has the effect of rewriting the return path (envelope sender) on outgoing
36137 SMTP messages, if the local part of the original return path ends in
36138 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36139 local part and domain of the recipient into the return path. Suppose, for
36140 example, that a message whose return path has been set to
36141 &'somelist-request@your.dom.example'& is sent to
36142 &'subscriber@other.dom.example'&. In the transport, the return path is
36143 rewritten as
36144 .code
36145 somelist-request+subscriber=other.dom.example@your.dom.example
36146 .endd
36147 .vindex "&$local_part$&"
36148 For this to work, you must tell Exim to send multiple copies of messages that
36149 have more than one recipient, so that each copy has just one recipient. This is
36150 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36151 might be sent to several different recipients in the same domain, in which case
36152 &$local_part$& is not available in the transport, because it is not unique.
36153
36154 Unless your host is doing nothing but mailing list deliveries, you should
36155 probably use a separate transport for the VERP deliveries, so as not to use
36156 extra resources in making one-per-recipient copies for other deliveries. This
36157 can easily be done by expanding the &%transport%& option in the router:
36158 .code
36159 dnslookup:
36160   driver = dnslookup
36161   domains = ! +local_domains
36162   transport = \
36163     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36164       {verp_smtp}{remote_smtp}}
36165   no_more
36166 .endd
36167 If you want to change the return path using &%errors_to%& in a router instead
36168 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36169 routers that handle mailing list addresses. This will ensure that all delivery
36170 errors, including those detected on the local host, are sent to the VERP
36171 address.
36172
36173 On a host that does no local deliveries and has no manual routing, only the
36174 &(dnslookup)& router needs to be changed. A special transport is not needed for
36175 SMTP deliveries. Every mailing list recipient has its own return path value,
36176 and so Exim must hand them to the transport one at a time. Here is an example
36177 of a &(dnslookup)& router that implements VERP:
36178 .code
36179 verp_dnslookup:
36180   driver = dnslookup
36181   domains = ! +local_domains
36182   transport = remote_smtp
36183   errors_to = \
36184     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36185      {$1-request+$local_part=$domain@your.dom.example}fail}
36186   no_more
36187 .endd
36188 Before you start sending out messages with VERPed return paths, you must also
36189 configure Exim to accept the bounce messages that come back to those paths.
36190 Typically this is done by setting a &%local_part_suffix%& option for a
36191 router, and using this to route the messages to wherever you want to handle
36192 them.
36193
36194 The overhead incurred in using VERP depends very much on the size of the
36195 message, the number of recipient addresses that resolve to the same remote
36196 host, and the speed of the connection over which the message is being sent. If
36197 a lot of addresses resolve to the same host and the connection is slow, sending
36198 a separate copy of the message for each address may take substantially longer
36199 than sending a single copy with many recipients (for which VERP cannot be
36200 used).
36201
36202
36203
36204
36205
36206
36207 .section "Virtual domains" "SECTvirtualdomains"
36208 .cindex "virtual domains"
36209 .cindex "domain" "virtual"
36210 The phrase &'virtual domain'& is unfortunately used with two rather different
36211 meanings:
36212
36213 .ilist
36214 A domain for which there are no real mailboxes; all valid local parts are
36215 aliases for other email addresses. Common examples are organizational
36216 top-level domains and &"vanity"& domains.
36217 .next
36218 One of a number of independent domains that are all handled by the same host,
36219 with mailboxes on that host, but where the mailbox owners do not necessarily
36220 have login accounts on that host.
36221 .endlist
36222
36223 The first usage is probably more common, and does seem more &"virtual"& than
36224 the second. This kind of domain can be handled in Exim with a straightforward
36225 aliasing router. One approach is to create a separate alias file for each
36226 virtual domain. Exim can test for the existence of the alias file to determine
36227 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36228 to a router of this form:
36229 .code
36230 virtual:
36231   driver = redirect
36232   domains = dsearch;/etc/mail/virtual
36233   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36234   no_more
36235 .endd
36236 The &%domains%& option specifies that the router is to be skipped, unless there
36237 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36238 domain that is being processed. When the router runs, it looks up the local
36239 part in the file to find a new address (or list of addresses). The &%no_more%&
36240 setting ensures that if the lookup fails (leading to &%data%& being an empty
36241 string), Exim gives up on the address without trying any subsequent routers.
36242
36243 This one router can handle all the virtual domains because the alias filenames
36244 follow a fixed pattern. Permissions can be arranged so that appropriate people
36245 can edit the different alias files. A successful aliasing operation results in
36246 a new envelope recipient address, which is then routed from scratch.
36247
36248 The other kind of &"virtual"& domain can also be handled in a straightforward
36249 way. One approach is to create a file for each domain containing a list of
36250 valid local parts, and use it in a router like this:
36251 .code
36252 my_domains:
36253   driver = accept
36254   domains = dsearch;/etc/mail/domains
36255   local_parts = lsearch;/etc/mail/domains/$domain
36256   transport = my_mailboxes
36257 .endd
36258 The address is accepted if there is a file for the domain, and the local part
36259 can be found in the file. The &%domains%& option is used to check for the
36260 file's existence because &%domains%& is tested before the &%local_parts%&
36261 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36262 because that option is tested after &%local_parts%&. The transport is as
36263 follows:
36264 .code
36265 my_mailboxes:
36266   driver = appendfile
36267   file = /var/mail/$domain/$local_part
36268   user = mail
36269 .endd
36270 This uses a directory of mailboxes for each domain. The &%user%& setting is
36271 required, to specify which uid is to be used for writing to the mailboxes.
36272
36273 The configuration shown here is just one example of how you might support this
36274 requirement. There are many other ways this kind of configuration can be set
36275 up, for example, by using a database instead of separate files to hold all the
36276 information about the domains.
36277
36278
36279
36280 .section "Multiple user mailboxes" "SECTmulbox"
36281 .cindex "multiple mailboxes"
36282 .cindex "mailbox" "multiple"
36283 .cindex "local part" "prefix"
36284 .cindex "local part" "suffix"
36285 Heavy email users often want to operate with multiple mailboxes, into which
36286 incoming mail is automatically sorted. A popular way of handling this is to
36287 allow users to use multiple sender addresses, so that replies can easily be
36288 identified. Users are permitted to add prefixes or suffixes to their local
36289 parts for this purpose. The wildcard facility of the generic router options
36290 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36291 example, consider this router:
36292 .code
36293 userforward:
36294   driver = redirect
36295   check_local_user
36296   file = $home/.forward
36297   local_part_suffix = -*
36298   local_part_suffix_optional
36299   allow_filter
36300 .endd
36301 .vindex "&$local_part_suffix$&"
36302 It runs a user's &_.forward_& file for all local parts of the form
36303 &'username-*'&. Within the filter file the user can distinguish different
36304 cases by testing the variable &$local_part_suffix$&. For example:
36305 .code
36306 if $local_part_suffix contains -special then
36307 save /home/$local_part/Mail/special
36308 endif
36309 .endd
36310 If the filter file does not exist, or does not deal with such addresses, they
36311 fall through to subsequent routers, and, assuming no subsequent use of the
36312 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36313 control over which suffixes are valid.
36314
36315 Alternatively, a suffix can be used to trigger the use of a different
36316 &_.forward_& file &-- which is the way a similar facility is implemented in
36317 another MTA:
36318 .code
36319 userforward:
36320   driver = redirect
36321   check_local_user
36322   file = $home/.forward$local_part_suffix
36323   local_part_suffix = -*
36324   local_part_suffix_optional
36325   allow_filter
36326 .endd
36327 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36328 example, &_.forward-special_& is used. Once again, if the appropriate file
36329 does not exist, or does not deal with the address, it is passed on to
36330 subsequent routers, which could, if required, look for an unqualified
36331 &_.forward_& file to use as a default.
36332
36333
36334
36335 .section "Simplified vacation processing" "SECID244"
36336 .cindex "vacation processing"
36337 The traditional way of running the &'vacation'& program is for a user to set up
36338 a pipe command in a &_.forward_& file
36339 (see section &<<SECTspecitredli>>& for syntax details).
36340 This is prone to error by inexperienced users. There are two features of Exim
36341 that can be used to make this process simpler for users:
36342
36343 .ilist
36344 A local part prefix such as &"vacation-"& can be specified on a router which
36345 can cause the message to be delivered directly to the &'vacation'& program, or
36346 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36347 &_.forward_& file are then much simpler. For example:
36348 .code
36349 spqr, vacation-spqr
36350 .endd
36351 .next
36352 The &%require_files%& generic router option can be used to trigger a
36353 vacation delivery by checking for the existence of a certain file in the
36354 user's home directory. The &%unseen%& generic option should also be used, to
36355 ensure that the original delivery also proceeds. In this case, all the user has
36356 to do is to create a file called, say, &_.vacation_&, containing a vacation
36357 message.
36358 .endlist
36359
36360 Another advantage of both these methods is that they both work even when the
36361 use of arbitrary pipes by users is locked out.
36362
36363
36364
36365 .section "Taking copies of mail" "SECID245"
36366 .cindex "message" "copying every"
36367 Some installations have policies that require archive copies of all messages to
36368 be made. A single copy of each message can easily be taken by an appropriate
36369 command in a system filter, which could, for example, use a different file for
36370 each day's messages.
36371
36372 There is also a shadow transport mechanism that can be used to take copies of
36373 messages that are successfully delivered by local transports, one copy per
36374 delivery. This could be used, &'inter alia'&, to implement automatic
36375 notification of delivery by sites that insist on doing such things.
36376
36377
36378
36379 .section "Intermittently connected hosts" "SECID246"
36380 .cindex "intermittently connected hosts"
36381 It has become quite common (because it is cheaper) for hosts to connect to the
36382 Internet periodically rather than remain connected all the time. The normal
36383 arrangement is that mail for such hosts accumulates on a system that is
36384 permanently connected.
36385
36386 Exim was designed for use on permanently connected hosts, and so it is not
36387 particularly well-suited to use in an intermittently connected environment.
36388 Nevertheless there are some features that can be used.
36389
36390
36391 .section "Exim on the upstream server host" "SECID247"
36392 It is tempting to arrange for incoming mail for the intermittently connected
36393 host to remain in Exim's queue until the client connects. However, this
36394 approach does not scale very well. Two different kinds of waiting message are
36395 being mixed up in the same queue &-- those that cannot be delivered because of
36396 some temporary problem, and those that are waiting for their destination host
36397 to connect. This makes it hard to manage the queue, as well as wasting
36398 resources, because each queue runner scans the entire queue.
36399
36400 A better approach is to separate off those messages that are waiting for an
36401 intermittently connected host. This can be done by delivering these messages
36402 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36403 format, from where they are transmitted by other software when their
36404 destination connects. This makes it easy to collect all the mail for one host
36405 in a single directory, and to apply local timeout rules on a per-message basis
36406 if required.
36407
36408 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36409 you are doing this, you should configure Exim with a long retry period for the
36410 intermittent host. For example:
36411 .code
36412 cheshire.wonderland.fict.example    *   F,5d,24h
36413 .endd
36414 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36415 which messages it has queued up for that host. Once the intermittent host comes
36416 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36417 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36418 causes all the queued up messages to be delivered, often down a single SMTP
36419 connection. While the host remains connected, any new messages get delivered
36420 immediately.
36421
36422 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36423 issued with a different IP address each time it connects, Exim's retry
36424 mechanisms on the holding host get confused, because the IP address is normally
36425 used as part of the key string for holding retry information. This can be
36426 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36427 Since this has disadvantages for permanently connected hosts, it is best to
36428 arrange a separate transport for the intermittently connected ones.
36429
36430
36431
36432 .section "Exim on the intermittently connected client host" "SECID248"
36433 The value of &%smtp_accept_queue_per_connection%& should probably be
36434 increased, or even set to zero (that is, disabled) on the intermittently
36435 connected host, so that all incoming messages down a single connection get
36436 delivered immediately.
36437
36438 .cindex "SMTP" "passed connection"
36439 .cindex "SMTP" "multiple deliveries"
36440 .cindex "multiple SMTP deliveries"
36441 Mail waiting to be sent from an intermittently connected host will probably
36442 not have been routed, because without a connection DNS lookups are not
36443 possible. This means that if a normal queue run is done at connection time,
36444 each message is likely to be sent in a separate SMTP session. This can be
36445 avoided by starting the queue run with a command line option beginning with
36446 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36447 first pass, routing is done but no deliveries take place. The second pass is a
36448 normal queue run; since all the messages have been previously routed, those
36449 destined for the same host are likely to get sent as multiple deliveries in a
36450 single SMTP connection.
36451
36452
36453
36454 . ////////////////////////////////////////////////////////////////////////////
36455 . ////////////////////////////////////////////////////////////////////////////
36456
36457 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36458          "Exim as a non-queueing client"
36459 .cindex "client, non-queueing"
36460 .cindex "smart host" "suppressing queueing"
36461 On a personal computer, it is a common requirement for all
36462 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36463 configured to operate that way, for all the popular operating systems.
36464 However, there are some MUAs for Unix-like systems that cannot be so
36465 configured: they submit messages using the command line interface of
36466 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36467 messages this way.
36468
36469 If the personal computer runs continuously, there is no problem, because it can
36470 run a conventional MTA that handles delivery to the smart host, and deal with
36471 any delays via its queueing mechanism. However, if the computer does not run
36472 continuously or runs different operating systems at different times, queueing
36473 email is not desirable.
36474
36475 There is therefore a requirement for something that can provide the
36476 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36477 any queueing or retrying facilities. Furthermore, the delivery to the smart
36478 host should be synchronous, so that if it fails, the sending MUA is immediately
36479 informed. In other words, we want something that extends an MUA that submits
36480 to a local MTA via the command line so that it behaves like one that submits
36481 to a remote smart host using TCP/SMTP.
36482
36483 There are a number of applications (for example, there is one called &'ssmtp'&)
36484 that do this job. However, people have found them to be lacking in various
36485 ways. For instance, you might want to allow aliasing and forwarding to be done
36486 before sending a message to the smart host.
36487
36488 Exim already had the necessary infrastructure for doing this job. Just a few
36489 tweaks were needed to make it behave as required, though it is somewhat of an
36490 overkill to use a fully-featured MTA for this purpose.
36491
36492 .oindex "&%mua_wrapper%&"
36493 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36494 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36495 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36496 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36497 compatible router and transport configuration. Typically there will be just one
36498 router and one transport, sending everything to a smart host.
36499
36500 When run in MUA wrapping mode, the behaviour of Exim changes in the
36501 following ways:
36502
36503 .ilist
36504 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36505 In other words, the only way to submit messages is via the command line.
36506 .next
36507 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36508 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36509 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36510 does not finish until the delivery attempt is complete. If the delivery is
36511 successful, a zero return code is given.
36512 .next
36513 Address redirection is permitted, but the final routing for all addresses must
36514 be to the same remote transport, and to the same list of hosts. Furthermore,
36515 the return address (envelope sender) must be the same for all recipients, as
36516 must any added or deleted header lines. In other words, it must be possible to
36517 deliver the message in a single SMTP transaction, however many recipients there
36518 are.
36519 .next
36520 If these conditions are not met, or if routing any address results in a
36521 failure or defer status, or if Exim is unable to deliver all the recipients
36522 successfully to one of the smart hosts, delivery of the entire message fails.
36523 .next
36524 Because no queueing is allowed, all failures are treated as permanent; there
36525 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36526 smart host. Furthermore, because only a single yes/no response can be given to
36527 the caller, it is not possible to deliver to some recipients and not others. If
36528 there is an error (temporary or permanent) for any recipient, all are failed.
36529 .next
36530 If more than one smart host is listed, Exim will try another host after a
36531 connection failure or a timeout, in the normal way. However, if this kind of
36532 failure happens for all the hosts, the delivery fails.
36533 .next
36534 When delivery fails, an error message is written to the standard error stream
36535 (as well as to Exim's log), and Exim exits to the caller with a return code
36536 value 1. The message is expunged from Exim's spool files. No bounce messages
36537 are ever generated.
36538 .next
36539 No retry data is maintained, and any retry rules are ignored.
36540 .next
36541 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36542 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36543 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36544 .endlist
36545
36546 The overall effect is that Exim makes a single synchronous attempt to deliver
36547 the message, failing if there is any kind of problem. Because no local
36548 deliveries are done and no daemon can be run, Exim does not need root
36549 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36550 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36551 the advantages and disadvantages of running without root privilege.
36552
36553
36554
36555
36556 . ////////////////////////////////////////////////////////////////////////////
36557 . ////////////////////////////////////////////////////////////////////////////
36558
36559 .chapter "Log files" "CHAPlog"
36560 .scindex IIDloggen "log" "general description"
36561 .cindex "log" "types of"
36562 Exim writes three different logs, referred to as the main log, the reject log,
36563 and the panic log:
36564
36565 .ilist
36566 .cindex "main log"
36567 The main log records the arrival of each message and each delivery in a single
36568 line in each case. The format is as compact as possible, in an attempt to keep
36569 down the size of log files. Two-character flag sequences make it easy to pick
36570 out these lines. A number of other events are recorded in the main log. Some of
36571 them are optional, in which case the &%log_selector%& option controls whether
36572 they are included or not. A Perl script called &'eximstats'&, which does simple
36573 analysis of main log files, is provided in the Exim distribution (see section
36574 &<<SECTmailstat>>&).
36575 .next
36576 .cindex "reject log"
36577 The reject log records information from messages that are rejected as a result
36578 of a configuration option (that is, for policy reasons).
36579 The first line of each rejection is a copy of the line that is also written to
36580 the main log. Then, if the message's header has been read at the time the log
36581 is written, its contents are written to this log. Only the original header
36582 lines are available; header lines added by ACLs are not logged. You can use the
36583 reject log to check that your policy controls are working correctly; on a busy
36584 host this may be easier than scanning the main log for rejection messages. You
36585 can suppress the writing of the reject log by setting &%write_rejectlog%&
36586 false.
36587 .next
36588 .cindex "panic log"
36589 .cindex "system log"
36590 When certain serious errors occur, Exim writes entries to its panic log. If the
36591 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36592 are usually written to the main log as well, but can get lost amid the mass of
36593 other entries. The panic log should be empty under normal circumstances. It is
36594 therefore a good idea to check it (or to have a &'cron'& script check it)
36595 regularly, in order to become aware of any problems. When Exim cannot open its
36596 panic log, it tries as a last resort to write to the system log (syslog). This
36597 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36598 message itself is written at priority LOG_CRIT.
36599 .endlist
36600
36601 Every log line starts with a timestamp, in the format shown in the following
36602 example. Note that many of the examples shown in this chapter are line-wrapped.
36603 In the log file, this would be all on one line:
36604 .code
36605 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36606   by QUIT
36607 .endd
36608 By default, the timestamps are in the local timezone. There are two
36609 ways of changing this:
36610
36611 .ilist
36612 You can set the &%timezone%& option to a different time zone; in particular, if
36613 you set
36614 .code
36615 timezone = UTC
36616 .endd
36617 the timestamps will be in UTC (aka GMT).
36618 .next
36619 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36620 example:
36621 .code
36622 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36623 .endd
36624 .endlist
36625
36626 .cindex "log" "process ids in"
36627 .cindex "pid (process id)" "in log lines"
36628 Exim does not include its process id in log lines by default, but you can
36629 request that it does so by specifying the &`pid`& log selector (see section
36630 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36631 brackets, immediately after the time and date.
36632
36633
36634
36635
36636 .section "Where the logs are written" "SECTwhelogwri"
36637 .cindex "log" "destination"
36638 .cindex "log" "to file"
36639 .cindex "log" "to syslog"
36640 .cindex "syslog"
36641 The logs may be written to local files, or to syslog, or both. However, it
36642 should be noted that many syslog implementations use UDP as a transport, and
36643 are therefore unreliable in the sense that messages are not guaranteed to
36644 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36645 It has also been reported that on large log files (tens of megabytes) you may
36646 need to tweak syslog to prevent it syncing the file with each write &-- on
36647 Linux this has been seen to make syslog take 90% plus of CPU time.
36648
36649 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36650 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
36651 configuration. This latter string is expanded, so it can contain, for example,
36652 references to the host name:
36653 .code
36654 log_file_path = /var/log/$primary_hostname/exim_%slog
36655 .endd
36656 It is generally advisable, however, to set the string in &_Local/Makefile_&
36657 rather than at runtime, because then the setting is available right from the
36658 start of Exim's execution. Otherwise, if there's something it wants to log
36659 before it has read the configuration file (for example, an error in the
36660 configuration file) it will not use the path you want, and may not be able to
36661 log at all.
36662
36663 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36664 list, currently limited to at most two items. This is one option where the
36665 facility for changing a list separator may not be used. The list must always be
36666 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36667 otherwise the item must either be an absolute path, containing &`%s`& at the
36668 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36669 implying the use of a default path.
36670
36671 When Exim encounters an empty item in the list, it searches the list defined by
36672 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36673 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36674 mean &"use the path specified at build time"&. It no such item exists, log
36675 files are written in the &_log_& subdirectory of the spool directory. This is
36676 equivalent to the setting:
36677 .code
36678 log_file_path = $spool_directory/log/%slog
36679 .endd
36680 If you do not specify anything at build time or runtime,
36681 or if you unset the option at runtime (i.e. &`log_file_path = `&),
36682 that is where the logs are written.
36683
36684 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
36685 are in use &-- see section &<<SECTdatlogfil>>& below.
36686
36687 Here are some examples of possible settings:
36688 .display
36689 &`LOG_FILE_PATH=syslog                    `& syslog only
36690 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36691 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36692 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36693 .endd
36694 If there are more than two paths in the list, the first is used and a panic
36695 error is logged.
36696
36697
36698
36699 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36700 .cindex "log" "cycling local files"
36701 .cindex "cycling logs"
36702 .cindex "&'exicyclog'&"
36703 .cindex "log" "local files; writing to"
36704 Some operating systems provide centralized and standardized methods for cycling
36705 log files. For those that do not, a utility script called &'exicyclog'& is
36706 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36707 main and reject logs each time it is called. The maximum number of old logs to
36708 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36709
36710 An Exim delivery process opens the main log when it first needs to write to it,
36711 and it keeps the file open in case subsequent entries are required &-- for
36712 example, if a number of different deliveries are being done for the same
36713 message. However, remote SMTP deliveries can take a long time, and this means
36714 that the file may be kept open long after it is renamed if &'exicyclog'& or
36715 something similar is being used to rename log files on a regular basis. To
36716 ensure that a switch of log files is noticed as soon as possible, Exim calls
36717 &[stat()]& on the main log's name before reusing an open file, and if the file
36718 does not exist, or its inode has changed, the old file is closed and Exim
36719 tries to open the main log from scratch. Thus, an old log file may remain open
36720 for quite some time, but no Exim processes should write to it once it has been
36721 renamed.
36722
36723
36724
36725 .section "Datestamped log files" "SECTdatlogfil"
36726 .cindex "log" "datestamped files"
36727 Instead of cycling the main and reject log files by renaming them
36728 periodically, some sites like to use files whose names contain a datestamp,
36729 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36730 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36731 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36732 point where the datestamp is required. For example:
36733 .code
36734 log_file_path = /var/spool/exim/log/%slog-%D
36735 log_file_path = /var/log/exim-%s-%D.log
36736 log_file_path = /var/spool/exim/log/%D-%slog
36737 log_file_path = /var/log/exim/%s.%M
36738 .endd
36739 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36740 examples of names generated by the above examples:
36741 .code
36742 /var/spool/exim/log/mainlog-20021225
36743 /var/log/exim-reject-20021225.log
36744 /var/spool/exim/log/20021225-mainlog
36745 /var/log/exim/main.200212
36746 .endd
36747 When this form of log file is specified, Exim automatically switches to new
36748 files at midnight. It does not make any attempt to compress old logs; you
36749 will need to write your own script if you require this. You should not
36750 run &'exicyclog'& with this form of logging.
36751
36752 The location of the panic log is also determined by &%log_file_path%&, but it
36753 is not datestamped, because rotation of the panic log does not make sense.
36754 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36755 the string. In addition, if it immediately follows a slash, a following
36756 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36757 character is removed. Thus, the four examples above would give these panic
36758 log names:
36759 .code
36760 /var/spool/exim/log/paniclog
36761 /var/log/exim-panic.log
36762 /var/spool/exim/log/paniclog
36763 /var/log/exim/panic
36764 .endd
36765
36766
36767 .section "Logging to syslog" "SECID249"
36768 .cindex "log" "syslog; writing to"
36769 The use of syslog does not change what Exim logs or the format of its messages,
36770 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36771 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36772 that, the same strings are written to syslog as to log files. The syslog
36773 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36774 by default, but you can change these by setting the &%syslog_facility%& and
36775 &%syslog_processname%& options, respectively. If Exim was compiled with
36776 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36777 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36778 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36779 the time and host name to each line.
36780 The three log streams are mapped onto syslog priorities as follows:
36781
36782 .ilist
36783 &'mainlog'& is mapped to LOG_INFO
36784 .next
36785 &'rejectlog'& is mapped to LOG_NOTICE
36786 .next
36787 &'paniclog'& is mapped to LOG_ALERT
36788 .endlist
36789
36790 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
36791 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
36792 these are routed by syslog to the same place. You can suppress this duplication
36793 by setting &%syslog_duplication%& false.
36794
36795 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
36796 entries contain multiple lines when headers are included. To cope with both
36797 these cases, entries written to syslog are split into separate &[syslog()]&
36798 calls at each internal newline, and also after a maximum of
36799 870 data characters. (This allows for a total syslog line length of 1024, when
36800 additions such as timestamps are added.) If you are running a syslog
36801 replacement that can handle lines longer than the 1024 characters allowed by
36802 RFC 3164, you should set
36803 .code
36804 SYSLOG_LONG_LINES=yes
36805 .endd
36806 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
36807 lines, but it still splits at internal newlines in &'reject'& log entries.
36808
36809 To make it easy to re-assemble split lines later, each component of a split
36810 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
36811 where <&'n'&> is the component number and <&'m'&> is the total number of
36812 components in the entry. The / delimiter is used when the line was split
36813 because it was too long; if it was split because of an internal newline, the \
36814 delimiter is used. For example, supposing the length limit to be 50 instead of
36815 870, the following would be the result of a typical rejection message to
36816 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
36817 name, and pid as added by syslog:
36818 .code
36819 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
36820 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
36821 [3/5]  when scanning for sender: missing or malformed lo
36822 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
36823 [5/5] mple>)
36824 .endd
36825 The same error might cause the following lines to be written to &"rejectlog"&
36826 (LOG_NOTICE):
36827 .code
36828 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
36829 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
36830 [3/18] er when scanning for sender: missing or malformed
36831 [4/18]  local part in "<>" (envelope sender is <ph10@cam
36832 [5\18] .example>)
36833 [6\18] Recipients: ph10@some.domain.cam.example
36834 [7\18] P Received: from [127.0.0.1] (ident=ph10)
36835 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
36836 [9\18]        id 16RdAL-0006pc-00
36837 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
36838 [11\18] 09:43 +0100
36839 [12\18] F From: <>
36840 [13\18]   Subject: this is a test header
36841 [18\18]   X-something: this is another header
36842 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
36843 [16\18] le>
36844 [17\18] B Bcc:
36845 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
36846 .endd
36847 Log lines that are neither too long nor contain newlines are written to syslog
36848 without modification.
36849
36850 If only syslog is being used, the Exim monitor is unable to provide a log tail
36851 display, unless syslog is routing &'mainlog'& to a file on the local host and
36852 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
36853 where it is.
36854
36855
36856
36857 .section "Log line flags" "SECID250"
36858 One line is written to the main log for each message received, and for each
36859 successful, unsuccessful, and delayed delivery. These lines can readily be
36860 picked out by the distinctive two-character flags that immediately follow the
36861 timestamp. The flags are:
36862 .display
36863 &`<=`&     message arrival
36864 &`(=`&     message fakereject
36865 &`=>`&     normal message delivery
36866 &`->`&     additional address in same delivery
36867 &`>>`&     cutthrough message delivery
36868 &`*>`&     delivery suppressed by &%-N%&
36869 &`**`&     delivery failed; address bounced
36870 &`==`&     delivery deferred; temporary problem
36871 .endd
36872
36873
36874 .section "Logging message reception" "SECID251"
36875 .cindex "log" "reception line"
36876 The format of the single-line entry in the main log that is written for every
36877 message received is shown in the basic example below, which is split over
36878 several lines in order to fit it on the page:
36879 .code
36880 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
36881   H=mailer.fict.example [192.168.123.123] U=exim
36882   P=smtp S=5678 id=<incoming message id>
36883 .endd
36884 The address immediately following &"<="& is the envelope sender address. A
36885 bounce message is shown with the sender address &"<>"&, and if it is locally
36886 generated, this is followed by an item of the form
36887 .code
36888 R=<message id>
36889 .endd
36890 which is a reference to the message that caused the bounce to be sent.
36891
36892 .cindex "HELO"
36893 .cindex "EHLO"
36894 For messages from other hosts, the H and U fields identify the remote host and
36895 record the RFC 1413 identity of the user that sent the message, if one was
36896 received. The number given in square brackets is the IP address of the sending
36897 host. If there is a single, unparenthesized  host name in the H field, as
36898 above, it has been verified to correspond to the IP address (see the
36899 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
36900 by the remote host in the SMTP HELO or EHLO command, and has not been
36901 verified. If verification yields a different name to that given for HELO or
36902 EHLO, the verified name appears first, followed by the HELO or EHLO
36903 name in parentheses.
36904
36905 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
36906 without brackets, in the HELO or EHLO command, leading to entries in
36907 the log containing text like these examples:
36908 .code
36909 H=(10.21.32.43) [192.168.8.34]
36910 H=([10.21.32.43]) [192.168.8.34]
36911 .endd
36912 This can be confusing. Only the final address in square brackets can be relied
36913 on.
36914
36915 For locally generated messages (that is, messages not received over TCP/IP),
36916 the H field is omitted, and the U field contains the login name of the caller
36917 of Exim.
36918
36919 .cindex "authentication" "logging"
36920 .cindex "AUTH" "logging"
36921 For all messages, the P field specifies the protocol used to receive the
36922 message. This is the value that is stored in &$received_protocol$&. In the case
36923 of incoming SMTP messages, the value indicates whether or not any SMTP
36924 extensions (ESMTP), encryption, or authentication were used. If the SMTP
36925 session was encrypted, there is an additional X field that records the cipher
36926 suite that was used.
36927
36928 .cindex log protocol
36929 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
36930 hosts that have authenticated themselves using the SMTP AUTH command. The first
36931 value is used when the SMTP connection was encrypted (&"secure"&). In this case
36932 there is an additional item A= followed by the name of the authenticator that
36933 was used. If an authenticated identification was set up by the authenticator's
36934 &%server_set_id%& option, this is logged too, separated by a colon from the
36935 authenticator name.
36936
36937 .cindex "size" "of message"
36938 The id field records the existing message id, if present. The size of the
36939 received message is given by the S field. When the message is delivered,
36940 headers may be removed or added, so that the size of delivered copies of the
36941 message may not correspond with this value (and indeed may be different to each
36942 other).
36943
36944 The &%log_selector%& option can be used to request the logging of additional
36945 data when a message is received. See section &<<SECTlogselector>>& below.
36946
36947
36948
36949 .section "Logging deliveries" "SECID252"
36950 .cindex "log" "delivery line"
36951 The format of the single-line entry in the main log that is written for every
36952 delivery is shown in one of the examples below, for local and remote
36953 deliveries, respectively. Each example has been split into multiple lines in order
36954 to fit it on the page:
36955 .code
36956 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
36957   <marv@hitch.fict.example> R=localuser T=local_delivery
36958 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
36959   monk@holistic.fict.example R=dnslookup T=remote_smtp
36960   H=holistic.fict.example [192.168.234.234]
36961 .endd
36962 For ordinary local deliveries, the original address is given in angle brackets
36963 after the final delivery address, which might be a pipe or a file. If
36964 intermediate address(es) exist between the original and the final address, the
36965 last of these is given in parentheses after the final address. The R and T
36966 fields record the router and transport that were used to process the address.
36967
36968 If SMTP AUTH was used for the delivery there is an additional item A=
36969 followed by the name of the authenticator that was used.
36970 If an authenticated identification was set up by the authenticator's &%client_set_id%&
36971 option, this is logged too, separated by a colon from the authenticator name.
36972
36973 If a shadow transport was run after a successful local delivery, the log line
36974 for the successful delivery has an item added on the end, of the form
36975 .display
36976 &`ST=<`&&'shadow transport name'&&`>`&
36977 .endd
36978 If the shadow transport did not succeed, the error message is put in
36979 parentheses afterwards.
36980
36981 .cindex "asterisk" "after IP address"
36982 When more than one address is included in a single delivery (for example, two
36983 SMTP RCPT commands in one transaction) the second and subsequent addresses are
36984 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
36985 down a single SMTP connection, an asterisk follows the IP address in the log
36986 lines for the second and subsequent messages.
36987 When two or more messages are delivered down a single TLS connection, the
36988 DNS and some TLS-related information logged for the first message delivered
36989 will not be present in the log lines for the second and subsequent messages.
36990 TLS cipher information is still available.
36991
36992 .cindex "delivery" "cutthrough; logging"
36993 .cindex "cutthrough" "logging"
36994 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
36995 line precedes the reception line, since cutthrough waits for a possible
36996 rejection from the destination in case it can reject the sourced item.
36997
36998 The generation of a reply message by a filter file gets logged as a
36999 &"delivery"& to the addressee, preceded by &">"&.
37000
37001 The &%log_selector%& option can be used to request the logging of additional
37002 data when a message is delivered. See section &<<SECTlogselector>>& below.
37003
37004
37005 .section "Discarded deliveries" "SECID253"
37006 .cindex "discarded messages"
37007 .cindex "message" "discarded"
37008 .cindex "delivery" "discarded; logging"
37009 When a message is discarded as a result of the command &"seen finish"& being
37010 obeyed in a filter file which generates no deliveries, a log entry of the form
37011 .code
37012 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37013   <low.club@bridge.example> R=userforward
37014 .endd
37015 is written, to record why no deliveries are logged. When a message is discarded
37016 because it is aliased to &":blackhole:"& the log line is like this:
37017 .code
37018 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37019   <hole@nowhere.example> R=blackhole_router
37020 .endd
37021
37022
37023 .section "Deferred deliveries" "SECID254"
37024 When a delivery is deferred, a line of the following form is logged:
37025 .code
37026 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37027   R=dnslookup T=smtp defer (146): Connection refused
37028 .endd
37029 In the case of remote deliveries, the error is the one that was given for the
37030 last IP address that was tried. Details of individual SMTP failures are also
37031 written to the log, so the above line would be preceded by something like
37032 .code
37033 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37034   mail1.endrest.example [192.168.239.239]: Connection refused
37035 .endd
37036 When a deferred address is skipped because its retry time has not been reached,
37037 a message is written to the log, but this can be suppressed by setting an
37038 appropriate value in &%log_selector%&.
37039
37040
37041
37042 .section "Delivery failures" "SECID255"
37043 .cindex "delivery" "failure; logging"
37044 If a delivery fails because an address cannot be routed, a line of the
37045 following form is logged:
37046 .code
37047 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37048   <jim@trek99.example>: unknown mail domain
37049 .endd
37050 If a delivery fails at transport time, the router and transport are shown, and
37051 the response from the remote host is included, as in this example:
37052 .code
37053 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37054   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37055   after pipelined RCPT TO:<ace400@pb.example>: host
37056   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37057   <ace400@pb.example>...Addressee unknown
37058 .endd
37059 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37060 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37061 disabling PIPELINING. The log lines for all forms of delivery failure are
37062 flagged with &`**`&.
37063
37064
37065
37066 .section "Fake deliveries" "SECID256"
37067 .cindex "delivery" "fake; logging"
37068 If a delivery does not actually take place because the &%-N%& option has been
37069 used to suppress it, a normal delivery line is written to the log, except that
37070 &"=>"& is replaced by &"*>"&.
37071
37072
37073
37074 .section "Completion" "SECID257"
37075 A line of the form
37076 .code
37077 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37078 .endd
37079 is written to the main log when a message is about to be removed from the spool
37080 at the end of its processing.
37081
37082
37083
37084
37085 .section "Summary of Fields in Log Lines" "SECID258"
37086 .cindex "log" "summary of fields"
37087 A summary of the field identifiers that are used in log lines is shown in
37088 the following table:
37089 .display
37090 &`A   `&        authenticator name (and optional id and sender)
37091 &`C   `&        SMTP confirmation on delivery
37092 &`    `&        command list for &"no mail in SMTP session"&
37093 &`CV  `&        certificate verification status
37094 &`D   `&        duration of &"no mail in SMTP session"&
37095 &`DKIM`&        domain verified in incoming message
37096 &`DN  `&        distinguished name from peer certificate
37097 &`DS  `&        DNSSEC secured lookups
37098 &`DT  `&        on &`=>`& lines: time taken for a delivery
37099 &`F   `&        sender address (on delivery lines)
37100 &`H   `&        host name and IP address
37101 &`I   `&        local interface used
37102 &`id  `&        message id (from header) for incoming message
37103 &`K   `&        CHUNKING extension used
37104 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37105 &`M8S `&        8BITMIME status for incoming message
37106 &`P   `&        on &`<=`& lines: protocol used
37107 &`    `&        on &`=>`& and &`**`& lines: return path
37108 &`PRDR`&        PRDR extension used
37109 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37110 &`Q   `&        alternate queue name
37111 &`QT  `&        on &`=>`& lines: time spent on queue so far
37112 &`    `&        on &"Completed"& lines: time spent on queue
37113 &`R   `&        on &`<=`& lines: reference for local bounce
37114 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37115 &`RT  `&        on &`<=`& lines: time taken for reception
37116 &`S   `&        size of message in bytes
37117 &`SNI `&        server name indication from TLS client hello
37118 &`ST  `&        shadow transport name
37119 &`T   `&        on &`<=`& lines: message subject (topic)
37120 &`TFO `&        connection took advantage of TCP Fast Open
37121 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37122 &`U   `&        local user or RFC 1413 identity
37123 &`X   `&        TLS cipher suite
37124 .endd
37125
37126
37127 .section "Other log entries" "SECID259"
37128 Various other types of log entry are written from time to time. Most should be
37129 self-explanatory. Among the more common are:
37130
37131 .ilist
37132 .cindex "retry" "time not reached"
37133 &'retry time not reached'&&~&~An address previously suffered a temporary error
37134 during routing or local delivery, and the time to retry has not yet arrived.
37135 This message is not written to an individual message log file unless it happens
37136 during the first delivery attempt.
37137 .next
37138 &'retry time not reached for any host'&&~&~An address previously suffered
37139 temporary errors during remote delivery, and the retry time has not yet arrived
37140 for any of the hosts to which it is routed.
37141 .next
37142 .cindex "spool directory" "file locked"
37143 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37144 some other Exim process is already working on the message. This can be quite
37145 common if queue running processes are started at frequent intervals. The
37146 &'exiwhat'& utility script can be used to find out what Exim processes are
37147 doing.
37148 .next
37149 .cindex "error" "ignored"
37150 &'error ignored'&&~&~There are several circumstances that give rise to this
37151 message:
37152 .olist
37153 Exim failed to deliver a bounce message whose age was greater than
37154 &%ignore_bounce_errors_after%&. The bounce was discarded.
37155 .next
37156 A filter file set up a delivery using the &"noerror"& option, and the delivery
37157 failed. The delivery was discarded.
37158 .next
37159 A delivery set up by a router configured with
37160 . ==== As this is a nested list, any displays it contains must be indented
37161 . ==== as otherwise they are too far to the left.
37162 .code
37163     errors_to = <>
37164 .endd
37165 failed. The delivery was discarded.
37166 .endlist olist
37167 .next
37168 .cindex DKIM "log line"
37169 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37170 logging and the message has a DKIM signature header.
37171 .endlist ilist
37172
37173
37174
37175
37176
37177 .section "Reducing or increasing what is logged" "SECTlogselector"
37178 .cindex "log" "selectors"
37179 By setting the &%log_selector%& global option, you can disable some of Exim's
37180 default logging, or you can request additional logging. The value of
37181 &%log_selector%& is made up of names preceded by plus or minus characters. For
37182 example:
37183 .code
37184 log_selector = +arguments -retry_defer
37185 .endd
37186 The list of optional log items is in the following table, with the default
37187 selection marked by asterisks:
37188 .display
37189 &` 8bitmime                   `&  received 8BITMIME status
37190 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37191 &` address_rewrite            `&  address rewriting
37192 &` all_parents                `&  all parents in => lines
37193 &` arguments                  `&  command line arguments
37194 &`*connection_reject          `&  connection rejections
37195 &`*delay_delivery             `&  immediate delivery delayed
37196 &` deliver_time               `&  time taken to perform delivery
37197 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37198 &`*dkim                       `&  DKIM verified domain on <= lines
37199 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37200 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37201 &` dnssec                     `&  DNSSEC secured lookups
37202 &`*etrn                       `&  ETRN commands
37203 &`*host_lookup_failed         `&  as it says
37204 &` ident_timeout              `&  timeout for ident connection
37205 &` incoming_interface         `&  local interface on <= and => lines
37206 &` incoming_port              `&  remote port on <= lines
37207 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37208 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37209 &`*msg_id                     `&  on <= lines, Message-ID: header value
37210 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37211 &` outgoing_interface         `&  local interface on => lines
37212 &` outgoing_port              `&  add remote port to => lines
37213 &`*queue_run                  `&  start and end queue runs
37214 &` queue_time                 `&  time on queue for one recipient
37215 &` queue_time_overall         `&  time on queue for whole message
37216 &` pid                        `&  Exim process id
37217 &` pipelining                 `&  PIPELINING use, on <= and => lines
37218 &` proxy                      `&  proxy address on <= and => lines
37219 &` receive_time               `&  time taken to receive message
37220 &` received_recipients        `&  recipients on <= lines
37221 &` received_sender            `&  sender on <= lines
37222 &`*rejected_header            `&  header contents on reject log
37223 &`*retry_defer                `&  &"retry time not reached"&
37224 &` return_path_on_delivery    `&  put return path on => and ** lines
37225 &` sender_on_delivery         `&  add sender to => lines
37226 &`*sender_verify_fail         `&  sender verification failures
37227 &`*size_reject                `&  rejection because too big
37228 &`*skip_delivery              `&  delivery skipped in a queue run
37229 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37230 &` smtp_connection            `&  incoming SMTP connections
37231 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37232 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37233 &` smtp_no_mail               `&  session with no MAIL commands
37234 &` smtp_protocol_error        `&  SMTP protocol errors
37235 &` smtp_syntax_error          `&  SMTP syntax errors
37236 &` subject                    `&  contents of &'Subject:'& on <= lines
37237 &`*tls_certificate_verified   `&  certificate verification status
37238 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37239 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37240 &` tls_sni                    `&  TLS SNI on <= lines
37241 &` unknown_in_list            `&  DNS lookup failed in list match
37242
37243 &` all                        `&  all of the above
37244 .endd
37245 See also the &%slow_lookup_log%& main configuration option,
37246 section &<<SECID99>>&
37247
37248 More details on each of these items follows:
37249
37250 .ilist
37251 .cindex "8BITMIME"
37252 .cindex "log" "8BITMIME"
37253 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37254 which may help in tracking down interoperability issues with ancient MTAs
37255 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37256 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37257 &`7BIT`& and &`8BITMIME`& respectively.
37258 .next
37259 .cindex "&%warn%& ACL verb" "log when skipping"
37260 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37261 its conditions cannot be evaluated, a log line to this effect is written if
37262 this log selector is set.
37263 .next
37264 .cindex "log" "rewriting"
37265 .cindex "rewriting" "logging"
37266 &%address_rewrite%&: This applies both to global rewrites and per-transport
37267 rewrites, but not to rewrites in filters run as an unprivileged user (because
37268 such users cannot access the log).
37269 .next
37270 .cindex "log" "full parentage"
37271 &%all_parents%&: Normally only the original and final addresses are logged on
37272 delivery lines; with this selector, intermediate parents are given in
37273 parentheses between them.
37274 .next
37275 .cindex "log" "Exim arguments"
37276 .cindex "Exim arguments, logging"
37277 &%arguments%&: This causes Exim to write the arguments with which it was called
37278 to the main log, preceded by the current working directory. This is a debugging
37279 feature, added to make it easier to find out how certain MUAs call
37280 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37281 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37282 that are empty or that contain white space are quoted. Non-printing characters
37283 are shown as escape sequences. This facility cannot log unrecognized arguments,
37284 because the arguments are checked before the configuration file is read. The
37285 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37286 between the caller and Exim.
37287 .next
37288 .cindex "log" "connection rejections"
37289 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37290 connection is rejected, for whatever reason.
37291 .next
37292 .cindex "log" "delayed delivery"
37293 .cindex "delayed delivery, logging"
37294 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37295 started for an incoming message because the load is too high or too many
37296 messages were received on one connection. Logging does not occur if no delivery
37297 process is started because &%queue_only%& is set or &%-odq%& was used.
37298 .next
37299 .cindex "log" "delivery duration"
37300 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37301 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37302 If millisecond logging is enabled, short times will be shown with greater
37303 precision, eg. &`DT=0.304s`&.
37304 .next
37305 .cindex "log" "message size on delivery"
37306 .cindex "size" "of message"
37307 &%delivery_size%&: For each delivery, the size of message delivered is added to
37308 the &"=>"& line, tagged with S=.
37309 .next
37310 .cindex log "DKIM verification"
37311 .cindex DKIM "verification logging"
37312 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37313 verifies successfully a tag of DKIM is added, with one of the verified domains.
37314 .next
37315 .cindex log "DKIM verification"
37316 .cindex DKIM "verification logging"
37317 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37318 .next
37319 .cindex "log" "dnslist defer"
37320 .cindex "DNS list" "logging defer"
37321 .cindex "black list (DNS)"
37322 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37323 DNS black list suffers a temporary error.
37324 .next
37325 .cindex log dnssec
37326 .cindex dnssec logging
37327 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37328 dns lookups gave secure results a tag of DS is added.
37329 For acceptance this covers the reverse and forward lookups for host name verification.
37330 It does not cover helo-name verification.
37331 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37332 .next
37333 .cindex "log" "ETRN commands"
37334 .cindex "ETRN" "logging"
37335 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37336 is run to determine whether or not it is actually accepted. An invalid ETRN
37337 command, or one received within a message transaction is not logged by this
37338 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37339 .next
37340 .cindex "log" "host lookup failure"
37341 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37342 any addresses, or when a lookup of an IP address fails to find a host name, a
37343 log line is written. This logging does not apply to direct DNS lookups when
37344 routing email addresses, but it does apply to &"byname"& lookups.
37345 .next
37346 .cindex "log" "ident timeout"
37347 .cindex "RFC 1413" "logging timeout"
37348 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37349 client's ident port times out.
37350 .next
37351 .cindex "log" "incoming interface"
37352 .cindex "log" "local interface"
37353 .cindex "log" "local address and port"
37354 .cindex "TCP/IP" "logging local address and port"
37355 .cindex "interface" "logging"
37356 &%incoming_interface%&: The interface on which a message was received is added
37357 to the &"<="& line as an IP address in square brackets, tagged by I= and
37358 followed by a colon and the port number. The local interface and port are also
37359 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37360 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37361 The latter can be disabled by turning off the &%outgoing_interface%& option.
37362 .next
37363 .cindex log "incoming proxy address"
37364 .cindex proxy "logging proxy address"
37365 .cindex "TCP/IP" "logging proxy address"
37366 &%proxy%&: The internal (closest to the system running Exim) IP address
37367 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37368 on a proxied connection
37369 or the &"=>"& line for a message delivered on a proxied connection.
37370 See &<<SECTproxyInbound>>& for more information.
37371 .next
37372 .cindex "log" "incoming remote port"
37373 .cindex "port" "logging remote"
37374 .cindex "TCP/IP" "logging incoming remote port"
37375 .vindex "&$sender_fullhost$&"
37376 .vindex "&$sender_rcvhost$&"
37377 &%incoming_port%&: The remote port number from which a message was received is
37378 added to log entries and &'Received:'& header lines, following the IP address
37379 in square brackets, and separated from it by a colon. This is implemented by
37380 changing the value that is put in the &$sender_fullhost$& and
37381 &$sender_rcvhost$& variables. Recording the remote port number has become more
37382 important with the widening use of NAT (see RFC 2505).
37383 .next
37384 .cindex "log" "dropped connection"
37385 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37386 connection is unexpectedly dropped.
37387 .next
37388 .cindex "log" "millisecond timestamps"
37389 .cindex millisecond logging
37390 .cindex timestamps "millisecond, in logs"
37391 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37392 appended to the seconds value.
37393 .next
37394 .new
37395 .cindex "log" "message id"
37396 &%msg_id%&: The value of the Message-ID: header.
37397 .next
37398 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37399 This will be either because the message is a bounce, or was submitted locally
37400 (submission mode) without one.
37401 The field identifier will have an asterix appended: &"id*="&.
37402 .wen
37403 .next
37404 .cindex "log" "outgoing interface"
37405 .cindex "log" "local interface"
37406 .cindex "log" "local address and port"
37407 .cindex "TCP/IP" "logging local address and port"
37408 .cindex "interface" "logging"
37409 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37410 interface on which a message was sent is added to delivery lines as an I= tag
37411 followed by IP address in square brackets. You can disable this by turning
37412 off the &%outgoing_interface%& option.
37413 .next
37414 .cindex "log" "outgoing remote port"
37415 .cindex "port" "logging outgoing remote"
37416 .cindex "TCP/IP" "logging outgoing remote port"
37417 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37418 containing => tags) following the IP address.
37419 The local port is also added if &%incoming_interface%& and
37420 &%outgoing_interface%& are both enabled.
37421 This option is not included in the default setting, because for most ordinary
37422 configurations, the remote port number is always 25 (the SMTP port), and the
37423 local port is a random ephemeral port.
37424 .next
37425 .cindex "log" "process ids in"
37426 .cindex "pid (process id)" "in log lines"
37427 &%pid%&: The current process id is added to every log line, in square brackets,
37428 immediately after the time and date.
37429 .next
37430 .cindex log pipelining
37431 .cindex pipelining "logging outgoing"
37432 &%pipelining%&: A field is added to delivery and accept
37433 log lines when the ESMTP PIPELINING extension was used.
37434 The field is a single "L".
37435
37436 On accept lines, where PIPELINING was offered but not used by the client,
37437 the field has a minus appended.
37438
37439 .new
37440 .cindex "pipelining" "early connection"
37441 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37442 accept "L" fields have a period appended if the feature was
37443 offered but not used, or an asterisk appended if used.
37444 Delivery "L" fields have an asterisk appended if used.
37445 .wen
37446
37447 .next
37448 .cindex "log" "queue run"
37449 .cindex "queue runner" "logging"
37450 &%queue_run%&: The start and end of every queue run are logged.
37451 .next
37452 .cindex "log" "queue time"
37453 &%queue_time%&: The amount of time the message has been in the queue on the
37454 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37455 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37456 includes reception time as well as the delivery time for the current address.
37457 This means that it may be longer than the difference between the arrival and
37458 delivery log line times, because the arrival log line is not written until the
37459 message has been successfully received.
37460 If millisecond logging is enabled, short times will be shown with greater
37461 precision, eg. &`QT=1.578s`&.
37462 .next
37463 &%queue_time_overall%&: The amount of time the message has been in the queue on
37464 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37465 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37466 message, so it includes reception time as well as the total delivery time.
37467 .next
37468 .cindex "log" "receive duration"
37469 &%receive_time%&: For each message, the amount of real time it has taken to
37470 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37471 If millisecond logging is enabled, short times will be shown with greater
37472 precision, eg. &`RT=0.204s`&.
37473 .next
37474 .cindex "log" "recipients"
37475 &%received_recipients%&: The recipients of a message are listed in the main log
37476 as soon as the message is received. The list appears at the end of the log line
37477 that is written when a message is received, preceded by the word &"for"&. The
37478 addresses are listed after they have been qualified, but before any rewriting
37479 has taken place.
37480 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37481 in the list.
37482 .next
37483 .cindex "log" "sender reception"
37484 &%received_sender%&: The unrewritten original sender of a message is added to
37485 the end of the log line that records the message's arrival, after the word
37486 &"from"& (before the recipients if &%received_recipients%& is also set).
37487 .next
37488 .cindex "log" "header lines for rejection"
37489 &%rejected_header%&: If a message's header has been received at the time a
37490 rejection is written to the reject log, the complete header is added to the
37491 log. Header logging can be turned off individually for messages that are
37492 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37493 .next
37494 .cindex "log" "retry defer"
37495 &%retry_defer%&: A log line is written if a delivery is deferred because a
37496 retry time has not yet been reached. However, this &"retry time not reached"&
37497 message is always omitted from individual message logs after the first delivery
37498 attempt.
37499 .next
37500 .cindex "log" "return path"
37501 &%return_path_on_delivery%&: The return path that is being transmitted with
37502 the message is included in delivery and bounce lines, using the tag P=.
37503 This is omitted if no delivery actually happens, for example, if routing fails,
37504 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37505 .next
37506 .cindex "log" "sender on delivery"
37507 &%sender_on_delivery%&: The message's sender address is added to every delivery
37508 and bounce line, tagged by F= (for &"from"&).
37509 This is the original sender that was received with the message; it is not
37510 necessarily the same as the outgoing return path.
37511 .next
37512 .cindex "log" "sender verify failure"
37513 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37514 gives details of a sender verification failure is not written. Log lines for
37515 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37516 detail is lost.
37517 .next
37518 .cindex "log" "size rejection"
37519 &%size_reject%&: A log line is written whenever a message is rejected because
37520 it is too big.
37521 .next
37522 .cindex "log" "frozen messages; skipped"
37523 .cindex "frozen messages" "logging skipping"
37524 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37525 queue run because it is frozen or because another process is already delivering
37526 it.
37527 .cindex "&""spool file is locked""&"
37528 The message that is written is &"spool file is locked"&.
37529 .next
37530 .cindex "log" "smtp confirmation"
37531 .cindex "SMTP" "logging confirmation"
37532 .cindex "LMTP" "logging confirmation"
37533 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37534 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37535 A number of MTAs (including Exim) return an identifying string in this
37536 response.
37537 .next
37538 .cindex "log" "SMTP connections"
37539 .cindex "SMTP" "logging connections"
37540 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37541 established or closed, unless the connection is from a host that matches
37542 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37543 only when the closure is unexpected.) This applies to connections from local
37544 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37545 dropped in the middle of a message, a log line is always written, whether or
37546 not this selector is set, but otherwise nothing is written at the start and end
37547 of connections unless this selector is enabled.
37548
37549 For TCP/IP connections to an Exim daemon, the current number of connections is
37550 included in the log message for each new connection, but note that the count is
37551 reset if the daemon is restarted.
37552 Also, because connections are closed (and the closure is logged) in
37553 subprocesses, the count may not include connections that have been closed but
37554 whose termination the daemon has not yet noticed. Thus, while it is possible to
37555 match up the opening and closing of connections in the log, the value of the
37556 logged counts may not be entirely accurate.
37557 .next
37558 .cindex "log" "SMTP transaction; incomplete"
37559 .cindex "SMTP" "logging incomplete transactions"
37560 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37561 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37562 and the message sender plus any accepted recipients are included in the log
37563 line. This can provide evidence of dictionary attacks.
37564 .next
37565 .cindex "log" "non-MAIL SMTP sessions"
37566 .cindex "MAIL" "logging session without"
37567 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37568 connection terminates without having issued a MAIL command. This includes both
37569 the case when the connection is dropped, and the case when QUIT is used. It
37570 does not include cases where the connection is rejected right at the start (by
37571 an ACL, or because there are too many connections, or whatever). These cases
37572 already have their own log lines.
37573
37574 The log line that is written contains the identity of the client in the usual
37575 way, followed by D= and a time, which records the duration of the connection.
37576 If the connection was authenticated, this fact is logged exactly as it is for
37577 an incoming message, with an A= item. If the connection was encrypted, CV=,
37578 DN=, and X= items may appear as they do for an incoming message, controlled by
37579 the same logging options.
37580
37581 Finally, if any SMTP commands were issued during the connection, a C= item
37582 is added to the line, listing the commands that were used. For example,
37583 .code
37584 C=EHLO,QUIT
37585 .endd
37586 shows that the client issued QUIT straight after EHLO. If there were fewer
37587 than 20 commands, they are all listed. If there were more than 20 commands,
37588 the last 20 are listed, preceded by &"..."&. However, with the default
37589 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37590 have been aborted before 20 non-mail commands are processed.
37591 .next
37592 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37593 colon-separated, is appended to the A= item for a message arrival or delivery
37594 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37595 was accepted or used.
37596 .next
37597 .cindex "log" "SMTP protocol error"
37598 .cindex "SMTP" "logging protocol error"
37599 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37600 encountered. Exim does not have perfect detection of all protocol errors
37601 because of transmission delays and the use of pipelining. If PIPELINING has
37602 been advertised to a client, an Exim server assumes that the client will use
37603 it, and therefore it does not count &"expected"& errors (for example, RCPT
37604 received after rejecting MAIL) as protocol errors.
37605 .next
37606 .cindex "SMTP" "logging syntax errors"
37607 .cindex "SMTP" "syntax errors; logging"
37608 .cindex "SMTP" "unknown command; logging"
37609 .cindex "log" "unknown SMTP command"
37610 .cindex "log" "SMTP syntax error"
37611 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37612 encountered. An unrecognized command is treated as a syntax error. For an
37613 external connection, the host identity is given; for an internal connection
37614 using &%-bs%& the sender identification (normally the calling user) is given.
37615 .next
37616 .cindex "log" "subject"
37617 .cindex "subject, logging"
37618 &%subject%&: The subject of the message is added to the arrival log line,
37619 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37620 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37621 specifies whether characters with values greater than 127 should be logged
37622 unchanged, or whether they should be rendered as escape sequences.
37623 .next
37624 .cindex "log" "certificate verification"
37625 .cindex log DANE
37626 .cindex DANE logging
37627 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37628 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37629 verified
37630 using a CA trust anchor,
37631 &`CA=dane`& if using a DNS trust anchor,
37632 and &`CV=no`& if not.
37633 .next
37634 .cindex "log" "TLS cipher"
37635 .cindex "TLS" "logging cipher"
37636 &%tls_cipher%&: When a message is sent or received over an encrypted
37637 connection, the cipher suite used is added to the log line, preceded by X=.
37638 .next
37639 .cindex "log" "TLS peer DN"
37640 .cindex "TLS" "logging peer DN"
37641 &%tls_peerdn%&: When a message is sent or received over an encrypted
37642 connection, and a certificate is supplied by the remote host, the peer DN is
37643 added to the log line, preceded by DN=.
37644 .next
37645 .cindex "log" "TLS SNI"
37646 .cindex "TLS" "logging SNI"
37647 &%tls_sni%&: When a message is received over an encrypted connection, and
37648 the remote host provided the Server Name Indication extension, the SNI is
37649 added to the log line, preceded by SNI=.
37650 .next
37651 .cindex "log" "DNS failure in list"
37652 &%unknown_in_list%&: This setting causes a log entry to be written when the
37653 result of a list match is failure because a DNS lookup failed.
37654 .endlist
37655
37656
37657 .section "Message log" "SECID260"
37658 .cindex "message" "log file for"
37659 .cindex "log" "message log; description of"
37660 .cindex "&_msglog_& directory"
37661 .oindex "&%preserve_message_logs%&"
37662 In addition to the general log files, Exim writes a log file for each message
37663 that it handles. The names of these per-message logs are the message ids, and
37664 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37665 message log contains copies of the log lines that apply to the message. This
37666 makes it easier to inspect the status of an individual message without having
37667 to search the main log. A message log is deleted when processing of the message
37668 is complete, unless &%preserve_message_logs%& is set, but this should be used
37669 only with great care because they can fill up your disk very quickly.
37670
37671 On a heavily loaded system, it may be desirable to disable the use of
37672 per-message logs, in order to reduce disk I/O. This can be done by setting the
37673 &%message_logs%& option false.
37674 .ecindex IIDloggen
37675
37676
37677
37678
37679 . ////////////////////////////////////////////////////////////////////////////
37680 . ////////////////////////////////////////////////////////////////////////////
37681
37682 .chapter "Exim utilities" "CHAPutils"
37683 .scindex IIDutils "utilities"
37684 A number of utility scripts and programs are supplied with Exim and are
37685 described in this chapter. There is also the Exim Monitor, which is covered in
37686 the next chapter. The utilities described here are:
37687
37688 .itable none 0 0 3  7* left  15* left  40* left
37689 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37690   "list what Exim processes are doing"
37691 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37692 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37693 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37694 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37695                                                 various criteria"
37696 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37697 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37698   "extract statistics from the log"
37699 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37700   "check address acceptance from given IP"
37701 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37702 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37703 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37704 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37705 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37706 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37707 .endtable
37708
37709 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37710 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37711 &url(https://duncanthrax.net/exilog/) for details.
37712
37713
37714
37715
37716 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37717 .cindex "&'exiwhat'&"
37718 .cindex "process, querying"
37719 .cindex "SIGUSR1"
37720 On operating systems that can restart a system call after receiving a signal
37721 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37722 a line describing what it is doing to the file &_exim-process.info_& in the
37723 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37724 processes it can find, having first emptied the file. It then waits for one
37725 second to allow the Exim processes to react before displaying the results. In
37726 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37727 send the signal to the Exim processes, so it is normally run as root.
37728
37729 &*Warning*&: This is not an efficient process. It is intended for occasional
37730 use by system administrators. It is not sensible, for example, to set up a
37731 script that sends SIGUSR1 signals to Exim processes at short intervals.
37732
37733
37734 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37735 varies in different operating systems. Not only are different options used,
37736 but the format of the output is different. For this reason, there are some
37737 system configuration options that configure exactly how &'exiwhat'& works. If
37738 it doesn't seem to be working for you, check the following compile-time
37739 options:
37740 .display
37741 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37742 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37743 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37744 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37745 .endd
37746 An example of typical output from &'exiwhat'& is
37747 .code
37748 164 daemon: -q1h, listening on port 25
37749 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37750 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37751   [10.19.42.42] (editor@ref.example)
37752 10592 handling incoming call from [192.168.243.242]
37753 10628 accepting a local non-SMTP message
37754 .endd
37755 The first number in the output line is the process number. The third line has
37756 been split here, in order to fit it on the page.
37757
37758
37759
37760 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37761 .cindex "&'exiqgrep'&"
37762 .cindex "queue" "grepping"
37763 This utility is a Perl script contributed by Matt Hubbard. It runs
37764 .code
37765 exim -bpu
37766 .endd
37767 or (in case &*-a*& switch is specified)
37768 .code
37769 exim -bp
37770 .endd
37771 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37772 contain alternate exim configuration the queue management might be using.
37773
37774 to obtain a queue listing, and then greps the output to select messages
37775 that match given criteria. The following selection options are available:
37776
37777 .vlist
37778 .vitem &*-f*&&~<&'regex'&>
37779 Match the sender address using a case-insensitive search. The field that is
37780 tested is enclosed in angle brackets, so you can test for bounce messages with
37781 .code
37782 exiqgrep -f '^<>$'
37783 .endd
37784 .vitem &*-r*&&~<&'regex'&>
37785 Match a recipient address using a case-insensitive search. The field that is
37786 tested is not enclosed in angle brackets.
37787
37788 .vitem &*-s*&&~<&'regex'&>
37789 Match against the size field.
37790
37791 .vitem &*-y*&&~<&'seconds'&>
37792 Match messages that are younger than the given time.
37793
37794 .vitem &*-o*&&~<&'seconds'&>
37795 Match messages that are older than the given time.
37796
37797 .vitem &*-z*&
37798 Match only frozen messages.
37799
37800 .vitem &*-x*&
37801 Match only non-frozen messages.
37802
37803 .new
37804 .vitem &*-G*&&~<&'queuename'&>
37805 Match only messages in the given queue.  Without this, the default queue is searched.
37806 .wen
37807 .endlist
37808
37809 The following options control the format of the output:
37810
37811 .vlist
37812 .vitem &*-c*&
37813 Display only the count of matching messages.
37814
37815 .vitem &*-l*&
37816 Long format &-- display the full message information as output by Exim. This is
37817 the default.
37818
37819 .vitem &*-i*&
37820 Display message ids only.
37821
37822 .vitem &*-b*&
37823 Brief format &-- one line per message.
37824
37825 .vitem &*-R*&
37826 Display messages in reverse order.
37827
37828 .vitem &*-a*&
37829 Include delivered recipients in queue listing.
37830 .endlist
37831
37832 There is one more option, &%-h%&, which outputs a list of options.
37833
37834
37835
37836 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
37837 .cindex "&'exiqsumm'&"
37838 .cindex "queue" "summary"
37839 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
37840 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
37841 running a command such as
37842 .code
37843 exim -bp | exiqsumm
37844 .endd
37845 The output consists of one line for each domain that has messages waiting for
37846 it, as in the following example:
37847 .code
37848 3   2322   74m   66m  msn.com.example
37849 .endd
37850 Each line lists the number of pending deliveries for a domain, their total
37851 volume, and the length of time that the oldest and the newest messages have
37852 been waiting. Note that the number of pending deliveries is greater than the
37853 number of messages when messages have more than one recipient.
37854
37855 A summary line is output at the end. By default the output is sorted on the
37856 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
37857 the output to be sorted by oldest message and by count of messages,
37858 respectively. There are also three options that split the messages for each
37859 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
37860 separates frozen messages, and &%-s%& separates messages according to their
37861 sender.
37862
37863 The output of &'exim -bp'& contains the original addresses in the message, so
37864 this also applies to the output from &'exiqsumm'&. No domains from addresses
37865 generated by aliasing or forwarding are included (unless the &%one_time%&
37866 option of the &(redirect)& router has been used to convert them into &"top
37867 level"& addresses).
37868
37869
37870
37871
37872 .section "Extracting specific information from the log (exigrep)" &&&
37873          "SECTextspeinf"
37874 .cindex "&'exigrep'&"
37875 .cindex "log" "extracts; grepping for"
37876 The &'exigrep'& utility is a Perl script that searches one or more main log
37877 files for entries that match a given pattern. When it finds a match, it
37878 extracts all the log entries for the relevant message, not just those that
37879 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
37880 given message, or all mail for a given user, or for a given host, for example.
37881 The input files can be in Exim log format or syslog format.
37882 If a matching log line is not associated with a specific message, it is
37883 included in &'exigrep'&'s output without any additional lines. The usage is:
37884 .display
37885 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
37886 .endd
37887 If no log filenames are given on the command line, the standard input is read.
37888
37889 The &%-t%& argument specifies a number of seconds. It adds an additional
37890 condition for message selection. Messages that are complete are shown only if
37891 they spent more than <&'n'&> seconds in the queue.
37892
37893 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
37894 makes it case-sensitive. This may give a performance improvement when searching
37895 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
37896 option; with &%-I%& they do not. In both cases it is possible to change the
37897 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
37898
37899 The &%-l%& option means &"literal"&, that is, treat all characters in the
37900 pattern as standing for themselves. Otherwise the pattern must be a Perl
37901 regular expression.
37902
37903 The &%-v%& option inverts the matching condition. That is, a line is selected
37904 if it does &'not'& match the pattern.
37905
37906 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
37907 that are generated as a result/response to a message that &'exigrep'& matched
37908 normally.
37909
37910 Example of &%-M%&:
37911 user_a sends a message to user_b, which generates a bounce back to user_b. If
37912 &'exigrep'& is used to search for &"user_a"&, only the first message will be
37913 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
37914 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
37915 when searching for &"user_a"& will show both messages since the bounce is
37916 &"related"& to or a &"result"& of the first message that was found by the
37917 search term.
37918
37919 If the location of a &'zcat'& command is known from the definition of
37920 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
37921 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
37922 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
37923 autodetection of some well known compression extensions.
37924
37925
37926 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
37927 .cindex "&'exipick'&"
37928 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
37929 lists messages from the queue according to a variety of criteria. For details
37930 of &'exipick'&'s facilities, run &'exipick'& with
37931 the &%--help%& option.
37932
37933
37934 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
37935 .cindex "log" "cycling local files"
37936 .cindex "cycling logs"
37937 .cindex "&'exicyclog'&"
37938 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
37939 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
37940 you are using log files with datestamps in their names (see section
37941 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
37942 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
37943 There are two command line options for &'exicyclog'&:
37944 .ilist
37945 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
37946 default that is set when Exim is built. The default default is 10.
37947 .next
37948 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
37949 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
37950 overriding the script's default, which is to find the setting from Exim's
37951 configuration.
37952 .endlist
37953
37954 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
37955 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
37956 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
37957 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
37958 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
37959 logs are handled similarly.
37960
37961 If the limit is greater than 99, the script uses 3-digit numbers such as
37962 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
37963 to one that is greater, or &'vice versa'&, you will have to fix the names of
37964 any existing log files.
37965
37966 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
37967 the end are deleted. All files with numbers greater than 01 are compressed,
37968 using a compression command which is configured by the COMPRESS_COMMAND
37969 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
37970 root &%crontab%& entry of the form
37971 .code
37972 1 0 * * * su exim -c /usr/exim/bin/exicyclog
37973 .endd
37974 assuming you have used the name &"exim"& for the Exim user. You can run
37975 &'exicyclog'& as root if you wish, but there is no need.
37976
37977
37978
37979 .section "Mail statistics (eximstats)" "SECTmailstat"
37980 .cindex "statistics"
37981 .cindex "&'eximstats'&"
37982 A Perl script called &'eximstats'& is provided for extracting statistical
37983 information from log files. The output is either plain text, or HTML.
37984 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
37985 . --- 404 error and everything else points to that.
37986
37987 The &'eximstats'& script has been hacked about quite a bit over time. The
37988 latest version is the result of some extensive revision by Steve Campbell. A
37989 lot of information is given by default, but there are options for suppressing
37990 various parts of it. Following any options, the arguments to the script are a
37991 list of files, which should be main log files. For example:
37992 .code
37993 eximstats -nr /var/spool/exim/log/mainlog.01
37994 .endd
37995 By default, &'eximstats'& extracts information about the number and volume of
37996 messages received from or delivered to various hosts. The information is sorted
37997 both by message count and by volume, and the top fifty hosts in each category
37998 are listed on the standard output. Similar information, based on email
37999 addresses or domains instead of hosts can be requested by means of various
38000 options. For messages delivered and received locally, similar statistics are
38001 also produced per user.
38002
38003 The output also includes total counts and statistics about delivery errors, and
38004 histograms showing the number of messages received and deliveries made in each
38005 hour of the day. A delivery with more than one address in its envelope (for
38006 example, an SMTP transaction with more than one RCPT command) is counted
38007 as a single delivery by &'eximstats'&.
38008
38009 Though normally more deliveries than receipts are reported (as messages may
38010 have multiple recipients), it is possible for &'eximstats'& to report more
38011 messages received than delivered, even though the queue is empty at the start
38012 and end of the period in question. If an incoming message contains no valid
38013 recipients, no deliveries are recorded for it. A bounce message is handled as
38014 an entirely separate message.
38015
38016 &'eximstats'& always outputs a grand total summary giving the volume and number
38017 of messages received and deliveries made, and the number of hosts involved in
38018 each case. It also outputs the number of messages that were delayed (that is,
38019 not completely delivered at the first attempt), and the number that had at
38020 least one address that failed.
38021
38022 The remainder of the output is in sections that can be independently disabled
38023 or modified by various options. It consists of a summary of deliveries by
38024 transport, histograms of messages received and delivered per time interval
38025 (default per hour), information about the time messages spent in the queue,
38026 a list of relayed messages, lists of the top fifty sending hosts, local
38027 senders, destination hosts, and destination local users by count and by volume,
38028 and a list of delivery errors that occurred.
38029
38030 The relay information lists messages that were actually relayed, that is, they
38031 came from a remote host and were directly delivered to some other remote host,
38032 without being processed (for example, for aliasing or forwarding) locally.
38033
38034 There are quite a few options for &'eximstats'& to control exactly what it
38035 outputs. These are documented in the Perl script itself, and can be extracted
38036 by running the command &(perldoc)& on the script. For example:
38037 .code
38038 perldoc /usr/exim/bin/eximstats
38039 .endd
38040
38041 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38042 .cindex "&'exim_checkaccess'&"
38043 .cindex "policy control" "checking access"
38044 .cindex "checking access"
38045 The &%-bh%& command line argument allows you to run a fake SMTP session with
38046 debugging output, in order to check what Exim is doing when it is applying
38047 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38048 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38049 sometimes you just want to answer the question &"Does this address have
38050 access?"& without bothering with any further details.
38051
38052 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38053 two arguments, an IP address and an email address:
38054 .code
38055 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38056 .endd
38057 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38058 given email address would be accepted in a RCPT command in a TCP/IP
38059 connection from the host with the given IP address. The output of the utility
38060 is either the word &"accepted"&, or the SMTP error response, for example:
38061 .code
38062 Rejected:
38063 550 Relay not permitted
38064 .endd
38065 When running this test, the utility uses &`<>`& as the envelope sender address
38066 for the MAIL command, but you can change this by providing additional
38067 options. These are passed directly to the Exim command. For example, to specify
38068 that the test is to be run with the sender address &'himself@there.example'&
38069 you can use:
38070 .code
38071 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38072                  -f himself@there.example
38073 .endd
38074 Note that these additional Exim command line items must be given after the two
38075 mandatory arguments.
38076
38077 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38078 while running its checks. You can run checks that include callouts by using
38079 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38080
38081
38082
38083 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38084 .cindex "DBM" "building dbm files"
38085 .cindex "building DBM files"
38086 .cindex "&'exim_dbmbuild'&"
38087 .cindex "lower casing"
38088 .cindex "binary zero" "in lookup key"
38089 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38090 the format used by the &(lsearch)& lookup (see section
38091 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38092 names as keys and the remainder of the information as data. The lower-casing
38093 can be prevented by calling the program with the &%-nolc%& option.
38094
38095 A terminating zero is included as part of the key string. This is expected by
38096 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38097 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38098 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38099 files.
38100
38101 The program requires two arguments: the name of the input file (which can be a
38102 single hyphen to indicate the standard input), and the name of the output file.
38103 It creates the output under a temporary name, and then renames it if all went
38104 well.
38105
38106 .cindex "USE_DB"
38107 If the native DB interface is in use (USE_DB is set in a compile-time
38108 configuration file &-- this is common in free versions of Unix) the two
38109 filenames must be different, because in this mode the Berkeley DB functions
38110 create a single output file using exactly the name given. For example,
38111 .code
38112 exim_dbmbuild /etc/aliases /etc/aliases.db
38113 .endd
38114 reads the system alias file and creates a DBM version of it in
38115 &_/etc/aliases.db_&.
38116
38117 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38118 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38119 environment, the suffixes are added to the second argument of
38120 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38121 when the Berkeley functions are used in compatibility mode (though this is not
38122 recommended), because in that case it adds a &_.db_& suffix to the filename.
38123
38124 If a duplicate key is encountered, the program outputs a warning, and when it
38125 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38126 option is used. By default, only the first of a set of duplicates is used &--
38127 this makes it compatible with &(lsearch)& lookups. There is an option
38128 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38129 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38130 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38131 return code is 2.
38132
38133
38134
38135
38136 .section "Finding individual retry times (exinext)" "SECTfinindret"
38137 .cindex "retry" "times"
38138 .cindex "&'exinext'&"
38139 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38140 fish specific information out of the retry database. Given a mail domain (or a
38141 complete address), it looks up the hosts for that domain, and outputs any retry
38142 information for the hosts or for the domain. At present, the retry information
38143 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38144 output. For example:
38145 .code
38146 $ exinext piglet@milne.fict.example
38147 kanga.milne.example:192.168.8.1 error 146: Connection refused
38148   first failed: 21-Feb-1996 14:57:34
38149   last tried:   21-Feb-1996 14:57:34
38150   next try at:  21-Feb-1996 15:02:34
38151 roo.milne.example:192.168.8.3 error 146: Connection refused
38152   first failed: 20-Jan-1996 13:12:08
38153   last tried:   21-Feb-1996 11:42:03
38154   next try at:  21-Feb-1996 19:42:03
38155   past final cutoff time
38156 .endd
38157 You can also give &'exinext'& a local part, without a domain, and it
38158 will give any retry information for that local part in your default domain.
38159 A message id can be used to obtain retry information pertaining to a specific
38160 message. This exists only when an attempt to deliver a message to a remote host
38161 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38162 &'exinext'& is not particularly efficient, but then it is not expected to be
38163 run very often.
38164
38165 The &'exinext'& utility calls Exim to find out information such as the location
38166 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38167 passed on to the &'exim'& commands. The first specifies an alternate Exim
38168 configuration file, and the second sets macros for use within the configuration
38169 file. These features are mainly to help in testing, but might also be useful in
38170 environments where more than one configuration file is in use.
38171
38172
38173
38174 .section "Hints database maintenance" "SECThindatmai"
38175 .cindex "hints database" "maintenance"
38176 .cindex "maintaining Exim's hints database"
38177 Three utility programs are provided for maintaining the DBM files that Exim
38178 uses to contain its delivery hint information. Each program requires two
38179 arguments. The first specifies the name of Exim's spool directory, and the
38180 second is the name of the database it is to operate on. These are as follows:
38181
38182 .ilist
38183 &'retry'&: the database of retry information
38184 .next
38185 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38186 for remote hosts
38187 .next
38188 &'callout'&: the callout cache
38189 .next
38190 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38191 .next
38192 &'misc'&: other hints data
38193 .endlist
38194
38195 The &'misc'& database is used for
38196
38197 .ilist
38198 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38199 .next
38200 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38201 &(smtp)& transport)
38202 .next
38203 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38204 in a transport)
38205 .endlist
38206
38207
38208
38209 .section "exim_dumpdb" "SECID261"
38210 .cindex "&'exim_dumpdb'&"
38211 The entire contents of a database are written to the standard output by the
38212 &'exim_dumpdb'& program, which has no options or arguments other than the
38213 spool and database names. For example, to dump the retry database:
38214 .code
38215 exim_dumpdb /var/spool/exim retry
38216 .endd
38217 Two lines of output are produced for each entry:
38218 .code
38219 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38220 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38221 .endd
38222 The first item on the first line is the key of the record. It starts with one
38223 of the letters R, or T, depending on whether it refers to a routing or
38224 transport retry. For a local delivery, the next part is the local address; for
38225 a remote delivery it is the name of the remote host, followed by its failing IP
38226 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38227 transport). If the remote port is not the standard one (port 25), it is added
38228 to the IP address. Then there follows an error code, an additional error code,
38229 and a textual description of the error.
38230
38231 The three times on the second line are the time of first failure, the time of
38232 the last delivery attempt, and the computed time for the next attempt. The line
38233 ends with an asterisk if the cutoff time for the last retry rule has been
38234 exceeded.
38235
38236 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38237 consists of a host name followed by a list of ids for messages that are or were
38238 waiting to be delivered to that host. If there are a very large number for any
38239 one host, continuation records, with a sequence number added to the host name,
38240 may be seen. The data in these records is often out of date, because a message
38241 may be routed to several alternative hosts, and Exim makes no effort to keep
38242 cross-references.
38243
38244
38245
38246 .section "exim_tidydb" "SECID262"
38247 .cindex "&'exim_tidydb'&"
38248 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38249 database. If run with no options, it removes all records that are more than 30
38250 days old. The age is calculated from the date and time that the record was last
38251 updated. Note that, in the case of the retry database, it is &'not'& the time
38252 since the first delivery failure. Information about a host that has been down
38253 for more than 30 days will remain in the database, provided that the record is
38254 updated sufficiently often.
38255
38256 The cutoff date can be altered by means of the &%-t%& option, which must be
38257 followed by a time. For example, to remove all records older than a week from
38258 the retry database:
38259 .code
38260 exim_tidydb -t 7d /var/spool/exim retry
38261 .endd
38262 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38263 message ids. In the former these appear as data in records keyed by host &--
38264 they were messages that were waiting for that host &-- and in the latter they
38265 are the keys for retry information for messages that have suffered certain
38266 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38267 message ids in database records are those of messages that are still on the
38268 queue. Message ids for messages that no longer exist are removed from
38269 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38270 For the &'retry'& database, records whose keys are non-existent message ids are
38271 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38272 whenever it removes information from the database.
38273
38274 Certain records are automatically removed by Exim when they are no longer
38275 needed, but others are not. For example, if all the MX hosts for a domain are
38276 down, a retry record is created for each one. If the primary MX host comes back
38277 first, its record is removed when Exim successfully delivers to it, but the
38278 records for the others remain because Exim has not tried to use those hosts.
38279
38280 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38281 hints databases. You should do this at a quiet time of day, because it requires
38282 a database to be locked (and therefore inaccessible to Exim) while it does its
38283 work. Removing records from a DBM file does not normally make the file smaller,
38284 but all the common DBM libraries are able to re-use the space that is released.
38285 After an initial phase of increasing in size, the databases normally reach a
38286 point at which they no longer get any bigger, as long as they are regularly
38287 tidied.
38288
38289 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38290 databases is likely to keep on increasing.
38291
38292
38293
38294
38295 .section "exim_fixdb" "SECID263"
38296 .cindex "&'exim_fixdb'&"
38297 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38298 Its main use is for testing Exim, but it might also be occasionally useful for
38299 getting round problems in a live system. It has no options, and its interface
38300 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38301 key of a database record can then be entered, and the data for that record is
38302 displayed.
38303
38304 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38305 except the &'retry'& database, that is the only operation that can be carried
38306 out. For the &'retry'& database, each field is output preceded by a number, and
38307 data for individual fields can be changed by typing the field number followed
38308 by new data, for example:
38309 .code
38310 > 4 951102:1000
38311 .endd
38312 resets the time of the next delivery attempt. Time values are given as a
38313 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38314 used as optional separators.
38315
38316
38317
38318
38319 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38320 .cindex "mailbox" "maintenance"
38321 .cindex "&'exim_lock'&"
38322 .cindex "locking mailboxes"
38323 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38324 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38325 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38326 a user agent while investigating a problem. The utility requires the name of
38327 the file as its first argument. If the locking is successful, the second
38328 argument is run as a command (using C's &[system()]& function); if there is no
38329 second argument, the value of the SHELL environment variable is used; if this
38330 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38331 is unlocked and the utility ends. The following options are available:
38332
38333 .vlist
38334 .vitem &%-fcntl%&
38335 Use &[fcntl()]& locking on the open mailbox.
38336
38337 .vitem &%-flock%&
38338 Use &[flock()]& locking on the open mailbox, provided the operating system
38339 supports it.
38340
38341 .vitem &%-interval%&
38342 This must be followed by a number, which is a number of seconds; it sets the
38343 interval to sleep between retries (default 3).
38344
38345 .vitem &%-lockfile%&
38346 Create a lock file before opening the mailbox.
38347
38348 .vitem &%-mbx%&
38349 Lock the mailbox using MBX rules.
38350
38351 .vitem &%-q%&
38352 Suppress verification output.
38353
38354 .vitem &%-retries%&
38355 This must be followed by a number; it sets the number of times to try to get
38356 the lock (default 10).
38357
38358 .vitem &%-restore_time%&
38359 This option causes &%exim_lock%& to restore the modified and read times to the
38360 locked file before exiting. This allows you to access a locked mailbox (for
38361 example, to take a backup copy) without disturbing the times that the user
38362 subsequently sees.
38363
38364 .vitem &%-timeout%&
38365 This must be followed by a number, which is a number of seconds; it sets a
38366 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38367 default), a non-blocking call is used.
38368
38369 .vitem &%-v%&
38370 Generate verbose output.
38371 .endlist
38372
38373 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38374 default is to create a lock file and also to use &[fcntl()]& locking on the
38375 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38376 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38377 requires that the directory containing the file be writeable. Locking by lock
38378 file does not last forever; Exim assumes that a lock file is expired if it is
38379 more than 30 minutes old.
38380
38381 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38382 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38383 to be taken out on the open mailbox, and an exclusive lock on the file
38384 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38385 number of the mailbox file. When the locking is released, if an exclusive lock
38386 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38387
38388 The default output contains verification of the locking that takes place. The
38389 &%-v%& option causes some additional information to be given. The &%-q%& option
38390 suppresses all output except error messages.
38391
38392 A command such as
38393 .code
38394 exim_lock /var/spool/mail/spqr
38395 .endd
38396 runs an interactive shell while the file is locked, whereas
38397 .display
38398 &`exim_lock -q /var/spool/mail/spqr <<End`&
38399 <&'some commands'&>
38400 &`End`&
38401 .endd
38402 runs a specific non-interactive sequence of commands while the file is locked,
38403 suppressing all verification output. A single command can be run by a command
38404 such as
38405 .code
38406 exim_lock -q /var/spool/mail/spqr \
38407   "cp /var/spool/mail/spqr /some/where"
38408 .endd
38409 Note that if a command is supplied, it must be entirely contained within the
38410 second argument &-- hence the quotes.
38411 .ecindex IIDutils
38412
38413
38414 . ////////////////////////////////////////////////////////////////////////////
38415 . ////////////////////////////////////////////////////////////////////////////
38416
38417 .chapter "The Exim monitor" "CHAPeximon"
38418 .scindex IIDeximon "Exim monitor" "description"
38419 .cindex "X-windows"
38420 .cindex "&'eximon'&"
38421 .cindex "Local/eximon.conf"
38422 .cindex "&_exim_monitor/EDITME_&"
38423 The Exim monitor is an application which displays in an X window information
38424 about the state of Exim's queue and what Exim is doing. An admin user can
38425 perform certain operations on messages from this GUI interface; however all
38426 such facilities are also available from the command line, and indeed, the
38427 monitor itself makes use of the command line to perform any actions requested.
38428
38429
38430
38431 .section "Running the monitor" "SECID264"
38432 The monitor is started by running the script called &'eximon'&. This is a shell
38433 script that sets up a number of environment variables, and then runs the
38434 binary called &_eximon.bin_&. The default appearance of the monitor window can
38435 be changed by editing the &_Local/eximon.conf_& file created by editing
38436 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38437 parameters are for.
38438
38439 The parameters that get built into the &'eximon'& script can be overridden for
38440 a particular invocation by setting up environment variables of the same names,
38441 preceded by &`EXIMON_`&. For example, a shell command such as
38442 .code
38443 EXIMON_LOG_DEPTH=400 eximon
38444 .endd
38445 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38446 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38447 overrides the Exim log file configuration. This makes it possible to have
38448 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38449 syslog messages are routed to a file on the local host.
38450
38451 X resources can be used to change the appearance of the window in the normal
38452 way. For example, a resource setting of the form
38453 .code
38454 Eximon*background: gray94
38455 .endd
38456 changes the colour of the background to light grey rather than white. The
38457 stripcharts are drawn with both the data lines and the reference lines in
38458 black. This means that the reference lines are not visible when on top of the
38459 data. However, their colour can be changed by setting a resource called
38460 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38461 For example, if your X server is running Unix, you could set up lighter
38462 reference lines in the stripcharts by obeying
38463 .code
38464 xrdb -merge <<End
38465 Eximon*highlight: gray
38466 End
38467 .endd
38468 .cindex "admin user"
38469 In order to see the contents of messages in the queue, and to operate on them,
38470 &'eximon'& must either be run as root or by an admin user.
38471
38472 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38473 contain X11 resource parameters interpreted by the X11 library.  In addition,
38474 if the first parameter starts with the string "gdb" then it is removed and the
38475 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38476 versioned variants of gdb can be invoked).
38477
38478 The monitor's window is divided into three parts. The first contains one or
38479 more stripcharts and two action buttons, the second contains a &"tail"& of the
38480 main log file, and the third is a display of the queue of messages awaiting
38481 delivery, with two more action buttons. The following sections describe these
38482 different parts of the display.
38483
38484
38485
38486
38487 .section "The stripcharts" "SECID265"
38488 .cindex "stripchart"
38489 The first stripchart is always a count of messages in the queue. Its name can
38490 be configured by setting QUEUE_STRIPCHART_NAME in the
38491 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38492 configuration script by regular expression matches on log file entries, making
38493 it possible to display, for example, counts of messages delivered to certain
38494 hosts or using certain transports. The supplied defaults display counts of
38495 received and delivered messages, and of local and SMTP deliveries. The default
38496 period between stripchart updates is one minute; this can be adjusted by a
38497 parameter in the &_Local/eximon.conf_& file.
38498
38499 The stripchart displays rescale themselves automatically as the value they are
38500 displaying changes. There are always 10 horizontal lines in each chart; the
38501 title string indicates the value of each division when it is greater than one.
38502 For example, &"x2"& means that each division represents a value of 2.
38503
38504 It is also possible to have a stripchart which shows the percentage fullness of
38505 a particular disk partition, which is useful when local deliveries are confined
38506 to a single partition.
38507
38508 .cindex "&%statvfs%& function"
38509 This relies on the availability of the &[statvfs()]& function or equivalent in
38510 the operating system. Most, but not all versions of Unix that support Exim have
38511 this. For this particular stripchart, the top of the chart always represents
38512 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38513 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38514 &_Local/eximon.conf_& file.
38515
38516
38517
38518
38519 .section "Main action buttons" "SECID266"
38520 .cindex "size" "of monitor window"
38521 .cindex "Exim monitor" "window size"
38522 .cindex "window size"
38523 Below the stripcharts there is an action button for quitting the monitor. Next
38524 to this is another button marked &"Size"&. They are placed here so that
38525 shrinking the window to its default minimum size leaves just the queue count
38526 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38527 the window to expand to its maximum size, unless it is already at the maximum,
38528 in which case it is reduced to its minimum.
38529
38530 When expanding to the maximum, if the window cannot be fully seen where it
38531 currently is, it is moved back to where it was the last time it was at full
38532 size. When it is expanding from its minimum size, the old position is
38533 remembered, and next time it is reduced to the minimum it is moved back there.
38534
38535 The idea is that you can keep a reduced window just showing one or two
38536 stripcharts at a convenient place on your screen, easily expand it to show
38537 the full window when required, and just as easily put it back to what it was.
38538 The idea is copied from what the &'twm'& window manager does for its
38539 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38540 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38541
38542 Normally, the monitor starts up with the window at its full size, but it can be
38543 built so that it starts up with the window at its smallest size, by setting
38544 START_SMALL=yes in &_Local/eximon.conf_&.
38545
38546
38547
38548 .section "The log display" "SECID267"
38549 .cindex "log" "tail of; in monitor"
38550 The second section of the window is an area in which a display of the tail of
38551 the main log is maintained.
38552 To save space on the screen, the timestamp on each log line is shortened by
38553 removing the date and, if &%log_timezone%& is set, the timezone.
38554 The log tail is not available when the only destination for logging data is
38555 syslog, unless the syslog lines are routed to a local file whose name is passed
38556 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38557
38558 The log sub-window has a scroll bar at its lefthand side which can be used to
38559 move back to look at earlier text, and the up and down arrow keys also have a
38560 scrolling effect. The amount of log that is kept depends on the setting of
38561 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38562 to use. When this is full, the earlier 50% of data is discarded &-- this is
38563 much more efficient than throwing it away line by line. The sub-window also has
38564 a horizontal scroll bar for accessing the ends of long log lines. This is the
38565 only means of horizontal scrolling; the right and left arrow keys are not
38566 available. Text can be cut from this part of the window using the mouse in the
38567 normal way. The size of this subwindow is controlled by parameters in the
38568 configuration file &_Local/eximon.conf_&.
38569
38570 Searches of the text in the log window can be carried out by means of the ^R
38571 and ^S keystrokes, which default to a reverse and a forward search,
38572 respectively. The search covers only the text that is displayed in the window.
38573 It cannot go further back up the log.
38574
38575 The point from which the search starts is indicated by a caret marker. This is
38576 normally at the end of the text in the window, but can be positioned explicitly
38577 by pointing and clicking with the left mouse button, and is moved automatically
38578 by a successful search. If new text arrives in the window when it is scrolled
38579 back, the caret remains where it is, but if the window is not scrolled back,
38580 the caret is moved to the end of the new text.
38581
38582 Pressing ^R or ^S pops up a window into which the search text can be typed.
38583 There are buttons for selecting forward or reverse searching, for carrying out
38584 the search, and for cancelling. If the &"Search"& button is pressed, the search
38585 happens and the window remains so that further searches can be done. If the
38586 &"Return"& key is pressed, a single search is done and the window is closed. If
38587 ^C is typed the search is cancelled.
38588
38589 The searching facility is implemented using the facilities of the Athena text
38590 widget. By default this pops up a window containing both &"search"& and
38591 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38592 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38593 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38594 provided version of &%TextPop%& when the remaining parts of the text widget
38595 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38596 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38597 on these systems, at the expense of having unwanted items in the search popup
38598 window.
38599
38600
38601
38602 .section "The queue display" "SECID268"
38603 .cindex "queue" "display in monitor"
38604 The bottom section of the monitor window contains a list of all messages that
38605 are in the queue, which includes those currently being received or delivered,
38606 as well as those awaiting delivery. The size of this subwindow is controlled by
38607 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38608 at which it is updated is controlled by another parameter in the same file &--
38609 the default is 5 minutes, since queue scans can be quite expensive. However,
38610 there is an &"Update"& action button just above the display which can be used
38611 to force an update of the queue display at any time.
38612
38613 When a host is down for some time, a lot of pending mail can build up for it,
38614 and this can make it hard to deal with other messages in the queue. To help
38615 with this situation there is a button next to &"Update"& called &"Hide"&. If
38616 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38617 type anything in here and press &"Return"&, the text is added to a chain of
38618 such texts, and if every undelivered address in a message matches at least one
38619 of the texts, the message is not displayed.
38620
38621 If there is an address that does not match any of the texts, all the addresses
38622 are displayed as normal. The matching happens on the ends of addresses so, for
38623 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38624 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38625 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38626 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38627 a hide request is automatically cancelled after one hour.
38628
38629 While the dialogue box is displayed, you can't press any buttons or do anything
38630 else to the monitor window. For this reason, if you want to cut text from the
38631 queue display to use in the dialogue box, you have to do the cutting before
38632 pressing the &"Hide"& button.
38633
38634 The queue display contains, for each unhidden queued message, the length of
38635 time it has been in the queue, the size of the message, the message id, the
38636 message sender, and the first undelivered recipient, all on one line. If it is
38637 a bounce message, the sender is shown as &"<>"&. If there is more than one
38638 recipient to which the message has not yet been delivered, subsequent ones are
38639 listed on additional lines, up to a maximum configured number, following which
38640 an ellipsis is displayed. Recipients that have already received the message are
38641 not shown.
38642
38643 .cindex "frozen messages" "display"
38644 If a message is frozen, an asterisk is displayed at the left-hand side.
38645
38646 The queue display has a vertical scroll bar, and can also be scrolled by means
38647 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38648 The text searching facilities, as described above for the log window, are also
38649 available, but the caret is always moved to the end of the text when the queue
38650 display is updated.
38651
38652
38653
38654 .section "The queue menu" "SECID269"
38655 .cindex "queue" "menu in monitor"
38656 If the &%shift%& key is held down and the left button is clicked when the mouse
38657 pointer is over the text for any message, an action menu pops up, and the first
38658 line of the queue display for the message is highlighted. This does not affect
38659 any selected text.
38660
38661 If you want to use some other event for popping up the menu, you can set the
38662 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38663 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38664 value set in this parameter is a standard X event description. For example, to
38665 run eximon using &%ctrl%& rather than &%shift%& you could use
38666 .code
38667 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38668 .endd
38669 The title of the menu is the message id, and it contains entries which act as
38670 follows:
38671
38672 .ilist
38673 &'message log'&: The contents of the message log for the message are displayed
38674 in a new text window.
38675 .next
38676 &'headers'&: Information from the spool file that contains the envelope
38677 information and headers is displayed in a new text window. See chapter
38678 &<<CHAPspool>>& for a description of the format of spool files.
38679 .next
38680 &'body'&: The contents of the spool file containing the body of the message are
38681 displayed in a new text window. There is a default limit of 20,000 bytes to the
38682 amount of data displayed. This can be changed by setting the BODY_MAX
38683 option at compile time, or the EXIMON_BODY_MAX option at runtime.
38684 .next
38685 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38686 delivery of the message. This causes an automatic thaw if the message is
38687 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38688 a new text window. The delivery is run in a separate process, to avoid holding
38689 up the monitor while the delivery proceeds.
38690 .next
38691 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38692 that the message be frozen.
38693 .next
38694 .cindex "thawing messages"
38695 .cindex "unfreezing messages"
38696 .cindex "frozen messages" "thawing"
38697 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38698 that the message be thawed.
38699 .next
38700 .cindex "delivery" "forcing failure"
38701 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38702 that Exim gives up trying to deliver the message. A bounce message is generated
38703 for any remaining undelivered addresses.
38704 .next
38705 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38706 that the message be deleted from the system without generating a bounce
38707 message.
38708 .next
38709 &'add recipient'&: A dialog box is displayed into which a recipient address can
38710 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38711 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38712 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38713 causes a call to Exim to be made using the &%-Mar%& option to request that an
38714 additional recipient be added to the message, unless the entry box is empty, in
38715 which case no action is taken.
38716 .next
38717 &'mark delivered'&: A dialog box is displayed into which a recipient address
38718 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38719 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38720 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38721 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38722 recipient address as already delivered, unless the entry box is empty, in which
38723 case no action is taken.
38724 .next
38725 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38726 mark all recipient addresses as already delivered.
38727 .next
38728 &'edit sender'&: A dialog box is displayed initialized with the current
38729 sender's address. Pressing RETURN causes a call to Exim to be made using the
38730 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38731 in which case no action is taken. If you want to set an empty sender (as in
38732 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38733 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38734 the address is qualified with that domain.
38735 .endlist
38736
38737 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38738 other cases when a call to Exim is made, if there is any output from Exim (in
38739 particular, if the command fails) a window containing the command and the
38740 output is displayed. Otherwise, the results of the action are normally apparent
38741 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38742 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38743 if no output is generated.
38744
38745 The queue display is automatically updated for actions such as freezing and
38746 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38747 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38748 force an update of the display after one of these actions.
38749
38750 In any text window that is displayed as result of a menu action, the normal
38751 cut-and-paste facility is available, and searching can be carried out using ^R
38752 and ^S, as described above for the log tail window.
38753 .ecindex IIDeximon
38754
38755
38756
38757
38758
38759 . ////////////////////////////////////////////////////////////////////////////
38760 . ////////////////////////////////////////////////////////////////////////////
38761
38762 .chapter "Security considerations" "CHAPsecurity"
38763 .scindex IIDsecurcon "security" "discussion of"
38764 This chapter discusses a number of issues concerned with security, some of
38765 which are also covered in other parts of this manual.
38766
38767 For reasons that this author does not understand, some people have promoted
38768 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38769 existence of this chapter in the documentation. However, the intent of the
38770 chapter is simply to describe the way Exim works in relation to certain
38771 security concerns, not to make any specific claims about the effectiveness of
38772 its security as compared with other MTAs.
38773
38774 What follows is a description of the way Exim is supposed to be. Best efforts
38775 have been made to try to ensure that the code agrees with the theory, but an
38776 absence of bugs can never be guaranteed. Any that are reported will get fixed
38777 as soon as possible.
38778
38779
38780 .section "Building a more &""hardened""& Exim" "SECID286"
38781 .cindex "security" "build-time features"
38782 There are a number of build-time options that can be set in &_Local/Makefile_&
38783 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
38784 Exim administrator who does not have the root password, or by someone who has
38785 penetrated the Exim (but not the root) account. These options are as follows:
38786
38787 .ilist
38788 ALT_CONFIG_PREFIX can be set to a string that is required to match the
38789 start of any filenames used with the &%-C%& option. When it is set, these
38790 filenames are also not allowed to contain the sequence &"/../"&. (However, if
38791 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
38792 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
38793 default setting for &%ALT_CONFIG_PREFIX%&.
38794
38795 If the permitted configuration files are confined to a directory to
38796 which only root has access, this guards against someone who has broken
38797 into the Exim account from running a privileged Exim with an arbitrary
38798 configuration file, and using it to break into other accounts.
38799 .next
38800
38801 If a non-trusted configuration file (i.e. not the default configuration file
38802 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
38803 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
38804 the next item), then root privilege is retained only if the caller of Exim is
38805 root. This locks out the possibility of testing a configuration using &%-C%&
38806 right through message reception and delivery, even if the caller is root. The
38807 reception works, but by that time, Exim is running as the Exim user, so when
38808 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
38809 privilege to be lost. However, root can test reception and delivery using two
38810 separate commands.
38811
38812 .next
38813 The WHITELIST_D_MACROS build option declares some macros to be safe to override
38814 with &%-D%& if the real uid is one of root, the Exim run-time user or the
38815 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
38816 requiring the run-time value supplied to &%-D%& to match a regex that errs on
38817 the restrictive side.  Requiring build-time selection of safe macros is onerous
38818 but this option is intended solely as a transition mechanism to permit
38819 previously-working configurations to continue to work after release 4.73.
38820 .next
38821 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
38822 is disabled.
38823 .next
38824 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
38825 never to be used for any deliveries. This is like the &%never_users%& runtime
38826 option, but it cannot be overridden; the runtime option adds additional users
38827 to the list. The default setting is &"root"&; this prevents a non-root user who
38828 is permitted to modify the runtime file from using Exim as a way to get root.
38829 .endlist
38830
38831
38832
38833 .section "Root privilege" "SECID270"
38834 .cindex "setuid"
38835 .cindex "root privilege"
38836 The Exim binary is normally setuid to root, which means that it gains root
38837 privilege (runs as root) when it starts execution. In some special cases (for
38838 example, when the daemon is not in use and there are no local deliveries), it
38839 may be possible to run Exim setuid to some user other than root. This is
38840 discussed in the next section. However, in most installations, root privilege
38841 is required for two things:
38842
38843 .ilist
38844 To set up a socket connected to the standard SMTP port (25) when initialising
38845 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
38846 not required.
38847 .next
38848 To be able to change uid and gid in order to read users' &_.forward_& files and
38849 perform local deliveries as the receiving user or as specified in the
38850 configuration.
38851 .endlist
38852
38853 It is not necessary to be root to do any of the other things Exim does, such as
38854 receiving messages and delivering them externally over SMTP, and it is
38855 obviously more secure if Exim does not run as root except when necessary.
38856 For this reason, a user and group for Exim to use must be defined in
38857 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
38858 group"&. Their values can be changed by the runtime configuration, though this
38859 is not recommended. Often a user called &'exim'& is used, but some sites use
38860 &'mail'& or another user name altogether.
38861
38862 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
38863 abdication; the process cannot regain root afterwards. Prior to release 4.00,
38864 &[seteuid()]& was used in some circumstances, but this is no longer the case.
38865
38866 After a new Exim process has interpreted its command line options, it changes
38867 uid and gid in the following cases:
38868
38869 .ilist
38870 .oindex "&%-C%&"
38871 .oindex "&%-D%&"
38872 If the &%-C%& option is used to specify an alternate configuration file, or if
38873 the &%-D%& option is used to define macro values for the configuration, and the
38874 calling process is not running as root, the uid and gid are changed to those of
38875 the calling process.
38876 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
38877 option may not be used at all.
38878 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
38879 can be supplied if the calling process is running as root, the Exim run-time
38880 user or CONFIGURE_OWNER, if defined.
38881 .next
38882 .oindex "&%-be%&"
38883 .oindex "&%-bf%&"
38884 .oindex "&%-bF%&"
38885 If the expansion test option (&%-be%&) or one of the filter testing options
38886 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
38887 calling process.
38888 .next
38889 If the process is not a daemon process or a queue runner process or a delivery
38890 process or a process for testing address routing (started with &%-bt%&), the
38891 uid and gid are changed to the Exim user and group. This means that Exim always
38892 runs under its own uid and gid when receiving messages. This also applies when
38893 testing address verification
38894 .oindex "&%-bv%&"
38895 .oindex "&%-bh%&"
38896 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
38897 option).
38898 .next
38899 For a daemon, queue runner, delivery, or address testing process, the uid
38900 remains as root at this stage, but the gid is changed to the Exim group.
38901 .endlist
38902
38903 The processes that initially retain root privilege behave as follows:
38904
38905 .ilist
38906 A daemon process changes the gid to the Exim group and the uid to the Exim
38907 user after setting up one or more listening sockets. The &[initgroups()]&
38908 function is called, so that if the Exim user is in any additional groups, they
38909 will be used during message reception.
38910 .next
38911 A queue runner process retains root privilege throughout its execution. Its
38912 job is to fork a controlled sequence of delivery processes.
38913 .next
38914 A delivery process retains root privilege throughout most of its execution,
38915 but any actual deliveries (that is, the transports themselves) are run in
38916 subprocesses which always change to a non-root uid and gid. For local
38917 deliveries this is typically the uid and gid of the owner of the mailbox; for
38918 remote deliveries, the Exim uid and gid are used. Once all the delivery
38919 subprocesses have been run, a delivery process changes to the Exim uid and gid
38920 while doing post-delivery tidying up such as updating the retry database and
38921 generating bounce and warning messages.
38922
38923 While the recipient addresses in a message are being routed, the delivery
38924 process runs as root. However, if a user's filter file has to be processed,
38925 this is done in a subprocess that runs under the individual user's uid and
38926 gid. A system filter is run as root unless &%system_filter_user%& is set.
38927 .next
38928 A process that is testing addresses (the &%-bt%& option) runs as root so that
38929 the routing is done in the same environment as a message delivery.
38930 .endlist
38931
38932
38933
38934
38935 .section "Running Exim without privilege" "SECTrunexiwitpri"
38936 .cindex "privilege, running without"
38937 .cindex "unprivileged running"
38938 .cindex "root privilege" "running without"
38939 Some installations like to run Exim in an unprivileged state for more of its
38940 operation, for added security. Support for this mode of operation is provided
38941 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
38942 gid are changed to the Exim user and group at the start of a delivery process
38943 (and also queue runner and address testing processes). This means that address
38944 routing is no longer run as root, and the deliveries themselves cannot change
38945 to any other uid.
38946
38947 .cindex SIGHUP
38948 .cindex "daemon" "restarting"
38949 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
38950 that the daemon can still be started in the usual way, and it can respond
38951 correctly to SIGHUP because the re-invocation regains root privilege.
38952
38953 An alternative approach is to make Exim setuid to the Exim user and also setgid
38954 to the Exim group. If you do this, the daemon must be started from a root
38955 process. (Calling Exim from a root process makes it behave in the way it does
38956 when it is setuid root.) However, the daemon cannot restart itself after a
38957 SIGHUP signal because it cannot regain privilege.
38958
38959 It is still useful to set &%deliver_drop_privilege%& in this case, because it
38960 stops Exim from trying to re-invoke itself to do a delivery after a message has
38961 been received. Such a re-invocation is a waste of resources because it has no
38962 effect.
38963
38964 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
38965 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
38966 to the Exim user seems a clean approach, but there is one complication:
38967
38968 In this style of operation, Exim is running with the real uid and gid set to
38969 those of the calling process, and the effective uid/gid set to Exim's values.
38970 Ideally, any association with the calling process' uid/gid should be dropped,
38971 that is, the real uid/gid should be reset to the effective values so as to
38972 discard any privileges that the caller may have. While some operating systems
38973 have a function that permits this action for a non-root effective uid, quite a
38974 number of them do not. Because of this lack of standardization, Exim does not
38975 address this problem at this time.
38976
38977 For this reason, the recommended approach for &"mostly unprivileged"& running
38978 is to keep the Exim binary setuid to root, and to set
38979 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
38980 be used in the most straightforward way.
38981
38982 If you configure Exim not to run delivery processes as root, there are a
38983 number of restrictions on what you can do:
38984
38985 .ilist
38986 You can deliver only as the Exim user/group. You should  explicitly use the
38987 &%user%& and &%group%& options to override routers or local transports that
38988 normally deliver as the recipient. This makes sure that configurations that
38989 work in this mode function the same way in normal mode. Any implicit or
38990 explicit specification of another user causes an error.
38991 .next
38992 Use of &_.forward_& files is severely restricted, such that it is usually
38993 not worthwhile to include them in the configuration.
38994 .next
38995 Users who wish to use &_.forward_& would have to make their home directory and
38996 the file itself accessible to the Exim user. Pipe and append-to-file entries,
38997 and their equivalents in Exim filters, cannot be used. While they could be
38998 enabled in the Exim user's name, that would be insecure and not very useful.
38999 .next
39000 Unless the local user mailboxes are all owned by the Exim user (possible in
39001 some POP3 or IMAP-only environments):
39002
39003 .olist
39004 They must be owned by the Exim group and be writeable by that group. This
39005 implies you must set &%mode%& in the appendfile configuration, as well as the
39006 mode of the mailbox files themselves.
39007 .next
39008 You must set &%no_check_owner%&, since most or all of the files will not be
39009 owned by the Exim user.
39010 .next
39011 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39012 on a newly created mailbox when unprivileged. This also implies that new
39013 mailboxes need to be created manually.
39014 .endlist olist
39015 .endlist ilist
39016
39017
39018 These restrictions severely restrict what can be done in local deliveries.
39019 However, there are no restrictions on remote deliveries. If you are running a
39020 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39021 gives more security at essentially no cost.
39022
39023 If you are using the &%mua_wrapper%& facility (see chapter
39024 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39025
39026
39027
39028
39029 .section "Delivering to local files" "SECID271"
39030 Full details of the checks applied by &(appendfile)& before it writes to a file
39031 are given in chapter &<<CHAPappendfile>>&.
39032
39033
39034
39035 .section "Running local commands" "SECTsecconslocalcmds"
39036 .cindex "security" "local commands"
39037 .cindex "security" "command injection attacks"
39038 There are a number of ways in which an administrator can configure Exim to run
39039 commands based upon received, untrustworthy, data. Further, in some
39040 configurations a user who can control a &_.forward_& file can also arrange to
39041 run commands. Configuration to check includes, but is not limited to:
39042
39043 .ilist
39044 Use of &%use_shell%& in the pipe transport: various forms of shell command
39045 injection may be possible with this option present. It is dangerous and should
39046 be used only with considerable caution. Consider constraints which whitelist
39047 allowed characters in a variable which is to be used in a pipe transport that
39048 has &%use_shell%& enabled.
39049 .next
39050 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39051 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39052 &_.forward_& files in a redirect router. If Exim is running on a central mail
39053 hub to which ordinary users do not have shell access, but home directories are
39054 NFS mounted (for instance) then administrators should review the list of these
39055 forbid options available, and should bear in mind that the options that may
39056 need forbidding can change as new features are added between releases.
39057 .next
39058 The &%${run...}%& expansion item does not use a shell by default, but
39059 administrators can configure use of &_/bin/sh_& as part of the command.
39060 Such invocations should be viewed with prejudicial suspicion.
39061 .next
39062 Administrators who use embedded Perl are advised to explore how Perl's
39063 taint checking might apply to their usage.
39064 .next
39065 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39066 administrators are well advised to view its use with suspicion, in case (for
39067 instance) it allows a local-part to contain embedded Exim directives.
39068 .next
39069 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39070 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39071 each can reference arbitrary lists and files, rather than just being a list
39072 of opaque strings.
39073 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39074 real-world security vulnerabilities caused by its use with untrustworthy data
39075 injected in, for SQL injection attacks.
39076 Consider the use of the &%inlisti%& expansion condition instead.
39077 .endlist
39078
39079
39080
39081
39082 .section "Trust in configuration data" "SECTsecconfdata"
39083 .cindex "security" "data sources"
39084 .cindex "security" "regular expressions"
39085 .cindex "regular expressions" "security"
39086 .cindex "PCRE" "security"
39087 If configuration data for Exim can come from untrustworthy sources, there
39088 are some issues to be aware of:
39089
39090 .ilist
39091 Use of &%${expand...}%& may provide a path for shell injection attacks.
39092 .next
39093 Letting untrusted data provide a regular expression is unwise.
39094 .next
39095 Using &%${match...}%& to apply a fixed regular expression against untrusted
39096 data may result in pathological behaviour within PCRE.  Be aware of what
39097 "backtracking" means and consider options for being more strict with a regular
39098 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39099 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39100 possessive quantifiers or just not using regular expressions against untrusted
39101 data.
39102 .next
39103 It can be important to correctly use &%${quote:...}%&,
39104 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39105 items to ensure that data is correctly constructed.
39106 .next
39107 Some lookups might return multiple results, even though normal usage is only
39108 expected to yield one result.
39109 .endlist
39110
39111
39112
39113
39114 .section "IPv4 source routing" "SECID272"
39115 .cindex "source routing" "in IP packets"
39116 .cindex "IP source routing"
39117 Many operating systems suppress IP source-routed packets in the kernel, but
39118 some cannot be made to do this, so Exim does its own check. It logs incoming
39119 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39120 IPv6. No special checking is currently done.
39121
39122
39123
39124 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39125 Support for these SMTP commands is disabled by default. If required, they can
39126 be enabled by defining suitable ACLs.
39127
39128
39129
39130
39131 .section "Privileged users" "SECID274"
39132 .cindex "trusted users"
39133 .cindex "admin user"
39134 .cindex "privileged user"
39135 .cindex "user" "trusted"
39136 .cindex "user" "admin"
39137 Exim recognizes two sets of users with special privileges. Trusted users are
39138 able to submit new messages to Exim locally, but supply their own sender
39139 addresses and information about a sending host. For other users submitting
39140 local messages, Exim sets up the sender address from the uid, and doesn't
39141 permit a remote host to be specified.
39142
39143 .oindex "&%-f%&"
39144 However, an untrusted user is permitted to use the &%-f%& command line option
39145 in the special form &%-f <>%& to indicate that a delivery failure for the
39146 message should not cause an error report. This affects the message's envelope,
39147 but it does not affect the &'Sender:'& header. Untrusted users may also be
39148 permitted to use specific forms of address with the &%-f%& option by setting
39149 the &%untrusted_set_sender%& option.
39150
39151 Trusted users are used to run processes that receive mail messages from some
39152 other mail domain and pass them on to Exim for delivery either locally, or over
39153 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39154 as any user listed in the &%trusted_users%& configuration option, or under any
39155 group listed in the &%trusted_groups%& option.
39156
39157 Admin users are permitted to do things to the messages on Exim's queue. They
39158 can freeze or thaw messages, cause them to be returned to their senders, remove
39159 them entirely, or modify them in various ways. In addition, admin users can run
39160 the Exim monitor and see all the information it is capable of providing, which
39161 includes the contents of files on the spool.
39162
39163 .oindex "&%-M%&"
39164 .oindex "&%-q%&"
39165 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39166 delivery of messages on its queue is restricted to admin users. This
39167 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39168 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39169 queue is also restricted to admin users. This restriction can be relaxed by
39170 setting &%no_queue_list_requires_admin%&.
39171
39172 Exim recognizes an admin user if the calling process is running as root or as
39173 the Exim user or if any of the groups associated with the calling process is
39174 the Exim group. It is not necessary actually to be running under the Exim
39175 group. However, if admin users who are not root or the Exim user are to access
39176 the contents of files on the spool via the Exim monitor (which runs
39177 unprivileged), Exim must be built to allow group read access to its spool
39178 files.
39179
39180 By default, regular users are trusted to perform basic testing and
39181 introspection commands, as themselves.  This setting can be tightened by
39182 setting the &%commandline_checks_require_admin%& option.
39183 This affects most of the checking options,
39184 such as &%-be%& and anything else &%-b*%&.
39185
39186
39187 .section "Spool files" "SECID275"
39188 .cindex "spool directory" "files"
39189 Exim's spool directory and everything it contains is owned by the Exim user and
39190 set to the Exim group. The mode for spool files is defined in the
39191 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39192 any user who is a member of the Exim group can access these files.
39193
39194
39195
39196 .section "Use of argv[0]" "SECID276"
39197 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39198 of specific strings, Exim assumes certain options. For example, calling Exim
39199 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39200 to calling it with the option &%-bS%&. There are no security implications in
39201 this.
39202
39203
39204
39205 .section "Use of %f formatting" "SECID277"
39206 The only use made of &"%f"& by Exim is in formatting load average values. These
39207 are actually stored in integer variables as 1000 times the load average.
39208 Consequently, their range is limited and so therefore is the length of the
39209 converted output.
39210
39211
39212
39213 .section "Embedded Exim path" "SECID278"
39214 Exim uses its own path name, which is embedded in the code, only when it needs
39215 to re-exec in order to regain root privilege. Therefore, it is not root when it
39216 does so. If some bug allowed the path to get overwritten, it would lead to an
39217 arbitrary program's being run as exim, not as root.
39218
39219
39220
39221 .section "Dynamic module directory" "SECTdynmoddir"
39222 Any dynamically loadable modules must be installed into the directory
39223 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39224 loading it.
39225
39226
39227 .section "Use of sprintf()" "SECID279"
39228 .cindex "&[sprintf()]&"
39229 A large number of occurrences of &"sprintf"& in the code are actually calls to
39230 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39231 The intermediate formatting is done into a large fixed buffer by a function
39232 that runs through the format string itself, and checks the length of each
39233 conversion before performing it, thus preventing buffer overruns.
39234
39235 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39236 the output buffer is known to be sufficiently long to contain the converted
39237 string.
39238
39239
39240
39241 .section "Use of debug_printf() and log_write()" "SECID280"
39242 Arbitrary strings are passed to both these functions, but they do their
39243 formatting by calling the function &'string_vformat()'&, which runs through
39244 the format string itself, and checks the length of each conversion.
39245
39246
39247
39248 .section "Use of strcat() and strcpy()" "SECID281"
39249 These are used only in cases where the output buffer is known to be large
39250 enough to hold the result.
39251 .ecindex IIDsecurcon
39252
39253
39254
39255
39256 . ////////////////////////////////////////////////////////////////////////////
39257 . ////////////////////////////////////////////////////////////////////////////
39258
39259 .chapter "Format of spool files" "CHAPspool"
39260 .scindex IIDforspo1 "format" "spool files"
39261 .scindex IIDforspo2 "spool directory" "format of files"
39262 .scindex IIDforspo3 "spool files" "format of"
39263 .cindex "spool files" "editing"
39264 A message on Exim's queue consists of two files, whose names are the message id
39265 followed by -D and -H, respectively. The data portion of the message is kept in
39266 the -D file on its own. The message's envelope, status, and headers are all
39267 kept in the -H file, whose format is described in this chapter. Each of these
39268 two files contains the final component of its own name as its first line. This
39269 is insurance against disk crashes where the directory is lost but the files
39270 themselves are recoverable.
39271
39272 The file formats may be changed, or new formats added, at any release.
39273 Spool files are not intended as an interface to other programs
39274 and should not be used as such.
39275
39276 Some people are tempted into editing -D files in order to modify messages. You
39277 need to be extremely careful if you do this; it is not recommended and you are
39278 on your own if you do it. Here are some of the pitfalls:
39279
39280 .ilist
39281 You must ensure that Exim does not try to deliver the message while you are
39282 fiddling with it. The safest way is to take out a write lock on the -D file,
39283 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39284 place, the lock will be retained. If you write a new file and rename it, the
39285 lock will be lost at the instant of rename.
39286 .next
39287 .vindex "&$body_linecount$&"
39288 If you change the number of lines in the file, the value of
39289 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39290 cause incomplete transmission of messages or undeliverable messages.
39291 .next
39292 If the message is in MIME format, you must take care not to break it.
39293 .next
39294 If the message is cryptographically signed, any change will invalidate the
39295 signature.
39296 .endlist
39297 All in all, modifying -D files is fraught with danger.
39298
39299 Files whose names end with -J may also be seen in the &_input_& directory (or
39300 its subdirectories when &%split_spool_directory%& is set). These are journal
39301 files, used to record addresses to which the message has been delivered during
39302 the course of a delivery attempt. If there are still undelivered recipients at
39303 the end, the -H file is updated, and the -J file is deleted. If, however, there
39304 is some kind of crash (for example, a power outage) before this happens, the -J
39305 file remains in existence. When Exim next processes the message, it notices the
39306 -J file and uses it to update the -H file before starting the next delivery
39307 attempt.
39308
39309 Files whose names end with -K or .eml may also be seen in the spool.
39310 These are temporaries used for DKIM or malware processing, when that is used.
39311 They should be tidied up by normal operations; any old ones are probably
39312 relics of crashes and can be removed.
39313
39314 .section "Format of the -H file" "SECID282"
39315 .cindex "uid (user id)" "in spool file"
39316 .cindex "gid (group id)" "in spool file"
39317 The second line of the -H file contains the login name for the uid of the
39318 process that called Exim to read the message, followed by the numerical uid and
39319 gid. For a locally generated message, this is normally the user who sent the
39320 message. For a message received over TCP/IP via the daemon, it is
39321 normally the Exim user.
39322
39323 The third line of the file contains the address of the message's sender as
39324 transmitted in the envelope, contained in angle brackets. The sender address is
39325 empty for bounce messages. For incoming SMTP mail, the sender address is given
39326 in the MAIL command. For locally generated mail, the sender address is
39327 created by Exim from the login name of the current user and the configured
39328 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39329 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39330 &"<>"& or an address that matches &%untrusted_set_senders%&.
39331
39332 The fourth line contains two numbers. The first is the time that the message
39333 was received, in the conventional Unix form &-- the number of seconds since the
39334 start of the epoch. The second number is a count of the number of messages
39335 warning of delayed delivery that have been sent to the sender.
39336
39337 There follow a number of lines starting with a hyphen. These can appear in any
39338 order, and are omitted when not relevant:
39339
39340 .vlist
39341 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39342 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39343 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39344 recognized, to provide backward compatibility. In the old format, a line of
39345 this form is present for every ACL variable that is not empty. The number
39346 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39347 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39348 the data string for the variable. The string itself starts at the beginning of
39349 the next line, and is followed by a newline character. It may contain internal
39350 newlines.
39351
39352 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39353 A line of this form is present for every ACL connection variable that is
39354 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39355 The length is the length of the data string for the variable. The string itself
39356 starts at the beginning of the next line, and is followed by a newline
39357 character. It may contain internal newlines.
39358
39359 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39360 A line of this form is present for every ACL message variable that is defined.
39361 Note that there is a space between &%-aclm%& and the rest of the name. The
39362 length is the length of the data string for the variable. The string itself
39363 starts at the beginning of the next line, and is followed by a newline
39364 character. It may contain internal newlines.
39365
39366 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39367 This is present if, when the message was received over SMTP, the value of
39368 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39369
39370 .vitem &%-allow_unqualified_recipient%&
39371 This is present if unqualified recipient addresses are permitted in header
39372 lines (to stop such addresses from being qualified if rewriting occurs at
39373 transport time). Local messages that were input using &%-bnq%& and remote
39374 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39375
39376 .vitem &%-allow_unqualified_sender%&
39377 This is present if unqualified sender addresses are permitted in header lines
39378 (to stop such addresses from being qualified if rewriting occurs at transport
39379 time). Local messages that were input using &%-bnq%& and remote messages from
39380 hosts that match &%sender_unqualified_hosts%& set this flag.
39381
39382 .vitem "&%-auth_id%&&~<&'text'&>"
39383 The id information for a message received on an authenticated SMTP connection
39384 &-- the value of the &$authenticated_id$& variable.
39385
39386 .vitem "&%-auth_sender%&&~<&'address'&>"
39387 The address of an authenticated sender &-- the value of the
39388 &$authenticated_sender$& variable.
39389
39390 .vitem "&%-body_linecount%&&~<&'number'&>"
39391 This records the number of lines in the body of the message, and is
39392 present unless &%-spool_file_wireformat%& is.
39393
39394 .vitem "&%-body_zerocount%&&~<&'number'&>"
39395 This records the number of binary zero bytes in the body of the message, and is
39396 present if the number is greater than zero.
39397
39398 .vitem &%-deliver_firsttime%&
39399 This is written when a new message is first added to the spool. When the spool
39400 file is updated after a deferral, it is omitted.
39401
39402 .vitem "&%-frozen%&&~<&'time'&>"
39403 .cindex "frozen messages" "spool data"
39404 The message is frozen, and the freezing happened at <&'time'&>.
39405
39406 .vitem "&%-helo_name%&&~<&'text'&>"
39407 This records the host name as specified by a remote host in a HELO or EHLO
39408 command.
39409
39410 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39411 This records the IP address of the host from which the message was received and
39412 the remote port number that was used. It is omitted for locally generated
39413 messages.
39414
39415 .vitem "&%-host_auth%&&~<&'text'&>"
39416 If the message was received on an authenticated SMTP connection, this records
39417 the name of the authenticator &-- the value of the
39418 &$sender_host_authenticated$& variable.
39419
39420 .vitem &%-host_lookup_failed%&
39421 This is present if an attempt to look up the sending host's name from its IP
39422 address failed. It corresponds to the &$host_lookup_failed$& variable.
39423
39424 .vitem "&%-host_name%&&~<&'text'&>"
39425 .cindex "reverse DNS lookup"
39426 .cindex "DNS" "reverse lookup"
39427 This records the name of the remote host from which the message was received,
39428 if the host name was looked up from the IP address when the message was being
39429 received. It is not present if no reverse lookup was done.
39430
39431 .vitem "&%-ident%&&~<&'text'&>"
39432 For locally submitted messages, this records the login of the originating user,
39433 unless it was a trusted user and the &%-oMt%& option was used to specify an
39434 ident value. For messages received over TCP/IP, this records the ident string
39435 supplied by the remote host, if any.
39436
39437 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39438 This records the IP address of the local interface and the port number through
39439 which a message was received from a remote host. It is omitted for locally
39440 generated messages.
39441
39442 .vitem &%-local%&
39443 The message is from a local sender.
39444
39445 .vitem &%-localerror%&
39446 The message is a locally-generated bounce message.
39447
39448 .vitem "&%-local_scan%&&~<&'string'&>"
39449 This records the data string that was returned by the &[local_scan()]& function
39450 when the message was received &-- the value of the &$local_scan_data$&
39451 variable. It is omitted if no data was returned.
39452
39453 .vitem &%-manual_thaw%&
39454 The message was frozen but has been thawed manually, that is, by an explicit
39455 Exim command rather than via the auto-thaw process.
39456
39457 .vitem &%-N%&
39458 A testing delivery process was started using the &%-N%& option to suppress any
39459 actual deliveries, but delivery was deferred. At any further delivery attempts,
39460 &%-N%& is assumed.
39461
39462 .vitem &%-received_protocol%&
39463 This records the value of the &$received_protocol$& variable, which contains
39464 the name of the protocol by which the message was received.
39465
39466 .vitem &%-sender_set_untrusted%&
39467 The envelope sender of this message was set by an untrusted local caller (used
39468 to ensure that the caller is displayed in queue listings).
39469
39470 .vitem "&%-spam_score_int%&&~<&'number'&>"
39471 If a message was scanned by SpamAssassin, this is present. It records the value
39472 of &$spam_score_int$&.
39473
39474 .vitem &%-spool_file_wireformat%&
39475 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39476 rather than Unix-format.
39477 The line-ending is CRLF rather than newline.
39478 There is still, however, no leading-dot-stuffing.
39479
39480 .vitem &%-tls_certificate_verified%&
39481 A TLS certificate was received from the client that sent this message, and the
39482 certificate was verified by the server.
39483
39484 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39485 When the message was received over an encrypted connection, this records the
39486 name of the cipher suite that was used.
39487
39488 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39489 When the message was received over an encrypted connection, and a certificate
39490 was received from the client, this records the Distinguished Name from that
39491 certificate.
39492 .endlist
39493
39494 Following the options there is a list of those addresses to which the message
39495 is not to be delivered. This set of addresses is initialized from the command
39496 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39497 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39498 the address is added to this set. The addresses are kept internally as a
39499 balanced binary tree, and it is a representation of that tree which is written
39500 to the spool file. If an address is expanded via an alias or forward file, the
39501 original address is added to the tree when deliveries to all its child
39502 addresses are complete.
39503
39504 If the tree is empty, there is a single line in the spool file containing just
39505 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39506 Y or N, followed by an address. The address is the value for the node of the
39507 tree, and the letters indicate whether the node has a left branch and/or a
39508 right branch attached to it, respectively. If branches exist, they immediately
39509 follow. Here is an example of a three-node tree:
39510 .code
39511 YY darcy@austen.fict.example
39512 NN alice@wonderland.fict.example
39513 NN editor@thesaurus.ref.example
39514 .endd
39515 After the non-recipients tree, there is a list of the message's recipients.
39516 This is a simple list, preceded by a count. It includes all the original
39517 recipients of the message, including those to whom the message has already been
39518 delivered. In the simplest case, the list contains one address per line. For
39519 example:
39520 .code
39521 4
39522 editor@thesaurus.ref.example
39523 darcy@austen.fict.example
39524 rdo@foundation
39525 alice@wonderland.fict.example
39526 .endd
39527 However, when a child address has been added to the top-level addresses as a
39528 result of the use of the &%one_time%& option on a &(redirect)& router, each
39529 line is of the following form:
39530 .display
39531 <&'top-level address'&> <&'errors_to address'&> &&&
39532   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39533 .endd
39534 The 01 flag bit indicates the presence of the three other fields that follow
39535 the top-level address. Other bits may be used in future to support additional
39536 fields. The <&'parent number'&> is the offset in the recipients list of the
39537 original parent of the &"one time"& address. The first two fields are the
39538 envelope sender that is associated with this address and its length. If the
39539 length is zero, there is no special envelope sender (there are then two space
39540 characters in the line). A non-empty field can arise from a &(redirect)& router
39541 that has an &%errors_to%& setting.
39542
39543
39544 A blank line separates the envelope and status information from the headers
39545 which follow. A header may occupy several lines of the file, and to save effort
39546 when reading it in, each header is preceded by a number and an identifying
39547 character. The number is the number of characters in the header, including any
39548 embedded newlines and the terminating newline. The character is one of the
39549 following:
39550
39551 .table2 50pt
39552 .row <&'blank'&>         "header in which Exim has no special interest"
39553 .row &`B`&               "&'Bcc:'& header"
39554 .row &`C`&               "&'Cc:'& header"
39555 .row &`F`&               "&'From:'& header"
39556 .row &`I`&               "&'Message-id:'& header"
39557 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39558 .row &`R`&               "&'Reply-To:'& header"
39559 .row &`S`&               "&'Sender:'& header"
39560 .row &`T`&               "&'To:'& header"
39561 .row &`*`&               "replaced or deleted header"
39562 .endtable
39563
39564 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39565 purposes. They are not transmitted when the message is delivered. Here is a
39566 typical set of headers:
39567 .code
39568 111P Received: by hobbit.fict.example with local (Exim 4.00)
39569 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39570 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39571 038* X-rewrote-sender: bb@hobbit.fict.example
39572 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39573 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39574 099* To: alice@wonderland.fict.example, rdo@foundation,
39575 darcy@austen.fict.example, editor@thesaurus.ref.example
39576 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39577 darcy@austen.fict.example, editor@thesaurus.ref.example
39578 038  Date: Fri, 11 May 2001 10:28:59 +0100
39579 .endd
39580 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39581 &'To:'& header have been rewritten, the last one because routing expanded the
39582 unqualified domain &'foundation'&.
39583 .ecindex IIDforspo1
39584 .ecindex IIDforspo2
39585 .ecindex IIDforspo3
39586
39587 .section "Format of the -D file" "SECID282a"
39588 The data file is traditionally in Unix-standard format: lines are ended with
39589 an ASCII newline character.
39590 However, when the &%spool_wireformat%& main option is used some -D files
39591 can have an alternate format.
39592 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39593 The -D file lines (not including the first name-component line) are
39594 suitable for direct copying to the wire when transmitting using the
39595 ESMTP CHUNKING option, meaning lower processing overhead.
39596 Lines are terminated with an ASCII CRLF pair.
39597 There is no dot-stuffing (and no dot-termination).
39598
39599 . ////////////////////////////////////////////////////////////////////////////
39600 . ////////////////////////////////////////////////////////////////////////////
39601
39602 .chapter "DKIM and SPF" "CHAPdkim" &&&
39603          "DKIM and SPF Support"
39604 .cindex "DKIM"
39605
39606 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39607
39608 DKIM is a mechanism by which messages sent by some entity can be provably
39609 linked to a domain which that entity controls.  It permits reputation to
39610 be tracked on a per-domain basis, rather than merely upon source IP address.
39611 DKIM is documented in RFC 6376.
39612
39613 As DKIM relies on the message being unchanged in transit, messages handled
39614 by a mailing-list (which traditionally adds to the message) will not match
39615 any original DKIM signature.
39616
39617 DKIM support is compiled into Exim by default if TLS support is present.
39618 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39619
39620 Exim's DKIM implementation allows for
39621 .olist
39622 Signing outgoing messages: This function is implemented in the SMTP transport.
39623 It can co-exist with all other Exim features
39624 (including transport filters)
39625 except cutthrough delivery.
39626 .next
39627 Verifying signatures in incoming messages: This is implemented by an additional
39628 ACL (acl_smtp_dkim), which can be called several times per message, with
39629 different signature contexts.
39630 .endlist
39631
39632 In typical Exim style, the verification implementation does not include any
39633 default "policy". Instead it enables you to build your own policy using
39634 Exim's standard controls.
39635
39636 Please note that verification of DKIM signatures in incoming mail is turned
39637 on by default for logging (in the <= line) purposes.
39638
39639 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39640 When set, for each signature in incoming email,
39641 exim will log a line displaying the most important signature details, and the
39642 signature status. Here is an example (with line-breaks added for clarity):
39643 .code
39644 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39645     d=facebookmail.com s=q1-2009b
39646     c=relaxed/relaxed a=rsa-sha1
39647     i=@facebookmail.com t=1252484542 [verification succeeded]
39648 .endd
39649
39650 You might want to turn off DKIM verification processing entirely for internal
39651 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39652 control modifier. This should typically be done in the RCPT ACL, at points
39653 where you accept mail from relay sources (internal hosts or authenticated
39654 senders).
39655
39656
39657 .section "Signing outgoing messages" "SECDKIMSIGN"
39658 .cindex "DKIM" "signing"
39659
39660 For signing to be usable you must have published a DKIM record in DNS.
39661 Note that RFC 8301 (which does not cover EC keys) says:
39662 .code
39663 rsa-sha1 MUST NOT be used for signing or verifying.
39664
39665 Signers MUST use RSA keys of at least 1024 bits for all keys.
39666 Signers SHOULD use RSA keys of at least 2048 bits.
39667 .endd
39668
39669 Note also that the key content (the 'p=' field)
39670 in the DNS record is different between RSA and EC keys;
39671 for the former it is the base64 of the ASN.1 for the RSA public key
39672 (equivalent to the private-key .pem with the header/trailer stripped)
39673 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39674
39675 Signing is enabled by setting private options on the SMTP transport.
39676 These options take (expandable) strings as arguments.
39677
39678 .option dkim_domain smtp string list&!! unset
39679 The domain(s) you want to sign with.
39680 After expansion, this can be a list.
39681 Each element in turn,
39682 .new
39683 lowercased,
39684 .wen
39685 is put into the &%$dkim_domain%& expansion variable
39686 while expanding the remaining signing options.
39687 If it is empty after expansion, DKIM signing is not done,
39688 and no error will result even if &%dkim_strict%& is set.
39689
39690 .option dkim_selector smtp string list&!! unset
39691 This sets the key selector string.
39692 After expansion, which can use &$dkim_domain$&, this can be a list.
39693 Each element in turn is put in the expansion
39694 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39695 option along with &%$dkim_domain%&.
39696 If the option is empty after expansion, DKIM signing is not done for this domain,
39697 and no error will result even if &%dkim_strict%& is set.
39698
39699 .option dkim_private_key smtp string&!! unset
39700 This sets the private key to use.
39701 You can use the &%$dkim_domain%& and
39702 &%$dkim_selector%& expansion variables to determine the private key to use.
39703 The result can either
39704 .ilist
39705 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39706 .next
39707 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39708 be a valid Ed25519 private key (same format as above)
39709 .next
39710 start with a slash, in which case it is treated as a file that contains
39711 the private key
39712 .next
39713 be "0", "false" or the empty string, in which case the message will not
39714 be signed. This case will not result in an error, even if &%dkim_strict%&
39715 is set.
39716 .endlist
39717
39718 To generate keys under OpenSSL:
39719 .code
39720 openssl genrsa -out dkim_rsa.private 2048
39721 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39722 .endd
39723 Take the base-64 lines from the output of the second command, concatenated,
39724 for the DNS TXT record.
39725 See section 3.6 of RFC6376 for the record specification.
39726
39727 Under GnuTLS:
39728 .code
39729 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39730 certtool --load-privkey=dkim_rsa.private --pubkey-info
39731 .endd
39732
39733 Note that RFC 8301 says:
39734 .code
39735 Signers MUST use RSA keys of at least 1024 bits for all keys.
39736 Signers SHOULD use RSA keys of at least 2048 bits.
39737 .endd
39738
39739 .new
39740 EC keys for DKIM are defined by RFC 8463.
39741 .wen
39742 They are considerably smaller than RSA keys for equivalent protection.
39743 As they are a recent development, users should consider dual-signing
39744 (by setting a list of selectors, and an expansion for this option)
39745 for some transition period.
39746 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39747 for EC keys.
39748
39749 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39750 .code
39751 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39752 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39753 .endd
39754
39755 To produce the required public key value for a DNS record:
39756 .code
39757 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39758 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39759 .endd
39760
39761 .new
39762 Exim also supports an alternate format
39763 of Ed25519 keys in DNS which was a candidate during development
39764 of the standard, but not adopted.
39765 A future release will probably drop that support.
39766 .wen
39767
39768 .option dkim_hash smtp string&!! sha256
39769 Can be set to any one of the supported hash methods, which are:
39770 .ilist
39771 &`sha1`& &-- should not be used, is old and insecure
39772 .next
39773 &`sha256`& &-- the default
39774 .next
39775 &`sha512`& &-- possibly more secure but less well supported
39776 .endlist
39777
39778 Note that RFC 8301 says:
39779 .code
39780 rsa-sha1 MUST NOT be used for signing or verifying.
39781 .endd
39782
39783 .option dkim_identity smtp string&!! unset
39784 If set after expansion, the value is used to set an "i=" tag in
39785 the signing header.  The DKIM standards restrict the permissible
39786 syntax of this optional tag to a mail address, with possibly-empty
39787 local part, an @, and a domain identical to or subdomain of the "d="
39788 tag value.  Note that Exim does not check the value.
39789
39790 .option dkim_canon smtp string&!! unset
39791 This option sets the canonicalization method used when signing a message.
39792 The DKIM RFC currently supports two methods: "simple" and "relaxed".
39793 The option defaults to "relaxed" when unset. Note: the current implementation
39794 only supports signing with the same canonicalization method for both headers and body.
39795
39796 .option dkim_strict smtp string&!! unset
39797 This  option  defines  how  Exim  behaves  when  signing a message that
39798 should be signed fails for some reason.  When the expansion evaluates to
39799 either "1" or "true", Exim will defer. Otherwise Exim will send the message
39800 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
39801 variables here.
39802
39803 .option dkim_sign_headers smtp string&!! "see below"
39804 If set, this option must expand to a colon-separated
39805 list of header names.
39806 Headers with these names, or the absence or such a header, will be included
39807 in the message signature.
39808 When unspecified, the header names listed in RFC4871 will be used,
39809 whether or not each header is present in the message.
39810 The default list is available for the expansion in the macro
39811 "_DKIM_SIGN_HEADERS".
39812
39813 If a name is repeated, multiple headers by that name (or the absence thereof)
39814 will be signed.  The textually later headers in the headers part of the
39815 message are signed first, if there are multiples.
39816
39817 A name can be prefixed with either an '=' or a '+' character.
39818 If an '=' prefix is used, all headers that are present with this name
39819 will be signed.
39820 If a '+' prefix if used, all headers that are present with this name
39821 will be signed, and one signature added for a missing header with the
39822 name will be appended.
39823
39824 .option dkim_timestamps smtp integer&!! unset
39825 This option controls the inclusion of timestamp information in the signature.
39826 If not set, no such information will be included.
39827 Otherwise, must be an unsigned number giving an offset in seconds from the current time
39828 for the expiry tag
39829 (eg. 1209600 for two weeks);
39830 both creation (t=) and expiry (x=) tags will be included.
39831
39832 RFC 6376 lists these tags as RECOMMENDED.
39833
39834
39835 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
39836 .cindex "DKIM" "verification"
39837
39838 Verification of DKIM signatures in SMTP incoming email is done for all
39839 messages for which an ACL control &%dkim_disable_verify%& has not been set.
39840 .cindex authentication "expansion item"
39841 Performing verification sets up information used by the
39842 &$authresults$& expansion item.
39843
39844 The results of that verification are then made available to the
39845 &%acl_smtp_dkim%& ACL, which can examine and modify them.
39846 By default, this ACL is called once for each
39847 syntactically(!) correct signature in the incoming message.
39848 A missing ACL definition defaults to accept.
39849 If any ACL call does not accept, the message is not accepted.
39850 If a cutthrough delivery was in progress for the message, that is
39851 summarily dropped (having wasted the transmission effort).
39852
39853 To evaluate the verification result in the ACL
39854 a large number of expansion variables
39855 containing the signature status and its details are set up during the
39856 runtime of the ACL.
39857
39858 Calling the ACL only for existing signatures is not sufficient to build
39859 more advanced policies. For that reason, the global option
39860 &%dkim_verify_signers%&, and a global expansion variable
39861 &%$dkim_signers%& exist.
39862
39863 The global option &%dkim_verify_signers%& can be set to a colon-separated
39864 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
39865 called. It is expanded when the message has been received. At this point,
39866 the expansion variable &%$dkim_signers%& already contains a colon-separated
39867 list of signer domains and identities for the message. When
39868 &%dkim_verify_signers%& is not specified in the main configuration,
39869 it defaults as:
39870 .code
39871 dkim_verify_signers = $dkim_signers
39872 .endd
39873 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
39874 DKIM signature in the message. Current DKIM verifiers may want to explicitly
39875 call the ACL for known domains or identities. This would be achieved as follows:
39876 .code
39877 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
39878 .endd
39879 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
39880 and "ebay.com", plus all domains and identities that have signatures in the message.
39881 You can also be more creative in constructing your policy. For example:
39882 .code
39883 dkim_verify_signers = $sender_address_domain:$dkim_signers
39884 .endd
39885
39886 If a domain or identity is listed several times in the (expanded) value of
39887 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
39888
39889 .new
39890 Note that if the option is set using untrustworthy data
39891 (such as the From: header)
39892 care should be taken to force lowercase for domains
39893 and for the domain part if identities.
39894 The default setting can be regarded as trustworthy in this respect.
39895 .wen
39896
39897 If multiple signatures match a domain (or identity), the ACL is called once
39898 for each matching signature.
39899
39900
39901 Inside the &%acl_smtp_dkim%&, the following expansion variables are
39902 available (from most to least important):
39903
39904
39905 .vlist
39906 .vitem &%$dkim_cur_signer%&
39907 The signer that is being evaluated in this ACL run. This can be a domain or
39908 an identity. This is one of the list items from the expanded main option
39909 &%dkim_verify_signers%& (see above).
39910
39911 .vitem &%$dkim_verify_status%&
39912 Within the DKIM ACL,
39913 a string describing the general status of the signature. One of
39914 .ilist
39915 &%none%&: There is no signature in the message for the current domain or
39916 identity (as reflected by &%$dkim_cur_signer%&).
39917 .next
39918 &%invalid%&: The signature could not be verified due to a processing error.
39919 More detail is available in &%$dkim_verify_reason%&.
39920 .next
39921 &%fail%&: Verification of the signature failed.  More detail is
39922 available in &%$dkim_verify_reason%&.
39923 .next
39924 &%pass%&: The signature passed verification. It is valid.
39925 .endlist
39926
39927 This variable can be overwritten using an ACL 'set' modifier.
39928 This might, for instance, be done to enforce a policy restriction on
39929 hash-method or key-size:
39930 .code
39931   warn condition       = ${if eq {$dkim_verify_status}{pass}}
39932        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
39933        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
39934                                   {< {$dkim_key_length}{1024}}}}
39935        logwrite        = NOTE: forcing DKIM verify fail (was pass)
39936        set dkim_verify_status = fail
39937        set dkim_verify_reason = hash too weak or key too short
39938 .endd
39939
39940 So long as a DKIM ACL is defined (it need do no more than accept),
39941 after all the DKIM ACL runs have completed, the value becomes a
39942 colon-separated list of the values after each run.
39943 This is maintained for the mime, prdr and data ACLs.
39944
39945 .vitem &%$dkim_verify_reason%&
39946 A string giving a little bit more detail when &%$dkim_verify_status%& is either
39947 "fail" or "invalid". One of
39948 .ilist
39949 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
39950 key for the domain could not be retrieved. This may be a temporary problem.
39951 .next
39952 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
39953 record for the domain is syntactically invalid.
39954 .next
39955 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
39956 body hash does not match the one specified in the signature header. This
39957 means that the message body was modified in transit.
39958 .next
39959 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
39960 could not be verified. This may mean that headers were modified,
39961 re-written or otherwise changed in a way which is incompatible with
39962 DKIM verification. It may of course also mean that the signature is forged.
39963 .endlist
39964
39965 This variable can be overwritten, with any value, using an ACL 'set' modifier.
39966
39967 .vitem &%$dkim_domain%&
39968 The signing domain. IMPORTANT: This variable is only populated if there is
39969 an actual signature in the message for the current domain or identity (as
39970 reflected by &%$dkim_cur_signer%&).
39971
39972 .vitem &%$dkim_identity%&
39973 The signing identity, if present. IMPORTANT: This variable is only populated
39974 if there is an actual signature in the message for the current domain or
39975 identity (as reflected by &%$dkim_cur_signer%&).
39976
39977 .vitem &%$dkim_selector%&
39978 The key record selector string.
39979
39980 .vitem &%$dkim_algo%&
39981 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
39982 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39983 may also be 'ed25519-sha256'.
39984 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39985 for EC keys.
39986
39987 Note that RFC 8301 says:
39988 .code
39989 rsa-sha1 MUST NOT be used for signing or verifying.
39990
39991 DKIM signatures identified as having been signed with historic
39992 algorithms (currently, rsa-sha1) have permanently failed evaluation
39993 .endd
39994
39995 To enforce this you must have a DKIM ACL which checks this variable
39996 and overwrites the &$dkim_verify_status$& variable as discussed above.
39997
39998 .vitem &%$dkim_canon_body%&
39999 The body canonicalization method. One of 'relaxed' or 'simple'.
40000
40001 .vitem &%$dkim_canon_headers%&
40002 The header canonicalization method. One of 'relaxed' or 'simple'.
40003
40004 .vitem &%$dkim_copiedheaders%&
40005 A transcript of headers and their values which are included in the signature
40006 (copied from the 'z=' tag of the signature).
40007 Note that RFC6376 requires that verification fail if the From: header is
40008 not included in the signature.  Exim does not enforce this; sites wishing
40009 strict enforcement should code the check explicitly.
40010
40011 .vitem &%$dkim_bodylength%&
40012 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40013 limit was set by the signer, "9999999999999" is returned. This makes sure
40014 that this variable always expands to an integer value.
40015 &*Note:*& The presence of the signature tag specifying a signing body length
40016 is one possible route to spoofing of valid DKIM signatures.
40017 A paranoid implementation might wish to regard signature where this variable
40018 shows less than the "no limit" return as being invalid.
40019
40020 .vitem &%$dkim_created%&
40021 UNIX timestamp reflecting the date and time when the signature was created.
40022 When this was not specified by the signer, "0" is returned.
40023
40024 .vitem &%$dkim_expires%&
40025 UNIX timestamp reflecting the date and time when the signer wants the
40026 signature to be treated as "expired". When this was not specified by the
40027 signer, "9999999999999" is returned. This makes it possible to do useful
40028 integer size comparisons against this value.
40029 Note that Exim does not check this value.
40030
40031 .vitem &%$dkim_headernames%&
40032 A colon-separated list of names of headers included in the signature.
40033
40034 .vitem &%$dkim_key_testing%&
40035 "1" if the key record has the "testing" flag set, "0" if not.
40036
40037 .vitem &%$dkim_key_nosubdomains%&
40038 "1" if the key record forbids subdomaining, "0" otherwise.
40039
40040 .vitem &%$dkim_key_srvtype%&
40041 Service type (tag s=) from the key record. Defaults to "*" if not specified
40042 in the key record.
40043
40044 .vitem &%$dkim_key_granularity%&
40045 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40046 in the key record.
40047
40048 .vitem &%$dkim_key_notes%&
40049 Notes from the key record (tag n=).
40050
40051 .vitem &%$dkim_key_length%&
40052 Number of bits in the key.
40053
40054 Note that RFC 8301 says:
40055 .code
40056 Verifiers MUST NOT consider signatures using RSA keys of
40057 less than 1024 bits as valid signatures.
40058 .endd
40059
40060 To enforce this you must have a DKIM ACL which checks this variable
40061 and overwrites the &$dkim_verify_status$& variable as discussed above.
40062 As EC keys are much smaller, the check should only do this for RSA keys.
40063
40064 .endlist
40065
40066 In addition, two ACL conditions are provided:
40067
40068 .vlist
40069 .vitem &%dkim_signers%&
40070 ACL condition that checks a colon-separated list of domains or identities
40071 for a match against the domain or identity that the ACL is currently verifying
40072 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40073 verb to a group of domains or identities. For example:
40074
40075 .code
40076 # Warn when Mail purportedly from GMail has no gmail signature
40077 warn log_message = GMail sender without gmail.com DKIM signature
40078      sender_domains = gmail.com
40079      dkim_signers = gmail.com
40080      dkim_status = none
40081 .endd
40082
40083 Note that the above does not check for a total lack of DKIM signing;
40084 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40085
40086 .vitem &%dkim_status%&
40087 ACL condition that checks a colon-separated list of possible DKIM verification
40088 results against the actual result of verification. This is typically used
40089 to restrict an ACL verb to a list of verification outcomes, for example:
40090
40091 .code
40092 deny message = Mail from Paypal with invalid/missing signature
40093      sender_domains = paypal.com:paypal.de
40094      dkim_signers = paypal.com:paypal.de
40095      dkim_status = none:invalid:fail
40096 .endd
40097
40098 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40099 see the documentation of the &%$dkim_verify_status%& expansion variable above
40100 for more information of what they mean.
40101 .endlist
40102
40103
40104
40105
40106 .section "SPF (Sender Policy Framework)" SECSPF
40107 .cindex SPF verification
40108
40109 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40110 messages with its domain in the envelope from, documented by RFC 7208.
40111 For more information on SPF see &url(http://www.openspf.org).
40112 . --- 2018-09-07: still not https
40113
40114 Messages sent by a system not authorised will fail checking of such assertions.
40115 This includes retransmissions done by traditional forwarders.
40116
40117 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40118 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40119 &url(https://www.libspf2.org/).
40120 There is no Exim involvement in the transmission of messages;
40121 publishing certain DNS records is all that is required.
40122
40123 For verification, an ACL condition and an expansion lookup are provided.
40124 .cindex authentication "expansion item"
40125 Performing verification sets up information used by the
40126 &$authresults$& expansion item.
40127
40128
40129 .cindex SPF "ACL condition"
40130 .cindex ACL "spf condition"
40131 The ACL condition "spf" can be used at or after the MAIL ACL.
40132 It takes as an argument a list of strings giving the outcome of the SPF check,
40133 and will succeed for any matching outcome.
40134 Valid strings are:
40135 .vlist
40136 .vitem &%pass%&
40137 The SPF check passed, the sending host is positively verified by SPF.
40138
40139 .vitem &%fail%&
40140 The SPF check failed, the sending host is NOT allowed to send mail for the
40141 domain in the envelope-from address.
40142
40143 .vitem &%softfail%&
40144 The SPF check failed, but the queried domain can't absolutely confirm that this
40145 is a forgery.
40146
40147 .vitem &%none%&
40148 The queried domain does not publish SPF records.
40149
40150 .vitem &%neutral%&
40151 The SPF check returned a "neutral" state.  This means the queried domain has
40152 published a SPF record, but wants to allow outside servers to send mail under
40153 its domain as well.  This should be treated like "none".
40154
40155 .vitem &%permerror%&
40156 This indicates a syntax error in the SPF record of the queried domain.
40157 You may deny messages when this occurs.
40158
40159 .vitem &%temperror%&
40160 This indicates a temporary error during all processing, including Exim's
40161 SPF processing.  You may defer messages when this occurs.
40162 .endlist
40163
40164 You can prefix each string with an exclamation mark to  invert
40165 its meaning,  for example  "!fail" will  match all  results but
40166 "fail".  The  string  list is  evaluated  left-to-right,  in a
40167 short-circuit fashion.
40168
40169 Example:
40170 .code
40171 deny spf = fail
40172      message = $sender_host_address is not allowed to send mail from \
40173                ${if def:sender_address_domain \
40174                     {$sender_address_domain}{$sender_helo_name}}.  \
40175                Please see http://www.openspf.org/Why?scope=\
40176                ${if def:sender_address_domain {mfrom}{helo}};\
40177                identity=${if def:sender_address_domain \
40178                              {$sender_address}{$sender_helo_name}};\
40179                ip=$sender_host_address
40180 .endd
40181
40182 When the spf condition has run, it sets up several expansion
40183 variables:
40184
40185 .cindex SPF "verification variables"
40186 .vlist
40187 .vitem &$spf_header_comment$&
40188 .vindex &$spf_header_comment$&
40189   This contains a human-readable string describing the outcome
40190   of the SPF check. You can add it to a custom header or use
40191   it for logging purposes.
40192
40193 .vitem &$spf_received$&
40194 .vindex &$spf_received$&
40195   This contains a complete Received-SPF: header that can be
40196   added to the message. Please note that according to the SPF
40197   draft, this header must be added at the top of the header
40198   list. Please see section 10 on how you can do this.
40199
40200   Note: in case of "Best-guess" (see below), the convention is
40201   to put this string in a header called X-SPF-Guess: instead.
40202
40203 .vitem &$spf_result$&
40204 .vindex &$spf_result$&
40205   This contains the outcome of the SPF check in string form,
40206   one of pass, fail, softfail, none, neutral, permerror or
40207   temperror.
40208
40209 .vitem &$spf_result_guessed$&
40210 .vindex &$spf_result_guessed$&
40211   This boolean is true only if a best-guess operation was used
40212   and required in order to obtain a result.
40213
40214 .vitem &$spf_smtp_comment$&
40215 .vindex &$spf_smtp_comment$&
40216   This contains a string that can be used in a SMTP response
40217   to the calling party. Useful for "fail".
40218 .endlist
40219
40220
40221 .cindex SPF "ACL condition"
40222 .cindex ACL "spf_guess condition"
40223 .cindex SPF "best guess"
40224 In addition to SPF, you can also perform checks for so-called
40225 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40226 SPF, but it is supported by the same framework that enables SPF
40227 capability.
40228 Refer to &url(http://www.openspf.org/FAQ/Best_guess_record)
40229 for a description of what it means.
40230 . --- 2018-09-07: still not https:
40231
40232 To access this feature, simply use the spf_guess condition in place
40233 of the spf one.  For example:
40234
40235 .code
40236 deny spf_guess = fail
40237      message = $sender_host_address doesn't look trustworthy to me
40238 .endd
40239
40240 In case you decide to reject messages based on this check, you
40241 should note that although it uses the same framework, "Best-guess"
40242 is not SPF, and therefore you should not mention SPF at all in your
40243 reject message.
40244
40245 When the spf_guess condition has run, it sets up the same expansion
40246 variables as when spf condition is run, described above.
40247
40248 Additionally, since Best-guess is not standardized, you may redefine
40249 what "Best-guess" means to you by redefining the main configuration
40250 &%spf_guess%& option.
40251 For example, the following:
40252
40253 .code
40254 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40255 .endd
40256
40257 would relax host matching rules to a broader network range.
40258
40259
40260 .cindex SPF "lookup expansion"
40261 .cindex lookup spf
40262 A lookup expansion is also available. It takes an email
40263 address as the key and an IP address as the database:
40264
40265 .code
40266   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40267 .endd
40268
40269 The lookup will return the same result strings as can appear in
40270 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40271 Currently, only IPv4 addresses are supported.
40272
40273
40274
40275
40276 . ////////////////////////////////////////////////////////////////////////////
40277 . ////////////////////////////////////////////////////////////////////////////
40278
40279 .chapter "Proxies" "CHAPproxies" &&&
40280          "Proxy support"
40281 .cindex "proxy support"
40282 .cindex "proxy" "access via"
40283
40284 A proxy is an intermediate system through which communication is passed.
40285 Proxies may provide a security, availability or load-distribution function.
40286
40287
40288 .section "Inbound proxies" SECTproxyInbound
40289 .cindex proxy inbound
40290 .cindex proxy "server side"
40291 .cindex proxy "Proxy protocol"
40292 .cindex "Proxy protocol" proxy
40293
40294 Exim has support for receiving inbound SMTP connections via a proxy
40295 that uses &"Proxy Protocol"& to speak to it.
40296 To include this support, include &"SUPPORT_PROXY=yes"&
40297 in Local/Makefile.
40298
40299 It was built on the HAProxy specification, found at
40300 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40301
40302 The purpose of this facility is so that an application load balancer,
40303 such as HAProxy, can sit in front of several Exim servers
40304 to distribute load.
40305 Exim uses the local protocol communication with the proxy to obtain
40306 the remote SMTP system IP address and port information.
40307 There is no logging if a host passes or
40308 fails Proxy Protocol negotiation, but it can easily be determined and
40309 recorded in an ACL (example is below).
40310
40311 Use of a proxy is enabled by setting the &%hosts_proxy%&
40312 main configuration option to a hostlist; connections from these
40313 hosts will use Proxy Protocol.
40314 Exim supports both version 1 and version 2 of the Proxy Protocol and
40315 automatically determines which version is in use.
40316
40317 The Proxy Protocol header is the first data received on a TCP connection
40318 and is inserted before any TLS-on-connect handshake from the client; Exim
40319 negotiates TLS between Exim-as-server and the remote client, not between
40320 Exim and the proxy server.
40321
40322 The following expansion variables are usable
40323 (&"internal"& and &"external"& here refer to the interfaces
40324 of the proxy):
40325 .display
40326 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40327 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40328 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40329 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40330 &'proxy_session            '& boolean: SMTP connection via proxy
40331 .endd
40332 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40333 there was a protocol error.
40334 The variables &$sender_host_address$& and &$sender_host_port$&
40335 will have values for the actual client system, not the proxy.
40336
40337 Since the real connections are all coming from the proxy, and the
40338 per host connection tracking is done before Proxy Protocol is
40339 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
40340 handle all of the parallel volume you expect per inbound proxy.
40341 With the option set so high, you lose the ability
40342 to protect your server from many connections from one IP.
40343 In order to prevent your server from overload, you
40344 need to add a per connection ratelimit to your connect ACL.
40345 A possible solution is:
40346 .display
40347   # Set max number of connections per host
40348   LIMIT   = 5
40349   # Or do some kind of IP lookup in a flat file or database
40350   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40351
40352   defer   message        = Too many connections from this IP right now
40353           ratelimit      = LIMIT / 5s / per_conn / strict
40354 .endd
40355
40356
40357
40358 .section "Outbound proxies" SECTproxySOCKS
40359 .cindex proxy outbound
40360 .cindex proxy "client side"
40361 .cindex proxy SOCKS
40362 .cindex SOCKS proxy
40363 Exim has support for sending outbound SMTP via a proxy
40364 using a protocol called SOCKS5 (defined by RFC1928).
40365 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40366 Local/Makefile.
40367
40368 Use of a proxy is enabled by setting the &%socks_proxy%& option
40369 on an smtp transport.
40370 The option value is expanded and should then be a list
40371 (colon-separated by default) of proxy specifiers.
40372 Each proxy specifier is a list
40373 (space-separated by default) where the initial element
40374 is an IP address and any subsequent elements are options.
40375
40376 Options are a string <name>=<value>.
40377 The list of options is in the following table:
40378 .display
40379 &'auth   '& authentication method
40380 &'name   '& authentication username
40381 &'pass   '& authentication password
40382 &'port   '& tcp port
40383 &'tmo    '& connection timeout
40384 &'pri    '& priority
40385 &'weight '& selection bias
40386 .endd
40387
40388 More details on each of these options follows:
40389
40390 .ilist
40391 .cindex authentication "to proxy"
40392 .cindex proxy authentication
40393 &%auth%&: Either &"none"& (default) or &"name"&.
40394 Using &"name"& selects username/password authentication per RFC 1929
40395 for access to the proxy.
40396 Default is &"none"&.
40397 .next
40398 &%name%&: sets the username for the &"name"& authentication method.
40399 Default is empty.
40400 .next
40401 &%pass%&: sets the password for the &"name"& authentication method.
40402 Default is empty.
40403 .next
40404 &%port%&: the TCP port number to use for the connection to the proxy.
40405 Default is 1080.
40406 .next
40407 &%tmo%&: sets a connection timeout in seconds for this proxy.
40408 Default is 5.
40409 .next
40410 &%pri%&: specifies a priority for the proxy within the list,
40411 higher values being tried first.
40412 The default priority is 1.
40413 .next
40414 &%weight%&: specifies a selection bias.
40415 Within a priority set servers are queried in a random fashion,
40416 weighted by this value.
40417 The default value for selection bias is 1.
40418 .endlist
40419
40420 Proxies from the list are tried according to their priority
40421 and weight settings until one responds.  The timeout for the
40422 overall connection applies to the set of proxied attempts.
40423
40424 .section Logging SECTproxyLog
40425 To log the (local) IP of a proxy in the incoming or delivery logline,
40426 add &"+proxy"& to the &%log_selector%& option.
40427 This will add a component tagged with &"PRX="& to the line.
40428
40429 . ////////////////////////////////////////////////////////////////////////////
40430 . ////////////////////////////////////////////////////////////////////////////
40431
40432 .chapter "Internationalisation" "CHAPi18n" &&&
40433          "Internationalisation""
40434 .cindex internationalisation "email address"
40435 .cindex EAI
40436 .cindex i18n
40437 .cindex utf8 "mail name handling"
40438
40439 Exim has support for Internationalised mail names.
40440 To include this it must be built with SUPPORT_I18N and the libidn library.
40441 Standards supported are RFCs 2060, 5890, 6530 and 6533.
40442
40443 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
40444 instead of it) then IDNA2008 is supported; this adds an extra library
40445 requirement, upon libidn2.
40446
40447 .section "MTA operations" SECTi18nMTA
40448 .cindex SMTPUTF8 "ESMTP option"
40449 The main configuration option &%smtputf8_advertise_hosts%& specifies
40450 a host list.  If this matches the sending host and
40451 accept_8bitmime is true (the default) then the ESMTP option
40452 SMTPUTF8 will be advertised.
40453
40454 If the sender specifies the SMTPUTF8 option on a MAIL command
40455 international handling for the message is enabled and
40456 the expansion variable &$message_smtputf8$& will have value TRUE.
40457
40458 The option &%allow_utf8_domains%& is set to true for this
40459 message. All DNS lookups are converted to a-label form
40460 whatever the setting of &%allow_utf8_domains%&
40461 when Exim is built with SUPPORT_I18N.
40462
40463 Both localparts and domain are maintained as the original
40464 UTF-8 form internally; any comparison or regular-expression use will
40465 require appropriate care.  Filenames created, eg. by
40466 the appendfile transport, will have UTF-8 names.
40467
40468 HELO names sent by the smtp transport will have any UTF-8
40469 components expanded to a-label form,
40470 and any certificate name checks will be done using the a-label
40471 form of the name.
40472
40473 .cindex log protocol
40474 .cindex SMTPUTF8 logging
40475 .cindex i18n logging
40476 Log lines and Received-by: header lines will acquire a "utf8"
40477 prefix on the protocol element, eg. utf8esmtp.
40478
40479 The following expansion operators can be used:
40480 .code
40481 ${utf8_domain_to_alabel:str}
40482 ${utf8_domain_from_alabel:str}
40483 ${utf8_localpart_to_alabel:str}
40484 ${utf8_localpart_from_alabel:str}
40485 .endd
40486
40487 .cindex utf8 "address downconversion"
40488 .cindex i18n "utf8 address downconversion"
40489 The RCPT ACL
40490 may use the following modifier:
40491 .display
40492 control = utf8_downconvert
40493 control = utf8_downconvert/<value>
40494 .endd
40495 This sets a flag requiring that addresses are converted to
40496 a-label form before smtp delivery, for use in a
40497 Message Submission Agent context.
40498 If a value is appended it may be:
40499 .display
40500 &`1  `& (default) mandatory downconversion
40501 &`0  `& no downconversion
40502 &`-1 `& if SMTPUTF8 not supported by destination host
40503 .endd
40504
40505 If mua_wrapper is set, the utf8_downconvert control
40506 is initially set to -1.
40507
40508 The smtp transport has an option &%utf8_downconvert%&.
40509 If set it must expand to one of the three values described above,
40510 and it overrides any previously set value.
40511
40512
40513 There is no explicit support for VRFY and EXPN.
40514 Configurations supporting these should inspect
40515 &$smtp_command_argument$& for an SMTPUTF8 argument.
40516
40517 There is no support for LMTP on Unix sockets.
40518 Using the "lmtp" protocol option on an smtp transport,
40519 for LMTP over TCP, should work as expected.
40520
40521 There is no support for DSN unitext handling,
40522 and no provision for converting logging from or to UTF-8.
40523
40524
40525
40526 .section "MDA operations" SECTi18nMDA
40527 To aid in constructing names suitable for IMAP folders
40528 the following expansion operator can be used:
40529 .code
40530 ${imapfolder {<string>} {<sep>} {<specials>}}
40531 .endd
40532
40533 The string is converted from the charset specified by
40534 the "headers charset" command (in a filter file)
40535 or &%headers_charset%& main configuration option (otherwise),
40536 to the
40537 modified UTF-7 encoding specified by RFC 2060,
40538 with the following exception: All occurrences of <sep>
40539 (which has to be a single character)
40540 are replaced with periods ("."), and all periods and slashes that are not
40541 <sep> and are not in the <specials> string are BASE64 encoded.
40542
40543 The third argument can be omitted, defaulting to an empty string.
40544 The second argument can be omitted, defaulting to "/".
40545
40546 This is the encoding used by Courier for Maildir names on disk, and followed
40547 by many other IMAP servers.
40548
40549 Examples:
40550 .display
40551 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
40552 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
40553 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
40554 .endd
40555
40556 Note that the source charset setting is vital, and also that characters
40557 must be representable in UTF-16.
40558
40559
40560 . ////////////////////////////////////////////////////////////////////////////
40561 . ////////////////////////////////////////////////////////////////////////////
40562
40563 .chapter "Events" "CHAPevents" &&&
40564          "Events"
40565 .cindex events
40566
40567 The events mechanism in Exim can be used to intercept processing at a number
40568 of points.  It was originally invented to give a way to do customised logging
40569 actions (for example, to a database) but can also be used to modify some
40570 processing actions.
40571
40572 Most installations will never need to use Events.
40573 The support can be left out of a build by defining DISABLE_EVENT=yes
40574 in &_Local/Makefile_&.
40575
40576 There are two major classes of events: main and transport.
40577 The main configuration option &%event_action%& controls reception events;
40578 a transport option &%event_action%& controls delivery events.
40579
40580 Both options are a string which is expanded when the event fires.
40581 An example might look like:
40582 .cindex logging custom
40583 .code
40584 event_action = ${if eq {msg:delivery}{$event_name} \
40585 {${lookup pgsql {SELECT * FROM record_Delivery( \
40586     '${quote_pgsql:$sender_address_domain}',\
40587     '${quote_pgsql:${lc:$sender_address_local_part}}', \
40588     '${quote_pgsql:$domain}', \
40589     '${quote_pgsql:${lc:$local_part}}', \
40590     '${quote_pgsql:$host_address}', \
40591     '${quote_pgsql:${lc:$host}}', \
40592     '${quote_pgsql:$message_exim_id}')}} \
40593 } {}}
40594 .endd
40595
40596 Events have names which correspond to the point in process at which they fire.
40597 The name is placed in the variable &$event_name$& and the event action
40598 expansion must check this, as it will be called for every possible event type.
40599
40600 The current list of events is:
40601 .display
40602 &`dane:fail              after    transport  `& per connection
40603 &`msg:complete           after    main       `& per message
40604 &`msg:delivery           after    transport  `& per recipient
40605 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
40606 &`msg:rcpt:defer         after    transport  `& per recipient
40607 &`msg:host:defer         after    transport  `& per attempt
40608 &`msg:fail:delivery      after    transport  `& per recipient
40609 &`msg:fail:internal      after    main       `& per recipient
40610 &`tcp:connect            before   transport  `& per connection
40611 &`tcp:close              after    transport  `& per connection
40612 &`tls:cert               before   both       `& per certificate in verification chain
40613 &`smtp:connect           after    transport  `& per connection
40614 .endd
40615 New event types may be added in future.
40616
40617 The event name is a colon-separated list, defining the type of
40618 event in a tree of possibilities.  It may be used as a list
40619 or just matched on as a whole.  There will be no spaces in the name.
40620
40621 The second column in the table above describes whether the event fires
40622 before or after the action is associates with.  Those which fire before
40623 can be used to affect that action (more on this below).
40624
40625 The third column in the table above says what section of the configuration
40626 should define the event action.
40627
40628 An additional variable, &$event_data$&, is filled with information varying
40629 with the event type:
40630 .display
40631 &`dane:fail            `& failure reason
40632 &`msg:delivery         `& smtp confirmation message
40633 &`msg:fail:internal    `& failure reason
40634 &`msg:fail:delivery    `& smtp error message
40635 &`msg:rcpt:host:defer  `& error string
40636 &`msg:rcpt:defer       `& error string
40637 &`msg:host:defer       `& error string
40638 &`tls:cert             `& verification chain depth
40639 &`smtp:connect         `& smtp banner
40640 .endd
40641
40642 The :defer events populate one extra variable: &$event_defer_errno$&.
40643
40644 For complex operations an ACL expansion can be used in &%event_action%&
40645 however due to the multiple contexts that Exim operates in during
40646 the course of its processing:
40647 .ilist
40648 variables set in transport events will not be visible outside that
40649 transport call
40650 .next
40651 acl_m variables in a server context are lost on a new connection,
40652 and after smtp helo/ehlo/mail/starttls/rset commands
40653 .endlist
40654 Using an ACL expansion with the logwrite modifier can be
40655 a useful way of writing to the main log.
40656
40657 The expansion of the event_action option should normally
40658 return an empty string.  Should it return anything else the
40659 following will be forced:
40660 .display
40661 &`tcp:connect      `&  do not connect
40662 &`tls:cert         `&  refuse verification
40663 &`smtp:connect     `&  close connection
40664 .endd
40665 All other message types ignore the result string, and
40666 no other use is made of it.
40667
40668 For a tcp:connect event, if the connection is being made to a proxy
40669 then the address and port variables will be that of the proxy and not
40670 the target system.
40671
40672 For tls:cert events, if GnuTLS is in use this will trigger only per
40673 chain element received on the connection.
40674 For OpenSSL it will trigger for every chain element including those
40675 loaded locally.
40676
40677 . ////////////////////////////////////////////////////////////////////////////
40678 . ////////////////////////////////////////////////////////////////////////////
40679
40680 .chapter "Adding new drivers or lookup types" "CHID13" &&&
40681          "Adding drivers or lookups"
40682 .cindex "adding drivers"
40683 .cindex "new drivers, adding"
40684 .cindex "drivers" "adding new"
40685 The following actions have to be taken in order to add a new router, transport,
40686 authenticator, or lookup type to Exim:
40687
40688 .olist
40689 Choose a name for the driver or lookup type that does not conflict with any
40690 existing name; I will use &"newdriver"& in what follows.
40691 .next
40692 Add to &_src/EDITME_& the line:
40693 .display
40694 <&'type'&>&`_NEWDRIVER=yes`&
40695 .endd
40696 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
40697 code is not to be included in the binary by default, comment this line out. You
40698 should also add any relevant comments about the driver or lookup type.
40699 .next
40700 Add to &_src/config.h.defaults_& the line:
40701 .code
40702 #define <type>_NEWDRIVER
40703 .endd
40704 .next
40705 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
40706 and create a table entry as is done for all the other drivers and lookup types.
40707 .next
40708 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
40709 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
40710 Add your &`NEWDRIVER`& to that list.
40711 As long as the dynamic module would be named &_newdriver.so_&, you can use the
40712 simple form that most lookups have.
40713 .next
40714 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
40715 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
40716 driver or lookup type and add it to the definition of OBJ.
40717 .next
40718 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
40719 definition of OBJ_MACRO.  Add a set of line to do the compile also.
40720 .next
40721 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
40722 &_src_&.
40723 .next
40724 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
40725 as for other drivers and lookups.
40726 .endlist
40727
40728 Then all you need to do is write the code! A good way to start is to make a
40729 proforma by copying an existing module of the same type, globally changing all
40730 occurrences of the name, and cutting out most of the code. Note that any
40731 options you create must be listed in alphabetical order, because the tables are
40732 searched using a binary chop procedure.
40733
40734 There is a &_README_& file in each of the sub-directories of &_src_& describing
40735 the interface that is expected.
40736
40737
40738
40739
40740 . ////////////////////////////////////////////////////////////////////////////
40741 . ////////////////////////////////////////////////////////////////////////////
40742
40743 . /////////////////////////////////////////////////////////////////////////////
40744 . These lines are processing instructions for the Simple DocBook Processor that
40745 . Philip Hazel has developed as a less cumbersome way of making PostScript and
40746 . PDFs than using xmlto and fop. They will be ignored by all other XML
40747 . processors.
40748 . /////////////////////////////////////////////////////////////////////////////
40749
40750 .literal xml
40751 <?sdop
40752   format="newpage"
40753   foot_right_recto="&chaptertitle;"
40754   foot_right_verso="&chaptertitle;"
40755 ?>
40756 .literal off
40757
40758 .makeindex "Options index"   "option"
40759 .makeindex "Variables index" "variable"
40760 .makeindex "Concept index"   "concept"
40761
40762
40763 . /////////////////////////////////////////////////////////////////////////////
40764 . /////////////////////////////////////////////////////////////////////////////