PIPE_CONNECT: promote from experimental
[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 sender"
2630 Trusted users are always permitted to use the &%-f%& option or a leading
2631 &"From&~"& line to specify the envelope sender of a message that is passed to
2632 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2633 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2634 users to set envelope senders.
2635
2636 .cindex "&'From:'& header line"
2637 .cindex "&'Sender:'& header line"
2638 .cindex "header lines" "From:"
2639 .cindex "header lines" "Sender:"
2640 For a trusted user, there is never any check on the contents of the &'From:'&
2641 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2642 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2643
2644 Trusted users may also specify a host name, host address, interface address,
2645 protocol name, ident value, and authentication data when submitting a message
2646 locally. Thus, they are able to insert messages into Exim's queue locally that
2647 have the characteristics of messages received from a remote host. Untrusted
2648 users may in some circumstances use &%-f%&, but can never set the other values
2649 that are available to trusted users.
2650 .next
2651 .cindex "user" "admin definition of"
2652 .cindex "admin user" "definition of"
2653 The admin users are root, the Exim user, and any user that is a member of the
2654 Exim group or of any group listed in the &%admin_groups%& configuration option.
2655 The current group does not have to be one of these groups.
2656
2657 Admin users are permitted to list the queue, and to carry out certain
2658 operations on messages, for example, to force delivery failures. It is also
2659 necessary to be an admin user in order to see the full information provided by
2660 the Exim monitor, and full debugging output.
2661
2662 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2663 Exim to attempt delivery of messages on its queue is restricted to admin users.
2664 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2665 option false (that is, specifying &%no_prod_requires_admin%&).
2666
2667 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2668 is restricted to admin users unless &%queue_list_requires_admin%& is set
2669 false.
2670 .endlist
2671
2672
2673 &*Warning*&: If you configure your system so that admin users are able to
2674 edit Exim's configuration file, you are giving those users an easy way of
2675 getting root. There is further discussion of this issue at the start of chapter
2676 &<<CHAPconf>>&.
2677
2678
2679
2680
2681 .section "Command line options" "SECID39"
2682 Exim's command line options are described in alphabetical order below. If none
2683 of the options that specifies a specific action (such as starting the daemon or
2684 a queue runner, or testing an address, or receiving a message in a specific
2685 format, or listing the queue) are present, and there is at least one argument
2686 on the command line, &%-bm%& (accept a local message on the standard input,
2687 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2688 outputs a brief message about itself and exits.
2689
2690 . ////////////////////////////////////////////////////////////////////////////
2691 . Insert a stylized XML comment here, to identify the start of the command line
2692 . options. This is for the benefit of the Perl script that automatically
2693 . creates a man page for the options.
2694 . ////////////////////////////////////////////////////////////////////////////
2695
2696 .literal xml
2697 <!-- === Start of command line options === -->
2698 .literal off
2699
2700
2701 .vlist
2702 .vitem &%--%&
2703 .oindex "--"
2704 .cindex "options" "command line; terminating"
2705 This is a pseudo-option whose only purpose is to terminate the options and
2706 therefore to cause subsequent command line items to be treated as arguments
2707 rather than options, even if they begin with hyphens.
2708
2709 .vitem &%--help%&
2710 .oindex "&%--help%&"
2711 This option causes Exim to output a few sentences stating what it is.
2712 The same output is generated if the Exim binary is called with no options and
2713 no arguments.
2714
2715 .vitem &%--version%&
2716 .oindex "&%--version%&"
2717 This option is an alias for &%-bV%& and causes version information to be
2718 displayed.
2719
2720 .vitem &%-Ac%& &&&
2721        &%-Am%&
2722 .oindex "&%-Ac%&"
2723 .oindex "&%-Am%&"
2724 These options are used by Sendmail for selecting configuration files and are
2725 ignored by Exim.
2726
2727 .vitem &%-B%&<&'type'&>
2728 .oindex "&%-B%&"
2729 .cindex "8-bit characters"
2730 .cindex "Sendmail compatibility" "8-bit characters"
2731 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2732 clean; it ignores this option.
2733
2734 .vitem &%-bd%&
2735 .oindex "&%-bd%&"
2736 .cindex "daemon"
2737 .cindex "SMTP" "listener"
2738 .cindex "queue runner"
2739 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2740 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2741 that the daemon should also initiate periodic queue runs.
2742
2743 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2744 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2745 disconnect from the controlling terminal. When running this way, it can be
2746 stopped by pressing ctrl-C.
2747
2748 By default, Exim listens for incoming connections to the standard SMTP port on
2749 all the host's running interfaces. However, it is possible to listen on other
2750 ports, on multiple ports, and only on specific interfaces. Chapter
2751 &<<CHAPinterfaces>>& contains a description of the options that control this.
2752
2753 When a listening daemon
2754 .cindex "daemon" "process id (pid)"
2755 .cindex "pid (process id)" "of daemon"
2756 is started without the use of &%-oX%& (that is, without overriding the normal
2757 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2758 in Exim's spool directory. This location can be overridden by setting
2759 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2760 running as root.
2761
2762 When &%-oX%& is used on the command line to start a listening daemon, the
2763 process id is not written to the normal pid file path. However, &%-oP%& can be
2764 used to specify a path on the command line if a pid file is required.
2765
2766 The SIGHUP signal
2767 .cindex "SIGHUP"
2768 .cindex "daemon" "restarting"
2769 .cindex signal "to reload configuration"
2770 .cindex daemon "reload configuration"
2771 can be used to cause the daemon to re-execute itself. This should be done
2772 whenever Exim's configuration file, or any file that is incorporated into it by
2773 means of the &%.include%& facility, is changed, and also whenever a new version
2774 of Exim is installed. It is not necessary to do this when other files that are
2775 referenced from the configuration (for example, alias files) are changed,
2776 because these are reread each time they are used.
2777
2778 .vitem &%-bdf%&
2779 .oindex "&%-bdf%&"
2780 This option has the same effect as &%-bd%& except that it never disconnects
2781 from the controlling terminal, even when no debugging is specified.
2782
2783 .vitem &%-be%&
2784 .oindex "&%-be%&"
2785 .cindex "testing" "string expansion"
2786 .cindex "expansion" "testing"
2787 Run Exim in expansion testing mode. Exim discards its root privilege, to
2788 prevent ordinary users from using this mode to read otherwise inaccessible
2789 files. If no arguments are given, Exim runs interactively, prompting for lines
2790 of data. Otherwise, it processes each argument in turn.
2791
2792 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2793 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2794 used without command line arguments. If successful, it uses the &[readline()]&
2795 function, which provides extensive line-editing facilities, for reading the
2796 test data. A line history is supported.
2797
2798 Long expansion expressions can be split over several lines by using backslash
2799 continuations. As in Exim's runtime configuration, white space at the start of
2800 continuation lines is ignored. Each argument or data line is passed through the
2801 string expansion mechanism, and the result is output. Variable values from the
2802 configuration file (for example, &$qualify_domain$&) are available, but no
2803 message-specific values (such as &$message_exim_id$&) are set, because no message
2804 is being processed (but see &%-bem%& and &%-Mset%&).
2805
2806 &*Note*&: If you use this mechanism to test lookups, and you change the data
2807 files or databases you are using, you must exit and restart Exim before trying
2808 the same lookup again. Otherwise, because each Exim process caches the results
2809 of lookups, you will just get the same result as before.
2810
2811 Macro processing is done on lines before string-expansion: new macros can be
2812 defined and macros will be expanded.
2813 Because macros in the config file are often used for secrets, those are only
2814 available to admin users.
2815
2816 .vitem &%-bem%&&~<&'filename'&>
2817 .oindex "&%-bem%&"
2818 .cindex "testing" "string expansion"
2819 .cindex "expansion" "testing"
2820 This option operates like &%-be%& except that it must be followed by the name
2821 of a file. For example:
2822 .code
2823 exim -bem /tmp/testmessage
2824 .endd
2825 The file is read as a message (as if receiving a locally-submitted non-SMTP
2826 message) before any of the test expansions are done. Thus, message-specific
2827 variables such as &$message_size$& and &$header_from:$& are available. However,
2828 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2829 recipients are read from the headers in the normal way, and are shown in the
2830 &$recipients$& variable. Note that recipients cannot be given on the command
2831 line, because further arguments are taken as strings to expand (just like
2832 &%-be%&).
2833
2834 .vitem &%-bF%&&~<&'filename'&>
2835 .oindex "&%-bF%&"
2836 .cindex "system filter" "testing"
2837 .cindex "testing" "system filter"
2838 This option is the same as &%-bf%& except that it assumes that the filter being
2839 tested is a system filter. The additional commands that are available only in
2840 system filters are recognized.
2841
2842 .vitem &%-bf%&&~<&'filename'&>
2843 .oindex "&%-bf%&"
2844 .cindex "filter" "testing"
2845 .cindex "testing" "filter file"
2846 .cindex "forward file" "testing"
2847 .cindex "testing" "forward file"
2848 .cindex "Sieve filter" "testing"
2849 This option runs Exim in user filter testing mode; the file is the filter file
2850 to be tested, and a test message must be supplied on the standard input. If
2851 there are no message-dependent tests in the filter, an empty file can be
2852 supplied.
2853
2854 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2855 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2856 filter and a user filter in the same run. For example:
2857 .code
2858 exim -bF /system/filter -bf /user/filter </test/message
2859 .endd
2860 This is helpful when the system filter adds header lines or sets filter
2861 variables that are used by the user filter.
2862
2863 If the test filter file does not begin with one of the special lines
2864 .code
2865 # Exim filter
2866 # Sieve filter
2867 .endd
2868 it is taken to be a normal &_.forward_& file, and is tested for validity under
2869 that interpretation. See sections &<<SECTitenonfilred>>& to
2870 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2871 redirection lists.
2872
2873 The result of an Exim command that uses &%-bf%&, provided no errors are
2874 detected, is a list of the actions that Exim would try to take if presented
2875 with the message for real. More details of filter testing are given in the
2876 separate document entitled &'Exim's interfaces to mail filtering'&.
2877
2878 When testing a filter file,
2879 .cindex "&""From""& line"
2880 .cindex "envelope sender"
2881 .oindex "&%-f%&" "for filter testing"
2882 the envelope sender can be set by the &%-f%& option,
2883 or by a &"From&~"& line at the start of the test message. Various parameters
2884 that would normally be taken from the envelope recipient address of the message
2885 can be set by means of additional command line options (see the next four
2886 options).
2887
2888 .vitem &%-bfd%&&~<&'domain'&>
2889 .oindex "&%-bfd%&"
2890 .vindex "&$qualify_domain$&"
2891 This sets the domain of the recipient address when a filter file is being
2892 tested by means of the &%-bf%& option. The default is the value of
2893 &$qualify_domain$&.
2894
2895 .vitem &%-bfl%&&~<&'local&~part'&>
2896 .oindex "&%-bfl%&"
2897 This sets the local part of the recipient address when a filter file is being
2898 tested by means of the &%-bf%& option. The default is the username of the
2899 process that calls Exim. A local part should be specified with any prefix or
2900 suffix stripped, because that is how it appears to the filter when a message is
2901 actually being delivered.
2902
2903 .vitem &%-bfp%&&~<&'prefix'&>
2904 .oindex "&%-bfp%&"
2905 .cindex affix "filter testing"
2906 This sets the prefix of the local part of the recipient address when a filter
2907 file is being tested by means of the &%-bf%& option. The default is an empty
2908 prefix.
2909
2910 .vitem &%-bfs%&&~<&'suffix'&>
2911 .oindex "&%-bfs%&"
2912 .cindex affix "filter testing"
2913 This sets the suffix of the local part of the recipient address when a filter
2914 file is being tested by means of the &%-bf%& option. The default is an empty
2915 suffix.
2916
2917 .vitem &%-bh%&&~<&'IP&~address'&>
2918 .oindex "&%-bh%&"
2919 .cindex "testing" "incoming SMTP"
2920 .cindex "SMTP" "testing incoming"
2921 .cindex "testing" "relay control"
2922 .cindex "relaying" "testing configuration"
2923 .cindex "policy control" "testing"
2924 .cindex "debugging" "&%-bh%& option"
2925 This option runs a fake SMTP session as if from the given IP address, using the
2926 standard input and output. The IP address may include a port number at the end,
2927 after a full stop. For example:
2928 .code
2929 exim -bh 10.9.8.7.1234
2930 exim -bh fe80::a00:20ff:fe86:a061.5678
2931 .endd
2932 When an IPv6 address is given, it is converted into canonical form. In the case
2933 of the second example above, the value of &$sender_host_address$& after
2934 conversion to the canonical form is
2935 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2936
2937 Comments as to what is going on are written to the standard error file. These
2938 include lines beginning with &"LOG"& for anything that would have been logged.
2939 This facility is provided for testing configuration options for incoming
2940 messages, to make sure they implement the required policy. For example, you can
2941 test your relay controls using &%-bh%&.
2942
2943 &*Warning 1*&:
2944 .cindex "RFC 1413"
2945 You can test features of the configuration that rely on ident (RFC 1413)
2946 information by using the &%-oMt%& option. However, Exim cannot actually perform
2947 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2948 connection.
2949
2950 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2951 are also skipped when testing using &%-bh%&. If you want these callouts to
2952 occur, use &%-bhc%& instead.
2953
2954 Messages supplied during the testing session are discarded, and nothing is
2955 written to any of the real log files. There may be pauses when DNS (and other)
2956 lookups are taking place, and of course these may time out. The &%-oMi%& option
2957 can be used to specify a specific IP interface and port if this is important,
2958 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2959 session were authenticated.
2960
2961 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2962 output just states whether a given recipient address from a given host is
2963 acceptable or not. See section &<<SECTcheckaccess>>&.
2964
2965 Features such as authentication and encryption, where the client input is not
2966 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2967 specialized SMTP test program such as
2968 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2969
2970 .vitem &%-bhc%&&~<&'IP&~address'&>
2971 .oindex "&%-bhc%&"
2972 This option operates in the same way as &%-bh%&, except that address
2973 verification callouts are performed if required. This includes consulting and
2974 updating the callout cache database.
2975
2976 .vitem &%-bi%&
2977 .oindex "&%-bi%&"
2978 .cindex "alias file" "building"
2979 .cindex "building alias file"
2980 .cindex "Sendmail compatibility" "&%-bi%& option"
2981 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2982 Exim does not have the concept of a single alias file, and so it cannot mimic
2983 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2984 tend to appear in various scripts such as NIS make files, so the option must be
2985 recognized.
2986
2987 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2988 configuration option is run, under the uid and gid of the caller of Exim. If
2989 the &%-oA%& option is used, its value is passed to the command as an argument.
2990 The command set by &%bi_command%& may not contain arguments. The command can
2991 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2992 if this is required. If the &%bi_command%& option is not set, calling Exim with
2993 &%-bi%& is a no-op.
2994
2995 . // Keep :help first, then the rest in alphabetical order
2996 .vitem &%-bI:help%&
2997 .oindex "&%-bI:help%&"
2998 .cindex "querying exim information"
2999 We shall provide various options starting &`-bI:`& for querying Exim for
3000 information.  The output of many of these will be intended for machine
3001 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3002 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3003 options shall cause Exim to exit after producing the requested output.
3004
3005 .vitem &%-bI:dscp%&
3006 .oindex "&%-bI:dscp%&"
3007 .cindex "DSCP" "values"
3008 This option causes Exim to emit an alphabetically sorted list of all
3009 recognised DSCP names.
3010
3011 .vitem &%-bI:sieve%&
3012 .oindex "&%-bI:sieve%&"
3013 .cindex "Sieve filter" "capabilities"
3014 This option causes Exim to emit an alphabetically sorted list of all supported
3015 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3016 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3017 &`SIEVE`& capability response line.  As the precise list may depend upon
3018 compile-time build options, which this option will adapt to, this is the only
3019 way to guarantee a correct response.
3020
3021 .vitem &%-bm%&
3022 .oindex "&%-bm%&"
3023 .cindex "local message reception"
3024 This option runs an Exim receiving process that accepts an incoming,
3025 locally-generated message on the standard input. The recipients are given as the
3026 command arguments (except when &%-t%& is also present &-- see below). Each
3027 argument can be a comma-separated list of RFC 2822 addresses. This is the
3028 default option for selecting the overall action of an Exim call; it is assumed
3029 if no other conflicting option is present.
3030
3031 If any addresses in the message are unqualified (have no domain), they are
3032 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3033 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3034 suppressing this for special cases.
3035
3036 Policy checks on the contents of local messages can be enforced by means of
3037 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3038
3039 .cindex "return code" "for &%-bm%&"
3040 The return code is zero if the message is successfully accepted. Otherwise, the
3041 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3042
3043 The format
3044 .cindex "message" "format"
3045 .cindex "format" "message"
3046 .cindex "&""From""& line"
3047 .cindex "UUCP" "&""From""& line"
3048 .cindex "Sendmail compatibility" "&""From""& line"
3049 of the message must be as defined in RFC 2822, except that, for
3050 compatibility with Sendmail and Smail, a line in one of the forms
3051 .code
3052 From sender Fri Jan  5 12:55 GMT 1997
3053 From sender Fri, 5 Jan 97 12:55:01
3054 .endd
3055 (with the weekday optional, and possibly with additional text after the date)
3056 is permitted to appear at the start of the message. There appears to be no
3057 authoritative specification of the format of this line. Exim recognizes it by
3058 matching against the regular expression defined by the &%uucp_from_pattern%&
3059 option, which can be changed if necessary.
3060
3061 .oindex "&%-f%&" "overriding &""From""& line"
3062 The specified sender is treated as if it were given as the argument to the
3063 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3064 preference to the address taken from the message. The caller of Exim must be a
3065 trusted user for the sender of a message to be set in this way.
3066
3067 .vitem &%-bmalware%&&~<&'filename'&>
3068 .oindex "&%-bmalware%&"
3069 .cindex "testing", "malware"
3070 .cindex "malware scan test"
3071 This debugging option causes Exim to scan the given file or directory
3072 (depending on the used scanner interface),
3073 using the malware scanning framework.  The option of &%av_scanner%& influences
3074 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3075 the expansion should have defaults which apply to this invocation.  ACLs are
3076 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3077 will never be populated and &%-bmalware%& will fail.
3078
3079 Exim will have changed working directory before resolving the filename, so
3080 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3081 user when it tries to open the file, rather than as the invoking user.
3082 This option requires admin privileges.
3083
3084 The &%-bmalware%& option will not be extended to be more generally useful,
3085 there are better tools for file-scanning.  This option exists to help
3086 administrators verify their Exim and AV scanner configuration.
3087
3088 .vitem &%-bnq%&
3089 .oindex "&%-bnq%&"
3090 .cindex "address qualification, suppressing"
3091 By default, Exim automatically qualifies unqualified addresses (those
3092 without domains) that appear in messages that are submitted locally (that
3093 is, not over TCP/IP). This qualification applies both to addresses in
3094 envelopes, and addresses in header lines. Sender addresses are qualified using
3095 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3096 defaults to the value of &%qualify_domain%&).
3097
3098 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3099 being used to re-submit messages that originally came from remote hosts after
3100 content scanning, you probably do not want to qualify unqualified addresses in
3101 header lines. (Such lines will be present only if you have not enabled a header
3102 syntax check in the appropriate ACL.)
3103
3104 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3105 messages that originate on the local host. When this is used, unqualified
3106 addresses in the envelope provoke errors (causing message rejection) and
3107 unqualified addresses in header lines are left alone.
3108
3109
3110 .vitem &%-bP%&
3111 .oindex "&%-bP%&"
3112 .cindex "configuration options" "extracting"
3113 .cindex "options" "configuration &-- extracting"
3114 If this option is given with no arguments, it causes the values of all Exim's
3115 main configuration options to be written to the standard output. The values
3116 of one or more specific options can be requested by giving their names as
3117 arguments, for example:
3118 .code
3119 exim -bP qualify_domain hold_domains
3120 .endd
3121 .cindex "hiding configuration option values"
3122 .cindex "configuration options" "hiding value of"
3123 .cindex "options" "hiding value of"
3124 However, any option setting that is preceded by the word &"hide"& in the
3125 configuration file is not shown in full, except to an admin user. For other
3126 users, the output is as in this example:
3127 .code
3128 mysql_servers = <value not displayable>
3129 .endd
3130 If &%config%& is given as an argument, the config is
3131 output, as it was parsed, any include file resolved, any comment removed.
3132
3133 If &%config_file%& is given as an argument, the name of the runtime
3134 configuration file is output. (&%configure_file%& works too, for
3135 backward compatibility.)
3136 If a list of configuration files was supplied, the value that is output here
3137 is the name of the file that was actually used.
3138
3139 .cindex "options" "hiding name of"
3140 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3141 name will not be output.
3142
3143 .cindex "daemon" "process id (pid)"
3144 .cindex "pid (process id)" "of daemon"
3145 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3146 directories where log files and daemon pid files are written are output,
3147 respectively. If these values are unset, log files are written in a
3148 sub-directory of the spool directory called &%log%&, and the pid file is
3149 written directly into the spool directory.
3150
3151 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3152 .code
3153 exim -bP +local_domains
3154 .endd
3155 it searches for a matching named list of any type (domain, host, address, or
3156 local part) and outputs what it finds.
3157
3158 .cindex "options" "router &-- extracting"
3159 .cindex "options" "transport &-- extracting"
3160 .cindex "options" "authenticator &-- extracting"
3161 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3162 followed by the name of an appropriate driver instance, the option settings for
3163 that driver are output. For example:
3164 .code
3165 exim -bP transport local_delivery
3166 .endd
3167 The generic driver options are output first, followed by the driver's private
3168 options. A list of the names of drivers of a particular type can be obtained by
3169 using one of the words &%router_list%&, &%transport_list%&, or
3170 &%authenticator_list%&, and a complete list of all drivers with their option
3171 settings can be obtained by using &%routers%&, &%transports%&, or
3172 &%authenticators%&.
3173
3174 .cindex "environment"
3175 If &%environment%& is given as an argument, the set of environment
3176 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3177 variables.
3178
3179 .cindex "options" "macro &-- extracting"
3180 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3181 are available, similarly to the drivers.  Because macros are sometimes used
3182 for storing passwords, this option is restricted.
3183 The output format is one item per line.
3184 For the "-bP macro <name>" form, if no such macro is found
3185 the exit status will be nonzero.
3186
3187 .vitem &%-bp%&
3188 .oindex "&%-bp%&"
3189 .cindex "queue" "listing messages in"
3190 .cindex "listing" "messages in the queue"
3191 This option requests a listing of the contents of the mail queue on the
3192 standard output. If the &%-bp%& option is followed by a list of message ids,
3193 just those messages are listed. By default, this option can be used only by an
3194 admin user. However, the &%queue_list_requires_admin%& option can be set false
3195 to allow any user to see the queue.
3196
3197 Each message in the queue is displayed as in the following example:
3198 .code
3199 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3200           red.king@looking-glass.fict.example
3201           <other addresses>
3202 .endd
3203 .cindex "message" "size in queue listing"
3204 .cindex "size" "of message"
3205 The first line contains the length of time the message has been in the queue
3206 (in this case 25 minutes), the size of the message (2.9K), the unique local
3207 identifier for the message, and the message sender, as contained in the
3208 envelope. For bounce messages, the sender address is empty, and appears as
3209 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3210 the default sender address, the user's login name is shown in parentheses
3211 before the sender address.
3212
3213 .cindex "frozen messages" "in queue listing"
3214 If the message is frozen (attempts to deliver it are suspended) then the text
3215 &"*** frozen ***"& is displayed at the end of this line.
3216
3217 The recipients of the message (taken from the envelope, not the headers) are
3218 displayed on subsequent lines. Those addresses to which the message has already
3219 been delivered are marked with the letter D. If an original address gets
3220 expanded into several addresses via an alias or forward file, the original is
3221 displayed with a D only when deliveries for all of its child addresses are
3222 complete.
3223
3224
3225 .vitem &%-bpa%&
3226 .oindex "&%-bpa%&"
3227 This option operates like &%-bp%&, but in addition it shows delivered addresses
3228 that were generated from the original top level address(es) in each message by
3229 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3230 of just &"D"&.
3231
3232
3233 .vitem &%-bpc%&
3234 .oindex "&%-bpc%&"
3235 .cindex "queue" "count of messages on"
3236 This option counts the number of messages in the queue, and writes the total
3237 to the standard output. It is restricted to admin users, unless
3238 &%queue_list_requires_admin%& is set false.
3239
3240
3241 .vitem &%-bpr%&
3242 .oindex "&%-bpr%&"
3243 This option operates like &%-bp%&, but the output is not sorted into
3244 chronological order of message arrival. This can speed it up when there are
3245 lots of messages in the queue, and is particularly useful if the output is
3246 going to be post-processed in a way that doesn't need the sorting.
3247
3248 .vitem &%-bpra%&
3249 .oindex "&%-bpra%&"
3250 This option is a combination of &%-bpr%& and &%-bpa%&.
3251
3252 .vitem &%-bpru%&
3253 .oindex "&%-bpru%&"
3254 This option is a combination of &%-bpr%& and &%-bpu%&.
3255
3256
3257 .vitem &%-bpu%&
3258 .oindex "&%-bpu%&"
3259 This option operates like &%-bp%& but shows only undelivered top-level
3260 addresses for each message displayed. Addresses generated by aliasing or
3261 forwarding are not shown, unless the message was deferred after processing by a
3262 router with the &%one_time%& option set.
3263
3264
3265 .vitem &%-brt%&
3266 .oindex "&%-brt%&"
3267 .cindex "testing" "retry configuration"
3268 .cindex "retry" "configuration testing"
3269 This option is for testing retry rules, and it must be followed by up to three
3270 arguments. It causes Exim to look for a retry rule that matches the values
3271 and to write it to the standard output. For example:
3272 .code
3273 exim -brt bach.comp.mus.example
3274 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3275 .endd
3276 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3277 argument, which is required, can be a complete address in the form
3278 &'local_part@domain'&, or it can be just a domain name. If the second argument
3279 contains a dot, it is interpreted as an optional second domain name; if no
3280 retry rule is found for the first argument, the second is tried. This ties in
3281 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3282 rule is found that matches the host, one that matches the mail domain is
3283 sought. Finally, an argument that is the name of a specific delivery error, as
3284 used in setting up retry rules, can be given. For example:
3285 .code
3286 exim -brt haydn.comp.mus.example quota_3d
3287 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3288 .endd
3289
3290 .vitem &%-brw%&
3291 .oindex "&%-brw%&"
3292 .cindex "testing" "rewriting"
3293 .cindex "rewriting" "testing"
3294 This option is for testing address rewriting rules, and it must be followed by
3295 a single argument, consisting of either a local part without a domain, or a
3296 complete address with a fully qualified domain. Exim outputs how this address
3297 would be rewritten for each possible place it might appear. See chapter
3298 &<<CHAPrewrite>>& for further details.
3299
3300 .vitem &%-bS%&
3301 .oindex "&%-bS%&"
3302 .cindex "SMTP" "batched incoming"
3303 .cindex "batched SMTP input"
3304 This option is used for batched SMTP input, which is an alternative interface
3305 for non-interactive local message submission. A number of messages can be
3306 submitted in a single run. However, despite its name, this is not really SMTP
3307 input. Exim reads each message's envelope from SMTP commands on the standard
3308 input, but generates no responses. If the caller is trusted, or
3309 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3310 believed; otherwise the sender is always the caller of Exim.
3311
3312 The message itself is read from the standard input, in SMTP format (leading
3313 dots doubled), terminated by a line containing just a single dot. An error is
3314 provoked if the terminating dot is missing. A further message may then follow.
3315
3316 As for other local message submissions, the contents of incoming batch SMTP
3317 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3318 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3319 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3320
3321 Some other SMTP commands are recognized in the input. HELO and EHLO act
3322 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3323 QUIT quits, ignoring the rest of the standard input.
3324
3325 .cindex "return code" "for &%-bS%&"
3326 If any error is encountered, reports are written to the standard output and
3327 error streams, and Exim gives up immediately. The return code is 0 if no error
3328 was detected; it is 1 if one or more messages were accepted before the error
3329 was detected; otherwise it is 2.
3330
3331 More details of input using batched SMTP are given in section
3332 &<<SECTincomingbatchedSMTP>>&.
3333
3334 .vitem &%-bs%&
3335 .oindex "&%-bs%&"
3336 .cindex "SMTP" "local input"
3337 .cindex "local SMTP input"
3338 This option causes Exim to accept one or more messages by reading SMTP commands
3339 on the standard input, and producing SMTP replies on the standard output. SMTP
3340 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3341 Some user agents use this interface as a way of passing locally-generated
3342 messages to the MTA.
3343
3344 In
3345 .cindex "sender" "source of"
3346 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3347 set, the senders of messages are taken from the SMTP MAIL commands.
3348 Otherwise the content of these commands is ignored and the sender is set up as
3349 the calling user. Unqualified addresses are automatically qualified using
3350 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3351 &%-bnq%& option is used.
3352
3353 .cindex "inetd"
3354 The
3355 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3356 using a listening daemon. Exim can distinguish the two cases by checking
3357 whether the standard input is a TCP/IP socket. When Exim is called from
3358 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3359 above concerning senders and qualification do not apply. In this situation,
3360 Exim behaves in exactly the same way as it does when receiving a message via
3361 the listening daemon.
3362
3363 .vitem &%-bt%&
3364 .oindex "&%-bt%&"
3365 .cindex "testing" "addresses"
3366 .cindex "address" "testing"
3367 This option runs Exim in address testing mode, in which each argument is taken
3368 as a recipient address to be tested for deliverability. The results are
3369 written to the standard output. If a test fails, and the caller is not an admin
3370 user, no details of the failure are output, because these might contain
3371 sensitive information such as usernames and passwords for database lookups.
3372
3373 If no arguments are given, Exim runs in an interactive manner, prompting with a
3374 right angle bracket for addresses to be tested.
3375
3376 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3377 &[readline()]& function, because it is running as &'root'& and there are
3378 security issues.
3379
3380 Each address is handled as if it were the recipient address of a message
3381 (compare the &%-bv%& option). It is passed to the routers and the result is
3382 written to the standard output. However, any router that has
3383 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3384 genuine routing tests if your first router passes everything to a scanner
3385 program.
3386
3387 .cindex "return code" "for &%-bt%&"
3388 The return code is 2 if any address failed outright; it is 1 if no address
3389 failed outright but at least one could not be resolved for some reason. Return
3390 code 0 is given only when all addresses succeed.
3391
3392 .cindex "duplicate addresses"
3393 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3394 addresses after routing is complete, so that only one delivery takes place.
3395 This does not happen when testing with &%-bt%&; the full results of routing are
3396 always shown.
3397
3398 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3399 routers in the configuration makes any tests on the sender address of a
3400 message,
3401 .oindex "&%-f%&" "for address testing"
3402 you can use the &%-f%& option to set an appropriate sender when running
3403 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3404 default qualifying domain. However, if you have set up (for example) routers
3405 whose behaviour depends on the contents of an incoming message, you cannot test
3406 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3407 doing such tests.
3408
3409 .vitem &%-bV%&
3410 .oindex "&%-bV%&"
3411 .cindex "version number of Exim"
3412 This option causes Exim to write the current version number, compilation
3413 number, and compilation date of the &'exim'& binary to the standard output.
3414 It also lists the DBM library that is being used, the optional modules (such as
3415 specific lookup types), the drivers that are included in the binary, and the
3416 name of the runtime configuration file that is in use.
3417
3418 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3419 configuration file. However, this is a static check only. It cannot check
3420 values that are to be expanded. For example, although a misspelt ACL verb is
3421 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3422 alone to discover (for example) all the typos in the configuration; some
3423 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3424 dynamic testing facilities.
3425
3426 .vitem &%-bv%&
3427 .oindex "&%-bv%&"
3428 .cindex "verifying address" "using &%-bv%&"
3429 .cindex "address" "verification"
3430 This option runs Exim in address verification mode, in which each argument is
3431 taken as a recipient address to be verified by the routers. (This does
3432 not involve any verification callouts). During normal operation, verification
3433 happens mostly as a consequence processing a &%verify%& condition in an ACL
3434 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3435 including callouts, see the &%-bh%& and &%-bhc%& options.
3436
3437 If verification fails, and the caller is not an admin user, no details of the
3438 failure are output, because these might contain sensitive information such as
3439 usernames and passwords for database lookups.
3440
3441 If no arguments are given, Exim runs in an interactive manner, prompting with a
3442 right angle bracket for addresses to be verified.
3443
3444 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3445 &[readline()]& function, because it is running as &'exim'& and there are
3446 security issues.
3447
3448 Verification differs from address testing (the &%-bt%& option) in that routers
3449 that have &%no_verify%& set are skipped, and if the address is accepted by a
3450 router that has &%fail_verify%& set, verification fails. The address is
3451 verified as a recipient if &%-bv%& is used; to test verification for a sender
3452 address, &%-bvs%& should be used.
3453
3454 If the &%-v%& option is not set, the output consists of a single line for each
3455 address, stating whether it was verified or not, and giving a reason in the
3456 latter case. Without &%-v%&, generating more than one address by redirection
3457 causes verification to end successfully, without considering the generated
3458 addresses. However, if just one address is generated, processing continues,
3459 and the generated address must verify successfully for the overall verification
3460 to succeed.
3461
3462 When &%-v%& is set, more details are given of how the address has been handled,
3463 and in the case of address redirection, all the generated addresses are also
3464 considered. Verification may succeed for some and fail for others.
3465
3466 The
3467 .cindex "return code" "for &%-bv%&"
3468 return code is 2 if any address failed outright; it is 1 if no address
3469 failed outright but at least one could not be resolved for some reason. Return
3470 code 0 is given only when all addresses succeed.
3471
3472 If any of the routers in the configuration makes any tests on the sender
3473 address of a message, you should use the &%-f%& option to set an appropriate
3474 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3475 calling user at the default qualifying domain.
3476
3477 .vitem &%-bvs%&
3478 .oindex "&%-bvs%&"
3479 This option acts like &%-bv%&, but verifies the address as a sender rather
3480 than a recipient address. This affects any rewriting and qualification that
3481 might happen.
3482
3483 .vitem &%-bw%&
3484 .oindex "&%-bw%&"
3485 .cindex "daemon"
3486 .cindex "inetd"
3487 .cindex "inetd" "wait mode"
3488 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3489 similarly to the &%-bd%& option.  All port specifications on the command-line
3490 and in the configuration file are ignored.  Queue-running may not be specified.
3491
3492 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3493 listening for connections.  This permits the system to start up and have
3494 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3495 each port only when the first connection is received.
3496
3497 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3498 which the daemon will exit, which should cause inetd to listen once more.
3499
3500 .vitem &%-C%&&~<&'filelist'&>
3501 .oindex "&%-C%&"
3502 .cindex "configuration file" "alternate"
3503 .cindex "CONFIGURE_FILE"
3504 .cindex "alternate configuration file"
3505 This option causes Exim to find the runtime configuration file from the given
3506 list instead of from the list specified by the CONFIGURE_FILE
3507 compile-time setting. Usually, the list will consist of just a single filename,
3508 but it can be a colon-separated list of names. In this case, the first
3509 file that exists is used. Failure to open an existing file stops Exim from
3510 proceeding any further along the list, and an error is generated.
3511
3512 When this option is used by a caller other than root, and the list is different
3513 from the compiled-in list, Exim gives up its root privilege immediately, and
3514 runs with the real and effective uid and gid set to those of the caller.
3515 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3516 file contains a list of full pathnames, one per line, for configuration files
3517 which are trusted. Root privilege is retained for any configuration file so
3518 listed, as long as the caller is the Exim user (or the user specified in the
3519 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3520 not writeable by inappropriate users or groups.
3521
3522 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3523 configuration using &%-C%& right through message reception and delivery,
3524 even if the caller is root. The reception works, but by that time, Exim is
3525 running as the Exim user, so when it re-executes to regain privilege for the
3526 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3527 test reception and delivery using two separate commands (one to put a message
3528 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3529
3530 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3531 prefix string with which any file named in a &%-C%& command line option
3532 must start. In addition, the filename must not contain the sequence &`/../`&.
3533 However, if the value of the &%-C%& option is identical to the value of
3534 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3535 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3536 unset, any filename can be used with &%-C%&.
3537
3538 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3539 to a directory to which only root has access. This prevents someone who has
3540 broken into the Exim account from running a privileged Exim with an arbitrary
3541 configuration file.
3542
3543 The &%-C%& facility is useful for ensuring that configuration files are
3544 syntactically correct, but cannot be used for test deliveries, unless the
3545 caller is privileged, or unless it is an exotic configuration that does not
3546 require privilege. No check is made on the owner or group of the files
3547 specified by this option.
3548
3549
3550 .vitem &%-D%&<&'macro'&>=<&'value'&>
3551 .oindex "&%-D%&"
3552 .cindex "macro" "setting on command line"
3553 This option can be used to override macro definitions in the configuration file
3554 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3555 unprivileged caller, it causes Exim to give up its root privilege.
3556 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3557 completely disabled, and its use causes an immediate error exit.
3558
3559 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3560 colon-separated list of macros which are considered safe and, if &%-D%& only
3561 supplies macros from this list, and the values are acceptable, then Exim will
3562 not give up root privilege if the caller is root, the Exim run-time user, or
3563 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3564 to be removed in the future.  Acceptable values for the macros satisfy the
3565 regexp: &`^[A-Za-z0-9_/.-]*$`&
3566
3567 The entire option (including equals sign if present) must all be within one
3568 command line item. &%-D%& can be used to set the value of a macro to the empty
3569 string, in which case the equals sign is optional. These two commands are
3570 synonymous:
3571 .code
3572 exim -DABC  ...
3573 exim -DABC= ...
3574 .endd
3575 To include spaces in a macro definition item, quotes must be used. If you use
3576 quotes, spaces are permitted around the macro name and the equals sign. For
3577 example:
3578 .code
3579 exim '-D ABC = something' ...
3580 .endd
3581 &%-D%& may be repeated up to 10 times on a command line.
3582 Only macro names up to 22 letters long can be set.
3583
3584
3585 .vitem &%-d%&<&'debug&~options'&>
3586 .oindex "&%-d%&"
3587 .cindex "debugging" "list of selectors"
3588 .cindex "debugging" "&%-d%& option"
3589 This option causes debugging information to be written to the standard
3590 error stream. It is restricted to admin users because debugging output may show
3591 database queries that contain password information. Also, the details of users'
3592 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3593 writes an error message to the standard error stream and exits with a non-zero
3594 return code.
3595
3596 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3597 standard debugging data is output. This can be reduced, or increased to include
3598 some more rarely needed information, by directly following &%-d%& with a string
3599 made up of names preceded by plus or minus characters. These add or remove sets
3600 of debugging data, respectively. For example, &%-d+filter%& adds filter
3601 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3602 no spaces are allowed in the debug setting. The available debugging categories
3603 are:
3604 .display
3605 &`acl            `& ACL interpretation
3606 &`auth           `& authenticators
3607 &`deliver        `& general delivery logic
3608 &`dns            `& DNS lookups (see also resolver)
3609 &`dnsbl          `& DNS black list (aka RBL) code
3610 &`exec           `& arguments for &[execv()]& calls
3611 &`expand         `& detailed debugging for string expansions
3612 &`filter         `& filter handling
3613 &`hints_lookup   `& hints data lookups
3614 &`host_lookup    `& all types of name-to-IP address handling
3615 &`ident          `& ident lookup
3616 &`interface      `& lists of local interfaces
3617 &`lists          `& matching things in lists
3618 &`load           `& system load checks
3619 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3620                     &<<CHAPlocalscan>>&)
3621 &`lookup         `& general lookup code and all lookups
3622 &`memory         `& memory handling
3623 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3624 &`pid            `& modifier: add pid to debug output lines
3625 &`process_info   `& setting info for the process log
3626 &`queue_run      `& queue runs
3627 &`receive        `& general message reception logic
3628 &`resolver       `& turn on the DNS resolver's debugging output
3629 &`retry          `& retry handling
3630 &`rewrite        `& address rewriting
3631 &`route          `& address routing
3632 &`timestamp      `& modifier: add timestamp to debug output lines
3633 &`tls            `& TLS logic
3634 &`transport      `& transports
3635 &`uid            `& changes of uid/gid and looking up uid/gid
3636 &`verify         `& address verification logic
3637 &`all            `& almost all of the above (see below), and also &%-v%&
3638 .endd
3639 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3640 for &`-all`&. The reason for this is that &`+all`& is something that people
3641 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3642 is included, an awful lot of output that is very rarely of interest is
3643 generated, so it now has to be explicitly requested. However, &`-all`& does
3644 turn everything off.
3645
3646 .cindex "resolver, debugging output"
3647 .cindex "DNS resolver, debugging output"
3648 The &`resolver`& option produces output only if the DNS resolver was compiled
3649 with DEBUG enabled. This is not the case in some operating systems. Also,
3650 unfortunately, debugging output from the DNS resolver is written to stdout
3651 rather than stderr.
3652
3653 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3654 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3655 However, the &`pid`& selector is forced when debugging is turned on for a
3656 daemon, which then passes it on to any re-executed Exims. Exim also
3657 automatically adds the pid to debug lines when several remote deliveries are
3658 run in parallel.
3659
3660 The &`timestamp`& selector causes the current time to be inserted at the start
3661 of all debug output lines. This can be useful when trying to track down delays
3662 in processing.
3663
3664 .cindex debugging "UTF-8 in"
3665 .cindex UTF-8 "in debug output"
3666 The &`noutf8`& selector disables the use of
3667 UTF-8 line-drawing characters to group related information.
3668 When disabled. ascii-art is used instead.
3669 Using the &`+all`& option does not set this modifier,
3670
3671 If the &%debug_print%& option is set in any driver, it produces output whenever
3672 any debugging is selected, or if &%-v%& is used.
3673
3674 .vitem &%-dd%&<&'debug&~options'&>
3675 .oindex "&%-dd%&"
3676 This option behaves exactly like &%-d%& except when used on a command that
3677 starts a daemon process. In that case, debugging is turned off for the
3678 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3679 behaviour of the daemon without creating as much output as full debugging does.
3680
3681 .vitem &%-dropcr%&
3682 .oindex "&%-dropcr%&"
3683 This is an obsolete option that is now a no-op. It used to affect the way Exim
3684 handled CR and LF characters in incoming messages. What happens now is
3685 described in section &<<SECTlineendings>>&.
3686
3687 .vitem &%-E%&
3688 .oindex "&%-E%&"
3689 .cindex "bounce message" "generating"
3690 This option specifies that an incoming message is a locally-generated delivery
3691 failure report. It is used internally by Exim when handling delivery failures
3692 and is not intended for external use. Its only effect is to stop Exim
3693 generating certain messages to the postmaster, as otherwise message cascades
3694 could occur in some situations. As part of the same option, a message id may
3695 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3696 new message contains the id, following &"R="&, as a cross-reference.
3697
3698 .vitem &%-e%&&'x'&
3699 .oindex "&%-e%&&'x'&"
3700 There are a number of Sendmail options starting with &%-oe%& which seem to be
3701 called by various programs without the leading &%o%& in the option. For
3702 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3703 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3704
3705 .vitem &%-F%&&~<&'string'&>
3706 .oindex "&%-F%&"
3707 .cindex "sender" "name"
3708 .cindex "name" "of sender"
3709 This option sets the sender's full name for use when a locally-generated
3710 message is being accepted. In the absence of this option, the user's &'gecos'&
3711 entry from the password data is used. As users are generally permitted to alter
3712 their &'gecos'& entries, no security considerations are involved. White space
3713 between &%-F%& and the <&'string'&> is optional.
3714
3715 .vitem &%-f%&&~<&'address'&>
3716 .oindex "&%-f%&"
3717 .cindex "sender" "address"
3718 .cindex "address" "sender"
3719 .cindex "trusted users"
3720 .cindex "envelope sender"
3721 .cindex "user" "trusted"
3722 This option sets the address of the envelope sender of a locally-generated
3723 message (also known as the return path). The option can normally be used only
3724 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3725 users to use it.
3726
3727 Processes running as root or the Exim user are always trusted. Other
3728 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3729 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3730 of a local message is set to the caller's login name at the default qualify
3731 domain.
3732
3733 There is one exception to the restriction on the use of &%-f%&: an empty sender
3734 can be specified by any user, trusted or not, to create a message that can
3735 never provoke a bounce. An empty sender can be specified either as an empty
3736 string, or as a pair of angle brackets with nothing between them, as in these
3737 examples of shell commands:
3738 .code
3739 exim -f '<>' user@domain
3740 exim -f "" user@domain
3741 .endd
3742 In addition, the use of &%-f%& is not restricted when testing a filter file
3743 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3744 &%-bv%& options.
3745
3746 Allowing untrusted users to change the sender address does not of itself make
3747 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3748 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3749 though this can be overridden by setting &%no_local_from_check%&.
3750
3751 White
3752 .cindex "&""From""& line"
3753 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3754 given as two arguments or one combined argument). The sender of a
3755 locally-generated message can also be set (when permitted) by an initial
3756 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3757 if &%-f%& is also present, it overrides &"From&~"&.
3758
3759 .vitem &%-G%&
3760 .oindex "&%-G%&"
3761 .cindex "submission fixups, suppressing (command-line)"
3762 This option is equivalent to an ACL applying:
3763 .code
3764 control = suppress_local_fixups
3765 .endd
3766 for every message received.  Note that Sendmail will complain about such
3767 bad formatting, where Exim silently just does not fix it up.  This may change
3768 in future.
3769
3770 As this affects audit information, the caller must be a trusted user to use
3771 this option.
3772
3773 .vitem &%-h%&&~<&'number'&>
3774 .oindex "&%-h%&"
3775 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3776 This option is accepted for compatibility with Sendmail, but has no effect. (In
3777 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3778 headers.)
3779
3780 .vitem &%-i%&
3781 .oindex "&%-i%&"
3782 .cindex "Solaris" "&'mail'& command"
3783 .cindex "dot" "in incoming non-SMTP message"
3784 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3785 line by itself should not terminate an incoming, non-SMTP message. I can find
3786 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3787 command in Solaris 2.4 uses it. See also &%-ti%&.
3788
3789 .vitem &%-L%&&~<&'tag'&>
3790 .oindex "&%-L%&"
3791 .cindex "syslog" "process name; set with flag"
3792 This option is equivalent to setting &%syslog_processname%& in the config
3793 file and setting &%log_file_path%& to &`syslog`&.
3794 Its use is restricted to administrators.  The configuration file has to be
3795 read and parsed, to determine access rights, before this is set and takes
3796 effect, so early configuration file errors will not honour this flag.
3797
3798 The tag should not be longer than 32 characters.
3799
3800 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3801 .oindex "&%-M%&"
3802 .cindex "forcing delivery"
3803 .cindex "delivery" "forcing attempt"
3804 .cindex "frozen messages" "forcing delivery"
3805 This option requests Exim to run a delivery attempt on each message in turn. If
3806 any of the messages are frozen, they are automatically thawed before the
3807 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3808 and &%hold_domains%& are ignored.
3809
3810 Retry
3811 .cindex "hints database" "overriding retry hints"
3812 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3813 the normal retry time has not yet been reached. This option requires the caller
3814 to be an admin user. However, there is an option called &%prod_requires_admin%&
3815 which can be set false to relax this restriction (and also the same requirement
3816 for the &%-q%&, &%-R%&, and &%-S%& options).
3817
3818 The deliveries happen synchronously, that is, the original Exim process does
3819 not terminate until all the delivery attempts have finished. No output is
3820 produced unless there is a serious error. If you want to see what is happening,
3821 use the &%-v%& option as well, or inspect Exim's main log.
3822
3823 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3824 .oindex "&%-Mar%&"
3825 .cindex "message" "adding recipients"
3826 .cindex "recipient" "adding"
3827 This option requests Exim to add the addresses to the list of recipients of the
3828 message (&"ar"& for &"add recipients"&). The first argument must be a message
3829 id, and the remaining ones must be email addresses. However, if the message is
3830 active (in the middle of a delivery attempt), it is not altered. This option
3831 can be used only by an admin user.
3832
3833 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3834         &~<&'message&~id'&>"
3835 .oindex "&%-MC%&"
3836 .cindex "SMTP" "passed connection"
3837 .cindex "SMTP" "multiple deliveries"
3838 .cindex "multiple SMTP deliveries"
3839 This option is not intended for use by external callers. It is used internally
3840 by Exim to invoke another instance of itself to deliver a waiting message using
3841 an existing SMTP connection, which is passed as the standard input. Details are
3842 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3843 must be root or the Exim user in order to use it.
3844
3845 .vitem &%-MCA%&
3846 .oindex "&%-MCA%&"
3847 This option is not intended for use by external callers. It is used internally
3848 by Exim in conjunction with the &%-MC%& option. It signifies that the
3849 connection to the remote host has been authenticated.
3850
3851 .vitem &%-MCD%&
3852 .oindex "&%-MCD%&"
3853 This option is not intended for use by external callers. It is used internally
3854 by Exim in conjunction with the &%-MC%& option. It signifies that the
3855 remote host supports the ESMTP &_DSN_& extension.
3856
3857 .vitem &%-MCG%&&~<&'queue&~name'&>
3858 .oindex "&%-MCG%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option. It signifies that an
3861 alternate queue is used, named by the following argument.
3862
3863 .vitem &%-MCK%&
3864 .oindex "&%-MCK%&"
3865 This option is not intended for use by external callers. It is used internally
3866 by Exim in conjunction with the &%-MC%& option. It signifies that a
3867 remote host supports the ESMTP &_CHUNKING_& extension.
3868
3869 .vitem &%-MCP%&
3870 .oindex "&%-MCP%&"
3871 This option is not intended for use by external callers. It is used internally
3872 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3873 which Exim is connected supports pipelining.
3874
3875 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3876 .oindex "&%-MCQ%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-MC%& option when the original delivery was
3879 started by a queue runner. It passes on the process id of the queue runner,
3880 together with the file descriptor number of an open pipe. Closure of the pipe
3881 signals the final completion of the sequence of processes that are passing
3882 messages through the same SMTP connection.
3883
3884 .vitem &%-MCS%&
3885 .oindex "&%-MCS%&"
3886 This option is not intended for use by external callers. It is used internally
3887 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3888 SMTP SIZE option should be used on messages delivered down the existing
3889 connection.
3890
3891 .vitem &%-MCT%&
3892 .oindex "&%-MCT%&"
3893 This option is not intended for use by external callers. It is used internally
3894 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3895 host to which Exim is connected supports TLS encryption.
3896
3897 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3898 .oindex "&%-MCt%&"
3899 This option is not intended for use by external callers. It is used internally
3900 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3901 connection is being proxied by a parent process for handling TLS encryption.
3902 The arguments give the local address and port being proxied, and the TLS cipher.
3903
3904 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3905 .oindex "&%-Mc%&"
3906 .cindex "hints database" "not overridden by &%-Mc%&"
3907 .cindex "delivery" "manually started &-- not forced"
3908 This option requests Exim to run a delivery attempt on each message, in turn,
3909 but unlike the &%-M%& option, it does check for retry hints, and respects any
3910 that are found. This option is not very useful to external callers. It is
3911 provided mainly for internal use by Exim when it needs to re-invoke itself in
3912 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3913 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3914 respects retry times and other options such as &%hold_domains%& that are
3915 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3916 If you want to run a specific delivery as if in a queue run, you should use
3917 &%-q%& with a message id argument. A distinction between queue run deliveries
3918 and other deliveries is made in one or two places.
3919
3920 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3921 .oindex "&%-Mes%&"
3922 .cindex "message" "changing sender"
3923 .cindex "sender" "changing"
3924 This option requests Exim to change the sender address in the message to the
3925 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3926 &"edit sender"&). There must be exactly two arguments. The first argument must
3927 be a message id, and the second one an email address. However, if the message
3928 is active (in the middle of a delivery attempt), its status is not altered.
3929 This option can be used only by an admin user.
3930
3931 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3932 .oindex "&%-Mf%&"
3933 .cindex "freezing messages"
3934 .cindex "message" "manually freezing"
3935 This option requests Exim to mark each listed message as &"frozen"&. This
3936 prevents any delivery attempts taking place until the message is &"thawed"&,
3937 either manually or as a result of the &%auto_thaw%& configuration option.
3938 However, if any of the messages are active (in the middle of a delivery
3939 attempt), their status is not altered. This option can be used only by an admin
3940 user.
3941
3942 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3943 .oindex "&%-Mg%&"
3944 .cindex "giving up on messages"
3945 .cindex "message" "abandoning delivery attempts"
3946 .cindex "delivery" "abandoning further attempts"
3947 This option requests Exim to give up trying to deliver the listed messages,
3948 including any that are frozen. However, if any of the messages are active,
3949 their status is not altered. For non-bounce messages, a delivery error message
3950 is sent to the sender, containing the text &"cancelled by administrator"&.
3951 Bounce messages are just discarded. This option can be used only by an admin
3952 user.
3953
3954 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3955 .oindex "&%-Mmad%&"
3956 .cindex "delivery" "cancelling all"
3957 This option requests Exim to mark all the recipient addresses in the messages
3958 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3959 message is active (in the middle of a delivery attempt), its status is not
3960 altered. This option can be used only by an admin user.
3961
3962 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3963 .oindex "&%-Mmd%&"
3964 .cindex "delivery" "cancelling by address"
3965 .cindex "recipient" "removing"
3966 .cindex "removing recipients"
3967 This option requests Exim to mark the given addresses as already delivered
3968 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3969 the remaining ones must be email addresses. These are matched to recipient
3970 addresses in the message in a case-sensitive manner. If the message is active
3971 (in the middle of a delivery attempt), its status is not altered. This option
3972 can be used only by an admin user.
3973
3974 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3975 .oindex "&%-Mrm%&"
3976 .cindex "removing messages"
3977 .cindex "abandoning mail"
3978 .cindex "message" "manually discarding"
3979 This option requests Exim to remove the given messages from the queue. No
3980 bounce messages are sent; each message is simply forgotten. However, if any of
3981 the messages are active, their status is not altered. This option can be used
3982 only by an admin user or by the user who originally caused the message to be
3983 placed in the queue.
3984
3985 . .new
3986 . .vitem &%-MS%&
3987 . .oindex "&%-MS%&"
3988 . .cindex REQUIRETLS
3989 . This option is used to request REQUIRETLS processing on the message.
3990 . It is used internally by Exim in conjunction with -E when generating
3991 . a bounce message.
3992 . .wen
3993
3994 .vitem &%-Mset%&&~<&'message&~id'&>
3995 .oindex "&%-Mset%&"
3996 .cindex "testing" "string expansion"
3997 .cindex "expansion" "testing"
3998 This option is useful only in conjunction with &%-be%& (that is, when testing
3999 string expansions). Exim loads the given message from its spool before doing
4000 the test expansions, thus setting message-specific variables such as
4001 &$message_size$& and the header variables. The &$recipients$& variable is made
4002 available. This feature is provided to make it easier to test expansions that
4003 make use of these variables. However, this option can be used only by an admin
4004 user. See also &%-bem%&.
4005
4006 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4007 .oindex "&%-Mt%&"
4008 .cindex "thawing messages"
4009 .cindex "unfreezing messages"
4010 .cindex "frozen messages" "thawing"
4011 .cindex "message" "thawing frozen"
4012 This option requests Exim to &"thaw"& any of the listed messages that are
4013 &"frozen"&, so that delivery attempts can resume. However, if any of the
4014 messages are active, their status is not altered. This option can be used only
4015 by an admin user.
4016
4017 .vitem &%-Mvb%&&~<&'message&~id'&>
4018 .oindex "&%-Mvb%&"
4019 .cindex "listing" "message body"
4020 .cindex "message" "listing body of"
4021 This option causes the contents of the message body (-D) spool file to be
4022 written to the standard output. This option can be used only by an admin user.
4023
4024 .vitem &%-Mvc%&&~<&'message&~id'&>
4025 .oindex "&%-Mvc%&"
4026 .cindex "message" "listing in RFC 2822 format"
4027 .cindex "listing" "message in RFC 2822 format"
4028 This option causes a copy of the complete message (header lines plus body) to
4029 be written to the standard output in RFC 2822 format. This option can be used
4030 only by an admin user.
4031
4032 .vitem &%-Mvh%&&~<&'message&~id'&>
4033 .oindex "&%-Mvh%&"
4034 .cindex "listing" "message headers"
4035 .cindex "header lines" "listing"
4036 .cindex "message" "listing header lines"
4037 This option causes the contents of the message headers (-H) spool file to be
4038 written to the standard output. This option can be used only by an admin user.
4039
4040 .vitem &%-Mvl%&&~<&'message&~id'&>
4041 .oindex "&%-Mvl%&"
4042 .cindex "listing" "message log"
4043 .cindex "message" "listing message log"
4044 This option causes the contents of the message log spool file to be written to
4045 the standard output. This option can be used only by an admin user.
4046
4047 .vitem &%-m%&
4048 .oindex "&%-m%&"
4049 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4050 treats it that way too.
4051
4052 .vitem &%-N%&
4053 .oindex "&%-N%&"
4054 .cindex "debugging" "&%-N%& option"
4055 .cindex "debugging" "suppressing delivery"
4056 This is a debugging option that inhibits delivery of a message at the transport
4057 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4058 it just doesn't actually transport the message, but instead behaves as if it
4059 had successfully done so. However, it does not make any updates to the retry
4060 database, and the log entries for deliveries are flagged with &"*>"& rather
4061 than &"=>"&.
4062
4063 Because &%-N%& discards any message to which it applies, only root or the Exim
4064 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4065 words, an ordinary user can use it only when supplying an incoming message to
4066 which it will apply. Although transportation never fails when &%-N%& is set, an
4067 address may be deferred because of a configuration problem on a transport, or a
4068 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4069 the message, and applies to any subsequent delivery attempts that may happen
4070 for that message.
4071
4072 .vitem &%-n%&
4073 .oindex "&%-n%&"
4074 This option is interpreted by Sendmail to mean &"no aliasing"&.
4075 For normal modes of operation, it is ignored by Exim.
4076 When combined with &%-bP%& it makes the output more terse (suppresses
4077 option names, environment values and config pretty printing).
4078
4079 .vitem &%-O%&&~<&'data'&>
4080 .oindex "&%-O%&"
4081 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4082 Exim.
4083
4084 .vitem &%-oA%&&~<&'file&~name'&>
4085 .oindex "&%-oA%&"
4086 .cindex "Sendmail compatibility" "&%-oA%& option"
4087 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4088 alternative alias filename. Exim handles &%-bi%& differently; see the
4089 description above.
4090
4091 .vitem &%-oB%&&~<&'n'&>
4092 .oindex "&%-oB%&"
4093 .cindex "SMTP" "passed connection"
4094 .cindex "SMTP" "multiple deliveries"
4095 .cindex "multiple SMTP deliveries"
4096 This is a debugging option which limits the maximum number of messages that can
4097 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4098 transport. If <&'n'&> is omitted, the limit is set to 1.
4099
4100 .vitem &%-odb%&
4101 .oindex "&%-odb%&"
4102 .cindex "background delivery"
4103 .cindex "delivery" "in the background"
4104 This option applies to all modes in which Exim accepts incoming messages,
4105 including the listening daemon. It requests &"background"& delivery of such
4106 messages, which means that the accepting process automatically starts a
4107 delivery process for each message received, but does not wait for the delivery
4108 processes to finish.
4109
4110 When all the messages have been received, the reception process exits,
4111 leaving the delivery processes to finish in their own time. The standard output
4112 and error streams are closed at the start of each delivery process.
4113 This is the default action if none of the &%-od%& options are present.
4114
4115 If one of the queueing options in the configuration file
4116 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4117 overrides it if &%queue_only_override%& is set true, which is the default
4118 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4119
4120 .vitem &%-odf%&
4121 .oindex "&%-odf%&"
4122 .cindex "foreground delivery"
4123 .cindex "delivery" "in the foreground"
4124 This option requests &"foreground"& (synchronous) delivery when Exim has
4125 accepted a locally-generated message. (For the daemon it is exactly the same as
4126 &%-odb%&.) A delivery process is automatically started to deliver the message,
4127 and Exim waits for it to complete before proceeding.
4128
4129 The original Exim reception process does not finish until the delivery
4130 process for the final message has ended. The standard error stream is left open
4131 during deliveries.
4132
4133 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4134 false and one of the queueing options in the configuration file is in effect.
4135
4136 If there is a temporary delivery error during foreground delivery, the
4137 message is left in the queue for later delivery, and the original reception
4138 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4139 restricted configuration that never queues messages.
4140
4141
4142 .vitem &%-odi%&
4143 .oindex "&%-odi%&"
4144 This option is synonymous with &%-odf%&. It is provided for compatibility with
4145 Sendmail.
4146
4147 .vitem &%-odq%&
4148 .oindex "&%-odq%&"
4149 .cindex "non-immediate delivery"
4150 .cindex "delivery" "suppressing immediate"
4151 .cindex "queueing incoming messages"
4152 This option applies to all modes in which Exim accepts incoming messages,
4153 including the listening daemon. It specifies that the accepting process should
4154 not automatically start a delivery process for each message received. Messages
4155 are placed in the queue, and remain there until a subsequent queue runner
4156 process encounters them. There are several configuration options (such as
4157 &%queue_only%&) that can be used to queue incoming messages under certain
4158 conditions. This option overrides all of them and also &%-odqs%&. It always
4159 forces queueing.
4160
4161 .vitem &%-odqs%&
4162 .oindex "&%-odqs%&"
4163 .cindex "SMTP" "delaying delivery"
4164 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4165 However, like &%-odb%& and &%-odi%&, this option has no effect if
4166 &%queue_only_override%& is false and one of the queueing options in the
4167 configuration file is in effect.
4168
4169 When &%-odqs%& does operate, a delivery process is started for each incoming
4170 message, in the background by default, but in the foreground if &%-odi%& is
4171 also present. The recipient addresses are routed, and local deliveries are done
4172 in the normal way. However, if any SMTP deliveries are required, they are not
4173 done at this time, so the message remains in the queue until a subsequent queue
4174 runner process encounters it. Because routing was done, Exim knows which
4175 messages are waiting for which hosts, and so a number of messages for the same
4176 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4177 configuration option has the same effect for specific domains. See also the
4178 &%-qq%& option.
4179
4180 .vitem &%-oee%&
4181 .oindex "&%-oee%&"
4182 .cindex "error" "reporting"
4183 If an error is detected while a non-SMTP message is being received (for
4184 example, a malformed address), the error is reported to the sender in a mail
4185 message.
4186
4187 .cindex "return code" "for &%-oee%&"
4188 Provided
4189 this error message is successfully sent, the Exim receiving process
4190 exits with a return code of zero. If not, the return code is 2 if the problem
4191 is that the original message has no recipients, or 1 for any other error.
4192 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4193
4194 .vitem &%-oem%&
4195 .oindex "&%-oem%&"
4196 .cindex "error" "reporting"
4197 .cindex "return code" "for &%-oem%&"
4198 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4199 return code, whether or not the error message was successfully sent.
4200 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4201
4202 .vitem &%-oep%&
4203 .oindex "&%-oep%&"
4204 .cindex "error" "reporting"
4205 If an error is detected while a non-SMTP message is being received, the
4206 error is reported by writing a message to the standard error file (stderr).
4207 .cindex "return code" "for &%-oep%&"
4208 The return code is 1 for all errors.
4209
4210 .vitem &%-oeq%&
4211 .oindex "&%-oeq%&"
4212 .cindex "error" "reporting"
4213 This option is supported for compatibility with Sendmail, but has the same
4214 effect as &%-oep%&.
4215
4216 .vitem &%-oew%&
4217 .oindex "&%-oew%&"
4218 .cindex "error" "reporting"
4219 This option is supported for compatibility with Sendmail, but has the same
4220 effect as &%-oem%&.
4221
4222 .vitem &%-oi%&
4223 .oindex "&%-oi%&"
4224 .cindex "dot" "in incoming non-SMTP message"
4225 This option, which has the same effect as &%-i%&, specifies that a dot on a
4226 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4227 single dot does terminate, though Exim does no special processing for other
4228 lines that start with a dot. This option is set by default if Exim is called as
4229 &'rmail'&. See also &%-ti%&.
4230
4231 .vitem &%-oitrue%&
4232 .oindex "&%-oitrue%&"
4233 This option is treated as synonymous with &%-oi%&.
4234
4235 .vitem &%-oMa%&&~<&'host&~address'&>
4236 .oindex "&%-oMa%&"
4237 .cindex "sender" "host address, specifying for local message"
4238 A number of options starting with &%-oM%& can be used to set values associated
4239 with remote hosts on locally-submitted messages (that is, messages not received
4240 over TCP/IP). These options can be used by any caller in conjunction with the
4241 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4242 other circumstances, they are ignored unless the caller is trusted.
4243
4244 The &%-oMa%& option sets the sender host address. This may include a port
4245 number at the end, after a full stop (period). For example:
4246 .code
4247 exim -bs -oMa 10.9.8.7.1234
4248 .endd
4249 An alternative syntax is to enclose the IP address in square brackets,
4250 followed by a colon and the port number:
4251 .code
4252 exim -bs -oMa [10.9.8.7]:1234
4253 .endd
4254 The IP address is placed in the &$sender_host_address$& variable, and the
4255 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4256 are present on the command line, the sender host IP address is taken from
4257 whichever one is last.
4258
4259 .vitem &%-oMaa%&&~<&'name'&>
4260 .oindex "&%-oMaa%&"
4261 .cindex "authentication" "name, specifying for local message"
4262 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4263 option sets the value of &$sender_host_authenticated$& (the authenticator
4264 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4265 This option can be used with &%-bh%& and &%-bs%& to set up an
4266 authenticated SMTP session without actually using the SMTP AUTH command.
4267
4268 .vitem &%-oMai%&&~<&'string'&>
4269 .oindex "&%-oMai%&"
4270 .cindex "authentication" "id, specifying for local message"
4271 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4272 option sets the value of &$authenticated_id$& (the id that was authenticated).
4273 This overrides the default value (the caller's login id, except with &%-bh%&,
4274 where there is no default) for messages from local sources. See chapter
4275 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4276
4277 .vitem &%-oMas%&&~<&'address'&>
4278 .oindex "&%-oMas%&"
4279 .cindex "authentication" "sender, specifying for local message"
4280 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4281 option sets the authenticated sender value in &$authenticated_sender$&. It
4282 overrides the sender address that is created from the caller's login id for
4283 messages from local sources, except when &%-bh%& is used, when there is no
4284 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4285 specified on a MAIL command overrides this value. See chapter
4286 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4287
4288 .vitem &%-oMi%&&~<&'interface&~address'&>
4289 .oindex "&%-oMi%&"
4290 .cindex "interface" "address, specifying for local message"
4291 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4292 option sets the IP interface address value. A port number may be included,
4293 using the same syntax as for &%-oMa%&. The interface address is placed in
4294 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4295
4296 .vitem &%-oMm%&&~<&'message&~reference'&>
4297 .oindex "&%-oMm%&"
4298 .cindex "message reference" "message reference, specifying for local message"
4299 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4300 option sets the message reference, e.g. message-id, and is logged during
4301 delivery. This is useful when some kind of audit trail is required to tie
4302 messages together. The format of the message reference is checked and will
4303 abort if the format is invalid. The option will only be accepted if exim is
4304 running in trusted mode, not as any regular user.
4305
4306 The best example of a message reference is when Exim sends a bounce message.
4307 The message reference is the message-id of the original message for which Exim
4308 is sending the bounce.
4309
4310 .vitem &%-oMr%&&~<&'protocol&~name'&>
4311 .oindex "&%-oMr%&"
4312 .cindex "protocol, specifying for local message"
4313 .vindex "&$received_protocol$&"
4314 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4315 option sets the received protocol value that is stored in
4316 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4317 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4318 SMTP protocol names (see the description of &$received_protocol$& in section
4319 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4320 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4321 be set by &%-oMr%&. Repeated use of this option is not supported.
4322
4323 .vitem &%-oMs%&&~<&'host&~name'&>
4324 .oindex "&%-oMs%&"
4325 .cindex "sender" "host name, specifying for local message"
4326 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4327 option sets the sender host name in &$sender_host_name$&. When this option is
4328 present, Exim does not attempt to look up a host name from an IP address; it
4329 uses the name it is given.
4330
4331 .vitem &%-oMt%&&~<&'ident&~string'&>
4332 .oindex "&%-oMt%&"
4333 .cindex "sender" "ident string, specifying for local message"
4334 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4335 option sets the sender ident value in &$sender_ident$&. The default setting for
4336 local callers is the login id of the calling process, except when &%-bh%& is
4337 used, when there is no default.
4338
4339 .vitem &%-om%&
4340 .oindex "&%-om%&"
4341 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4342 In Sendmail, this option means &"me too"&, indicating that the sender of a
4343 message should receive a copy of the message if the sender appears in an alias
4344 expansion. Exim always does this, so the option does nothing.
4345
4346 .vitem &%-oo%&
4347 .oindex "&%-oo%&"
4348 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4349 This option is ignored. In Sendmail it specifies &"old style headers"&,
4350 whatever that means.
4351
4352 .vitem &%-oP%&&~<&'path'&>
4353 .oindex "&%-oP%&"
4354 .cindex "pid (process id)" "of daemon"
4355 .cindex "daemon" "process id (pid)"
4356 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4357 value. The option specifies the file to which the process id of the daemon is
4358 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4359 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4360 because in those cases, the normal pid file is not used.
4361
4362 .vitem &%-or%&&~<&'time'&>
4363 .oindex "&%-or%&"
4364 .cindex "timeout" "for non-SMTP input"
4365 This option sets a timeout value for incoming non-SMTP messages. If it is not
4366 set, Exim will wait forever for the standard input. The value can also be set
4367 by the &%receive_timeout%& option. The format used for specifying times is
4368 described in section &<<SECTtimeformat>>&.
4369
4370 .vitem &%-os%&&~<&'time'&>
4371 .oindex "&%-os%&"
4372 .cindex "timeout" "for SMTP input"
4373 .cindex "SMTP" "input timeout"
4374 This option sets a timeout value for incoming SMTP messages. The timeout
4375 applies to each SMTP command and block of data. The value can also be set by
4376 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4377 for specifying times is described in section &<<SECTtimeformat>>&.
4378
4379 .vitem &%-ov%&
4380 .oindex "&%-ov%&"
4381 This option has exactly the same effect as &%-v%&.
4382
4383 .vitem &%-oX%&&~<&'number&~or&~string'&>
4384 .oindex "&%-oX%&"
4385 .cindex "TCP/IP" "setting listening ports"
4386 .cindex "TCP/IP" "setting listening interfaces"
4387 .cindex "port" "receiving TCP/IP"
4388 This option is relevant only when the &%-bd%& (start listening daemon) option
4389 is also given. It controls which ports and interfaces the daemon uses. Details
4390 of the syntax, and how it interacts with configuration file options, are given
4391 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4392 file is written unless &%-oP%& is also present to specify a pid filename.
4393
4394 .vitem &%-pd%&
4395 .oindex "&%-pd%&"
4396 .cindex "Perl" "starting the interpreter"
4397 This option applies when an embedded Perl interpreter is linked with Exim (see
4398 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4399 option, forcing the starting of the interpreter to be delayed until it is
4400 needed.
4401
4402 .vitem &%-ps%&
4403 .oindex "&%-ps%&"
4404 .cindex "Perl" "starting the interpreter"
4405 This option applies when an embedded Perl interpreter is linked with Exim (see
4406 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4407 option, forcing the starting of the interpreter to occur as soon as Exim is
4408 started.
4409
4410 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4411 .oindex "&%-p%&"
4412 For compatibility with Sendmail, this option is equivalent to
4413 .display
4414 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4415 .endd
4416 It sets the incoming protocol and host name (for trusted callers). The
4417 host name and its colon can be omitted when only the protocol is to be set.
4418 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4419 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4420 or &`s`& using this option (but that does not seem a real limitation).
4421 Repeated use of this option is not supported.
4422
4423 .vitem &%-q%&
4424 .oindex "&%-q%&"
4425 .cindex "queue runner" "starting manually"
4426 This option is normally restricted to admin users. However, there is a
4427 configuration option called &%prod_requires_admin%& which can be set false to
4428 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4429 and &%-S%& options).
4430
4431 .cindex "queue runner" "description of operation"
4432 If other commandline options do not specify an action,
4433 the &%-q%& option starts one queue runner process. This scans the queue of
4434 waiting messages, and runs a delivery process for each one in turn. It waits
4435 for each delivery process to finish before starting the next one. A delivery
4436 process may not actually do any deliveries if the retry times for the addresses
4437 have not been reached. Use &%-qf%& (see below) if you want to override this.
4438
4439 If
4440 .cindex "SMTP" "passed connection"
4441 .cindex "SMTP" "multiple deliveries"
4442 .cindex "multiple SMTP deliveries"
4443 the delivery process spawns other processes to deliver other messages down
4444 passed SMTP connections, the queue runner waits for these to finish before
4445 proceeding.
4446
4447 When all the queued messages have been considered, the original queue runner
4448 process terminates. In other words, a single pass is made over the waiting
4449 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4450 this to be repeated periodically.
4451
4452 Exim processes the waiting messages in an unpredictable order. It isn't very
4453 random, but it is likely to be different each time, which is all that matters.
4454 If one particular message screws up a remote MTA, other messages to the same
4455 MTA have a chance of getting through if they get tried first.
4456
4457 It is possible to cause the messages to be processed in lexical message id
4458 order, which is essentially the order in which they arrived, by setting the
4459 &%queue_run_in_order%& option, but this is not recommended for normal use.
4460
4461 .vitem &%-q%&<&'qflags'&>
4462 The &%-q%& option may be followed by one or more flag letters that change its
4463 behaviour. They are all optional, but if more than one is present, they must
4464 appear in the correct order. Each flag is described in a separate item below.
4465
4466 .vitem &%-qq...%&
4467 .oindex "&%-qq%&"
4468 .cindex "queue" "double scanning"
4469 .cindex "queue" "routing"
4470 .cindex "routing" "whole queue before delivery"
4471 An option starting with &%-qq%& requests a two-stage queue run. In the first
4472 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4473 every domain. Addresses are routed, local deliveries happen, but no remote
4474 transports are run.
4475
4476 .cindex "hints database" "remembering routing"
4477 The hints database that remembers which messages are waiting for specific hosts
4478 is updated, as if delivery to those hosts had been deferred. After this is
4479 complete, a second, normal queue scan happens, with routing and delivery taking
4480 place as normal. Messages that are routed to the same host should mostly be
4481 delivered down a single SMTP
4482 .cindex "SMTP" "passed connection"
4483 .cindex "SMTP" "multiple deliveries"
4484 .cindex "multiple SMTP deliveries"
4485 connection because of the hints that were set up during the first queue scan.
4486 This option may be useful for hosts that are connected to the Internet
4487 intermittently.
4488
4489 .vitem &%-q[q]i...%&
4490 .oindex "&%-qi%&"
4491 .cindex "queue" "initial delivery"
4492 If the &'i'& flag is present, the queue runner runs delivery processes only for
4493 those messages that haven't previously been tried. (&'i'& stands for &"initial
4494 delivery"&.) This can be helpful if you are putting messages in the queue using
4495 &%-odq%& and want a queue runner just to process the new messages.
4496
4497 .vitem &%-q[q][i]f...%&
4498 .oindex "&%-qf%&"
4499 .cindex "queue" "forcing delivery"
4500 .cindex "delivery" "forcing in queue run"
4501 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4502 message, whereas without &'f'& only those non-frozen addresses that have passed
4503 their retry times are tried.
4504
4505 .vitem &%-q[q][i]ff...%&
4506 .oindex "&%-qff%&"
4507 .cindex "frozen messages" "forcing delivery"
4508 If &'ff'& is present, a delivery attempt is forced for every message, whether
4509 frozen or not.
4510
4511 .vitem &%-q[q][i][f[f]]l%&
4512 .oindex "&%-ql%&"
4513 .cindex "queue" "local deliveries only"
4514 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4515 be done. If a message requires any remote deliveries, it remains in the queue
4516 for later delivery.
4517
4518 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4519 .oindex "&%-qG%&"
4520 .cindex queue named
4521 .cindex "named queues"
4522 .cindex "queue" "delivering specific messages"
4523 If the &'G'& flag and a name is present, the queue runner operates on the
4524 queue with the given name rather than the default queue.
4525 The name should not contain a &'/'& character.
4526 For a periodic queue run (see below)
4527 append to the name a slash and a time value.
4528
4529 If other commandline options specify an action, a &'-qG<name>'& option
4530 will specify a queue to operate on.
4531 For example:
4532 .code
4533 exim -bp -qGquarantine
4534 mailq -qGquarantine
4535 exim -qGoffpeak -Rf @special.domain.example
4536 .endd
4537
4538 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4539 When scanning the queue, Exim can be made to skip over messages whose ids are
4540 lexically less than a given value by following the &%-q%& option with a
4541 starting message id. For example:
4542 .code
4543 exim -q 0t5C6f-0000c8-00
4544 .endd
4545 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4546 second message id is given, messages whose ids are lexically greater than it
4547 are also skipped. If the same id is given twice, for example,
4548 .code
4549 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4550 .endd
4551 just one delivery process is started, for that message. This differs from
4552 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4553 that it counts as a delivery from a queue run. Note that the selection
4554 mechanism does not affect the order in which the messages are scanned. There
4555 are also other ways of selecting specific sets of messages for delivery in a
4556 queue run &-- see &%-R%& and &%-S%&.
4557
4558 .vitem &%-q%&<&'qflags'&><&'time'&>
4559 .cindex "queue runner" "starting periodically"
4560 .cindex "periodic queue running"
4561 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4562 starting a queue runner process at intervals specified by the given time value
4563 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4564 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4565 single daemon process handles both functions. A common way of starting up a
4566 combined daemon at system boot time is to use a command such as
4567 .code
4568 /usr/exim/bin/exim -bd -q30m
4569 .endd
4570 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4571 process every 30 minutes.
4572
4573 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4574 pid file is written unless one is explicitly requested by the &%-oP%& option.
4575
4576 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4577 .oindex "&%-qR%&"
4578 This option is synonymous with &%-R%&. It is provided for Sendmail
4579 compatibility.
4580
4581 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4582 .oindex "&%-qS%&"
4583 This option is synonymous with &%-S%&.
4584
4585 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4586 .oindex "&%-R%&"
4587 .cindex "queue runner" "for specific recipients"
4588 .cindex "delivery" "to given domain"
4589 .cindex "domain" "delivery to"
4590 The <&'rsflags'&> may be empty, in which case the white space before the string
4591 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4592 which are the possible values for <&'rsflags'&>. White space is required if
4593 <&'rsflags'&> is not empty.
4594
4595 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4596 perform a single queue run, except that, when scanning the messages on the
4597 queue, Exim processes only those that have at least one undelivered recipient
4598 address containing the given string, which is checked in a case-independent
4599 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4600 regular expression; otherwise it is a literal string.
4601
4602 If you want to do periodic queue runs for messages with specific recipients,
4603 you can combine &%-R%& with &%-q%& and a time value. For example:
4604 .code
4605 exim -q25m -R @special.domain.example
4606 .endd
4607 This example does a queue run for messages with recipients in the given domain
4608 every 25 minutes. Any additional flags that are specified with &%-q%& are
4609 applied to each queue run.
4610
4611 Once a message is selected for delivery by this mechanism, all its addresses
4612 are processed. For the first selected message, Exim overrides any retry
4613 information and forces a delivery attempt for each undelivered address. This
4614 means that if delivery of any address in the first message is successful, any
4615 existing retry information is deleted, and so delivery attempts for that
4616 address in subsequently selected messages (which are processed without forcing)
4617 will run. However, if delivery of any address does not succeed, the retry
4618 information is updated, and in subsequently selected messages, the failing
4619 address will be skipped.
4620
4621 .cindex "frozen messages" "forcing delivery"
4622 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4623 all selected messages, not just the first; frozen messages are included when
4624 &'ff'& is present.
4625
4626 The &%-R%& option makes it straightforward to initiate delivery of all messages
4627 to a given domain after a host has been down for some time. When the SMTP
4628 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4629 effect is to run Exim with the &%-R%& option, but it can be configured to run
4630 an arbitrary command instead.
4631
4632 .vitem &%-r%&
4633 .oindex "&%-r%&"
4634 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4635
4636 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4637 .oindex "&%-S%&"
4638 .cindex "delivery" "from given sender"
4639 .cindex "queue runner" "for specific senders"
4640 This option acts like &%-R%& except that it checks the string against each
4641 message's sender instead of against the recipients. If &%-R%& is also set, both
4642 conditions must be met for a message to be selected. If either of the options
4643 has &'f'& or &'ff'& in its flags, the associated action is taken.
4644
4645 .vitem &%-Tqt%&&~<&'times'&>
4646 .oindex "&%-Tqt%&"
4647 This is an option that is exclusively for use by the Exim testing suite. It is not
4648 recognized when Exim is run normally. It allows for the setting up of explicit
4649 &"queue times"& so that various warning/retry features can be tested.
4650
4651 .vitem &%-t%&
4652 .oindex "&%-t%&"
4653 .cindex "recipient" "extracting from header lines"
4654 .cindex "&'Bcc:'& header line"
4655 .cindex "&'Cc:'& header line"
4656 .cindex "&'To:'& header line"
4657 When Exim is receiving a locally-generated, non-SMTP message on its standard
4658 input, the &%-t%& option causes the recipients of the message to be obtained
4659 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4660 from the command arguments. The addresses are extracted before any rewriting
4661 takes place and the &'Bcc:'& header line, if present, is then removed.
4662
4663 .cindex "Sendmail compatibility" "&%-t%& option"
4664 If the command has any arguments, they specify addresses to which the message
4665 is &'not'& to be delivered. That is, the argument addresses are removed from
4666 the recipients list obtained from the headers. This is compatible with Smail 3
4667 and in accordance with the documented behaviour of several versions of
4668 Sendmail, as described in man pages on a number of operating systems (e.g.
4669 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4670 argument addresses to those obtained from the headers, and the O'Reilly
4671 Sendmail book documents it that way. Exim can be made to add argument addresses
4672 instead of subtracting them by setting the option
4673 &%extract_addresses_remove_arguments%& false.
4674
4675 .cindex "&%Resent-%& header lines" "with &%-t%&"
4676 If there are any &%Resent-%& header lines in the message, Exim extracts
4677 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4678 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4679 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4680 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4681
4682 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4683 message is resent several times). The RFC also specifies that they should be
4684 added at the front of the message, and separated by &'Received:'& lines. It is
4685 not at all clear how &%-t%& should operate in the present of multiple sets,
4686 nor indeed exactly what constitutes a &"set"&.
4687 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4688 are often added at the end of the header, and if a message is resent more than
4689 once, it is common for the original set of &%Resent-%& headers to be renamed as
4690 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4691
4692 .vitem &%-ti%&
4693 .oindex "&%-ti%&"
4694 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4695 compatibility with Sendmail.
4696
4697 .vitem &%-tls-on-connect%&
4698 .oindex "&%-tls-on-connect%&"
4699 .cindex "TLS" "use without STARTTLS"
4700 .cindex "TLS" "automatic start"
4701 This option is available when Exim is compiled with TLS support. It forces all
4702 incoming SMTP connections to behave as if the incoming port is listed in the
4703 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4704 &<<CHAPTLS>>& for further details.
4705
4706
4707 .vitem &%-U%&
4708 .oindex "&%-U%&"
4709 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4710 Sendmail uses this option for &"initial message submission"&, and its
4711 documentation states that in future releases, it may complain about
4712 syntactically invalid messages rather than fixing them when this flag is not
4713 set. Exim ignores this option.
4714
4715 .vitem &%-v%&
4716 .oindex "&%-v%&"
4717 This option causes Exim to write information to the standard error stream,
4718 describing what it is doing. In particular, it shows the log lines for
4719 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4720 dialogue is shown. Some of the log lines shown may not actually be written to
4721 the log if the setting of &%log_selector%& discards them. Any relevant
4722 selectors are shown with each log line. If none are shown, the logging is
4723 unconditional.
4724
4725 .vitem &%-x%&
4726 .oindex "&%-x%&"
4727 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4728 National Language Support extended characters in the body of the mail item"&).
4729 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4730 this option.
4731
4732 .vitem &%-X%&&~<&'logfile'&>
4733 .oindex "&%-X%&"
4734 This option is interpreted by Sendmail to cause debug information to be sent
4735 to the named file.  It is ignored by Exim.
4736
4737 .vitem &%-z%&&~<&'log-line'&>
4738 .oindex "&%-z%&"
4739 This option writes its argument to Exim's logfile.
4740 Use is restricted to administrators; the intent is for operational notes.
4741 Quotes should be used to maintain a multi-word item as a single argument,
4742 under most shells.
4743 .endlist
4744
4745 .ecindex IIDclo1
4746 .ecindex IIDclo2
4747
4748
4749 . ////////////////////////////////////////////////////////////////////////////
4750 . Insert a stylized DocBook comment here, to identify the end of the command
4751 . line options. This is for the benefit of the Perl script that automatically
4752 . creates a man page for the options.
4753 . ////////////////////////////////////////////////////////////////////////////
4754
4755 .literal xml
4756 <!-- === End of command line options === -->
4757 .literal off
4758
4759
4760
4761
4762
4763 . ////////////////////////////////////////////////////////////////////////////
4764 . ////////////////////////////////////////////////////////////////////////////
4765
4766
4767 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4768          "The runtime configuration file"
4769
4770 .cindex "runtime configuration"
4771 .cindex "configuration file" "general description"
4772 .cindex "CONFIGURE_FILE"
4773 .cindex "configuration file" "errors in"
4774 .cindex "error" "in configuration file"
4775 .cindex "return code" "for bad configuration"
4776 Exim uses a single runtime configuration file that is read whenever an Exim
4777 binary is executed. Note that in normal operation, this happens frequently,
4778 because Exim is designed to operate in a distributed manner, without central
4779 control.
4780
4781 If a syntax error is detected while reading the configuration file, Exim
4782 writes a message on the standard error, and exits with a non-zero return code.
4783 The message is also written to the panic log. &*Note*&: Only simple syntax
4784 errors can be detected at this time. The values of any expanded options are
4785 not checked until the expansion happens, even when the expansion does not
4786 actually alter the string.
4787
4788 The name of the configuration file is compiled into the binary for security
4789 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4790 most configurations, this specifies a single file. However, it is permitted to
4791 give a colon-separated list of filenames, in which case Exim uses the first
4792 existing file in the list.
4793
4794 .cindex "EXIM_USER"
4795 .cindex "EXIM_GROUP"
4796 .cindex "CONFIGURE_OWNER"
4797 .cindex "CONFIGURE_GROUP"
4798 .cindex "configuration file" "ownership"
4799 .cindex "ownership" "configuration file"
4800 The runtime configuration file must be owned by root or by the user that is
4801 specified at compile time by the CONFIGURE_OWNER option (if set). The
4802 configuration file must not be world-writeable, or group-writeable unless its
4803 group is the root group or the one specified at compile time by the
4804 CONFIGURE_GROUP option.
4805
4806 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4807 to root, anybody who is able to edit the runtime configuration file has an
4808 easy way to run commands as root. If you specify a user or group in the
4809 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4810 who are members of that group will trivially be able to obtain root privileges.
4811
4812 Up to Exim version 4.72, the runtime configuration file was also permitted to
4813 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4814 since it offered a simple privilege escalation for any attacker who managed to
4815 compromise the Exim user account.
4816
4817 A default configuration file, which will work correctly in simple situations,
4818 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4819 defines just one filename, the installation process copies the default
4820 configuration to a new file of that name if it did not previously exist. If
4821 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4822 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4823 configuration.
4824
4825
4826
4827 .section "Using a different configuration file" "SECID40"
4828 .cindex "configuration file" "alternate"
4829 A one-off alternate configuration can be specified by the &%-C%& command line
4830 option, which may specify a single file or a list of files. However, when
4831 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4832 unless the argument for &%-C%& is identical to the built-in value from
4833 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4834 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4835 is useful mainly for checking the syntax of configuration files before
4836 installing them. No owner or group checks are done on a configuration file
4837 specified by &%-C%&, if root privilege has been dropped.
4838
4839 Even the Exim user is not trusted to specify an arbitrary configuration file
4840 with the &%-C%& option to be used with root privileges, unless that file is
4841 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4842 testing a configuration using &%-C%& right through message reception and
4843 delivery, even if the caller is root. The reception works, but by that time,
4844 Exim is running as the Exim user, so when it re-execs to regain privilege for
4845 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4846 can test reception and delivery using two separate commands (one to put a
4847 message in the queue, using &%-odq%&, and another to do the delivery, using
4848 &%-M%&).
4849
4850 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4851 prefix string with which any file named in a &%-C%& command line option must
4852 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4853 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4854 filename can be used with &%-C%&.
4855
4856 One-off changes to a configuration can be specified by the &%-D%& command line
4857 option, which defines and overrides values for macros used inside the
4858 configuration file. However, like &%-C%&, the use of this option by a
4859 non-privileged user causes Exim to discard its root privilege.
4860 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4861 completely disabled, and its use causes an immediate error exit.
4862
4863 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4864 to declare certain macro names trusted, such that root privilege will not
4865 necessarily be discarded.
4866 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4867 considered safe and, if &%-D%& only supplies macros from this list, and the
4868 values are acceptable, then Exim will not give up root privilege if the caller
4869 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4870 transition mechanism and is expected to be removed in the future.  Acceptable
4871 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4872
4873 Some sites may wish to use the same Exim binary on different machines that
4874 share a file system, but to use different configuration files on each machine.
4875 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4876 looks for a file whose name is the configuration filename followed by a dot
4877 and the machine's node name, as obtained from the &[uname()]& function. If this
4878 file does not exist, the standard name is tried. This processing occurs for
4879 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4880
4881 In some esoteric situations different versions of Exim may be run under
4882 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4883 help with this. See the comments in &_src/EDITME_& for details.
4884
4885
4886
4887 .section "Configuration file format" "SECTconffilfor"
4888 .cindex "configuration file" "format of"
4889 .cindex "format" "configuration file"
4890 Exim's configuration file is divided into a number of different parts. General
4891 option settings must always appear at the start of the file. The other parts
4892 are all optional, and may appear in any order. Each part other than the first
4893 is introduced by the word &"begin"& followed by at least one literal
4894 space, and the name of the part. The optional parts are:
4895
4896 .ilist
4897 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4898 &<<CHAPACL>>&).
4899 .next
4900 .cindex "AUTH" "configuration"
4901 &'authenticators'&: Configuration settings for the authenticator drivers. These
4902 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4903 .next
4904 &'routers'&: Configuration settings for the router drivers. Routers process
4905 addresses and determine how the message is to be delivered (see chapters
4906 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4907 .next
4908 &'transports'&: Configuration settings for the transport drivers. Transports
4909 define mechanisms for copying messages to destinations (see chapters
4910 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4911 .next
4912 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4913 If there is no retry section, or if it is empty (that is, no retry rules are
4914 defined), Exim will not retry deliveries. In this situation, temporary errors
4915 are treated the same as permanent errors. Retry rules are discussed in chapter
4916 &<<CHAPretry>>&.
4917 .next
4918 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4919 when new addresses are generated during delivery. Rewriting is discussed in
4920 chapter &<<CHAPrewrite>>&.
4921 .next
4922 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4923 want to use this feature, you must set
4924 .code
4925 LOCAL_SCAN_HAS_OPTIONS=yes
4926 .endd
4927 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4928 facility are given in chapter &<<CHAPlocalscan>>&.
4929 .endlist
4930
4931 .cindex "configuration file" "leading white space in"
4932 .cindex "configuration file" "trailing white space in"
4933 .cindex "white space" "in configuration file"
4934 Leading and trailing white space in configuration lines is always ignored.
4935
4936 Blank lines in the file, and lines starting with a # character (ignoring
4937 leading white space) are treated as comments and are ignored. &*Note*&: A
4938 # character other than at the beginning of a line is not treated specially,
4939 and does not introduce a comment.
4940
4941 Any non-comment line can be continued by ending it with a backslash. Note that
4942 the general rule for white space means that trailing white space after the
4943 backslash and leading white space at the start of continuation
4944 lines is ignored. Comment lines beginning with # (but not empty lines) may
4945 appear in the middle of a sequence of continuation lines.
4946
4947 A convenient way to create a configuration file is to start from the
4948 default, which is supplied in &_src/configure.default_&, and add, delete, or
4949 change settings as required.
4950
4951 The ACLs, retry rules, and rewriting rules have their own syntax which is
4952 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4953 respectively. The other parts of the configuration file have some syntactic
4954 items in common, and these are described below, from section &<<SECTcos>>&
4955 onwards. Before that, the inclusion, macro, and conditional facilities are
4956 described.
4957
4958
4959
4960 .section "File inclusions in the configuration file" "SECID41"
4961 .cindex "inclusions in configuration file"
4962 .cindex "configuration file" "including other files"
4963 .cindex "&`.include`& in configuration file"
4964 .cindex "&`.include_if_exists`& in configuration file"
4965 You can include other files inside Exim's runtime configuration file by
4966 using this syntax:
4967 .display
4968 &`.include`& <&'filename'&>
4969 &`.include_if_exists`& <&'filename'&>
4970 .endd
4971 on a line by itself. Double quotes round the filename are optional. If you use
4972 the first form, a configuration error occurs if the file does not exist; the
4973 second form does nothing for non-existent files.
4974 The first form allows a relative name. It is resolved relative to
4975 the directory of the including file. For the second form an absolute filename
4976 is required.
4977
4978 Includes may be nested to any depth, but remember that Exim reads its
4979 configuration file often, so it is a good idea to keep them to a minimum.
4980 If you change the contents of an included file, you must HUP the daemon,
4981 because an included file is read only when the configuration itself is read.
4982
4983 The processing of inclusions happens early, at a physical line level, so, like
4984 comment lines, an inclusion can be used in the middle of an option setting,
4985 for example:
4986 .code
4987 hosts_lookup = a.b.c \
4988                .include /some/file
4989 .endd
4990 Include processing happens after macro processing (see below). Its effect is to
4991 process the lines of the included file as if they occurred inline where the
4992 inclusion appears.
4993
4994
4995
4996 .section "Macros in the configuration file" "SECTmacrodefs"
4997 .cindex "macro" "description of"
4998 .cindex "configuration file" "macros"
4999 If a line in the main part of the configuration (that is, before the first
5000 &"begin"& line) begins with an upper case letter, it is taken as a macro
5001 definition, and must be of the form
5002 .display
5003 <&'name'&> = <&'rest of line'&>
5004 .endd
5005 The name must consist of letters, digits, and underscores, and need not all be
5006 in upper case, though that is recommended. The rest of the line, including any
5007 continuations, is the replacement text, and has leading and trailing white
5008 space removed. Quotes are not removed. The replacement text can never end with
5009 a backslash character, but this doesn't seem to be a serious limitation.
5010
5011 Macros may also be defined between router, transport, authenticator, or ACL
5012 definitions. They may not, however, be defined within an individual driver or
5013 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5014
5015 .section "Macro substitution" "SECID42"
5016 Once a macro is defined, all subsequent lines in the file (and any included
5017 files) are scanned for the macro name; if there are several macros, the line is
5018 scanned for each, in turn, in the order in which the macros are defined. The
5019 replacement text is not re-scanned for the current macro, though it is scanned
5020 for subsequently defined macros. For this reason, a macro name may not contain
5021 the name of a previously defined macro as a substring. You could, for example,
5022 define
5023 .display
5024 &`ABCD_XYZ = `&<&'something'&>
5025 &`ABCD = `&<&'something else'&>
5026 .endd
5027 but putting the definitions in the opposite order would provoke a configuration
5028 error. Macro expansion is applied to individual physical lines from the file,
5029 before checking for line continuation or file inclusion (see above). If a line
5030 consists solely of a macro name, and the expansion of the macro is empty, the
5031 line is ignored. A macro at the start of a line may turn the line into a
5032 comment line or a &`.include`& line.
5033
5034
5035 .section "Redefining macros" "SECID43"
5036 Once defined, the value of a macro can be redefined later in the configuration
5037 (or in an included file). Redefinition is specified by using &'=='& instead of
5038 &'='&. For example:
5039 .code
5040 MAC =  initial value
5041 ...
5042 MAC == updated value
5043 .endd
5044 Redefinition does not alter the order in which the macros are applied to the
5045 subsequent lines of the configuration file. It is still the same order in which
5046 the macros were originally defined. All that changes is the macro's value.
5047 Redefinition makes it possible to accumulate values. For example:
5048 .code
5049 MAC =  initial value
5050 ...
5051 MAC == MAC and something added
5052 .endd
5053 This can be helpful in situations where the configuration file is built
5054 from a number of other files.
5055
5056 .section "Overriding macro values" "SECID44"
5057 The values set for macros in the configuration file can be overridden by the
5058 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5059 used, unless called by root or the Exim user. A definition on the command line
5060 using the &%-D%& option causes all definitions and redefinitions within the
5061 file to be ignored.
5062
5063
5064
5065 .section "Example of macro usage" "SECID45"
5066 As an example of macro usage, consider a configuration where aliases are looked
5067 up in a MySQL database. It helps to keep the file less cluttered if long
5068 strings such as SQL statements are defined separately as macros, for example:
5069 .code
5070 ALIAS_QUERY = select mailbox from user where \
5071               login='${quote_mysql:$local_part}';
5072 .endd
5073 This can then be used in a &(redirect)& router setting like this:
5074 .code
5075 data = ${lookup mysql{ALIAS_QUERY}}
5076 .endd
5077 In earlier versions of Exim macros were sometimes used for domain, host, or
5078 address lists. In Exim 4 these are handled better by named lists &-- see
5079 section &<<SECTnamedlists>>&.
5080
5081
5082 .section "Builtin macros" "SECTbuiltinmacros"
5083 Exim defines some macros depending on facilities available, which may
5084 differ due to build-time definitions and from one release to another.
5085 All of these macros start with an underscore.
5086 They can be used to conditionally include parts of a configuration
5087 (see below).
5088
5089 The following classes of macros are defined:
5090 .display
5091 &` _HAVE_*                    `&  build-time defines
5092 &` _DRIVER_ROUTER_*           `&  router drivers
5093 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5094 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5095 &` _LOG_*                     `&  log_selector values
5096 &` _OPT_MAIN_*                `&  main config options
5097 &` _OPT_ROUTERS_*             `&  generic router options
5098 &` _OPT_TRANSPORTS_*          `&  generic transport options
5099 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5100 &` _OPT_ROUTER_*_*            `&  private router options
5101 &` _OPT_TRANSPORT_*_*         `&  private transport options
5102 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5103 .endd
5104
5105 Use an &"exim -bP macros"& command to get the list of macros.
5106
5107
5108 .section "Conditional skips in the configuration file" "SECID46"
5109 .cindex "configuration file" "conditional skips"
5110 .cindex "&`.ifdef`&"
5111 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5112 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5113 portions of the configuration file. The processing happens whenever the file is
5114 read (that is, when an Exim binary starts to run).
5115
5116 The implementation is very simple. Instances of the first four directives must
5117 be followed by text that includes the names of one or macros. The condition
5118 that is tested is whether or not any macro substitution has taken place in the
5119 line. Thus:
5120 .code
5121 .ifdef AAA
5122 message_size_limit = 50M
5123 .else
5124 message_size_limit = 100M
5125 .endif
5126 .endd
5127 sets a message size limit of 50M if the macro &`AAA`& is defined
5128 (or &`A`& or &`AA`&), and 100M
5129 otherwise. If there is more than one macro named on the line, the condition
5130 is true if any of them are defined. That is, it is an &"or"& condition. To
5131 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5132
5133 Although you can use a macro expansion to generate one of these directives,
5134 it is not very useful, because the condition &"there was a macro substitution
5135 in this line"& will always be true.
5136
5137 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5138 to clarify complicated nestings.
5139
5140
5141
5142 .section "Common option syntax" "SECTcos"
5143 .cindex "common option syntax"
5144 .cindex "syntax of common options"
5145 .cindex "configuration file" "common option syntax"
5146 For the main set of options, driver options, and &[local_scan()]& options,
5147 each setting is on a line by itself, and starts with a name consisting of
5148 lower-case letters and underscores. Many options require a data value, and in
5149 these cases the name must be followed by an equals sign (with optional white
5150 space) and then the value. For example:
5151 .code
5152 qualify_domain = mydomain.example.com
5153 .endd
5154 .cindex "hiding configuration option values"
5155 .cindex "configuration options" "hiding value of"
5156 .cindex "options" "hiding value of"
5157 Some option settings may contain sensitive data, for example, passwords for
5158 accessing databases. To stop non-admin users from using the &%-bP%& command
5159 line option to read these values, you can precede the option settings with the
5160 word &"hide"&. For example:
5161 .code
5162 hide mysql_servers = localhost/users/admin/secret-password
5163 .endd
5164 For non-admin users, such options are displayed like this:
5165 .code
5166 mysql_servers = <value not displayable>
5167 .endd
5168 If &"hide"& is used on a driver option, it hides the value of that option on
5169 all instances of the same driver.
5170
5171 The following sections describe the syntax used for the different data types
5172 that are found in option settings.
5173
5174
5175 .section "Boolean options" "SECID47"
5176 .cindex "format" "boolean"
5177 .cindex "boolean configuration values"
5178 .oindex "&%no_%&&'xxx'&"
5179 .oindex "&%not_%&&'xxx'&"
5180 Options whose type is given as boolean are on/off switches. There are two
5181 different ways of specifying such options: with and without a data value. If
5182 the option name is specified on its own without data, the switch is turned on;
5183 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5184 boolean options may be followed by an equals sign and one of the words
5185 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5186 the following two settings have exactly the same effect:
5187 .code
5188 queue_only
5189 queue_only = true
5190 .endd
5191 The following two lines also have the same (opposite) effect:
5192 .code
5193 no_queue_only
5194 queue_only = false
5195 .endd
5196 You can use whichever syntax you prefer.
5197
5198
5199
5200
5201 .section "Integer values" "SECID48"
5202 .cindex "integer configuration values"
5203 .cindex "format" "integer"
5204 If an option's type is given as &"integer"&, the value can be given in decimal,
5205 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5206 number is assumed. Otherwise, it is treated as an octal number unless it starts
5207 with the characters &"0x"&, in which case the remainder is interpreted as a
5208 hexadecimal number.
5209
5210 If an integer value is followed by the letter K, it is multiplied by 1024; if
5211 it is followed by the letter M, it is multiplied by 1024x1024;
5212 if by the letter G, 1024x1024x1024.
5213 When the values
5214 of integer option settings are output, values which are an exact multiple of
5215 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5216 and M. The printing style is independent of the actual input format that was
5217 used.
5218
5219
5220 .section "Octal integer values" "SECID49"
5221 .cindex "integer format"
5222 .cindex "format" "octal integer"
5223 If an option's type is given as &"octal integer"&, its value is always
5224 interpreted as an octal number, whether or not it starts with the digit zero.
5225 Such options are always output in octal.
5226
5227
5228 .section "Fixed point numbers" "SECID50"
5229 .cindex "fixed point configuration values"
5230 .cindex "format" "fixed point"
5231 If an option's type is given as &"fixed-point"&, its value must be a decimal
5232 integer, optionally followed by a decimal point and up to three further digits.
5233
5234
5235
5236 .section "Time intervals" "SECTtimeformat"
5237 .cindex "time interval" "specifying in configuration"
5238 .cindex "format" "time interval"
5239 A time interval is specified as a sequence of numbers, each followed by one of
5240 the following letters, with no intervening white space:
5241
5242 .table2 30pt
5243 .irow &%s%& seconds
5244 .irow &%m%& minutes
5245 .irow &%h%& hours
5246 .irow &%d%& days
5247 .irow &%w%& weeks
5248 .endtable
5249
5250 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5251 intervals are output in the same format. Exim does not restrict the values; it
5252 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5253
5254
5255
5256 .section "String values" "SECTstrings"
5257 .cindex "string" "format of configuration values"
5258 .cindex "format" "string"
5259 If an option's type is specified as &"string"&, the value can be specified with
5260 or without double-quotes. If it does not start with a double-quote, the value
5261 consists of the remainder of the line plus any continuation lines, starting at
5262 the first character after any leading white space, with trailing white space
5263 removed, and with no interpretation of the characters in the string. Because
5264 Exim removes comment lines (those beginning with #) at an early stage, they can
5265 appear in the middle of a multi-line string. The following two settings are
5266 therefore equivalent:
5267 .code
5268 trusted_users = uucp:mail
5269 trusted_users = uucp:\
5270                 # This comment line is ignored
5271                 mail
5272 .endd
5273 .cindex "string" "quoted"
5274 .cindex "escape characters in quoted strings"
5275 If a string does start with a double-quote, it must end with a closing
5276 double-quote, and any backslash characters other than those used for line
5277 continuation are interpreted as escape characters, as follows:
5278
5279 .table2 100pt
5280 .irow &`\\`&                     "single backslash"
5281 .irow &`\n`&                     "newline"
5282 .irow &`\r`&                     "carriage return"
5283 .irow &`\t`&                     "tab"
5284 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5285 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5286                                    character"
5287 .endtable
5288
5289 If a backslash is followed by some other character, including a double-quote
5290 character, that character replaces the pair.
5291
5292 Quoting is necessary only if you want to make use of the backslash escapes to
5293 insert special characters, or if you need to specify a value with leading or
5294 trailing spaces. These cases are rare, so quoting is almost never needed in
5295 current versions of Exim. In versions of Exim before 3.14, quoting was required
5296 in order to continue lines, so you may come across older configuration files
5297 and examples that apparently quote unnecessarily.
5298
5299
5300 .section "Expanded strings" "SECID51"
5301 .cindex "expansion" "definition of"
5302 Some strings in the configuration file are subjected to &'string expansion'&,
5303 by which means various parts of the string may be changed according to the
5304 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5305 is as just described; in particular, the handling of backslashes in quoted
5306 strings is done as part of the input process, before expansion takes place.
5307 However, backslash is also an escape character for the expander, so any
5308 backslashes that are required for that reason must be doubled if they are
5309 within a quoted configuration string.
5310
5311
5312 .section "User and group names" "SECID52"
5313 .cindex "user name" "format of"
5314 .cindex "format" "user name"
5315 .cindex "groups" "name format"
5316 .cindex "format" "group name"
5317 User and group names are specified as strings, using the syntax described
5318 above, but the strings are interpreted specially. A user or group name must
5319 either consist entirely of digits, or be a name that can be looked up using the
5320 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5321
5322
5323 .section "List construction" "SECTlistconstruct"
5324 .cindex "list" "syntax of in configuration"
5325 .cindex "format" "list item in configuration"
5326 .cindex "string" "list, definition of"
5327 The data for some configuration options is a list of items, with colon as the
5328 default separator. Many of these options are shown with type &"string list"& in
5329 the descriptions later in this document. Others are listed as &"domain list"&,
5330 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5331 are all the same; however, those other than &"string list"& are subject to
5332 particular kinds of interpretation, as described in chapter
5333 &<<CHAPdomhosaddlists>>&.
5334
5335 In all these cases, the entire list is treated as a single string as far as the
5336 input syntax is concerned. The &%trusted_users%& setting in section
5337 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5338 in a list, it must be entered as two colons. Leading and trailing white space
5339 on each item in a list is ignored. This makes it possible to include items that
5340 start with a colon, and in particular, certain forms of IPv6 address. For
5341 example, the list
5342 .code
5343 local_interfaces = 127.0.0.1 : ::::1
5344 .endd
5345 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5346
5347 &*Note*&: Although leading and trailing white space is ignored in individual
5348 list items, it is not ignored when parsing the list. The space after the first
5349 colon in the example above is necessary. If it were not there, the list would
5350 be interpreted as the two items 127.0.0.1:: and 1.
5351
5352 .section "Changing list separators" "SECTlistsepchange"
5353 .cindex "list separator" "changing"
5354 .cindex "IPv6" "addresses in lists"
5355 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5356 introduced to allow the separator character to be changed. If a list begins
5357 with a left angle bracket, followed by any punctuation character, that
5358 character is used instead of colon as the list separator. For example, the list
5359 above can be rewritten to use a semicolon separator like this:
5360 .code
5361 local_interfaces = <; 127.0.0.1 ; ::1
5362 .endd
5363 This facility applies to all lists, with the exception of the list in
5364 &%log_file_path%&. It is recommended that the use of non-colon separators be
5365 confined to circumstances where they really are needed.
5366
5367 .cindex "list separator" "newline as"
5368 .cindex "newline" "as list separator"
5369 It is also possible to use newline and other control characters (those with
5370 code values less than 32, plus DEL) as separators in lists. Such separators
5371 must be provided literally at the time the list is processed. For options that
5372 are string-expanded, you can write the separator using a normal escape
5373 sequence. This will be processed by the expander before the string is
5374 interpreted as a list. For example, if a newline-separated list of domains is
5375 generated by a lookup, you can process it directly by a line such as this:
5376 .code
5377 domains = <\n ${lookup mysql{.....}}
5378 .endd
5379 This avoids having to change the list separator in such data. You are unlikely
5380 to want to use a control character as a separator in an option that is not
5381 expanded, because the value is literal text. However, it can be done by giving
5382 the value in quotes. For example:
5383 .code
5384 local_interfaces = "<\n 127.0.0.1 \n ::1"
5385 .endd
5386 Unlike printing character separators, which can be included in list items by
5387 doubling, it is not possible to include a control character as data when it is
5388 set as the separator. Two such characters in succession are interpreted as
5389 enclosing an empty list item.
5390
5391
5392
5393 .section "Empty items in lists" "SECTempitelis"
5394 .cindex "list" "empty item in"
5395 An empty item at the end of a list is always ignored. In other words, trailing
5396 separator characters are ignored. Thus, the list in
5397 .code
5398 senders = user@domain :
5399 .endd
5400 contains only a single item. If you want to include an empty string as one item
5401 in a list, it must not be the last item. For example, this list contains three
5402 items, the second of which is empty:
5403 .code
5404 senders = user1@domain : : user2@domain
5405 .endd
5406 &*Note*&: There must be white space between the two colons, as otherwise they
5407 are interpreted as representing a single colon data character (and the list
5408 would then contain just one item). If you want to specify a list that contains
5409 just one, empty item, you can do it as in this example:
5410 .code
5411 senders = :
5412 .endd
5413 In this case, the first item is empty, and the second is discarded because it
5414 is at the end of the list.
5415
5416
5417
5418
5419 .section "Format of driver configurations" "SECTfordricon"
5420 .cindex "drivers" "configuration format"
5421 There are separate parts in the configuration for defining routers, transports,
5422 and authenticators. In each part, you are defining a number of driver
5423 instances, each with its own set of options. Each driver instance is defined by
5424 a sequence of lines like this:
5425 .display
5426 <&'instance name'&>:
5427   <&'option'&>
5428   ...
5429   <&'option'&>
5430 .endd
5431 In the following example, the instance name is &(localuser)&, and it is
5432 followed by three options settings:
5433 .code
5434 localuser:
5435   driver = accept
5436   check_local_user
5437   transport = local_delivery
5438 .endd
5439 For each driver instance, you specify which Exim code module it uses &-- by the
5440 setting of the &%driver%& option &-- and (optionally) some configuration
5441 settings. For example, in the case of transports, if you want a transport to
5442 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5443 a local file you would use the &(appendfile)& driver. Each of the drivers is
5444 described in detail in its own separate chapter later in this manual.
5445
5446 You can have several routers, transports, or authenticators that are based on
5447 the same underlying driver (each must have a different instance name).
5448
5449 The order in which routers are defined is important, because addresses are
5450 passed to individual routers one by one, in order. The order in which
5451 transports are defined does not matter at all. The order in which
5452 authenticators are defined is used only when Exim, as a client, is searching
5453 them to find one that matches an authentication mechanism offered by the
5454 server.
5455
5456 .cindex "generic options"
5457 .cindex "options" "generic &-- definition of"
5458 Within a driver instance definition, there are two kinds of option: &'generic'&
5459 and &'private'&. The generic options are those that apply to all drivers of the
5460 same type (that is, all routers, all transports or all authenticators). The
5461 &%driver%& option is a generic option that must appear in every definition.
5462 .cindex "private options"
5463 The private options are special for each driver, and none need appear, because
5464 they all have default values.
5465
5466 The options may appear in any order, except that the &%driver%& option must
5467 precede any private options, since these depend on the particular driver. For
5468 this reason, it is recommended that &%driver%& always be the first option.
5469
5470 Driver instance names, which are used for reference in log entries and
5471 elsewhere, can be any sequence of letters, digits, and underscores (starting
5472 with a letter) and must be unique among drivers of the same type. A router and
5473 a transport (for example) can each have the same name, but no two router
5474 instances can have the same name. The name of a driver instance should not be
5475 confused with the name of the underlying driver module. For example, the
5476 configuration lines:
5477 .code
5478 remote_smtp:
5479   driver = smtp
5480 .endd
5481 create an instance of the &(smtp)& transport driver whose name is
5482 &(remote_smtp)&. The same driver code can be used more than once, with
5483 different instance names and different option settings each time. A second
5484 instance of the &(smtp)& transport, with different options, might be defined
5485 thus:
5486 .code
5487 special_smtp:
5488   driver = smtp
5489   port = 1234
5490   command_timeout = 10s
5491 .endd
5492 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5493 these transport instances from routers, and these names would appear in log
5494 lines.
5495
5496 Comment lines may be present in the middle of driver specifications. The full
5497 list of option settings for any particular driver instance, including all the
5498 defaulted values, can be extracted by making use of the &%-bP%& command line
5499 option.
5500
5501
5502
5503
5504
5505
5506 . ////////////////////////////////////////////////////////////////////////////
5507 . ////////////////////////////////////////////////////////////////////////////
5508
5509 .chapter "The default configuration file" "CHAPdefconfil"
5510 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5511 .cindex "default" "configuration file &""walk through""&"
5512 The default configuration file supplied with Exim as &_src/configure.default_&
5513 is sufficient for a host with simple mail requirements. As an introduction to
5514 the way Exim is configured, this chapter &"walks through"& the default
5515 configuration, giving brief explanations of the settings. Detailed descriptions
5516 of the options are given in subsequent chapters. The default configuration file
5517 itself contains extensive comments about ways you might want to modify the
5518 initial settings. However, note that there are many options that are not
5519 mentioned at all in the default configuration.
5520
5521
5522
5523 .section "Macros" "SECTdefconfmacros"
5524 All macros should be defined before any options.
5525
5526 One macro is specified, but commented out, in the default configuration:
5527 .code
5528 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5529 .endd
5530 If all off-site mail is expected to be delivered to a "smarthost", then set the
5531 hostname here and uncomment the macro.  This will affect which router is used
5532 later on.  If this is left commented out, then Exim will perform direct-to-MX
5533 deliveries using a &(dnslookup)& router.
5534
5535 In addition to macros defined here, Exim includes a number of built-in macros
5536 to enable configuration to be guarded by a binary built with support for a
5537 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5538
5539
5540 .section "Main configuration settings" "SECTdefconfmain"
5541 The main (global) configuration option settings section must always come first
5542 in the file, after the macros.
5543 The first thing you'll see in the file, after some initial comments, is the line
5544 .code
5545 # primary_hostname =
5546 .endd
5547 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5548 to know the official, fully qualified name of your host, and this is where you
5549 can specify it. However, in most cases you do not need to set this option. When
5550 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5551
5552 The first three non-comment configuration lines are as follows:
5553 .code
5554 domainlist local_domains    = @
5555 domainlist relay_to_domains =
5556 hostlist   relay_from_hosts = 127.0.0.1
5557 .endd
5558 These are not, in fact, option settings. They are definitions of two named
5559 domain lists and one named host list. Exim allows you to give names to lists of
5560 domains, hosts, and email addresses, in order to make it easier to manage the
5561 configuration file (see section &<<SECTnamedlists>>&).
5562
5563 The first line defines a domain list called &'local_domains'&; this is used
5564 later in the configuration to identify domains that are to be delivered
5565 on the local host.
5566
5567 .cindex "@ in a domain list"
5568 There is just one item in this list, the string &"@"&. This is a special form
5569 of entry which means &"the name of the local host"&. Thus, if the local host is
5570 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5571 be delivered locally. Because the local host's name is referenced indirectly,
5572 the same configuration file can be used on different hosts.
5573
5574 The second line defines a domain list called &'relay_to_domains'&, but the
5575 list itself is empty. Later in the configuration we will come to the part that
5576 controls mail relaying through the local host; it allows relaying to any
5577 domains in this list. By default, therefore, no relaying on the basis of a mail
5578 domain is permitted.
5579
5580 The third line defines a host list called &'relay_from_hosts'&. This list is
5581 used later in the configuration to permit relaying from any host or IP address
5582 that matches the list. The default contains just the IP address of the IPv4
5583 loopback interface, which means that processes on the local host are able to
5584 submit mail for relaying by sending it over TCP/IP to that interface. No other
5585 hosts are permitted to submit messages for relaying.
5586
5587 Just to be sure there's no misunderstanding: at this point in the configuration
5588 we aren't actually setting up any controls. We are just defining some domains
5589 and hosts that will be used in the controls that are specified later.
5590
5591 The next two configuration lines are genuine option settings:
5592 .code
5593 acl_smtp_rcpt = acl_check_rcpt
5594 acl_smtp_data = acl_check_data
5595 .endd
5596 These options specify &'Access Control Lists'& (ACLs) that are to be used
5597 during an incoming SMTP session for every recipient of a message (every RCPT
5598 command), and after the contents of the message have been received,
5599 respectively. The names of the lists are &'acl_check_rcpt'& and
5600 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5601 section of the configuration. The RCPT ACL controls which recipients are
5602 accepted for an incoming message &-- if a configuration does not provide an ACL
5603 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5604 contents of a message to be checked.
5605
5606 Two commented-out option settings are next:
5607 .code
5608 # av_scanner = clamd:/tmp/clamd
5609 # spamd_address = 127.0.0.1 783
5610 .endd
5611 These are example settings that can be used when Exim is compiled with the
5612 content-scanning extension. The first specifies the interface to the virus
5613 scanner, and the second specifies the interface to SpamAssassin. Further
5614 details are given in chapter &<<CHAPexiscan>>&.
5615
5616 Three more commented-out option settings follow:
5617 .code
5618 # tls_advertise_hosts = *
5619 # tls_certificate = /etc/ssl/exim.crt
5620 # tls_privatekey = /etc/ssl/exim.pem
5621 .endd
5622 These are example settings that can be used when Exim is compiled with
5623 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5624 first one specifies the list of clients that are allowed to use TLS when
5625 connecting to this server; in this case, the wildcard means all clients. The
5626 other options specify where Exim should find its TLS certificate and private
5627 key, which together prove the server's identity to any clients that connect.
5628 More details are given in chapter &<<CHAPTLS>>&.
5629
5630 Another two commented-out option settings follow:
5631 .code
5632 # daemon_smtp_ports = 25 : 465 : 587
5633 # tls_on_connect_ports = 465
5634 .endd
5635 .cindex "port" "465 and 587"
5636 .cindex "port" "for message submission"
5637 .cindex "message" "submission, ports for"
5638 .cindex "submissions protocol"
5639 .cindex "smtps protocol"
5640 .cindex "ssmtp protocol"
5641 .cindex "SMTP" "submissions protocol"
5642 .cindex "SMTP" "ssmtp protocol"
5643 .cindex "SMTP" "smtps protocol"
5644 These options provide better support for roaming users who wish to use this
5645 server for message submission. They are not much use unless you have turned on
5646 TLS (as described in the previous paragraph) and authentication (about which
5647 more in section &<<SECTdefconfauth>>&).
5648 Mail submission from mail clients (MUAs) should be separate from inbound mail
5649 to your domain (MX delivery) for various good reasons (eg, ability to impose
5650 much saner TLS protocol and ciphersuite requirements without unintended
5651 consequences).
5652 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5653 which uses STARTTLS, so this is the &"submission"& port.
5654 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5655 which should be used in preference to 587.
5656 You should also consider deploying SRV records to help clients find
5657 these ports.
5658 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5659
5660 Two more commented-out options settings follow:
5661 .code
5662 # qualify_domain =
5663 # qualify_recipient =
5664 .endd
5665 The first of these specifies a domain that Exim uses when it constructs a
5666 complete email address from a local login name. This is often needed when Exim
5667 receives a message from a local process. If you do not set &%qualify_domain%&,
5668 the value of &%primary_hostname%& is used. If you set both of these options,
5669 you can have different qualification domains for sender and recipient
5670 addresses. If you set only the first one, its value is used in both cases.
5671
5672 .cindex "domain literal" "recognizing format"
5673 The following line must be uncommented if you want Exim to recognize
5674 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5675 (an IP address within square brackets) instead of a named domain.
5676 .code
5677 # allow_domain_literals
5678 .endd
5679 The RFCs still require this form, but many people think that in the modern
5680 Internet it makes little sense to permit mail to be sent to specific hosts by
5681 quoting their IP addresses. This ancient format has been used by people who
5682 try to abuse hosts by using them for unwanted relaying. However, some
5683 people believe there are circumstances (for example, messages addressed to
5684 &'postmaster'&) where domain literals are still useful.
5685
5686 The next configuration line is a kind of trigger guard:
5687 .code
5688 never_users = root
5689 .endd
5690 It specifies that no delivery must ever be run as the root user. The normal
5691 convention is to set up &'root'& as an alias for the system administrator. This
5692 setting is a guard against slips in the configuration.
5693 The list of users specified by &%never_users%& is not, however, the complete
5694 list; the build-time configuration in &_Local/Makefile_& has an option called
5695 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5696 contents of &%never_users%& are added to this list. By default
5697 FIXED_NEVER_USERS also specifies root.
5698
5699 When a remote host connects to Exim in order to send mail, the only information
5700 Exim has about the host's identity is its IP address. The next configuration
5701 line,
5702 .code
5703 host_lookup = *
5704 .endd
5705 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5706 in order to get a host name. This improves the quality of the logging
5707 information, but if you feel it is too expensive, you can remove it entirely,
5708 or restrict the lookup to hosts on &"nearby"& networks.
5709 Note that it is not always possible to find a host name from an IP address,
5710 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5711 unreachable.
5712
5713 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5714 1413 (hence their names):
5715 .code
5716 rfc1413_hosts = *
5717 rfc1413_query_timeout = 0s
5718 .endd
5719 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5720 Few hosts offer RFC1413 service these days; calls have to be
5721 terminated by a timeout and this needlessly delays the startup
5722 of an incoming SMTP connection.
5723 If you have hosts for which you trust RFC1413 and need this
5724 information, you can change this.
5725
5726 This line enables an efficiency SMTP option.  It is negotiated by clients
5727 and not expected to cause problems but can be disabled if needed.
5728 .code
5729 prdr_enable = true
5730 .endd
5731
5732 When Exim receives messages over SMTP connections, it expects all addresses to
5733 be fully qualified with a domain, as required by the SMTP definition. However,
5734 if you are running a server to which simple clients submit messages, you may
5735 find that they send unqualified addresses. The two commented-out options:
5736 .code
5737 # sender_unqualified_hosts =
5738 # recipient_unqualified_hosts =
5739 .endd
5740 show how you can specify hosts that are permitted to send unqualified sender
5741 and recipient addresses, respectively.
5742
5743 The &%log_selector%& option is used to increase the detail of logging
5744 over the default:
5745 .code
5746 log_selector = +smtp_protocol_error +smtp_syntax_error \
5747                +tls_certificate_verified
5748 .endd
5749
5750 The &%percent_hack_domains%& option is also commented out:
5751 .code
5752 # percent_hack_domains =
5753 .endd
5754 It provides a list of domains for which the &"percent hack"& is to operate.
5755 This is an almost obsolete form of explicit email routing. If you do not know
5756 anything about it, you can safely ignore this topic.
5757
5758 The next two settings in the main part of the default configuration are
5759 concerned with messages that have been &"frozen"& on Exim's queue. When a
5760 message is frozen, Exim no longer continues to try to deliver it. Freezing
5761 occurs when a bounce message encounters a permanent failure because the sender
5762 address of the original message that caused the bounce is invalid, so the
5763 bounce cannot be delivered. This is probably the most common case, but there
5764 are also other conditions that cause freezing, and frozen messages are not
5765 always bounce messages.
5766 .code
5767 ignore_bounce_errors_after = 2d
5768 timeout_frozen_after = 7d
5769 .endd
5770 The first of these options specifies that failing bounce messages are to be
5771 discarded after 2 days in the queue. The second specifies that any frozen
5772 message (whether a bounce message or not) is to be timed out (and discarded)
5773 after a week. In this configuration, the first setting ensures that no failing
5774 bounce message ever lasts a week.
5775
5776 Exim queues it's messages in a spool directory. If you expect to have
5777 large queues, you may consider using this option. It splits the spool
5778 directory into subdirectories to avoid file system degradation from
5779 many files in a single directory, resulting in better performance.
5780 Manual manipulation of queued messages becomes more complex (though fortunately
5781 not often needed).
5782 .code
5783 # split_spool_directory = true
5784 .endd
5785
5786 In an ideal world everybody follows the standards. For non-ASCII
5787 messages RFC 2047 is a standard, allowing a maximum line length of 76
5788 characters. Exim adheres that standard and won't process messages which
5789 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5790 In particular, the Exim maintainers have had multiple reports of
5791 problems from Russian administrators of issues until they disable this
5792 check, because of some popular, yet buggy, mail composition software.
5793 .code
5794 # check_rfc2047_length = false
5795 .endd
5796
5797 If you need to be strictly RFC compliant you may wish to disable the
5798 8BITMIME advertisement. Use this, if you exchange mails with systems
5799 that are not 8-bit clean.
5800 .code
5801 # accept_8bitmime = false
5802 .endd
5803
5804 Libraries you use may depend on specific environment settings.  This
5805 imposes a security risk (e.g. PATH). There are two lists:
5806 &%keep_environment%& for the variables to import as they are, and
5807 &%add_environment%& for variables we want to set to a fixed value.
5808 Note that TZ is handled separately, by the $%timezone%$ runtime
5809 option and by the TIMEZONE_DEFAULT buildtime option.
5810 .code
5811 # keep_environment = ^LDAP
5812 # add_environment = PATH=/usr/bin::/bin
5813 .endd
5814
5815
5816 .section "ACL configuration" "SECID54"
5817 .cindex "default" "ACLs"
5818 .cindex "&ACL;" "default configuration"
5819 In the default configuration, the ACL section follows the main configuration.
5820 It starts with the line
5821 .code
5822 begin acl
5823 .endd
5824 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5825 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5826 and &%acl_smtp_data%& above.
5827
5828 .cindex "RCPT" "ACL for"
5829 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5830 RCPT command specifies one of the message's recipients. The ACL statements
5831 are considered in order, until the recipient address is either accepted or
5832 rejected. The RCPT command is then accepted or rejected, according to the
5833 result of the ACL processing.
5834 .code
5835 acl_check_rcpt:
5836 .endd
5837 This line, consisting of a name terminated by a colon, marks the start of the
5838 ACL, and names it.
5839 .code
5840 accept  hosts = :
5841 .endd
5842 This ACL statement accepts the recipient if the sending host matches the list.
5843 But what does that strange list mean? It doesn't actually contain any host
5844 names or IP addresses. The presence of the colon puts an empty item in the
5845 list; Exim matches this only if the incoming message did not come from a remote
5846 host, because in that case, the remote hostname is empty. The colon is
5847 important. Without it, the list itself is empty, and can never match anything.
5848
5849 What this statement is doing is to accept unconditionally all recipients in
5850 messages that are submitted by SMTP from local processes using the standard
5851 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5852 manner.
5853 .code
5854 deny    message       = Restricted characters in address
5855         domains       = +local_domains
5856         local_parts   = ^[.] : ^.*[@%!/|]
5857
5858 deny    message       = Restricted characters in address
5859         domains       = !+local_domains
5860         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5861 .endd
5862 These statements are concerned with local parts that contain any of the
5863 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5864 Although these characters are entirely legal in local parts (in the case of
5865 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5866 in Internet mail addresses.
5867
5868 The first three have in the past been associated with explicitly routed
5869 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5870 option). Addresses containing these characters are regularly tried by spammers
5871 in an attempt to bypass relaying restrictions, and also by open relay testing
5872 programs. Unless you really need them it is safest to reject these characters
5873 at this early stage. This configuration is heavy-handed in rejecting these
5874 characters for all messages it accepts from remote hosts. This is a deliberate
5875 policy of being as safe as possible.
5876
5877 The first rule above is stricter, and is applied to messages that are addressed
5878 to one of the local domains handled by this host. This is implemented by the
5879 first condition, which restricts it to domains that are listed in the
5880 &'local_domains'& domain list. The &"+"& character is used to indicate a
5881 reference to a named list. In this configuration, there is just one domain in
5882 &'local_domains'&, but in general there may be many.
5883
5884 The second condition on the first statement uses two regular expressions to
5885 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5886 or &"|"&. If you have local accounts that include these characters, you will
5887 have to modify this rule.
5888
5889 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5890 allows them because they have been encountered in practice. (Consider the
5891 common convention of local parts constructed as
5892 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5893 the author of Exim, who has no second initial.) However, a local part starting
5894 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5895 filename (for example, for a mailing list). This is also true for local parts
5896 that contain slashes. A pipe symbol can also be troublesome if the local part
5897 is incorporated unthinkingly into a shell command line.
5898
5899 The second rule above applies to all other domains, and is less strict. This
5900 allows your own users to send outgoing messages to sites that use slashes
5901 and vertical bars in their local parts. It blocks local parts that begin
5902 with a dot, slash, or vertical bar, but allows these characters within the
5903 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5904 and &"!"& is blocked, as before. The motivation here is to prevent your users
5905 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5906 .code
5907 accept  local_parts   = postmaster
5908         domains       = +local_domains
5909 .endd
5910 This statement, which has two conditions, accepts an incoming address if the
5911 local part is &'postmaster'& and the domain is one of those listed in the
5912 &'local_domains'& domain list. The &"+"& character is used to indicate a
5913 reference to a named list. In this configuration, there is just one domain in
5914 &'local_domains'&, but in general there may be many.
5915
5916 The presence of this statement means that mail to postmaster is never blocked
5917 by any of the subsequent tests. This can be helpful while sorting out problems
5918 in cases where the subsequent tests are incorrectly denying access.
5919 .code
5920 require verify        = sender
5921 .endd
5922 This statement requires the sender address to be verified before any subsequent
5923 ACL statement can be used. If verification fails, the incoming recipient
5924 address is refused. Verification consists of trying to route the address, to
5925 see if a bounce message could be delivered to it. In the case of remote
5926 addresses, basic verification checks only the domain, but &'callouts'& can be
5927 used for more verification if required. Section &<<SECTaddressverification>>&
5928 discusses the details of address verification.
5929 .code
5930 accept  hosts         = +relay_from_hosts
5931         control       = submission
5932 .endd
5933 This statement accepts the address if the message is coming from one of the
5934 hosts that are defined as being allowed to relay through this host. Recipient
5935 verification is omitted here, because in many cases the clients are dumb MUAs
5936 that do not cope well with SMTP error responses. For the same reason, the
5937 second line specifies &"submission mode"& for messages that are accepted. This
5938 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5939 messages that are deficient in some way, for example, because they lack a
5940 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5941 probably add recipient verification here, and disable submission mode.
5942 .code
5943 accept  authenticated = *
5944         control       = submission
5945 .endd
5946 This statement accepts the address if the client host has authenticated itself.
5947 Submission mode is again specified, on the grounds that such messages are most
5948 likely to come from MUAs. The default configuration does not define any
5949 authenticators, though it does include some nearly complete commented-out
5950 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5951 fact authenticate until you complete the authenticator definitions.
5952 .code
5953 require message = relay not permitted
5954         domains = +local_domains : +relay_to_domains
5955 .endd
5956 This statement rejects the address if its domain is neither a local domain nor
5957 one of the domains for which this host is a relay.
5958 .code
5959 require verify = recipient
5960 .endd
5961 This statement requires the recipient address to be verified; if verification
5962 fails, the address is rejected.
5963 .code
5964 # deny    message     = rejected because $sender_host_address \
5965 #                       is in a black list at $dnslist_domain\n\
5966 #                       $dnslist_text
5967 #         dnslists    = black.list.example
5968 #
5969 # warn    dnslists    = black.list.example
5970 #         add_header  = X-Warning: $sender_host_address is in \
5971 #                       a black list at $dnslist_domain
5972 #         log_message = found in $dnslist_domain
5973 .endd
5974 These commented-out lines are examples of how you could configure Exim to check
5975 sending hosts against a DNS black list. The first statement rejects messages
5976 from blacklisted hosts, whereas the second just inserts a warning header
5977 line.
5978 .code
5979 # require verify = csa
5980 .endd
5981 This commented-out line is an example of how you could turn on client SMTP
5982 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5983 records.
5984 .code
5985 accept
5986 .endd
5987 The final statement in the first ACL unconditionally accepts any recipient
5988 address that has successfully passed all the previous tests.
5989 .code
5990 acl_check_data:
5991 .endd
5992 This line marks the start of the second ACL, and names it. Most of the contents
5993 of this ACL are commented out:
5994 .code
5995 # deny    malware   = *
5996 #         message   = This message contains a virus \
5997 #                     ($malware_name).
5998 .endd
5999 These lines are examples of how to arrange for messages to be scanned for
6000 viruses when Exim has been compiled with the content-scanning extension, and a
6001 suitable virus scanner is installed. If the message is found to contain a
6002 virus, it is rejected with the given custom error message.
6003 .code
6004 # warn    spam      = nobody
6005 #         message   = X-Spam_score: $spam_score\n\
6006 #                     X-Spam_score_int: $spam_score_int\n\
6007 #                     X-Spam_bar: $spam_bar\n\
6008 #                     X-Spam_report: $spam_report
6009 .endd
6010 These lines are an example of how to arrange for messages to be scanned by
6011 SpamAssassin when Exim has been compiled with the content-scanning extension,
6012 and SpamAssassin has been installed. The SpamAssassin check is run with
6013 &`nobody`& as its user parameter, and the results are added to the message as a
6014 series of extra header line. In this case, the message is not rejected,
6015 whatever the spam score.
6016 .code
6017 accept
6018 .endd
6019 This final line in the DATA ACL accepts the message unconditionally.
6020
6021
6022 .section "Router configuration" "SECID55"
6023 .cindex "default" "routers"
6024 .cindex "routers" "default"
6025 The router configuration comes next in the default configuration, introduced
6026 by the line
6027 .code
6028 begin routers
6029 .endd
6030 Routers are the modules in Exim that make decisions about where to send
6031 messages. An address is passed to each router, in turn, until it is either
6032 accepted, or failed. This means that the order in which you define the routers
6033 matters. Each router is fully described in its own chapter later in this
6034 manual. Here we give only brief overviews.
6035 .code
6036 # domain_literal:
6037 #   driver = ipliteral
6038 #   domains = !+local_domains
6039 #   transport = remote_smtp
6040 .endd
6041 .cindex "domain literal" "default router"
6042 This router is commented out because the majority of sites do not want to
6043 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6044 you uncomment this router, you also need to uncomment the setting of
6045 &%allow_domain_literals%& in the main part of the configuration.
6046
6047 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6048 macro has been defined, per
6049 .code
6050 .ifdef ROUTER_SMARTHOST
6051 smarthost:
6052 #...
6053 .else
6054 dnslookup:
6055 #...
6056 .endif
6057 .endd
6058
6059 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6060 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6061 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6062 skip these routers because of the &%domains%& option.
6063
6064 .code
6065 smarthost:
6066   driver = manualroute
6067   domains = ! +local_domains
6068   transport = smarthost_smtp
6069   route_data = ROUTER_SMARTHOST
6070   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6071   no_more
6072 .endd
6073 This router only handles mail which is not to any local domains; this is
6074 specified by the line
6075 .code
6076 domains = ! +local_domains
6077 .endd
6078 The &%domains%& option lists the domains to which this router applies, but the
6079 exclamation mark is a negation sign, so the router is used only for domains
6080 that are not in the domain list called &'local_domains'& (which was defined at
6081 the start of the configuration). The plus sign before &'local_domains'&
6082 indicates that it is referring to a named list. Addresses in other domains are
6083 passed on to the following routers.
6084
6085 The name of the router driver is &(manualroute)& because we are manually
6086 specifying how mail should be routed onwards, instead of using DNS MX.
6087 While the name of this router instance is arbitrary, the &%driver%& option must
6088 be one of the driver modules that is in the Exim binary.
6089
6090 With no pre-conditions other than &%domains%&, all mail for non-local domains
6091 will be handled by this router, and the &%no_more%& setting will ensure that no
6092 other routers will be used for messages matching the pre-conditions.  See
6093 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6094 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6095 and the macro supplies the value; the address is then queued for the
6096 &(smarthost_smtp)& transport.
6097
6098 .code
6099 dnslookup:
6100   driver = dnslookup
6101   domains = ! +local_domains
6102   transport = remote_smtp
6103   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6104   no_more
6105 .endd
6106 The &%domains%& option behaves as per smarthost, above.
6107
6108 The name of the router driver is &(dnslookup)&,
6109 and is specified by the &%driver%& option. Do not be confused by the fact that
6110 the name of this router instance is the same as the name of the driver. The
6111 instance name is arbitrary, but the name set in the &%driver%& option must be
6112 one of the driver modules that is in the Exim binary.
6113
6114 The &(dnslookup)& router routes addresses by looking up their domains in the
6115 DNS in order to obtain a list of hosts to which the address is routed. If the
6116 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6117 specified by the &%transport%& option. If the router does not find the domain
6118 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6119 the address fails and is bounced.
6120
6121 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6122 be entirely ignored. This option is present because a number of cases have been
6123 encountered where MX records in the DNS point to host names
6124 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6125 Completely ignoring these IP addresses causes Exim to fail to route the
6126 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6127 continue to try to deliver the message periodically until the address timed
6128 out.
6129 .code
6130 system_aliases:
6131   driver = redirect
6132   allow_fail
6133   allow_defer
6134   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6135 # user = exim
6136   file_transport = address_file
6137   pipe_transport = address_pipe
6138 .endd
6139 Control reaches this and subsequent routers only for addresses in the local
6140 domains. This router checks to see whether the local part is defined as an
6141 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6142 data that it looks up from that file. If no data is found for the local part,
6143 the value of the &%data%& option is empty, causing the address to be passed to
6144 the next router.
6145
6146 &_/etc/aliases_& is a conventional name for the system aliases file that is
6147 often used. That is why it is referenced by from the default configuration
6148 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6149 &_Local/Makefile_& before building Exim.
6150 .code
6151 userforward:
6152   driver = redirect
6153   check_local_user
6154 # local_part_suffix = +* : -*
6155 # local_part_suffix_optional
6156   file = $home/.forward
6157 # allow_filter
6158   no_verify
6159   no_expn
6160   check_ancestor
6161   file_transport = address_file
6162   pipe_transport = address_pipe
6163   reply_transport = address_reply
6164 .endd
6165 This is the most complicated router in the default configuration. It is another
6166 redirection router, but this time it is looking for forwarding data set up by
6167 individual users. The &%check_local_user%& setting specifies a check that the
6168 local part of the address is the login name of a local user. If it is not, the
6169 router is skipped. The two commented options that follow &%check_local_user%&,
6170 namely:
6171 .code
6172 # local_part_suffix = +* : -*
6173 # local_part_suffix_optional
6174 .endd
6175 .vindex "&$local_part_suffix$&"
6176 show how you can specify the recognition of local part suffixes. If the first
6177 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6178 by any sequence of characters, is removed from the local part and placed in the
6179 variable &$local_part_suffix$&. The second suffix option specifies that the
6180 presence of a suffix in the local part is optional. When a suffix is present,
6181 the check for a local login uses the local part with the suffix removed.
6182
6183 When a local user account is found, the file called &_.forward_& in the user's
6184 home directory is consulted. If it does not exist, or is empty, the router
6185 declines. Otherwise, the contents of &_.forward_& are interpreted as
6186 redirection data (see chapter &<<CHAPredirect>>& for more details).
6187
6188 .cindex "Sieve filter" "enabling in default router"
6189 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6190 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6191 is commented out by default), the contents of the file are interpreted as a set
6192 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6193 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6194 separate document entitled &'Exim's interfaces to mail filtering'&.
6195
6196 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6197 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6198 There are two reasons for doing this:
6199
6200 .olist
6201 Whether or not a local user has a &_.forward_& file is not really relevant when
6202 checking an address for validity; it makes sense not to waste resources doing
6203 unnecessary work.
6204 .next
6205 More importantly, when Exim is verifying addresses or handling an EXPN
6206 command during an SMTP session, it is running as the Exim user, not as root.
6207 The group is the Exim group, and no additional groups are set up.
6208 It may therefore not be possible for Exim to read users' &_.forward_& files at
6209 this time.
6210 .endlist
6211
6212 The setting of &%check_ancestor%& prevents the router from generating a new
6213 address that is the same as any previous address that was redirected. (This
6214 works round a problem concerning a bad interaction between aliasing and
6215 forwarding &-- see section &<<SECTredlocmai>>&).
6216
6217 The final three option settings specify the transports that are to be used when
6218 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6219 auto-reply, respectively. For example, if a &_.forward_& file contains
6220 .code
6221 a.nother@elsewhere.example, /home/spqr/archive
6222 .endd
6223 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6224 transport.
6225 .code
6226 localuser:
6227   driver = accept
6228   check_local_user
6229 # local_part_suffix = +* : -*
6230 # local_part_suffix_optional
6231   transport = local_delivery
6232 .endd
6233 The final router sets up delivery into local mailboxes, provided that the local
6234 part is the name of a local login, by accepting the address and assigning it to
6235 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6236 routers, so the address is bounced. The commented suffix settings fulfil the
6237 same purpose as they do for the &(userforward)& router.
6238
6239
6240 .section "Transport configuration" "SECID56"
6241 .cindex "default" "transports"
6242 .cindex "transports" "default"
6243 Transports define mechanisms for actually delivering messages. They operate
6244 only when referenced from routers, so the order in which they are defined does
6245 not matter. The transports section of the configuration starts with
6246 .code
6247 begin transports
6248 .endd
6249 Two remote transports and four local transports are defined.
6250 .code
6251 remote_smtp:
6252   driver = smtp
6253   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6254 .ifdef _HAVE_DANE
6255   dnssec_request_domains = *
6256   hosts_try_dane = *
6257 .endif
6258 .ifdef _HAVE_PRDR
6259   hosts_try_prdr = *
6260 .endif
6261 .endd
6262 This transport is used for delivering messages over SMTP connections.
6263 The list of remote hosts comes from the router.
6264 The &%message_size_limit%& usage is a hack to avoid sending on messages
6265 with over-long lines.  The built-in macro _HAVE_DANE guards configuration
6266 to try to use DNSSEC for all queries and to use DANE for delivery;
6267 see section &<<SECDANE>>& for more details.
6268
6269 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6270 negotiated between client and server and not expected to cause problems
6271 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6272 use of the &%hosts_try_prdr%& configuration option.
6273
6274 The other remote transport is used when delivering to a specific smarthost
6275 with whom there must be some kind of existing relationship, instead of the
6276 usual federated system.
6277
6278 .code
6279 smarthost_smtp:
6280   driver = smtp
6281   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6282   multi_domain
6283   #
6284 .ifdef _HAVE_TLS
6285   # Comment out any of these which you have to, then file a Support
6286   # request with your smarthost provider to get things fixed:
6287   hosts_require_tls = *
6288   tls_verify_hosts = *
6289   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6290   # have to comment it out then this will at least log whether you succeed
6291   # or not:
6292   tls_try_verify_hosts = *
6293   #
6294   # The SNI name should match the name which we'll expect to verify;
6295   # many mail systems don't use SNI and this doesn't matter, but if it does,
6296   # we need to send a name which the remote site will recognize.
6297   # This _should_ be the name which the smarthost operators specified as
6298   # the hostname for sending your mail to.
6299   tls_sni = ROUTER_SMARTHOST
6300   #
6301 .ifdef _HAVE_OPENSSL
6302   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6303 .endif
6304 .ifdef _HAVE_GNUTLS
6305   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6306 .endif
6307 .endif
6308 .ifdef _HAVE_PRDR
6309   hosts_try_prdr = *
6310 .endif
6311 .endd
6312 After the same &%message_size_limit%& hack, we then specify that this Transport
6313 can handle messages to multiple domains in one run.  The assumption here is
6314 that you're routing all non-local mail to the same place and that place is
6315 happy to take all messages from you as quickly as possible.
6316 All other options depend upon built-in macros; if Exim was built without TLS support
6317 then no other options are defined.
6318 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6319 and versions using the &%tls_require_ciphers%& option, where the value to be
6320 used depends upon the library providing TLS.
6321 Beyond that, the options adopt the stance that you should have TLS support available
6322 from your smarthost on today's Internet, so we turn on requiring TLS for the
6323 mail to be delivered, and requiring that the certificate be valid, and match
6324 the expected hostname.  The &%tls_sni%& option can be used by service providers
6325 to select an appropriate certificate to present to you and here we re-use the
6326 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6327 You want to specify the hostname which you'll expect to validate for, and that
6328 should not be subject to insecure tampering via DNS results.
6329
6330 For the &%hosts_try_prdr%& option see the previous transport.
6331
6332 All other options are defaulted.
6333 .code
6334 local_delivery:
6335   driver = appendfile
6336   file = /var/mail/$local_part
6337   delivery_date_add
6338   envelope_to_add
6339   return_path_add
6340 # group = mail
6341 # mode = 0660
6342 .endd
6343 This &(appendfile)& transport is used for local delivery to user mailboxes in
6344 traditional BSD mailbox format. By default it runs under the uid and gid of the
6345 local user, which requires the sticky bit to be set on the &_/var/mail_&
6346 directory. Some systems use the alternative approach of running mail deliveries
6347 under a particular group instead of using the sticky bit. The commented options
6348 show how this can be done.
6349
6350 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6351 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6352 similarly-named options above.
6353 .code
6354 address_pipe:
6355   driver = pipe
6356   return_output
6357 .endd
6358 This transport is used for handling deliveries to pipes that are generated by
6359 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6360 option specifies that any output on stdout or stderr generated by the pipe is to
6361 be returned to the sender.
6362 .code
6363 address_file:
6364   driver = appendfile
6365   delivery_date_add
6366   envelope_to_add
6367   return_path_add
6368 .endd
6369 This transport is used for handling deliveries to files that are generated by
6370 redirection. The name of the file is not specified in this instance of
6371 &(appendfile)&, because it comes from the &(redirect)& router.
6372 .code
6373 address_reply:
6374   driver = autoreply
6375 .endd
6376 This transport is used for handling automatic replies generated by users'
6377 filter files.
6378
6379
6380
6381 .section "Default retry rule" "SECID57"
6382 .cindex "retry" "default rule"
6383 .cindex "default" "retry rule"
6384 The retry section of the configuration file contains rules which affect the way
6385 Exim retries deliveries that cannot be completed at the first attempt. It is
6386 introduced by the line
6387 .code
6388 begin retry
6389 .endd
6390 In the default configuration, there is just one rule, which applies to all
6391 errors:
6392 .code
6393 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6394 .endd
6395 This causes any temporarily failing address to be retried every 15 minutes for
6396 2 hours, then at intervals starting at one hour and increasing by a factor of
6397 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6398 is not delivered after 4 days of temporary failure, it is bounced. The time is
6399 measured from first failure, not from the time the message was received.
6400
6401 If the retry section is removed from the configuration, or is empty (that is,
6402 if no retry rules are defined), Exim will not retry deliveries. This turns
6403 temporary errors into permanent errors.
6404
6405
6406 .section "Rewriting configuration" "SECID58"
6407 The rewriting section of the configuration, introduced by
6408 .code
6409 begin rewrite
6410 .endd
6411 contains rules for rewriting addresses in messages as they arrive. There are no
6412 rewriting rules in the default configuration file.
6413
6414
6415
6416 .section "Authenticators configuration" "SECTdefconfauth"
6417 .cindex "AUTH" "configuration"
6418 The authenticators section of the configuration, introduced by
6419 .code
6420 begin authenticators
6421 .endd
6422 defines mechanisms for the use of the SMTP AUTH command. The default
6423 configuration file contains two commented-out example authenticators
6424 which support plaintext username/password authentication using the
6425 standard PLAIN mechanism and the traditional but non-standard LOGIN
6426 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6427 to support most MUA software.
6428
6429 The example PLAIN authenticator looks like this:
6430 .code
6431 #PLAIN:
6432 #  driver                  = plaintext
6433 #  server_set_id           = $auth2
6434 #  server_prompts          = :
6435 #  server_condition        = Authentication is not yet configured
6436 #  server_advertise_condition = ${if def:tls_in_cipher }
6437 .endd
6438 And the example LOGIN authenticator looks like this:
6439 .code
6440 #LOGIN:
6441 #  driver                  = plaintext
6442 #  server_set_id           = $auth1
6443 #  server_prompts          = <| Username: | Password:
6444 #  server_condition        = Authentication is not yet configured
6445 #  server_advertise_condition = ${if def:tls_in_cipher }
6446 .endd
6447
6448 The &%server_set_id%& option makes Exim remember the authenticated username
6449 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6450 &%server_prompts%& option configures the &(plaintext)& authenticator so
6451 that it implements the details of the specific authentication mechanism,
6452 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6453 when Exim offers authentication to clients; in the examples, this is only
6454 when TLS or SSL has been started, so to enable the authenticators you also
6455 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6456
6457 The &%server_condition%& setting defines how to verify that the username and
6458 password are correct. In the examples it just produces an error message.
6459 To make the authenticators work, you can use a string expansion
6460 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6461
6462 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6463 usercode and password are in different positions.
6464 Chapter &<<CHAPplaintext>>& covers both.
6465
6466 .ecindex IIDconfiwal
6467
6468
6469
6470 . ////////////////////////////////////////////////////////////////////////////
6471 . ////////////////////////////////////////////////////////////////////////////
6472
6473 .chapter "Regular expressions" "CHAPregexp"
6474
6475 .cindex "regular expressions" "library"
6476 .cindex "PCRE"
6477 Exim supports the use of regular expressions in many of its options. It
6478 uses the PCRE regular expression library; this provides regular expression
6479 matching that is compatible with Perl 5. The syntax and semantics of
6480 regular expressions is discussed in
6481 online Perl manpages, in
6482 many Perl reference books, and also in
6483 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6484 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6485 . --- the http: URL here redirects to another page with the ISBN in the URL
6486 . --- where trying to use https: just redirects back to http:, so sticking
6487 . --- to the old URL for now.  2018-09-07.
6488
6489 The documentation for the syntax and semantics of the regular expressions that
6490 are supported by PCRE is included in the PCRE distribution, and no further
6491 description is included here. The PCRE functions are called from Exim using
6492 the default option settings (that is, with no PCRE options set), except that
6493 the PCRE_CASELESS option is set when the matching is required to be
6494 case-insensitive.
6495
6496 In most cases, when a regular expression is required in an Exim configuration,
6497 it has to start with a circumflex, in order to distinguish it from plain text
6498 or an &"ends with"& wildcard. In this example of a configuration setting, the
6499 second item in the colon-separated list is a regular expression.
6500 .code
6501 domains = a.b.c : ^\\d{3} : *.y.z : ...
6502 .endd
6503 The doubling of the backslash is required because of string expansion that
6504 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6505 of this issue, and a way of avoiding the need for doubling backslashes. The
6506 regular expression that is eventually used in this example contains just one
6507 backslash. The circumflex is included in the regular expression, and has the
6508 normal effect of &"anchoring"& it to the start of the string that is being
6509 matched.
6510
6511 There are, however, two cases where a circumflex is not required for the
6512 recognition of a regular expression: these are the &%match%& condition in a
6513 string expansion, and the &%matches%& condition in an Exim filter file. In
6514 these cases, the relevant string is always treated as a regular expression; if
6515 it does not start with a circumflex, the expression is not anchored, and can
6516 match anywhere in the subject string.
6517
6518 In all cases, if you want a regular expression to match at the end of a string,
6519 you must code the $ metacharacter to indicate this. For example:
6520 .code
6521 domains = ^\\d{3}\\.example
6522 .endd
6523 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6524 You need to use:
6525 .code
6526 domains = ^\\d{3}\\.example\$
6527 .endd
6528 if you want &'example'& to be the top-level domain. The backslash before the
6529 $ is needed because string expansion also interprets dollar characters.
6530
6531
6532
6533 . ////////////////////////////////////////////////////////////////////////////
6534 . ////////////////////////////////////////////////////////////////////////////
6535
6536 .chapter "File and database lookups" "CHAPfdlookup"
6537 .scindex IIDfidalo1 "file" "lookups"
6538 .scindex IIDfidalo2 "database" "lookups"
6539 .cindex "lookup" "description of"
6540 Exim can be configured to look up data in files or databases as it processes
6541 messages. Two different kinds of syntax are used:
6542
6543 .olist
6544 A string that is to be expanded may contain explicit lookup requests. These
6545 cause parts of the string to be replaced by data that is obtained from the
6546 lookup. Lookups of this type are conditional expansion items. Different results
6547 can be defined for the cases of lookup success and failure. See chapter
6548 &<<CHAPexpand>>&, where string expansions are described in detail.
6549 The key for the lookup is specified as part of the string expansion.
6550 .next
6551 Lists of domains, hosts, and email addresses can contain lookup requests as a
6552 way of avoiding excessively long linear lists. In this case, the data that is
6553 returned by the lookup is often (but not always) discarded; whether the lookup
6554 succeeds or fails is what really counts. These kinds of list are described in
6555 chapter &<<CHAPdomhosaddlists>>&.
6556 The key for the lookup is given by the context in which the list is expanded.
6557 .endlist
6558
6559 String expansions, lists, and lookups interact with each other in such a way
6560 that there is no order in which to describe any one of them that does not
6561 involve references to the others. Each of these three chapters makes more sense
6562 if you have read the other two first. If you are reading this for the first
6563 time, be aware that some of it will make a lot more sense after you have read
6564 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6565
6566 .section "Examples of different lookup syntax" "SECID60"
6567 It is easy to confuse the two different kinds of lookup, especially as the
6568 lists that may contain the second kind are always expanded before being
6569 processed as lists. Therefore, they may also contain lookups of the first kind.
6570 Be careful to distinguish between the following two examples:
6571 .code
6572 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6573 domains = lsearch;/some/file
6574 .endd
6575 The first uses a string expansion, the result of which must be a domain list.
6576 No strings have been specified for a successful or a failing lookup; the
6577 defaults in this case are the looked-up data and an empty string, respectively.
6578 The expansion takes place before the string is processed as a list, and the
6579 file that is searched could contain lines like this:
6580 .code
6581 192.168.3.4: domain1:domain2:...
6582 192.168.1.9: domain3:domain4:...
6583 .endd
6584 When the lookup succeeds, the result of the expansion is a list of domains (and
6585 possibly other types of item that are allowed in domain lists).
6586
6587 In the second example, the lookup is a single item in a domain list. It causes
6588 Exim to use a lookup to see if the domain that is being processed can be found
6589 in the file. The file could contains lines like this:
6590 .code
6591 domain1:
6592 domain2:
6593 .endd
6594 Any data that follows the keys is not relevant when checking that the domain
6595 matches the list item.
6596
6597 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6598 Consider a file containing lines like this:
6599 .code
6600 192.168.5.6: lsearch;/another/file
6601 .endd
6602 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6603 first &%domains%& setting above generates the second setting, which therefore
6604 causes a second lookup to occur.
6605
6606 The rest of this chapter describes the different lookup types that are
6607 available. Any of them can be used in any part of the configuration where a
6608 lookup is permitted.
6609
6610
6611 .section "Lookup types" "SECID61"
6612 .cindex "lookup" "types of"
6613 .cindex "single-key lookup" "definition of"
6614 Two different types of data lookup are implemented:
6615
6616 .ilist
6617 The &'single-key'& type requires the specification of a file in which to look,
6618 and a single key to search for. The key must be a non-empty string for the
6619 lookup to succeed. The lookup type determines how the file is searched.
6620 .next
6621 .cindex "query-style lookup" "definition of"
6622 The &'query-style'& type accepts a generalized database query. No particular
6623 key value is assumed by Exim for query-style lookups. You can use whichever
6624 Exim variables you need to construct the database query.
6625 .endlist
6626
6627 The code for each lookup type is in a separate source file that is included in
6628 the binary of Exim only if the corresponding compile-time option is set. The
6629 default settings in &_src/EDITME_& are:
6630 .code
6631 LOOKUP_DBM=yes
6632 LOOKUP_LSEARCH=yes
6633 .endd
6634 which means that only linear searching and DBM lookups are included by default.
6635 For some types of lookup (e.g. SQL databases), you need to install appropriate
6636 libraries and header files before building Exim.
6637
6638
6639
6640
6641 .section "Single-key lookup types" "SECTsinglekeylookups"
6642 .cindex "lookup" "single-key types"
6643 .cindex "single-key lookup" "list of types"
6644 The following single-key lookup types are implemented:
6645
6646 .ilist
6647 .cindex "cdb" "description of"
6648 .cindex "lookup" "cdb"
6649 .cindex "binary zero" "in lookup key"
6650 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6651 string without a terminating binary zero. The cdb format is designed for
6652 indexed files that are read frequently and never updated, except by total
6653 re-creation. As such, it is particularly suitable for large files containing
6654 aliases or other indexed data referenced by an MTA. Information about cdb and
6655 tools for building the files can be found in several places:
6656 .display
6657 &url(https://cr.yp.to/cdb.html)
6658 &url(http://www.corpit.ru/mjt/tinycdb.html)
6659 &url(https://packages.debian.org/stable/utils/freecdb)
6660 &url(https://github.com/philpennock/cdbtools) (in Go)
6661 .endd
6662 . --- 2018-09-07: corpit.ru http:-only
6663 A cdb distribution is not needed in order to build Exim with cdb support,
6664 because the code for reading cdb files is included directly in Exim itself.
6665 However, no means of building or testing cdb files is provided with Exim, so
6666 you need to obtain a cdb distribution in order to do this.
6667 .next
6668 .cindex "DBM" "lookup type"
6669 .cindex "lookup" "dbm"
6670 .cindex "binary zero" "in lookup key"
6671 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6672 DBM file by looking up the record with the given key. A terminating binary
6673 zero is included in the key that is passed to the DBM library. See section
6674 &<<SECTdb>>& for a discussion of DBM libraries.
6675
6676 .cindex "Berkeley DB library" "file format"
6677 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6678 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6679 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6680 the DB_UNKNOWN option. This enables it to handle any of the types of database
6681 that the library supports, and can be useful for accessing DBM files created by
6682 other applications. (For earlier DB versions, DB_HASH is always used.)
6683 .next
6684 .cindex "lookup" "dbmjz"
6685 .cindex "lookup" "dbm &-- embedded NULs"
6686 .cindex "sasldb2"
6687 .cindex "dbmjz lookup type"
6688 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6689 interpreted as an Exim list; the elements of the list are joined together with
6690 ASCII NUL characters to form the lookup key.  An example usage would be to
6691 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6692 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6693 &(cram_md5)& authenticator.
6694 .next
6695 .cindex "lookup" "dbmnz"
6696 .cindex "lookup" "dbm &-- terminating zero"
6697 .cindex "binary zero" "in lookup key"
6698 .cindex "Courier"
6699 .cindex "&_/etc/userdbshadow.dat_&"
6700 .cindex "dbmnz lookup type"
6701 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6702 is not included in the key that is passed to the DBM library. You may need this
6703 if you want to look up data in files that are created by or shared with some
6704 other application that does not use terminating zeros. For example, you need to
6705 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6706 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6707 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6708 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6709 .next
6710 .cindex "lookup" "dsearch"
6711 .cindex "dsearch lookup type"
6712 &(dsearch)&: The given file must be a directory; this is searched for an entry
6713 whose name is the key by calling the &[lstat()]& function. The key may not
6714 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6715 the lookup is the name of the entry, which may be a file, directory,
6716 symbolic link, or any other kind of directory entry. An example of how this
6717 lookup can be used to support virtual domains is given in section
6718 &<<SECTvirtualdomains>>&.
6719 .next
6720 .cindex "lookup" "iplsearch"
6721 .cindex "iplsearch lookup type"
6722 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6723 terminated by a colon or white space or the end of the line. The keys in the
6724 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6725 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6726 being interpreted as a key terminator. For example:
6727 .code
6728 1.2.3.4:           data for 1.2.3.4
6729 192.168.0.0/16:    data for 192.168.0.0/16
6730 "abcd::cdab":      data for abcd::cdab
6731 "abcd:abcd::/32"   data for abcd:abcd::/32
6732 .endd
6733 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6734 file is searched linearly, using the CIDR masks where present, until a matching
6735 key is found. The first key that matches is used; there is no attempt to find a
6736 &"best"& match. Apart from the way the keys are matched, the processing for
6737 &(iplsearch)& is the same as for &(lsearch)&.
6738
6739 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6740 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6741 lookup types support only literal keys.
6742
6743 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6744 the implicit key is the host's IP address rather than its name (see section
6745 &<<SECThoslispatsikey>>&).
6746
6747 .new
6748 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6749 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6750 notation before executing the lookup.)
6751 .wen
6752 .next
6753 .new
6754 .cindex lookup json
6755 .cindex json "lookup type"
6756 .cindex JSON expansions
6757 &(json)&: The given file is a text file with a JSON structure.
6758 An element of the structure is extracted, defined by the search key.
6759 The key is a list of subelement selectors
6760 (colon-separated by default but changeable in the usual way)
6761 which are applied in turn to select smaller and smaller portions
6762 of the JSON structure.
6763 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6764 nunbered array element is selected.
6765 Otherwise it must apply to a JSON object; the named element is selected.
6766 The final resulting element can be a simple JSON type or a JSON object
6767 or array; for the latter two a string-representation os the JSON
6768 is returned.
6769 For elements of type string, the returned value is de-quoted.
6770 .wen
6771 .next
6772 .cindex "linear search"
6773 .cindex "lookup" "lsearch"
6774 .cindex "lsearch lookup type"
6775 .cindex "case sensitivity" "in lsearch lookup"
6776 &(lsearch)&: The given file is a text file that is searched linearly for a
6777 line beginning with the search key, terminated by a colon or white space or the
6778 end of the line. The search is case-insensitive; that is, upper and lower case
6779 letters are treated as the same. The first occurrence of the key that is found
6780 in the file is used.
6781
6782 White space between the key and the colon is permitted. The remainder of the
6783 line, with leading and trailing white space removed, is the data. This can be
6784 continued onto subsequent lines by starting them with any amount of white
6785 space, but only a single space character is included in the data at such a
6786 junction. If the data begins with a colon, the key must be terminated by a
6787 colon, for example:
6788 .code
6789 baduser:  :fail:
6790 .endd
6791 Empty lines and lines beginning with # are ignored, even if they occur in the
6792 middle of an item. This is the traditional textual format of alias files. Note
6793 that the keys in an &(lsearch)& file are literal strings. There is no
6794 wildcarding of any kind.
6795
6796 .cindex "lookup" "lsearch &-- colons in keys"
6797 .cindex "white space" "in lsearch key"
6798 In most &(lsearch)& files, keys are not required to contain colons or #
6799 characters, or white space. However, if you need this feature, it is available.
6800 If a key begins with a doublequote character, it is terminated only by a
6801 matching quote (or end of line), and the normal escaping rules apply to its
6802 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6803 quoted keys (exactly as for unquoted keys). There is no special handling of
6804 quotes for the data part of an &(lsearch)& line.
6805
6806 .next
6807 .cindex "NIS lookup type"
6808 .cindex "lookup" "NIS"
6809 .cindex "binary zero" "in lookup key"
6810 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6811 the given key, without a terminating binary zero. There is a variant called
6812 &(nis0)& which does include the terminating binary zero in the key. This is
6813 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6814 aliases; the full map names must be used.
6815
6816 .next
6817 .cindex "wildlsearch lookup type"
6818 .cindex "lookup" "wildlsearch"
6819 .cindex "nwildlsearch lookup type"
6820 .cindex "lookup" "nwildlsearch"
6821 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6822 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6823 the file may be wildcarded. The difference between these two lookup types is
6824 that for &(wildlsearch)&, each key in the file is string-expanded before being
6825 used, whereas for &(nwildlsearch)&, no expansion takes place.
6826
6827 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6828 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6829 file that are regular expressions can be made case-sensitive by the use of
6830 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6831
6832 . ==== As this is a nested list, any displays it contains must be indented
6833 . ==== as otherwise they are too far to the left.
6834
6835 .olist
6836 The string may begin with an asterisk to mean &"ends with"&. For example:
6837 .code
6838     *.a.b.c       data for anything.a.b.c
6839     *fish         data for anythingfish
6840 .endd
6841 .next
6842 The string may begin with a circumflex to indicate a regular expression. For
6843 example, for &(wildlsearch)&:
6844 .code
6845     ^\N\d+\.a\.b\N    data for <digits>.a.b
6846 .endd
6847 Note the use of &`\N`& to disable expansion of the contents of the regular
6848 expression. If you are using &(nwildlsearch)&, where the keys are not
6849 string-expanded, the equivalent entry is:
6850 .code
6851     ^\d+\.a\.b        data for <digits>.a.b
6852 .endd
6853 The case-insensitive flag is set at the start of compiling the regular
6854 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6855 For example, to make the entire pattern case-sensitive:
6856 .code
6857     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6858 .endd
6859
6860 If the regular expression contains white space or colon characters, you must
6861 either quote it (see &(lsearch)& above), or represent these characters in other
6862 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6863 colon. This may be easier than quoting, because if you quote, you have to
6864 escape all the backslashes inside the quotes.
6865
6866 &*Note*&: It is not possible to capture substrings in a regular expression
6867 match for later use, because the results of all lookups are cached. If a lookup
6868 is repeated, the result is taken from the cache, and no actual pattern matching
6869 takes place. The values of all the numeric variables are unset after a
6870 &((n)wildlsearch)& match.
6871
6872 .next
6873 Although I cannot see it being of much use, the general matching function that
6874 is used to implement &((n)wildlsearch)& means that the string may begin with a
6875 lookup name terminated by a semicolon, and followed by lookup data. For
6876 example:
6877 .code
6878     cdb;/some/file  data for keys that match the file
6879 .endd
6880 The data that is obtained from the nested lookup is discarded.
6881 .endlist olist
6882
6883 Keys that do not match any of these patterns are interpreted literally. The
6884 continuation rules for the data are the same as for &(lsearch)&, and keys may
6885 be followed by optional colons.
6886
6887 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6888 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6889 lookup types support only literal keys.
6890
6891 .next
6892 .cindex "lookup" "spf"
6893 If Exim is built with SPF support, manual lookups can be done
6894 (as opposed to the standard ACL condition method.
6895 For details see section &<<SECSPF>>&.
6896 .endlist ilist
6897
6898
6899 .section "Query-style lookup types" "SECTquerystylelookups"
6900 .cindex "lookup" "query-style types"
6901 .cindex "query-style lookup" "list of types"
6902 The supported query-style lookup types are listed below. Further details about
6903 many of them are given in later sections.
6904
6905 .ilist
6906 .cindex "DNS" "as a lookup type"
6907 .cindex "lookup" "DNS"
6908 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6909 are given in the supplied query. The resulting data is the contents of the
6910 records. See section &<<SECTdnsdb>>&.
6911 .next
6912 .cindex "InterBase lookup type"
6913 .cindex "lookup" "InterBase"
6914 &(ibase)&: This does a lookup in an InterBase database.
6915 .next
6916 .cindex "LDAP" "lookup type"
6917 .cindex "lookup" "LDAP"
6918 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6919 returns attributes from a single entry. There is a variant called &(ldapm)&
6920 that permits values from multiple entries to be returned. A third variant
6921 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6922 any attribute values. See section &<<SECTldap>>&.
6923 .next
6924 .cindex "MySQL" "lookup type"
6925 .cindex "lookup" "MySQL"
6926 &(mysql)&: The format of the query is an SQL statement that is passed to a
6927 MySQL database. See section &<<SECTsql>>&.
6928 .next
6929 .cindex "NIS+ lookup type"
6930 .cindex "lookup" "NIS+"
6931 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6932 the field to be returned. See section &<<SECTnisplus>>&.
6933 .next
6934 .cindex "Oracle" "lookup type"
6935 .cindex "lookup" "Oracle"
6936 &(oracle)&: The format of the query is an SQL statement that is passed to an
6937 Oracle database. See section &<<SECTsql>>&.
6938 .next
6939 .cindex "lookup" "passwd"
6940 .cindex "passwd lookup type"
6941 .cindex "&_/etc/passwd_&"
6942 &(passwd)& is a query-style lookup with queries that are just user names. The
6943 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6944 success, the result string is the same as you would get from an &(lsearch)&
6945 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6946 password value. For example:
6947 .code
6948 *:42:42:King Rat:/home/kr:/bin/bash
6949 .endd
6950 .next
6951 .cindex "PostgreSQL lookup type"
6952 .cindex "lookup" "PostgreSQL"
6953 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6954 PostgreSQL database. See section &<<SECTsql>>&.
6955
6956 .next
6957 .cindex "Redis lookup type"
6958 .cindex lookup Redis
6959 &(redis)&: The format of the query is either a simple get or simple set,
6960 passed to a Redis database. See section &<<SECTsql>>&.
6961
6962 .next
6963 .cindex "sqlite lookup type"
6964 .cindex "lookup" "sqlite"
6965 &(sqlite)&: The format of the query is a filename followed by an SQL statement
6966 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6967
6968 .next
6969 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6970 not likely to be useful in normal operation.
6971 .next
6972 .cindex "whoson lookup type"
6973 .cindex "lookup" "whoson"
6974 . --- still http:-only, 2018-09-07
6975 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6976 allows a server to check whether a particular (dynamically allocated) IP
6977 address is currently allocated to a known (trusted) user and, optionally, to
6978 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6979 at one time for &"POP before SMTP"& authentication, but that approach has been
6980 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6981 &"POP before SMTP"& checking using ACL statements such as
6982 .code
6983 require condition = \
6984   ${lookup whoson {$sender_host_address}{yes}{no}}
6985 .endd
6986 The query consists of a single IP address. The value returned is the name of
6987 the authenticated user, which is stored in the variable &$value$&. However, in
6988 this example, the data in &$value$& is not used; the result of the lookup is
6989 one of the fixed strings &"yes"& or &"no"&.
6990 .endlist
6991
6992
6993
6994 .section "Temporary errors in lookups" "SECID63"
6995 .cindex "lookup" "temporary error in"
6996 Lookup functions can return temporary error codes if the lookup cannot be
6997 completed. For example, an SQL or LDAP database might be unavailable. For this
6998 reason, it is not advisable to use a lookup that might do this for critical
6999 options such as a list of local domains.
7000
7001 When a lookup cannot be completed in a router or transport, delivery
7002 of the message (to the relevant address) is deferred, as for any other
7003 temporary error. In other circumstances Exim may assume the lookup has failed,
7004 or may give up altogether.
7005
7006
7007
7008 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7009 .cindex "wildcard lookups"
7010 .cindex "lookup" "default values"
7011 .cindex "lookup" "wildcard"
7012 .cindex "lookup" "* added to type"
7013 .cindex "default" "in single-key lookups"
7014 In this context, a &"default value"& is a value specified by the administrator
7015 that is to be used if a lookup fails.
7016
7017 &*Note:*& This section applies only to single-key lookups. For query-style
7018 lookups, the facilities of the query language must be used. An attempt to
7019 specify a default for a query-style lookup provokes an error.
7020
7021 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7022 and the initial lookup fails, the key &"*"& is looked up in the file to
7023 provide a default value. See also the section on partial matching below.
7024
7025 .cindex "*@ with single-key lookup"
7026 .cindex "lookup" "*@ added to type"
7027 .cindex "alias file" "per-domain default"
7028 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7029 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7030 character, a second lookup is done with everything before the last @ replaced
7031 by *. This makes it possible to provide per-domain defaults in alias files
7032 that include the domains in the keys. If the second lookup fails (or doesn't
7033 take place because there is no @ in the key), &"*"& is looked up.
7034 For example, a &(redirect)& router might contain:
7035 .code
7036 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7037 .endd
7038 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7039 looks up these keys, in this order:
7040 .code
7041 jane@eyre.example
7042 *@eyre.example
7043 *
7044 .endd
7045 The data is taken from whichever key it finds first. &*Note*&: In an
7046 &(lsearch)& file, this does not mean the first of these keys in the file. A
7047 complete scan is done for each key, and only if it is not found at all does
7048 Exim move on to try the next key.
7049
7050
7051
7052 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7053 .cindex "partial matching"
7054 .cindex "wildcard lookups"
7055 .cindex "lookup" "partial matching"
7056 .cindex "lookup" "wildcard"
7057 .cindex "asterisk" "in search type"
7058 The normal operation of a single-key lookup is to search the file for an exact
7059 match with the given key. However, in a number of situations where domains are
7060 being looked up, it is useful to be able to do partial matching. In this case,
7061 information in the file that has a key starting with &"*."& is matched by any
7062 domain that ends with the components that follow the full stop. For example, if
7063 a key in a DBM file is
7064 .code
7065 *.dates.fict.example
7066 .endd
7067 then when partial matching is enabled this is matched by (amongst others)
7068 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7069 by &'dates.fict.example'&, if that does not appear as a separate key in the
7070 file.
7071
7072 &*Note*&: Partial matching is not available for query-style lookups. It is
7073 also not available for any lookup items in address lists (see section
7074 &<<SECTaddresslist>>&).
7075
7076 Partial matching is implemented by doing a series of separate lookups using
7077 keys constructed by modifying the original subject key. This means that it can
7078 be used with any of the single-key lookup types, provided that
7079 partial matching keys
7080 beginning with a special prefix (default &"*."&) are included in the data file.
7081 Keys in the file that do not begin with the prefix are matched only by
7082 unmodified subject keys when partial matching is in use.
7083
7084 Partial matching is requested by adding the string &"partial-"& to the front of
7085 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7086 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7087 is added at the start of the subject key, and it is looked up again. If that
7088 fails, further lookups are tried with dot-separated components removed from the
7089 start of the subject key, one-by-one, and &"*."& added on the front of what
7090 remains.
7091
7092 A minimum number of two non-* components are required. This can be adjusted
7093 by including a number before the hyphen in the search type. For example,
7094 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7095 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7096 subject key is &'2250.dates.fict.example'& then the following keys are looked
7097 up when the minimum number of non-* components is two:
7098 .code
7099 2250.dates.fict.example
7100 *.2250.dates.fict.example
7101 *.dates.fict.example
7102 *.fict.example
7103 .endd
7104 As soon as one key in the sequence is successfully looked up, the lookup
7105 finishes.
7106
7107 .cindex "lookup" "partial matching &-- changing prefix"
7108 .cindex "prefix" "for partial matching"
7109 The use of &"*."& as the partial matching prefix is a default that can be
7110 changed. The motivation for this feature is to allow Exim to operate with file
7111 formats that are used by other MTAs. A different prefix can be supplied in
7112 parentheses instead of the hyphen after &"partial"&. For example:
7113 .code
7114 domains = partial(.)lsearch;/some/file
7115 .endd
7116 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7117 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7118 components is unchanged). The prefix may consist of any punctuation characters
7119 other than a closing parenthesis. It may be empty, for example:
7120 .code
7121 domains = partial1()cdb;/some/file
7122 .endd
7123 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7124 &`a.b.c`&, &`b.c`&, and &`c`&.
7125
7126 If &"partial0"& is specified, what happens at the end (when the lookup with
7127 just one non-wild component has failed, and the original key is shortened right
7128 down to the null string) depends on the prefix:
7129
7130 .ilist
7131 If the prefix has zero length, the whole lookup fails.
7132 .next
7133 If the prefix has length 1, a lookup for just the prefix is done. For
7134 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7135 .next
7136 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7137 remainder is looked up. With the default prefix, therefore, the final lookup is
7138 for &"*"& on its own.
7139 .next
7140 Otherwise, the whole prefix is looked up.
7141 .endlist
7142
7143
7144 If the search type ends in &"*"& or &"*@"& (see section
7145 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7146 this implies happens after all partial lookups have failed. If &"partial0"& is
7147 specified, adding &"*"& to the search type has no effect with the default
7148 prefix, because the &"*"& key is already included in the sequence of partial
7149 lookups. However, there might be a use for lookup types such as
7150 &"partial0(.)lsearch*"&.
7151
7152 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7153 in domain lists and the like. Partial matching works only in terms of
7154 dot-separated components; a key such as &`*fict.example`&
7155 in a database file is useless, because the asterisk in a partial matching
7156 subject key is always followed by a dot.
7157
7158
7159
7160
7161 .section "Lookup caching" "SECID64"
7162 .cindex "lookup" "caching"
7163 .cindex "caching" "lookup data"
7164 Exim caches all lookup results in order to avoid needless repetition of
7165 lookups. However, because (apart from the daemon) Exim operates as a collection
7166 of independent, short-lived processes, this caching applies only within a
7167 single Exim process. There is no inter-process lookup caching facility.
7168
7169 For single-key lookups, Exim keeps the relevant files open in case there is
7170 another lookup that needs them. In some types of configuration this can lead to
7171 many files being kept open for messages with many recipients. To avoid hitting
7172 the operating system limit on the number of simultaneously open files, Exim
7173 closes the least recently used file when it needs to open more files than its
7174 own internal limit, which can be changed via the &%lookup_open_max%& option.
7175
7176 The single-key lookup files are closed and the lookup caches are flushed at
7177 strategic points during delivery &-- for example, after all routing is
7178 complete.
7179
7180
7181
7182
7183 .section "Quoting lookup data" "SECID65"
7184 .cindex "lookup" "quoting"
7185 .cindex "quoting" "in lookups"
7186 When data from an incoming message is included in a query-style lookup, there
7187 is the possibility of special characters in the data messing up the syntax of
7188 the query. For example, a NIS+ query that contains
7189 .code
7190 [name=$local_part]
7191 .endd
7192 will be broken if the local part happens to contain a closing square bracket.
7193 For NIS+, data can be enclosed in double quotes like this:
7194 .code
7195 [name="$local_part"]
7196 .endd
7197 but this still leaves the problem of a double quote in the data. The rule for
7198 NIS+ is that double quotes must be doubled. Other lookup types have different
7199 rules, and to cope with the differing requirements, an expansion operator
7200 of the following form is provided:
7201 .code
7202 ${quote_<lookup-type>:<string>}
7203 .endd
7204 For example, the safest way to write the NIS+ query is
7205 .code
7206 [name="${quote_nisplus:$local_part}"]
7207 .endd
7208 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7209 operator can be used for all lookup types, but has no effect for single-key
7210 lookups, since no quoting is ever needed in their key strings.
7211
7212
7213
7214
7215 .section "More about dnsdb" "SECTdnsdb"
7216 .cindex "dnsdb lookup"
7217 .cindex "lookup" "dnsdb"
7218 .cindex "DNS" "as a lookup type"
7219 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7220 of a record type and a domain name, separated by an equals sign. For example,
7221 an expansion string could contain:
7222 .code
7223 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7224 .endd
7225 If the lookup succeeds, the result is placed in &$value$&, which in this case
7226 is used on its own as the result. If the lookup does not succeed, the
7227 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7228 &<<SECTforexpfai>>& for an explanation of what this means.
7229
7230 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7231 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7232 If no type is given, TXT is assumed.
7233
7234 For any record type, if multiple records are found, the data is returned as a
7235 concatenation, with newline as the default separator. The order, of course,
7236 depends on the DNS resolver. You can specify a different separator character
7237 between multiple records by putting a right angle-bracket followed immediately
7238 by the new separator at the start of the query. For example:
7239 .code
7240 ${lookup dnsdb{>: a=host1.example}}
7241 .endd
7242 It is permitted to specify a space as the separator character. Further
7243 white space is ignored.
7244 For lookup types that return multiple fields per record,
7245 an alternate field separator can be specified using a comma after the main
7246 separator character, followed immediately by the field separator.
7247
7248 .cindex "PTR record" "in &(dnsdb)& lookup"
7249 When the type is PTR,
7250 the data can be an IP address, written as normal; inversion and the addition of
7251 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7252 .code
7253 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7254 .endd
7255 If the data for a PTR record is not a syntactically valid IP address, it is not
7256 altered and nothing is added.
7257
7258 .cindex "MX record" "in &(dnsdb)& lookup"
7259 .cindex "SRV record" "in &(dnsdb)& lookup"
7260 For an MX lookup, both the preference value and the host name are returned for
7261 each record, separated by a space. For an SRV lookup, the priority, weight,
7262 port, and host name are returned for each record, separated by spaces.
7263 The field separator can be modified as above.
7264
7265 .cindex "TXT record" "in &(dnsdb)& lookup"
7266 .cindex "SPF record" "in &(dnsdb)& lookup"
7267 For TXT records with multiple items of data, only the first item is returned,
7268 unless a field separator is specified.
7269 To concatenate items without a separator, use a semicolon instead.
7270 For SPF records the
7271 default behaviour is to concatenate multiple items without using a separator.
7272 .code
7273 ${lookup dnsdb{>\n,: txt=a.b.example}}
7274 ${lookup dnsdb{>\n; txt=a.b.example}}
7275 ${lookup dnsdb{spf=example.org}}
7276 .endd
7277 It is permitted to specify a space as the separator character. Further
7278 white space is ignored.
7279
7280 .cindex "SOA record" "in &(dnsdb)& lookup"
7281 For an SOA lookup, while no result is obtained the lookup is redone with
7282 successively more leading components dropped from the given domain.
7283 Only the primary-nameserver field is returned unless a field separator is
7284 specified.
7285 .code
7286 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7287 .endd
7288
7289 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7290 .cindex "dnsdb modifiers"
7291 .cindex "modifiers" "dnsdb"
7292 .cindex "options" "dnsdb"
7293 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7294 each followed by a comma,
7295 that may appear before the record type.
7296
7297 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7298 temporary DNS error for any of them, the behaviour is controlled by
7299 a defer-option modifier.
7300 The possible keywords are
7301 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7302 With &"strict"& behaviour, any temporary DNS error causes the
7303 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7304 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7305 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7306 error causes the whole lookup to defer only if none of the other lookups
7307 succeed. The default is &"lax"&, so the following lookups are equivalent:
7308 .code
7309 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7310 ${lookup dnsdb{a=one.host.com:two.host.com}}
7311 .endd
7312 Thus, in the default case, as long as at least one of the DNS lookups
7313 yields some data, the lookup succeeds.
7314
7315 .cindex "DNSSEC" "dns lookup"
7316 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7317 The possible keywords are
7318 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7319 With &"strict"& or &"lax"& DNSSEC information is requested
7320 with the lookup.
7321 With &"strict"& a response from the DNS resolver that
7322 is not labelled as authenticated data
7323 is treated as equivalent to a temporary DNS error.
7324 The default is &"never"&.
7325
7326 See also the &$lookup_dnssec_authenticated$& variable.
7327
7328 .cindex timeout "dns lookup"
7329 .cindex "DNS" timeout
7330 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7331 The form is &"retrans_VAL"& where VAL is an Exim time specification
7332 (e.g. &"5s"&).
7333 The default value is set by the main configuration option &%dns_retrans%&.
7334
7335 Retries for the dnsdb lookup can be controlled by a retry modifier.
7336 The form if &"retry_VAL"& where VAL is an integer.
7337 The default count is set by the main configuration option &%dns_retry%&.
7338
7339 .cindex caching "of dns lookup"
7340 .cindex TTL "of dns lookup"
7341 .cindex DNS TTL
7342 Dnsdb lookup results are cached within a single process (and its children).
7343 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7344 value of the set of returned DNS records.
7345
7346
7347 .section "Pseudo dnsdb record types" "SECID66"
7348 .cindex "MX record" "in &(dnsdb)& lookup"
7349 By default, both the preference value and the host name are returned for
7350 each MX record, separated by a space. If you want only host names, you can use
7351 the pseudo-type MXH:
7352 .code
7353 ${lookup dnsdb{mxh=a.b.example}}
7354 .endd
7355 In this case, the preference values are omitted, and just the host names are
7356 returned.
7357
7358 .cindex "name server for enclosing domain"
7359 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7360 records on the given domain, but if none are found, it removes the first
7361 component of the domain name, and tries again. This process continues until NS
7362 records are found or there are no more components left (or there is a DNS
7363 error). In other words, it may return the name servers for a top-level domain,
7364 but it never returns the root name servers. If there are no NS records for the
7365 top-level domain, the lookup fails. Consider these examples:
7366 .code
7367 ${lookup dnsdb{zns=xxx.quercite.com}}
7368 ${lookup dnsdb{zns=xxx.edu}}
7369 .endd
7370 Assuming that in each case there are no NS records for the full domain name,
7371 the first returns the name servers for &%quercite.com%&, and the second returns
7372 the name servers for &%edu%&.
7373
7374 You should be careful about how you use this lookup because, unless the
7375 top-level domain does not exist, the lookup always returns some host names. The
7376 sort of use to which this might be put is for seeing if the name servers for a
7377 given domain are on a blacklist. You can probably assume that the name servers
7378 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7379 such a list.
7380
7381 .cindex "CSA" "in &(dnsdb)& lookup"
7382 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7383 records according to the CSA rules, which are described in section
7384 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7385 not sufficient because of the extra parent domain search behaviour of CSA. The
7386 result of a successful lookup such as:
7387 .code
7388 ${lookup dnsdb {csa=$sender_helo_name}}
7389 .endd
7390 has two space-separated fields: an authorization code and a target host name.
7391 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7392 authorization required but absent, or &"?"& for unknown.
7393
7394 .cindex "A+" "in &(dnsdb)& lookup"
7395 The pseudo-type A+ performs an AAAA
7396 and then an A lookup.  All results are returned; defer processing
7397 (see below) is handled separately for each lookup.  Example:
7398 .code
7399 ${lookup dnsdb {>; a+=$sender_helo_name}}
7400 .endd
7401
7402
7403 .section "Multiple dnsdb lookups" "SECID67"
7404 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7405 However, you can specify a list of domains or IP addresses in a single
7406 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7407 the default separator, but with the ability to change this. For example:
7408 .code
7409 ${lookup dnsdb{one.domain.com:two.domain.com}}
7410 ${lookup dnsdb{a=one.host.com:two.host.com}}
7411 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7412 .endd
7413 In order to retain backwards compatibility, there is one special case: if
7414 the lookup type is PTR and no change of separator is specified, Exim looks
7415 to see if the rest of the string is precisely one IPv6 address. In this
7416 case, it does not treat it as a list.
7417
7418 The data from each lookup is concatenated, with newline separators by default,
7419 in the same way that multiple DNS records for a single item are handled. A
7420 different separator can be specified, as described above.
7421
7422
7423
7424
7425 .section "More about LDAP" "SECTldap"
7426 .cindex "LDAP" "lookup, more about"
7427 .cindex "lookup" "LDAP"
7428 .cindex "Solaris" "LDAP"
7429 The original LDAP implementation came from the University of Michigan; this has
7430 become &"Open LDAP"&, and there are now two different releases. Another
7431 implementation comes from Netscape, and Solaris 7 and subsequent releases
7432 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7433 the lookup function level, their error handling is different. For this reason
7434 it is necessary to set a compile-time variable when building Exim with LDAP, to
7435 indicate which LDAP library is in use. One of the following should appear in
7436 your &_Local/Makefile_&:
7437 .code
7438 LDAP_LIB_TYPE=UMICHIGAN
7439 LDAP_LIB_TYPE=OPENLDAP1
7440 LDAP_LIB_TYPE=OPENLDAP2
7441 LDAP_LIB_TYPE=NETSCAPE
7442 LDAP_LIB_TYPE=SOLARIS
7443 .endd
7444 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7445 same interface as the University of Michigan version.
7446
7447 There are three LDAP lookup types in Exim. These behave slightly differently in
7448 the way they handle the results of a query:
7449
7450 .ilist
7451 &(ldap)& requires the result to contain just one entry; if there are more, it
7452 gives an error.
7453 .next
7454 &(ldapdn)& also requires the result to contain just one entry, but it is the
7455 Distinguished Name that is returned rather than any attribute values.
7456 .next
7457 &(ldapm)& permits the result to contain more than one entry; the attributes
7458 from all of them are returned.
7459 .endlist
7460
7461
7462 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7463 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7464 the data returned by a successful lookup is described in the next section.
7465 First we explain how LDAP queries are coded.
7466
7467
7468 .section "Format of LDAP queries" "SECTforldaque"
7469 .cindex "LDAP" "query format"
7470 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7471 the configuration of a &(redirect)& router one might have this setting:
7472 .code
7473 data = ${lookup ldap \
7474   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7475   c=UK?mailbox?base?}}
7476 .endd
7477 .cindex "LDAP" "with TLS"
7478 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7479 secure (encrypted) LDAP connections. The second of these ensures that an
7480 encrypted TLS connection is used.
7481
7482 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7483 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7484 See the &%ldap_start_tls%& option.
7485
7486 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7487 controlled. Every part of the TLS configuration can be configured by settings in
7488 &_exim.conf_&. Depending on the version of the client libraries installed on
7489 your system, some of the initialization may have required setting options in
7490 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7491 certificates. This revealed a nuance where the current UID that exim was
7492 running as could affect which config files it read. With Exim 4.83, these
7493 methods become optional, only taking effect if not specifically set in
7494 &_exim.conf_&.
7495
7496
7497 .section "LDAP quoting" "SECID68"
7498 .cindex "LDAP" "quoting"
7499 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7500 and the second because the LDAP query is represented as a URL. Furthermore,
7501 within an LDAP query, two different kinds of quoting are required. For this
7502 reason, there are two different LDAP-specific quoting operators.
7503
7504 The &%quote_ldap%& operator is designed for use on strings that are part of
7505 filter specifications. Conceptually, it first does the following conversions on
7506 the string:
7507 .code
7508 *   =>   \2A
7509 (   =>   \28
7510 )   =>   \29
7511 \   =>   \5C
7512 .endd
7513 in accordance with RFC 2254. The resulting string is then quoted according
7514 to the rules for URLs, that is, all non-alphanumeric characters except
7515 .code
7516 ! $ ' - . _ ( ) * +
7517 .endd
7518 are converted to their hex values, preceded by a percent sign. For example:
7519 .code
7520 ${quote_ldap: a(bc)*, a<yz>; }
7521 .endd
7522 yields
7523 .code
7524 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7525 .endd
7526 Removing the URL quoting, this is (with a leading and a trailing space):
7527 .code
7528 a\28bc\29\2A, a<yz>;
7529 .endd
7530 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7531 base DN specifications in queries. Conceptually, it first converts the string
7532 by inserting a backslash in front of any of the following characters:
7533 .code
7534 , + " \ < > ;
7535 .endd
7536 It also inserts a backslash before any leading spaces or # characters, and
7537 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7538 is then quoted according to the rules for URLs. For example:
7539 .code
7540 ${quote_ldap_dn: a(bc)*, a<yz>; }
7541 .endd
7542 yields
7543 .code
7544 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7545 .endd
7546 Removing the URL quoting, this is (with a trailing space):
7547 .code
7548 \ a(bc)*\, a\<yz\>\;\
7549 .endd
7550 There are some further comments about quoting in the section on LDAP
7551 authentication below.
7552
7553
7554 .section "LDAP connections" "SECID69"
7555 .cindex "LDAP" "connections"
7556 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7557 is in use, via a Unix domain socket. The example given above does not specify
7558 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7559 by starting it with
7560 .code
7561 ldap://<hostname>:<port>/...
7562 .endd
7563 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7564 used. When no server is specified in a query, a list of default servers is
7565 taken from the &%ldap_default_servers%& configuration option. This supplies a
7566 colon-separated list of servers which are tried in turn until one successfully
7567 handles a query, or there is a serious error. Successful handling either
7568 returns the requested data, or indicates that it does not exist. Serious errors
7569 are syntactical, or multiple values when only a single value is expected.
7570 Errors which cause the next server to be tried are connection failures, bind
7571 failures, and timeouts.
7572
7573 For each server name in the list, a port number can be given. The standard way
7574 of specifying a host and port is to use a colon separator (RFC 1738). Because
7575 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7576 doubled. For example
7577 .code
7578 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7579 .endd
7580 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7581 to the LDAP library with no server name, and the library's default (normally
7582 the local host) is used.
7583
7584 If you are using the OpenLDAP library, you can connect to an LDAP server using
7585 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7586 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7587 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7588 not available.
7589
7590 For this type of connection, instead of a host name for the server, a pathname
7591 for the socket is required, and the port number is not relevant. The pathname
7592 can be specified either as an item in &%ldap_default_servers%&, or inline in
7593 the query. In the former case, you can have settings such as
7594 .code
7595 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7596 .endd
7597 When the pathname is given in the query, you have to escape the slashes as
7598 &`%2F`& to fit in with the LDAP URL syntax. For example:
7599 .code
7600 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7601 .endd
7602 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7603 a pathname, it uses the Unix domain socket code, even if the query actually
7604 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7605 socket connection. This behaviour means that you can use a setting of
7606 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7607 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7608 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7609 backup host.
7610
7611 If an explicit &`ldapi`& type is given in a query when a host name is
7612 specified, an error is diagnosed. However, if there are more items in
7613 &%ldap_default_servers%&, they are tried. In other words:
7614
7615 .ilist
7616 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7617 interface.
7618 .next
7619 Using &`ldapi`& with a host name causes an error.
7620 .endlist
7621
7622
7623 Using &`ldapi`& with no host or path in the query, and no setting of
7624 &%ldap_default_servers%&, does whatever the library does by default.
7625
7626
7627
7628 .section "LDAP authentication and control information" "SECID70"
7629 .cindex "LDAP" "authentication"
7630 The LDAP URL syntax provides no way of passing authentication and other control
7631 information to the server. To make this possible, the URL in an LDAP query may
7632 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7633 spaces. If a value contains spaces it must be enclosed in double quotes, and
7634 when double quotes are used, backslash is interpreted in the usual way inside
7635 them. The following names are recognized:
7636 .display
7637 &`DEREFERENCE`&  set the dereferencing parameter
7638 &`NETTIME    `&  set a timeout for a network operation
7639 &`USER       `&  set the DN, for authenticating the LDAP bind
7640 &`PASS       `&  set the password, likewise
7641 &`REFERRALS  `&  set the referrals parameter
7642 &`SERVERS    `&  set alternate server list for this query only
7643 &`SIZE       `&  set the limit for the number of entries returned
7644 &`TIME       `&  set the maximum waiting time for a query
7645 .endd
7646 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7647 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7648 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7649 library from trying to follow referrals issued by the LDAP server.
7650
7651 .cindex LDAP timeout
7652 .cindex timeout "LDAP lookup"
7653 The name CONNECT is an obsolete name for NETTIME, retained for
7654 backwards compatibility. This timeout (specified as a number of seconds) is
7655 enforced from the client end for operations that can be carried out over a
7656 network. Specifically, it applies to network connections and calls to the
7657 &'ldap_result()'& function. If the value is greater than zero, it is used if
7658 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7659 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7660 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7661 Netscape SDK; for OpenLDAP no action is taken.
7662
7663 The TIME parameter (also a number of seconds) is passed to the server to
7664 set a server-side limit on the time taken to complete a search.
7665
7666 The SERVERS parameter allows you to specify an alternate list of ldap servers
7667 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7668 default list of ldap servers, and a single lookup can specify a single ldap
7669 server to use.  But when you need to do a lookup with a list of servers that is
7670 different than the default list (maybe different order, maybe a completely
7671 different set of servers), the SERVERS parameter allows you to specify this
7672 alternate list (colon-separated).
7673
7674 Here is an example of an LDAP query in an Exim lookup that uses some of these
7675 values. This is a single line, folded to fit on the page:
7676 .code
7677 ${lookup ldap
7678   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7679   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7680   {$value}fail}
7681 .endd
7682 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7683 any of the auxiliary data. Exim configuration settings that include lookups
7684 which contain password information should be preceded by &"hide"& to prevent
7685 non-admin users from using the &%-bP%& option to see their values.
7686
7687 The auxiliary data items may be given in any order. The default is no
7688 connection timeout (the system timeout is used), no user or password, no limit
7689 on the number of entries returned, and no time limit on queries.
7690
7691 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7692 removes any URL quoting that it may contain before passing it LDAP. Apparently
7693 some libraries do this for themselves, but some do not. Removing the URL
7694 quoting has two advantages:
7695
7696 .ilist
7697 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7698 DNs as with DNs inside actual queries.
7699 .next
7700 It permits spaces inside USER= DNs.
7701 .endlist
7702
7703 For example, a setting such as
7704 .code
7705 USER=cn=${quote_ldap_dn:$1}
7706 .endd
7707 should work even if &$1$& contains spaces.
7708
7709 Expanded data for the PASS= value should be quoted using the &%quote%&
7710 expansion operator, rather than the LDAP quote operators. The only reason this
7711 field needs quoting is to ensure that it conforms to the Exim syntax, which
7712 does not allow unquoted spaces. For example:
7713 .code
7714 PASS=${quote:$3}
7715 .endd
7716 The LDAP authentication mechanism can be used to check passwords as part of
7717 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7718 &<<CHAPexpand>>&.
7719
7720
7721
7722 .section "Format of data returned by LDAP" "SECID71"
7723 .cindex "LDAP" "returned data formats"
7724 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7725 as a sequence of values, for example
7726 .code
7727 cn=manager,o=University of Cambridge,c=UK
7728 .endd
7729 The &(ldap)& lookup type generates an error if more than one entry matches the
7730 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7731 the result between the data from different entries. It is possible for multiple
7732 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7733 you know that whatever values are returned all came from a single entry in the
7734 directory.
7735
7736 In the common case where you specify a single attribute in your LDAP query, the
7737 result is not quoted, and does not contain the attribute name. If the attribute
7738 has multiple values, they are separated by commas. Any comma that is
7739 part of an attribute's value is doubled.
7740
7741 If you specify multiple attributes, the result contains space-separated, quoted
7742 strings, each preceded by the attribute name and an equals sign. Within the
7743 quotes, the quote character, backslash, and newline are escaped with
7744 backslashes, and commas are used to separate multiple values for the attribute.
7745 Any commas in attribute values are doubled
7746 (permitting treatment of the values as a comma-separated list).
7747 Apart from the escaping, the string within quotes takes the same form as the
7748 output when a single attribute is requested. Specifying no attributes is the
7749 same as specifying all of an entry's attributes.
7750
7751 Here are some examples of the output format. The first line of each pair is an
7752 LDAP query, and the second is the data that is returned. The attribute called
7753 &%attr1%& has two values, one of them with an embedded comma, whereas
7754 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7755 (they have SUP &%attr%& in their schema definitions).
7756
7757 .code
7758 ldap:///o=base?attr1?sub?(uid=fred)
7759 value1.1,value1,,2
7760
7761 ldap:///o=base?attr2?sub?(uid=fred)
7762 value two
7763
7764 ldap:///o=base?attr?sub?(uid=fred)
7765 value1.1,value1,,2,value two
7766
7767 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7768 attr1="value1.1,value1,,2" attr2="value two"
7769
7770 ldap:///o=base??sub?(uid=fred)
7771 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7772 .endd
7773 You can
7774 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7775 results of LDAP lookups.
7776 The &%extract%& operator in string expansions can be used to pick out
7777 individual fields from data that consists of &'key'&=&'value'& pairs.
7778 The &%listextract%& operator should be used to pick out individual values
7779 of attributes, even when only a single value is expected.
7780 The doubling of embedded commas allows you to use the returned data as a
7781 comma separated list (using the "<," syntax for changing the input list separator).
7782
7783
7784
7785
7786 .section "More about NIS+" "SECTnisplus"
7787 .cindex "NIS+ lookup type"
7788 .cindex "lookup" "NIS+"
7789 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7790 and field name. If this is given, the result of a successful query is the
7791 contents of the named field; otherwise the result consists of a concatenation
7792 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7793 values containing spaces are quoted. For example, the query
7794 .code
7795 [name=mg1456],passwd.org_dir
7796 .endd
7797 might return the string
7798 .code
7799 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7800 home=/home/mg1456 shell=/bin/bash shadow=""
7801 .endd
7802 (split over two lines here to fit on the page), whereas
7803 .code
7804 [name=mg1456],passwd.org_dir:gcos
7805 .endd
7806 would just return
7807 .code
7808 Martin Guerre
7809 .endd
7810 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7811 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7812 operator is to double any quote characters within the text.
7813
7814
7815
7816 .section "SQL lookups" "SECTsql"
7817 .cindex "SQL lookup types"
7818 .cindex "MySQL" "lookup type"
7819 .cindex "PostgreSQL lookup type"
7820 .cindex "lookup" "MySQL"
7821 .cindex "lookup" "PostgreSQL"
7822 .cindex "Oracle" "lookup type"
7823 .cindex "lookup" "Oracle"
7824 .cindex "InterBase lookup type"
7825 .cindex "lookup" "InterBase"
7826 .cindex "Redis lookup type"
7827 .cindex lookup Redis
7828 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7829 and SQLite
7830 databases. Queries for these databases contain SQL statements, so an example
7831 might be
7832 .code
7833 ${lookup mysql{select mailbox from users where id='userx'}\
7834   {$value}fail}
7835 .endd
7836 If the result of the query contains more than one field, the data for each
7837 field in the row is returned, preceded by its name, so the result of
7838 .code
7839 ${lookup pgsql{select home,name from users where id='userx'}\
7840   {$value}}
7841 .endd
7842 might be
7843 .code
7844 home=/home/userx name="Mister X"
7845 .endd
7846 Empty values and values containing spaces are double quoted, with embedded
7847 quotes escaped by a backslash. If the result of the query contains just one
7848 field, the value is passed back verbatim, without a field name, for example:
7849 .code
7850 Mister X
7851 .endd
7852 If the result of the query yields more than one row, it is all concatenated,
7853 with a newline between the data for each row.
7854
7855
7856 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7857 .cindex "MySQL" "lookup type"
7858 .cindex "PostgreSQL lookup type"
7859 .cindex "lookup" "MySQL"
7860 .cindex "lookup" "PostgreSQL"
7861 .cindex "Oracle" "lookup type"
7862 .cindex "lookup" "Oracle"
7863 .cindex "InterBase lookup type"
7864 .cindex "lookup" "InterBase"
7865 .cindex "Redis lookup type"
7866 .cindex lookup Redis
7867 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7868 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7869 or &%redis_servers%&
7870 option (as appropriate) must be set to a colon-separated list of server
7871 information.
7872 (For MySQL and PostgreSQL, the global option need not be set if all
7873 queries contain their own server information &-- see section
7874 &<<SECTspeserque>>&.)
7875 For all but Redis
7876 each item in the list is a slash-separated list of four
7877 items: host name, database name, user name, and password. In the case of
7878 Oracle, the host name field is used for the &"service name"&, and the database
7879 name field is not used and should be empty. For example:
7880 .code
7881 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7882 .endd
7883 Because password data is sensitive, you should always precede the setting with
7884 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7885 option. Here is an example where two MySQL servers are listed:
7886 .code
7887 hide mysql_servers = localhost/users/root/secret:\
7888                      otherhost/users/root/othersecret
7889 .endd
7890 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7891 because this is a colon-separated list, the colon has to be doubled. For each
7892 query, these parameter groups are tried in order until a connection is made and
7893 a query is successfully processed. The result of a query may be that no data is
7894 found, but that is still a successful query. In other words, the list of
7895 servers provides a backup facility, not a list of different places to look.
7896
7897 For Redis the global option need not be specified if all queries contain their
7898 own server information &-- see section &<<SECTspeserque>>&.
7899 If specified, the option must be set to a colon-separated list of server
7900 information.
7901 Each item in the list is a slash-separated list of three items:
7902 host, database number, and password.
7903 .olist
7904 The host is required and may be either an IPv4 address and optional
7905 port number (separated by a colon, which needs doubling due to the
7906 higher-level list), or a Unix socket pathname enclosed in parentheses
7907 .next
7908 The database number is optional; if present that number is selected in the backend
7909 .next
7910 The password is optional; if present it is used to authenticate to the backend
7911 .endlist
7912
7913 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7914 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7915 respectively, and the characters single-quote, double-quote, and backslash
7916 itself are escaped with backslashes.
7917
7918 The &%quote_redis%& expansion operator
7919 escapes whitespace and backslash characters with a backslash.
7920
7921 .section "Specifying the server in the query" "SECTspeserque"
7922 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7923 it is possible to specify a list of servers with an individual query. This is
7924 done by starting the query with
7925 .display
7926 &`servers=`&&'server1:server2:server3:...'&&`;`&
7927 .endd
7928 Each item in the list may take one of two forms:
7929 .olist
7930 If it contains no slashes it is assumed to be just a host name. The appropriate
7931 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7932 of the same name, and the remaining parameters (database, user, password) are
7933 taken from there.
7934 .next
7935 If it contains any slashes, it is taken as a complete parameter set.
7936 .endlist
7937 The list of servers is used in exactly the same way as the global list.
7938 Once a connection to a server has happened and a query has been
7939 successfully executed, processing of the lookup ceases.
7940
7941 This feature is intended for use in master/slave situations where updates
7942 are occurring and you want to update the master rather than a slave. If the
7943 master is in the list as a backup for reading, you might have a global setting
7944 like this:
7945 .code
7946 mysql_servers = slave1/db/name/pw:\
7947                 slave2/db/name/pw:\
7948                 master/db/name/pw
7949 .endd
7950 In an updating lookup, you could then write:
7951 .code
7952 ${lookup mysql{servers=master; UPDATE ...} }
7953 .endd
7954 That query would then be sent only to the master server. If, on the other hand,
7955 the master is not to be used for reading, and so is not present in the global
7956 option, you can still update it by a query of this form:
7957 .code
7958 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7959 .endd
7960
7961
7962 .section "Special MySQL features" "SECID73"
7963 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7964 causes a connection to the server on the local host by means of a Unix domain
7965 socket. An alternate socket can be specified in parentheses.
7966 An option group name for MySQL option files can be specified in square brackets;
7967 the default value is &"exim"&.
7968 The full syntax of each item in &%mysql_servers%& is:
7969 .display
7970 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7971   <&'database'&>/<&'user'&>/<&'password'&>
7972 .endd
7973 Any of the four sub-parts of the first field can be omitted. For normal use on
7974 the local host it can be left blank or set to just &"localhost"&.
7975
7976 No database need be supplied &-- but if it is absent here, it must be given in
7977 the queries.
7978
7979 If a MySQL query is issued that does not request any data (an insert, update,
7980 or delete command), the result of the lookup is the number of rows affected.
7981
7982 &*Warning*&: This can be misleading. If an update does not actually change
7983 anything (for example, setting a field to the value it already has), the result
7984 is zero because no rows are affected.
7985
7986
7987 .section "Special PostgreSQL features" "SECID74"
7988 PostgreSQL lookups can also use Unix domain socket connections to the database.
7989 This is usually faster and costs less CPU time than a TCP/IP connection.
7990 However it can be used only if the mail server runs on the same machine as the
7991 database server. A configuration line for PostgreSQL via Unix domain sockets
7992 looks like this:
7993 .code
7994 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7995 .endd
7996 In other words, instead of supplying a host name, a path to the socket is
7997 given. The path name is enclosed in parentheses so that its slashes aren't
7998 visually confused with the delimiters for the other server parameters.
7999
8000 If a PostgreSQL query is issued that does not request any data (an insert,
8001 update, or delete command), the result of the lookup is the number of rows
8002 affected.
8003
8004 .section "More about SQLite" "SECTsqlite"
8005 .cindex "lookup" "SQLite"
8006 .cindex "sqlite lookup type"
8007 SQLite is different to the other SQL lookups because a filename is required in
8008 addition to the SQL query. An SQLite database is a single file, and there is no
8009 daemon as in the other SQL databases. The interface to Exim requires the name
8010 of the file, as an absolute path, to be given at the start of the query. It is
8011 separated from the query by white space. This means that the path name cannot
8012 contain white space. Here is a lookup expansion example:
8013 .code
8014 ${lookup sqlite {/some/thing/sqlitedb \
8015   select name from aliases where id='userx';}}
8016 .endd
8017 In a list, the syntax is similar. For example:
8018 .code
8019 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8020    select * from relays where ip='$sender_host_address';
8021 .endd
8022 The only character affected by the &%quote_sqlite%& operator is a single
8023 quote, which it doubles.
8024
8025 .cindex timeout SQLite
8026 .cindex sqlite "lookup timeout"
8027 The SQLite library handles multiple simultaneous accesses to the database
8028 internally. Multiple readers are permitted, but only one process can
8029 update at once. Attempts to access the database while it is being updated
8030 are rejected after a timeout period, during which the SQLite library
8031 waits for the lock to be released. In Exim, the default timeout is set
8032 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8033 option.
8034
8035 .section "More about Redis" "SECTredis"
8036 .cindex "lookup" "Redis"
8037 .cindex "redis lookup type"
8038 Redis is a non-SQL database. Commands are simple get and set.
8039 Examples:
8040 .code
8041 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8042 ${lookup redis{get keyname}}
8043 .endd
8044
8045 As of release 4.91, "lightweight" support for Redis Cluster is available.
8046 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8047 of which must be reachable from the running exim instance. If the cluster has
8048 master/slave replication, the list must contain all the master and slave
8049 servers.
8050
8051 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8052 immediately follow the redirection but treats the response as a DEFER, moving on
8053 to the next server in the &%redis_servers%& list until the correct server is
8054 reached.
8055
8056 .ecindex IIDfidalo1
8057 .ecindex IIDfidalo2
8058
8059
8060 . ////////////////////////////////////////////////////////////////////////////
8061 . ////////////////////////////////////////////////////////////////////////////
8062
8063 .chapter "Domain, host, address, and local part lists" &&&
8064          "CHAPdomhosaddlists" &&&
8065          "Domain, host, and address lists"
8066 .scindex IIDdohoadli "lists of domains; hosts; etc."
8067 A number of Exim configuration options contain lists of domains, hosts,
8068 email addresses, or local parts. For example, the &%hold_domains%& option
8069 contains a list of domains whose delivery is currently suspended. These lists
8070 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8071 arguments to expansion conditions such as &%match_domain%&.
8072
8073 Each item in one of these lists is a pattern to be matched against a domain,
8074 host, email address, or local part, respectively. In the sections below, the
8075 different types of pattern for each case are described, but first we cover some
8076 general facilities that apply to all four kinds of list.
8077
8078 Note that other parts of Exim use a &'string list'& which does not
8079 support all the complexity available in
8080 domain, host, address and local part lists.
8081
8082
8083
8084 .section "Expansion of lists" "SECTlistexpand"
8085 .cindex "expansion" "of lists"
8086 Each list is expanded as a single string before it is used.
8087
8088 &'Exception: the router headers_remove option, where list-item
8089 splitting is done before string-expansion.'&
8090
8091 The result of
8092 expansion must be a list, possibly containing empty items, which is split up
8093 into separate items for matching. By default, colon is the separator character,
8094 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8095 &<<SECTempitelis>>& for details of the list syntax; the second of these
8096 discusses the way to specify empty list items.
8097
8098
8099 If the string expansion is forced to fail, Exim behaves as if the item it is
8100 testing (domain, host, address, or local part) is not in the list. Other
8101 expansion failures cause temporary errors.
8102
8103 If an item in a list is a regular expression, backslashes, dollars and possibly
8104 other special characters in the expression must be protected against
8105 misinterpretation by the string expander. The easiest way to do this is to use
8106 the &`\N`& expansion feature to indicate that the contents of the regular
8107 expression should not be expanded. For example, in an ACL you might have:
8108 .code
8109 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8110                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8111 .endd
8112 The first item is a regular expression that is protected from expansion by
8113 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8114 senders based on the receiving domain.
8115
8116
8117
8118
8119 .section "Negated items in lists" "SECID76"
8120 .cindex "list" "negation"
8121 .cindex "negation" "in lists"
8122 Items in a list may be positive or negative. Negative items are indicated by a
8123 leading exclamation mark, which may be followed by optional white space. A list
8124 defines a set of items (domains, etc). When Exim processes one of these lists,
8125 it is trying to find out whether a domain, host, address, or local part
8126 (respectively) is in the set that is defined by the list. It works like this:
8127
8128 The list is scanned from left to right. If a positive item is matched, the
8129 subject that is being checked is in the set; if a negative item is matched, the
8130 subject is not in the set. If the end of the list is reached without the
8131 subject having matched any of the patterns, it is in the set if the last item
8132 was a negative one, but not if it was a positive one. For example, the list in
8133 .code
8134 domainlist relay_to_domains = !a.b.c : *.b.c
8135 .endd
8136 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8137 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8138 list is positive. However, if the setting were
8139 .code
8140 domainlist relay_to_domains = !a.b.c
8141 .endd
8142 then all domains other than &'a.b.c'& would match because the last item in the
8143 list is negative. In other words, a list that ends with a negative item behaves
8144 as if it had an extra item &`:*`& on the end.
8145
8146 Another way of thinking about positive and negative items in lists is to read
8147 the connector as &"or"& after a positive item and as &"and"& after a negative
8148 item.
8149
8150
8151
8152 .section "File names in lists" "SECTfilnamlis"
8153 .cindex "list" "filename in"
8154 If an item in a domain, host, address, or local part list is an absolute
8155 filename (beginning with a slash character), each line of the file is read and
8156 processed as if it were an independent item in the list, except that further
8157 filenames are not allowed,
8158 and no expansion of the data from the file takes place.
8159 Empty lines in the file are ignored, and the file may also contain comment
8160 lines:
8161
8162 .ilist
8163 For domain and host lists, if a # character appears anywhere in a line of the
8164 file, it and all following characters are ignored.
8165 .next
8166 Because local parts may legitimately contain # characters, a comment in an
8167 address list or local part list file is recognized only if # is preceded by
8168 white space or the start of the line. For example:
8169 .code
8170 not#comment@x.y.z   # but this is a comment
8171 .endd
8172 .endlist
8173
8174 Putting a filename in a list has the same effect as inserting each line of the
8175 file as an item in the list (blank lines and comments excepted). However, there
8176 is one important difference: the file is read each time the list is processed,
8177 so if its contents vary over time, Exim's behaviour changes.
8178
8179 If a filename is preceded by an exclamation mark, the sense of any match
8180 within the file is inverted. For example, if
8181 .code
8182 hold_domains = !/etc/nohold-domains
8183 .endd
8184 and the file contains the lines
8185 .code
8186 !a.b.c
8187 *.b.c
8188 .endd
8189 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8190 any domain matching &`*.b.c`& is not.
8191
8192
8193
8194 .section "An lsearch file is not an out-of-line list" "SECID77"
8195 As will be described in the sections that follow, lookups can be used in lists
8196 to provide indexed methods of checking list membership. There has been some
8197 confusion about the way &(lsearch)& lookups work in lists. Because
8198 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8199 sometimes thought that it is allowed to contain wild cards and other kinds of
8200 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8201 always fixed strings, just as for any other single-key lookup type.
8202
8203 If you want to use a file to contain wild-card patterns that form part of a
8204 list, just give the filename on its own, without a search type, as described
8205 in the previous section. You could also use the &(wildlsearch)& or
8206 &(nwildlsearch)&, but there is no advantage in doing this.
8207
8208
8209
8210
8211 .section "Named lists" "SECTnamedlists"
8212 .cindex "named lists"
8213 .cindex "list" "named"
8214 A list of domains, hosts, email addresses, or local parts can be given a name
8215 which is then used to refer to the list elsewhere in the configuration. This is
8216 particularly convenient if the same list is required in several different
8217 places. It also allows lists to be given meaningful names, which can improve
8218 the readability of the configuration. For example, it is conventional to define
8219 a domain list called &'local_domains'& for all the domains that are handled
8220 locally on a host, using a configuration line such as
8221 .code
8222 domainlist local_domains = localhost:my.dom.example
8223 .endd
8224 Named lists are referenced by giving their name preceded by a plus sign, so,
8225 for example, a router that is intended to handle local domains would be
8226 configured with the line
8227 .code
8228 domains = +local_domains
8229 .endd
8230 The first router in a configuration is often one that handles all domains
8231 except the local ones, using a configuration with a negated item like this:
8232 .code
8233 dnslookup:
8234   driver = dnslookup
8235   domains = ! +local_domains
8236   transport = remote_smtp
8237   no_more
8238 .endd
8239 The four kinds of named list are created by configuration lines starting with
8240 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8241 respectively. Then there follows the name that you are defining, followed by an
8242 equals sign and the list itself. For example:
8243 .code
8244 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8245 addresslist bad_senders = cdb;/etc/badsenders
8246 .endd
8247 A named list may refer to other named lists:
8248 .code
8249 domainlist  dom1 = first.example : second.example
8250 domainlist  dom2 = +dom1 : third.example
8251 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8252 .endd
8253 &*Warning*&: If the last item in a referenced list is a negative one, the
8254 effect may not be what you intended, because the negation does not propagate
8255 out to the higher level. For example, consider:
8256 .code
8257 domainlist  dom1 = !a.b
8258 domainlist  dom2 = +dom1 : *.b
8259 .endd
8260 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8261 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8262 means it matches the second list as well. The effect is not the same as
8263 .code
8264 domainlist  dom2 = !a.b : *.b
8265 .endd
8266 where &'x.y'& does not match. It's best to avoid negation altogether in
8267 referenced lists if you can.
8268
8269 Named lists may have a performance advantage. When Exim is routing an
8270 address or checking an incoming message, it caches the result of tests on named
8271 lists. So, if you have a setting such as
8272 .code
8273 domains = +local_domains
8274 .endd
8275 on several of your routers
8276 or in several ACL statements,
8277 the actual test is done only for the first one. However, the caching works only
8278 if there are no expansions within the list itself or any sublists that it
8279 references. In other words, caching happens only for lists that are known to be
8280 the same each time they are referenced.
8281
8282 By default, there may be up to 16 named lists of each type. This limit can be
8283 extended by changing a compile-time variable. The use of domain and host lists
8284 is recommended for concepts such as local domains, relay domains, and relay
8285 hosts. The default configuration is set up like this.
8286
8287
8288
8289 .section "Named lists compared with macros" "SECID78"
8290 .cindex "list" "named compared with macro"
8291 .cindex "macro" "compared with named list"
8292 At first sight, named lists might seem to be no different from macros in the
8293 configuration file. However, macros are just textual substitutions. If you
8294 write
8295 .code
8296 ALIST = host1 : host2
8297 auth_advertise_hosts = !ALIST
8298 .endd
8299 it probably won't do what you want, because that is exactly the same as
8300 .code
8301 auth_advertise_hosts = !host1 : host2
8302 .endd
8303 Notice that the second host name is not negated. However, if you use a host
8304 list, and write
8305 .code
8306 hostlist alist = host1 : host2
8307 auth_advertise_hosts = ! +alist
8308 .endd
8309 the negation applies to the whole list, and so that is equivalent to
8310 .code
8311 auth_advertise_hosts = !host1 : !host2
8312 .endd
8313
8314
8315 .section "Named list caching" "SECID79"
8316 .cindex "list" "caching of named"
8317 .cindex "caching" "named lists"
8318 While processing a message, Exim caches the result of checking a named list if
8319 it is sure that the list is the same each time. In practice, this means that
8320 the cache operates only if the list contains no $ characters, which guarantees
8321 that it will not change when it is expanded. Sometimes, however, you may have
8322 an expanded list that you know will be the same each time within a given
8323 message. For example:
8324 .code
8325 domainlist special_domains = \
8326            ${lookup{$sender_host_address}cdb{/some/file}}
8327 .endd
8328 This provides a list of domains that depends only on the sending host's IP
8329 address. If this domain list is referenced a number of times (for example,
8330 in several ACL lines, or in several routers) the result of the check is not
8331 cached by default, because Exim does not know that it is going to be the
8332 same list each time.
8333
8334 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8335 cache the result anyway. For example:
8336 .code
8337 domainlist_cache special_domains = ${lookup{...
8338 .endd
8339 If you do this, you should be absolutely sure that caching is going to do
8340 the right thing in all cases. When in doubt, leave it out.
8341
8342
8343
8344 .section "Domain lists" "SECTdomainlist"
8345 .cindex "domain list" "patterns for"
8346 .cindex "list" "domain list"
8347 Domain lists contain patterns that are to be matched against a mail domain.
8348 The following types of item may appear in domain lists:
8349
8350 .ilist
8351 .cindex "primary host name"
8352 .cindex "host name" "matched in domain list"
8353 .oindex "&%primary_hostname%&"
8354 .cindex "domain list" "matching primary host name"
8355 .cindex "@ in a domain list"
8356 If a pattern consists of a single @ character, it matches the local host name,
8357 as set by the &%primary_hostname%& option (or defaulted). This makes it
8358 possible to use the same configuration file on several different hosts that
8359 differ only in their names.
8360 .next
8361 .cindex "@[] in a domain list"
8362 .cindex "domain list" "matching local IP interfaces"
8363 .cindex "domain literal"
8364 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8365 in square brackets (as in an email address that contains a domain literal), but
8366 only if that IP address is recognized as local for email routing purposes. The
8367 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8368 control which of a host's several IP addresses are treated as local.
8369 In today's Internet, the use of domain literals is controversial.
8370 .next
8371 .cindex "@mx_any"
8372 .cindex "@mx_primary"
8373 .cindex "@mx_secondary"
8374 .cindex "domain list" "matching MX pointers to local host"
8375 If a pattern consists of the string &`@mx_any`& it matches any domain that
8376 has an MX record pointing to the local host or to any host that is listed in
8377 .oindex "&%hosts_treat_as_local%&"
8378 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8379 are similar, except that the first matches only when a primary MX target is the
8380 local host, and the second only when no primary MX target is the local host,
8381 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8382 preference value &-- there may of course be more than one of them.
8383
8384 The MX lookup that takes place when matching a pattern of this type is
8385 performed with the resolver options for widening names turned off. Thus, for
8386 example, a single-component domain will &'not'& be expanded by adding the
8387 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8388 options of the &(dnslookup)& router for a discussion of domain widening.
8389
8390 Sometimes you may want to ignore certain IP addresses when using one of these
8391 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8392 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8393 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8394 on a router). For example:
8395 .code
8396 domains = @mx_any/ignore=127.0.0.1
8397 .endd
8398 This example matches any domain that has an MX record pointing to one of
8399 the local host's IP addresses other than 127.0.0.1.
8400
8401 The list of IP addresses is in fact processed by the same code that processes
8402 host lists, so it may contain CIDR-coded network specifications and it may also
8403 contain negative items.
8404
8405 Because the list of IP addresses is a sublist within a domain list, you have to
8406 be careful about delimiters if there is more than one address. Like any other
8407 list, the default delimiter can be changed. Thus, you might have:
8408 .code
8409 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8410           an.other.domain : ...
8411 .endd
8412 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8413 involved, it is easiest to change the delimiter for the main list as well:
8414 .code
8415 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8416           an.other.domain ? ...
8417 .endd
8418 .next
8419 .cindex "asterisk" "in domain list"
8420 .cindex "domain list" "asterisk in"
8421 .cindex "domain list" "matching &""ends with""&"
8422 If a pattern starts with an asterisk, the remaining characters of the pattern
8423 are compared with the terminating characters of the domain. The use of &"*"& in
8424 domain lists differs from its use in partial matching lookups. In a domain
8425 list, the character following the asterisk need not be a dot, whereas partial
8426 matching works only in terms of dot-separated components. For example, a domain
8427 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8428 &'cipher.key.ex'&.
8429
8430 .next
8431 .cindex "regular expressions" "in domain list"
8432 .cindex "domain list" "matching regular expression"
8433 If a pattern starts with a circumflex character, it is treated as a regular
8434 expression, and matched against the domain using a regular expression matching
8435 function. The circumflex is treated as part of the regular expression.
8436 Email domains are case-independent, so this regular expression match is by
8437 default case-independent, but you can make it case-dependent by starting it
8438 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8439 are given in chapter &<<CHAPregexp>>&.
8440
8441 &*Warning*&: Because domain lists are expanded before being processed, you
8442 must escape any backslash and dollar characters in the regular expression, or
8443 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8444 it is not to be expanded (unless you really do want to build a regular
8445 expression by expansion, of course).
8446 .next
8447 .cindex "lookup" "in domain list"
8448 .cindex "domain list" "matching by lookup"
8449 If a pattern starts with the name of a single-key lookup type followed by a
8450 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8451 must be a filename in a suitable format for the lookup type. For example, for
8452 &"cdb;"& it must be an absolute path:
8453 .code
8454 domains = cdb;/etc/mail/local_domains.cdb
8455 .endd
8456 The appropriate type of lookup is done on the file using the domain name as the
8457 key. In most cases, the data that is looked up is not used; Exim is interested
8458 only in whether or not the key is present in the file. However, when a lookup
8459 is used for the &%domains%& option on a router
8460 or a &%domains%& condition in an ACL statement, the data is preserved in the
8461 &$domain_data$& variable and can be referred to in other router options or
8462 other statements in the same ACL.
8463
8464 .next
8465 Any of the single-key lookup type names may be preceded by
8466 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8467 .code
8468 domains = partial-dbm;/partial/domains
8469 .endd
8470 This causes partial matching logic to be invoked; a description of how this
8471 works is given in section &<<SECTpartiallookup>>&.
8472
8473 .next
8474 .cindex "asterisk" "in lookup type"
8475 Any of the single-key lookup types may be followed by an asterisk. This causes
8476 a default lookup for a key consisting of a single asterisk to be done if the
8477 original lookup fails. This is not a useful feature when using a domain list to
8478 select particular domains (because any domain would match), but it might have
8479 value if the result of the lookup is being used via the &$domain_data$&
8480 expansion variable.
8481 .next
8482 If the pattern starts with the name of a query-style lookup type followed by a
8483 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8484 pattern must be an appropriate query for the lookup type, as described in
8485 chapter &<<CHAPfdlookup>>&. For example:
8486 .code
8487 hold_domains = mysql;select domain from holdlist \
8488   where domain = '${quote_mysql:$domain}';
8489 .endd
8490 In most cases, the data that is looked up is not used (so for an SQL query, for
8491 example, it doesn't matter what field you select). Exim is interested only in
8492 whether or not the query succeeds. However, when a lookup is used for the
8493 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8494 variable and can be referred to in other options.
8495 .next
8496 .cindex "domain list" "matching literal domain name"
8497 If none of the above cases apply, a caseless textual comparison is made
8498 between the pattern and the domain.
8499 .endlist
8500
8501 Here is an example that uses several different kinds of pattern:
8502 .code
8503 domainlist funny_domains = \
8504   @ : \
8505   lib.unseen.edu : \
8506   *.foundation.fict.example : \
8507   \N^[1-2]\d{3}\.fict\.example$\N : \
8508   partial-dbm;/opt/data/penguin/book : \
8509   nis;domains.byname : \
8510   nisplus;[name=$domain,status=local],domains.org_dir
8511 .endd
8512 There are obvious processing trade-offs among the various matching modes. Using
8513 an asterisk is faster than a regular expression, and listing a few names
8514 explicitly probably is too. The use of a file or database lookup is expensive,
8515 but may be the only option if hundreds of names are required. Because the
8516 patterns are tested in order, it makes sense to put the most commonly matched
8517 patterns earlier.
8518
8519
8520
8521 .section "Host lists" "SECThostlist"
8522 .cindex "host list" "patterns in"
8523 .cindex "list" "host list"
8524 Host lists are used to control what remote hosts are allowed to do. For
8525 example, some hosts may be allowed to use the local host as a relay, and some
8526 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8527 two different ways, by name or by IP address. In a host list, some types of
8528 pattern are matched to a host name, and some are matched to an IP address.
8529 You need to be particularly careful with this when single-key lookups are
8530 involved, to ensure that the right value is being used as the key.
8531
8532
8533 .section "Special host list patterns" "SECID80"
8534 .cindex "empty item in hosts list"
8535 .cindex "host list" "empty string in"
8536 If a host list item is the empty string, it matches only when no remote host is
8537 involved. This is the case when a message is being received from a local
8538 process using SMTP on the standard input, that is, when a TCP/IP connection is
8539 not used.
8540
8541 .cindex "asterisk" "in host list"
8542 The special pattern &"*"& in a host list matches any host or no host. Neither
8543 the IP address nor the name is actually inspected.
8544
8545
8546
8547 .section "Host list patterns that match by IP address" "SECThoslispatip"
8548 .cindex "host list" "matching IP addresses"
8549 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8550 the incoming address actually appears in the IPv6 host as
8551 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8552 list, it is converted into a traditional IPv4 address first. (Not all operating
8553 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8554 concerns.)
8555
8556 The following types of pattern in a host list check the remote host by
8557 inspecting its IP address:
8558
8559 .ilist
8560 If the pattern is a plain domain name (not a regular expression, not starting
8561 with *, not a lookup of any kind), Exim calls the operating system function
8562 to find the associated IP address(es). Exim uses the newer
8563 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8564 This typically causes a forward DNS lookup of the name. The result is compared
8565 with the IP address of the subject host.
8566
8567 If there is a temporary problem (such as a DNS timeout) with the host name
8568 lookup, a temporary error occurs. For example, if the list is being used in an
8569 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8570 temporary SMTP error code. If no IP address can be found for the host name,
8571 what happens is described in section &<<SECTbehipnot>>& below.
8572
8573 .next
8574 .cindex "@ in a host list"
8575 If the pattern is &"@"&, the primary host name is substituted and used as a
8576 domain name, as just described.
8577
8578 .next
8579 If the pattern is an IP address, it is matched against the IP address of the
8580 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8581 IPv6 addresses can be given in colon-separated format, but the colons have to
8582 be doubled so as not to be taken as item separators when the default list
8583 separator is used. IPv6 addresses are recognized even when Exim is compiled
8584 without IPv6 support. This means that if they appear in a host list on an
8585 IPv4-only host, Exim will not treat them as host names. They are just addresses
8586 that can never match a client host.
8587
8588 .next
8589 .cindex "@[] in a host list"
8590 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8591 the local host. For example, if the local host is an IPv4 host with one
8592 interface address 10.45.23.56, these two ACL statements have the same effect:
8593 .code
8594 accept hosts = 127.0.0.1 : 10.45.23.56
8595 accept hosts = @[]
8596 .endd
8597 .next
8598 .cindex "CIDR notation"
8599 If the pattern is an IP address followed by a slash and a mask length (for
8600 example 10.11.42.0/24), it is matched against the IP address of the subject
8601 host under the given mask. This allows, an entire network of hosts to be
8602 included (or excluded) by a single item. The mask uses CIDR notation; it
8603 specifies the number of address bits that must match, starting from the most
8604 significant end of the address.
8605
8606 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8607 of a range of addresses. It is the number of bits in the network portion of the
8608 address. The above example specifies a 24-bit netmask, so it matches all 256
8609 addresses in the 10.11.42.0 network. An item such as
8610 .code
8611 192.168.23.236/31
8612 .endd
8613 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8614 32 for an IPv4 address is the same as no mask at all; just a single address
8615 matches.
8616
8617 Here is another example which shows an IPv4 and an IPv6 network:
8618 .code
8619 recipient_unqualified_hosts = 192.168.0.0/16: \
8620                               3ffe::ffff::836f::::/48
8621 .endd
8622 The doubling of list separator characters applies only when these items
8623 appear inline in a host list. It is not required when indirecting via a file.
8624 For example:
8625 .code
8626 recipient_unqualified_hosts = /opt/exim/unqualnets
8627 .endd
8628 could make use of a file containing
8629 .code
8630 172.16.0.0/12
8631 3ffe:ffff:836f::/48
8632 .endd
8633 to have exactly the same effect as the previous example. When listing IPv6
8634 addresses inline, it is usually more convenient to use the facility for
8635 changing separator characters. This list contains the same two networks:
8636 .code
8637 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8638                                  3ffe:ffff:836f::/48
8639 .endd
8640 The separator is changed to semicolon by the leading &"<;"& at the start of the
8641 list.
8642 .endlist
8643
8644
8645
8646 .section "Host list patterns for single-key lookups by host address" &&&
8647          "SECThoslispatsikey"
8648 .cindex "host list" "lookup of IP address"
8649 When a host is to be identified by a single-key lookup of its complete IP
8650 address, the pattern takes this form:
8651 .display
8652 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8653 .endd
8654 For example:
8655 .code
8656 hosts_lookup = net-cdb;/hosts-by-ip.db
8657 .endd
8658 The text form of the IP address of the subject host is used as the lookup key.
8659 IPv6 addresses are converted to an unabbreviated form, using lower case
8660 letters, with dots as separators because colon is the key terminator in
8661 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8662 quoting the keys, but this is a facility that was added later.] The data
8663 returned by the lookup is not used.
8664
8665 .cindex "IP address" "masking"
8666 .cindex "host list" "masked IP address"
8667 Single-key lookups can also be performed using masked IP addresses, using
8668 patterns of this form:
8669 .display
8670 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8671 .endd
8672 For example:
8673 .code
8674 net24-dbm;/networks.db
8675 .endd
8676 The IP address of the subject host is masked using <&'number'&> as the mask
8677 length. A textual string is constructed from the masked value, followed by the
8678 mask, and this is used as the lookup key. For example, if the host's IP address
8679 is 192.168.34.6, the key that is looked up for the above example is
8680 &"192.168.34.0/24"&.
8681
8682 When an IPv6 address is converted to a string, dots are normally used instead
8683 of colons, so that keys in &(lsearch)& files need not contain colons (which
8684 terminate &(lsearch)& keys). This was implemented some time before the ability
8685 to quote keys was made available in &(lsearch)& files. However, the more
8686 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8687 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8688 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8689 converted using colons and not dots.
8690 .new
8691 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8692 addresses are always used.
8693 The latter are converted to IPv4 addresses, in dotted-quad form.
8694 .wen
8695
8696 Ideally, it would be nice to tidy up this anomalous situation by changing to
8697 colons in all cases, given that quoting is now available for &(lsearch)&.
8698 However, this would be an incompatible change that might break some existing
8699 configurations.
8700
8701 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8702 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8703 the former case the key strings include the mask value, whereas in the latter
8704 case the IP address is used on its own.
8705
8706
8707
8708 .section "Host list patterns that match by host name" "SECThoslispatnam"
8709 .cindex "host" "lookup failures"
8710 .cindex "unknown host name"
8711 .cindex "host list" "matching host name"
8712 There are several types of pattern that require Exim to know the name of the
8713 remote host. These are either wildcard patterns or lookups by name. (If a
8714 complete hostname is given without any wildcarding, it is used to find an IP
8715 address to match against, as described in section &<<SECThoslispatip>>&
8716 above.)
8717
8718 If the remote host name is not already known when Exim encounters one of these
8719 patterns, it has to be found from the IP address.
8720 Although many sites on the Internet are conscientious about maintaining reverse
8721 DNS data for their hosts, there are also many that do not do this.
8722 Consequently, a name cannot always be found, and this may lead to unwanted
8723 effects. Take care when configuring host lists with wildcarded name patterns.
8724 Consider what will happen if a name cannot be found.
8725
8726 Because of the problems of determining host names from IP addresses, matching
8727 against host names is not as common as matching against IP addresses.
8728
8729 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8730 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8731 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8732 are done can be changed by setting the &%host_lookup_order%& option. For
8733 security, once Exim has found one or more names, it looks up the IP addresses
8734 for these names and compares them with the IP address that it started with.
8735 Only those names whose IP addresses match are accepted. Any other names are
8736 discarded. If no names are left, Exim behaves as if the host name cannot be
8737 found. In the most common case there is only one name and one IP address.
8738
8739 There are some options that control what happens if a host name cannot be
8740 found. These are described in section &<<SECTbehipnot>>& below.
8741
8742 .cindex "host" "alias for"
8743 .cindex "alias for host"
8744 As a result of aliasing, hosts may have more than one name. When processing any
8745 of the following types of pattern, all the host's names are checked:
8746
8747 .ilist
8748 .cindex "asterisk" "in host list"
8749 If a pattern starts with &"*"& the remainder of the item must match the end of
8750 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8751 &'.b.c'&. This special simple form is provided because this is a very common
8752 requirement. Other kinds of wildcarding require the use of a regular
8753 expression.
8754 .next
8755 .cindex "regular expressions" "in host list"
8756 .cindex "host list" "regular expression in"
8757 If the item starts with &"^"& it is taken to be a regular expression which is
8758 matched against the host name. Host names are case-independent, so this regular
8759 expression match is by default case-independent, but you can make it
8760 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8761 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8762 example,
8763 .code
8764 ^(a|b)\.c\.d$
8765 .endd
8766 is a regular expression that matches either of the two hosts &'a.c.d'& or
8767 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8768 that backslash and dollar characters are not misinterpreted as part of the
8769 string expansion. The simplest way to do this is to use &`\N`& to mark that
8770 part of the string as non-expandable. For example:
8771 .code
8772 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8773 .endd
8774 &*Warning*&: If you want to match a complete host name, you must include the
8775 &`$`& terminating metacharacter in the regular expression, as in the above
8776 example. Without it, a match at the start of the host name is all that is
8777 required.
8778 .endlist
8779
8780
8781
8782
8783 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8784 .cindex "host" "lookup failures, permanent"
8785 While processing a host list, Exim may need to look up an IP address from a
8786 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8787 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8788 behaviour when it fails to find the information it is seeking is the same.
8789
8790 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8791 apply to temporary DNS errors, whose handling is described in the next section.
8792
8793 .cindex "&`+include_unknown`&"
8794 .cindex "&`+ignore_unknown`&"
8795 Exim parses a host list from left to right. If it encounters a permanent
8796 lookup failure in any item in the host list before it has found a match,
8797 Exim treats it as a failure and the default behavior is as if the host
8798 does not match the list. This may not always be what you want to happen.
8799 To change Exim's behaviour, the special items &`+include_unknown`& or
8800 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8801 not recognized in an indirected file).
8802
8803 .ilist
8804 If any item that follows &`+include_unknown`& requires information that
8805 cannot found, Exim behaves as if the host does match the list. For example,
8806 .code
8807 host_reject_connection = +include_unknown:*.enemy.ex
8808 .endd
8809 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8810 any hosts whose name it cannot find.
8811
8812 .next
8813 If any item that follows &`+ignore_unknown`& requires information that cannot
8814 be found, Exim ignores that item and proceeds to the rest of the list. For
8815 example:
8816 .code
8817 accept hosts = +ignore_unknown : friend.example : \
8818                192.168.4.5
8819 .endd
8820 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8821 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8822 name can be found for 192.168.4.5, it is rejected.
8823 .endlist
8824
8825 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8826 list. The effect of each one lasts until the next, or until the end of the
8827 list.
8828
8829 .section "Mixing wildcarded host names and addresses in host lists" &&&
8830          "SECTmixwilhos"
8831 .cindex "host list" "mixing names and addresses in"
8832
8833 This section explains the host/ip processing logic with the same concepts
8834 as the previous section, but specifically addresses what happens when a
8835 wildcarded hostname is one of the items in the hostlist.
8836
8837 .ilist
8838 If you have name lookups or wildcarded host names and
8839 IP addresses in the same host list, you should normally put the IP
8840 addresses first. For example, in an ACL you could have:
8841 .code
8842 accept hosts = 10.9.8.7 : *.friend.example
8843 .endd
8844 The reason you normally would order it this way lies in the
8845 left-to-right way that Exim processes lists.  It can test IP addresses
8846 without doing any DNS lookups, but when it reaches an item that requires
8847 a host name, it fails if it cannot find a host name to compare with the
8848 pattern. If the above list is given in the opposite order, the
8849 &%accept%& statement fails for a host whose name cannot be found, even
8850 if its IP address is 10.9.8.7.
8851
8852 .next
8853 If you really do want to do the name check first, and still recognize the IP
8854 address, you can rewrite the ACL like this:
8855 .code
8856 accept hosts = *.friend.example
8857 accept hosts = 10.9.8.7
8858 .endd
8859 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8860 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8861 &`+ignore_unknown`&, which was discussed in depth in the first example in
8862 this section.
8863 .endlist
8864
8865
8866 .section "Temporary DNS errors when looking up host information" &&&
8867          "SECTtemdnserr"
8868 .cindex "host" "lookup failures, temporary"
8869 .cindex "&`+include_defer`&"
8870 .cindex "&`+ignore_defer`&"
8871 A temporary DNS lookup failure normally causes a defer action (except when
8872 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8873 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8874 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8875 section. These options should be used with care, probably only in non-critical
8876 host lists such as whitelists.
8877
8878
8879
8880 .section "Host list patterns for single-key lookups by host name" &&&
8881          "SECThoslispatnamsk"
8882 .cindex "unknown host name"
8883 .cindex "host list" "matching host name"
8884 If a pattern is of the form
8885 .display
8886 <&'single-key-search-type'&>;<&'search-data'&>
8887 .endd
8888 for example
8889 .code
8890 dbm;/host/accept/list
8891 .endd
8892 a single-key lookup is performed, using the host name as its key. If the
8893 lookup succeeds, the host matches the item. The actual data that is looked up
8894 is not used.
8895
8896 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8897 keys in the file, not IP addresses. If you want to do lookups based on IP
8898 addresses, you must precede the search type with &"net-"& (see section
8899 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8900 two items in the same list, one doing an address lookup and one doing a name
8901 lookup, both using the same file.
8902
8903
8904
8905 .section "Host list patterns for query-style lookups" "SECID81"
8906 If a pattern is of the form
8907 .display
8908 <&'query-style-search-type'&>;<&'query'&>
8909 .endd
8910 the query is obeyed, and if it succeeds, the host matches the item. The actual
8911 data that is looked up is not used. The variables &$sender_host_address$& and
8912 &$sender_host_name$& can be used in the query. For example:
8913 .code
8914 hosts_lookup = pgsql;\
8915   select ip from hostlist where ip='$sender_host_address'
8916 .endd
8917 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8918 can use the &%sg%& expansion item to change this if you need to. If you want to
8919 use masked IP addresses in database queries, you can use the &%mask%& expansion
8920 operator.
8921
8922 If the query contains a reference to &$sender_host_name$&, Exim automatically
8923 looks up the host name if it has not already done so. (See section
8924 &<<SECThoslispatnam>>& for comments on finding host names.)
8925
8926 Historical note: prior to release 4.30, Exim would always attempt to find a
8927 host name before running the query, unless the search type was preceded by
8928 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8929 still recognized for query-style lookups, but its presence or absence has no
8930 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8931 See section &<<SECThoslispatsikey>>&.)
8932
8933
8934
8935
8936
8937 .section "Address lists" "SECTaddresslist"
8938 .cindex "list" "address list"
8939 .cindex "address list" "empty item"
8940 .cindex "address list" "patterns"
8941 Address lists contain patterns that are matched against mail addresses. There
8942 is one special case to be considered: the sender address of a bounce message is
8943 always empty. You can test for this by providing an empty item in an address
8944 list. For example, you can set up a router to process bounce messages by
8945 using this option setting:
8946 .code
8947 senders = :
8948 .endd
8949 The presence of the colon creates an empty item. If you do not provide any
8950 data, the list is empty and matches nothing. The empty sender can also be
8951 detected by a regular expression that matches an empty string,
8952 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8953
8954 Non-empty items in an address list can be straightforward email addresses. For
8955 example:
8956 .code
8957 senders = jbc@askone.example : hs@anacreon.example
8958 .endd
8959 A certain amount of wildcarding is permitted. If a pattern contains an @
8960 character, but is not a regular expression and does not begin with a
8961 semicolon-terminated lookup type (described below), the local part of the
8962 subject address is compared with the local part of the pattern, which may start
8963 with an asterisk. If the local parts match, the domain is checked in exactly
8964 the same way as for a pattern in a domain list. For example, the domain can be
8965 wildcarded, refer to a named list, or be a lookup:
8966 .code
8967 deny senders = *@*.spamming.site:\
8968                *@+hostile_domains:\
8969                bozo@partial-lsearch;/list/of/dodgy/sites:\
8970                *@dbm;/bad/domains.db
8971 .endd
8972 .cindex "local part" "starting with !"
8973 .cindex "address list" "local part starting with !"
8974 If a local part that begins with an exclamation mark is required, it has to be
8975 specified using a regular expression, because otherwise the exclamation mark is
8976 treated as a sign of negation, as is standard in lists.
8977
8978 If a non-empty pattern that is not a regular expression or a lookup does not
8979 contain an @ character, it is matched against the domain part of the subject
8980 address. The only two formats that are recognized this way are a literal
8981 domain, or a domain pattern that starts with *. In both these cases, the effect
8982 is the same as if &`*@`& preceded the pattern. For example:
8983 .code
8984 deny senders = enemy.domain : *.enemy.domain
8985 .endd
8986
8987 The following kinds of more complicated address list pattern can match any
8988 address, including the empty address that is characteristic of bounce message
8989 senders:
8990
8991 .ilist
8992 .cindex "regular expressions" "in address list"
8993 .cindex "address list" "regular expression in"
8994 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8995 done against the complete address, with the pattern as the regular expression.
8996 You must take care that backslash and dollar characters are not misinterpreted
8997 as part of the string expansion. The simplest way to do this is to use &`\N`&
8998 to mark that part of the string as non-expandable. For example:
8999 .code
9000 deny senders = \N^.*this.*@example\.com$\N : \
9001                \N^\d{8}.+@spamhaus.example$\N : ...
9002 .endd
9003 The &`\N`& sequences are removed by the expansion, so these items do indeed
9004 start with &"^"& by the time they are being interpreted as address patterns.
9005
9006 .next
9007 .cindex "address list" "lookup for complete address"
9008 Complete addresses can be looked up by using a pattern that starts with a
9009 lookup type terminated by a semicolon, followed by the data for the lookup. For
9010 example:
9011 .code
9012 deny senders = cdb;/etc/blocked.senders : \
9013   mysql;select address from blocked where \
9014   address='${quote_mysql:$sender_address}'
9015 .endd
9016 Both query-style and single-key lookup types can be used. For a single-key
9017 lookup type, Exim uses the complete address as the key. However, empty keys are
9018 not supported for single-key lookups, so a match against the empty address
9019 always fails. This restriction does not apply to query-style lookups.
9020
9021 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9022 cannot be used, and is ignored if specified, with an entry being written to the
9023 panic log.
9024 .cindex "*@ with single-key lookup"
9025 However, you can configure lookup defaults, as described in section
9026 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9027 default. For example, with this lookup:
9028 .code
9029 accept senders = lsearch*@;/some/file
9030 .endd
9031 the file could contains lines like this:
9032 .code
9033 user1@domain1.example
9034 *@domain2.example
9035 .endd
9036 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9037 that are tried is:
9038 .code
9039 nimrod@jaeger.example
9040 *@jaeger.example
9041 *
9042 .endd
9043 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9044 would mean that every address matches, thus rendering the test useless.
9045
9046 &*Warning 2*&: Do not confuse these two kinds of item:
9047 .code
9048 deny recipients = dbm*@;/some/file
9049 deny recipients = *@dbm;/some/file
9050 .endd
9051 The first does a whole address lookup, with defaulting, as just described,
9052 because it starts with a lookup type. The second matches the local part and
9053 domain independently, as described in a bullet point below.
9054 .endlist
9055
9056
9057 The following kinds of address list pattern can match only non-empty addresses.
9058 If the subject address is empty, a match against any of these pattern types
9059 always fails.
9060
9061
9062 .ilist
9063 .cindex "@@ with single-key lookup"
9064 .cindex "address list" "@@ lookup type"
9065 .cindex "address list" "split local part and domain"
9066 If a pattern starts with &"@@"& followed by a single-key lookup item
9067 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9068 split into a local part and a domain. The domain is looked up in the file. If
9069 it is not found, there is no match. If it is found, the data that is looked up
9070 from the file is treated as a colon-separated list of local part patterns, each
9071 of which is matched against the subject local part in turn.
9072
9073 .cindex "asterisk" "in address list"
9074 The lookup may be a partial one, and/or one involving a search for a default
9075 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9076 patterns that are looked up can be regular expressions or begin with &"*"&, or
9077 even be further lookups. They may also be independently negated. For example,
9078 with
9079 .code
9080 deny senders = @@dbm;/etc/reject-by-domain
9081 .endd
9082 the data from which the DBM file is built could contain lines like
9083 .code
9084 baddomain.com:  !postmaster : *
9085 .endd
9086 to reject all senders except &%postmaster%& from that domain.
9087
9088 .cindex "local part" "starting with !"
9089 If a local part that actually begins with an exclamation mark is required, it
9090 has to be specified using a regular expression. In &(lsearch)& files, an entry
9091 may be split over several lines by indenting the second and subsequent lines,
9092 but the separating colon must still be included at line breaks. White space
9093 surrounding the colons is ignored. For example:
9094 .code
9095 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9096   spammer3 : spammer4
9097 .endd
9098 As in all colon-separated lists in Exim, a colon can be included in an item by
9099 doubling.
9100
9101 If the last item in the list starts with a right angle-bracket, the remainder
9102 of the item is taken as a new key to look up in order to obtain a continuation
9103 list of local parts. The new key can be any sequence of characters. Thus one
9104 might have entries like
9105 .code
9106 aol.com: spammer1 : spammer 2 : >*
9107 xyz.com: spammer3 : >*
9108 *:       ^\d{8}$
9109 .endd
9110 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9111 local parts for all domains, in addition to the specific local parts listed for
9112 each domain. Of course, using this feature costs another lookup each time a
9113 chain is followed, but the effort needed to maintain the data is reduced.
9114
9115 .cindex "loop" "in lookups"
9116 It is possible to construct loops using this facility, and in order to catch
9117 them, the chains may be no more than fifty items long.
9118
9119 .next
9120 The @@<&'lookup'&> style of item can also be used with a query-style
9121 lookup, but in this case, the chaining facility is not available. The lookup
9122 can only return a single list of local parts.
9123 .endlist
9124
9125 &*Warning*&: There is an important difference between the address list items
9126 in these two examples:
9127 .code
9128 senders = +my_list
9129 senders = *@+my_list
9130 .endd
9131 In the first one, &`my_list`& is a named address list, whereas in the second
9132 example it is a named domain list.
9133
9134
9135
9136
9137 .section "Case of letters in address lists" "SECTcasletadd"
9138 .cindex "case of local parts"
9139 .cindex "address list" "case forcing"
9140 .cindex "case forcing in address lists"
9141 Domains in email addresses are always handled caselessly, but for local parts
9142 case may be significant on some systems (see &%caseful_local_part%& for how
9143 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9144 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9145 blocking lists should be done in a case-independent manner. Since most address
9146 lists in Exim are used for this kind of control, Exim attempts to do this by
9147 default.
9148
9149 The domain portion of an address is always lowercased before matching it to an
9150 address list. The local part is lowercased by default, and any string
9151 comparisons that take place are done caselessly. This means that the data in
9152 the address list itself, in files included as plain filenames, and in any file
9153 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9154 keys in files that are looked up by a search type other than &(lsearch)& (which
9155 works caselessly) must be in lower case, because these lookups are not
9156 case-independent.
9157
9158 .cindex "&`+caseful`&"
9159 To allow for the possibility of caseful address list matching, if an item in
9160 an address list is the string &"+caseful"&, the original case of the local
9161 part is restored for any comparisons that follow, and string comparisons are no
9162 longer case-independent. This does not affect the domain, which remains in
9163 lower case. However, although independent matches on the domain alone are still
9164 performed caselessly, regular expressions that match against an entire address
9165 become case-sensitive after &"+caseful"& has been seen.
9166
9167
9168
9169 .section "Local part lists" "SECTlocparlis"
9170 .cindex "list" "local part list"
9171 .cindex "local part" "list"
9172 Case-sensitivity in local part lists is handled in the same way as for address
9173 lists, as just described. The &"+caseful"& item can be used if required. In a
9174 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9175 set false, the subject is lowercased and the matching is initially
9176 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9177 matching in the local part list, but not elsewhere in the router. If
9178 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9179 option is case-sensitive from the start.
9180
9181 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9182 comments are handled in the same way as address lists &-- they are recognized
9183 only if the # is preceded by white space or the start of the line.
9184 Otherwise, local part lists are matched in the same way as domain lists, except
9185 that the special items that refer to the local host (&`@`&, &`@[]`&,
9186 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9187 Refer to section &<<SECTdomainlist>>& for details of the other available item
9188 types.
9189 .ecindex IIDdohoadli
9190
9191
9192
9193
9194 . ////////////////////////////////////////////////////////////////////////////
9195 . ////////////////////////////////////////////////////////////////////////////
9196
9197 .chapter "String expansions" "CHAPexpand"
9198 .scindex IIDstrexp "expansion" "of strings"
9199 Many strings in Exim's runtime configuration are expanded before use. Some of
9200 them are expanded every time they are used; others are expanded only once.
9201
9202 When a string is being expanded it is copied verbatim from left to right except
9203 .cindex expansion "string concatenation"
9204 when a dollar or backslash character is encountered. A dollar specifies the
9205 start of a portion of the string that is interpreted and replaced as described
9206 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9207 escape character, as described in the following section.
9208
9209 Whether a string is expanded depends upon the context.  Usually this is solely
9210 dependent upon the option for which a value is sought; in this documentation,
9211 options for which string expansion is performed are marked with &dagger; after
9212 the data type.  ACL rules always expand strings.  A couple of expansion
9213 conditions do not expand some of the brace-delimited branches, for security
9214 reasons.
9215
9216
9217
9218 .section "Literal text in expanded strings" "SECTlittext"
9219 .cindex "expansion" "including literal text"
9220 An uninterpreted dollar can be included in an expanded string by putting a
9221 backslash in front of it. A backslash can be used to prevent any special
9222 character being treated specially in an expansion, including backslash itself.
9223 If the string appears in quotes in the configuration file, two backslashes are
9224 required because the quotes themselves cause interpretation of backslashes when
9225 the string is read in (see section &<<SECTstrings>>&).
9226
9227 .cindex "expansion" "non-expandable substrings"
9228 A portion of the string can specified as non-expandable by placing it between
9229 two occurrences of &`\N`&. This is particularly useful for protecting regular
9230 expressions, which often contain backslashes and dollar signs. For example:
9231 .code
9232 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9233 .endd
9234 On encountering the first &`\N`&, the expander copies subsequent characters
9235 without interpretation until it reaches the next &`\N`& or the end of the
9236 string.
9237
9238
9239
9240 .section "Character escape sequences in expanded strings" "SECID82"
9241 .cindex "expansion" "escape sequences"
9242 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9243 expanded string is recognized as an escape sequence for the character newline,
9244 carriage return, or tab, respectively. A backslash followed by up to three
9245 octal digits is recognized as an octal encoding for a single character, and a
9246 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9247 encoding.
9248
9249 These escape sequences are also recognized in quoted strings when they are read
9250 in. Their interpretation in expansions as well is useful for unquoted strings,
9251 and for other cases such as looked-up strings that are then expanded.
9252
9253
9254 .section "Testing string expansions" "SECID83"
9255 .cindex "expansion" "testing"
9256 .cindex "testing" "string expansion"
9257 .oindex "&%-be%&"
9258 Many expansions can be tested by calling Exim with the &%-be%& option. This
9259 takes the command arguments, or lines from the standard input if there are no
9260 arguments, runs them through the string expansion code, and writes the results
9261 to the standard output. Variables based on configuration values are set up, but
9262 since no message is being processed, variables such as &$local_part$& have no
9263 value. Nevertheless the &%-be%& option can be useful for checking out file and
9264 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9265 and &%nhash%&.
9266
9267 Exim gives up its root privilege when it is called with the &%-be%& option, and
9268 instead runs under the uid and gid it was called with, to prevent users from
9269 using &%-be%& for reading files to which they do not have access.
9270
9271 .oindex "&%-bem%&"
9272 If you want to test expansions that include variables whose values are taken
9273 from a message, there are two other options that can be used. The &%-bem%&
9274 option is like &%-be%& except that it is followed by a filename. The file is
9275 read as a message before doing the test expansions. For example:
9276 .code
9277 exim -bem /tmp/test.message '$h_subject:'
9278 .endd
9279 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9280 Exim message identifier. For example:
9281 .code
9282 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9283 .endd
9284 This loads the message from Exim's spool before doing the test expansions, and
9285 is therefore restricted to admin users.
9286
9287
9288 .section "Forced expansion failure" "SECTforexpfai"
9289 .cindex "expansion" "forced failure"
9290 A number of expansions that are described in the following section have
9291 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9292 (which are sometimes called &"curly brackets"&). Which of the two strings is
9293 used depends on some condition that is evaluated as part of the expansion. If,
9294 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9295 the entire string expansion fails in a way that can be detected by the code
9296 that requested the expansion. This is called &"forced expansion failure"&, and
9297 its consequences depend on the circumstances. In some cases it is no different
9298 from any other expansion failure, but in others a different action may be
9299 taken. Such variations are mentioned in the documentation of the option that is
9300 being expanded.
9301
9302
9303
9304
9305 .section "Expansion items" "SECTexpansionitems"
9306 The following items are recognized in expanded strings. White space may be used
9307 between sub-items that are keywords or substrings enclosed in braces inside an
9308 outer set of braces, to improve readability. &*Warning*&: Within braces,
9309 white space is significant.
9310
9311 .vlist
9312 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9313 .cindex "expansion" "variables"
9314 Substitute the contents of the named variable, for example:
9315 .code
9316 $local_part
9317 ${domain}
9318 .endd
9319 The second form can be used to separate the name from subsequent alphanumeric
9320 characters. This form (using braces) is available only for variables; it does
9321 &'not'& apply to message headers. The names of the variables are given in
9322 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9323 given, the expansion fails.
9324
9325 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9326 .cindex "expansion" "operators"
9327 The string is first itself expanded, and then the operation specified by
9328 <&'op'&> is applied to it. For example:
9329 .code
9330 ${lc:$local_part}
9331 .endd
9332 The string starts with the first character after the colon, which may be
9333 leading white space. A list of operators is given in section &<<SECTexpop>>&
9334 below. The operator notation is used for simple expansion items that have just
9335 one argument, because it reduces the number of braces and therefore makes the
9336 string easier to understand.
9337
9338 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9339 This item inserts &"basic"& header lines. It is described with the &%header%&
9340 expansion item below.
9341
9342
9343 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9344 .cindex "expansion" "calling an acl"
9345 .cindex "&%acl%&" "call from expansion"
9346 The name and zero to nine argument strings are first expanded separately.  The expanded
9347 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9348 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9349 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9350 and may use the variables; if another acl expansion is used the values
9351 are restored after it returns.  If the ACL sets
9352 a value using a "message =" modifier and returns accept or deny, the value becomes
9353 the result of the expansion.
9354 If no message is set and the ACL returns accept or deny
9355 the expansion result is an empty string.
9356 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9357
9358
9359 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9360 .cindex authentication "results header"
9361 .cindex headers "authentication-results:"
9362 .cindex authentication "expansion item"
9363 This item returns a string suitable for insertion as an
9364 &'Authentication-Results"'&
9365 header line.
9366 The given <&'authserv-id'&> is included in the result; typically this
9367 will be a domain name identifying the system performing the authentications.
9368 Methods that might be present in the result include:
9369 .code
9370 none
9371 iprev
9372 auth
9373 spf
9374 dkim
9375 .endd
9376
9377 Example use (as an ACL modifier):
9378 .code
9379       add_header = :at_start:${authresults {$primary_hostname}}
9380 .endd
9381 This is safe even if no authentication results are available.
9382
9383
9384 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9385        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9386 .cindex "expansion" "extracting certificate fields"
9387 .cindex "&%certextract%&" "certificate fields"
9388 .cindex "certificate" "extracting fields"
9389 The <&'certificate'&> must be a variable of type certificate.
9390 The field name is expanded and used to retrieve the relevant field from
9391 the certificate.  Supported fields are:
9392 .display
9393 &`version        `&
9394 &`serial_number  `&
9395 &`subject        `& RFC4514 DN
9396 &`issuer         `& RFC4514 DN
9397 &`notbefore      `& time
9398 &`notafter       `& time
9399 &`sig_algorithm  `&
9400 &`signature      `&
9401 &`subj_altname   `& tagged list
9402 &`ocsp_uri       `& list
9403 &`crl_uri        `& list
9404 .endd
9405 If the field is found,
9406 <&'string2'&> is expanded, and replaces the whole item;
9407 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9408 variable &$value$& contains the value that has been extracted. Afterwards, it
9409 is restored to any previous value it might have had.
9410
9411 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9412 key is not found. If {<&'string2'&>} is also omitted, the value that was
9413 extracted is used.
9414
9415 Some field names take optional modifiers, appended and separated by commas.
9416
9417 The field selectors marked as "RFC4514" above
9418 output a Distinguished Name string which is
9419 not quite
9420 parseable by Exim as a comma-separated tagged list
9421 (the exceptions being elements containing commas).
9422 RDN elements of a single type may be selected by
9423 a modifier of the type label; if so the expansion
9424 result is a list (newline-separated by default).
9425 The separator may be changed by another modifier of
9426 a right angle-bracket followed immediately by the new separator.
9427 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9428
9429 The field selectors marked as "time" above
9430 take an optional modifier of "int"
9431 for which the result is the number of seconds since epoch.
9432 Otherwise the result is a human-readable string
9433 in the timezone selected by the main "timezone" option.
9434
9435 The field selectors marked as "list" above return a list,
9436 newline-separated by default,
9437 (embedded separator characters in elements are doubled).
9438 The separator may be changed by a modifier of
9439 a right angle-bracket followed immediately by the new separator.
9440
9441 The field selectors marked as "tagged" above
9442 prefix each list element with a type string and an equals sign.
9443 Elements of only one type may be selected by a modifier
9444 which is one of "dns", "uri" or "mail";
9445 if so the element tags are omitted.
9446
9447 If not otherwise noted field values are presented in human-readable form.
9448
9449 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9450        {*&<&'arg'&>&*}...}*&"
9451 .cindex &%dlfunc%&
9452 This expansion dynamically loads and then calls a locally-written C function.
9453 This functionality is available only if Exim is compiled with
9454 .code
9455 EXPAND_DLFUNC=yes
9456 .endd
9457 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9458 object so that it doesn't reload the same object file in the same Exim process
9459 (but of course Exim does start new processes frequently).
9460
9461 There may be from zero to eight arguments to the function. When compiling
9462 a local function that is to be called in this way, &_local_scan.h_& should be
9463 included. The Exim variables and functions that are defined by that API
9464 are also available for dynamically loaded functions. The function itself
9465 must have the following type:
9466 .code
9467 int dlfunction(uschar **yield, int argc, uschar *argv[])
9468 .endd
9469 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9470 function should return one of the following values:
9471
9472 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9473 into the expanded string that is being built.
9474
9475 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9476 from &'yield'&, if it is set.
9477
9478 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9479 taken from &'yield'& if it is set.
9480
9481 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9482
9483 When compiling a function that is to be used in this way with gcc,
9484 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9485 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9486
9487
9488 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9489 .cindex "expansion" "extracting value from environment"
9490 .cindex "environment" "values from"
9491 The key is first expanded separately, and leading and trailing white space
9492 removed.
9493 This is then searched for as a name in the environment.
9494 If a variable is found then its value is placed in &$value$&
9495 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9496
9497 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9498 appear, for example:
9499 .code
9500 ${env{USER}{$value} fail }
9501 .endd
9502 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9503 {<&'string1'&>} must be present for &"fail"& to be recognized.
9504
9505 If {<&'string2'&>} is omitted an empty string is substituted on
9506 search failure.
9507 If {<&'string1'&>} is omitted the search result is substituted on
9508 search success.
9509
9510 The environment is adjusted by the &%keep_environment%& and
9511 &%add_environment%& main section options.
9512
9513
9514 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9515        {*&<&'string3'&>&*}}*&"
9516 .cindex "expansion" "extracting substrings by key"
9517 .cindex "&%extract%&" "substrings by key"
9518 The key and <&'string1'&> are first expanded separately. Leading and trailing
9519 white space is removed from the key (but not from any of the strings). The key
9520 must not be empty and must not consist entirely of digits.
9521 The expanded <&'string1'&> must be of the form:
9522 .display
9523 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9524 .endd
9525 .vindex "&$value$&"
9526 where the equals signs and spaces (but not both) are optional. If any of the
9527 values contain white space, they must be enclosed in double quotes, and any
9528 values that are enclosed in double quotes are subject to escape processing as
9529 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9530 for the value that corresponds to the key. The search is case-insensitive. If
9531 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9532 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9533 variable &$value$& contains the value that has been extracted. Afterwards, it
9534 is restored to any previous value it might have had.
9535
9536 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9537 key is not found. If {<&'string2'&>} is also omitted, the value that was
9538 extracted is used. Thus, for example, these two expansions are identical, and
9539 yield &"2001"&:
9540 .code
9541 ${extract{gid}{uid=1984 gid=2001}}
9542 ${extract{gid}{uid=1984 gid=2001}{$value}}
9543 .endd
9544 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9545 appear, for example:
9546 .code
9547 ${extract{Z}{A=... B=...}{$value} fail }
9548 .endd
9549 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9550 {<&'string2'&>} must be present for &"fail"& to be recognized.
9551
9552 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9553        {*&<&'string3'&>&*}}*&" &&&
9554        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9555        {*&<&'string3'&>&*}}*&"
9556 .cindex "expansion" "extracting from JSON object"
9557 .cindex JSON expansions
9558 The key and <&'string1'&> are first expanded separately. Leading and trailing
9559 white space is removed from the key (but not from any of the strings). The key
9560 must not be empty and must not consist entirely of digits.
9561 The expanded <&'string1'&> must be of the form:
9562 .display
9563 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9564 .endd
9565 .vindex "&$value$&"
9566 The braces, commas and colons, and the quoting of the member name are required;
9567 the spaces are optional.
9568 Matching of the key against the member names is done case-sensitively.
9569 For the &"json"& variant,
9570 if a returned value is a JSON string, it retains its leading and
9571 trailing quotes.
9572 .new
9573 For the &"jsons"& variant, which is intended for use with JSON strings, the
9574 leading and trailing quotes are removed from the returned value.
9575 .wen
9576 . XXX should be a UTF-8 compare
9577
9578 The results of matching are handled as above.
9579
9580
9581 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9582         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9583 .cindex "expansion" "extracting substrings by number"
9584 .cindex "&%extract%&" "substrings by number"
9585 The <&'number'&> argument must consist entirely of decimal digits,
9586 apart from leading and trailing white space, which is ignored.
9587 This is what distinguishes this form of &%extract%& from the previous kind. It
9588 behaves in the same way, except that, instead of extracting a named field, it
9589 extracts from <&'string1'&> the field whose number is given as the first
9590 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9591 <&'string3'&> as before.
9592
9593 The fields in the string are separated by any one of the characters in the
9594 separator string. These may include space or tab characters.
9595 The first field is numbered one. If the number is negative, the fields are
9596 counted from the end of the string, with the rightmost one numbered -1. If the
9597 number given is zero, the entire string is returned. If the modulus of the
9598 number is greater than the number of fields in the string, the result is the
9599 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9600 provided. For example:
9601 .code
9602 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9603 .endd
9604 yields &"42"&, and
9605 .code
9606 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9607 .endd
9608 yields &"99"&. Two successive separators mean that the field between them is
9609 empty (for example, the fifth field above).
9610
9611
9612 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9613         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9614        "&*${extract jsons{*&<&'number'&>&*}}&&&
9615         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9616 .cindex "expansion" "extracting from JSON array"
9617 .cindex JSON expansions
9618 The <&'number'&> argument must consist entirely of decimal digits,
9619 apart from leading and trailing white space, which is ignored.
9620
9621 Field selection and result handling is as above;
9622 there is no choice of field separator.
9623 For the &"json"& variant,
9624 if a returned value is a JSON string, it retains its leading and
9625 trailing quotes.
9626 .new
9627 For the &"jsons"& variant, which is intended for use with JSON strings, the
9628 leading and trailing quotes are removed from the returned value.
9629 .wen
9630
9631
9632 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9633 .cindex "list" "selecting by condition"
9634 .cindex "expansion" "selecting from list by condition"
9635 .vindex "&$item$&"
9636 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9637 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9638 For each item
9639 in this list, its value is place in &$item$&, and then the condition is
9640 evaluated. If the condition is true, &$item$& is added to the output as an
9641 item in a new list; if the condition is false, the item is discarded. The
9642 separator used for the output list is the same as the one used for the
9643 input, but a separator setting is not included in the output. For example:
9644 .code
9645 ${filter{a:b:c}{!eq{$item}{b}}}
9646 .endd
9647 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9648 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9649
9650
9651 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9652 .cindex "hash function" "textual"
9653 .cindex "expansion" "textual hash"
9654 This is a textual hashing function, and was the first to be implemented in
9655 early versions of Exim. In current releases, there are other hashing functions
9656 (numeric, MD5, and SHA-1), which are described below.
9657
9658 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9659 <&'n'&>. If you are using fixed values for these numbers, that is, if
9660 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9661 use the simpler operator notation that avoids some of the braces:
9662 .code
9663 ${hash_<n>_<m>:<string>}
9664 .endd
9665 The second number is optional (in both notations). If <&'n'&> is greater than
9666 or equal to the length of the string, the expansion item returns the string.
9667 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9668 function to the string. The new string consists of characters taken from the
9669 first <&'m'&> characters of the string
9670 .code
9671 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9672 .endd
9673 If <&'m'&> is not present the value 26 is used, so that only lower case
9674 letters appear. For example:
9675 .display
9676 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9677 &`$hash{5}{monty}}           `&   yields  &`monty`&
9678 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9679 .endd
9680
9681 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9682         &*$h_*&<&'header&~name'&>&*:*&" &&&
9683        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9684         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9685        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9686         &*$lh_*&<&'header&~name'&>&*:*&"
9687        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9688         &*$rh_*&<&'header&~name'&>&*:*&"
9689 .cindex "expansion" "header insertion"
9690 .vindex "&$header_$&"
9691 .vindex "&$bheader_$&"
9692 .vindex "&$lheader_$&"
9693 .vindex "&$rheader_$&"
9694 .cindex "header lines" "in expansion strings"
9695 .cindex "header lines" "character sets"
9696 .cindex "header lines" "decoding"
9697 Substitute the contents of the named message header line, for example
9698 .code
9699 $header_reply-to:
9700 .endd
9701 The newline that terminates a header line is not included in the expansion, but
9702 internal newlines (caused by splitting the header line over several physical
9703 lines) may be present.
9704
9705 The difference between the four pairs of expansions is in the way
9706 the data in the header line is interpreted.
9707
9708 .ilist
9709 .cindex "white space" "in header lines"
9710 &%rheader%& gives the original &"raw"& content of the header line, with no
9711 processing at all, and without the removal of leading and trailing white space.
9712
9713 .next
9714 .cindex "list" "of header lines"
9715 &%lheader%& gives a colon-separated list, one element per header when there
9716 are multiple headers with a given name.
9717 Any embedded colon characters within an element are doubled, so normal Exim
9718 list-processing facilities can be used.
9719 The terminating newline of each element is removed; in other respects
9720 the content is &"raw"&.
9721
9722 .next
9723 .cindex "base64 encoding" "in header lines"
9724 &%bheader%& removes leading and trailing white space, and then decodes base64
9725 or quoted-printable MIME &"words"& within the header text, but does no
9726 character set translation. If decoding of what looks superficially like a MIME
9727 &"word"& fails, the raw string is returned. If decoding
9728 .cindex "binary zero" "in header line"
9729 produces a binary zero character, it is replaced by a question mark &-- this is
9730 what Exim does for binary zeros that are actually received in header lines.
9731
9732 .next
9733 &%header%& tries to translate the string as decoded by &%bheader%& to a
9734 standard character set. This is an attempt to produce the same string as would
9735 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9736 returned. Translation is attempted only on operating systems that support the
9737 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9738 a system Makefile or in &_Local/Makefile_&.
9739 .endlist ilist
9740
9741 In a filter file, the target character set for &%header%& can be specified by a
9742 command of the following form:
9743 .code
9744 headers charset "UTF-8"
9745 .endd
9746 This command affects all references to &$h_$& (or &$header_$&) expansions in
9747 subsequently obeyed filter commands. In the absence of this command, the target
9748 character set in a filter is taken from the setting of the &%headers_charset%&
9749 option in the runtime configuration. The value of this option defaults to the
9750 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9751 ISO-8859-1.
9752
9753 Header names follow the syntax of RFC 2822, which states that they may contain
9754 any printing characters except space and colon. Consequently, curly brackets
9755 &'do not'& terminate header names, and should not be used to enclose them as
9756 if they were variables. Attempting to do so causes a syntax error.
9757
9758 Only header lines that are common to all copies of a message are visible to
9759 this mechanism. These are the original header lines that are received with the
9760 message, and any that are added by an ACL statement or by a system
9761 filter. Header lines that are added to a particular copy of a message by a
9762 router or transport are not accessible.
9763
9764 For incoming SMTP messages, no header lines are visible in
9765 ACLs that are obeyed before the data phase completes,
9766 because the header structure is not set up until the message is received.
9767 They are visible in DKIM, PRDR and DATA ACLs.
9768 Header lines that are added in a RCPT ACL (for example)
9769 are saved until the message's incoming header lines are available, at which
9770 point they are added.
9771 When any of the above ACLs ar
9772 running, however, header lines added by earlier ACLs are visible.
9773
9774 Upper case and lower case letters are synonymous in header names. If the
9775 following character is white space, the terminating colon may be omitted, but
9776 this is not recommended, because you may then forget it when it is needed. When
9777 white space terminates the header name, this white space is included in the
9778 expanded string.  If the message does not contain the given header, the
9779 expansion item is replaced by an empty string. (See the &%def%& condition in
9780 section &<<SECTexpcond>>& for a means of testing for the existence of a
9781 header.)
9782
9783 If there is more than one header with the same name, they are all concatenated
9784 to form the substitution string, up to a maximum length of 64K. Unless
9785 &%rheader%& is being used, leading and trailing white space is removed from
9786 each header before concatenation, and a completely empty header is ignored. A
9787 newline character is then inserted between non-empty headers, but there is no
9788 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9789 those headers that contain lists of addresses, a comma is also inserted at the
9790 junctions between headers. This does not happen for the &%rheader%& expansion.
9791
9792
9793 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9794 .cindex "expansion" "hmac hashing"
9795 .cindex &%hmac%&
9796 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9797 shared secret and some text into a message authentication code, as specified in
9798 RFC 2104. This differs from &`${md5:secret_text...}`& or
9799 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9800 cryptographic hash, allowing for authentication that is not possible with MD5
9801 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9802 present. For example:
9803 .code
9804 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9805 .endd
9806 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9807 produces:
9808 .code
9809 dd97e3ba5d1a61b5006108f8c8252953
9810 .endd
9811 As an example of how this might be used, you might put in the main part of
9812 an Exim configuration:
9813 .code
9814 SPAMSCAN_SECRET=cohgheeLei2thahw
9815 .endd
9816 In a router or a transport you could then have:
9817 .code
9818 headers_add = \
9819   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9820   ${hmac{md5}{SPAMSCAN_SECRET}\
9821   {${primary_hostname},${message_exim_id},$h_message-id:}}
9822 .endd
9823 Then given a message, you can check where it was scanned by looking at the
9824 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9825 this header line is authentic by recomputing the authentication code from the
9826 host name, message ID and the &'Message-id:'& header line. This can be done
9827 using Exim's &%-be%& option, or by other means, for example, by using the
9828 &'hmac_md5_hex()'& function in Perl.
9829
9830
9831 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9832 .cindex "expansion" "conditional"
9833 .cindex "&%if%&, expansion item"
9834 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9835 item; otherwise <&'string2'&> is used. The available conditions are described
9836 in section &<<SECTexpcond>>& below. For example:
9837 .code
9838 ${if eq {$local_part}{postmaster} {yes}{no} }
9839 .endd
9840 The second string need not be present; if it is not and the condition is not
9841 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9842 be present instead of the second string (without any curly brackets). In this
9843 case, the expansion is forced to fail if the condition is not true (see section
9844 &<<SECTforexpfai>>&).
9845
9846 If both strings are omitted, the result is the string &`true`& if the condition
9847 is true, and the empty string if the condition is false. This makes it less
9848 cumbersome to write custom ACL and router conditions. For example, instead of
9849 .code
9850 condition = ${if >{$acl_m4}{3}{true}{false}}
9851 .endd
9852 you can use
9853 .code
9854 condition = ${if >{$acl_m4}{3}}
9855 .endd
9856
9857
9858
9859 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9860 .cindex expansion "imap folder"
9861 .cindex "&%imapfolder%& expansion item"
9862 This item converts a (possibly multilevel, or with non-ASCII characters)
9863 folder specification to a Maildir name for filesystem use.
9864 For information on internationalisation support see &<<SECTi18nMDA>>&.
9865
9866
9867
9868 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9869 .cindex "expansion" "string truncation"
9870 .cindex "&%length%& expansion item"
9871 The &%length%& item is used to extract the initial portion of a string. Both
9872 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9873 you are using a fixed value for the number, that is, if <&'string1'&> does not
9874 change when expanded, you can use the simpler operator notation that avoids
9875 some of the braces:
9876 .code
9877 ${length_<n>:<string>}
9878 .endd
9879 The result of this item is either the first <&'n'&> bytes or the whole
9880 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9881 &%strlen%&, which gives the length of a string.
9882 All measurement is done in bytes and is not UTF-8 aware.
9883
9884
9885 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9886         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9887 .cindex "expansion" "extracting list elements by number"
9888 .cindex "&%listextract%&" "extract list elements by number"
9889 .cindex "list" "extracting elements by number"
9890 The <&'number'&> argument must consist entirely of decimal digits,
9891 apart from an optional leading minus,
9892 and leading and trailing white space (which is ignored).
9893
9894 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9895 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9896
9897 The first field of the list is numbered one.
9898 If the number is negative, the fields are
9899 counted from the end of the list, with the rightmost one numbered -1.
9900 The numbered element of the list is extracted and placed in &$value$&,
9901 then <&'string2'&> is expanded as the result.
9902
9903 If the modulus of the
9904 number is zero or greater than the number of fields in the string,
9905 the result is the expansion of <&'string3'&>.
9906
9907 For example:
9908 .code
9909 ${listextract{2}{x:42:99}}
9910 .endd
9911 yields &"42"&, and
9912 .code
9913 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9914 .endd
9915 yields &"result: 42"&.
9916
9917 If {<&'string3'&>} is omitted, an empty string is used for string3.
9918 If {<&'string2'&>} is also omitted, the value that was
9919 extracted is used.
9920 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9921
9922
9923 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9924         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9925 This is the first of one of two different types of lookup item, which are both
9926 described in the next item.
9927
9928 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9929         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9930 .cindex "expansion" "lookup in"
9931 .cindex "file" "lookups"
9932 .cindex "lookup" "in expanded string"
9933 The two forms of lookup item specify data lookups in files and databases, as
9934 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9935 lookups, and the second is used for query-style lookups. The <&'key'&>,
9936 <&'file'&>, and <&'query'&> strings are expanded before use.
9937
9938 If there is any white space in a lookup item which is part of a filter command,
9939 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9940 other place where white space is significant, the lookup item must be enclosed
9941 in double quotes. The use of data lookups in users' filter files may be locked
9942 out by the system administrator.
9943
9944 .vindex "&$value$&"
9945 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9946 During its expansion, the variable &$value$& contains the data returned by the
9947 lookup. Afterwards it reverts to the value it had previously (at the outer
9948 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9949 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9950 string on failure. If <&'string2'&> is provided, it can itself be a nested
9951 lookup, thus providing a mechanism for looking up a default value when the
9952 original lookup fails.
9953
9954 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9955 data for the outer lookup while the parameters of the second lookup are
9956 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9957 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9958 appear, and in this case, if the lookup fails, the entire expansion is forced
9959 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9960 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9961 successful lookup, and nothing in the case of failure.
9962
9963 For single-key lookups, the string &"partial"& is permitted to precede the
9964 search type in order to do partial matching, and * or *@ may follow a search
9965 type to request default lookups if the key does not match (see sections
9966 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9967
9968 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9969 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9970 and non-wild parts of the key during the expansion of the replacement text.
9971 They return to their previous values at the end of the lookup item.
9972
9973 This example looks up the postmaster alias in the conventional alias file:
9974 .code
9975 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9976 .endd
9977 This example uses NIS+ to look up the full name of the user corresponding to
9978 the local part of an address, forcing the expansion to fail if it is not found:
9979 .code
9980 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9981   {$value}fail}
9982 .endd
9983
9984
9985 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9986 .cindex "expansion" "list creation"
9987 .vindex "&$item$&"
9988 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9989 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9990 For each item
9991 in this list, its value is place in &$item$&, and then <&'string2'&> is
9992 expanded and added to the output as an item in a new list. The separator used
9993 for the output list is the same as the one used for the input, but a separator
9994 setting is not included in the output. For example:
9995 .code
9996 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9997 .endd
9998 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9999 value of &$item$& is restored to what it was before. See also the &*filter*&
10000 and &*reduce*& expansion items.
10001
10002 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10003 .cindex "expansion" "numeric hash"
10004 .cindex "hash function" "numeric"
10005 The three strings are expanded; the first two must yield numbers. Call them
10006 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10007 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10008 can use the simpler operator notation that avoids some of the braces:
10009 .code
10010 ${nhash_<n>_<m>:<string>}
10011 .endd
10012 The second number is optional (in both notations). If there is only one number,
10013 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10014 processed by a div/mod hash function that returns two numbers, separated by a
10015 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10016 example,
10017 .code
10018 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10019 .endd
10020 returns the string &"6/33"&.
10021
10022
10023
10024 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10025 .cindex "Perl" "use in expanded string"
10026 .cindex "expansion" "calling Perl from"
10027 This item is available only if Exim has been built to include an embedded Perl
10028 interpreter. The subroutine name and the arguments are first separately
10029 expanded, and then the Perl subroutine is called with those arguments. No
10030 additional arguments need be given; the maximum number permitted, including the
10031 name of the subroutine, is nine.
10032
10033 The return value of the subroutine is inserted into the expanded string, unless
10034 the return value is &%undef%&. In that case, the expansion fails in the same
10035 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10036 Whatever you return is evaluated in a scalar context. For example, if you
10037 return the name of a Perl vector, the return value is the size of the vector,
10038 not its contents.
10039
10040 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10041 with the error message that was passed to &%die%&. More details of the embedded
10042 Perl facility are given in chapter &<<CHAPperl>>&.
10043
10044 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10045 out the use of this expansion item in filter files.
10046
10047
10048 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10049 .cindex "&%prvs%& expansion item"
10050 The first argument is a complete email address and the second is secret
10051 keystring. The third argument, specifying a key number, is optional. If absent,
10052 it defaults to 0. The result of the expansion is a prvs-signed email address,
10053 to be typically used with the &%return_path%& option on an &(smtp)& transport
10054 as part of a bounce address tag validation (BATV) scheme. For more discussion
10055 and an example, see section &<<SECTverifyPRVS>>&.
10056
10057 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10058         {*&<&'string'&>&*}}*&"
10059 .cindex "&%prvscheck%& expansion item"
10060 This expansion item is the complement of the &%prvs%& item. It is used for
10061 checking prvs-signed addresses. If the expansion of the first argument does not
10062 yield a syntactically valid prvs-signed address, the whole item expands to the
10063 empty string. When the first argument does expand to a syntactically valid
10064 prvs-signed address, the second argument is expanded, with the prvs-decoded
10065 version of the address and the key number extracted from the address in the
10066 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10067
10068 These two variables can be used in the expansion of the second argument to
10069 retrieve the secret. The validity of the prvs-signed address is then checked
10070 against the secret. The result is stored in the variable &$prvscheck_result$&,
10071 which is empty for failure or &"1"& for success.
10072
10073 The third argument is optional; if it is missing, it defaults to an empty
10074 string. This argument is now expanded. If the result is an empty string, the
10075 result of the expansion is the decoded version of the address. This is the case
10076 whether or not the signature was valid. Otherwise, the result of the expansion
10077 is the expansion of the third argument.
10078
10079 All three variables can be used in the expansion of the third argument.
10080 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10081 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10082
10083 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10084 .cindex "expansion" "inserting an entire file"
10085 .cindex "file" "inserting into expansion"
10086 .cindex "&%readfile%& expansion item"
10087 The filename and end-of-line string are first expanded separately. The file is
10088 then read, and its contents replace the entire item. All newline characters in
10089 the file are replaced by the end-of-line string if it is present. Otherwise,
10090 newlines are left in the string.
10091 String expansion is not applied to the contents of the file. If you want this,
10092 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10093 the string expansion fails.
10094
10095 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10096 locks out the use of this expansion item in filter files.
10097
10098
10099
10100 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10101         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10102 .cindex "expansion" "inserting from a socket"
10103 .cindex "socket, use of in expansion"
10104 .cindex "&%readsocket%& expansion item"
10105 This item inserts data from a Unix domain or TCP socket into the expanded
10106 string. The minimal way of using it uses just two arguments, as in these
10107 examples:
10108 .code
10109 ${readsocket{/socket/name}{request string}}
10110 ${readsocket{inet:some.host:1234}{request string}}
10111 .endd
10112 For a Unix domain socket, the first substring must be the path to the socket.
10113 For an Internet socket, the first substring must contain &`inet:`& followed by
10114 a host name or IP address, followed by a colon and a port, which can be a
10115 number or the name of a TCP port in &_/etc/services_&. An IP address may
10116 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10117 example:
10118 .code
10119 ${readsocket{inet:[::1]:1234}{request string}}
10120 .endd
10121 Only a single host name may be given, but if looking it up yields more than
10122 one IP address, they are each tried in turn until a connection is made. For
10123 both kinds of socket, Exim makes a connection, writes the request string
10124 unless it is an empty string; and no terminating NUL is ever sent)
10125 and reads from the socket until an end-of-file
10126 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10127 extend what can be done. Firstly, you can vary the timeout. For example:
10128 .code
10129 ${readsocket{/socket/name}{request string}{3s}}
10130 .endd
10131
10132 The third argument is a list of options, of which the first element is the timeout
10133 and must be present if the argument is given.
10134 Further elements are options of form &'name=value'&.
10135 Two option types is currently recognised: shutdown and tls.
10136 The first defines whether (the default)
10137 or not a shutdown is done on the connection after sending the request.
10138 Example, to not do so (preferred, eg. by some webservers):
10139 .code
10140 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10141 .endd
10142 The second, tls, controls the use of TLS on the connection.  Example:
10143 .code
10144 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10145 .endd
10146 The default is to not use TLS.
10147 If it is enabled, a shutdown as descripbed above is never done.
10148
10149 A fourth argument allows you to change any newlines that are in the data
10150 that is read, in the same way as for &%readfile%& (see above). This example
10151 turns them into spaces:
10152 .code
10153 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10154 .endd
10155 As with all expansions, the substrings are expanded before the processing
10156 happens. Errors in these sub-expansions cause the expansion to fail. In
10157 addition, the following errors can occur:
10158
10159 .ilist
10160 Failure to create a socket file descriptor;
10161 .next
10162 Failure to connect the socket;
10163 .next
10164 Failure to write the request string;
10165 .next
10166 Timeout on reading from the socket.
10167 .endlist
10168
10169 By default, any of these errors causes the expansion to fail. However, if
10170 you supply a fifth substring, it is expanded and used when any of the above
10171 errors occurs. For example:
10172 .code
10173 ${readsocket{/socket/name}{request string}{3s}{\n}\
10174   {socket failure}}
10175 .endd
10176 You can test for the existence of a Unix domain socket by wrapping this
10177 expansion in &`${if exists`&, but there is a race condition between that test
10178 and the actual opening of the socket, so it is safer to use the fifth argument
10179 if you want to be absolutely sure of avoiding an expansion error for a
10180 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10181
10182 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10183 locks out the use of this expansion item in filter files.
10184
10185
10186 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10187 .cindex "expansion" "reducing a list to a scalar"
10188 .cindex "list" "reducing to a scalar"
10189 .vindex "&$value$&"
10190 .vindex "&$item$&"
10191 This operation reduces a list to a single, scalar string. After expansion,
10192 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10193 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10194 Then <&'string2'&> is expanded and
10195 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10196 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10197 them. The result of that expansion is assigned to &$value$& before the next
10198 iteration. When the end of the list is reached, the final value of &$value$& is
10199 added to the expansion output. The &*reduce*& expansion item can be used in a
10200 number of ways. For example, to add up a list of numbers:
10201 .code
10202 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10203 .endd
10204 The result of that expansion would be &`6`&. The maximum of a list of numbers
10205 can be found:
10206 .code
10207 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10208 .endd
10209 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10210 restored to what they were before. See also the &*filter*& and &*map*&
10211 expansion items.
10212
10213 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10214 This item inserts &"raw"& header lines. It is described with the &%header%&
10215 expansion item in section &<<SECTexpansionitems>>& above.
10216
10217 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10218         {*&<&'string2'&>&*}}*&"
10219 .cindex "expansion" "running a command"
10220 .cindex "&%run%& expansion item"
10221 The command and its arguments are first expanded as one string. The string is
10222 split apart into individual arguments by spaces, and then the command is run
10223 in a separate process, but under the same uid and gid.  As in other command
10224 executions from Exim, a shell is not used by default. If the command requires
10225 a shell, you must explicitly code it.
10226
10227 Since the arguments are split by spaces, when there is a variable expansion
10228 which has an empty result, it will cause the situation that the argument will
10229 simply be omitted when the program is actually executed by Exim. If the
10230 script/program requires a specific number of arguments and the expanded
10231 variable could possibly result in this empty expansion, the variable must be
10232 quoted. This is more difficult if the expanded variable itself could result
10233 in a string containing quotes, because it would interfere with the quotes
10234 around the command arguments. A possible guard against this is to wrap the
10235 variable in the &%sg%& operator to change any quote marks to some other
10236 character.
10237
10238 The standard input for the command exists, but is empty. The standard output
10239 and standard error are set to the same file descriptor.
10240 .cindex "return code" "from &%run%& expansion"
10241 .vindex "&$value$&"
10242 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10243 and replaces the entire item; during this expansion, the standard output/error
10244 from the command is in the variable &$value$&. If the command fails,
10245 <&'string2'&>, if present, is expanded and used. Once again, during the
10246 expansion, the standard output/error from the command is in the variable
10247 &$value$&.
10248
10249 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10250 can be the word &"fail"& (not in braces) to force expansion failure if the
10251 command does not succeed. If both strings are omitted, the result is contents
10252 of the standard output/error on success, and nothing on failure.
10253
10254 .vindex "&$run_in_acl$&"
10255 The standard output/error of the command is put in the variable &$value$&.
10256 In this ACL example, the output of a command is logged for the admin to
10257 troubleshoot:
10258 .code
10259 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10260       log_message  = Output of id: $value
10261 .endd
10262 If the command requires shell idioms, such as the > redirect operator, the
10263 shell must be invoked directly, such as with:
10264 .code
10265 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10266 .endd
10267
10268 .vindex "&$runrc$&"
10269 The return code from the command is put in the variable &$runrc$&, and this
10270 remains set afterwards, so in a filter file you can do things like this:
10271 .code
10272 if "${run{x y z}{}}$runrc" is 1 then ...
10273   elif $runrc is 2 then ...
10274   ...
10275 endif
10276 .endd
10277 If execution of the command fails (for example, the command does not exist),
10278 the return code is 127 &-- the same code that shells use for non-existent
10279 commands.
10280
10281 &*Warning*&: In a router or transport, you cannot assume the order in which
10282 option values are expanded, except for those preconditions whose order of
10283 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10284 by the expansion of one option, and use it in another.
10285
10286 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10287 out the use of this expansion item in filter files.
10288
10289
10290 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10291 .cindex "expansion" "string substitution"
10292 .cindex "&%sg%& expansion item"
10293 This item works like Perl's substitution operator (s) with the global (/g)
10294 option; hence its name. However, unlike the Perl equivalent, Exim does not
10295 modify the subject string; instead it returns the modified string for insertion
10296 into the overall expansion. The item takes three arguments: the subject string,
10297 a regular expression, and a substitution string. For example:
10298 .code
10299 ${sg{abcdefabcdef}{abc}{xyz}}
10300 .endd
10301 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10302 if any $, } or \ characters are required in the regular expression or in the
10303 substitution string, they have to be escaped. For example:
10304 .code
10305 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10306 .endd
10307 yields &"defabc"&, and
10308 .code
10309 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10310 .endd
10311 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10312 the regular expression from string expansion.
10313
10314 The regular expression is compiled in 8-bit mode, working against bytes
10315 rather than any Unicode-aware character handling.
10316
10317
10318 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10319 .cindex sorting "a list"
10320 .cindex list sorting
10321 .cindex expansion "list sorting"
10322 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10323 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10324 The <&'comparator'&> argument is interpreted as the operator
10325 of a two-argument expansion condition.
10326 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10327 The comparison should return true when applied to two values
10328 if the first value should sort before the second value.
10329 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10330 the element being placed in &$item$&,
10331 to give values for comparison.
10332
10333 The item result is a sorted list,
10334 with the original list separator,
10335 of the list elements (in full) of the original.
10336
10337 Examples:
10338 .code
10339 ${sort{3:2:1:4}{<}{$item}}
10340 .endd
10341 sorts a list of numbers, and
10342 .code
10343 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10344 .endd
10345 will sort an MX lookup into priority order.
10346
10347
10348 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10349 .cindex "&%substr%& expansion item"
10350 .cindex "substring extraction"
10351 .cindex "expansion" "substring extraction"
10352 The three strings are expanded; the first two must yield numbers. Call them
10353 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10354 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10355 can use the simpler operator notation that avoids some of the braces:
10356 .code
10357 ${substr_<n>_<m>:<string>}
10358 .endd
10359 The second number is optional (in both notations).
10360 If it is absent in the simpler format, the preceding underscore must also be
10361 omitted.
10362
10363 The &%substr%& item can be used to extract more general substrings than
10364 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10365 length required. For example
10366 .code
10367 ${substr{3}{2}{$local_part}}
10368 .endd
10369 If the starting offset is greater than the string length the result is the
10370 null string; if the length plus starting offset is greater than the string
10371 length, the result is the right-hand part of the string, starting from the
10372 given offset. The first byte (character) in the string has offset zero.
10373
10374 The &%substr%& expansion item can take negative offset values to count
10375 from the right-hand end of its operand. The last byte (character) is offset -1,
10376 the second-last is offset -2, and so on. Thus, for example,
10377 .code
10378 ${substr{-5}{2}{1234567}}
10379 .endd
10380 yields &"34"&. If the absolute value of a negative offset is greater than the
10381 length of the string, the substring starts at the beginning of the string, and
10382 the length is reduced by the amount of overshoot. Thus, for example,
10383 .code
10384 ${substr{-5}{2}{12}}
10385 .endd
10386 yields an empty string, but
10387 .code
10388 ${substr{-3}{2}{12}}
10389 .endd
10390 yields &"1"&.
10391
10392 When the second number is omitted from &%substr%&, the remainder of the string
10393 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10394 string preceding the offset point are taken. For example, an offset of -1 and
10395 no length, as in these semantically identical examples:
10396 .code
10397 ${substr_-1:abcde}
10398 ${substr{-1}{abcde}}
10399 .endd
10400 yields all but the last character of the string, that is, &"abcd"&.
10401
10402 All measurement is done in bytes and is not UTF-8 aware.
10403
10404
10405
10406 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10407         {*&<&'replacements'&>&*}}*&"
10408 .cindex "expansion" "character translation"
10409 .cindex "&%tr%& expansion item"
10410 This item does single-character (in bytes) translation on its subject string. The second
10411 argument is a list of characters to be translated in the subject string. Each
10412 matching character is replaced by the corresponding character from the
10413 replacement list. For example
10414 .code
10415 ${tr{abcdea}{ac}{13}}
10416 .endd
10417 yields &`1b3de1`&. If there are duplicates in the second character string, the
10418 last occurrence is used. If the third string is shorter than the second, its
10419 last character is replicated. However, if it is empty, no translation takes
10420 place.
10421
10422 All character handling is done in bytes and is not UTF-8 aware.
10423
10424 .endlist
10425
10426
10427
10428 .section "Expansion operators" "SECTexpop"
10429 .cindex "expansion" "operators"
10430 For expansion items that perform transformations on a single argument string,
10431 the &"operator"& notation is used because it is simpler and uses fewer braces.
10432 The substring is first expanded before the operation is applied to it. The
10433 following operations can be performed:
10434
10435 .vlist
10436 .vitem &*${address:*&<&'string'&>&*}*&
10437 .cindex "expansion" "RFC 2822 address handling"
10438 .cindex "&%address%& expansion item"
10439 The string is interpreted as an RFC 2822 address, as it might appear in a
10440 header line, and the effective address is extracted from it. If the string does
10441 not parse successfully, the result is empty.
10442
10443 The parsing correctly handles SMTPUTF8 Unicode in the string.
10444
10445
10446 .vitem &*${addresses:*&<&'string'&>&*}*&
10447 .cindex "expansion" "RFC 2822 address handling"
10448 .cindex "&%addresses%& expansion item"
10449 The string (after expansion) is interpreted as a list of addresses in RFC
10450 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10451 operative address (&'local-part@domain'&) is extracted from each item, and the
10452 result of the expansion is a colon-separated list, with appropriate
10453 doubling of colons should any happen to be present in the email addresses.
10454 Syntactically invalid RFC2822 address items are omitted from the output.
10455
10456 It is possible to specify a character other than colon for the output
10457 separator by starting the string with > followed by the new separator
10458 character. For example:
10459 .code
10460 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10461 .endd
10462 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10463 first, so if the expanded string starts with >, it may change the output
10464 separator unintentionally. This can be avoided by setting the output
10465 separator explicitly:
10466 .code
10467 ${addresses:>:$h_from:}
10468 .endd
10469
10470 Compare the &*address*& (singular)
10471 expansion item, which extracts the working address from a single RFC2822
10472 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10473 processing lists.
10474
10475 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10476 a strict interpretation of header line formatting.  Exim parses the bare,
10477 unquoted portion of an email address and if it finds a comma, treats it as an
10478 email address separator. For the example header line:
10479 .code
10480 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10481 .endd
10482 The first example below demonstrates that Q-encoded email addresses are parsed
10483 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10484 It does not see the comma because it's still encoded as "=2C".  The second
10485 example below is passed the contents of &`$header_from:`&, meaning it gets
10486 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10487 The third example shows that the presence of a comma is skipped when it is
10488 quoted.  The fourth example shows SMTPUTF8 handling.
10489 .code
10490 # exim -be '${addresses:From: \
10491 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10492 user@example.com
10493 # exim -be '${addresses:From: Last, First <user@example.com>}'
10494 Last:user@example.com
10495 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10496 user@example.com
10497 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10498 フィリップ@example.jp
10499 .endd
10500
10501 .vitem &*${base32:*&<&'digits'&>&*}*&
10502 .cindex "&%base32%& expansion item"
10503 .cindex "expansion" "conversion to base 32"
10504 The string must consist entirely of decimal digits. The number is converted to
10505 base 32 and output as a (empty, for zero) string of characters.
10506 Only lowercase letters are used.
10507
10508 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10509 .cindex "&%base32d%& expansion item"
10510 .cindex "expansion" "conversion to base 32"
10511 The string must consist entirely of base-32 digits.
10512 The number is converted to decimal and output as a string.
10513
10514 .vitem &*${base62:*&<&'digits'&>&*}*&
10515 .cindex "&%base62%& expansion item"
10516 .cindex "expansion" "conversion to base 62"
10517 The string must consist entirely of decimal digits. The number is converted to
10518 base 62 and output as a string of six characters, including leading zeros. In
10519 the few operating environments where Exim uses base 36 instead of base 62 for
10520 its message identifiers (because those systems do not have case-sensitive
10521 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10522 to be absolutely clear: this is &'not'& base64 encoding.
10523
10524 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10525 .cindex "&%base62d%& expansion item"
10526 .cindex "expansion" "conversion to base 62"
10527 The string must consist entirely of base-62 digits, or, in operating
10528 environments where Exim uses base 36 instead of base 62 for its message
10529 identifiers, base-36 digits. The number is converted to decimal and output as a
10530 string.
10531
10532 .vitem &*${base64:*&<&'string'&>&*}*&
10533 .cindex "expansion" "base64 encoding"
10534 .cindex "base64 encoding" "in string expansion"
10535 .cindex "&%base64%& expansion item"
10536 .cindex certificate "base64 of DER"
10537 This operator converts a string into one that is base64 encoded.
10538
10539 If the string is a single variable of type certificate,
10540 returns the base64 encoding of the DER form of the certificate.
10541
10542
10543 .vitem &*${base64d:*&<&'string'&>&*}*&
10544 .cindex "expansion" "base64 decoding"
10545 .cindex "base64 decoding" "in string expansion"
10546 .cindex "&%base64d%& expansion item"
10547 This operator converts a base64-encoded string into the un-coded form.
10548
10549
10550 .vitem &*${domain:*&<&'string'&>&*}*&
10551 .cindex "domain" "extraction"
10552 .cindex "expansion" "domain extraction"
10553 The string is interpreted as an RFC 2822 address and the domain is extracted
10554 from it. If the string does not parse successfully, the result is empty.
10555
10556
10557 .vitem &*${escape:*&<&'string'&>&*}*&
10558 .cindex "expansion" "escaping non-printing characters"
10559 .cindex "&%escape%& expansion item"
10560 If the string contains any non-printing characters, they are converted to
10561 escape sequences starting with a backslash. Whether characters with the most
10562 significant bit set (so-called &"8-bit characters"&) count as printing or not
10563 is controlled by the &%print_topbitchars%& option.
10564
10565 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10566 .cindex "expansion" "escaping 8-bit characters"
10567 .cindex "&%escape8bit%& expansion item"
10568 If the string contains and characters with the most significant bit set,
10569 they are converted to escape sequences starting with a backslash.
10570 Backslashes and DEL characters are also converted.
10571
10572
10573 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10574 .cindex "expansion" "expression evaluation"
10575 .cindex "expansion" "arithmetic expression"
10576 .cindex "&%eval%& expansion item"
10577 These items supports simple arithmetic and bitwise logical operations in
10578 expansion strings. The string (after expansion) must be a conventional
10579 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10580 logical operators, and parentheses. All operations are carried out using
10581 integer arithmetic. The operator priorities are as follows (the same as in the
10582 C programming language):
10583 .table2 70pt 300pt
10584 .irow &'highest:'& "not (~), negate (-)"
10585 .irow ""   "multiply (*), divide (/), remainder (%)"
10586 .irow ""   "plus (+), minus (-)"
10587 .irow ""   "shift-left (<<), shift-right (>>)"
10588 .irow ""   "and (&&)"
10589 .irow ""   "xor (^)"
10590 .irow &'lowest:'&  "or (|)"
10591 .endtable
10592 Binary operators with the same priority are evaluated from left to right. White
10593 space is permitted before or after operators.
10594
10595 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10596 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10597 decimal, even if they start with a leading zero; hexadecimal numbers are not
10598 permitted. This can be useful when processing numbers extracted from dates or
10599 times, which often do have leading zeros.
10600
10601 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10602 or 1024*1024*1024,
10603 respectively. Negative numbers are supported. The result of the computation is
10604 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10605
10606 .display
10607 &`${eval:1+1}            `&  yields 2
10608 &`${eval:1+2*3}          `&  yields 7
10609 &`${eval:(1+2)*3}        `&  yields 9
10610 &`${eval:2+42%5}         `&  yields 4
10611 &`${eval:0xc&amp;5}          `&  yields 4
10612 &`${eval:0xc|5}          `&  yields 13
10613 &`${eval:0xc^5}          `&  yields 9
10614 &`${eval:0xc>>1}         `&  yields 6
10615 &`${eval:0xc<<1}         `&  yields 24
10616 &`${eval:~255&amp;0x1234}    `&  yields 4608
10617 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10618 .endd
10619
10620 As a more realistic example, in an ACL you might have
10621 .code
10622 deny   message = Too many bad recipients
10623        condition =                    \
10624          ${if and {                   \
10625            {>{$rcpt_count}{10}}       \
10626            {                          \
10627            <                          \
10628              {$recipients_count}      \
10629              {${eval:$rcpt_count/2}}  \
10630            }                          \
10631          }{yes}{no}}
10632 .endd
10633 The condition is true if there have been more than 10 RCPT commands and
10634 fewer than half of them have resulted in a valid recipient.
10635
10636
10637 .vitem &*${expand:*&<&'string'&>&*}*&
10638 .cindex "expansion" "re-expansion of substring"
10639 The &%expand%& operator causes a string to be expanded for a second time. For
10640 example,
10641 .code
10642 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10643 .endd
10644 first looks up a string in a file while expanding the operand for &%expand%&,
10645 and then re-expands what it has found.
10646
10647
10648 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10649 .cindex "Unicode"
10650 .cindex "UTF-8" "conversion from"
10651 .cindex "expansion" "UTF-8 conversion"
10652 .cindex "&%from_utf8%& expansion item"
10653 The world is slowly moving towards Unicode, although there are no standards for
10654 email yet. However, other applications (including some databases) are starting
10655 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10656 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10657 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10658 the result is an undefined sequence of bytes.
10659
10660 Unicode code points with values less than 256 are compatible with ASCII and
10661 ISO-8859-1 (also known as Latin-1).
10662 For example, character 169 is the copyright symbol in both cases, though the
10663 way it is encoded is different. In UTF-8, more than one byte is needed for
10664 characters with code values greater than 127, whereas ISO-8859-1 is a
10665 single-byte encoding (but thereby limited to 256 characters). This makes
10666 translation from UTF-8 to ISO-8859-1 straightforward.
10667
10668
10669 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10670 .cindex "hash function" "textual"
10671 .cindex "expansion" "textual hash"
10672 The &%hash%& operator is a simpler interface to the hashing function that can
10673 be used when the two parameters are fixed numbers (as opposed to strings that
10674 change when expanded). The effect is the same as
10675 .code
10676 ${hash{<n>}{<m>}{<string>}}
10677 .endd
10678 See the description of the general &%hash%& item above for details. The
10679 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10680
10681
10682
10683 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10684 .cindex "base64 encoding" "conversion from hex"
10685 .cindex "expansion" "hex to base64"
10686 .cindex "&%hex2b64%& expansion item"
10687 This operator converts a hex string into one that is base64 encoded. This can
10688 be useful for processing the output of the various hashing functions.
10689
10690
10691
10692 .vitem &*${hexquote:*&<&'string'&>&*}*&
10693 .cindex "quoting" "hex-encoded unprintable characters"
10694 .cindex "&%hexquote%& expansion item"
10695 This operator converts non-printable characters in a string into a hex
10696 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10697 as is, and other byte values are converted to &`\xNN`&, for example, a
10698 byte value 127 is converted to &`\x7f`&.
10699
10700
10701 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10702 .cindex "&%ipv6denorm%& expansion item"
10703 .cindex "IP address" normalisation
10704 This expands an IPv6 address to a full eight-element colon-separated set
10705 of hex digits including leading zeroes.
10706 A trailing ipv4-style dotted-decimal set is converted to hex.
10707 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10708
10709 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10710 .cindex "&%ipv6norm%& expansion item"
10711 .cindex "IP address" normalisation
10712 .cindex "IP address" "canonical form"
10713 This converts an IPv6 address to canonical form.
10714 Leading zeroes of groups are omitted, and the longest
10715 set of zero-valued groups is replaced with a double colon.
10716 A trailing ipv4-style dotted-decimal set is converted to hex.
10717 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10718
10719
10720 .vitem &*${lc:*&<&'string'&>&*}*&
10721 .cindex "case forcing in strings"
10722 .cindex "string" "case forcing"
10723 .cindex "lower casing"
10724 .cindex "expansion" "case forcing"
10725 .cindex "&%lc%& expansion item"
10726 This forces the letters in the string into lower-case, for example:
10727 .code
10728 ${lc:$local_part}
10729 .endd
10730 Case is defined per the system C locale.
10731
10732 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10733 .cindex "expansion" "string truncation"
10734 .cindex "&%length%& expansion item"
10735 The &%length%& operator is a simpler interface to the &%length%& function that
10736 can be used when the parameter is a fixed number (as opposed to a string that
10737 changes when expanded). The effect is the same as
10738 .code
10739 ${length{<number>}{<string>}}
10740 .endd
10741 See the description of the general &%length%& item above for details. Note that
10742 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10743 when &%length%& is used as an operator.
10744 All measurement is done in bytes and is not UTF-8 aware.
10745
10746
10747 .vitem &*${listcount:*&<&'string'&>&*}*&
10748 .cindex "expansion" "list item count"
10749 .cindex "list" "item count"
10750 .cindex "list" "count of items"
10751 .cindex "&%listcount%& expansion item"
10752 The string is interpreted as a list and the number of items is returned.
10753
10754
10755 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10756 .cindex "expansion" "named list"
10757 .cindex "&%listnamed%& expansion item"
10758 The name is interpreted as a named list and the content of the list is returned,
10759 expanding any referenced lists, re-quoting as needed for colon-separation.
10760 If the optional type is given it must be one of "a", "d", "h" or "l"
10761 and selects address-, domain-, host- or localpart- lists to search among respectively.
10762 Otherwise all types are searched in an undefined order and the first
10763 matching list is returned.
10764
10765
10766 .vitem &*${local_part:*&<&'string'&>&*}*&
10767 .cindex "expansion" "local part extraction"
10768 .cindex "&%local_part%& expansion item"
10769 The string is interpreted as an RFC 2822 address and the local part is
10770 extracted from it. If the string does not parse successfully, the result is
10771 empty.
10772 The parsing correctly handles SMTPUTF8 Unicode in the string.
10773
10774
10775 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10776 .cindex "masked IP address"
10777 .cindex "IP address" "masking"
10778 .cindex "CIDR notation"
10779 .cindex "expansion" "IP address masking"
10780 .cindex "&%mask%& expansion item"
10781 If the form of the string to be operated on is not an IP address followed by a
10782 slash and an integer (that is, a network address in CIDR notation), the
10783 expansion fails. Otherwise, this operator converts the IP address to binary,
10784 masks off the least significant bits according to the bit count, and converts
10785 the result back to text, with mask appended. For example,
10786 .code
10787 ${mask:10.111.131.206/28}
10788 .endd
10789 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10790 be mostly used for looking up masked addresses in files, the result for an IPv6
10791 address uses dots to separate components instead of colons, because colon
10792 terminates a key string in lsearch files. So, for example,
10793 .code
10794 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10795 .endd
10796 returns the string
10797 .code
10798 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10799 .endd
10800 Letters in IPv6 addresses are always output in lower case.
10801
10802
10803 .vitem &*${md5:*&<&'string'&>&*}*&
10804 .cindex "MD5 hash"
10805 .cindex "expansion" "MD5 hash"
10806 .cindex certificate fingerprint
10807 .cindex "&%md5%& expansion item"
10808 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10809 as a 32-digit hexadecimal number, in which any letters are in lower case.
10810
10811 If the string is a single variable of type certificate,
10812 returns the MD5 hash fingerprint of the certificate.
10813
10814
10815 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10816 .cindex "expansion" "numeric hash"
10817 .cindex "hash function" "numeric"
10818 The &%nhash%& operator is a simpler interface to the numeric hashing function
10819 that can be used when the two parameters are fixed numbers (as opposed to
10820 strings that change when expanded). The effect is the same as
10821 .code
10822 ${nhash{<n>}{<m>}{<string>}}
10823 .endd
10824 See the description of the general &%nhash%& item above for details.
10825
10826
10827 .vitem &*${quote:*&<&'string'&>&*}*&
10828 .cindex "quoting" "in string expansions"
10829 .cindex "expansion" "quoting"
10830 .cindex "&%quote%& expansion item"
10831 The &%quote%& operator puts its argument into double quotes if it
10832 is an empty string or
10833 contains anything other than letters, digits, underscores, dots, and hyphens.
10834 Any occurrences of double quotes and backslashes are escaped with a backslash.
10835 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10836 respectively For example,
10837 .code
10838 ${quote:ab"*"cd}
10839 .endd
10840 becomes
10841 .code
10842 "ab\"*\"cd"
10843 .endd
10844 The place where this is useful is when the argument is a substitution from a
10845 variable or a message header.
10846
10847 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10848 .cindex "&%quote_local_part%& expansion item"
10849 This operator is like &%quote%&, except that it quotes the string only if
10850 required to do so by the rules of RFC 2822 for quoting local parts. For
10851 example, a plus sign would not cause quoting (but it would for &%quote%&).
10852 If you are creating a new email address from the contents of &$local_part$&
10853 (or any other unknown data), you should always use this operator.
10854
10855 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10856 will likely use the quoting form.
10857 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10858
10859
10860 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10861 .cindex "quoting" "lookup-specific"
10862 This operator applies lookup-specific quoting rules to the string. Each
10863 query-style lookup type has its own quoting rules which are described with
10864 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10865 .code
10866 ${quote_ldap:two * two}
10867 .endd
10868 returns
10869 .code
10870 two%20%5C2A%20two
10871 .endd
10872 For single-key lookup types, no quoting is ever necessary and this operator
10873 yields an unchanged string.
10874
10875
10876 .vitem &*${randint:*&<&'n'&>&*}*&
10877 .cindex "random number"
10878 This operator returns a somewhat random number which is less than the
10879 supplied number and is at least 0.  The quality of this randomness depends
10880 on how Exim was built; the values are not suitable for keying material.
10881 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10882 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10883 for versions of GnuTLS with that function.
10884 Otherwise, the implementation may be arc4random(), random() seeded by
10885 srandomdev() or srandom(), or a custom implementation even weaker than
10886 random().
10887
10888
10889 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10890 .cindex "expansion" "IP address"
10891 This operator reverses an IP address; for IPv4 addresses, the result is in
10892 dotted-quad decimal form, while for IPv6 addresses the result is in
10893 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10894 for DNS.  For example,
10895 .code
10896 ${reverse_ip:192.0.2.4}
10897 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10898 .endd
10899 returns
10900 .code
10901 4.2.0.192
10902 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
10903 .endd
10904
10905
10906 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10907 .cindex "expansion" "RFC 2047"
10908 .cindex "RFC 2047" "expansion operator"
10909 .cindex "&%rfc2047%& expansion item"
10910 This operator encodes text according to the rules of RFC 2047. This is an
10911 encoding that is used in header lines to encode non-ASCII characters. It is
10912 assumed that the input string is in the encoding specified by the
10913 &%headers_charset%& option, which gets its default at build time. If the string
10914 contains only characters in the range 33&--126, and no instances of the
10915 characters
10916 .code
10917 ? = ( ) < > @ , ; : \ " . [ ] _
10918 .endd
10919 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10920 string, using as many &"encoded words"& as necessary to encode all the
10921 characters.
10922
10923
10924 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10925 .cindex "expansion" "RFC 2047"
10926 .cindex "RFC 2047" "decoding"
10927 .cindex "&%rfc2047d%& expansion item"
10928 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10929 bytes are replaced by question marks. Characters are converted into the
10930 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10931 not recognized unless &%check_rfc2047_length%& is set false.
10932
10933 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10934 access a header line, RFC 2047 decoding is done automatically. You do not need
10935 to use this operator as well.
10936
10937
10938
10939 .vitem &*${rxquote:*&<&'string'&>&*}*&
10940 .cindex "quoting" "in regular expressions"
10941 .cindex "regular expressions" "quoting"
10942 .cindex "&%rxquote%& expansion item"
10943 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10944 characters in its argument. This is useful when substituting the values of
10945 variables or headers inside regular expressions.
10946
10947
10948 .vitem &*${sha1:*&<&'string'&>&*}*&
10949 .cindex "SHA-1 hash"
10950 .cindex "expansion" "SHA-1 hashing"
10951 .cindex certificate fingerprint
10952 .cindex "&%sha1%& expansion item"
10953 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10954 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10955
10956 If the string is a single variable of type certificate,
10957 returns the SHA-1 hash fingerprint of the certificate.
10958
10959
10960 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
10961        &*${sha2:*&<&'string'&>&*}*& &&&
10962        &*${sha2_<n>:*&<&'string'&>&*}*&
10963 .cindex "SHA-256 hash"
10964 .cindex "SHA-2 hash"
10965 .cindex certificate fingerprint
10966 .cindex "expansion" "SHA-256 hashing"
10967 .cindex "&%sha256%& expansion item"
10968 .cindex "&%sha2%& expansion item"
10969 The &%sha256%& operator computes the SHA-256 hash value of the string
10970 and returns
10971 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10972
10973 If the string is a single variable of type certificate,
10974 returns the SHA-256 hash fingerprint of the certificate.
10975
10976 .new
10977 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
10978 (except for certificates, which are not supported).
10979 Finally, if an underbar
10980 and a number is appended it specifies the output length, selecting a
10981 member of the SHA-2 family of hash functions.
10982 Values of 256, 384 and 512 are accepted, with 256 being the default.
10983 .wen
10984
10985
10986 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10987        &*${sha3_<n>:*&<&'string'&>&*}*&
10988 .cindex "SHA3 hash"
10989 .cindex "expansion" "SHA3 hashing"
10990 .cindex "&%sha3%& expansion item"
10991 The &%sha3%& operator computes the SHA3-256 hash value of the string
10992 and returns
10993 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10994
10995 If a number is appended, separated by an underbar, it specifies
10996 the output length.  Values of 224, 256, 384 and 512 are accepted;
10997 with 256 being the default.
10998
10999 The &%sha3%& expansion item is only supported if Exim has been
11000 compiled with GnuTLS 3.5.0 or later,
11001 or OpenSSL 1.1.1 or later.
11002 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11003
11004
11005 .vitem &*${stat:*&<&'string'&>&*}*&
11006 .cindex "expansion" "statting a file"
11007 .cindex "file" "extracting characteristics"
11008 .cindex "&%stat%& expansion item"
11009 The string, after expansion, must be a file path. A call to the &[stat()]&
11010 function is made for this path. If &[stat()]& fails, an error occurs and the
11011 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11012 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11013 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11014 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11015 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11016 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11017 can extract individual fields using the &%extract%& expansion item.
11018
11019 The use of the &%stat%& expansion in users' filter files can be locked out by
11020 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11021 systems for files larger than 2GB.
11022
11023 .vitem &*${str2b64:*&<&'string'&>&*}*&
11024 .cindex "&%str2b64%& expansion item"
11025 Now deprecated, a synonym for the &%base64%& expansion operator.
11026
11027
11028
11029 .vitem &*${strlen:*&<&'string'&>&*}*&
11030 .cindex "expansion" "string length"
11031 .cindex "string" "length in expansion"
11032 .cindex "&%strlen%& expansion item"
11033 The item is replace by the length of the expanded string, expressed as a
11034 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11035 All measurement is done in bytes and is not UTF-8 aware.
11036
11037
11038 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11039 .cindex "&%substr%& expansion item"
11040 .cindex "substring extraction"
11041 .cindex "expansion" "substring expansion"
11042 The &%substr%& operator is a simpler interface to the &%substr%& function that
11043 can be used when the two parameters are fixed numbers (as opposed to strings
11044 that change when expanded). The effect is the same as
11045 .code
11046 ${substr{<start>}{<length>}{<string>}}
11047 .endd
11048 See the description of the general &%substr%& item above for details. The
11049 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11050 All measurement is done in bytes and is not UTF-8 aware.
11051
11052 .vitem &*${time_eval:*&<&'string'&>&*}*&
11053 .cindex "&%time_eval%& expansion item"
11054 .cindex "time interval" "decoding"
11055 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11056 seconds.
11057
11058 .vitem &*${time_interval:*&<&'string'&>&*}*&
11059 .cindex "&%time_interval%& expansion item"
11060 .cindex "time interval" "formatting"
11061 The argument (after sub-expansion) must be a sequence of decimal digits that
11062 represents an interval of time as a number of seconds. It is converted into a
11063 number of larger units and output in Exim's normal time format, for example,
11064 &`1w3d4h2m6s`&.
11065
11066 .vitem &*${uc:*&<&'string'&>&*}*&
11067 .cindex "case forcing in strings"
11068 .cindex "string" "case forcing"
11069 .cindex "upper casing"
11070 .cindex "expansion" "case forcing"
11071 .cindex "&%uc%& expansion item"
11072 This forces the letters in the string into upper-case.
11073 Case is defined per the system C locale.
11074
11075 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11076 .cindex "correction of invalid utf-8 sequences in strings"
11077 .cindex "utf-8" "utf-8 sequences"
11078 .cindex "incorrect utf-8"
11079 .cindex "expansion" "utf-8 forcing"
11080 .cindex "&%utf8clean%& expansion item"
11081 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11082 In versions of Exim before 4.92, this did not correctly do so for a truncated
11083 final codepoint's encoding, and the character would be silently dropped.
11084 If you must handle detection of this scenario across both sets of Exim behavior,
11085 the complexity will depend upon the task.
11086 For instance, to detect if the first character is multibyte and a 1-byte
11087 extraction can be successfully used as a path component (as is common for
11088 dividing up delivery folders), you might use:
11089 .code
11090 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11091 .endd
11092 (which will false-positive if the first character of the local part is a
11093 literal question mark).
11094
11095 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11096        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11097        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11098        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11099 .cindex expansion UTF-8
11100 .cindex UTF-8 expansion
11101 .cindex EAI
11102 .cindex internationalisation
11103 .cindex "&%utf8_domain_to_alabel%& expansion item"
11104 .cindex "&%utf8_domain_from_alabel%& expansion item"
11105 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11106 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11107 These convert EAI mail name components between UTF-8 and a-label forms.
11108 For information on internationalisation support see &<<SECTi18nMTA>>&.
11109 .endlist
11110
11111
11112
11113
11114
11115
11116 .section "Expansion conditions" "SECTexpcond"
11117 .scindex IIDexpcond "expansion" "conditions"
11118 The following conditions are available for testing by the &%${if%& construct
11119 while expanding strings:
11120
11121 .vlist
11122 .vitem &*!*&<&'condition'&>
11123 .cindex "expansion" "negating a condition"
11124 .cindex "negation" "in expansion condition"
11125 Preceding any condition with an exclamation mark negates the result of the
11126 condition.
11127
11128 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11129 .cindex "numeric comparison"
11130 .cindex "expansion" "numeric comparison"
11131 There are a number of symbolic operators for doing numeric comparisons. They
11132 are:
11133 .display
11134 &`=   `&   equal
11135 &`==  `&   equal
11136 &`>   `&   greater
11137 &`>=  `&   greater or equal
11138 &`<   `&   less
11139 &`<=  `&   less or equal
11140 .endd
11141 For example:
11142 .code
11143 ${if >{$message_size}{10M} ...
11144 .endd
11145 Note that the general negation operator provides for inequality testing. The
11146 two strings must take the form of optionally signed decimal integers,
11147 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11148 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11149 As a special case, the numerical value of an empty string is taken as
11150 zero.
11151
11152 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11153 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11154 10M, not if 10M is larger than &$message_size$&.
11155
11156
11157 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11158         {*&<&'arg2'&>&*}...}*&
11159 .cindex "expansion" "calling an acl"
11160 .cindex "&%acl%&" "expansion condition"
11161 The name and zero to nine argument strings are first expanded separately.  The expanded
11162 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11163 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11164 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11165 and may use the variables; if another acl expansion is used the values
11166 are restored after it returns.  If the ACL sets
11167 a value using a "message =" modifier the variable $value becomes
11168 the result of the expansion, otherwise it is empty.
11169 If the ACL returns accept the condition is true; if deny, false.
11170 If the ACL returns defer the result is a forced-fail.
11171
11172 .vitem &*bool&~{*&<&'string'&>&*}*&
11173 .cindex "expansion" "boolean parsing"
11174 .cindex "&%bool%& expansion condition"
11175 This condition turns a string holding a true or false representation into
11176 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11177 (case-insensitively); also integer numbers map to true if non-zero,
11178 false if zero.
11179 An empty string is treated as false.
11180 Leading and trailing whitespace is ignored;
11181 thus a string consisting only of whitespace is false.
11182 All other string values will result in expansion failure.
11183
11184 When combined with ACL variables, this expansion condition will let you
11185 make decisions in one place and act on those decisions in another place.
11186 For example:
11187 .code
11188 ${if bool{$acl_m_privileged_sender} ...
11189 .endd
11190
11191
11192 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11193 .cindex "expansion" "boolean parsing"
11194 .cindex "&%bool_lax%& expansion condition"
11195 Like &%bool%&, this condition turns a string into a boolean state.  But
11196 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11197 loose definition that the Router &%condition%& option uses.  The empty string
11198 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11199 true.  Leading and trailing whitespace is ignored.
11200
11201 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11202
11203 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11204 .cindex "expansion" "encrypted comparison"
11205 .cindex "encrypted strings, comparing"
11206 .cindex "&%crypteq%& expansion condition"
11207 This condition is included in the Exim binary if it is built to support any
11208 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11209 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11210 included in the binary.
11211
11212 The &%crypteq%& condition has two arguments. The first is encrypted and
11213 compared against the second, which is already encrypted. The second string may
11214 be in the LDAP form for storing encrypted strings, which starts with the
11215 encryption type in curly brackets, followed by the data. If the second string
11216 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11217 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11218 Typically this will be a field from a password file. An example of an encrypted
11219 string in LDAP form is:
11220 .code
11221 {md5}CY9rzUYh03PK3k6DJie09g==
11222 .endd
11223 If such a string appears directly in an expansion, the curly brackets have to
11224 be quoted, because they are part of the expansion syntax. For example:
11225 .code
11226 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11227 .endd
11228 The following encryption types (whose names are matched case-independently) are
11229 supported:
11230
11231 .ilist
11232 .cindex "MD5 hash"
11233 .cindex "base64 encoding" "in encrypted password"
11234 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11235 printable characters to compare with the remainder of the second string. If the
11236 length of the comparison string is 24, Exim assumes that it is base64 encoded
11237 (as in the above example). If the length is 32, Exim assumes that it is a
11238 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11239 comparison fails.
11240
11241 .next
11242 .cindex "SHA-1 hash"
11243 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11244 printable characters to compare with the remainder of the second string. If the
11245 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11246 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11247 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11248
11249 .next
11250 .cindex "&[crypt()]&"
11251 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11252 only the first eight characters of the password. However, in modern operating
11253 systems this is no longer true, and in many cases the entire password is used,
11254 whatever its length.
11255
11256 .next
11257 .cindex "&[crypt16()]&"
11258 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11259 use up to 16 characters of the password in some operating systems. Again, in
11260 modern operating systems, more characters may be used.
11261 .endlist
11262 Exim has its own version of &[crypt16()]&, which is just a double call to
11263 &[crypt()]&. For operating systems that have their own version, setting
11264 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11265 operating system version instead of its own. This option is set by default in
11266 the OS-dependent &_Makefile_& for those operating systems that are known to
11267 support &[crypt16()]&.
11268
11269 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11270 it was not using the same algorithm as some operating systems' versions. It
11271 turns out that as well as &[crypt16()]& there is a function called
11272 &[bigcrypt()]& in some operating systems. This may or may not use the same
11273 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11274
11275 However, since there is now a move away from the traditional &[crypt()]&
11276 functions towards using SHA1 and other algorithms, tidying up this area of
11277 Exim is seen as very low priority.
11278
11279 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11280 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11281 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11282 default is &`{crypt}`&. Whatever the default, you can always use either
11283 function by specifying it explicitly in curly brackets.
11284
11285 .vitem &*def:*&<&'variable&~name'&>
11286 .cindex "expansion" "checking for empty variable"
11287 .cindex "&%def%& expansion condition"
11288 The &%def%& condition must be followed by the name of one of the expansion
11289 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11290 variable does not contain the empty string. For example:
11291 .code
11292 ${if def:sender_ident {from $sender_ident}}
11293 .endd
11294 Note that the variable name is given without a leading &%$%& character. If the
11295 variable does not exist, the expansion fails.
11296
11297 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11298         &~&*def:h_*&<&'header&~name'&>&*:*&"
11299 .cindex "expansion" "checking header line existence"
11300 This condition is true if a message is being processed and the named header
11301 exists in the message. For example,
11302 .code
11303 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11304 .endd
11305 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11306 the header name must be terminated by a colon if white space does not follow.
11307
11308 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11309        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11310 .cindex "string" "comparison"
11311 .cindex "expansion" "string comparison"
11312 .cindex "&%eq%& expansion condition"
11313 .cindex "&%eqi%& expansion condition"
11314 The two substrings are first expanded. The condition is true if the two
11315 resulting strings are identical. For &%eq%& the comparison includes the case of
11316 letters, whereas for &%eqi%& the comparison is case-independent, where
11317 case is defined per the system C locale.
11318
11319 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11320 .cindex "expansion" "file existence test"
11321 .cindex "file" "existence test"
11322 .cindex "&%exists%&, expansion condition"
11323 The substring is first expanded and then interpreted as an absolute path. The
11324 condition is true if the named file (or directory) exists. The existence test
11325 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11326 users' filter files may be locked out by the system administrator.
11327
11328 .vitem &*first_delivery*&
11329 .cindex "delivery" "first"
11330 .cindex "first delivery"
11331 .cindex "expansion" "first delivery test"
11332 .cindex "&%first_delivery%& expansion condition"
11333 This condition, which has no data, is true during a message's first delivery
11334 attempt. It is false during any subsequent delivery attempts.
11335
11336
11337 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11338        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11339 .cindex "list" "iterative conditions"
11340 .cindex "expansion" "&*forall*& condition"
11341 .cindex "expansion" "&*forany*& condition"
11342 .vindex "&$item$&"
11343 These conditions iterate over a list. The first argument is expanded to form
11344 the list. By default, the list separator is a colon, but it can be changed by
11345 the normal method (&<<SECTlistsepchange>>&).
11346 The second argument is interpreted as a condition that is to
11347 be applied to each item in the list in turn. During the interpretation of the
11348 condition, the current list item is placed in a variable called &$item$&.
11349 .ilist
11350 For &*forany*&, interpretation stops if the condition is true for any item, and
11351 the result of the whole condition is true. If the condition is false for all
11352 items in the list, the overall condition is false.
11353 .next
11354 For &*forall*&, interpretation stops if the condition is false for any item,
11355 and the result of the whole condition is false. If the condition is true for
11356 all items in the list, the overall condition is true.
11357 .endlist
11358 Note that negation of &*forany*& means that the condition must be false for all
11359 items for the overall condition to succeed, and negation of &*forall*& means
11360 that the condition must be false for at least one item. In this example, the
11361 list separator is changed to a comma:
11362 .code
11363 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11364 .endd
11365 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
11366 being processed, to enable these expansion items to be nested.
11367
11368 To scan a named list, expand it with the &*listnamed*& operator.
11369
11370 .new
11371 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11372        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11373        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11374        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11375 .cindex JSON "iterative conditions"
11376 .cindex JSON expansions
11377 .cindex expansion "&*forall_json*& condition"
11378 .cindex expansion "&*forany_json*& condition"
11379 .cindex expansion "&*forall_jsons*& condition"
11380 .cindex expansion "&*forany_jsons*& condition"
11381 As for the above, except that the first argument must, after expansion,
11382 be a JSON array.
11383 The array separator is not changeable.
11384 For the &"jsons"& variants the elements are expected to be JSON strings
11385 and have their quotes removed before the evaluation of the condition.
11386 .wen
11387
11388
11389
11390 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11391        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11392 .cindex "string" "comparison"
11393 .cindex "expansion" "string comparison"
11394 .cindex "&%ge%& expansion condition"
11395 .cindex "&%gei%& expansion condition"
11396 The two substrings are first expanded. The condition is true if the first
11397 string is lexically greater than or equal to the second string. For &%ge%& the
11398 comparison includes the case of letters, whereas for &%gei%& the comparison is
11399 case-independent.
11400 Case and collation order are defined per the system C locale.
11401
11402 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11403        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11404 .cindex "string" "comparison"
11405 .cindex "expansion" "string comparison"
11406 .cindex "&%gt%& expansion condition"
11407 .cindex "&%gti%& expansion condition"
11408 The two substrings are first expanded. The condition is true if the first
11409 string is lexically greater than the second string. For &%gt%& the comparison
11410 includes the case of letters, whereas for &%gti%& the comparison is
11411 case-independent.
11412 Case and collation order are defined per the system C locale.
11413
11414 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11415        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11416 .cindex "string" "comparison"
11417 .cindex "list" "iterative conditions"
11418 Both strings are expanded; the second string is treated as a list of simple
11419 strings; if the first string is a member of the second, then the condition
11420 is true.
11421 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11422
11423 These are simpler to use versions of the more powerful &*forany*& condition.
11424 Examples, and the &*forany*& equivalents:
11425 .code
11426 ${if inlist{needle}{foo:needle:bar}}
11427   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11428 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11429   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11430 .endd
11431
11432 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11433        &*isip4&~{*&<&'string'&>&*}*& &&&
11434        &*isip6&~{*&<&'string'&>&*}*&
11435 .cindex "IP address" "testing string format"
11436 .cindex "string" "testing for IP address"
11437 .cindex "&%isip%& expansion condition"
11438 .cindex "&%isip4%& expansion condition"
11439 .cindex "&%isip6%& expansion condition"
11440 The substring is first expanded, and then tested to see if it has the form of
11441 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11442 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11443
11444 For an IPv4 address, the test is for four dot-separated components, each of
11445 which consists of from one to three digits. For an IPv6 address, up to eight
11446 colon-separated components are permitted, each containing from one to four
11447 hexadecimal digits. There may be fewer than eight components if an empty
11448 component (adjacent colons) is present. Only one empty component is permitted.
11449
11450 &*Note*&: The checks used to be just on the form of the address; actual numerical
11451 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11452 check.
11453 This is no longer the case.
11454
11455 The main use of these tests is to distinguish between IP addresses and
11456 host names, or between IPv4 and IPv6 addresses. For example, you could use
11457 .code
11458 ${if isip4{$sender_host_address}...
11459 .endd
11460 to test which IP version an incoming SMTP connection is using.
11461
11462 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11463 .cindex "LDAP" "use for authentication"
11464 .cindex "expansion" "LDAP authentication test"
11465 .cindex "&%ldapauth%& expansion condition"
11466 This condition supports user authentication using LDAP. See section
11467 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11468 queries. For this use, the query must contain a user name and password. The
11469 query itself is not used, and can be empty. The condition is true if the
11470 password is not empty, and the user name and password are accepted by the LDAP
11471 server. An empty password is rejected without calling LDAP because LDAP binds
11472 with an empty password are considered anonymous regardless of the username, and
11473 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11474 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11475 this can be used.
11476
11477
11478 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11479        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11480 .cindex "string" "comparison"
11481 .cindex "expansion" "string comparison"
11482 .cindex "&%le%& expansion condition"
11483 .cindex "&%lei%& expansion condition"
11484 The two substrings are first expanded. The condition is true if the first
11485 string is lexically less than or equal to the second string. For &%le%& the
11486 comparison includes the case of letters, whereas for &%lei%& the comparison is
11487 case-independent.
11488 Case and collation order are defined per the system C locale.
11489
11490 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11491        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11492 .cindex "string" "comparison"
11493 .cindex "expansion" "string comparison"
11494 .cindex "&%lt%& expansion condition"
11495 .cindex "&%lti%& expansion condition"
11496 The two substrings are first expanded. The condition is true if the first
11497 string is lexically less than the second string. For &%lt%& the comparison
11498 includes the case of letters, whereas for &%lti%& the comparison is
11499 case-independent.
11500 Case and collation order are defined per the system C locale.
11501
11502
11503 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11504 .cindex "expansion" "regular expression comparison"
11505 .cindex "regular expressions" "match in expanded string"
11506 .cindex "&%match%& expansion condition"
11507 The two substrings are first expanded. The second is then treated as a regular
11508 expression and applied to the first. Because of the pre-expansion, if the
11509 regular expression contains dollar, or backslash characters, they must be
11510 escaped. Care must also be taken if the regular expression contains braces
11511 (curly brackets). A closing brace must be escaped so that it is not taken as a
11512 premature termination of <&'string2'&>. The easiest approach is to use the
11513 &`\N`& feature to disable expansion of the regular expression.
11514 For example,
11515 .code
11516 ${if match {$local_part}{\N^\d{3}\N} ...
11517 .endd
11518 If the whole expansion string is in double quotes, further escaping of
11519 backslashes is also required.
11520
11521 The condition is true if the regular expression match succeeds.
11522 The regular expression is not required to begin with a circumflex
11523 metacharacter, but if there is no circumflex, the expression is not anchored,
11524 and it may match anywhere in the subject, not just at the start. If you want
11525 the pattern to match at the end of the subject, you must include the &`$`&
11526 metacharacter at an appropriate point.
11527 All character handling is done in bytes and is not UTF-8 aware,
11528 but we might change this in a future Exim release.
11529
11530 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11531 At the start of an &%if%& expansion the values of the numeric variable
11532 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11533 succeeds causes them to be reset to the substrings of that condition and they
11534 will have these values during the expansion of the success string. At the end
11535 of the &%if%& expansion, the previous values are restored. After testing a
11536 combination of conditions using &%or%&, the subsequent values of the numeric
11537 variables are those of the condition that succeeded.
11538
11539 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11540 .cindex "&%match_address%& expansion condition"
11541 See &*match_local_part*&.
11542
11543 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11544 .cindex "&%match_domain%& expansion condition"
11545 See &*match_local_part*&.
11546
11547 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11548 .cindex "&%match_ip%& expansion condition"
11549 This condition matches an IP address to a list of IP address patterns. It must
11550 be followed by two argument strings. The first (after expansion) must be an IP
11551 address or an empty string. The second (not expanded) is a restricted host
11552 list that can match only an IP address, not a host name. For example:
11553 .code
11554 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11555 .endd
11556 The specific types of host list item that are permitted in the list are:
11557
11558 .ilist
11559 An IP address, optionally with a CIDR mask.
11560 .next
11561 A single asterisk, which matches any IP address.
11562 .next
11563 An empty item, which matches only if the IP address is empty. This could be
11564 useful for testing for a locally submitted message or one from specific hosts
11565 in a single test such as
11566 . ==== As this is a nested list, any displays it contains must be indented
11567 . ==== as otherwise they are too far to the left. This comment applies to
11568 . ==== the use of xmlto plus fop. There's no problem when formatting with
11569 . ==== sdop, with or without the extra indent.
11570 .code
11571   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11572 .endd
11573 where the first item in the list is the empty string.
11574 .next
11575 The item @[] matches any of the local host's interface addresses.
11576 .next
11577 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11578 even if &`net-`& is not specified. There is never any attempt to turn the IP
11579 address into a host name. The most common type of linear search for
11580 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11581 masks. For example:
11582 .code
11583   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11584 .endd
11585 It is of course possible to use other kinds of lookup, and in such a case, you
11586 do need to specify the &`net-`& prefix if you want to specify a specific
11587 address mask, for example:
11588 .code
11589   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11590 .endd
11591 However, unless you are combining a &%match_ip%& condition with others, it is
11592 just as easy to use the fact that a lookup is itself a condition, and write:
11593 .code
11594   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11595 .endd
11596 .endlist ilist
11597
11598 Note that <&'string2'&> is not itself subject to string expansion, unless
11599 Exim was built with the EXPAND_LISTMATCH_RHS option.
11600
11601 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11602
11603 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11604 .cindex "domain list" "in expansion condition"
11605 .cindex "address list" "in expansion condition"
11606 .cindex "local part" "list, in expansion condition"
11607 .cindex "&%match_local_part%& expansion condition"
11608 This condition, together with &%match_address%& and &%match_domain%&, make it
11609 possible to test domain, address, and local part lists within expansions. Each
11610 condition requires two arguments: an item and a list to match. A trivial
11611 example is:
11612 .code
11613 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11614 .endd
11615 In each case, the second argument may contain any of the allowable items for a
11616 list of the appropriate type. Also, because the second argument
11617 is a standard form of list, it is possible to refer to a named list.
11618 Thus, you can use conditions like this:
11619 .code
11620 ${if match_domain{$domain}{+local_domains}{...
11621 .endd
11622 .cindex "&`+caseful`&"
11623 For address lists, the matching starts off caselessly, but the &`+caseful`&
11624 item can be used, as in all address lists, to cause subsequent items to
11625 have their local parts matched casefully. Domains are always matched
11626 caselessly.
11627
11628 Note that <&'string2'&> is not itself subject to string expansion, unless
11629 Exim was built with the EXPAND_LISTMATCH_RHS option.
11630
11631 &*Note*&: Host lists are &'not'& supported in this way. This is because
11632 hosts have two identities: a name and an IP address, and it is not clear
11633 how to specify cleanly how such a test would work. However, IP addresses can be
11634 matched using &%match_ip%&.
11635
11636 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11637 .cindex "PAM authentication"
11638 .cindex "AUTH" "with PAM"
11639 .cindex "Solaris" "PAM support"
11640 .cindex "expansion" "PAM authentication test"
11641 .cindex "&%pam%& expansion condition"
11642 &'Pluggable Authentication Modules'&
11643 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11644 available in the latest releases of Solaris and in some GNU/Linux
11645 distributions. The Exim support, which is intended for use in conjunction with
11646 the SMTP AUTH command, is available only if Exim is compiled with
11647 .code
11648 SUPPORT_PAM=yes
11649 .endd
11650 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11651 in some releases of GNU/Linux &%-ldl%& is also needed.
11652
11653 The argument string is first expanded, and the result must be a
11654 colon-separated list of strings. Leading and trailing white space is ignored.
11655 The PAM module is initialized with the service name &"exim"& and the user name
11656 taken from the first item in the colon-separated data string (<&'string1'&>).
11657 The remaining items in the data string are passed over in response to requests
11658 from the authentication function. In the simple case there will only be one
11659 request, for a password, so the data consists of just two strings.
11660
11661 There can be problems if any of the strings are permitted to contain colon
11662 characters. In the usual way, these have to be doubled to avoid being taken as
11663 separators. If the data is being inserted from a variable, the &%sg%& expansion
11664 item can be used to double any existing colons. For example, the configuration
11665 of a LOGIN authenticator might contain this setting:
11666 .code
11667 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11668 .endd
11669 For a PLAIN authenticator you could use:
11670 .code
11671 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11672 .endd
11673 In some operating systems, PAM authentication can be done only from a process
11674 running as root. Since Exim is running as the Exim user when receiving
11675 messages, this means that PAM cannot be used directly in those systems.
11676 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11677
11678
11679 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11680 .cindex "&'pwcheck'& daemon"
11681 .cindex "Cyrus"
11682 .cindex "expansion" "&'pwcheck'& authentication test"
11683 .cindex "&%pwcheck%& expansion condition"
11684 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11685 This is one way of making it possible for passwords to be checked by a process
11686 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11687 deprecated. Its replacement is &'saslauthd'& (see below).
11688
11689 The pwcheck support is not included in Exim by default. You need to specify
11690 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11691 building Exim. For example:
11692 .code
11693 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11694 .endd
11695 You do not need to install the full Cyrus software suite in order to use
11696 the pwcheck daemon. You can compile and install just the daemon alone
11697 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11698 access to the &_/var/pwcheck_& directory.
11699
11700 The &%pwcheck%& condition takes one argument, which must be the user name and
11701 password, separated by a colon. For example, in a LOGIN authenticator
11702 configuration, you might have this:
11703 .code
11704 server_condition = ${if pwcheck{$auth1:$auth2}}
11705 .endd
11706 Again, for a PLAIN authenticator configuration, this would be:
11707 .code
11708 server_condition = ${if pwcheck{$auth2:$auth3}}
11709 .endd
11710 .vitem &*queue_running*&
11711 .cindex "queue runner" "detecting when delivering from"
11712 .cindex "expansion" "queue runner test"
11713 .cindex "&%queue_running%& expansion condition"
11714 This condition, which has no data, is true during delivery attempts that are
11715 initiated by queue runner processes, and false otherwise.
11716
11717
11718 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11719 .cindex "Radius"
11720 .cindex "expansion" "Radius authentication"
11721 .cindex "&%radius%& expansion condition"
11722 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11723 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11724 the Radius client configuration file in order to build Exim with Radius
11725 support.
11726
11727 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11728 library, using the original API. If you are using release 0.4.0 or later of
11729 this library, you need to set
11730 .code
11731 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11732 .endd
11733 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11734 &%libradius%& library that comes with FreeBSD. To do this, set
11735 .code
11736 RADIUS_LIB_TYPE=RADLIB
11737 .endd
11738 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11739 You may also have to supply a suitable setting in EXTRALIBS so that the
11740 Radius library can be found when Exim is linked.
11741
11742 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11743 Radius client library, which calls the Radius server. The condition is true if
11744 the authentication is successful. For example:
11745 .code
11746 server_condition = ${if radius{<arguments>}}
11747 .endd
11748
11749
11750 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11751         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11752 .cindex "&'saslauthd'& daemon"
11753 .cindex "Cyrus"
11754 .cindex "expansion" "&'saslauthd'& authentication test"
11755 .cindex "&%saslauthd%& expansion condition"
11756 This condition supports user authentication using the Cyrus &'saslauthd'&
11757 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11758 Using this daemon is one way of making it possible for passwords to be checked
11759 by a process that is not running as root.
11760
11761 The saslauthd support is not included in Exim by default. You need to specify
11762 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11763 building Exim. For example:
11764 .code
11765 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11766 .endd
11767 You do not need to install the full Cyrus software suite in order to use
11768 the saslauthd daemon. You can compile and install just the daemon alone
11769 from the Cyrus SASL library.
11770
11771 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11772 two are mandatory. For example:
11773 .code
11774 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11775 .endd
11776 The service and the realm are optional (which is why the arguments are enclosed
11777 in their own set of braces). For details of the meaning of the service and
11778 realm, and how to run the daemon, consult the Cyrus documentation.
11779 .endlist vlist
11780
11781
11782
11783 .section "Combining expansion conditions" "SECID84"
11784 .cindex "expansion" "combining conditions"
11785 Several conditions can be tested at once by combining them using the &%and%&
11786 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11787 conditions on their own, and precede their lists of sub-conditions. Each
11788 sub-condition must be enclosed in braces within the overall braces that contain
11789 the list. No repetition of &%if%& is used.
11790
11791
11792 .vlist
11793 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11794 .cindex "&""or""& expansion condition"
11795 .cindex "expansion" "&""or""& of conditions"
11796 The sub-conditions are evaluated from left to right. The condition is true if
11797 any one of the sub-conditions is true.
11798 For example,
11799 .code
11800 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11801 .endd
11802 When a true sub-condition is found, the following ones are parsed but not
11803 evaluated. If there are several &"match"& sub-conditions the values of the
11804 numeric variables afterwards are taken from the first one that succeeds.
11805
11806 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11807 .cindex "&""and""& expansion condition"
11808 .cindex "expansion" "&""and""& of conditions"
11809 The sub-conditions are evaluated from left to right. The condition is true if
11810 all of the sub-conditions are true. If there are several &"match"&
11811 sub-conditions, the values of the numeric variables afterwards are taken from
11812 the last one. When a false sub-condition is found, the following ones are
11813 parsed but not evaluated.
11814 .endlist
11815 .ecindex IIDexpcond
11816
11817
11818
11819
11820 .section "Expansion variables" "SECTexpvar"
11821 .cindex "expansion" "variables, list of"
11822 This section contains an alphabetical list of all the expansion variables. Some
11823 of them are available only when Exim is compiled with specific options such as
11824 support for TLS or the content scanning extension.
11825
11826 .vlist
11827 .vitem "&$0$&, &$1$&, etc"
11828 .cindex "numerical variables (&$1$& &$2$& etc)"
11829 When a &%match%& expansion condition succeeds, these variables contain the
11830 captured substrings identified by the regular expression during subsequent
11831 processing of the success string of the containing &%if%& expansion item.
11832 In the expansion condition case
11833 they do not retain their values afterwards; in fact, their previous
11834 values are restored at the end of processing an &%if%& item. The numerical
11835 variables may also be set externally by some other matching process which
11836 precedes the expansion of the string. For example, the commands available in
11837 Exim filter files include an &%if%& command with its own regular expression
11838 matching condition.
11839
11840 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11841 Within an acl condition, expansion condition or expansion item
11842 any arguments are copied to these variables,
11843 any unused variables being made empty.
11844
11845 .vitem "&$acl_c...$&"
11846 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11847 can be given any name that starts with &$acl_c$& and is at least six characters
11848 long, but the sixth character must be either a digit or an underscore. For
11849 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11850 variables persist throughout the lifetime of an SMTP connection. They can be
11851 used to pass information between ACLs and between different invocations of the
11852 same ACL. When a message is received, the values of these variables are saved
11853 with the message, and can be accessed by filters, routers, and transports
11854 during subsequent delivery.
11855
11856 .vitem "&$acl_m...$&"
11857 These variables are like the &$acl_c...$& variables, except that their values
11858 are reset after a message has been received. Thus, if several messages are
11859 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11860 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11861 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11862 message is received, the values of these variables are saved with the message,
11863 and can be accessed by filters, routers, and transports during subsequent
11864 delivery.
11865
11866 .vitem &$acl_narg$&
11867 Within an acl condition, expansion condition or expansion item
11868 this variable has the number of arguments.
11869
11870 .vitem &$acl_verify_message$&
11871 .vindex "&$acl_verify_message$&"
11872 After an address verification has failed, this variable contains the failure
11873 message. It retains its value for use in subsequent modifiers. The message can
11874 be preserved by coding like this:
11875 .code
11876 warn !verify = sender
11877      set acl_m0 = $acl_verify_message
11878 .endd
11879 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11880 &%log_message%& modifiers, to include information about the verification
11881 failure.
11882
11883 .vitem &$address_data$&
11884 .vindex "&$address_data$&"
11885 This variable is set by means of the &%address_data%& option in routers. The
11886 value then remains with the address while it is processed by subsequent routers
11887 and eventually a transport. If the transport is handling multiple addresses,
11888 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11889 for more details. &*Note*&: The contents of &$address_data$& are visible in
11890 user filter files.
11891
11892 If &$address_data$& is set when the routers are called from an ACL to verify
11893 a recipient address, the final value is still in the variable for subsequent
11894 conditions and modifiers of the ACL statement. If routing the address caused it
11895 to be redirected to just one address, the child address is also routed as part
11896 of the verification, and in this case the final value of &$address_data$& is
11897 from the child's routing.
11898
11899 If &$address_data$& is set when the routers are called from an ACL to verify a
11900 sender address, the final value is also preserved, but this time in
11901 &$sender_address_data$&, to distinguish it from data from a recipient
11902 address.
11903
11904 In both cases (recipient and sender verification), the value does not persist
11905 after the end of the current ACL statement. If you want to preserve
11906 these values for longer, you can save them in ACL variables.
11907
11908 .vitem &$address_file$&
11909 .vindex "&$address_file$&"
11910 When, as a result of aliasing, forwarding, or filtering, a message is directed
11911 to a specific file, this variable holds the name of the file when the transport
11912 is running. At other times, the variable is empty. For example, using the
11913 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11914 .code
11915 /home/r2d2/savemail
11916 .endd
11917 then when the &(address_file)& transport is running, &$address_file$&
11918 contains the text string &`/home/r2d2/savemail`&.
11919 .cindex "Sieve filter" "value of &$address_file$&"
11920 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11921 then up to the transport configuration to generate an appropriate absolute path
11922 to the relevant file.
11923
11924 .vitem &$address_pipe$&
11925 .vindex "&$address_pipe$&"
11926 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11927 this variable holds the pipe command when the transport is running.
11928
11929 .vitem "&$auth1$& &-- &$auth3$&"
11930 .vindex "&$auth1$&, &$auth2$&, etc"
11931 These variables are used in SMTP authenticators (see chapters
11932 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11933
11934 .vitem &$authenticated_id$&
11935 .cindex "authentication" "id"
11936 .vindex "&$authenticated_id$&"
11937 When a server successfully authenticates a client it may be configured to
11938 preserve some of the authentication information in the variable
11939 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11940 user/password authenticator configuration might preserve the user name for use
11941 in the routers. Note that this is not the same information that is saved in
11942 &$sender_host_authenticated$&.
11943
11944 When a message is submitted locally (that is, not over a TCP connection)
11945 the value of &$authenticated_id$& is normally the login name of the calling
11946 process. However, a trusted user can override this by means of the &%-oMai%&
11947 command line option.
11948 This second case also sets up information used by the
11949 &$authresults$& expansion item.
11950
11951 .vitem &$authenticated_fail_id$&
11952 .cindex "authentication" "fail" "id"
11953 .vindex "&$authenticated_fail_id$&"
11954 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11955 will contain the failed authentication id. If more than one authentication
11956 id is attempted, it will contain only the last one. The variable is
11957 available for processing in the ACL's, generally the quit or notquit ACL.
11958 A message to a local recipient could still be accepted without requiring
11959 authentication, which means this variable could also be visible in all of
11960 the ACL's as well.
11961
11962
11963 .vitem &$authenticated_sender$&
11964 .cindex "sender" "authenticated"
11965 .cindex "authentication" "sender"
11966 .cindex "AUTH" "on MAIL command"
11967 .vindex "&$authenticated_sender$&"
11968 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11969 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11970 described in section &<<SECTauthparamail>>&. Unless the data is the string
11971 &"<>"&, it is set as the authenticated sender of the message, and the value is
11972 available during delivery in the &$authenticated_sender$& variable. If the
11973 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11974
11975 .vindex "&$qualify_domain$&"
11976 When a message is submitted locally (that is, not over a TCP connection), the
11977 value of &$authenticated_sender$& is an address constructed from the login
11978 name of the calling process and &$qualify_domain$&, except that a trusted user
11979 can override this by means of the &%-oMas%& command line option.
11980
11981
11982 .vitem &$authentication_failed$&
11983 .cindex "authentication" "failure"
11984 .vindex "&$authentication_failed$&"
11985 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11986 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11987 possible to distinguish between &"did not try to authenticate"&
11988 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11989 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11990 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11991 negative response to an AUTH command, including (for example) an attempt to use
11992 an undefined mechanism.
11993
11994 .vitem &$av_failed$&
11995 .cindex "content scanning" "AV scanner failure"
11996 This variable is available when Exim is compiled with the content-scanning
11997 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11998 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11999 the ACL malware condition.
12000
12001 .vitem &$body_linecount$&
12002 .cindex "message body" "line count"
12003 .cindex "body of message" "line count"
12004 .vindex "&$body_linecount$&"
12005 When a message is being received or delivered, this variable contains the
12006 number of lines in the message's body. See also &$message_linecount$&.
12007
12008 .vitem &$body_zerocount$&
12009 .cindex "message body" "binary zero count"
12010 .cindex "body of message" "binary zero count"
12011 .cindex "binary zero" "in message body"
12012 .vindex "&$body_zerocount$&"
12013 When a message is being received or delivered, this variable contains the
12014 number of binary zero bytes (ASCII NULs) in the message's body.
12015
12016 .vitem &$bounce_recipient$&
12017 .vindex "&$bounce_recipient$&"
12018 This is set to the recipient address of a bounce message while Exim is creating
12019 it. It is useful if a customized bounce message text file is in use (see
12020 chapter &<<CHAPemsgcust>>&).
12021
12022 .vitem &$bounce_return_size_limit$&
12023 .vindex "&$bounce_return_size_limit$&"
12024 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12025 up to a multiple of 1000. It is useful when a customized error message text
12026 file is in use (see chapter &<<CHAPemsgcust>>&).
12027
12028 .vitem &$caller_gid$&
12029 .cindex "gid (group id)" "caller"
12030 .vindex "&$caller_gid$&"
12031 The real group id under which the process that called Exim was running. This is
12032 not the same as the group id of the originator of a message (see
12033 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12034 incarnation normally contains the Exim gid.
12035
12036 .vitem &$caller_uid$&
12037 .cindex "uid (user id)" "caller"
12038 .vindex "&$caller_uid$&"
12039 The real user id under which the process that called Exim was running. This is
12040 not the same as the user id of the originator of a message (see
12041 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12042 incarnation normally contains the Exim uid.
12043
12044 .vitem &$callout_address$&
12045 .vindex "&$callout_address$&"
12046 After a callout for verification, spamd or malware daemon service, the
12047 address that was connected to.
12048
12049 .vitem &$compile_number$&
12050 .vindex "&$compile_number$&"
12051 The building process for Exim keeps a count of the number
12052 of times it has been compiled. This serves to distinguish different
12053 compilations of the same version of Exim.
12054
12055 .vitem &$config_dir$&
12056 .vindex "&$config_dir$&"
12057 The directory name of the main configuration file. That is, the content of
12058 &$config_file$& with the last component stripped. The value does not
12059 contain the trailing slash. If &$config_file$& does not contain a slash,
12060 &$config_dir$& is ".".
12061
12062 .vitem &$config_file$&
12063 .vindex "&$config_file$&"
12064 The name of the main configuration file Exim is using.
12065
12066 .vitem &$dkim_verify_status$&
12067 Results of DKIM verification.
12068 For details see section &<<SECDKIMVFY>>&.
12069
12070 .vitem &$dkim_cur_signer$& &&&
12071        &$dkim_verify_reason$& &&&
12072        &$dkim_domain$& &&&
12073        &$dkim_identity$& &&&
12074        &$dkim_selector$& &&&
12075        &$dkim_algo$& &&&
12076        &$dkim_canon_body$& &&&
12077        &$dkim_canon_headers$& &&&
12078        &$dkim_copiedheaders$& &&&
12079        &$dkim_bodylength$& &&&
12080        &$dkim_created$& &&&
12081        &$dkim_expires$& &&&
12082        &$dkim_headernames$& &&&
12083        &$dkim_key_testing$& &&&
12084        &$dkim_key_nosubdomains$& &&&
12085        &$dkim_key_srvtype$& &&&
12086        &$dkim_key_granularity$& &&&
12087        &$dkim_key_notes$& &&&
12088        &$dkim_key_length$&
12089 These variables are only available within the DKIM ACL.
12090 For details see section &<<SECDKIMVFY>>&.
12091
12092 .vitem &$dkim_signers$&
12093 .vindex &$dkim_signers$&
12094 When a message has been received this variable contains
12095 a colon-separated list of signer domains and identities for the message.
12096 For details see section &<<SECDKIMVFY>>&.
12097
12098 .vitem &$dnslist_domain$& &&&
12099        &$dnslist_matched$& &&&
12100        &$dnslist_text$& &&&
12101        &$dnslist_value$&
12102 .vindex "&$dnslist_domain$&"
12103 .vindex "&$dnslist_matched$&"
12104 .vindex "&$dnslist_text$&"
12105 .vindex "&$dnslist_value$&"
12106 .cindex "black list (DNS)"
12107 When a DNS (black) list lookup succeeds, these variables are set to contain
12108 the following data from the lookup: the list's domain name, the key that was
12109 looked up, the contents of any associated TXT record, and the value from the
12110 main A record. See section &<<SECID204>>& for more details.
12111
12112 .vitem &$domain$&
12113 .vindex "&$domain$&"
12114 When an address is being routed, or delivered on its own, this variable
12115 contains the domain. Uppercase letters in the domain are converted into lower
12116 case for &$domain$&.
12117
12118 Global address rewriting happens when a message is received, so the value of
12119 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12120 is set during user filtering, but not during system filtering, because a
12121 message may have many recipients and the system filter is called just once.
12122
12123 When more than one address is being delivered at once (for example, several
12124 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12125 have the same domain. Transports can be restricted to handling only one domain
12126 at a time if the value of &$domain$& is required at transport time &-- this is
12127 the default for local transports. For further details of the environment in
12128 which local transports are run, see chapter &<<CHAPenvironment>>&.
12129
12130 .oindex "&%delay_warning_condition%&"
12131 At the end of a delivery, if all deferred addresses have the same domain, it is
12132 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12133
12134 The &$domain$& variable is also used in some other circumstances:
12135
12136 .ilist
12137 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12138 the recipient address. The domain of the &'sender'& address is in
12139 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12140 normally set during the running of the MAIL ACL. However, if the sender address
12141 is verified with a callout during the MAIL ACL, the sender domain is placed in
12142 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12143 the &(smtp)& transport.
12144
12145 .next
12146 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12147 &$domain$& contains the domain portion of the address that is being rewritten;
12148 it can be used in the expansion of the replacement address, for example, to
12149 rewrite domains by file lookup.
12150
12151 .next
12152 With one important exception, whenever a domain list is being scanned,
12153 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12154 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12155 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12156 that, in a RCPT ACL, the sender domain list can be dependent on the
12157 recipient domain (which is what is in &$domain$& at this time).
12158
12159 .next
12160 .cindex "ETRN" "value of &$domain$&"
12161 .oindex "&%smtp_etrn_command%&"
12162 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12163 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12164 .endlist
12165
12166
12167 .vitem &$domain_data$&
12168 .vindex "&$domain_data$&"
12169 When the &%domains%& option on a router matches a domain by
12170 means of a lookup, the data read by the lookup is available during the running
12171 of the router as &$domain_data$&. In addition, if the driver routes the
12172 address to a transport, the value is available in that transport. If the
12173 transport is handling multiple addresses, the value from the first address is
12174 used.
12175
12176 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12177 domain by means of a lookup. The data read by the lookup is available during
12178 the rest of the ACL statement. In all other situations, this variable expands
12179 to nothing.
12180
12181 .vitem &$exim_gid$&
12182 .vindex "&$exim_gid$&"
12183 This variable contains the numerical value of the Exim group id.
12184
12185 .vitem &$exim_path$&
12186 .vindex "&$exim_path$&"
12187 This variable contains the path to the Exim binary.
12188
12189 .vitem &$exim_uid$&
12190 .vindex "&$exim_uid$&"
12191 This variable contains the numerical value of the Exim user id.
12192
12193 .vitem &$exim_version$&
12194 .vindex "&$exim_version$&"
12195 This variable contains the version string of the Exim build.
12196 The first character is a major version number, currently 4.
12197 Then after a dot, the next group of digits is a minor version number.
12198 There may be other characters following the minor version.
12199 This value may be overridden by the &%exim_version%& main config option.
12200
12201 .vitem &$header_$&<&'name'&>
12202 This is not strictly an expansion variable. It is expansion syntax for
12203 inserting the message header line with the given name. Note that the name must
12204 be terminated by colon or white space, because it may contain a wide variety of
12205 characters. Note also that braces must &'not'& be used.
12206 See the full description in section &<<SECTexpansionitems>>& above.
12207
12208 .vitem &$headers_added$&
12209 .vindex "&$headers_added$&"
12210 Within an ACL this variable contains the headers added so far by
12211 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12212 The headers are a newline-separated list.
12213
12214 .vitem &$home$&
12215 .vindex "&$home$&"
12216 When the &%check_local_user%& option is set for a router, the user's home
12217 directory is placed in &$home$& when the check succeeds. In particular, this
12218 means it is set during the running of users' filter files. A router may also
12219 explicitly set a home directory for use by a transport; this can be overridden
12220 by a setting on the transport itself.
12221
12222 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12223 of the environment variable HOME, which is subject to the
12224 &%keep_environment%& and &%add_environment%& main config options.
12225
12226 .vitem &$host$&
12227 .vindex "&$host$&"
12228 If a router assigns an address to a transport (any transport), and passes a
12229 list of hosts with the address, the value of &$host$& when the transport starts
12230 to run is the name of the first host on the list. Note that this applies both
12231 to local and remote transports.
12232
12233 .cindex "transport" "filter"
12234 .cindex "filter" "transport filter"
12235 For the &(smtp)& transport, if there is more than one host, the value of
12236 &$host$& changes as the transport works its way through the list. In
12237 particular, when the &(smtp)& transport is expanding its options for encryption
12238 using TLS, or for specifying a transport filter (see chapter
12239 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12240 is connected.
12241
12242 When used in the client part of an authenticator configuration (see chapter
12243 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12244 client is connected.
12245
12246
12247 .vitem &$host_address$&
12248 .vindex "&$host_address$&"
12249 This variable is set to the remote host's IP address whenever &$host$& is set
12250 for a remote connection. It is also set to the IP address that is being checked
12251 when the &%ignore_target_hosts%& option is being processed.
12252
12253 .vitem &$host_data$&
12254 .vindex "&$host_data$&"
12255 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12256 result of the lookup is made available in the &$host_data$& variable. This
12257 allows you, for example, to do things like this:
12258 .code
12259 deny  hosts = net-lsearch;/some/file
12260 message = $host_data
12261 .endd
12262 .vitem &$host_lookup_deferred$&
12263 .cindex "host name" "lookup, failure of"
12264 .vindex "&$host_lookup_deferred$&"
12265 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12266 message comes from a remote host and there is an attempt to look up the host's
12267 name from its IP address, and the attempt is not successful, one of these
12268 variables is set to &"1"&.
12269
12270 .ilist
12271 If the lookup receives a definite negative response (for example, a DNS lookup
12272 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12273
12274 .next
12275 If there is any kind of problem during the lookup, such that Exim cannot
12276 tell whether or not the host name is defined (for example, a timeout for a DNS
12277 lookup), &$host_lookup_deferred$& is set to &"1"&.
12278 .endlist ilist
12279
12280 Looking up a host's name from its IP address consists of more than just a
12281 single reverse lookup. Exim checks that a forward lookup of at least one of the
12282 names it receives from a reverse lookup yields the original IP address. If this
12283 is not the case, Exim does not accept the looked up name(s), and
12284 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12285 IP address (for example, the existence of a PTR record in the DNS) is not
12286 sufficient on its own for the success of a host name lookup. If the reverse
12287 lookup succeeds, but there is a lookup problem such as a timeout when checking
12288 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12289 &"1"&. See also &$sender_host_name$&.
12290
12291 .cindex authentication "expansion item"
12292 Performing these checks sets up information used by the
12293 &$authresults$& expansion item.
12294
12295
12296 .vitem &$host_lookup_failed$&
12297 .vindex "&$host_lookup_failed$&"
12298 See &$host_lookup_deferred$&.
12299
12300 .vitem &$host_port$&
12301 .vindex "&$host_port$&"
12302 This variable is set to the remote host's TCP port whenever &$host$& is set
12303 for an outbound connection.
12304
12305 .vitem &$initial_cwd$&
12306 .vindex "&$initial_cwd$&
12307 This variable contains the full path name of the initial working
12308 directory of the current Exim process. This may differ from the current
12309 working directory, as Exim changes this to "/" during early startup, and
12310 to &$spool_directory$& later.
12311
12312 .vitem &$inode$&
12313 .vindex "&$inode$&"
12314 The only time this variable is set is while expanding the &%directory_file%&
12315 option in the &(appendfile)& transport. The variable contains the inode number
12316 of the temporary file which is about to be renamed. It can be used to construct
12317 a unique name for the file.
12318
12319 .vitem &$interface_address$&
12320 .vindex "&$interface_address$&"
12321 This is an obsolete name for &$received_ip_address$&.
12322
12323 .vitem &$interface_port$&
12324 .vindex "&$interface_port$&"
12325 This is an obsolete name for &$received_port$&.
12326
12327 .vitem &$item$&
12328 .vindex "&$item$&"
12329 This variable is used during the expansion of &*forall*& and &*forany*&
12330 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12331 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12332 empty.
12333
12334 .vitem &$ldap_dn$&
12335 .vindex "&$ldap_dn$&"
12336 This variable, which is available only when Exim is compiled with LDAP support,
12337 contains the DN from the last entry in the most recently successful LDAP
12338 lookup.
12339
12340 .vitem &$load_average$&
12341 .vindex "&$load_average$&"
12342 This variable contains the system load average, multiplied by 1000 so that it
12343 is an integer. For example, if the load average is 0.21, the value of the
12344 variable is 210. The value is recomputed every time the variable is referenced.
12345
12346 .vitem &$local_part$&
12347 .vindex "&$local_part$&"
12348 When an address is being routed, or delivered on its own, this
12349 variable contains the local part. When a number of addresses are being
12350 delivered together (for example, multiple RCPT commands in an SMTP
12351 session), &$local_part$& is not set.
12352
12353 Global address rewriting happens when a message is received, so the value of
12354 &$local_part$& during routing and delivery is the value after rewriting.
12355 &$local_part$& is set during user filtering, but not during system filtering,
12356 because a message may have many recipients and the system filter is called just
12357 once.
12358
12359 .vindex "&$local_part_prefix$&"
12360 .vindex "&$local_part_suffix$&"
12361 .cindex affix variables
12362 If a local part prefix or suffix has been recognized, it is not included in the
12363 value of &$local_part$& during routing and subsequent delivery. The values of
12364 any prefix or suffix are in &$local_part_prefix$& and
12365 &$local_part_suffix$&, respectively.
12366
12367 When a message is being delivered to a file, pipe, or autoreply transport as a
12368 result of aliasing or forwarding, &$local_part$& is set to the local part of
12369 the parent address, not to the filename or command (see &$address_file$& and
12370 &$address_pipe$&).
12371
12372 When an ACL is running for a RCPT command, &$local_part$& contains the
12373 local part of the recipient address.
12374
12375 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12376 &$local_part$& contains the local part of the address that is being rewritten;
12377 it can be used in the expansion of the replacement address, for example.
12378
12379 In all cases, all quoting is removed from the local part. For example, for both
12380 the addresses
12381 .code
12382 "abc:xyz"@test.example
12383 abc\:xyz@test.example
12384 .endd
12385 the value of &$local_part$& is
12386 .code
12387 abc:xyz
12388 .endd
12389 If you use &$local_part$& to create another address, you should always wrap it
12390 inside a quoting operator. For example, in a &(redirect)& router you could
12391 have:
12392 .code
12393 data = ${quote_local_part:$local_part}@new.domain.example
12394 .endd
12395 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12396 to process local parts in a case-dependent manner in a router, you can set the
12397 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12398
12399 .vitem &$local_part_data$&
12400 .vindex "&$local_part_data$&"
12401 When the &%local_parts%& option on a router matches a local part by means of a
12402 lookup, the data read by the lookup is available during the running of the
12403 router as &$local_part_data$&. In addition, if the driver routes the address
12404 to a transport, the value is available in that transport. If the transport is
12405 handling multiple addresses, the value from the first address is used.
12406
12407 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12408 matches a local part by means of a lookup. The data read by the lookup is
12409 available during the rest of the ACL statement. In all other situations, this
12410 variable expands to nothing.
12411
12412 .vitem &$local_part_prefix$&
12413 .vindex "&$local_part_prefix$&"
12414 .cindex affix variables
12415 When an address is being routed or delivered, and a
12416 specific prefix for the local part was recognized, it is available in this
12417 variable, having been removed from &$local_part$&.
12418
12419 .vitem &$local_part_suffix$&
12420 .vindex "&$local_part_suffix$&"
12421 When an address is being routed or delivered, and a
12422 specific suffix for the local part was recognized, it is available in this
12423 variable, having been removed from &$local_part$&.
12424
12425 .vitem &$local_scan_data$&
12426 .vindex "&$local_scan_data$&"
12427 This variable contains the text returned by the &[local_scan()]& function when
12428 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12429
12430 .vitem &$local_user_gid$&
12431 .vindex "&$local_user_gid$&"
12432 See &$local_user_uid$&.
12433
12434 .vitem &$local_user_uid$&
12435 .vindex "&$local_user_uid$&"
12436 This variable and &$local_user_gid$& are set to the uid and gid after the
12437 &%check_local_user%& router precondition succeeds. This means that their values
12438 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12439 and &%condition%&), for the &%address_data%& expansion, and for any
12440 router-specific expansions. At all other times, the values in these variables
12441 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12442
12443 .vitem &$localhost_number$&
12444 .vindex "&$localhost_number$&"
12445 This contains the expanded value of the
12446 &%localhost_number%& option. The expansion happens after the main options have
12447 been read.
12448
12449 .vitem &$log_inodes$&
12450 .vindex "&$log_inodes$&"
12451 The number of free inodes in the disk partition where Exim's
12452 log files are being written. The value is recalculated whenever the variable is
12453 referenced. If the relevant file system does not have the concept of inodes,
12454 the value of is -1. See also the &%check_log_inodes%& option.
12455
12456 .vitem &$log_space$&
12457 .vindex "&$log_space$&"
12458 The amount of free space (as a number of kilobytes) in the disk
12459 partition where Exim's log files are being written. The value is recalculated
12460 whenever the variable is referenced. If the operating system does not have the
12461 ability to find the amount of free space (only true for experimental systems),
12462 the space value is -1. See also the &%check_log_space%& option.
12463
12464
12465 .vitem &$lookup_dnssec_authenticated$&
12466 .vindex "&$lookup_dnssec_authenticated$&"
12467 This variable is set after a DNS lookup done by
12468 a dnsdb lookup expansion, dnslookup router or smtp transport.
12469 .cindex "DNS" "DNSSEC"
12470 It will be empty if &(DNSSEC)& was not requested,
12471 &"no"& if the result was not labelled as authenticated data
12472 and &"yes"& if it was.
12473 Results that are labelled as authoritative answer that match
12474 the &%dns_trust_aa%& configuration variable count also
12475 as authenticated data.
12476
12477 .vitem &$mailstore_basename$&
12478 .vindex "&$mailstore_basename$&"
12479 This variable is set only when doing deliveries in &"mailstore"& format in the
12480 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12481 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12482 contains the basename of the files that are being written, that is, the name
12483 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12484 variable is empty.
12485
12486 .vitem &$malware_name$&
12487 .vindex "&$malware_name$&"
12488 This variable is available when Exim is compiled with the
12489 content-scanning extension. It is set to the name of the virus that was found
12490 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12491
12492 .vitem &$max_received_linelength$&
12493 .vindex "&$max_received_linelength$&"
12494 .cindex "maximum" "line length"
12495 .cindex "line length" "maximum"
12496 This variable contains the number of bytes in the longest line that was
12497 received as part of the message, not counting the line termination
12498 character(s).
12499 It is not valid if the &%spool_files_wireformat%& option is used.
12500
12501 .vitem &$message_age$&
12502 .cindex "message" "age of"
12503 .vindex "&$message_age$&"
12504 This variable is set at the start of a delivery attempt to contain the number
12505 of seconds since the message was received. It does not change during a single
12506 delivery attempt.
12507
12508 .vitem &$message_body$&
12509 .cindex "body of message" "expansion variable"
12510 .cindex "message body" "in expansion"
12511 .cindex "binary zero" "in message body"
12512 .vindex "&$message_body$&"
12513 .oindex "&%message_body_visible%&"
12514 This variable contains the initial portion of a message's body while it is
12515 being delivered, and is intended mainly for use in filter files. The maximum
12516 number of characters of the body that are put into the variable is set by the
12517 &%message_body_visible%& configuration option; the default is 500.
12518
12519 .oindex "&%message_body_newlines%&"
12520 By default, newlines are converted into spaces in &$message_body$&, to make it
12521 easier to search for phrases that might be split over a line break. However,
12522 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12523 zeros are always converted into spaces.
12524
12525 .vitem &$message_body_end$&
12526 .cindex "body of message" "expansion variable"
12527 .cindex "message body" "in expansion"
12528 .vindex "&$message_body_end$&"
12529 This variable contains the final portion of a message's
12530 body while it is being delivered. The format and maximum size are as for
12531 &$message_body$&.
12532
12533 .vitem &$message_body_size$&
12534 .cindex "body of message" "size"
12535 .cindex "message body" "size"
12536 .vindex "&$message_body_size$&"
12537 When a message is being delivered, this variable contains the size of the body
12538 in bytes. The count starts from the character after the blank line that
12539 separates the body from the header. Newlines are included in the count. See
12540 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12541
12542 If the spool file is wireformat
12543 (see the &%spool_files_wireformat%& main option)
12544 the CRLF line-terminators are included in the count.
12545
12546 .vitem &$message_exim_id$&
12547 .vindex "&$message_exim_id$&"
12548 When a message is being received or delivered, this variable contains the
12549 unique message id that is generated and used by Exim to identify the message.
12550 An id is not created for a message until after its header has been successfully
12551 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12552 line; it is the local id that Exim assigns to the message, for example:
12553 &`1BXTIK-0001yO-VA`&.
12554
12555 .vitem &$message_headers$&
12556 .vindex &$message_headers$&
12557 This variable contains a concatenation of all the header lines when a message
12558 is being processed, except for lines added by routers or transports. The header
12559 lines are separated by newline characters. Their contents are decoded in the
12560 same way as a header line that is inserted by &%bheader%&.
12561
12562 .vitem &$message_headers_raw$&
12563 .vindex &$message_headers_raw$&
12564 This variable is like &$message_headers$& except that no processing of the
12565 contents of header lines is done.
12566
12567 .vitem &$message_id$&
12568 This is an old name for &$message_exim_id$&. It is now deprecated.
12569
12570 .vitem &$message_linecount$&
12571 .vindex "&$message_linecount$&"
12572 This variable contains the total number of lines in the header and body of the
12573 message. Compare &$body_linecount$&, which is the count for the body only.
12574 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12575 number of lines received. Before delivery happens (that is, before filters,
12576 routers, and transports run) the count is increased to include the
12577 &'Received:'& header line that Exim standardly adds, and also any other header
12578 lines that are added by ACLs. The blank line that separates the message header
12579 from the body is not counted.
12580
12581 As with the special case of &$message_size$&, during the expansion of the
12582 appendfile transport's maildir_tag option in maildir format, the value of
12583 &$message_linecount$& is the precise size of the number of newlines in the
12584 file that has been written (minus one for the blank line between the
12585 header and the body).
12586
12587 Here is an example of the use of this variable in a DATA ACL:
12588 .code
12589 deny message   = Too many lines in message header
12590      condition = \
12591       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12592 .endd
12593 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12594 message has not yet been received.
12595
12596 This variable is not valid if the &%spool_files_wireformat%& option is used.
12597
12598 .vitem &$message_size$&
12599 .cindex "size" "of message"
12600 .cindex "message" "size"
12601 .vindex "&$message_size$&"
12602 When a message is being processed, this variable contains its size in bytes. In
12603 most cases, the size includes those headers that were received with the
12604 message, but not those (such as &'Envelope-to:'&) that are added to individual
12605 deliveries as they are written. However, there is one special case: during the
12606 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12607 doing a delivery in maildir format, the value of &$message_size$& is the
12608 precise size of the file that has been written. See also
12609 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12610
12611 .cindex "RCPT" "value of &$message_size$&"
12612 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12613 contains the size supplied on the MAIL command, or -1 if no size was given. The
12614 value may not, of course, be truthful.
12615
12616 .vitem &$mime_$&&'xxx'&
12617 A number of variables whose names start with &$mime$& are
12618 available when Exim is compiled with the content-scanning extension. For
12619 details, see section &<<SECTscanmimepart>>&.
12620
12621 .vitem "&$n0$& &-- &$n9$&"
12622 These variables are counters that can be incremented by means
12623 of the &%add%& command in filter files.
12624
12625 .vitem &$original_domain$&
12626 .vindex "&$domain$&"
12627 .vindex "&$original_domain$&"
12628 When a top-level address is being processed for delivery, this contains the
12629 same value as &$domain$&. However, if a &"child"& address (for example,
12630 generated by an alias, forward, or filter file) is being processed, this
12631 variable contains the domain of the original address (lower cased). This
12632 differs from &$parent_domain$& only when there is more than one level of
12633 aliasing or forwarding. When more than one address is being delivered in a
12634 single transport run, &$original_domain$& is not set.
12635
12636 If a new address is created by means of a &%deliver%& command in a system
12637 filter, it is set up with an artificial &"parent"& address. This has the local
12638 part &'system-filter'& and the default qualify domain.
12639
12640 .vitem &$original_local_part$&
12641 .vindex "&$local_part$&"
12642 .vindex "&$original_local_part$&"
12643 When a top-level address is being processed for delivery, this contains the
12644 same value as &$local_part$&, unless a prefix or suffix was removed from the
12645 local part, because &$original_local_part$& always contains the full local
12646 part. When a &"child"& address (for example, generated by an alias, forward, or
12647 filter file) is being processed, this variable contains the full local part of
12648 the original address.
12649
12650 If the router that did the redirection processed the local part
12651 case-insensitively, the value in &$original_local_part$& is in lower case.
12652 This variable differs from &$parent_local_part$& only when there is more than
12653 one level of aliasing or forwarding. When more than one address is being
12654 delivered in a single transport run, &$original_local_part$& is not set.
12655
12656 If a new address is created by means of a &%deliver%& command in a system
12657 filter, it is set up with an artificial &"parent"& address. This has the local
12658 part &'system-filter'& and the default qualify domain.
12659
12660 .vitem &$originator_gid$&
12661 .cindex "gid (group id)" "of originating user"
12662 .cindex "sender" "gid"
12663 .vindex "&$caller_gid$&"
12664 .vindex "&$originator_gid$&"
12665 This variable contains the value of &$caller_gid$& that was set when the
12666 message was received. For messages received via the command line, this is the
12667 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12668 normally the gid of the Exim user.
12669
12670 .vitem &$originator_uid$&
12671 .cindex "uid (user id)" "of originating user"
12672 .cindex "sender" "uid"
12673 .vindex "&$caller_uid$&"
12674 .vindex "&$originator_uid$&"
12675 The value of &$caller_uid$& that was set when the message was received. For
12676 messages received via the command line, this is the uid of the sending user.
12677 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12678 user.
12679
12680 .vitem &$parent_domain$&
12681 .vindex "&$parent_domain$&"
12682 This variable is similar to &$original_domain$& (see
12683 above), except that it refers to the immediately preceding parent address.
12684
12685 .vitem &$parent_local_part$&
12686 .vindex "&$parent_local_part$&"
12687 This variable is similar to &$original_local_part$&
12688 (see above), except that it refers to the immediately preceding parent address.
12689
12690 .vitem &$pid$&
12691 .cindex "pid (process id)" "of current process"
12692 .vindex "&$pid$&"
12693 This variable contains the current process id.
12694
12695 .vitem &$pipe_addresses$&
12696 .cindex "filter" "transport filter"
12697 .cindex "transport" "filter"
12698 .vindex "&$pipe_addresses$&"
12699 This is not an expansion variable, but is mentioned here because the string
12700 &`$pipe_addresses`& is handled specially in the command specification for the
12701 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12702 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12703 It cannot be used in general expansion strings, and provokes an &"unknown
12704 variable"& error if encountered.
12705
12706 .vitem &$primary_hostname$&
12707 .vindex "&$primary_hostname$&"
12708 This variable contains the value set by &%primary_hostname%& in the
12709 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12710 a single-component name, Exim calls &[gethostbyname()]& (or
12711 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12712 qualified host name. See also &$smtp_active_hostname$&.
12713
12714
12715 .vitem &$proxy_external_address$& &&&
12716        &$proxy_external_port$& &&&
12717        &$proxy_local_address$& &&&
12718        &$proxy_local_port$& &&&
12719        &$proxy_session$&
12720 These variables are only available when built with Proxy Protocol
12721 or SOCKS5 support.
12722 For details see chapter &<<SECTproxyInbound>>&.
12723
12724 .vitem &$prdr_requested$&
12725 .cindex "PRDR" "variable for"
12726 This variable is set to &"yes"& if PRDR was requested by the client for the
12727 current message, otherwise &"no"&.
12728
12729 .vitem &$prvscheck_address$&
12730 This variable is used in conjunction with the &%prvscheck%& expansion item,
12731 which is described in sections &<<SECTexpansionitems>>& and
12732 &<<SECTverifyPRVS>>&.
12733
12734 .vitem &$prvscheck_keynum$&
12735 This variable is used in conjunction with the &%prvscheck%& expansion item,
12736 which is described in sections &<<SECTexpansionitems>>& and
12737 &<<SECTverifyPRVS>>&.
12738
12739 .vitem &$prvscheck_result$&
12740 This variable is used in conjunction with the &%prvscheck%& expansion item,
12741 which is described in sections &<<SECTexpansionitems>>& and
12742 &<<SECTverifyPRVS>>&.
12743
12744 .vitem &$qualify_domain$&
12745 .vindex "&$qualify_domain$&"
12746 The value set for the &%qualify_domain%& option in the configuration file.
12747
12748 .vitem &$qualify_recipient$&
12749 .vindex "&$qualify_recipient$&"
12750 The value set for the &%qualify_recipient%& option in the configuration file,
12751 or if not set, the value of &$qualify_domain$&.
12752
12753 .vitem &$queue_name$&
12754 .vindex &$queue_name$&
12755 .cindex "named queues"
12756 .cindex queues named
12757 The name of the spool queue in use; empty for the default queue.
12758
12759 .vitem &$rcpt_count$&
12760 .vindex "&$rcpt_count$&"
12761 When a message is being received by SMTP, this variable contains the number of
12762 RCPT commands received for the current message. If this variable is used in a
12763 RCPT ACL, its value includes the current command.
12764
12765 .vitem &$rcpt_defer_count$&
12766 .vindex "&$rcpt_defer_count$&"
12767 .cindex "4&'xx'& responses" "count of"
12768 When a message is being received by SMTP, this variable contains the number of
12769 RCPT commands in the current message that have previously been rejected with a
12770 temporary (4&'xx'&) response.
12771
12772 .vitem &$rcpt_fail_count$&
12773 .vindex "&$rcpt_fail_count$&"
12774 When a message is being received by SMTP, this variable contains the number of
12775 RCPT commands in the current message that have previously been rejected with a
12776 permanent (5&'xx'&) response.
12777
12778 .vitem &$received_count$&
12779 .vindex "&$received_count$&"
12780 This variable contains the number of &'Received:'& header lines in the message,
12781 including the one added by Exim (so its value is always greater than zero). It
12782 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12783 delivering.
12784
12785 .vitem &$received_for$&
12786 .vindex "&$received_for$&"
12787 If there is only a single recipient address in an incoming message, this
12788 variable contains that address when the &'Received:'& header line is being
12789 built. The value is copied after recipient rewriting has happened, but before
12790 the &[local_scan()]& function is run.
12791
12792 .vitem &$received_ip_address$&
12793 .vindex "&$received_ip_address$&"
12794 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12795 variable is set to the address of the local IP interface, and &$received_port$&
12796 is set to the local port number. (The remote IP address and port are in
12797 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12798 the port value is -1 unless it has been set using the &%-oMi%& command line
12799 option.
12800
12801 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12802 could be used, for example, to make the filename for a TLS certificate depend
12803 on which interface and/or port is being used for the incoming connection. The
12804 values of &$received_ip_address$& and &$received_port$& are saved with any
12805 messages that are received, thus making these variables available at delivery
12806 time.
12807 For outbound connections see &$sending_ip_address$&.
12808
12809 .vitem &$received_port$&
12810 .vindex "&$received_port$&"
12811 See &$received_ip_address$&.
12812
12813 .vitem &$received_protocol$&
12814 .vindex "&$received_protocol$&"
12815 When a message is being processed, this variable contains the name of the
12816 protocol by which it was received. Most of the names used by Exim are defined
12817 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12818 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12819 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12820 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12821 connection and the client was successfully authenticated.
12822
12823 Exim uses the protocol name &"smtps"& for the case when encryption is
12824 automatically set up on connection without the use of STARTTLS (see
12825 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12826 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12827 where the client initially uses EHLO, sets up an encrypted connection using
12828 STARTTLS, and then uses HELO afterwards.
12829
12830 The &%-oMr%& option provides a way of specifying a custom protocol name for
12831 messages that are injected locally by trusted callers. This is commonly used to
12832 identify messages that are being re-injected after some kind of scanning.
12833
12834 .vitem &$received_time$&
12835 .vindex "&$received_time$&"
12836 This variable contains the date and time when the current message was received,
12837 as a number of seconds since the start of the Unix epoch.
12838
12839 .vitem &$recipient_data$&
12840 .vindex "&$recipient_data$&"
12841 This variable is set after an indexing lookup success in an ACL &%recipients%&
12842 condition. It contains the data from the lookup, and the value remains set
12843 until the next &%recipients%& test. Thus, you can do things like this:
12844 .display
12845 &`require recipients  = cdb*@;/some/file`&
12846 &`deny    `&&'some further test involving'& &`$recipient_data`&
12847 .endd
12848 &*Warning*&: This variable is set only when a lookup is used as an indexing
12849 method in the address list, using the semicolon syntax as in the example above.
12850 The variable is not set for a lookup that is used as part of the string
12851 expansion that all such lists undergo before being interpreted.
12852
12853 .vitem &$recipient_verify_failure$&
12854 .vindex "&$recipient_verify_failure$&"
12855 In an ACL, when a recipient verification fails, this variable contains
12856 information about the failure. It is set to one of the following words:
12857
12858 .ilist
12859 &"qualify"&: The address was unqualified (no domain), and the message
12860 was neither local nor came from an exempted host.
12861
12862 .next
12863 &"route"&: Routing failed.
12864
12865 .next
12866 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12867 or before the MAIL command (that is, on initial connection, HELO, or
12868 MAIL).
12869
12870 .next
12871 &"recipient"&: The RCPT command in a callout was rejected.
12872 .next
12873
12874 &"postmaster"&: The postmaster check in a callout was rejected.
12875 .endlist
12876
12877 The main use of this variable is expected to be to distinguish between
12878 rejections of MAIL and rejections of RCPT.
12879
12880 .vitem &$recipients$&
12881 .vindex "&$recipients$&"
12882 This variable contains a list of envelope recipients for a message. A comma and
12883 a space separate the addresses in the replacement text. However, the variable
12884 is not generally available, to prevent exposure of Bcc recipients in
12885 unprivileged users' filter files. You can use &$recipients$& only in these
12886 cases:
12887
12888 .olist
12889 In a system filter file.
12890 .next
12891 In the ACLs associated with the DATA command and with non-SMTP messages, that
12892 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12893 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12894 &%acl_not_smtp_mime%&.
12895 .next
12896 From within a &[local_scan()]& function.
12897 .endlist
12898
12899
12900 .vitem &$recipients_count$&
12901 .vindex "&$recipients_count$&"
12902 When a message is being processed, this variable contains the number of
12903 envelope recipients that came with the message. Duplicates are not excluded
12904 from the count. While a message is being received over SMTP, the number
12905 increases for each accepted recipient. It can be referenced in an ACL.
12906
12907
12908 .vitem &$regex_match_string$&
12909 .vindex "&$regex_match_string$&"
12910 This variable is set to contain the matching regular expression after a
12911 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12912
12913 .vitem "&$regex1$&, &$regex2$&, etc"
12914 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12915 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12916 these variables contain the
12917 captured substrings identified by the regular expression.
12918
12919
12920 .vitem &$reply_address$&
12921 .vindex "&$reply_address$&"
12922 When a message is being processed, this variable contains the contents of the
12923 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12924 contents of the &'From:'& header line. Apart from the removal of leading
12925 white space, the value is not processed in any way. In particular, no RFC 2047
12926 decoding or character code translation takes place.
12927
12928 .vitem &$return_path$&
12929 .vindex "&$return_path$&"
12930 When a message is being delivered, this variable contains the return path &--
12931 the sender field that will be sent as part of the envelope. It is not enclosed
12932 in <> characters. At the start of routing an address, &$return_path$& has the
12933 same value as &$sender_address$&, but if, for example, an incoming message to a
12934 mailing list has been expanded by a router which specifies a different address
12935 for bounce messages, &$return_path$& subsequently contains the new bounce
12936 address, whereas &$sender_address$& always contains the original sender address
12937 that was received with the message. In other words, &$sender_address$& contains
12938 the incoming envelope sender, and &$return_path$& contains the outgoing
12939 envelope sender.
12940
12941 .vitem &$return_size_limit$&
12942 .vindex "&$return_size_limit$&"
12943 This is an obsolete name for &$bounce_return_size_limit$&.
12944
12945 .vitem &$router_name$&
12946 .cindex "router" "name"
12947 .cindex "name" "of router"
12948 .vindex "&$router_name$&"
12949 During the running of a router this variable contains its name.
12950
12951 .vitem &$runrc$&
12952 .cindex "return code" "from &%run%& expansion"
12953 .vindex "&$runrc$&"
12954 This variable contains the return code from a command that is run by the
12955 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12956 assume the order in which option values are expanded, except for those
12957 preconditions whose order of testing is documented. Therefore, you cannot
12958 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12959 another.
12960
12961 .vitem &$self_hostname$&
12962 .oindex "&%self%&" "value of host name"
12963 .vindex "&$self_hostname$&"
12964 When an address is routed to a supposedly remote host that turns out to be the
12965 local host, what happens is controlled by the &%self%& generic router option.
12966 One of its values causes the address to be passed to another router. When this
12967 happens, &$self_hostname$& is set to the name of the local host that the
12968 original router encountered. In other circumstances its contents are null.
12969
12970 .vitem &$sender_address$&
12971 .vindex "&$sender_address$&"
12972 When a message is being processed, this variable contains the sender's address
12973 that was received in the message's envelope. The case of letters in the address
12974 is retained, in both the local part and the domain. For bounce messages, the
12975 value of this variable is the empty string. See also &$return_path$&.
12976
12977 .vitem &$sender_address_data$&
12978 .vindex "&$address_data$&"
12979 .vindex "&$sender_address_data$&"
12980 If &$address_data$& is set when the routers are called from an ACL to verify a
12981 sender address, the final value is preserved in &$sender_address_data$&, to
12982 distinguish it from data from a recipient address. The value does not persist
12983 after the end of the current ACL statement. If you want to preserve it for
12984 longer, you can save it in an ACL variable.
12985
12986 .vitem &$sender_address_domain$&
12987 .vindex "&$sender_address_domain$&"
12988 The domain portion of &$sender_address$&.
12989
12990 .vitem &$sender_address_local_part$&
12991 .vindex "&$sender_address_local_part$&"
12992 The local part portion of &$sender_address$&.
12993
12994 .vitem &$sender_data$&
12995 .vindex "&$sender_data$&"
12996 This variable is set after a lookup success in an ACL &%senders%& condition or
12997 in a router &%senders%& option. It contains the data from the lookup, and the
12998 value remains set until the next &%senders%& test. Thus, you can do things like
12999 this:
13000 .display
13001 &`require senders      = cdb*@;/some/file`&
13002 &`deny    `&&'some further test involving'& &`$sender_data`&
13003 .endd
13004 &*Warning*&: This variable is set only when a lookup is used as an indexing
13005 method in the address list, using the semicolon syntax as in the example above.
13006 The variable is not set for a lookup that is used as part of the string
13007 expansion that all such lists undergo before being interpreted.
13008
13009 .vitem &$sender_fullhost$&
13010 .vindex "&$sender_fullhost$&"
13011 When a message is received from a remote host, this variable contains the host
13012 name and IP address in a single string. It ends with the IP address in square
13013 brackets, followed by a colon and a port number if the logging of ports is
13014 enabled. The format of the rest of the string depends on whether the host
13015 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13016 looking up its IP address. (Looking up the IP address can be forced by the
13017 &%host_lookup%& option, independent of verification.) A plain host name at the
13018 start of the string is a verified host name; if this is not present,
13019 verification either failed or was not requested. A host name in parentheses is
13020 the argument of a HELO or EHLO command. This is omitted if it is identical to
13021 the verified host name or to the host's IP address in square brackets.
13022
13023 .vitem &$sender_helo_dnssec$&
13024 .vindex "&$sender_helo_dnssec$&"
13025 This boolean variable is true if a successful HELO verification was
13026 .cindex "DNS" "DNSSEC"
13027 done using DNS information the resolver library stated was authenticated data.
13028
13029 .vitem &$sender_helo_name$&
13030 .vindex "&$sender_helo_name$&"
13031 When a message is received from a remote host that has issued a HELO or EHLO
13032 command, the argument of that command is placed in this variable. It is also
13033 set if HELO or EHLO is used when a message is received using SMTP locally via
13034 the &%-bs%& or &%-bS%& options.
13035
13036 .vitem &$sender_host_address$&
13037 .vindex "&$sender_host_address$&"
13038 When a message is received from a remote host using SMTP,
13039 this variable contains that
13040 host's IP address. For locally non-SMTP submitted messages, it is empty.
13041
13042 .vitem &$sender_host_authenticated$&
13043 .vindex "&$sender_host_authenticated$&"
13044 This variable contains the name (not the public name) of the authenticator
13045 driver that successfully authenticated the client from which the message was
13046 received. It is empty if there was no successful authentication. See also
13047 &$authenticated_id$&.
13048
13049 .vitem &$sender_host_dnssec$&
13050 .vindex "&$sender_host_dnssec$&"
13051 If an attempt to populate &$sender_host_name$& has been made
13052 (by reference, &%hosts_lookup%& or
13053 otherwise) then this boolean will have been set true if, and only if, the
13054 resolver library states that both
13055 the reverse and forward DNS were authenticated data.  At all
13056 other times, this variable is false.
13057
13058 .cindex "DNS" "DNSSEC"
13059 It is likely that you will need to coerce DNSSEC support on in the resolver
13060 library, by setting:
13061 .code
13062 dns_dnssec_ok = 1
13063 .endd
13064
13065 Exim does not perform DNSSEC validation itself, instead leaving that to a
13066 validating resolver (e.g. unbound, or bind with suitable configuration).
13067
13068 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13069 mechanism in the list, then this variable will be false.
13070
13071 This requires that your system resolver library support EDNS0 (and that
13072 DNSSEC flags exist in the system headers).  If the resolver silently drops
13073 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13074 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13075
13076
13077 .vitem &$sender_host_name$&
13078 .vindex "&$sender_host_name$&"
13079 When a message is received from a remote host, this variable contains the
13080 host's name as obtained by looking up its IP address. For messages received by
13081 other means, this variable is empty.
13082
13083 .vindex "&$host_lookup_failed$&"
13084 If the host name has not previously been looked up, a reference to
13085 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13086 A looked up name is accepted only if it leads back to the original IP address
13087 via a forward lookup. If either the reverse or the forward lookup fails to find
13088 any data, or if the forward lookup does not yield the original IP address,
13089 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13090
13091 .vindex "&$host_lookup_deferred$&"
13092 However, if either of the lookups cannot be completed (for example, there is a
13093 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13094 &$host_lookup_failed$& remains set to &"0"&.
13095
13096 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13097 host name again if there is a subsequent reference to &$sender_host_name$&
13098 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13099 is set to &"1"&.
13100
13101 Exim does not automatically look up every calling host's name. If you want
13102 maximum efficiency, you should arrange your configuration so that it avoids
13103 these lookups altogether. The lookup happens only if one or more of the
13104 following are true:
13105
13106 .ilist
13107 A string containing &$sender_host_name$& is expanded.
13108 .next
13109 The calling host matches the list in &%host_lookup%&. In the default
13110 configuration, this option is set to *, so it must be changed if lookups are
13111 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13112 .next
13113 Exim needs the host name in order to test an item in a host list. The items
13114 that require this are described in sections &<<SECThoslispatnam>>& and
13115 &<<SECThoslispatnamsk>>&.
13116 .next
13117 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13118 In this case, the host name is required to compare with the name quoted in any
13119 EHLO or HELO commands that the client issues.
13120 .next
13121 The remote host issues a EHLO or HELO command that quotes one of the
13122 domains in &%helo_lookup_domains%&. The default value of this option is
13123 . ==== As this is a nested list, any displays it contains must be indented
13124 . ==== as otherwise they are too far to the left.
13125 .code
13126   helo_lookup_domains = @ : @[]
13127 .endd
13128 which causes a lookup if a remote host (incorrectly) gives the server's name or
13129 IP address in an EHLO or HELO command.
13130 .endlist
13131
13132
13133 .vitem &$sender_host_port$&
13134 .vindex "&$sender_host_port$&"
13135 When a message is received from a remote host, this variable contains the port
13136 number that was used on the remote host.
13137
13138 .vitem &$sender_ident$&
13139 .vindex "&$sender_ident$&"
13140 When a message is received from a remote host, this variable contains the
13141 identification received in response to an RFC 1413 request. When a message has
13142 been received locally, this variable contains the login name of the user that
13143 called Exim.
13144
13145 .vitem &$sender_rate_$&&'xxx'&
13146 A number of variables whose names begin &$sender_rate_$& are set as part of the
13147 &%ratelimit%& ACL condition. Details are given in section
13148 &<<SECTratelimiting>>&.
13149
13150 .vitem &$sender_rcvhost$&
13151 .cindex "DNS" "reverse lookup"
13152 .cindex "reverse DNS lookup"
13153 .vindex "&$sender_rcvhost$&"
13154 This is provided specifically for use in &'Received:'& headers. It starts with
13155 either the verified host name (as obtained from a reverse DNS lookup) or, if
13156 there is no verified host name, the IP address in square brackets. After that
13157 there may be text in parentheses. When the first item is a verified host name,
13158 the first thing in the parentheses is the IP address in square brackets,
13159 followed by a colon and a port number if port logging is enabled. When the
13160 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13161 the parentheses.
13162
13163 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13164 was used and its argument was not identical to the real host name or IP
13165 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13166 all three items are present in the parentheses, a newline and tab are inserted
13167 into the string, to improve the formatting of the &'Received:'& header.
13168
13169 .vitem &$sender_verify_failure$&
13170 .vindex "&$sender_verify_failure$&"
13171 In an ACL, when a sender verification fails, this variable contains information
13172 about the failure. The details are the same as for
13173 &$recipient_verify_failure$&.
13174
13175 .vitem &$sending_ip_address$&
13176 .vindex "&$sending_ip_address$&"
13177 This variable is set whenever an outgoing SMTP connection to another host has
13178 been set up. It contains the IP address of the local interface that is being
13179 used. This is useful if a host that has more than one IP address wants to take
13180 on different personalities depending on which one is being used. For incoming
13181 connections, see &$received_ip_address$&.
13182
13183 .vitem &$sending_port$&
13184 .vindex "&$sending_port$&"
13185 This variable is set whenever an outgoing SMTP connection to another host has
13186 been set up. It contains the local port that is being used. For incoming
13187 connections, see &$received_port$&.
13188
13189 .vitem &$smtp_active_hostname$&
13190 .vindex "&$smtp_active_hostname$&"
13191 During an incoming SMTP session, this variable contains the value of the active
13192 host name, as specified by the &%smtp_active_hostname%& option. The value of
13193 &$smtp_active_hostname$& is saved with any message that is received, so its
13194 value can be consulted during routing and delivery.
13195
13196 .vitem &$smtp_command$&
13197 .vindex "&$smtp_command$&"
13198 During the processing of an incoming SMTP command, this variable contains the
13199 entire command. This makes it possible to distinguish between HELO and EHLO in
13200 the HELO ACL, and also to distinguish between commands such as these:
13201 .code
13202 MAIL FROM:<>
13203 MAIL FROM: <>
13204 .endd
13205 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13206 command, the address in &$smtp_command$& is the original address before any
13207 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13208 the address after SMTP-time rewriting.
13209
13210 .vitem &$smtp_command_argument$&
13211 .cindex "SMTP" "command, argument for"
13212 .vindex "&$smtp_command_argument$&"
13213 While an ACL is running to check an SMTP command, this variable contains the
13214 argument, that is, the text that follows the command name, with leading white
13215 space removed. Following the introduction of &$smtp_command$&, this variable is
13216 somewhat redundant, but is retained for backwards compatibility.
13217
13218 .vitem &$smtp_command_history$&
13219 .cindex SMTP "command history"
13220 .vindex "&$smtp_command_history$&"
13221 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13222 received, in time-order left to right.  Only a limited number of commands
13223 are remembered.
13224
13225 .vitem &$smtp_count_at_connection_start$&
13226 .vindex "&$smtp_count_at_connection_start$&"
13227 This variable is set greater than zero only in processes spawned by the Exim
13228 daemon for handling incoming SMTP connections. The name is deliberately long,
13229 in order to emphasize what the contents are. When the daemon accepts a new
13230 connection, it increments this variable. A copy of the variable is passed to
13231 the child process that handles the connection, but its value is fixed, and
13232 never changes. It is only an approximation of how many incoming connections
13233 there actually are, because many other connections may come and go while a
13234 single connection is being processed. When a child process terminates, the
13235 daemon decrements its copy of the variable.
13236
13237 .vitem "&$sn0$& &-- &$sn9$&"
13238 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13239 that were current at the end of the system filter file. This allows a system
13240 filter file to set values that can be tested in users' filter files. For
13241 example, a system filter could set a value indicating how likely it is that a
13242 message is junk mail.
13243
13244 .vitem &$spam_$&&'xxx'&
13245 A number of variables whose names start with &$spam$& are available when Exim
13246 is compiled with the content-scanning extension. For details, see section
13247 &<<SECTscanspamass>>&.
13248
13249 .vitem &$spf_header_comment$& &&&
13250        &$spf_received$& &&&
13251        &$spf_result$& &&&
13252        &$spf_result_guessed$& &&&
13253        &$spf_smtp_comment$&
13254 These variables are only available if Exim is built with SPF support.
13255 For details see section &<<SECSPF>>&.
13256
13257 .vitem &$spool_directory$&
13258 .vindex "&$spool_directory$&"
13259 The name of Exim's spool directory.
13260
13261 .vitem &$spool_inodes$&
13262 .vindex "&$spool_inodes$&"
13263 The number of free inodes in the disk partition where Exim's spool files are
13264 being written. The value is recalculated whenever the variable is referenced.
13265 If the relevant file system does not have the concept of inodes, the value of
13266 is -1. See also the &%check_spool_inodes%& option.
13267
13268 .vitem &$spool_space$&
13269 .vindex "&$spool_space$&"
13270 The amount of free space (as a number of kilobytes) in the disk partition where
13271 Exim's spool files are being written. The value is recalculated whenever the
13272 variable is referenced. If the operating system does not have the ability to
13273 find the amount of free space (only true for experimental systems), the space
13274 value is -1. For example, to check in an ACL that there is at least 50
13275 megabytes free on the spool, you could write:
13276 .code
13277 condition = ${if > {$spool_space}{50000}}
13278 .endd
13279 See also the &%check_spool_space%& option.
13280
13281
13282 .vitem &$thisaddress$&
13283 .vindex "&$thisaddress$&"
13284 This variable is set only during the processing of the &%foranyaddress%&
13285 command in a filter file. Its use is explained in the description of that
13286 command, which can be found in the separate document entitled &'Exim's
13287 interfaces to mail filtering'&.
13288
13289 .vitem &$tls_in_bits$&
13290 .vindex "&$tls_in_bits$&"
13291 Contains an approximation of the TLS cipher's bit-strength
13292 on the inbound connection; the meaning of
13293 this depends upon the TLS implementation used.
13294 If TLS has not been negotiated, the value will be 0.
13295 The value of this is automatically fed into the Cyrus SASL authenticator
13296 when acting as a server, to specify the "external SSF" (a SASL term).
13297
13298 The deprecated &$tls_bits$& variable refers to the inbound side
13299 except when used in the context of an outbound SMTP delivery, when it refers to
13300 the outbound.
13301
13302 .vitem &$tls_out_bits$&
13303 .vindex "&$tls_out_bits$&"
13304 Contains an approximation of the TLS cipher's bit-strength
13305 on an outbound SMTP connection; the meaning of
13306 this depends upon the TLS implementation used.
13307 If TLS has not been negotiated, the value will be 0.
13308
13309 .vitem &$tls_in_ourcert$&
13310 .vindex "&$tls_in_ourcert$&"
13311 .cindex certificate variables
13312 This variable refers to the certificate presented to the peer of an
13313 inbound connection when the message was received.
13314 It is only useful as the argument of a
13315 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13316 or a &%def%& condition.
13317
13318 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13319 when a list of more than one
13320 file is used for &%tls_certificate%&, this variable is not reliable.
13321
13322 .vitem &$tls_in_peercert$&
13323 .vindex "&$tls_in_peercert$&"
13324 This variable refers to the certificate presented by the peer of an
13325 inbound connection when the message was received.
13326 It is only useful as the argument of a
13327 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13328 or a &%def%& condition.
13329 If certificate verification fails it may refer to a failing chain element
13330 which is not the leaf.
13331
13332 .vitem &$tls_out_ourcert$&
13333 .vindex "&$tls_out_ourcert$&"
13334 This variable refers to the certificate presented to the peer of an
13335 outbound connection.  It is only useful as the argument of a
13336 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13337 or a &%def%& condition.
13338
13339 .vitem &$tls_out_peercert$&
13340 .vindex "&$tls_out_peercert$&"
13341 This variable refers to the certificate presented by the peer of an
13342 outbound connection.  It is only useful as the argument of a
13343 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13344 or a &%def%& condition.
13345 If certificate verification fails it may refer to a failing chain element
13346 which is not the leaf.
13347
13348 .vitem &$tls_in_certificate_verified$&
13349 .vindex "&$tls_in_certificate_verified$&"
13350 This variable is set to &"1"& if a TLS certificate was verified when the
13351 message was received, and &"0"& otherwise.
13352
13353 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13354 except when used in the context of an outbound SMTP delivery, when it refers to
13355 the outbound.
13356
13357 .vitem &$tls_out_certificate_verified$&
13358 .vindex "&$tls_out_certificate_verified$&"
13359 This variable is set to &"1"& if a TLS certificate was verified when an
13360 outbound SMTP connection was made,
13361 and &"0"& otherwise.
13362
13363 .vitem &$tls_in_cipher$&
13364 .vindex "&$tls_in_cipher$&"
13365 .vindex "&$tls_cipher$&"
13366 When a message is received from a remote host over an encrypted SMTP
13367 connection, this variable is set to the cipher suite that was negotiated, for
13368 example DES-CBC3-SHA. In other circumstances, in particular, for message
13369 received over unencrypted connections, the variable is empty. Testing
13370 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13371 non-encrypted connections during ACL processing.
13372
13373 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13374 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13375 becomes the same as &$tls_out_cipher$&.
13376
13377 .new
13378 .vitem &$tls_in_cipher_std$&
13379 .vindex "&$tls_in_cipher_std$&"
13380 As above, but returning the RFC standard name for the cipher suite.
13381 .wen
13382
13383 .vitem &$tls_out_cipher$&
13384 .vindex "&$tls_out_cipher$&"
13385 This variable is
13386 cleared before any outgoing SMTP connection is made,
13387 and then set to the outgoing cipher suite if one is negotiated. See chapter
13388 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13389 details of the &(smtp)& transport.
13390
13391 ,new
13392 .vitem &$tls_out_cipher_std$&
13393 .vindex "&$tls_out_cipher_std$&"
13394 As above, but returning the RFC standard name for the cipher suite.
13395 .wen
13396
13397 .vitem &$tls_out_dane$&
13398 .vindex &$tls_out_dane$&
13399 DANE active status.  See section &<<SECDANE>>&.
13400
13401 .vitem &$tls_in_ocsp$&
13402 .vindex "&$tls_in_ocsp$&"
13403 When a message is received from a remote client connection
13404 the result of any OCSP request from the client is encoded in this variable:
13405 .code
13406 0 OCSP proof was not requested (default value)
13407 1 No response to request
13408 2 Response not verified
13409 3 Verification failed
13410 4 Verification succeeded
13411 .endd
13412
13413 .vitem &$tls_out_ocsp$&
13414 .vindex "&$tls_out_ocsp$&"
13415 When a message is sent to a remote host connection
13416 the result of any OCSP request made is encoded in this variable.
13417 See &$tls_in_ocsp$& for values.
13418
13419 .vitem &$tls_in_peerdn$&
13420 .vindex "&$tls_in_peerdn$&"
13421 .vindex "&$tls_peerdn$&"
13422 .cindex certificate "extracting fields"
13423 When a message is received from a remote host over an encrypted SMTP
13424 connection, and Exim is configured to request a certificate from the client,
13425 the value of the Distinguished Name of the certificate is made available in the
13426 &$tls_in_peerdn$& during subsequent processing.
13427 If certificate verification fails it may refer to a failing chain element
13428 which is not the leaf.
13429
13430 The deprecated &$tls_peerdn$& variable refers to the inbound side
13431 except when used in the context of an outbound SMTP delivery, when it refers to
13432 the outbound.
13433
13434 .vitem &$tls_out_peerdn$&
13435 .vindex "&$tls_out_peerdn$&"
13436 When a message is being delivered to a remote host over an encrypted SMTP
13437 connection, and Exim is configured to request a certificate from the server,
13438 the value of the Distinguished Name of the certificate is made available in the
13439 &$tls_out_peerdn$& during subsequent processing.
13440 If certificate verification fails it may refer to a failing chain element
13441 which is not the leaf.
13442
13443 .vitem &$tls_in_sni$&
13444 .vindex "&$tls_in_sni$&"
13445 .vindex "&$tls_sni$&"
13446 .cindex "TLS" "Server Name Indication"
13447 When a TLS session is being established, if the client sends the Server
13448 Name Indication extension, the value will be placed in this variable.
13449 If the variable appears in &%tls_certificate%& then this option and
13450 some others, described in &<<SECTtlssni>>&,
13451 will be re-expanded early in the TLS session, to permit
13452 a different certificate to be presented (and optionally a different key to be
13453 used) to the client, based upon the value of the SNI extension.
13454
13455 The deprecated &$tls_sni$& variable refers to the inbound side
13456 except when used in the context of an outbound SMTP delivery, when it refers to
13457 the outbound.
13458
13459 .vitem &$tls_out_sni$&
13460 .vindex "&$tls_out_sni$&"
13461 .cindex "TLS" "Server Name Indication"
13462 During outbound
13463 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13464 the transport.
13465
13466 .vitem &$tls_out_tlsa_usage$&
13467 .vindex &$tls_out_tlsa_usage$&
13468 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13469
13470 .vitem &$tod_bsdinbox$&
13471 .vindex "&$tod_bsdinbox$&"
13472 The time of day and the date, in the format required for BSD-style mailbox
13473 files, for example: Thu Oct 17 17:14:09 1995.
13474
13475 .vitem &$tod_epoch$&
13476 .vindex "&$tod_epoch$&"
13477 The time and date as a number of seconds since the start of the Unix epoch.
13478
13479 .vitem &$tod_epoch_l$&
13480 .vindex "&$tod_epoch_l$&"
13481 The time and date as a number of microseconds since the start of the Unix epoch.
13482
13483 .vitem &$tod_full$&
13484 .vindex "&$tod_full$&"
13485 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13486 +0100. The timezone is always given as a numerical offset from UTC, with
13487 positive values used for timezones that are ahead (east) of UTC, and negative
13488 values for those that are behind (west).
13489
13490 .vitem &$tod_log$&
13491 .vindex "&$tod_log$&"
13492 The time and date in the format used for writing Exim's log files, for example:
13493 1995-10-12 15:32:29, but without a timezone.
13494
13495 .vitem &$tod_logfile$&
13496 .vindex "&$tod_logfile$&"
13497 This variable contains the date in the format yyyymmdd. This is the format that
13498 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13499 flag.
13500
13501 .vitem &$tod_zone$&
13502 .vindex "&$tod_zone$&"
13503 This variable contains the numerical value of the local timezone, for example:
13504 -0500.
13505
13506 .vitem &$tod_zulu$&
13507 .vindex "&$tod_zulu$&"
13508 This variable contains the UTC date and time in &"Zulu"& format, as specified
13509 by ISO 8601, for example: 20030221154023Z.
13510
13511 .vitem &$transport_name$&
13512 .cindex "transport" "name"
13513 .cindex "name" "of transport"
13514 .vindex "&$transport_name$&"
13515 During the running of a transport, this variable contains its name.
13516
13517 .vitem &$value$&
13518 .vindex "&$value$&"
13519 This variable contains the result of an expansion lookup, extraction operation,
13520 or external command, as described above. It is also used during a
13521 &*reduce*& expansion.
13522
13523 .vitem &$verify_mode$&
13524 .vindex "&$verify_mode$&"
13525 While a router or transport is being run in verify mode or for cutthrough delivery,
13526 contains "S" for sender-verification or "R" for recipient-verification.
13527 Otherwise, empty.
13528
13529 .vitem &$version_number$&
13530 .vindex "&$version_number$&"
13531 The version number of Exim. Same as &$exim_version$&, may be overridden
13532 by the &%exim_version%& main config option.
13533
13534 .vitem &$warn_message_delay$&
13535 .vindex "&$warn_message_delay$&"
13536 This variable is set only during the creation of a message warning about a
13537 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13538
13539 .vitem &$warn_message_recipients$&
13540 .vindex "&$warn_message_recipients$&"
13541 This variable is set only during the creation of a message warning about a
13542 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13543 .endlist
13544 .ecindex IIDstrexp
13545
13546
13547
13548 . ////////////////////////////////////////////////////////////////////////////
13549 . ////////////////////////////////////////////////////////////////////////////
13550
13551 .chapter "Embedded Perl" "CHAPperl"
13552 .scindex IIDperl "Perl" "calling from Exim"
13553 Exim can be built to include an embedded Perl interpreter. When this is done,
13554 Perl subroutines can be called as part of the string expansion process. To make
13555 use of the Perl support, you need version 5.004 or later of Perl installed on
13556 your system. To include the embedded interpreter in the Exim binary, include
13557 the line
13558 .code
13559 EXIM_PERL = perl.o
13560 .endd
13561 in your &_Local/Makefile_& and then build Exim in the normal way.
13562
13563
13564 .section "Setting up so Perl can be used" "SECID85"
13565 .oindex "&%perl_startup%&"
13566 Access to Perl subroutines is via a global configuration option called
13567 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13568 no &%perl_startup%& option in the Exim configuration file then no Perl
13569 interpreter is started and there is almost no overhead for Exim (since none of
13570 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13571 option then the associated value is taken to be Perl code which is executed in
13572 a newly created Perl interpreter.
13573
13574 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13575 need backslashes before any characters to escape special meanings. The option
13576 should usually be something like
13577 .code
13578 perl_startup = do '/etc/exim.pl'
13579 .endd
13580 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13581 use from Exim. Exim can be configured either to start up a Perl interpreter as
13582 soon as it is entered, or to wait until the first time it is needed. Starting
13583 the interpreter at the beginning ensures that it is done while Exim still has
13584 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13585 fact used in a particular run. Also, note that this does not mean that Exim is
13586 necessarily running as root when Perl is called at a later time. By default,
13587 the interpreter is started only when it is needed, but this can be changed in
13588 two ways:
13589
13590 .ilist
13591 .oindex "&%perl_at_start%&"
13592 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13593 a startup when Exim is entered.
13594 .next
13595 The command line option &%-ps%& also requests a startup when Exim is entered,
13596 overriding the setting of &%perl_at_start%&.
13597 .endlist
13598
13599 There is also a command line option &%-pd%& (for delay) which suppresses the
13600 initial startup, even if &%perl_at_start%& is set.
13601
13602 .ilist
13603 .oindex "&%perl_taintmode%&"
13604 .cindex "Perl" "taintmode"
13605 To provide more security executing Perl code via the embedded Perl
13606 interpreter, the &%perl_taintmode%& option can be set. This enables the
13607 taint mode of the Perl interpreter. You are encouraged to set this
13608 option to a true value. To avoid breaking existing installations, it
13609 defaults to false.
13610
13611
13612 .section "Calling Perl subroutines" "SECID86"
13613 When the configuration file includes a &%perl_startup%& option you can make use
13614 of the string expansion item to call the Perl subroutines that are defined
13615 by the &%perl_startup%& code. The operator is used in any of the following
13616 forms:
13617 .code
13618 ${perl{foo}}
13619 ${perl{foo}{argument}}
13620 ${perl{foo}{argument1}{argument2} ... }
13621 .endd
13622 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13623 arguments may be passed. Passing more than this results in an expansion failure
13624 with an error message of the form
13625 .code
13626 Too many arguments passed to Perl subroutine "foo" (max is 8)
13627 .endd
13628 The return value of the Perl subroutine is evaluated in a scalar context before
13629 it is passed back to Exim to be inserted into the expanded string. If the
13630 return value is &'undef'&, the expansion is forced to fail in the same way as
13631 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13632 by obeying Perl's &%die%& function, the expansion fails with the error message
13633 that was passed to &%die%&.
13634
13635
13636 .section "Calling Exim functions from Perl" "SECID87"
13637 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13638 is available to call back into Exim's string expansion function. For example,
13639 the Perl code
13640 .code
13641 my $lp = Exim::expand_string('$local_part');
13642 .endd
13643 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13644 Note those are single quotes and not double quotes to protect against
13645 &$local_part$& being interpolated as a Perl variable.
13646
13647 If the string expansion is forced to fail by a &"fail"& item, the result of
13648 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13649 expansion string, the Perl call from the original expansion string fails with
13650 an appropriate error message, in the same way as if &%die%& were used.
13651
13652 .cindex "debugging" "from embedded Perl"
13653 .cindex "log" "writing from embedded Perl"
13654 Two other Exim functions are available for use from within Perl code.
13655 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13656 debugging is enabled. If you want a newline at the end, you must supply it.
13657 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13658 timestamp. In this case, you should not supply a terminating newline.
13659
13660
13661 .section "Use of standard output and error by Perl" "SECID88"
13662 .cindex "Perl" "standard output and error"
13663 You should not write to the standard error or output streams from within your
13664 Perl code, as it is not defined how these are set up. In versions of Exim
13665 before 4.50, it is possible for the standard output or error to refer to the
13666 SMTP connection during message reception via the daemon. Writing to this stream
13667 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13668 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13669 avoided, but the output is lost.
13670
13671 .cindex "Perl" "use of &%warn%&"
13672 The Perl &%warn%& statement writes to the standard error stream by default.
13673 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13674 you have no control. When Exim starts up the Perl interpreter, it arranges for
13675 output from the &%warn%& statement to be written to the Exim main log. You can
13676 change this by including appropriate Perl magic somewhere in your Perl code.
13677 For example, to discard &%warn%& output completely, you need this:
13678 .code
13679 $SIG{__WARN__} = sub { };
13680 .endd
13681 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13682 example, the code for the subroutine is empty, so it does nothing, but you can
13683 include any Perl code that you like. The text of the &%warn%& message is passed
13684 as the first subroutine argument.
13685 .ecindex IIDperl
13686
13687
13688 . ////////////////////////////////////////////////////////////////////////////
13689 . ////////////////////////////////////////////////////////////////////////////
13690
13691 .chapter "Starting the daemon and the use of network interfaces" &&&
13692          "CHAPinterfaces" &&&
13693          "Starting the daemon"
13694 .cindex "daemon" "starting"
13695 .cindex "interface" "listening"
13696 .cindex "network interface"
13697 .cindex "interface" "network"
13698 .cindex "IP address" "for listening"
13699 .cindex "daemon" "listening IP addresses"
13700 .cindex "TCP/IP" "setting listening interfaces"
13701 .cindex "TCP/IP" "setting listening ports"
13702 A host that is connected to a TCP/IP network may have one or more physical
13703 hardware network interfaces. Each of these interfaces may be configured as one
13704 or more &"logical"& interfaces, which are the entities that a program actually
13705 works with. Each of these logical interfaces is associated with an IP address.
13706 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13707 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13708 knowledge about the host's interfaces for use in three different circumstances:
13709
13710 .olist
13711 When a listening daemon is started, Exim needs to know which interfaces
13712 and ports to listen on.
13713 .next
13714 When Exim is routing an address, it needs to know which IP addresses
13715 are associated with local interfaces. This is required for the correct
13716 processing of MX lists by removing the local host and others with the
13717 same or higher priority values. Also, Exim needs to detect cases
13718 when an address is routed to an IP address that in fact belongs to the
13719 local host. Unless the &%self%& router option or the &%allow_localhost%&
13720 option of the smtp transport is set (as appropriate), this is treated
13721 as an error situation.
13722 .next
13723 When Exim connects to a remote host, it may need to know which interface to use
13724 for the outgoing connection.
13725 .endlist
13726
13727
13728 Exim's default behaviour is likely to be appropriate in the vast majority
13729 of cases. If your host has only one interface, and you want all its IP
13730 addresses to be treated in the same way, and you are using only the
13731 standard SMTP port, you should not need to take any special action. The
13732 rest of this chapter does not apply to you.
13733
13734 In a more complicated situation you may want to listen only on certain
13735 interfaces, or on different ports, and for this reason there are a number of
13736 options that can be used to influence Exim's behaviour. The rest of this
13737 chapter describes how they operate.
13738
13739 When a message is received over TCP/IP, the interface and port that were
13740 actually used are set in &$received_ip_address$& and &$received_port$&.
13741
13742
13743
13744 .section "Starting a listening daemon" "SECID89"
13745 When a listening daemon is started (by means of the &%-bd%& command line
13746 option), the interfaces and ports on which it listens are controlled by the
13747 following options:
13748
13749 .ilist
13750 &%daemon_smtp_ports%& contains a list of default ports
13751 or service names.
13752 (For backward compatibility, this option can also be specified in the singular.)
13753 .next
13754 &%local_interfaces%& contains list of interface IP addresses on which to
13755 listen. Each item may optionally also specify a port.
13756 .endlist
13757
13758 The default list separator in both cases is a colon, but this can be changed as
13759 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13760 it is usually best to change the separator to avoid having to double all the
13761 colons. For example:
13762 .code
13763 local_interfaces = <; 127.0.0.1 ; \
13764                       192.168.23.65 ; \
13765                       ::1 ; \
13766                       3ffe:ffff:836f::fe86:a061
13767 .endd
13768 There are two different formats for specifying a port along with an IP address
13769 in &%local_interfaces%&:
13770
13771 .olist
13772 The port is added onto the address with a dot separator. For example, to listen
13773 on port 1234 on two different IP addresses:
13774 .code
13775 local_interfaces = <; 192.168.23.65.1234 ; \
13776                       3ffe:ffff:836f::fe86:a061.1234
13777 .endd
13778 .next
13779 The IP address is enclosed in square brackets, and the port is added
13780 with a colon separator, for example:
13781 .code
13782 local_interfaces = <; [192.168.23.65]:1234 ; \
13783                       [3ffe:ffff:836f::fe86:a061]:1234
13784 .endd
13785 .endlist
13786
13787 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13788 default setting contains just one port:
13789 .code
13790 daemon_smtp_ports = smtp
13791 .endd
13792 If more than one port is listed, each interface that does not have its own port
13793 specified listens on all of them. Ports that are listed in
13794 &%daemon_smtp_ports%& can be identified either by name (defined in
13795 &_/etc/services_&) or by number. However, when ports are given with individual
13796 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13797
13798
13799
13800 .section "Special IP listening addresses" "SECID90"
13801 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13802 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13803 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13804 instead of setting up separate listening sockets for each interface. The
13805 default value of &%local_interfaces%& is
13806 .code
13807 local_interfaces = 0.0.0.0
13808 .endd
13809 when Exim is built without IPv6 support; otherwise it is:
13810 .code
13811 local_interfaces = <; ::0 ; 0.0.0.0
13812 .endd
13813 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13814
13815
13816
13817 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13818 The &%-oX%& command line option can be used to override the values of
13819 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13820 instance. Another way of doing this would be to use macros and the &%-D%&
13821 option. However, &%-oX%& can be used by any admin user, whereas modification of
13822 the runtime configuration by &%-D%& is allowed only when the caller is root or
13823 exim.
13824
13825 The value of &%-oX%& is a list of items. The default colon separator can be
13826 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13827 If there are any items that do not
13828 contain dots or colons (that is, are not IP addresses), the value of
13829 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13830 items that do contain dots or colons, the value of &%local_interfaces%& is
13831 replaced by those items. Thus, for example,
13832 .code
13833 -oX 1225
13834 .endd
13835 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13836 whereas
13837 .code
13838 -oX 192.168.34.5.1125
13839 .endd
13840 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13841 (However, since &%local_interfaces%& now contains no items without ports, the
13842 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13843
13844
13845
13846 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13847 .cindex "submissions protocol"
13848 .cindex "ssmtp protocol"
13849 .cindex "smtps protocol"
13850 .cindex "SMTP" "ssmtp protocol"
13851 .cindex "SMTP" "smtps protocol"
13852 Exim supports the use of TLS-on-connect, used by mail clients in the
13853 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13854 For some years, IETF Standards Track documents only blessed the
13855 STARTTLS-based Submission service (port 587) while common practice was to support
13856 the same feature set on port 465, but using TLS-on-connect.
13857 If your installation needs to provide service to mail clients
13858 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13859 the 465 TCP ports.
13860
13861 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13862 service names, connections to those ports must first establish TLS, before
13863 proceeding to the application layer use of the SMTP protocol.
13864
13865 The common use of this option is expected to be
13866 .code
13867 tls_on_connect_ports = 465
13868 .endd
13869 per RFC 8314.
13870 There is also a command line option &%-tls-on-connect%&, which forces all ports
13871 to behave in this way when a daemon is started.
13872
13873 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13874 daemon to listen on those ports. You must still specify them in
13875 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13876 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13877 connections via the daemon.)
13878
13879
13880
13881
13882 .section "IPv6 address scopes" "SECID92"
13883 .cindex "IPv6" "address scopes"
13884 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13885 can, in principle, have the same link-local IPv6 address on different
13886 interfaces. Thus, additional information is needed, over and above the IP
13887 address, to distinguish individual interfaces. A convention of using a
13888 percent sign followed by something (often the interface name) has been
13889 adopted in some cases, leading to addresses like this:
13890 .code
13891 fe80::202:b3ff:fe03:45c1%eth0
13892 .endd
13893 To accommodate this usage, a percent sign followed by an arbitrary string is
13894 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13895 to convert a textual IPv6 address for actual use. This function recognizes the
13896 percent convention in operating systems that support it, and it processes the
13897 address appropriately. Unfortunately, some older libraries have problems with
13898 &[getaddrinfo()]&. If
13899 .code
13900 IPV6_USE_INET_PTON=yes
13901 .endd
13902 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13903 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13904 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13905 function.) Of course, this means that the additional functionality of
13906 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13907
13908 .section "Disabling IPv6" "SECID93"
13909 .cindex "IPv6" "disabling"
13910 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13911 run on a host whose kernel does not support IPv6. The binary will fall back to
13912 using IPv4, but it may waste resources looking up AAAA records, and trying to
13913 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13914 .oindex "&%disable_ipv6%&"
13915 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13916 activities take place. AAAA records are never looked up, and any IPv6 addresses
13917 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13918 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13919 to handle IPv6 literal addresses.
13920
13921 On the other hand, when IPv6 is in use, there may be times when you want to
13922 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13923 option to globally suppress the lookup of AAAA records for specified domains,
13924 and you can use the &%ignore_target_hosts%& generic router option to ignore
13925 IPv6 addresses in an individual router.
13926
13927
13928
13929 .section "Examples of starting a listening daemon" "SECID94"
13930 The default case in an IPv6 environment is
13931 .code
13932 daemon_smtp_ports = smtp
13933 local_interfaces = <; ::0 ; 0.0.0.0
13934 .endd
13935 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13936 Either one or two sockets may be used, depending on the characteristics of
13937 the TCP/IP stack. (This is complicated and messy; for more information,
13938 read the comments in the &_daemon.c_& source file.)
13939
13940 To specify listening on ports 25 and 26 on all interfaces:
13941 .code
13942 daemon_smtp_ports = 25 : 26
13943 .endd
13944 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13945 .code
13946 local_interfaces = <; ::0.25     ; ::0.26 \
13947                       0.0.0.0.25 ; 0.0.0.0.26
13948 .endd
13949 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13950 IPv4 loopback address only:
13951 .code
13952 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13953 .endd
13954 To specify listening on the default port on specific interfaces only:
13955 .code
13956 local_interfaces = 10.0.0.67 : 192.168.34.67
13957 .endd
13958 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13959
13960
13961
13962 .section "Recognizing the local host" "SECTreclocipadd"
13963 The &%local_interfaces%& option is also used when Exim needs to determine
13964 whether or not an IP address refers to the local host. That is, the IP
13965 addresses of all the interfaces on which a daemon is listening are always
13966 treated as local.
13967
13968 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13969 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13970 available interfaces from the operating system, and extracts the relevant
13971 (that is, IPv4 or IPv6) addresses to use for checking.
13972
13973 Some systems set up large numbers of virtual interfaces in order to provide
13974 many virtual web servers. In this situation, you may want to listen for
13975 email on only a few of the available interfaces, but nevertheless treat all
13976 interfaces as local when routing. You can do this by setting
13977 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13978 &"all"& wildcard values. These addresses are recognized as local, but are not
13979 used for listening. Consider this example:
13980 .code
13981 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13982                       192.168.53.235 ; \
13983                       3ffe:2101:12:1:a00:20ff:fe86:a061
13984
13985 extra_local_interfaces = <; ::0 ; 0.0.0.0
13986 .endd
13987 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13988 address, but all available interface addresses are treated as local when
13989 Exim is routing.
13990
13991 In some environments the local host name may be in an MX list, but with an IP
13992 address that is not assigned to any local interface. In other cases it may be
13993 desirable to treat other host names as if they referred to the local host. Both
13994 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13995 This contains host names rather than IP addresses. When a host is referenced
13996 during routing, either via an MX record or directly, it is treated as the local
13997 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13998 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13999
14000
14001
14002 .section "Delivering to a remote host" "SECID95"
14003 Delivery to a remote host is handled by the smtp transport. By default, it
14004 allows the system's TCP/IP functions to choose which interface to use (if
14005 there is more than one) when connecting to a remote host. However, the
14006 &%interface%& option can be set to specify which interface is used. See the
14007 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14008 details.
14009
14010
14011
14012
14013 . ////////////////////////////////////////////////////////////////////////////
14014 . ////////////////////////////////////////////////////////////////////////////
14015
14016 .chapter "Main configuration" "CHAPmainconfig"
14017 .scindex IIDconfima "configuration file" "main section"
14018 .scindex IIDmaiconf "main configuration"
14019 The first part of the runtime configuration file contains three types of item:
14020
14021 .ilist
14022 Macro definitions: These lines start with an upper case letter. See section
14023 &<<SECTmacrodefs>>& for details of macro processing.
14024 .next
14025 Named list definitions: These lines start with one of the words &"domainlist"&,
14026 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14027 section &<<SECTnamedlists>>&.
14028 .next
14029 Main configuration settings: Each setting occupies one line of the file
14030 (with possible continuations). If any setting is preceded by the word
14031 &"hide"&, the &%-bP%& command line option displays its value to admin users
14032 only. See section &<<SECTcos>>& for a description of the syntax of these option
14033 settings.
14034 .endlist
14035
14036 This chapter specifies all the main configuration options, along with their
14037 types and default values. For ease of finding a particular option, they appear
14038 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14039 are now so many options, they are first listed briefly in functional groups, as
14040 an aid to finding the name of the option you are looking for. Some options are
14041 listed in more than one group.
14042
14043 .section "Miscellaneous" "SECID96"
14044 .table2
14045 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14046 .row &%debug_store%&                 "do extra internal checks"
14047 .row &%disable_ipv6%&                "do no IPv6 processing"
14048 .row &%keep_malformed%&              "for broken files &-- should not happen"
14049 .row &%localhost_number%&            "for unique message ids in clusters"
14050 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14051 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14052 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14053 .row &%print_topbitchars%&           "top-bit characters are printing"
14054 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14055 .row &%timezone%&                    "force time zone"
14056 .endtable
14057
14058
14059 .section "Exim parameters" "SECID97"
14060 .table2
14061 .row &%exim_group%&                  "override compiled-in value"
14062 .row &%exim_path%&                   "override compiled-in value"
14063 .row &%exim_user%&                   "override compiled-in value"
14064 .row &%primary_hostname%&            "default from &[uname()]&"
14065 .row &%split_spool_directory%&       "use multiple directories"
14066 .row &%spool_directory%&             "override compiled-in value"
14067 .endtable
14068
14069
14070
14071 .section "Privilege controls" "SECID98"
14072 .table2
14073 .row &%admin_groups%&                "groups that are Exim admin users"
14074 .row &%commandline_checks_require_admin%& "require admin for various checks"
14075 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14076 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14077 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14078 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14079 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14080 .row &%never_users%&                 "do not run deliveries as these"
14081 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14082 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14083 .row &%trusted_groups%&              "groups that are trusted"
14084 .row &%trusted_users%&               "users that are trusted"
14085 .endtable
14086
14087
14088
14089 .section "Logging" "SECID99"
14090 .table2
14091 .row &%event_action%&                "custom logging"
14092 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14093 .row &%log_file_path%&               "override compiled-in value"
14094 .row &%log_selector%&                "set/unset optional logging"
14095 .row &%log_timezone%&                "add timezone to log lines"
14096 .row &%message_logs%&                "create per-message logs"
14097 .row &%preserve_message_logs%&       "after message completion"
14098 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14099 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14100 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14101 .row &%syslog_facility%&             "set syslog &""facility""& field"
14102 .row &%syslog_pid%&                  "pid in syslog lines"
14103 .row &%syslog_processname%&          "set syslog &""ident""& field"
14104 .row &%syslog_timestamp%&            "timestamp syslog lines"
14105 .row &%write_rejectlog%&             "control use of message log"
14106 .endtable
14107
14108
14109
14110 .section "Frozen messages" "SECID100"
14111 .table2
14112 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14113 .row &%freeze_tell%&                 "send message when freezing"
14114 .row &%move_frozen_messages%&        "to another directory"
14115 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14116 .endtable
14117
14118
14119
14120 .section "Data lookups" "SECID101"
14121 .table2
14122 .row &%ibase_servers%&               "InterBase servers"
14123 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14124 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14125 .row &%ldap_cert_file%&              "client cert file for LDAP"
14126 .row &%ldap_cert_key%&               "client key file for LDAP"
14127 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14128 .row &%ldap_default_servers%&        "used if no server in query"
14129 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14130 .row &%ldap_start_tls%&              "require TLS within LDAP"
14131 .row &%ldap_version%&                "set protocol version"
14132 .row &%lookup_open_max%&             "lookup files held open"
14133 .row &%mysql_servers%&               "default MySQL servers"
14134 .row &%oracle_servers%&              "Oracle servers"
14135 .row &%pgsql_servers%&               "default PostgreSQL servers"
14136 .row &%sqlite_lock_timeout%&         "as it says"
14137 .endtable
14138
14139
14140
14141 .section "Message ids" "SECID102"
14142 .table2
14143 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14144 .row &%message_id_header_text%&      "ditto"
14145 .endtable
14146
14147
14148
14149 .section "Embedded Perl Startup" "SECID103"
14150 .table2
14151 .row &%perl_at_start%&               "always start the interpreter"
14152 .row &%perl_startup%&                "code to obey when starting Perl"
14153 .row &%perl_taintmode%&              "enable taint mode in Perl"
14154 .endtable
14155
14156
14157
14158 .section "Daemon" "SECID104"
14159 .table2
14160 .row &%daemon_smtp_ports%&           "default ports"
14161 .row &%daemon_startup_retries%&      "number of times to retry"
14162 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14163 .row &%extra_local_interfaces%&      "not necessarily listened on"
14164 .row &%local_interfaces%&            "on which to listen, with optional ports"
14165 .row &%pid_file_path%&               "override compiled-in value"
14166 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14167 .endtable
14168
14169
14170
14171 .section "Resource control" "SECID105"
14172 .table2
14173 .row &%check_log_inodes%&            "before accepting a message"
14174 .row &%check_log_space%&             "before accepting a message"
14175 .row &%check_spool_inodes%&          "before accepting a message"
14176 .row &%check_spool_space%&           "before accepting a message"
14177 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14178 .row &%queue_only_load%&             "queue incoming if load high"
14179 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14180 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14181 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14182 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14183 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14184 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14185 .row &%smtp_accept_max_per_connection%& "messages per connection"
14186 .row &%smtp_accept_max_per_host%&    "connections from one host"
14187 .row &%smtp_accept_queue%&           "queue mail if more connections"
14188 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14189                                            connection"
14190 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14191 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14192 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14193 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14194 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14195 .endtable
14196
14197
14198
14199 .section "Policy controls" "SECID106"
14200 .table2
14201 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14202 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14203 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14204 .row &%acl_smtp_auth%&               "ACL for AUTH"
14205 .row &%acl_smtp_connect%&            "ACL for connection"
14206 .row &%acl_smtp_data%&               "ACL for DATA"
14207 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14208 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14209 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14210 .row &%acl_smtp_expn%&               "ACL for EXPN"
14211 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14212 .row &%acl_smtp_mail%&               "ACL for MAIL"
14213 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14214 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14215 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14216 .row &%acl_smtp_predata%&            "ACL for start of data"
14217 .row &%acl_smtp_quit%&               "ACL for QUIT"
14218 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14219 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14220 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14221 .row &%av_scanner%&                  "specify virus scanner"
14222 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14223                                       words""&"
14224 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14225 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14226 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14227 .row &%header_maxsize%&              "total size of message header"
14228 .row &%header_line_maxsize%&         "individual header line limit"
14229 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14230 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14231 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14232 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14233 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14234 .row &%host_lookup%&                 "host name looked up for these hosts"
14235 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14236 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14237 .row &%host_reject_connection%&      "reject connection from these hosts"
14238 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14239 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14240 .row &%message_size_limit%&          "for all messages"
14241 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14242 .row &%spamd_address%&               "set interface to SpamAssassin"
14243 .row &%strict_acl_vars%&             "object to unset ACL variables"
14244 .endtable
14245
14246
14247
14248 .section "Callout cache" "SECID107"
14249 .table2
14250 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14251                                          item"
14252 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14253                                          item"
14254 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14255 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14256 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14257 .endtable
14258
14259
14260
14261 .section "TLS" "SECID108"
14262 .table2
14263 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14264 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14265 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14266 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14267 .row &%tls_certificate%&             "location of server certificate"
14268 .row &%tls_crl%&                     "certificate revocation list"
14269 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14270 .row &%tls_dhparam%&                 "DH parameters for server"
14271 .row &%tls_eccurve%&                 "EC curve selection for server"
14272 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14273 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14274 .row &%tls_privatekey%&              "location of server private key"
14275 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14276 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14277 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14278 .row &%tls_verify_certificates%&     "expected client certificates"
14279 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14280 .endtable
14281
14282
14283
14284 .section "Local user handling" "SECID109"
14285 .table2
14286 .row &%finduser_retries%&            "useful in NIS environments"
14287 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14288 .row &%gecos_pattern%&               "ditto"
14289 .row &%max_username_length%&         "for systems that truncate"
14290 .row &%unknown_login%&               "used when no login name found"
14291 .row &%unknown_username%&            "ditto"
14292 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14293 .row &%uucp_from_sender%&            "ditto"
14294 .endtable
14295
14296
14297
14298 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14299 .table2
14300 .row &%header_maxsize%&              "total size of message header"
14301 .row &%header_line_maxsize%&         "individual header line limit"
14302 .row &%message_size_limit%&          "applies to all messages"
14303 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14304 .row &%received_header_text%&        "expanded to make &'Received:'&"
14305 .row &%received_headers_max%&        "for mail loop detection"
14306 .row &%recipients_max%&              "limit per message"
14307 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14308 .endtable
14309
14310
14311
14312
14313 .section "Non-SMTP incoming messages" "SECID111"
14314 .table2
14315 .row &%receive_timeout%&             "for non-SMTP messages"
14316 .endtable
14317
14318
14319
14320
14321
14322 .section "Incoming SMTP messages" "SECID112"
14323 See also the &'Policy controls'& section above.
14324
14325 .table2
14326 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
14327 .row &%host_lookup%&                 "host name looked up for these hosts"
14328 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14329 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14330 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14331 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14332 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14333 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14334 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14335 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14336 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14337 .row &%smtp_accept_max_per_connection%& "messages per connection"
14338 .row &%smtp_accept_max_per_host%&    "connections from one host"
14339 .row &%smtp_accept_queue%&           "queue mail if more connections"
14340 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14341                                            connection"
14342 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14343 .row &%smtp_active_hostname%&        "host name to use in messages"
14344 .row &%smtp_banner%&                 "text for welcome banner"
14345 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14346 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14347 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14348 .row &%smtp_etrn_command%&           "what to run for ETRN"
14349 .row &%smtp_etrn_serialize%&         "only one at once"
14350 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14351 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14352 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14353 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14354 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14355 .row &%smtp_receive_timeout%&        "per command or data line"
14356 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14357 .row &%smtp_return_error_details%&   "give detail on rejections"
14358 .endtable
14359
14360
14361
14362 .section "SMTP extensions" "SECID113"
14363 .table2
14364 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14365 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14366 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14367 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14368 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14369 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14370 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14371 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14372 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14373 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14374 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14375 .endtable
14376
14377
14378
14379 .section "Processing messages" "SECID114"
14380 .table2
14381 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14382 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14383 .row &%allow_utf8_domains%&          "in addresses"
14384 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14385                                       words""&"
14386 .row &%delivery_date_remove%&        "from incoming messages"
14387 .row &%envelope_to_remove%&          "from incoming messages"
14388 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14389 .row &%headers_charset%&             "default for translations"
14390 .row &%qualify_domain%&              "default for senders"
14391 .row &%qualify_recipient%&           "default for recipients"
14392 .row &%return_path_remove%&          "from incoming messages"
14393 .row &%strip_excess_angle_brackets%& "in addresses"
14394 .row &%strip_trailing_dot%&          "at end of addresses"
14395 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14396 .endtable
14397
14398
14399
14400 .section "System filter" "SECID115"
14401 .table2
14402 .row &%system_filter%&               "locate system filter"
14403 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14404                                             directory"
14405 .row &%system_filter_file_transport%& "transport for delivery to a file"
14406 .row &%system_filter_group%&         "group for filter running"
14407 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14408 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14409 .row &%system_filter_user%&          "user for filter running"
14410 .endtable
14411
14412
14413
14414 .section "Routing and delivery" "SECID116"
14415 .table2
14416 .row &%disable_ipv6%&                "do no IPv6 processing"
14417 .row &%dns_again_means_nonexist%&    "for broken domains"
14418 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14419 .row &%dns_dnssec_ok%&               "parameter for resolver"
14420 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14421 .row &%dns_retrans%&                 "parameter for resolver"
14422 .row &%dns_retry%&                   "parameter for resolver"
14423 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14424 .row &%dns_use_edns0%&               "parameter for resolver"
14425 .row &%hold_domains%&                "hold delivery for these domains"
14426 .row &%local_interfaces%&            "for routing checks"
14427 .row &%queue_domains%&               "no immediate delivery for these"
14428 .row &%queue_only%&                  "no immediate delivery at all"
14429 .row &%queue_only_file%&             "no immediate delivery if file exists"
14430 .row &%queue_only_load%&             "no immediate delivery if load is high"
14431 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14432 .row &%queue_only_override%&         "allow command line to override"
14433 .row &%queue_run_in_order%&          "order of arrival"
14434 .row &%queue_run_max%&               "of simultaneous queue runners"
14435 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14436 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14437 .row &%remote_sort_domains%&         "order of remote deliveries"
14438 .row &%retry_data_expire%&           "timeout for retry data"
14439 .row &%retry_interval_max%&          "safety net for retry rules"
14440 .endtable
14441
14442
14443
14444 .section "Bounce and warning messages" "SECID117"
14445 .table2
14446 .row &%bounce_message_file%&         "content of bounce"
14447 .row &%bounce_message_text%&         "content of bounce"
14448 .row &%bounce_return_body%&          "include body if returning message"
14449 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14450 .row &%bounce_return_message%&       "include original message in bounce"
14451 .row &%bounce_return_size_limit%&    "limit on returned message"
14452 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14453 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14454 .row &%errors_copy%&                 "copy bounce messages"
14455 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14456 .row &%delay_warning%&               "time schedule"
14457 .row &%delay_warning_condition%&     "condition for warning messages"
14458 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14459 .row &%smtp_return_error_details%&   "give detail on rejections"
14460 .row &%warn_message_file%&           "content of warning message"
14461 .endtable
14462
14463
14464
14465 .section "Alphabetical list of main options" "SECTalomo"
14466 Those options that undergo string expansion before use are marked with
14467 &dagger;.
14468
14469 .option accept_8bitmime main boolean true
14470 .cindex "8BITMIME"
14471 .cindex "8-bit characters"
14472 .cindex "log" "selectors"
14473 .cindex "log" "8BITMIME"
14474 This option causes Exim to send 8BITMIME in its response to an SMTP
14475 EHLO command, and to accept the BODY= parameter on MAIL commands.
14476 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14477 takes no steps to do anything special with messages received by this route.
14478
14479 Historically Exim kept this option off by default, but the maintainers
14480 feel that in today's Internet, this causes more problems than it solves.
14481 It now defaults to true.
14482 A more detailed analysis of the issues is provided by Dan Bernstein:
14483 .display
14484 &url(https://cr.yp.to/smtp/8bitmime.html)
14485 .endd
14486
14487 To log received 8BITMIME status use
14488 .code
14489 log_selector = +8bitmime
14490 .endd
14491
14492 .option acl_not_smtp main string&!! unset
14493 .cindex "&ACL;" "for non-SMTP messages"
14494 .cindex "non-SMTP messages" "ACLs for"
14495 This option defines the ACL that is run when a non-SMTP message has been
14496 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14497 further details.
14498
14499 .option acl_not_smtp_mime main string&!! unset
14500 This option defines the ACL that is run for individual MIME parts of non-SMTP
14501 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14502 SMTP messages.
14503
14504 .option acl_not_smtp_start main string&!! unset
14505 .cindex "&ACL;" "at start of non-SMTP message"
14506 .cindex "non-SMTP messages" "ACLs for"
14507 This option defines the ACL that is run before Exim starts reading a
14508 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14509
14510 .option acl_smtp_auth main string&!! unset
14511 .cindex "&ACL;" "setting up for SMTP commands"
14512 .cindex "AUTH" "ACL for"
14513 This option defines the ACL that is run when an SMTP AUTH command is
14514 received. See chapter &<<CHAPACL>>& for further details.
14515
14516 .option acl_smtp_connect main string&!! unset
14517 .cindex "&ACL;" "on SMTP connection"
14518 This option defines the ACL that is run when an SMTP connection is received.
14519 See chapter &<<CHAPACL>>& for further details.
14520
14521 .option acl_smtp_data main string&!! unset
14522 .cindex "DATA" "ACL for"
14523 This option defines the ACL that is run after an SMTP DATA command has been
14524 processed and the message itself has been received, but before the final
14525 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14526
14527 .option acl_smtp_data_prdr main string&!! accept
14528 .cindex "PRDR" "ACL for"
14529 .cindex "DATA" "PRDR ACL for"
14530 .cindex "&ACL;" "PRDR-related"
14531 .cindex "&ACL;" "per-user data processing"
14532 This option defines the ACL that,
14533 if the PRDR feature has been negotiated,
14534 is run for each recipient after an SMTP DATA command has been
14535 processed and the message itself has been received, but before the
14536 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14537
14538 .option acl_smtp_dkim main string&!! unset
14539 .cindex DKIM "ACL for"
14540 This option defines the ACL that is run for each DKIM signature
14541 (by default, or as specified in the dkim_verify_signers option)
14542 of a received message.
14543 See section &<<SECDKIMVFY>>& for further details.
14544
14545 .option acl_smtp_etrn main string&!! unset
14546 .cindex "ETRN" "ACL for"
14547 This option defines the ACL that is run when an SMTP ETRN command is
14548 received. See chapter &<<CHAPACL>>& for further details.
14549
14550 .option acl_smtp_expn main string&!! unset
14551 .cindex "EXPN" "ACL for"
14552 This option defines the ACL that is run when an SMTP EXPN command is
14553 received. See chapter &<<CHAPACL>>& for further details.
14554
14555 .option acl_smtp_helo main string&!! unset
14556 .cindex "EHLO" "ACL for"
14557 .cindex "HELO" "ACL for"
14558 This option defines the ACL that is run when an SMTP EHLO or HELO
14559 command is received. See chapter &<<CHAPACL>>& for further details.
14560
14561
14562 .option acl_smtp_mail main string&!! unset
14563 .cindex "MAIL" "ACL for"
14564 This option defines the ACL that is run when an SMTP MAIL command is
14565 received. See chapter &<<CHAPACL>>& for further details.
14566
14567 .option acl_smtp_mailauth main string&!! unset
14568 .cindex "AUTH" "on MAIL command"
14569 This option defines the ACL that is run when there is an AUTH parameter on
14570 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14571 &<<CHAPSMTPAUTH>>& for details of authentication.
14572
14573 .option acl_smtp_mime main string&!! unset
14574 .cindex "MIME content scanning" "ACL for"
14575 This option is available when Exim is built with the content-scanning
14576 extension. It defines the ACL that is run for each MIME part in a message. See
14577 section &<<SECTscanmimepart>>& for details.
14578
14579 .option acl_smtp_notquit main string&!! unset
14580 .cindex "not-QUIT, ACL for"
14581 This option defines the ACL that is run when an SMTP session
14582 ends without a QUIT command being received.
14583 See chapter &<<CHAPACL>>& for further details.
14584
14585 .option acl_smtp_predata main string&!! unset
14586 This option defines the ACL that is run when an SMTP DATA command is
14587 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14588 further details.
14589
14590 .option acl_smtp_quit main string&!! unset
14591 .cindex "QUIT, ACL for"
14592 This option defines the ACL that is run when an SMTP QUIT command is
14593 received. See chapter &<<CHAPACL>>& for further details.
14594
14595 .option acl_smtp_rcpt main string&!! unset
14596 .cindex "RCPT" "ACL for"
14597 This option defines the ACL that is run when an SMTP RCPT command is
14598 received. See chapter &<<CHAPACL>>& for further details.
14599
14600 .option acl_smtp_starttls main string&!! unset
14601 .cindex "STARTTLS, ACL for"
14602 This option defines the ACL that is run when an SMTP STARTTLS command is
14603 received. See chapter &<<CHAPACL>>& for further details.
14604
14605 .option acl_smtp_vrfy main string&!! unset
14606 .cindex "VRFY" "ACL for"
14607 This option defines the ACL that is run when an SMTP VRFY command is
14608 received. See chapter &<<CHAPACL>>& for further details.
14609
14610 .option add_environment main "string list" empty
14611 .cindex "environment" "set values"
14612 This option allows to set individual environment variables that the
14613 currently linked libraries and programs in child processes use.
14614 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14615
14616 .option admin_groups main "string list&!!" unset
14617 .cindex "admin user"
14618 This option is expanded just once, at the start of Exim's processing. If the
14619 current group or any of the supplementary groups of an Exim caller is in this
14620 colon-separated list, the caller has admin privileges. If all your system
14621 programmers are in a specific group, for example, you can give them all Exim
14622 admin privileges by putting that group in &%admin_groups%&. However, this does
14623 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14624 To permit this, you have to add individuals to the Exim group.
14625
14626 .option allow_domain_literals main boolean false
14627 .cindex "domain literal"
14628 If this option is set, the RFC 2822 domain literal format is permitted in
14629 email addresses. The option is not set by default, because the domain literal
14630 format is not normally required these days, and few people know about it. It
14631 has, however, been exploited by mail abusers.
14632
14633 Unfortunately, it seems that some DNS black list maintainers are using this
14634 format to report black listing to postmasters. If you want to accept messages
14635 addressed to your hosts by IP address, you need to set
14636 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14637 domains (defined in the named domain list &%local_domains%& in the default
14638 configuration). This &"magic string"& matches the domain literal form of all
14639 the local host's IP addresses.
14640
14641
14642 .option allow_mx_to_ip main boolean false
14643 .cindex "MX record" "pointing to IP address"
14644 It appears that more and more DNS zone administrators are breaking the rules
14645 and putting domain names that look like IP addresses on the right hand side of
14646 MX records. Exim follows the rules and rejects this, giving an error message
14647 that explains the misconfiguration. However, some other MTAs support this
14648 practice, so to avoid &"Why can't Exim do this?"& complaints,
14649 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14650 recommended, except when you have no other choice.
14651
14652 .option allow_utf8_domains main boolean false
14653 .cindex "domain" "UTF-8 characters in"
14654 .cindex "UTF-8" "in domain name"
14655 Lots of discussion is going on about internationalized domain names. One
14656 camp is strongly in favour of just using UTF-8 characters, and it seems
14657 that at least two other MTAs permit this. This option allows Exim users to
14658 experiment if they wish.
14659
14660 If it is set true, Exim's domain parsing function allows valid
14661 UTF-8 multicharacters to appear in domain name components, in addition to
14662 letters, digits, and hyphens. However, just setting this option is not
14663 enough; if you want to look up these domain names in the DNS, you must also
14664 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14665 suitable setting is:
14666 .code
14667 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14668   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14669 .endd
14670 Alternatively, you can just disable this feature by setting
14671 .code
14672 dns_check_names_pattern =
14673 .endd
14674 That is, set the option to an empty string so that no check is done.
14675
14676
14677 .option auth_advertise_hosts main "host list&!!" *
14678 .cindex "authentication" "advertising"
14679 .cindex "AUTH" "advertising"
14680 If any server authentication mechanisms are configured, Exim advertises them in
14681 response to an EHLO command only if the calling host matches this list.
14682 Otherwise, Exim does not advertise AUTH.
14683 Exim does not accept AUTH commands from clients to which it has not
14684 advertised the availability of AUTH. The advertising of individual
14685 authentication mechanisms can be controlled by the use of the
14686 &%server_advertise_condition%& generic authenticator option on the individual
14687 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14688
14689 Certain mail clients (for example, Netscape) require the user to provide a name
14690 and password for authentication if AUTH is advertised, even though it may
14691 not be needed (the host may accept messages from hosts on its local LAN without
14692 authentication, for example). The &%auth_advertise_hosts%& option can be used
14693 to make these clients more friendly by excluding them from the set of hosts to
14694 which Exim advertises AUTH.
14695
14696 .cindex "AUTH" "advertising when encrypted"
14697 If you want to advertise the availability of AUTH only when the connection
14698 is encrypted using TLS, you can make use of the fact that the value of this
14699 option is expanded, with a setting like this:
14700 .code
14701 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14702 .endd
14703 .vindex "&$tls_in_cipher$&"
14704 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14705 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14706 expansion is *, which matches all hosts.
14707
14708
14709 .option auto_thaw main time 0s
14710 .cindex "thawing messages"
14711 .cindex "unfreezing messages"
14712 If this option is set to a time greater than zero, a queue runner will try a
14713 new delivery attempt on any frozen message, other than a bounce message, if
14714 this much time has passed since it was frozen. This may result in the message
14715 being re-frozen if nothing has changed since the last attempt. It is a way of
14716 saying &"keep on trying, even though there are big problems"&.
14717
14718 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14719 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14720 thought to be very useful any more, and its use should probably be avoided.
14721
14722
14723 .option av_scanner main string "see below"
14724 This option is available if Exim is built with the content-scanning extension.
14725 It specifies which anti-virus scanner to use. The default value is:
14726 .code
14727 sophie:/var/run/sophie
14728 .endd
14729 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14730 before use. See section &<<SECTscanvirus>>& for further details.
14731
14732
14733 .option bi_command main string unset
14734 .oindex "&%-bi%&"
14735 This option supplies the name of a command that is run when Exim is called with
14736 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14737 just the command name, it is not a complete command line. If an argument is
14738 required, it must come from the &%-oA%& command line option.
14739
14740
14741 .option bounce_message_file main string unset
14742 .cindex "bounce message" "customizing"
14743 .cindex "customizing" "bounce message"
14744 This option defines a template file containing paragraphs of text to be used
14745 for constructing bounce messages.  Details of the file's contents are given in
14746 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14747
14748
14749 .option bounce_message_text main string unset
14750 When this option is set, its contents are included in the default bounce
14751 message immediately after &"This message was created automatically by mail
14752 delivery software."& It is not used if &%bounce_message_file%& is set.
14753
14754 .option bounce_return_body main boolean true
14755 .cindex "bounce message" "including body"
14756 This option controls whether the body of an incoming message is included in a
14757 bounce message when &%bounce_return_message%& is true. The default setting
14758 causes the entire message, both header and body, to be returned (subject to the
14759 value of &%bounce_return_size_limit%&). If this option is false, only the
14760 message header is included. In the case of a non-SMTP message containing an
14761 error that is detected during reception, only those header lines preceding the
14762 point at which the error was detected are returned.
14763 .cindex "bounce message" "including original"
14764
14765 .option bounce_return_linesize_limit main integer 998
14766 .cindex "size" "of bounce lines, limit"
14767 .cindex "bounce message" "line length limit"
14768 .cindex "limit" "bounce message line length"
14769 This option sets a limit in bytes on the line length of messages
14770 that are returned to senders due to delivery problems,
14771 when &%bounce_return_message%& is true.
14772 The default value corresponds to RFC limits.
14773 If the message being returned has lines longer than this value it is
14774 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14775
14776 The option also applies to bounces returned when an error is detected
14777 during reception of a message.
14778 In this case lines from the original are truncated.
14779
14780 The option does not apply to messages generated by an &(autoreply)& transport.
14781
14782
14783 .option bounce_return_message main boolean true
14784 If this option is set false, none of the original message is included in
14785 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14786 &%bounce_return_body%&.
14787
14788
14789 .option bounce_return_size_limit main integer 100K
14790 .cindex "size" "of bounce, limit"
14791 .cindex "bounce message" "size limit"
14792 .cindex "limit" "bounce message size"
14793 This option sets a limit in bytes on the size of messages that are returned to
14794 senders as part of bounce messages when &%bounce_return_message%& is true. The
14795 limit should be less than the value of the global &%message_size_limit%& and of
14796 any &%message_size_limit%& settings on transports, to allow for the bounce text
14797 that Exim generates. If this option is set to zero there is no limit.
14798
14799 When the body of any message that is to be included in a bounce message is
14800 greater than the limit, it is truncated, and a comment pointing this out is
14801 added at the top. The actual cutoff may be greater than the value given, owing
14802 to the use of buffering for transferring the message in chunks (typically 8K in
14803 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14804 messages.
14805
14806 .option bounce_sender_authentication main string unset
14807 .cindex "bounce message" "sender authentication"
14808 .cindex "authentication" "bounce message"
14809 .cindex "AUTH" "on bounce message"
14810 This option provides an authenticated sender address that is sent with any
14811 bounce messages generated by Exim that are sent over an authenticated SMTP
14812 connection. A typical setting might be:
14813 .code
14814 bounce_sender_authentication = mailer-daemon@my.domain.example
14815 .endd
14816 which would cause bounce messages to be sent using the SMTP command:
14817 .code
14818 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14819 .endd
14820 The value of &%bounce_sender_authentication%& must always be a complete email
14821 address.
14822
14823 .option callout_domain_negative_expire main time 3h
14824 .cindex "caching" "callout timeouts"
14825 .cindex "callout" "caching timeouts"
14826 This option specifies the expiry time for negative callout cache data for a
14827 domain. See section &<<SECTcallver>>& for details of callout verification, and
14828 section &<<SECTcallvercache>>& for details of the caching.
14829
14830
14831 .option callout_domain_positive_expire main time 7d
14832 This option specifies the expiry time for positive callout cache data for a
14833 domain. See section &<<SECTcallver>>& for details of callout verification, and
14834 section &<<SECTcallvercache>>& for details of the caching.
14835
14836
14837 .option callout_negative_expire main time 2h
14838 This option specifies the expiry time for negative callout cache data for an
14839 address. See section &<<SECTcallver>>& for details of callout verification, and
14840 section &<<SECTcallvercache>>& for details of the caching.
14841
14842
14843 .option callout_positive_expire main time 24h
14844 This option specifies the expiry time for positive callout cache data for an
14845 address. See section &<<SECTcallver>>& for details of callout verification, and
14846 section &<<SECTcallvercache>>& for details of the caching.
14847
14848
14849 .option callout_random_local_part main string&!! "see below"
14850 This option defines the &"random"& local part that can be used as part of
14851 callout verification. The default value is
14852 .code
14853 $primary_hostname-$tod_epoch-testing
14854 .endd
14855 See section &<<CALLaddparcall>>& for details of how this value is used.
14856
14857
14858 .option check_log_inodes main integer 100
14859 See &%check_spool_space%& below.
14860
14861
14862 .option check_log_space main integer 10M
14863 See &%check_spool_space%& below.
14864
14865 .oindex "&%check_rfc2047_length%&"
14866 .cindex "RFC 2047" "disabling length check"
14867 .option check_rfc2047_length main boolean true
14868 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14869 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14870 word; strings to be encoded that exceed this length are supposed to use
14871 multiple encoded words. By default, Exim does not recognize encoded words that
14872 exceed the maximum length. However, it seems that some software, in violation
14873 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14874 set false, Exim recognizes encoded words of any length.
14875
14876
14877 .option check_spool_inodes main integer 100
14878 See &%check_spool_space%& below.
14879
14880
14881 .option check_spool_space main integer 10M
14882 .cindex "checking disk space"
14883 .cindex "disk space, checking"
14884 .cindex "spool directory" "checking space"
14885 The four &%check_...%& options allow for checking of disk resources before a
14886 message is accepted.
14887
14888 .vindex "&$log_inodes$&"
14889 .vindex "&$log_space$&"
14890 .vindex "&$spool_inodes$&"
14891 .vindex "&$spool_space$&"
14892 When any of these options are nonzero, they apply to all incoming messages. If you
14893 want to apply different checks to different kinds of message, you can do so by
14894 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14895 &$spool_space$& in an ACL with appropriate additional conditions.
14896
14897
14898 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14899 either value is greater than zero, for example:
14900 .code
14901 check_spool_space = 100M
14902 check_spool_inodes = 100
14903 .endd
14904 The spool partition is the one that contains the directory defined by
14905 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14906 transit.
14907
14908 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14909 files are written if either is greater than zero. These should be set only if
14910 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14911
14912 If there is less space or fewer inodes than requested, Exim refuses to accept
14913 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14914 error response to the MAIL command. If ESMTP is in use and there was a
14915 SIZE parameter on the MAIL command, its value is added to the
14916 &%check_spool_space%& value, and the check is performed even if
14917 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14918
14919 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14920 number of kilobytes (though specified in bytes).
14921 If a non-multiple of 1024 is specified, it is rounded up.
14922
14923 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14924 failure a message is written to stderr and Exim exits with a non-zero code, as
14925 it obviously cannot send an error message of any kind.
14926
14927 There is a slight performance penalty for these checks.
14928 Versions of Exim preceding 4.88 had these disabled by default;
14929 high-rate installations confident they will never run out of resources
14930 may wish to deliberately disable them.
14931
14932 .option chunking_advertise_hosts main "host list&!!" *
14933 .cindex CHUNKING advertisement
14934 .cindex "RFC 3030" "CHUNKING"
14935 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14936 these hosts.
14937 Hosts may use the BDAT command as an alternate to DATA.
14938
14939 .option commandline_checks_require_admin main boolean &`false`&
14940 .cindex "restricting access to features"
14941 This option restricts various basic checking features to require an
14942 administrative user.
14943 This affects most of the &%-b*%& options, such as &%-be%&.
14944
14945 .option debug_store main boolean &`false`&
14946 .cindex debugging "memory corruption"
14947 .cindex memory debugging
14948 This option, when true, enables extra checking in Exim's internal memory
14949 management.  For use when a memory corruption issue is being investigated,
14950 it should normally be left as default.
14951
14952 .option daemon_smtp_ports main string &`smtp`&
14953 .cindex "port" "for daemon"
14954 .cindex "TCP/IP" "setting listening ports"
14955 This option specifies one or more default SMTP ports on which the Exim daemon
14956 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14957 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14958
14959 .option daemon_startup_retries main integer 9
14960 .cindex "daemon startup, retrying"
14961 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14962 the daemon at startup when it cannot immediately bind a listening socket
14963 (typically because the socket is already in use): &%daemon_startup_retries%&
14964 defines the number of retries after the first failure, and
14965 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14966
14967 .option daemon_startup_sleep main time 30s
14968 See &%daemon_startup_retries%&.
14969
14970 .option delay_warning main "time list" 24h
14971 .cindex "warning of delay"
14972 .cindex "delay warning, specifying"
14973 .cindex "queue" "delay warning"
14974 When a message is delayed, Exim sends a warning message to the sender at
14975 intervals specified by this option. The data is a colon-separated list of times
14976 after which to send warning messages. If the value of the option is an empty
14977 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14978 message has been in the queue for longer than the last time, the last interval
14979 between the times is used to compute subsequent warning times. For example,
14980 with
14981 .code
14982 delay_warning = 4h:8h:24h
14983 .endd
14984 the first message is sent after 4 hours, the second after 8 hours, and
14985 the third one after 24 hours. After that, messages are sent every 16 hours,
14986 because that is the interval between the last two times on the list. If you set
14987 just one time, it specifies the repeat interval. For example, with:
14988 .code
14989 delay_warning = 6h
14990 .endd
14991 messages are repeated every six hours. To stop warnings after a given time, set
14992 a very large time at the end of the list. For example:
14993 .code
14994 delay_warning = 2h:12h:99d
14995 .endd
14996 Note that the option is only evaluated at the time a delivery attempt fails,
14997 which depends on retry and queue-runner configuration.
14998 Typically retries will be configured more frequently than warning messages.
14999
15000 .option delay_warning_condition main string&!! "see below"
15001 .vindex "&$domain$&"
15002 The string is expanded at the time a warning message might be sent. If all the
15003 deferred addresses have the same domain, it is set in &$domain$& during the
15004 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15005 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15006 &"false"& (the comparison being done caselessly) then the warning message is
15007 not sent. The default is:
15008 .code
15009 delay_warning_condition = ${if or {\
15010   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15011   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15012   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15013   } {no}{yes}}
15014 .endd
15015 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15016 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15017 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15018 &"auto-replied"& in an &'Auto-Submitted:'& header.
15019
15020 .option deliver_drop_privilege main boolean false
15021 .cindex "unprivileged delivery"
15022 .cindex "delivery" "unprivileged"
15023 If this option is set true, Exim drops its root privilege at the start of a
15024 delivery process, and runs as the Exim user throughout. This severely restricts
15025 the kinds of local delivery that are possible, but is viable in certain types
15026 of configuration. There is a discussion about the use of root privilege in
15027 chapter &<<CHAPsecurity>>&.
15028
15029 .option deliver_queue_load_max main fixed-point unset
15030 .cindex "load average"
15031 .cindex "queue runner" "abandoning"
15032 When this option is set, a queue run is abandoned if the system load average
15033 becomes greater than the value of the option. The option has no effect on
15034 ancient operating systems on which Exim cannot determine the load average.
15035 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15036
15037
15038 .option delivery_date_remove main boolean true
15039 .cindex "&'Delivery-date:'& header line"
15040 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15041 message when it is delivered, in exactly the same way as &'Return-path:'& is
15042 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15043 should not be present in incoming messages, and this option causes them to be
15044 removed at the time the message is received, to avoid any problems that might
15045 occur when a delivered message is subsequently sent on to some other recipient.
15046
15047 .option disable_fsync main boolean false
15048 .cindex "&[fsync()]&, disabling"
15049 This option is available only if Exim was built with the compile-time option
15050 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15051 a runtime configuration generates an &"unknown option"& error. You should not
15052 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15053 really, really, really understand what you are doing. &'No pre-compiled
15054 distributions of Exim should ever make this option available.'&
15055
15056 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15057 updated files' data to be written to disc before continuing. Unexpected events
15058 such as crashes and power outages may cause data to be lost or scrambled.
15059 Here be Dragons. &*Beware.*&
15060
15061
15062 .option disable_ipv6 main boolean false
15063 .cindex "IPv6" "disabling"
15064 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15065 activities take place. AAAA records are never looked up, and any IPv6 addresses
15066 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15067 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15068 to handle IPv6 literal addresses.
15069
15070
15071 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15072 .cindex DKIM "controlling calls to the ACL"
15073 This option gives a list of DKIM domains for which the DKIM ACL is run.
15074 It is expanded after the message is received; by default it runs
15075 the ACL once for each signature in the message.
15076 See section &<<SECDKIMVFY>>&.
15077
15078
15079 .option dns_again_means_nonexist main "domain list&!!" unset
15080 .cindex "DNS" "&""try again""& response; overriding"
15081 DNS lookups give a &"try again"& response for the DNS errors
15082 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15083 keep trying to deliver a message, or to give repeated temporary errors to
15084 incoming mail. Sometimes the effect is caused by a badly set up name server and
15085 may persist for a long time. If a domain which exhibits this problem matches
15086 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15087 This option should be used with care. You can make it apply to reverse lookups
15088 by a setting such as this:
15089 .code
15090 dns_again_means_nonexist = *.in-addr.arpa
15091 .endd
15092 This option applies to all DNS lookups that Exim does. It also applies when the
15093 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15094 since these are most likely to be caused by DNS lookup problems. The
15095 &(dnslookup)& router has some options of its own for controlling what happens
15096 when lookups for MX or SRV records give temporary errors. These more specific
15097 options are applied after this global option.
15098
15099 .option dns_check_names_pattern main string "see below"
15100 .cindex "DNS" "pre-check of name syntax"
15101 When this option is set to a non-empty string, it causes Exim to check domain
15102 names for characters that are not allowed in host names before handing them to
15103 the DNS resolver, because some resolvers give temporary errors for names that
15104 contain unusual characters. If a domain name contains any unwanted characters,
15105 a &"not found"& result is forced, and the resolver is not called. The check is
15106 done by matching the domain name against a regular expression, which is the
15107 value of this option. The default pattern is
15108 .code
15109 dns_check_names_pattern = \
15110   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15111 .endd
15112 which permits only letters, digits, slashes, and hyphens in components, but
15113 they must start and end with a letter or digit. Slashes are not, in fact,
15114 permitted in host names, but they are found in certain NS records (which can be
15115 accessed in Exim by using a &%dnsdb%& lookup). If you set
15116 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15117 empty string.
15118
15119 .option dns_csa_search_limit main integer 5
15120 This option controls the depth of parental searching for CSA SRV records in the
15121 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15122
15123 .option dns_csa_use_reverse main boolean true
15124 This option controls whether or not an IP address, given as a CSA domain, is
15125 reversed and looked up in the reverse DNS, as described in more detail in
15126 section &<<SECTverifyCSA>>&.
15127
15128 .option dns_cname_loops main integer 1
15129 .cindex DNS "CNAME following"
15130 This option controls the following of CNAME chains, needed if the resolver does
15131 not do it internally.
15132 As of 2018 most should, and the default can be left.
15133 If you have an ancient one, a value of 10 is likely needed.
15134
15135 The default value of one CNAME-follow is needed
15136 thanks to the observed return for an MX request,
15137 given no MX presence but a CNAME to an A, of the CNAME.
15138
15139
15140 .option dns_dnssec_ok main integer -1
15141 .cindex "DNS" "resolver options"
15142 .cindex "DNS" "DNSSEC"
15143 If this option is set to a non-negative number then Exim will initialise the
15144 DNS resolver library to either use or not use DNSSEC, overriding the system
15145 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15146
15147 If the resolver library does not support DNSSEC then this option has no effect.
15148
15149
15150 .option dns_ipv4_lookup main "domain list&!!" unset
15151 .cindex "IPv6" "DNS lookup for AAAA records"
15152 .cindex "DNS" "IPv6 lookup for AAAA records"
15153 .cindex DNS "IPv6 disabling"
15154 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15155 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15156 (A records) when trying to find IP addresses for hosts, unless the host's
15157 domain matches this list.
15158
15159 This is a fudge to help with name servers that give big delays or otherwise do
15160 not work for the AAAA record type. In due course, when the world's name
15161 servers have all been upgraded, there should be no need for this option.
15162
15163
15164 .option dns_retrans main time 0s
15165 .cindex "DNS" "resolver options"
15166 .cindex timeout "dns lookup"
15167 .cindex "DNS" timeout
15168 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15169 retransmission and retry parameters for DNS lookups. Values of zero (the
15170 defaults) leave the system default settings unchanged. The first value is the
15171 time between retries, and the second is the number of retries. It isn't
15172 totally clear exactly how these settings affect the total time a DNS lookup may
15173 take. I haven't found any documentation about timeouts on DNS lookups; these
15174 parameter values are available in the external resolver interface structure,
15175 but nowhere does it seem to describe how they are used or what you might want
15176 to set in them.
15177 See also the &%slow_lookup_log%& option.
15178
15179
15180 .option dns_retry main integer 0
15181 See &%dns_retrans%& above.
15182
15183
15184 .option dns_trust_aa main "domain list&!!" unset
15185 .cindex "DNS" "resolver options"
15186 .cindex "DNS" "DNSSEC"
15187 If this option is set then lookup results marked with the AA bit
15188 (Authoritative Answer) are trusted the same way as if they were
15189 DNSSEC-verified. The authority section's name of the answer must
15190 match with this expanded domain list.
15191
15192 Use this option only if you talk directly to a resolver that is
15193 authoritative for some zones and does not set the AD (Authentic Data)
15194 bit in the answer. Some DNS servers may have an configuration option to
15195 mark the answers from their own zones as verified (they set the AD bit).
15196 Others do not have this option. It is considered as poor practice using
15197 a resolver that is an authoritative server for some zones.
15198
15199 Use this option only if you really have to (e.g. if you want
15200 to use DANE for remote delivery to a server that is listed in the DNS
15201 zones that your resolver is authoritative for).
15202
15203 If the DNS answer packet has the AA bit set and contains resource record
15204 in the answer section, the name of the first NS record appearing in the
15205 authority section is compared against the list. If the answer packet is
15206 authoritative but the answer section is empty, the name of the first SOA
15207 record in the authoritative section is used instead.
15208
15209 .cindex "DNS" "resolver options"
15210 .option dns_use_edns0 main integer -1
15211 .cindex "DNS" "resolver options"
15212 .cindex "DNS" "EDNS0"
15213 .cindex "DNS" "OpenBSD
15214 If this option is set to a non-negative number then Exim will initialise the
15215 DNS resolver library to either use or not use EDNS0 extensions, overriding
15216 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15217 on.
15218
15219 If the resolver library does not support EDNS0 then this option has no effect.
15220
15221 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15222 means that DNSSEC will not work with Exim on that platform either, unless Exim
15223 is linked against an alternative DNS client library.
15224
15225
15226 .option drop_cr main boolean false
15227 This is an obsolete option that is now a no-op. It used to affect the way Exim
15228 handled CR and LF characters in incoming messages. What happens now is
15229 described in section &<<SECTlineendings>>&.
15230
15231 .option dsn_advertise_hosts main "host list&!!" unset
15232 .cindex "bounce messages" "success"
15233 .cindex "DSN" "success"
15234 .cindex "Delivery Status Notification" "success"
15235 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15236 and accepted from, these hosts.
15237 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15238 and RET and ORCPT options on MAIL FROM commands.
15239 A NOTIFY=SUCCESS option requests success-DSN messages.
15240 A NOTIFY= option with no argument requests that no delay or failure DSNs
15241 are sent.
15242
15243 .option dsn_from main "string&!!" "see below"
15244 .cindex "&'From:'& header line" "in bounces"
15245 .cindex "bounce messages" "&'From:'& line, specifying"
15246 This option can be used to vary the contents of &'From:'& header lines in
15247 bounces and other automatically generated messages (&"Delivery Status
15248 Notifications"& &-- hence the name of the option). The default setting is:
15249 .code
15250 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15251 .endd
15252 The value is expanded every time it is needed. If the expansion fails, a
15253 panic is logged, and the default value is used.
15254
15255 .option envelope_to_remove main boolean true
15256 .cindex "&'Envelope-to:'& header line"
15257 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15258 message when it is delivered, in exactly the same way as &'Return-path:'& is
15259 handled. &'Envelope-to:'& records the original recipient address from the
15260 message's envelope that caused the delivery to happen. Such headers should not
15261 be present in incoming messages, and this option causes them to be removed at
15262 the time the message is received, to avoid any problems that might occur when a
15263 delivered message is subsequently sent on to some other recipient.
15264
15265
15266 .option errors_copy main "string list&!!" unset
15267 .cindex "bounce message" "copy to other address"
15268 .cindex "copy of bounce message"
15269 Setting this option causes Exim to send bcc copies of bounce messages that it
15270 generates to other addresses. &*Note*&: This does not apply to bounce messages
15271 coming from elsewhere. The value of the option is a colon-separated list of
15272 items. Each item consists of a pattern, terminated by white space, followed by
15273 a comma-separated list of email addresses. If a pattern contains spaces, it
15274 must be enclosed in double quotes.
15275
15276 Each pattern is processed in the same way as a single item in an address list
15277 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15278 the bounce message, the message is copied to the addresses on the list. The
15279 items are scanned in order, and once a matching one is found, no further items
15280 are examined. For example:
15281 .code
15282 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15283               rqps@mydomain   hostmaster@mydomain.example,\
15284                               postmaster@mydomain.example
15285 .endd
15286 .vindex "&$domain$&"
15287 .vindex "&$local_part$&"
15288 The address list is expanded before use. The expansion variables &$local_part$&
15289 and &$domain$& are set from the original recipient of the error message, and if
15290 there was any wildcard matching in the pattern, the expansion
15291 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15292 variables &$0$&, &$1$&, etc. are set in the normal way.
15293
15294
15295 .option errors_reply_to main string unset
15296 .cindex "bounce message" "&'Reply-to:'& in"
15297 By default, Exim's bounce and delivery warning messages contain the header line
15298 .display
15299 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15300 .endd
15301 .oindex &%quota_warn_message%&
15302 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15303 A warning message that is generated by the &%quota_warn_message%& option in an
15304 &(appendfile)& transport may contain its own &'From:'& header line that
15305 overrides the default.
15306
15307 Experience shows that people reply to bounce messages. If the
15308 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15309 and warning messages. For example:
15310 .code
15311 errors_reply_to = postmaster@my.domain.example
15312 .endd
15313 The value of the option is not expanded. It must specify a valid RFC 2822
15314 address. However, if a warning message that is generated by the
15315 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15316 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15317 not used.
15318
15319
15320 .option event_action main string&!! unset
15321 .cindex events
15322 This option declares a string to be expanded for Exim's events mechanism.
15323 For details see chapter &<<CHAPevents>>&.
15324
15325
15326 .option exim_group main string "compile-time configured"
15327 .cindex "gid (group id)" "Exim's own"
15328 .cindex "Exim group"
15329 This option changes the gid under which Exim runs when it gives up root
15330 privilege. The default value is compiled into the binary. The value of this
15331 option is used only when &%exim_user%& is also set. Unless it consists entirely
15332 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15333 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15334 security issues.
15335
15336
15337 .option exim_path main string "see below"
15338 .cindex "Exim binary, path name"
15339 This option specifies the path name of the Exim binary, which is used when Exim
15340 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15341 the directory configured at compile time by the BIN_DIRECTORY setting. It
15342 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15343 other place.
15344 &*Warning*&: Do not use a macro to define the value of this option, because
15345 you will break those Exim utilities that scan the configuration file to find
15346 where the binary is. (They then use the &%-bP%& option to extract option
15347 settings such as the value of &%spool_directory%&.)
15348
15349
15350 .option exim_user main string "compile-time configured"
15351 .cindex "uid (user id)" "Exim's own"
15352 .cindex "Exim user"
15353 This option changes the uid under which Exim runs when it gives up root
15354 privilege. The default value is compiled into the binary. Ownership of the run
15355 time configuration file and the use of the &%-C%& and &%-D%& command line
15356 options is checked against the values in the binary, not what is set here.
15357
15358 Unless it consists entirely of digits, the string is looked up using
15359 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15360 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15361 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15362
15363
15364 .option exim_version main string "current version"
15365 .cindex "Exim version"
15366 .cindex customizing "version number"
15367 .cindex "version number of Exim" override
15368 This option allows to override the &$version_number$&/&$exim_version$& Exim reports in
15369 various places.  Use with care, this may fool stupid security scanners.
15370
15371
15372 .option extra_local_interfaces main "string list" unset
15373 This option defines network interfaces that are to be considered local when
15374 routing, but which are not used for listening by the daemon. See section
15375 &<<SECTreclocipadd>>& for details.
15376
15377
15378 . Allow this long option name to split; give it unsplit as a fifth argument
15379 . for the automatic .oindex that is generated by .option.
15380
15381 .option "extract_addresses_remove_arguments" main boolean true &&&
15382          extract_addresses_remove_arguments
15383 .oindex "&%-t%&"
15384 .cindex "command line" "addresses with &%-t%&"
15385 .cindex "Sendmail compatibility" "&%-t%& option"
15386 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15387 are present on the command line when the &%-t%& option is used to build an
15388 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15389 line addresses are removed from the recipients list. This is also how Smail
15390 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15391 command line addresses are added to those obtained from the header lines. When
15392 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15393 argument headers. If it is set false, Exim adds rather than removes argument
15394 addresses.
15395
15396
15397 .option finduser_retries main integer 0
15398 .cindex "NIS, retrying user lookups"
15399 On systems running NIS or other schemes in which user and group information is
15400 distributed from a remote system, there can be times when &[getpwnam()]& and
15401 related functions fail, even when given valid data, because things time out.
15402 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15403 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15404 many extra times to find a user or a group, waiting for one second between
15405 retries.
15406
15407 .cindex "&_/etc/passwd_&" "multiple reading of"
15408 You should not set this option greater than zero if your user information is in
15409 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15410 search the file multiple times for non-existent users, and also cause delay.
15411
15412
15413
15414 .option freeze_tell main "string list, comma separated" unset
15415 .cindex "freezing messages" "sending a message when freezing"
15416 On encountering certain errors, or when configured to do so in a system filter,
15417 ACL, or special router, Exim freezes a message. This means that no further
15418 delivery attempts take place until an administrator thaws the message, or the
15419 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15420 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15421 warning message whenever it freezes something, unless the message it is
15422 freezing is a locally-generated bounce message. (Without this exception there
15423 is the possibility of looping.) The warning message is sent to the addresses
15424 supplied as the comma-separated value of this option. If several of the
15425 message's addresses cause freezing, only a single message is sent. If the
15426 freezing was automatic, the reason(s) for freezing can be found in the message
15427 log. If you configure freezing in a filter or ACL, you must arrange for any
15428 logging that you require.
15429
15430
15431 .option gecos_name main string&!! unset
15432 .cindex "HP-UX"
15433 .cindex "&""gecos""& field, parsing"
15434 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15435 password file to hold other information in addition to users' real names. Exim
15436 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15437 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15438 of the field are used unchanged, except that, if an ampersand is encountered,
15439 it is replaced by the user's login name with the first character forced to
15440 upper case, since this is a convention that is observed on many systems.
15441
15442 When these options are set, &%gecos_pattern%& is treated as a regular
15443 expression that is to be applied to the field (again with && replaced by the
15444 login name), and if it matches, &%gecos_name%& is expanded and used as the
15445 user's name.
15446
15447 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15448 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15449 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15450 name terminates at the first comma, the following can be used:
15451 .code
15452 gecos_pattern = ([^,]*)
15453 gecos_name = $1
15454 .endd
15455
15456 .option gecos_pattern main string unset
15457 See &%gecos_name%& above.
15458
15459
15460 .option gnutls_compat_mode main boolean unset
15461 This option controls whether GnuTLS is used in compatibility mode in an Exim
15462 server. This reduces security slightly, but improves interworking with older
15463 implementations of TLS.
15464
15465
15466 .option gnutls_allow_auto_pkcs11 main boolean unset
15467 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15468 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15469
15470 See
15471 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15472 for documentation.
15473
15474
15475
15476 .option headers_charset main string "see below"
15477 This option sets a default character set for translating from encoded MIME
15478 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15479 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15480 ultimate default is ISO-8859-1. For more details see the description of header
15481 insertions in section &<<SECTexpansionitems>>&.
15482
15483
15484
15485 .option header_maxsize main integer "see below"
15486 .cindex "header section" "maximum size of"
15487 .cindex "limit" "size of message header section"
15488 This option controls the overall maximum size of a message's header
15489 section. The default is the value of HEADER_MAXSIZE in
15490 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15491 sections are rejected.
15492
15493
15494 .option header_line_maxsize main integer 0
15495 .cindex "header lines" "maximum size of"
15496 .cindex "limit" "size of one header line"
15497 This option limits the length of any individual header line in a message, after
15498 all the continuations have been joined together. Messages with individual
15499 header lines that are longer than the limit are rejected. The default value of
15500 zero means &"no limit"&.
15501
15502
15503
15504
15505 .option helo_accept_junk_hosts main "host list&!!" unset
15506 .cindex "HELO" "accepting junk data"
15507 .cindex "EHLO" "accepting junk data"
15508 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15509 mail, and gives an error response for invalid data. Unfortunately, there are
15510 some SMTP clients that send syntactic junk. They can be accommodated by setting
15511 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15512 if you want to do semantic checking.
15513 See also &%helo_allow_chars%& for a way of extending the permitted character
15514 set.
15515
15516
15517 .option helo_allow_chars main string unset
15518 .cindex "HELO" "underscores in"
15519 .cindex "EHLO" "underscores in"
15520 .cindex "underscore in EHLO/HELO"
15521 This option can be set to a string of rogue characters that are permitted in
15522 all EHLO and HELO names in addition to the standard letters, digits,
15523 hyphens, and dots. If you really must allow underscores, you can set
15524 .code
15525 helo_allow_chars = _
15526 .endd
15527 Note that the value is one string, not a list.
15528
15529
15530 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15531 .cindex "HELO" "forcing reverse lookup"
15532 .cindex "EHLO" "forcing reverse lookup"
15533 If the domain given by a client in a HELO or EHLO command matches this
15534 list, a reverse lookup is done in order to establish the host's true name. The
15535 default forces a lookup if the client host gives the server's name or any of
15536 its IP addresses (in brackets), something that broken clients have been seen to
15537 do.
15538
15539
15540 .option helo_try_verify_hosts main "host list&!!" unset
15541 .cindex "HELO verifying" "optional"
15542 .cindex "EHLO" "verifying, optional"
15543 By default, Exim just checks the syntax of HELO and EHLO commands (see
15544 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15545 to do more extensive checking of the data supplied by these commands. The ACL
15546 condition &`verify = helo`& is provided to make this possible.
15547 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15548 to force the check to occur. From release 4.53 onwards, this is no longer
15549 necessary. If the check has not been done before &`verify = helo`& is
15550 encountered, it is done at that time. Consequently, this option is obsolete.
15551 Its specification is retained here for backwards compatibility.
15552
15553 When an EHLO or HELO command is received, if the calling host matches
15554 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15555 EHLO command either:
15556
15557 .ilist
15558 is an IP literal matching the calling address of the host, or
15559 .next
15560 .cindex "DNS" "reverse lookup"
15561 .cindex "reverse DNS lookup"
15562 matches the host name that Exim obtains by doing a reverse lookup of the
15563 calling host address, or
15564 .next
15565 when looked up in DNS yields the calling host address.
15566 .endlist
15567
15568 However, the EHLO or HELO command is not rejected if any of the checks
15569 fail. Processing continues, but the result of the check is remembered, and can
15570 be detected later in an ACL by the &`verify = helo`& condition.
15571
15572 If DNS was used for successful verification, the variable
15573 .cindex "DNS" "DNSSEC"
15574 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15575
15576 .option helo_verify_hosts main "host list&!!" unset
15577 .cindex "HELO verifying" "mandatory"
15578 .cindex "EHLO" "verifying, mandatory"
15579 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15580 backwards compatibility. For hosts that match this option, Exim checks the host
15581 name given in the HELO or EHLO in the same way as for
15582 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15583 rejected with a 550 error, and entries are written to the main and reject logs.
15584 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15585 error.
15586
15587 .option hold_domains main "domain list&!!" unset
15588 .cindex "domain" "delaying delivery"
15589 .cindex "delivery" "delaying certain domains"
15590 This option allows mail for particular domains to be held in the queue
15591 manually. The option is overridden if a message delivery is forced with the
15592 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15593 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15594 item in &%hold_domains%&, no routing or delivery for that address is done, and
15595 it is deferred every time the message is looked at.
15596
15597 This option is intended as a temporary operational measure for delaying the
15598 delivery of mail while some problem is being sorted out, or some new
15599 configuration tested. If you just want to delay the processing of some
15600 domains until a queue run occurs, you should use &%queue_domains%& or
15601 &%queue_smtp_domains%&, not &%hold_domains%&.
15602
15603 A setting of &%hold_domains%& does not override Exim's code for removing
15604 messages from the queue if they have been there longer than the longest retry
15605 time in any retry rule. If you want to hold messages for longer than the normal
15606 retry times, insert a dummy retry rule with a long retry time.
15607
15608
15609 .option host_lookup main "host list&!!" unset
15610 .cindex "host name" "lookup, forcing"
15611 Exim does not look up the name of a calling host from its IP address unless it
15612 is required to compare against some host list, or the host matches
15613 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15614 option (which normally contains IP addresses rather than host names). The
15615 default configuration file contains
15616 .code
15617 host_lookup = *
15618 .endd
15619 which causes a lookup to happen for all hosts. If the expense of these lookups
15620 is felt to be too great, the setting can be changed or removed.
15621
15622 After a successful reverse lookup, Exim does a forward lookup on the name it
15623 has obtained, to verify that it yields the IP address that it started with. If
15624 this check fails, Exim behaves as if the name lookup failed.
15625
15626 .vindex "&$host_lookup_failed$&"
15627 .vindex "&$sender_host_name$&"
15628 After any kind of failure, the host name (in &$sender_host_name$&) remains
15629 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15630 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15631 &`verify = reverse_host_lookup`& in ACLs.
15632
15633
15634 .option host_lookup_order main "string list" &`bydns:byaddr`&
15635 This option specifies the order of different lookup methods when Exim is trying
15636 to find a host name from an IP address. The default is to do a DNS lookup
15637 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15638 if that fails. You can change the order of these lookups, or omit one entirely,
15639 if you want.
15640
15641 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15642 multiple PTR records in the DNS and the IP address is not listed in
15643 &_/etc/hosts_&. Different operating systems give different results in this
15644 case. That is why the default tries a DNS lookup first.
15645
15646
15647
15648 .option host_reject_connection main "host list&!!" unset
15649 .cindex "host" "rejecting connections from"
15650 If this option is set, incoming SMTP calls from the hosts listed are rejected
15651 as soon as the connection is made.
15652 This option is obsolete, and retained only for backward compatibility, because
15653 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15654 connections immediately.
15655
15656 The ability to give an immediate rejection (either by this option or using an
15657 ACL) is provided for use in unusual cases. Many hosts will just try again,
15658 sometimes without much delay. Normally, it is better to use an ACL to reject
15659 incoming messages at a later stage, such as after RCPT commands. See
15660 chapter &<<CHAPACL>>&.
15661
15662
15663 .option hosts_connection_nolog main "host list&!!" unset
15664 .cindex "host" "not logging connections from"
15665 This option defines a list of hosts for which connection logging does not
15666 happen, even though the &%smtp_connection%& log selector is set. For example,
15667 you might want not to log SMTP connections from local processes, or from
15668 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15669 the daemon; you should therefore strive to restrict its value to a short inline
15670 list of IP addresses and networks. To disable logging SMTP connections from
15671 local processes, you must create a host list with an empty item. For example:
15672 .code
15673 hosts_connection_nolog = :
15674 .endd
15675 If the &%smtp_connection%& log selector is not set, this option has no effect.
15676
15677
15678
15679 .option hosts_proxy main "host list&!!" unset
15680 .cindex proxy "proxy protocol"
15681 This option enables use of Proxy Protocol proxies for incoming
15682 connections.  For details see section &<<SECTproxyInbound>>&.
15683
15684
15685 .option hosts_treat_as_local main "domain list&!!" unset
15686 .cindex "local host" "domains treated as"
15687 .cindex "host" "treated as local"
15688 If this option is set, any host names that match the domain list are treated as
15689 if they were the local host when Exim is scanning host lists obtained from MX
15690 records
15691 or other sources. Note that the value of this option is a domain list, not a
15692 host list, because it is always used to check host names, not IP addresses.
15693
15694 This option also applies when Exim is matching the special items
15695 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15696 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15697 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15698 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15699 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15700 interfaces and recognizing the local host.
15701
15702
15703 .option ibase_servers main "string list" unset
15704 .cindex "InterBase" "server list"
15705 This option provides a list of InterBase servers and associated connection data,
15706 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15707 The option is available only if Exim has been built with InterBase support.
15708
15709
15710
15711 .option ignore_bounce_errors_after main time 10w
15712 .cindex "bounce message" "discarding"
15713 .cindex "discarding bounce message"
15714 This option affects the processing of bounce messages that cannot be delivered,
15715 that is, those that suffer a permanent delivery failure. (Bounce messages that
15716 suffer temporary delivery failures are of course retried in the usual way.)
15717
15718 After a permanent delivery failure, bounce messages are frozen,
15719 because there is no sender to whom they can be returned. When a frozen bounce
15720 message has been in the queue for more than the given time, it is unfrozen at
15721 the next queue run, and a further delivery is attempted. If delivery fails
15722 again, the bounce message is discarded. This makes it possible to keep failed
15723 bounce messages around for a shorter time than the normal maximum retry time
15724 for frozen messages. For example,
15725 .code
15726 ignore_bounce_errors_after = 12h
15727 .endd
15728 retries failed bounce message deliveries after 12 hours, discarding any further
15729 failures. If the value of this option is set to a zero time period, bounce
15730 failures are discarded immediately. Setting a very long time (as in the default
15731 value) has the effect of disabling this option. For ways of automatically
15732 dealing with other kinds of frozen message, see &%auto_thaw%& and
15733 &%timeout_frozen_after%&.
15734
15735
15736 .option ignore_fromline_hosts main "host list&!!" unset
15737 .cindex "&""From""& line"
15738 .cindex "UUCP" "&""From""& line"
15739 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15740 the headers of a message. By default this is treated as the start of the
15741 message's body, which means that any following headers are not recognized as
15742 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15743 match those hosts that insist on sending it. If the sender is actually a local
15744 process rather than a remote host, and is using &%-bs%& to inject the messages,
15745 &%ignore_fromline_local%& must be set to achieve this effect.
15746
15747
15748 .option ignore_fromline_local main boolean false
15749 See &%ignore_fromline_hosts%& above.
15750
15751 .option keep_environment main "string list" unset
15752 .cindex "environment" "values from"
15753 This option contains a string list of environment variables to keep.
15754 You have to trust these variables or you have to be sure that
15755 these variables do not impose any security risk. Keep in mind that
15756 during the startup phase Exim is running with an effective UID 0 in most
15757 installations. As the default value is an empty list, the default
15758 environment for using libraries, running embedded Perl code, or running
15759 external binaries is empty, and does not not even contain PATH or HOME.
15760
15761 Actually the list is interpreted as a list of patterns
15762 (&<<SECTlistexpand>>&), except that it is not expanded first.
15763
15764 WARNING: Macro substitution is still done first, so having a macro
15765 FOO and having FOO_HOME in your &%keep_environment%& option may have
15766 unexpected results. You may work around this using a regular expression
15767 that does not match the macro name: ^[F]OO_HOME$.
15768
15769 Current versions of Exim issue a warning during startup if you do not mention
15770 &%keep_environment%& in your runtime configuration file and if your
15771 current environment is not empty. Future versions may not issue that warning
15772 anymore.
15773
15774 See the &%add_environment%& main config option for a way to set
15775 environment variables to a fixed value.  The environment for &(pipe)&
15776 transports is handled separately, see section &<<SECTpipeenv>>& for
15777 details.
15778
15779
15780 .option keep_malformed main time 4d
15781 This option specifies the length of time to keep messages whose spool files
15782 have been corrupted in some way. This should, of course, never happen. At the
15783 next attempt to deliver such a message, it gets removed. The incident is
15784 logged.
15785
15786
15787 .option ldap_ca_cert_dir main string unset
15788 .cindex "LDAP", "TLS CA certificate directory"
15789 .cindex certificate "directory for LDAP"
15790 This option indicates which directory contains CA certificates for verifying
15791 a TLS certificate presented by an LDAP server.
15792 While Exim does not provide a default value, your SSL library may.
15793 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15794 and constrained to be a directory.
15795
15796
15797 .option ldap_ca_cert_file main string unset
15798 .cindex "LDAP", "TLS CA certificate file"
15799 .cindex certificate "file for LDAP"
15800 This option indicates which file contains CA certificates for verifying
15801 a TLS certificate presented by an LDAP server.
15802 While Exim does not provide a default value, your SSL library may.
15803 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15804 and constrained to be a file.
15805
15806
15807 .option ldap_cert_file main string unset
15808 .cindex "LDAP" "TLS client certificate file"
15809 .cindex certificate "file for LDAP"
15810 This option indicates which file contains an TLS client certificate which
15811 Exim should present to the LDAP server during TLS negotiation.
15812 Should be used together with &%ldap_cert_key%&.
15813
15814
15815 .option ldap_cert_key main string unset
15816 .cindex "LDAP" "TLS client key file"
15817 .cindex certificate "key for LDAP"
15818 This option indicates which file contains the secret/private key to use
15819 to prove identity to the LDAP server during TLS negotiation.
15820 Should be used together with &%ldap_cert_file%&, which contains the
15821 identity to be proven.
15822
15823
15824 .option ldap_cipher_suite main string unset
15825 .cindex "LDAP" "TLS cipher suite"
15826 This controls the TLS cipher-suite negotiation during TLS negotiation with
15827 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15828 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15829
15830
15831 .option ldap_default_servers main "string list" unset
15832 .cindex "LDAP" "default servers"
15833 This option provides a list of LDAP servers which are tried in turn when an
15834 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15835 details of LDAP queries. This option is available only when Exim has been built
15836 with LDAP support.
15837
15838
15839 .option ldap_require_cert main string unset.
15840 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15841 This should be one of the values "hard", "demand", "allow", "try" or "never".
15842 A value other than one of these is interpreted as "never".
15843 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15844 Although Exim does not set a default, the LDAP library probably defaults
15845 to hard/demand.
15846
15847
15848 .option ldap_start_tls main boolean false
15849 .cindex "LDAP" "whether or not to negotiate TLS"
15850 If set, Exim will attempt to negotiate TLS with the LDAP server when
15851 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15852 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15853 of SSL-on-connect.
15854 In the event of failure to negotiate TLS, the action taken is controlled
15855 by &%ldap_require_cert%&.
15856 This option is ignored for &`ldapi`& connections.
15857
15858
15859 .option ldap_version main integer unset
15860 .cindex "LDAP" "protocol version, forcing"
15861 This option can be used to force Exim to set a specific protocol version for
15862 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15863 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15864 the LDAP headers; otherwise it is 2. This option is available only when Exim
15865 has been built with LDAP support.
15866
15867
15868
15869 .option local_from_check main boolean true
15870 .cindex "&'Sender:'& header line" "disabling addition of"
15871 .cindex "&'From:'& header line" "disabling checking of"
15872 When a message is submitted locally (that is, not over a TCP/IP connection) by
15873 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15874 checks that the &'From:'& header line matches the login of the calling user and
15875 the domain specified by &%qualify_domain%&.
15876
15877 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15878 locally submitted message is automatically qualified by Exim, unless the
15879 &%-bnq%& command line option is used.
15880
15881 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15882 on the local part. If the &'From:'& header line does not match, Exim adds a
15883 &'Sender:'& header with an address constructed from the calling user's login
15884 and the default qualify domain.
15885
15886 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15887 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15888 &'Sender:'& header lines supplied by untrusted users, you must also set
15889 &%local_sender_retain%& to be true.
15890
15891 .cindex "envelope sender"
15892 These options affect only the header lines in the message. The envelope sender
15893 is still forced to be the login id at the qualify domain unless
15894 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15895
15896 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15897 request similar header line checking. See section &<<SECTthesenhea>>&, which
15898 has more details about &'Sender:'& processing.
15899
15900
15901
15902
15903 .option local_from_prefix main string unset
15904 When Exim checks the &'From:'& header line of locally submitted messages for
15905 matching the login id (see &%local_from_check%& above), it can be configured to
15906 ignore certain prefixes and suffixes in the local part of the address. This is
15907 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15908 appropriate lists, in the same form as the &%local_part_prefix%& and
15909 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15910 example, if
15911 .code
15912 local_from_prefix = *-
15913 .endd
15914 is set, a &'From:'& line containing
15915 .code
15916 From: anything-user@your.domain.example
15917 .endd
15918 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15919 matches the actual sender address that is constructed from the login name and
15920 qualify domain.
15921
15922
15923 .option local_from_suffix main string unset
15924 See &%local_from_prefix%& above.
15925
15926
15927 .option local_interfaces main "string list" "see below"
15928 This option controls which network interfaces are used by the daemon for
15929 listening; they are also used to identify the local host when routing. Chapter
15930 &<<CHAPinterfaces>>& contains a full description of this option and the related
15931 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15932 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15933 &%local_interfaces%& is
15934 .code
15935 local_interfaces = 0.0.0.0
15936 .endd
15937 when Exim is built without IPv6 support; otherwise it is
15938 .code
15939 local_interfaces = <; ::0 ; 0.0.0.0
15940 .endd
15941
15942 .option local_scan_timeout main time 5m
15943 .cindex "timeout" "for &[local_scan()]& function"
15944 .cindex "&[local_scan()]& function" "timeout"
15945 This timeout applies to the &[local_scan()]& function (see chapter
15946 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15947 the incoming message is rejected with a temporary error if it is an SMTP
15948 message. For a non-SMTP message, the message is dropped and Exim ends with a
15949 non-zero code. The incident is logged on the main and reject logs.
15950
15951
15952
15953 .option local_sender_retain main boolean false
15954 .cindex "&'Sender:'& header line" "retaining from local submission"
15955 When a message is submitted locally (that is, not over a TCP/IP connection) by
15956 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15957 do not want this to happen, you must set &%local_sender_retain%&, and you must
15958 also set &%local_from_check%& to be false (Exim will complain if you do not).
15959 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15960 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15961
15962
15963
15964
15965 .option localhost_number main string&!! unset
15966 .cindex "host" "locally unique number for"
15967 .cindex "message ids" "with multiple hosts"
15968 .vindex "&$localhost_number$&"
15969 Exim's message ids are normally unique only within the local host. If
15970 uniqueness among a set of hosts is required, each host must set a different
15971 value for the &%localhost_number%& option. The string is expanded immediately
15972 after reading the configuration file (so that a number can be computed from the
15973 host name, for example) and the result of the expansion must be a number in the
15974 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15975 systems). This is available in subsequent string expansions via the variable
15976 &$localhost_number$&. When &%localhost_number is set%&, the final two
15977 characters of the message id, instead of just being a fractional part of the
15978 time, are computed from the time and the local host number as described in
15979 section &<<SECTmessiden>>&.
15980
15981
15982
15983 .option log_file_path main "string list&!!" "set at compile time"
15984 .cindex "log" "file path for"
15985 This option sets the path which is used to determine the names of Exim's log
15986 files, or indicates that logging is to be to syslog, or both. It is expanded
15987 when Exim is entered, so it can, for example, contain a reference to the host
15988 name. If no specific path is set for the log files at compile or runtime,
15989 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
15990 they are written in a sub-directory called &_log_& in Exim's spool directory.
15991 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15992 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15993 used. If this string is fixed at your installation (contains no expansion
15994 variables) it is recommended that you do not set this option in the
15995 configuration file, but instead supply the path using LOG_FILE_PATH in
15996 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15997 early on &-- in particular, failure to read the configuration file.
15998
15999
16000 .option log_selector main string unset
16001 .cindex "log" "selectors"
16002 This option can be used to reduce or increase the number of things that Exim
16003 writes to its log files. Its argument is made up of names preceded by plus or
16004 minus characters. For example:
16005 .code
16006 log_selector = +arguments -retry_defer
16007 .endd
16008 A list of possible names and what they control is given in the chapter on
16009 logging, in section &<<SECTlogselector>>&.
16010
16011
16012 .option log_timezone main boolean false
16013 .cindex "log" "timezone for entries"
16014 .vindex "&$tod_log$&"
16015 .vindex "&$tod_zone$&"
16016 By default, the timestamps on log lines are in local time without the
16017 timezone. This means that if your timezone changes twice a year, the timestamps
16018 in log lines are ambiguous for an hour when the clocks go back. One way of
16019 avoiding this problem is to set the timezone to UTC. An alternative is to set
16020 &%log_timezone%& true. This turns on the addition of the timezone offset to
16021 timestamps in log lines. Turning on this option can add quite a lot to the size
16022 of log files because each line is extended by 6 characters. Note that the
16023 &$tod_log$& variable contains the log timestamp without the zone, but there is
16024 another variable called &$tod_zone$& that contains just the timezone offset.
16025
16026
16027 .option lookup_open_max main integer 25
16028 .cindex "too many open files"
16029 .cindex "open files, too many"
16030 .cindex "file" "too many open"
16031 .cindex "lookup" "maximum open files"
16032 .cindex "limit" "open files for lookups"
16033 This option limits the number of simultaneously open files for single-key
16034 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16035 Exim normally keeps these files open during routing, because often the same
16036 file is required several times. If the limit is reached, Exim closes the least
16037 recently used file. Note that if you are using the &'ndbm'& library, it
16038 actually opens two files for each logical DBM database, though it still counts
16039 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16040 open files"& errors with NDBM, you need to reduce the value of
16041 &%lookup_open_max%&.
16042
16043
16044 .option max_username_length main integer 0
16045 .cindex "length of login name"
16046 .cindex "user name" "maximum length"
16047 .cindex "limit" "user name length"
16048 Some operating systems are broken in that they truncate long arguments to
16049 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16050 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16051 an argument that is longer behaves as if &[getpwnam()]& failed.
16052
16053
16054 .option message_body_newlines main bool false
16055 .cindex "message body" "newlines in variables"
16056 .cindex "newline" "in message body variables"
16057 .vindex "&$message_body$&"
16058 .vindex "&$message_body_end$&"
16059 By default, newlines in the message body are replaced by spaces when setting
16060 the &$message_body$& and &$message_body_end$& expansion variables. If this
16061 option is set true, this no longer happens.
16062
16063
16064 .option message_body_visible main integer 500
16065 .cindex "body of message" "visible size"
16066 .cindex "message body" "visible size"
16067 .vindex "&$message_body$&"
16068 .vindex "&$message_body_end$&"
16069 This option specifies how much of a message's body is to be included in the
16070 &$message_body$& and &$message_body_end$& expansion variables.
16071
16072
16073 .option message_id_header_domain main string&!! unset
16074 .cindex "&'Message-ID:'& header line"
16075 If this option is set, the string is expanded and used as the right hand side
16076 (domain) of the &'Message-ID:'& header that Exim creates if a
16077 locally-originated incoming message does not have one. &"Locally-originated"&
16078 means &"not received over TCP/IP."&
16079 Otherwise, the primary host name is used.
16080 Only letters, digits, dot and hyphen are accepted; any other characters are
16081 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16082 empty string, the option is ignored.
16083
16084
16085 .option message_id_header_text main string&!! unset
16086 If this variable is set, the string is expanded and used to augment the text of
16087 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16088 message does not have one. The text of this header is required by RFC 2822 to
16089 take the form of an address. By default, Exim uses its internal message id as
16090 the local part, and the primary host name as the domain. If this option is set,
16091 it is expanded, and provided the expansion is not forced to fail, and does not
16092 yield an empty string, the result is inserted into the header immediately
16093 before the @, separated from the internal message id by a dot. Any characters
16094 that are illegal in an address are automatically converted into hyphens. This
16095 means that variables such as &$tod_log$& can be used, because the spaces and
16096 colons will become hyphens.
16097
16098
16099 .option message_logs main boolean true
16100 .cindex "message logs" "disabling"
16101 .cindex "log" "message log; disabling"
16102 If this option is turned off, per-message log files are not created in the
16103 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16104 Exim, by reducing the number of files involved in handling a message from a
16105 minimum of four (header spool file, body spool file, delivery journal, and
16106 per-message log) to three. The other major I/O activity is Exim's main log,
16107 which is not affected by this option.
16108
16109
16110 .option message_size_limit main string&!! 50M
16111 .cindex "message" "size limit"
16112 .cindex "limit" "message size"
16113 .cindex "size" "of message, limit"
16114 This option limits the maximum size of message that Exim will process. The
16115 value is expanded for each incoming connection so, for example, it can be made
16116 to depend on the IP address of the remote host for messages arriving via
16117 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16118 optionally followed by K or M.
16119
16120 &*Note*&: This limit cannot be made to depend on a message's sender or any
16121 other properties of an individual message, because it has to be advertised in
16122 the server's response to EHLO. String expansion failure causes a temporary
16123 error. A value of zero means no limit, but its use is not recommended. See also
16124 &%bounce_return_size_limit%&.
16125
16126 Incoming SMTP messages are failed with a 552 error if the limit is
16127 exceeded; locally-generated messages either get a stderr message or a delivery
16128 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16129 an oversized message is logged in both the main and the reject logs. See also
16130 the generic transport option &%message_size_limit%&, which limits the size of
16131 message that an individual transport can process.
16132
16133 If you use a virus-scanner and set this option to to a value larger than the
16134 maximum size that your virus-scanner is configured to support, you may get
16135 failures triggered by large mails.  The right size to configure for the
16136 virus-scanner depends upon what data is passed and the options in use but it's
16137 probably safest to just set it to a little larger than this value.  E.g., with a
16138 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16139 some problems may result.
16140
16141 A value of 0 will disable size limit checking; Exim will still advertise the
16142 SIZE extension in an EHLO response, but without a limit, so as to permit
16143 SMTP clients to still indicate the message size along with the MAIL verb.
16144
16145
16146 .option move_frozen_messages main boolean false
16147 .cindex "frozen messages" "moving"
16148 This option, which is available only if Exim has been built with the setting
16149 .code
16150 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16151 .endd
16152 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16153 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16154 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16155 standard utilities for handling such moved messages, and they do not show up in
16156 lists generated by &%-bp%& or by the Exim monitor.
16157
16158
16159 .option mua_wrapper main boolean false
16160 Setting this option true causes Exim to run in a very restrictive mode in which
16161 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16162 contains a full description of this facility.
16163
16164
16165
16166 .option mysql_servers main "string list" unset
16167 .cindex "MySQL" "server list"
16168 This option provides a list of MySQL servers and associated connection data, to
16169 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16170 option is available only if Exim has been built with MySQL support.
16171
16172
16173 .option never_users main "string list&!!" unset
16174 This option is expanded just once, at the start of Exim's processing. Local
16175 message deliveries are normally run in processes that are setuid to the
16176 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16177 It is usually desirable to prevent any deliveries from running as root, as a
16178 safety precaution.
16179
16180 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16181 list of users that must not be used for local deliveries. This list is fixed in
16182 the binary and cannot be overridden by the configuration file. By default, it
16183 contains just the single user name &"root"&. The &%never_users%& runtime option
16184 can be used to add more users to the fixed list.
16185
16186 If a message is to be delivered as one of the users on the fixed list or the
16187 &%never_users%& list, an error occurs, and delivery is deferred. A common
16188 example is
16189 .code
16190 never_users = root:daemon:bin
16191 .endd
16192 Including root is redundant if it is also on the fixed list, but it does no
16193 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16194 transport driver.
16195
16196
16197 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket"
16198 .cindex "OpenSSL "compatibility options"
16199 This option allows an administrator to adjust the SSL options applied
16200 by OpenSSL to connections.  It is given as a space-separated list of items,
16201 each one to be +added or -subtracted from the current value.
16202
16203 This option is only available if Exim is built against OpenSSL.  The values
16204 available for this option vary according to the age of your OpenSSL install.
16205 The &"all"& value controls a subset of flags which are available, typically
16206 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16207 list the values known on your system and Exim should support all the
16208 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16209 names lose the leading &"SSL_OP_"& and are lower-cased.
16210
16211 Note that adjusting the options can have severe impact upon the security of
16212 SSL as used by Exim.  It is possible to disable safety checks and shoot
16213 yourself in the foot in various unpleasant ways.  This option should not be
16214 adjusted lightly.  An unrecognised item will be detected at startup, by
16215 invoking Exim with the &%-bV%& flag.
16216
16217 The option affects Exim operating both as a server and as a client.
16218
16219 Historical note: prior to release 4.80, Exim defaulted this value to
16220 "+dont_insert_empty_fragments", which may still be needed for compatibility
16221 with some clients, but which lowers security by increasing exposure to
16222 some now infamous attacks.
16223
16224 Examples:
16225 .code
16226 # Make both old MS and old Eudora happy:
16227 openssl_options = -all +microsoft_big_sslv3_buffer \
16228                        +dont_insert_empty_fragments
16229
16230 # Disable older protocol versions:
16231 openssl_options = +no_sslv2 +no_sslv3
16232 .endd
16233
16234 Possible options may include:
16235 .ilist
16236 &`all`&
16237 .next
16238 &`allow_unsafe_legacy_renegotiation`&
16239 .next
16240 &`cipher_server_preference`&
16241 .next
16242 &`dont_insert_empty_fragments`&
16243 .next
16244 &`ephemeral_rsa`&
16245 .next
16246 &`legacy_server_connect`&
16247 .next
16248 &`microsoft_big_sslv3_buffer`&
16249 .next
16250 &`microsoft_sess_id_bug`&
16251 .next
16252 &`msie_sslv2_rsa_padding`&
16253 .next
16254 &`netscape_challenge_bug`&
16255 .next
16256 &`netscape_reuse_cipher_change_bug`&
16257 .next
16258 &`no_compression`&
16259 .next
16260 &`no_session_resumption_on_renegotiation`&
16261 .next
16262 &`no_sslv2`&
16263 .next
16264 &`no_sslv3`&
16265 .next
16266 &`no_ticket`&
16267 .next
16268 &`no_tlsv1`&
16269 .next
16270 &`no_tlsv1_1`&
16271 .next
16272 &`no_tlsv1_2`&
16273 .next
16274 &`safari_ecdhe_ecdsa_bug`&
16275 .next
16276 &`single_dh_use`&
16277 .next
16278 &`single_ecdh_use`&
16279 .next
16280 &`ssleay_080_client_dh_bug`&
16281 .next
16282 &`sslref2_reuse_cert_type_bug`&
16283 .next
16284 &`tls_block_padding_bug`&
16285 .next
16286 &`tls_d5_bug`&
16287 .next
16288 &`tls_rollback_bug`&
16289 .endlist
16290
16291 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16292 all clients connecting using the MacOS SecureTransport TLS facility prior
16293 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16294 to negotiate TLS then this option value might help, provided that your OpenSSL
16295 release is new enough to contain this work-around.  This may be a situation
16296 where you have to upgrade OpenSSL to get buggy clients working.
16297
16298
16299 .option oracle_servers main "string list" unset
16300 .cindex "Oracle" "server list"
16301 This option provides a list of Oracle servers and associated connection data,
16302 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16303 The option is available only if Exim has been built with Oracle support.
16304
16305
16306 .option percent_hack_domains main "domain list&!!" unset
16307 .cindex "&""percent hack""&"
16308 .cindex "source routing" "in email address"
16309 .cindex "address" "source-routed"
16310 The &"percent hack"& is the convention whereby a local part containing a
16311 percent sign is re-interpreted as a new email address, with the percent
16312 replaced by @. This is sometimes called &"source routing"&, though that term is
16313 also applied to RFC 2822 addresses that begin with an @ character. If this
16314 option is set, Exim implements the percent facility for those domains listed,
16315 but no others. This happens before an incoming SMTP address is tested against
16316 an ACL.
16317
16318 &*Warning*&: The &"percent hack"& has often been abused by people who are
16319 trying to get round relaying restrictions. For this reason, it is best avoided
16320 if at all possible. Unfortunately, a number of less security-conscious MTAs
16321 implement it unconditionally. If you are running Exim on a gateway host, and
16322 routing mail through to internal MTAs without processing the local parts, it is
16323 a good idea to reject recipient addresses with percent characters in their
16324 local parts. Exim's default configuration does this.
16325
16326
16327 .option perl_at_start main boolean false
16328 .cindex "Perl"
16329 This option is available only when Exim is built with an embedded Perl
16330 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16331
16332
16333 .option perl_startup main string unset
16334 .cindex "Perl"
16335 This option is available only when Exim is built with an embedded Perl
16336 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16337
16338 .option perl_startup main boolean false
16339 .cindex "Perl"
16340 This Option enables the taint mode of the embedded Perl interpreter.
16341
16342
16343 .option pgsql_servers main "string list" unset
16344 .cindex "PostgreSQL lookup type" "server list"
16345 This option provides a list of PostgreSQL servers and associated connection
16346 data, to be used in conjunction with &(pgsql)& lookups (see section
16347 &<<SECID72>>&). The option is available only if Exim has been built with
16348 PostgreSQL support.
16349
16350
16351 .option pid_file_path main string&!! "set at compile time"
16352 .cindex "daemon" "pid file path"
16353 .cindex "pid file, path for"
16354 This option sets the name of the file to which the Exim daemon writes its
16355 process id. The string is expanded, so it can contain, for example, references
16356 to the host name:
16357 .code
16358 pid_file_path = /var/log/$primary_hostname/exim.pid
16359 .endd
16360 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16361 spool directory.
16362 The value set by the option can be overridden by the &%-oP%& command line
16363 option. A pid file is not written if a &"non-standard"& daemon is run by means
16364 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16365
16366
16367 .option pipelining_advertise_hosts main "host list&!!" *
16368 .cindex "PIPELINING" "suppressing advertising"
16369 This option can be used to suppress the advertisement of the SMTP
16370 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16371 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16372 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16373 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16374 that clients will use it; &"out of order"& commands that are &"expected"& do
16375 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16376
16377 .new
16378 .option pipelining_connect_advertise_hosts main "host list&!!" *
16379 .cindex "pipelining" "early connection"
16380 .cindex "pipelining" PIPE_CONNECT
16381 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16382 this option controls which hosts the facility is advertised to
16383 and from which pipeline early-connection (before MAIL) SMTP
16384 commands are acceptable.
16385 When used, the pipelining saves on roundtrip times.
16386
16387 Currently the option name &"X_PIPE_CONNECT"& is used.
16388 .wen
16389
16390
16391 .option prdr_enable main boolean false
16392 .cindex "PRDR" "enabling on server"
16393 This option can be used to enable the Per-Recipient Data Response extension
16394 to SMTP, defined by Eric Hall.
16395 If the option is set, PRDR is advertised by Exim when operating as a server.
16396 If the client requests PRDR, and more than one recipient, for a message
16397 an additional ACL is called for each recipient after the message content
16398 is received.  See section &<<SECTPRDRACL>>&.
16399
16400 .option preserve_message_logs main boolean false
16401 .cindex "message logs" "preserving"
16402 If this option is set, message log files are not deleted when messages are
16403 completed. Instead, they are moved to a sub-directory of the spool directory
16404 called &_msglog.OLD_&, where they remain available for statistical or debugging
16405 purposes. This is a dangerous option to set on systems with any appreciable
16406 volume of mail. Use with care!
16407
16408
16409 .option primary_hostname main string "see below"
16410 .cindex "name" "of local host"
16411 .cindex "host" "name of local"
16412 .cindex "local host" "name of"
16413 .vindex "&$primary_hostname$&"
16414 This specifies the name of the current host. It is used in the default EHLO or
16415 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16416 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16417 The value is also used by default in some SMTP response messages from an Exim
16418 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16419
16420 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16421 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16422 contains only one component, Exim passes it to &[gethostbyname()]& (or
16423 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16424 version. The variable &$primary_hostname$& contains the host name, whether set
16425 explicitly by this option, or defaulted.
16426
16427
16428 .option print_topbitchars main boolean false
16429 .cindex "printing characters"
16430 .cindex "8-bit characters"
16431 By default, Exim considers only those characters whose codes lie in the range
16432 32&--126 to be printing characters. In a number of circumstances (for example,
16433 when writing log entries) non-printing characters are converted into escape
16434 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16435 is set, code values of 128 and above are also considered to be printing
16436 characters.
16437
16438 This option also affects the header syntax checks performed by the
16439 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16440 the user's full name when constructing From: and Sender: addresses (as
16441 described in section &<<SECTconstr>>&). Setting this option can cause
16442 Exim to generate eight bit message headers that do not conform to the
16443 standards.
16444
16445
16446 .option process_log_path main string unset
16447 .cindex "process log path"
16448 .cindex "log" "process log"
16449 .cindex "&'exiwhat'&"
16450 This option sets the name of the file to which an Exim process writes its
16451 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16452 utility script. If this option is unset, the file called &_exim-process.info_&
16453 in Exim's spool directory is used. The ability to specify the name explicitly
16454 can be useful in environments where two different Exims are running, using
16455 different spool directories.
16456
16457
16458 .option prod_requires_admin main boolean true
16459 .cindex "restricting access to features"
16460 .oindex "&%-M%&"
16461 .oindex "&%-R%&"
16462 .oindex "&%-q%&"
16463 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16464 admin user unless &%prod_requires_admin%& is set false. See also
16465 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16466
16467
16468 .option qualify_domain main string "see below"
16469 .cindex "domain" "for qualifying addresses"
16470 .cindex "address" "qualification"
16471 This option specifies the domain name that is added to any envelope sender
16472 addresses that do not have a domain qualification. It also applies to
16473 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16474 are accepted by default only for locally-generated messages. Qualification is
16475 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16476 locally-generated messages, unless the &%-bnq%& command line option is used.
16477
16478 Messages from external sources must always contain fully qualified addresses,
16479 unless the sending host matches &%sender_unqualified_hosts%& or
16480 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16481 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16482 necessary. Internally, Exim always works with fully qualified envelope
16483 addresses. If &%qualify_domain%& is not set, it defaults to the
16484 &%primary_hostname%& value.
16485
16486
16487 .option qualify_recipient main string "see below"
16488 This option allows you to specify a different domain for qualifying recipient
16489 addresses to the one that is used for senders. See &%qualify_domain%& above.
16490
16491
16492
16493 .option queue_domains main "domain list&!!" unset
16494 .cindex "domain" "specifying non-immediate delivery"
16495 .cindex "queueing incoming messages"
16496 .cindex "message" "queueing certain domains"
16497 This option lists domains for which immediate delivery is not required.
16498 A delivery process is started whenever a message is received, but only those
16499 domains that do not match are processed. All other deliveries wait until the
16500 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16501
16502
16503 .option queue_list_requires_admin main boolean true
16504 .cindex "restricting access to features"
16505 .oindex "&%-bp%&"
16506 The &%-bp%& command-line option, which lists the messages that are on the
16507 queue, requires the caller to be an admin user unless
16508 &%queue_list_requires_admin%& is set false.
16509 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16510
16511
16512 .option queue_only main boolean false
16513 .cindex "queueing incoming messages"
16514 .cindex "message" "queueing unconditionally"
16515 If &%queue_only%& is set, a delivery process is not automatically started
16516 whenever a message is received. Instead, the message waits in the queue for the
16517 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16518 delivered immediately when certain conditions (such as heavy load) occur.
16519
16520 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16521 and &%-odi%& command line options override &%queue_only%& unless
16522 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16523 &%queue_only_load%&, and &%smtp_accept_queue%&.
16524
16525
16526 .option queue_only_file main string unset
16527 .cindex "queueing incoming messages"
16528 .cindex "message" "queueing by file existence"
16529 This option can be set to a colon-separated list of absolute path names, each
16530 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16531 it tests for the existence of each listed path using a call to &[stat()]&. For
16532 each path that exists, the corresponding queueing option is set.
16533 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16534 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16535 .code
16536 queue_only_file = smtp/some/file
16537 .endd
16538 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16539 &_/some/file_& exists.
16540
16541
16542 .option queue_only_load main fixed-point unset
16543 .cindex "load average"
16544 .cindex "queueing incoming messages"
16545 .cindex "message" "queueing by load"
16546 If the system load average is higher than this value, incoming messages from
16547 all sources are queued, and no automatic deliveries are started. If this
16548 happens during local or remote SMTP input, all subsequent messages received on
16549 the same SMTP connection are queued by default, whatever happens to the load in
16550 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16551 false.
16552
16553 Deliveries will subsequently be performed by queue runner processes. This
16554 option has no effect on ancient operating systems on which Exim cannot
16555 determine the load average. See also &%deliver_queue_load_max%& and
16556 &%smtp_load_reserve%&.
16557
16558
16559 .option queue_only_load_latch main boolean true
16560 .cindex "load average" "re-evaluating per message"
16561 When this option is true (the default), once one message has been queued
16562 because the load average is higher than the value set by &%queue_only_load%&,
16563 all subsequent messages received on the same SMTP connection are also queued.
16564 This is a deliberate choice; even though the load average may fall below the
16565 threshold, it doesn't seem right to deliver later messages on the same
16566 connection when not delivering earlier ones. However, there are special
16567 circumstances such as very long-lived connections from scanning appliances
16568 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16569 should be set false. This causes the value of the load average to be
16570 re-evaluated for each message.
16571
16572
16573 .option queue_only_override main boolean true
16574 .cindex "queueing incoming messages"
16575 When this option is true, the &%-od%&&'x'& command line options override the
16576 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16577 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16578 to override; they are accepted, but ignored.
16579
16580
16581 .option queue_run_in_order main boolean false
16582 .cindex "queue runner" "processing messages in order"
16583 If this option is set, queue runs happen in order of message arrival instead of
16584 in an arbitrary order. For this to happen, a complete list of the entire queue
16585 must be set up before the deliveries start. When the queue is all held in a
16586 single directory (the default), a single list is created for both the ordered
16587 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16588 single list is not created when &%queue_run_in_order%& is false. In this case,
16589 the sub-directories are processed one at a time (in a random order), and this
16590 avoids setting up one huge list for the whole queue. Thus, setting
16591 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16592 when the queue is large, because of the extra work in setting up the single,
16593 large list. In most situations, &%queue_run_in_order%& should not be set.
16594
16595
16596
16597 .option queue_run_max main integer&!! 5
16598 .cindex "queue runner" "maximum number of"
16599 This controls the maximum number of queue runner processes that an Exim daemon
16600 can run simultaneously. This does not mean that it starts them all at once,
16601 but rather that if the maximum number are still running when the time comes to
16602 start another one, it refrains from starting another one. This can happen with
16603 very large queues and/or very sluggish deliveries. This option does not,
16604 however, interlock with other processes, so additional queue runners can be
16605 started by other means, or by killing and restarting the daemon.
16606
16607 Setting this option to zero does not suppress queue runs; rather, it disables
16608 the limit, allowing any number of simultaneous queue runner processes to be
16609 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16610 the daemon's command line.
16611
16612 .cindex queues named
16613 .cindex "named queues"
16614 To set limits for different named queues use
16615 an expansion depending on the &$queue_name$& variable.
16616
16617 .option queue_smtp_domains main "domain list&!!" unset
16618 .cindex "queueing incoming messages"
16619 .cindex "message" "queueing remote deliveries"
16620 When this option is set, a delivery process is started whenever a message is
16621 received, routing is performed, and local deliveries take place.
16622 However, if any SMTP deliveries are required for domains that match
16623 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16624 message waits in the queue for the next queue run. Since routing of the message
16625 has taken place, Exim knows to which remote hosts it must be delivered, and so
16626 when the queue run happens, multiple messages for the same host are delivered
16627 over a single SMTP connection. The &%-odqs%& command line option causes all
16628 SMTP deliveries to be queued in this way, and is equivalent to setting
16629 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16630 &%queue_domains%&.
16631
16632
16633 .option receive_timeout main time 0s
16634 .cindex "timeout" "for non-SMTP input"
16635 This option sets the timeout for accepting a non-SMTP message, that is, the
16636 maximum time that Exim waits when reading a message on the standard input. If
16637 the value is zero, it will wait forever. This setting is overridden by the
16638 &%-or%& command line option. The timeout for incoming SMTP messages is
16639 controlled by &%smtp_receive_timeout%&.
16640
16641 .option received_header_text main string&!! "see below"
16642 .cindex "customizing" "&'Received:'& header"
16643 .cindex "&'Received:'& header line" "customizing"
16644 This string defines the contents of the &'Received:'& message header that is
16645 added to each message, except for the timestamp, which is automatically added
16646 on at the end (preceded by a semicolon). The string is expanded each time it is
16647 used. If the expansion yields an empty string, no &'Received:'& header line is
16648 added to the message. Otherwise, the string should start with the text
16649 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16650 header lines.
16651 .new
16652 The default setting is:
16653
16654 .code
16655 received_header_text = Received: \
16656   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16657     {${if def:sender_ident \
16658       {from ${quote_local_part:$sender_ident} }}\
16659         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16660   by $primary_hostname \
16661   ${if def:received_protocol {with $received_protocol }}\
16662   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16663   (Exim $version_number)\n\t\
16664   ${if def:sender_address \
16665   {(envelope-from <$sender_address>)\n\t}}\
16666   id $message_exim_id\
16667   ${if def:received_for {\n\tfor $received_for}}
16668 .endd
16669 .wen
16670
16671 The reference to the TLS cipher is omitted when Exim is built without TLS
16672 support. The use of conditional expansions ensures that this works for both
16673 locally generated messages and messages received from remote hosts, giving
16674 header lines such as the following:
16675 .code
16676 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16677 by marley.carol.example with esmtp (Exim 4.00)
16678 (envelope-from <bob@carol.example>)
16679 id 16IOWa-00019l-00
16680 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16681 Received: by scrooge.carol.example with local (Exim 4.00)
16682 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16683 .endd
16684 Until the body of the message has been received, the timestamp is the time when
16685 the message started to be received. Once the body has arrived, and all policy
16686 checks have taken place, the timestamp is updated to the time at which the
16687 message was accepted.
16688
16689
16690 .option received_headers_max main integer 30
16691 .cindex "loop" "prevention"
16692 .cindex "mail loop prevention"
16693 .cindex "&'Received:'& header line" "counting"
16694 When a message is to be delivered, the number of &'Received:'& headers is
16695 counted, and if it is greater than this parameter, a mail loop is assumed to
16696 have occurred, the delivery is abandoned, and an error message is generated.
16697 This applies to both local and remote deliveries.
16698
16699
16700 .option recipient_unqualified_hosts main "host list&!!" unset
16701 .cindex "unqualified addresses"
16702 .cindex "host" "unqualified addresses from"
16703 This option lists those hosts from which Exim is prepared to accept unqualified
16704 recipient addresses in message envelopes. The addresses are made fully
16705 qualified by the addition of the &%qualify_recipient%& value. This option also
16706 affects message header lines. Exim does not reject unqualified recipient
16707 addresses in headers, but it qualifies them only if the message came from a
16708 host that matches &%recipient_unqualified_hosts%&,
16709 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16710 option was not set.
16711
16712
16713 .option recipients_max main integer 0
16714 .cindex "limit" "number of recipients"
16715 .cindex "recipient" "maximum number"
16716 If this option is set greater than zero, it specifies the maximum number of
16717 original recipients for any message. Additional recipients that are generated
16718 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16719 all recipients over the limit; earlier recipients are delivered as normal.
16720 Non-SMTP messages with too many recipients are failed, and no deliveries are
16721 done.
16722
16723 .cindex "RCPT" "maximum number of incoming"
16724 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16725 RCPT commands in a single message.
16726
16727
16728 .option recipients_max_reject main boolean false
16729 If this option is set true, Exim rejects SMTP messages containing too many
16730 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16731 error to the eventual DATA command. Otherwise (the default) it gives a 452
16732 error to the surplus RCPT commands and accepts the message on behalf of the
16733 initial set of recipients. The remote server should then re-send the message
16734 for the remaining recipients at a later time.
16735
16736
16737 .option remote_max_parallel main integer 2
16738 .cindex "delivery" "parallelism for remote"
16739 This option controls parallel delivery of one message to a number of remote
16740 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16741 does all the remote deliveries for a message one by one. Otherwise, if a single
16742 message has to be delivered to more than one remote host, or if several copies
16743 have to be sent to the same remote host, up to &%remote_max_parallel%&
16744 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16745 deliveries are required, the maximum number of processes are started, and as
16746 each one finishes, another is begun. The order of starting processes is the
16747 same as if sequential delivery were being done, and can be controlled by the
16748 &%remote_sort_domains%& option. If parallel delivery takes place while running
16749 with debugging turned on, the debugging output from each delivery process is
16750 tagged with its process id.
16751
16752 This option controls only the maximum number of parallel deliveries for one
16753 message in one Exim delivery process. Because Exim has no central queue
16754 manager, there is no way of controlling the total number of simultaneous
16755 deliveries if the configuration allows a delivery attempt as soon as a message
16756 is received.
16757
16758 .cindex "number of deliveries"
16759 .cindex "delivery" "maximum number of"
16760 If you want to control the total number of deliveries on the system, you
16761 need to set the &%queue_only%& option. This ensures that all incoming messages
16762 are added to the queue without starting a delivery process. Then set up an Exim
16763 daemon to start queue runner processes at appropriate intervals (probably
16764 fairly often, for example, every minute), and limit the total number of queue
16765 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16766 delivers only one message at a time, the maximum number of deliveries that can
16767 then take place at once is &%queue_run_max%& multiplied by
16768 &%remote_max_parallel%&.
16769
16770 If it is purely remote deliveries you want to control, use
16771 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16772 doing the SMTP routing before queueing, so that several messages for the same
16773 host will eventually get delivered down the same connection.
16774
16775
16776 .option remote_sort_domains main "domain list&!!" unset
16777 .cindex "sorting remote deliveries"
16778 .cindex "delivery" "sorting remote"
16779 When there are a number of remote deliveries for a message, they are sorted by
16780 domain into the order given by this list. For example,
16781 .code
16782 remote_sort_domains = *.cam.ac.uk:*.uk
16783 .endd
16784 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16785 then to those in the &%uk%& domain, then to any others.
16786
16787
16788 .option retry_data_expire main time 7d
16789 .cindex "hints database" "data expiry"
16790 This option sets a &"use before"& time on retry information in Exim's hints
16791 database. Any older retry data is ignored. This means that, for example, once a
16792 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16793 past failures.
16794
16795
16796 .option retry_interval_max main time 24h
16797 .cindex "retry" "limit on interval"
16798 .cindex "limit" "on retry interval"
16799 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16800 intervals between delivery attempts for messages that cannot be delivered
16801 straight away. This option sets an overall limit to the length of time between
16802 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16803 the default value.
16804
16805
16806 .option return_path_remove main boolean true
16807 .cindex "&'Return-path:'& header line" "removing"
16808 RFC 2821, section 4.4, states that an SMTP server must insert a
16809 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16810 The &'Return-path:'& header preserves the sender address as received in the
16811 MAIL command. This description implies that this header should not be present
16812 in an incoming message. If &%return_path_remove%& is true, any existing
16813 &'Return-path:'& headers are removed from messages at the time they are
16814 received. Exim's transports have options for adding &'Return-path:'& headers at
16815 the time of delivery. They are normally used only for final local deliveries.
16816
16817
16818 .option return_size_limit main integer 100K
16819 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16820
16821
16822 .option rfc1413_hosts main "host list&!!" @[]
16823 .cindex "RFC 1413"
16824 .cindex "host" "for RFC 1413 calls"
16825 RFC 1413 identification calls are made to any client host which matches
16826 an item in the list.
16827 The default value specifies just this host, being any local interface
16828 for the system.
16829
16830 .option rfc1413_query_timeout main time 0s
16831 .cindex "RFC 1413" "query timeout"
16832 .cindex "timeout" "for RFC 1413 call"
16833 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16834 no RFC 1413 calls are ever made.
16835
16836
16837 .option sender_unqualified_hosts main "host list&!!" unset
16838 .cindex "unqualified addresses"
16839 .cindex "host" "unqualified addresses from"
16840 This option lists those hosts from which Exim is prepared to accept unqualified
16841 sender addresses. The addresses are made fully qualified by the addition of
16842 &%qualify_domain%&. This option also affects message header lines. Exim does
16843 not reject unqualified addresses in headers that contain sender addresses, but
16844 it qualifies them only if the message came from a host that matches
16845 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16846 using TCP/IP), and the &%-bnq%& option was not set.
16847
16848 .option set_environment main "string list" empty
16849 .cindex "environment"
16850 This option allows to set individual environment variables that the
16851 currently linked libraries and programs in child processes use. The
16852 default list is empty,
16853
16854
16855 .option slow_lookup_log main integer 0
16856 .cindex "logging" "slow lookups"
16857 .cindex "dns" "logging slow lookups"
16858 This option controls logging of slow lookups.
16859 If the value is nonzero it is taken as a number of milliseconds
16860 and lookups taking longer than this are logged.
16861 Currently this applies only to DNS lookups.
16862
16863
16864
16865 .option smtp_accept_keepalive main boolean true
16866 .cindex "keepalive" "on incoming connection"
16867 This option controls the setting of the SO_KEEPALIVE option on incoming
16868 TCP/IP socket connections. When set, it causes the kernel to probe idle
16869 connections periodically, by sending packets with &"old"& sequence numbers. The
16870 other end of the connection should send an acknowledgment if the connection is
16871 still okay or a reset if the connection has been aborted. The reason for doing
16872 this is that it has the beneficial effect of freeing up certain types of
16873 connection that can get stuck when the remote host is disconnected without
16874 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16875 hours to detect unreachable hosts.
16876
16877
16878
16879 .option smtp_accept_max main integer 20
16880 .cindex "limit" "incoming SMTP connections"
16881 .cindex "SMTP" "incoming connection count"
16882 .cindex "inetd"
16883 This option specifies the maximum number of simultaneous incoming SMTP calls
16884 that Exim will accept. It applies only to the listening daemon; there is no
16885 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16886 value is set to zero, no limit is applied. However, it is required to be
16887 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16888 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16889
16890 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16891 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16892 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16893 and &%smtp_load_reserve%& are then checked before accepting the connection.
16894
16895
16896 .option smtp_accept_max_nonmail main integer 10
16897 .cindex "limit" "non-mail SMTP commands"
16898 .cindex "SMTP" "limiting non-mail commands"
16899 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16900 the connection if there are too many. This option defines &"too many"&. The
16901 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16902 client looping sending EHLO, for example. The check is applied only if the
16903 client host matches &%smtp_accept_max_nonmail_hosts%&.
16904
16905 When a new message is expected, one occurrence of RSET is not counted. This
16906 allows a client to send one RSET between messages (this is not necessary,
16907 but some clients do it). Exim also allows one uncounted occurrence of HELO
16908 or EHLO, and one occurrence of STARTTLS between messages. After
16909 starting up a TLS session, another EHLO is expected, and so it too is not
16910 counted. The first occurrence of AUTH in a connection, or immediately
16911 following STARTTLS is not counted. Otherwise, all commands other than
16912 MAIL, RCPT, DATA, and QUIT are counted.
16913
16914
16915 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16916 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16917 check by setting this option. The default value makes it apply to all hosts. By
16918 changing the value, you can exclude any badly-behaved hosts that you have to
16919 live with.
16920
16921
16922 . Allow this long option name to split; give it unsplit as a fifth argument
16923 . for the automatic .oindex that is generated by .option.
16924 . We insert " &~&~" which is both pretty nasty visually and results in
16925 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16926 . zero-width-space, which would be nicer visually and results in (at least)
16927 . html that Firefox will split on when it's forced to reflow (rather than
16928 . inserting a horizontal scrollbar).  However, the text is still not
16929 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16930 . the option name to split.
16931
16932 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16933          smtp_accept_max_per_connection
16934 .cindex "SMTP" "limiting incoming message count"
16935 .cindex "limit" "messages per SMTP connection"
16936 The value of this option limits the number of MAIL commands that Exim is
16937 prepared to accept over a single SMTP connection, whether or not each command
16938 results in the transfer of a message. After the limit is reached, a 421
16939 response is given to subsequent MAIL commands. This limit is a safety
16940 precaution against a client that goes mad (incidents of this type have been
16941 seen).
16942
16943
16944 .option smtp_accept_max_per_host main string&!! unset
16945 .cindex "limit" "SMTP connections from one host"
16946 .cindex "host" "limiting SMTP connections from"
16947 This option restricts the number of simultaneous IP connections from a single
16948 host (strictly, from a single IP address) to the Exim daemon. The option is
16949 expanded, to enable different limits to be applied to different hosts by
16950 reference to &$sender_host_address$&. Once the limit is reached, additional
16951 connection attempts from the same host are rejected with error code 421. This
16952 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16953 of zero imposes no limit. If this option is set greater than zero, it is
16954 required that &%smtp_accept_max%& be non-zero.
16955
16956 &*Warning*&: When setting this option you should not use any expansion
16957 constructions that take an appreciable amount of time. The expansion and test
16958 happen in the main daemon loop, in order to reject additional connections
16959 without forking additional processes (otherwise a denial-of-service attack
16960 could cause a vast number or processes to be created). While the daemon is
16961 doing this processing, it cannot accept any other incoming connections.
16962
16963
16964
16965 .option smtp_accept_queue main integer 0
16966 .cindex "SMTP" "incoming connection count"
16967 .cindex "queueing incoming messages"
16968 .cindex "message" "queueing by SMTP connection count"
16969 If the number of simultaneous incoming SMTP connections being handled via the
16970 listening daemon exceeds this value, messages received by SMTP are just placed
16971 in the queue; no delivery processes are started automatically. The count is
16972 fixed at the start of an SMTP connection. It cannot be updated in the
16973 subprocess that receives messages, and so the queueing or not queueing applies
16974 to all messages received in the same connection.
16975
16976 A value of zero implies no limit, and clearly any non-zero value is useful only
16977 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16978 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16979 various &%-od%&&'x'& command line options.
16980
16981
16982 . See the comment on smtp_accept_max_per_connection
16983
16984 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16985          smtp_accept_queue_per_connection
16986 .cindex "queueing incoming messages"
16987 .cindex "message" "queueing by message count"
16988 This option limits the number of delivery processes that Exim starts
16989 automatically when receiving messages via SMTP, whether via the daemon or by
16990 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16991 and the number of messages received in a single SMTP session exceeds this
16992 number, subsequent messages are placed in the queue, but no delivery processes
16993 are started. This helps to limit the number of Exim processes when a server
16994 restarts after downtime and there is a lot of mail waiting for it on other
16995 systems. On large systems, the default should probably be increased, and on
16996 dial-in client systems it should probably be set to zero (that is, disabled).
16997
16998
16999 .option smtp_accept_reserve main integer 0
17000 .cindex "SMTP" "incoming call count"
17001 .cindex "host" "reserved"
17002 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17003 number of SMTP connections that are reserved for connections from the hosts
17004 that are specified in &%smtp_reserve_hosts%&. The value set in
17005 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17006 restricted to this number of connections; the option specifies a minimum number
17007 of connection slots for them, not a maximum. It is a guarantee that this group
17008 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17009 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17010 individual host.
17011
17012 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17013 set to 5, once there are 45 active connections (from any hosts), new
17014 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17015 provided the other criteria for acceptance are met.
17016
17017
17018 .option smtp_active_hostname main string&!! unset
17019 .cindex "host" "name in SMTP responses"
17020 .cindex "SMTP" "host name in responses"
17021 .vindex "&$primary_hostname$&"
17022 This option is provided for multi-homed servers that want to masquerade as
17023 several different hosts. At the start of an incoming SMTP connection, its value
17024 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17025 responses. For example, it is used as domain name in the response to an
17026 incoming HELO or EHLO command.
17027
17028 .vindex "&$smtp_active_hostname$&"
17029 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17030 is saved with any messages that are received. It is therefore available for use
17031 in routers and transports when the message is later delivered.
17032
17033 If this option is unset, or if its expansion is forced to fail, or if the
17034 expansion results in an empty string, the value of &$primary_hostname$& is
17035 used. Other expansion failures cause a message to be written to the main and
17036 panic logs, and the SMTP command receives a temporary error. Typically, the
17037 value of &%smtp_active_hostname%& depends on the incoming interface address.
17038 For example:
17039 .code
17040 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17041   {cox.mydomain}{box.mydomain}}
17042 .endd
17043
17044 Although &$smtp_active_hostname$& is primarily concerned with incoming
17045 messages, it is also used as the default for HELO commands in callout
17046 verification if there is no remote transport from which to obtain a
17047 &%helo_data%& value.
17048
17049 .option smtp_banner main string&!! "see below"
17050 .cindex "SMTP" "welcome banner"
17051 .cindex "banner for SMTP"
17052 .cindex "welcome banner for SMTP"
17053 .cindex "customizing" "SMTP banner"
17054 This string, which is expanded every time it is used, is output as the initial
17055 positive response to an SMTP connection. The default setting is:
17056 .code
17057 smtp_banner = $smtp_active_hostname ESMTP Exim \
17058   $version_number $tod_full
17059 .endd
17060 Failure to expand the string causes a panic error. If you want to create a
17061 multiline response to the initial SMTP connection, use &"\n"& in the string at
17062 appropriate points, but not at the end. Note that the 220 code is not included
17063 in this string. Exim adds it automatically (several times in the case of a
17064 multiline response).
17065
17066
17067 .option smtp_check_spool_space main boolean true
17068 .cindex "checking disk space"
17069 .cindex "disk space, checking"
17070 .cindex "spool directory" "checking space"
17071 When this option is set, if an incoming SMTP session encounters the SIZE
17072 option on a MAIL command, it checks that there is enough space in the
17073 spool directory's partition to accept a message of that size, while still
17074 leaving free the amount specified by &%check_spool_space%& (even if that value
17075 is zero). If there isn't enough space, a temporary error code is returned.
17076
17077
17078 .option smtp_connect_backlog main integer 20
17079 .cindex "connection backlog"
17080 .cindex "SMTP" "connection backlog"
17081 .cindex "backlog of connections"
17082 This option specifies a maximum number of waiting SMTP connections. Exim passes
17083 this value to the TCP/IP system when it sets up its listener. Once this number
17084 of connections are waiting for the daemon's attention, subsequent connection
17085 attempts are refused at the TCP/IP level. At least, that is what the manuals
17086 say; in some circumstances such connection attempts have been observed to time
17087 out instead. For large systems it is probably a good idea to increase the
17088 value (to 50, say). It also gives some protection against denial-of-service
17089 attacks by SYN flooding.
17090
17091
17092 .option smtp_enforce_sync main boolean true
17093 .cindex "SMTP" "synchronization checking"
17094 .cindex "synchronization checking in SMTP"
17095 The SMTP protocol specification requires the client to wait for a response from
17096 the server at certain points in the dialogue. Without PIPELINING these
17097 synchronization points are after every command; with PIPELINING they are
17098 fewer, but they still exist.
17099
17100 Some spamming sites send out a complete set of SMTP commands without waiting
17101 for any response. Exim protects against this by rejecting a message if the
17102 client has sent further input when it should not have. The error response &"554
17103 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17104 for this error cannot be perfect because of transmission delays (unexpected
17105 input may be on its way but not yet received when Exim checks). However, it
17106 does detect many instances.
17107
17108 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17109 If you want to disable the check selectively (for example, only for certain
17110 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17111 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17112
17113
17114
17115 .option smtp_etrn_command main string&!! unset
17116 .cindex "ETRN" "command to be run"
17117 .vindex "&$domain$&"
17118 If this option is set, the given command is run whenever an SMTP ETRN
17119 command is received from a host that is permitted to issue such commands (see
17120 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17121 are independently expanded. The expansion variable &$domain$& is set to the
17122 argument of the ETRN command, and no syntax checking is done on it. For
17123 example:
17124 .code
17125 smtp_etrn_command = /etc/etrn_command $domain \
17126                     $sender_host_address
17127 .endd
17128 A new process is created to run the command, but Exim does not wait for it to
17129 complete. Consequently, its status cannot be checked. If the command cannot be
17130 run, a line is written to the panic log, but the ETRN caller still receives
17131 a 250 success response. Exim is normally running under its own uid when
17132 receiving SMTP, so it is not possible for it to change the uid before running
17133 the command.
17134
17135
17136 .option smtp_etrn_serialize main boolean true
17137 .cindex "ETRN" "serializing"
17138 When this option is set, it prevents the simultaneous execution of more than
17139 one identical command as a result of ETRN in an SMTP connection. See
17140 section &<<SECTETRN>>& for details.
17141
17142
17143 .option smtp_load_reserve main fixed-point unset
17144 .cindex "load average"
17145 If the system load average ever gets higher than this, incoming SMTP calls are
17146 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17147 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17148 the load is over the limit. The option has no effect on ancient operating
17149 systems on which Exim cannot determine the load average. See also
17150 &%deliver_queue_load_max%& and &%queue_only_load%&.
17151
17152
17153
17154 .option smtp_max_synprot_errors main integer 3
17155 .cindex "SMTP" "limiting syntax and protocol errors"
17156 .cindex "limit" "SMTP syntax and protocol errors"
17157 Exim rejects SMTP commands that contain syntax or protocol errors. In
17158 particular, a syntactically invalid email address, as in this command:
17159 .code
17160 RCPT TO:<abc xyz@a.b.c>
17161 .endd
17162 causes immediate rejection of the command, before any other tests are done.
17163 (The ACL cannot be run if there is no valid address to set up for it.) An
17164 example of a protocol error is receiving RCPT before MAIL. If there are
17165 too many syntax or protocol errors in one SMTP session, the connection is
17166 dropped. The limit is set by this option.
17167
17168 .cindex "PIPELINING" "expected errors"
17169 When the PIPELINING extension to SMTP is in use, some protocol errors are
17170 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17171 Exim assumes that PIPELINING will be used if it advertises it (see
17172 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17173 not count towards the limit.
17174
17175
17176
17177 .option smtp_max_unknown_commands main integer 3
17178 .cindex "SMTP" "limiting unknown commands"
17179 .cindex "limit" "unknown SMTP commands"
17180 If there are too many unrecognized commands in an incoming SMTP session, an
17181 Exim server drops the connection. This is a defence against some kinds of abuse
17182 that subvert web
17183 clients
17184 into making connections to SMTP ports; in these circumstances, a number of
17185 non-SMTP command lines are sent first.
17186
17187
17188
17189 .option smtp_ratelimit_hosts main "host list&!!" unset
17190 .cindex "SMTP" "rate limiting"
17191 .cindex "limit" "rate of message arrival"
17192 .cindex "RCPT" "rate limiting"
17193 Some sites find it helpful to be able to limit the rate at which certain hosts
17194 can send them messages, and the rate at which an individual message can specify
17195 recipients.
17196
17197 Exim has two rate-limiting facilities. This section describes the older
17198 facility, which can limit rates within a single connection. The newer
17199 &%ratelimit%& ACL condition can limit rates across all connections. See section
17200 &<<SECTratelimiting>>& for details of the newer facility.
17201
17202 When a host matches &%smtp_ratelimit_hosts%&, the values of
17203 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17204 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17205 respectively. Each option, if set, must contain a set of four comma-separated
17206 values:
17207
17208 .ilist
17209 A threshold, before which there is no rate limiting.
17210 .next
17211 An initial time delay. Unlike other times in Exim, numbers with decimal
17212 fractional parts are allowed here.
17213 .next
17214 A factor by which to increase the delay each time.
17215 .next
17216 A maximum value for the delay. This should normally be less than 5 minutes,
17217 because after that time, the client is liable to timeout the SMTP command.
17218 .endlist
17219
17220 For example, these settings have been used successfully at the site which
17221 first suggested this feature, for controlling mail from their customers:
17222 .code
17223 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17224 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17225 .endd
17226 The first setting specifies delays that are applied to MAIL commands after
17227 two have been received over a single connection. The initial delay is 0.5
17228 seconds, increasing by a factor of 1.05 each time. The second setting applies
17229 delays to RCPT commands when more than four occur in a single message.
17230
17231
17232 .option smtp_ratelimit_mail main string unset
17233 See &%smtp_ratelimit_hosts%& above.
17234
17235
17236 .option smtp_ratelimit_rcpt main string unset
17237 See &%smtp_ratelimit_hosts%& above.
17238
17239
17240 .option smtp_receive_timeout main time&!! 5m
17241 .cindex "timeout" "for SMTP input"
17242 .cindex "SMTP" "input timeout"
17243 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17244 input, including batch SMTP. If a line of input (either an SMTP command or a
17245 data line) is not received within this time, the SMTP connection is dropped and
17246 the message is abandoned.
17247 A line is written to the log containing one of the following messages:
17248 .code
17249 SMTP command timeout on connection from...
17250 SMTP data timeout on connection from...
17251 .endd
17252 The former means that Exim was expecting to read an SMTP command; the latter
17253 means that it was in the DATA phase, reading the contents of a message.
17254
17255 If the first character of the option is a &"$"& the option is
17256 expanded before use and may depend on
17257 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17258
17259
17260 .oindex "&%-os%&"
17261 The value set by this option can be overridden by the
17262 &%-os%& command-line option. A setting of zero time disables the timeout, but
17263 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17264 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17265 timeout is controlled by &%receive_timeout%& and &%-or%&.
17266
17267
17268 .option smtp_reserve_hosts main "host list&!!" unset
17269 This option defines hosts for which SMTP connections are reserved; see
17270 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17271
17272
17273 .option smtp_return_error_details main boolean false
17274 .cindex "SMTP" "details policy failures"
17275 .cindex "policy control" "rejection, returning details"
17276 In the default state, Exim uses bland messages such as
17277 &"Administrative prohibition"& when it rejects SMTP commands for policy
17278 reasons. Many sysadmins like this because it gives away little information
17279 to spammers. However, some other sysadmins who are applying strict checking
17280 policies want to give out much fuller information about failures. Setting
17281 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17282 example, instead of &"Administrative prohibition"&, it might give:
17283 .code
17284 550-Rejected after DATA: '>' missing at end of address:
17285 550 failing address in "From" header is: <user@dom.ain
17286 .endd
17287
17288
17289 .option smtputf8_advertise_hosts main "host list&!!" *
17290 .cindex "SMTPUTF8" "advertising"
17291 When Exim is built with support for internationalised mail names,
17292 the availability thereof is advertised in
17293 response to EHLO only to those client hosts that match this option. See
17294 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17295
17296
17297 .option spamd_address main string "127.0.0.1 783"
17298 This option is available when Exim is compiled with the content-scanning
17299 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17300 See section &<<SECTscanspamass>>& for more details.
17301
17302
17303
17304 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17305 This option is available when Exim is compiled with SPF support.
17306 See section &<<SECSPF>>& for more details.
17307
17308
17309
17310 .option split_spool_directory main boolean false
17311 .cindex "multiple spool directories"
17312 .cindex "spool directory" "split"
17313 .cindex "directories, multiple"
17314 If this option is set, it causes Exim to split its input directory into 62
17315 subdirectories, each with a single alphanumeric character as its name. The
17316 sixth character of the message id is used to allocate messages to
17317 subdirectories; this is the least significant base-62 digit of the time of
17318 arrival of the message.
17319
17320 Splitting up the spool in this way may provide better performance on systems
17321 where there are long mail queues, by reducing the number of files in any one
17322 directory. The msglog directory is also split up in a similar way to the input
17323 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17324 are still placed in the single directory &_msglog.OLD_&.
17325
17326 It is not necessary to take any special action for existing messages when
17327 changing &%split_spool_directory%&. Exim notices messages that are in the
17328 &"wrong"& place, and continues to process them. If the option is turned off
17329 after a period of being on, the subdirectories will eventually empty and be
17330 automatically deleted.
17331
17332 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17333 changes. Instead of creating a list of all messages in the queue, and then
17334 trying to deliver each one, in turn, it constructs a list of those in one
17335 sub-directory and tries to deliver them, before moving on to the next
17336 sub-directory. The sub-directories are processed in a random order. This
17337 spreads out the scanning of the input directories, and uses less memory. It is
17338 particularly beneficial when there are lots of messages in the queue. However,
17339 if &%queue_run_in_order%& is set, none of this new processing happens. The
17340 entire queue has to be scanned and sorted before any deliveries can start.
17341
17342
17343 .option spool_directory main string&!! "set at compile time"
17344 .cindex "spool directory" "path to"
17345 This defines the directory in which Exim keeps its spool, that is, the messages
17346 it is waiting to deliver. The default value is taken from the compile-time
17347 configuration setting, if there is one. If not, this option must be set. The
17348 string is expanded, so it can contain, for example, a reference to
17349 &$primary_hostname$&.
17350
17351 If the spool directory name is fixed on your installation, it is recommended
17352 that you set it at build time rather than from this option, particularly if the
17353 log files are being written to the spool directory (see &%log_file_path%&).
17354 Otherwise log files cannot be used for errors that are detected early on, such
17355 as failures in the configuration file.
17356
17357 By using this option to override the compiled-in path, it is possible to run
17358 tests of Exim without using the standard spool.
17359
17360 .option spool_wireformat main boolean false
17361 .cindex "spool directory" "file formats"
17362 If this option is set, Exim may for some messages use an alternative format
17363 for data-files in the spool which matches the wire format.
17364 Doing this permits more efficient message reception and transmission.
17365 Currently it is only done for messages received using the ESMTP CHUNKING
17366 option.
17367
17368 The following variables will not have useful values:
17369 .code
17370 $max_received_linelength
17371 $body_linecount
17372 $body_zerocount
17373 .endd
17374
17375 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17376 and any external programs which are passed a reference to a message data file
17377 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17378 will need to be aware of the different formats potentially available.
17379
17380 Using any of the ACL conditions noted will negate the reception benefit
17381 (as a Unix-mbox-format file is constructed for them).
17382 The transmission benefit is maintained.
17383
17384 .option sqlite_lock_timeout main time 5s
17385 .cindex "sqlite lookup type" "lock timeout"
17386 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17387 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17388
17389 .option strict_acl_vars main boolean false
17390 .cindex "&ACL;" "variables, handling unset"
17391 This option controls what happens if a syntactically valid but undefined ACL
17392 variable is referenced. If it is false (the default), an empty string
17393 is substituted; if it is true, an error is generated. See section
17394 &<<SECTaclvariables>>& for details of ACL variables.
17395
17396 .option strip_excess_angle_brackets main boolean false
17397 .cindex "angle brackets, excess"
17398 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17399 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17400 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17401 passed on to another MTA, the excess angle brackets are not passed on. If this
17402 option is not set, multiple pairs of angle brackets cause a syntax error.
17403
17404
17405 .option strip_trailing_dot main boolean false
17406 .cindex "trailing dot on domain"
17407 .cindex "dot" "trailing on domain"
17408 If this option is set, a trailing dot at the end of a domain in an address is
17409 ignored. If this is in the envelope and the message is passed on to another
17410 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17411 domain causes a syntax error.
17412 However, addresses in header lines are checked only when an ACL requests header
17413 syntax checking.
17414
17415
17416 .option syslog_duplication main boolean true
17417 .cindex "syslog" "duplicate log lines; suppressing"
17418 When Exim is logging to syslog, it writes the log lines for its three
17419 separate logs at different syslog priorities so that they can in principle
17420 be separated on the logging hosts. Some installations do not require this
17421 separation, and in those cases, the duplication of certain log lines is a
17422 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17423 particular log line is written to syslog. For lines that normally go to
17424 both the main log and the reject log, the reject log version (possibly
17425 containing message header lines) is written, at LOG_NOTICE priority.
17426 Lines that normally go to both the main and the panic log are written at
17427 the LOG_ALERT priority.
17428
17429
17430 .option syslog_facility main string unset
17431 .cindex "syslog" "facility; setting"
17432 This option sets the syslog &"facility"& name, used when Exim is logging to
17433 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17434 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17435 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17436 details of Exim's logging.
17437
17438
17439 .option syslog_pid main boolean true
17440 .cindex "syslog" "pid"
17441 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17442 omitted when these lines are sent to syslog. (Syslog normally prefixes
17443 the log lines with the PID of the logging process automatically.) You need
17444 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17445 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17446
17447
17448
17449 .option syslog_processname main string &`exim`&
17450 .cindex "syslog" "process name; setting"
17451 This option sets the syslog &"ident"& name, used when Exim is logging to
17452 syslog. The value must be no longer than 32 characters. See chapter
17453 &<<CHAPlog>>& for details of Exim's logging.
17454
17455
17456
17457 .option syslog_timestamp main boolean true
17458 .cindex "syslog" "timestamps"
17459 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17460 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17461 details of Exim's logging.
17462
17463
17464 .option system_filter main string&!! unset
17465 .cindex "filter" "system filter"
17466 .cindex "system filter" "specifying"
17467 .cindex "Sieve filter" "not available for system filter"
17468 This option specifies an Exim filter file that is applied to all messages at
17469 the start of each delivery attempt, before any routing is done. System filters
17470 must be Exim filters; they cannot be Sieve filters. If the system filter
17471 generates any deliveries to files or pipes, or any new mail messages, the
17472 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17473 which transports are to be used. Details of this facility are given in chapter
17474 &<<CHAPsystemfilter>>&.
17475 A forced expansion failure results in no filter operation.
17476
17477
17478 .option system_filter_directory_transport main string&!! unset
17479 .vindex "&$address_file$&"
17480 This sets the name of the transport driver that is to be used when the
17481 &%save%& command in a system message filter specifies a path ending in &"/"&,
17482 implying delivery of each message into a separate file in some directory.
17483 During the delivery, the variable &$address_file$& contains the path name.
17484
17485
17486 .option system_filter_file_transport main string&!! unset
17487 .cindex "file" "transport for system filter"
17488 This sets the name of the transport driver that is to be used when the &%save%&
17489 command in a system message filter specifies a path not ending in &"/"&. During
17490 the delivery, the variable &$address_file$& contains the path name.
17491
17492 .option system_filter_group main string unset
17493 .cindex "gid (group id)" "system filter"
17494 This option is used only when &%system_filter_user%& is also set. It sets the
17495 gid under which the system filter is run, overriding any gid that is associated
17496 with the user. The value may be numerical or symbolic.
17497
17498 .option system_filter_pipe_transport main string&!! unset
17499 .cindex "&(pipe)& transport" "for system filter"
17500 .vindex "&$address_pipe$&"
17501 This specifies the transport driver that is to be used when a &%pipe%& command
17502 is used in a system filter. During the delivery, the variable &$address_pipe$&
17503 contains the pipe command.
17504
17505
17506 .option system_filter_reply_transport main string&!! unset
17507 .cindex "&(autoreply)& transport" "for system filter"
17508 This specifies the transport driver that is to be used when a &%mail%& command
17509 is used in a system filter.
17510
17511
17512 .option system_filter_user main string unset
17513 .cindex "uid (user id)" "system filter"
17514 If this option is set to root, the system filter is run in the main Exim
17515 delivery process, as root.  Otherwise, the system filter runs in a separate
17516 process, as the given user, defaulting to the Exim run-time user.
17517 Unless the string consists entirely of digits, it
17518 is looked up in the password data. Failure to find the named user causes a
17519 configuration error. The gid is either taken from the password data, or
17520 specified by &%system_filter_group%&. When the uid is specified numerically,
17521 &%system_filter_group%& is required to be set.
17522
17523 If the system filter generates any pipe, file, or reply deliveries, the uid
17524 under which the filter is run is used when transporting them, unless a
17525 transport option overrides.
17526
17527
17528 .option tcp_nodelay main boolean true
17529 .cindex "daemon" "TCP_NODELAY on sockets"
17530 .cindex "Nagle algorithm"
17531 .cindex "TCP_NODELAY on listening sockets"
17532 If this option is set false, it stops the Exim daemon setting the
17533 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17534 turns off the &"Nagle algorithm"&, which is a way of improving network
17535 performance in interactive (character-by-character) situations. Turning it off
17536 should improve Exim's performance a bit, so that is what happens by default.
17537 However, it appears that some broken clients cannot cope, and time out. Hence
17538 this option. It affects only those sockets that are set up for listening by the
17539 daemon. Sockets created by the smtp transport for delivering mail always set
17540 TCP_NODELAY.
17541
17542
17543 .option timeout_frozen_after main time 0s
17544 .cindex "frozen messages" "timing out"
17545 .cindex "timeout" "frozen messages"
17546 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17547 message of any kind that has been in the queue for longer than the given time
17548 is automatically cancelled at the next queue run. If the frozen message is a
17549 bounce message, it is just discarded; otherwise, a bounce is sent to the
17550 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17551 If you want to timeout frozen bounce messages earlier than other kinds of
17552 frozen message, see &%ignore_bounce_errors_after%&.
17553
17554 &*Note:*& the default value of zero means no timeouts; with this setting,
17555 frozen messages remain in the queue forever (except for any frozen bounce
17556 messages that are released by &%ignore_bounce_errors_after%&).
17557
17558
17559 .option timezone main string unset
17560 .cindex "timezone, setting"
17561 .cindex "environment" "values from"
17562 The value of &%timezone%& is used to set the environment variable TZ while
17563 running Exim (if it is different on entry). This ensures that all timestamps
17564 created by Exim are in the required timezone. If you want all your timestamps
17565 to be in UTC (aka GMT) you should set
17566 .code
17567 timezone = UTC
17568 .endd
17569 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17570 or, if that is not set, from the value of the TZ environment variable when Exim
17571 is built. If &%timezone%& is set to the empty string, either at build or run
17572 time, any existing TZ variable is removed from the environment when Exim
17573 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17574 unfortunately not all, operating systems.
17575
17576
17577 .option tls_advertise_hosts main "host list&!!" *
17578 .cindex "TLS" "advertising"
17579 .cindex "encryption" "on SMTP connection"
17580 .cindex "SMTP" "encrypted connection"
17581 When Exim is built with support for TLS encrypted connections, the availability
17582 of the STARTTLS command to set up an encrypted session is advertised in
17583 response to EHLO only to those client hosts that match this option. See
17584 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17585 Note that the default value requires that a certificate be supplied
17586 using the &%tls_certificate%& option.  If TLS support for incoming connections
17587 is not required the &%tls_advertise_hosts%& option should be set empty.
17588
17589
17590 .option tls_certificate main string list&!! unset
17591 .cindex "TLS" "server certificate; location of"
17592 .cindex "certificate" "server, location of"
17593 The value of this option is expanded, and must then be a list of absolute paths to
17594 files which contains the server's certificates.  Commonly only one file is
17595 needed.
17596 The server's private key is also
17597 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17598 &<<CHAPTLS>>& for further details.
17599
17600 &*Note*&: The certificates defined by this option are used only when Exim is
17601 receiving incoming messages as a server. If you want to supply certificates for
17602 use when sending messages as a client, you must set the &%tls_certificate%&
17603 option in the relevant &(smtp)& transport.
17604
17605 &*Note*&: If you use filenames based on IP addresses, change the list
17606 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17607
17608 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17609 when a list of more than one
17610 file is used, the &$tls_in_ourcert$& variable is unreliable.
17611
17612 &*Note*&: OCSP stapling is not usable under OpenSSL
17613 when a list of more than one file is used.
17614
17615 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17616 if the OpenSSL build supports TLS extensions and the TLS client sends the
17617 Server Name Indication extension, then this option and others documented in
17618 &<<SECTtlssni>>& will be re-expanded.
17619
17620 If this option is unset or empty a fresh self-signed certificate will be
17621 generated for every connection.
17622
17623 .option tls_crl main string&!! unset
17624 .cindex "TLS" "server certificate revocation list"
17625 .cindex "certificate" "revocation list for server"
17626 This option specifies a certificate revocation list. The expanded value must
17627 be the name of a file that contains CRLs in PEM format.
17628
17629 Under OpenSSL the option can specify a directory with CRL files.
17630
17631 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17632 for each signing element of the certificate chain (i.e. all but the leaf).
17633 For the file variant this can be multiple PEM blocks in the one file.
17634
17635 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17636
17637
17638 .option tls_dh_max_bits main integer 2236
17639 .cindex "TLS" "D-H bit count"
17640 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17641 the chosen TLS library.  That value might prove to be too high for
17642 interoperability.  This option provides a maximum clamp on the value
17643 suggested, trading off security for interoperability.
17644
17645 The value must be at least 1024.
17646
17647 The value 2236 was chosen because, at time of adding the option, it was the
17648 hard-coded maximum value supported by the NSS cryptographic library, as used
17649 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17650
17651 If you prefer more security and are willing to break some clients, raise this
17652 number.
17653
17654 Note that the value passed to GnuTLS for *generating* a new prime may be a
17655 little less than this figure, because GnuTLS is inexact and may produce a
17656 larger prime than requested.
17657
17658
17659 .option tls_dhparam main string&!! unset
17660 .cindex "TLS" "D-H parameters for server"
17661 The value of this option is expanded and indicates the source of DH parameters
17662 to be used by Exim.
17663
17664 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17665 local DH parameters*&, which has been supported across all versions of Exim.  The
17666 other specific constants available are a fallback so that even when
17667 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17668
17669 If &%tls_dhparam%& is a filename starting with a &`/`&,
17670 then it names a file from which DH
17671 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17672 PKCS#3 representation of the DH prime.  If the file does not exist, for
17673 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17674 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17675 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17676 and treated as though the &%tls_dhparam%& were set to "none".
17677
17678 If this option expands to the string "none", then no DH parameters will be
17679 loaded by Exim.
17680
17681 If this option expands to the string "historic" and Exim is using GnuTLS, then
17682 Exim will attempt to load a file from inside the spool directory.  If the file
17683 does not exist, Exim will attempt to create it.
17684 See section &<<SECTgnutlsparam>>& for further details.
17685
17686 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17687 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17688
17689 In older versions of Exim the default was the 2048 bit prime described in section
17690 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17691 in IKE is assigned number 23.
17692
17693 Otherwise, the option must expand to the name used by Exim for any of a number
17694 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17695 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17696 the number used by IKE, or "default" which corresponds to
17697 &`exim.dev.20160529.3`&.
17698
17699 The available standard primes are:
17700 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17701 &`ike1`&, &`ike2`&, &`ike5`&,
17702 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17703 &`ike22`&, &`ike23`& and &`ike24`&.
17704
17705 The available additional primes are:
17706 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17707
17708 Some of these will be too small to be accepted by clients.
17709 Some may be too large to be accepted by clients.
17710 The open cryptographic community has suspicions about the integrity of some
17711 of the later IKE values, which led into RFC7919 providing new fixed constants
17712 (the "ffdhe" identifiers).
17713
17714 At this point, all of the "ike" values should be considered obsolete;
17715 they're still in Exim to avoid breaking unusual configurations, but are
17716 candidates for removal the next time we have backwards-incompatible changes.
17717
17718 The TLS protocol does not negotiate an acceptable size for this; clients tend
17719 to hard-drop connections if what is offered by the server is unacceptable,
17720 whether too large or too small, and there's no provision for the client to
17721 tell the server what these constraints are.  Thus, as a server operator, you
17722 need to make an educated guess as to what is most likely to work for your
17723 userbase.
17724
17725 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17726 is most likely to maximise interoperability.  The upper bound comes from
17727 applications using the Mozilla Network Security Services (NSS) library, which
17728 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17729 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17730 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17731 acceptable bound from 1024 to 2048.
17732
17733
17734 .option tls_eccurve main string&!! &`auto`&
17735 .cindex TLS "EC cryptography"
17736 This option selects a EC curve for use by Exim when used with OpenSSL.
17737 It has no effect when Exim is used with GnuTLS.
17738
17739 After expansion it must contain a valid EC curve parameter, such as
17740 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17741 for valid selections.
17742
17743 For OpenSSL versions before (and not including) 1.0.2, the string
17744 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17745 &`auto`& tells the library to choose.
17746
17747 If the option expands to an empty string, no EC curves will be enabled.
17748
17749
17750 .option tls_ocsp_file main string&!! unset
17751 .cindex TLS "certificate status"
17752 .cindex TLS "OCSP proof file"
17753 This option
17754 must if set expand to the absolute path to a file which contains a current
17755 status proof for the server's certificate, as obtained from the
17756 Certificate Authority.
17757
17758 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17759
17760 For GnuTLS 3.5.6 or later the expanded value of this option can be a list
17761 of files, to match a list given for the &%tls_certificate%& option.
17762 The ordering of the two lists must match.
17763
17764
17765 .option tls_on_connect_ports main "string list" unset
17766 .cindex SSMTP
17767 .cindex SMTPS
17768 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17769 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17770 set up without waiting for the client to issue a STARTTLS command. For
17771 further details, see section &<<SECTsupobssmt>>&.
17772
17773
17774
17775 .option tls_privatekey main string list&!! unset
17776 .cindex "TLS" "server private key; location of"
17777 The value of this option is expanded, and must then be a list of absolute paths to
17778 files which contains the server's private keys.
17779 If this option is unset, or if
17780 the expansion is forced to fail, or the result is an empty string, the private
17781 key is assumed to be in the same file as the server's certificates. See chapter
17782 &<<CHAPTLS>>& for further details.
17783
17784 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17785
17786
17787 .option tls_remember_esmtp main boolean false
17788 .cindex "TLS" "esmtp state; remembering"
17789 .cindex "TLS" "broken clients"
17790 If this option is set true, Exim violates the RFCs by remembering that it is in
17791 &"esmtp"& state after successfully negotiating a TLS session. This provides
17792 support for broken clients that fail to send a new EHLO after starting a
17793 TLS session.
17794
17795
17796 .option tls_require_ciphers main string&!! unset
17797 .cindex "TLS" "requiring specific ciphers"
17798 .cindex "cipher" "requiring specific"
17799 This option controls which ciphers can be used for incoming TLS connections.
17800 The &(smtp)& transport has an option of the same name for controlling outgoing
17801 connections. This option is expanded for each connection, so can be varied for
17802 different clients if required. The value of this option must be a list of
17803 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17804 in somewhat different ways. If GnuTLS is being used, the client controls the
17805 preference order of the available ciphers. Details are given in sections
17806 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17807
17808
17809 .option tls_try_verify_hosts main "host list&!!" unset
17810 .cindex "TLS" "client certificate verification"
17811 .cindex "certificate" "verification of client"
17812 See &%tls_verify_hosts%& below.
17813
17814
17815 .option tls_verify_certificates main string&!! system
17816 .cindex "TLS" "client certificate verification"
17817 .cindex "certificate" "verification of client"
17818 The value of this option is expanded, and must then be either the
17819 word "system"
17820 or the absolute path to
17821 a file or directory containing permitted certificates for clients that
17822 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17823
17824 The "system" value for the option will use a
17825 system default location compiled into the SSL library.
17826 This is not available for GnuTLS versions preceding 3.0.20,
17827 and will be taken as empty; an explicit location
17828 must be specified.
17829
17830 The use of a directory for the option value is not available for GnuTLS versions
17831 preceding 3.3.6 and a single file must be used.
17832
17833 With OpenSSL the certificates specified
17834 explicitly
17835 either by file or directory
17836 are added to those given by the system default location.
17837
17838 These certificates should be for the certificate authorities trusted, rather
17839 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17840 the value is a file then the certificates are sent by Exim as a server to
17841 connecting clients, defining the list of accepted certificate authorities.
17842 Thus the values defined should be considered public data.  To avoid this,
17843 use the explicit directory version.
17844
17845 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17846
17847 A forced expansion failure or setting to an empty string is equivalent to
17848 being unset.
17849
17850
17851 .option tls_verify_hosts main "host list&!!" unset
17852 .cindex "TLS" "client certificate verification"
17853 .cindex "certificate" "verification of client"
17854 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17855 certificates from clients. The expected certificates are defined by
17856 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17857 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17858 &%tls_verify_certificates%& is not set.
17859
17860 Any client that matches &%tls_verify_hosts%& is constrained by
17861 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17862 present one of the listed certificates. If it does not, the connection is
17863 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17864 the host to use TLS. It can still send SMTP commands through unencrypted
17865 connections. Forcing a client to use TLS has to be done separately using an
17866 ACL to reject inappropriate commands when the connection is not encrypted.
17867
17868 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17869 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17870 certificate and checks it against &%tls_verify_certificates%&, but does not
17871 abort the connection if there is no certificate or if it does not match. This
17872 state can be detected in an ACL, which makes it possible to implement policies
17873 such as &"accept for relay only if a verified certificate has been received,
17874 but accept for local delivery if encrypted, even without a verified
17875 certificate"&.
17876
17877 Client hosts that match neither of these lists are not asked to present
17878 certificates.
17879
17880
17881 .option trusted_groups main "string list&!!" unset
17882 .cindex "trusted groups"
17883 .cindex "groups" "trusted"
17884 This option is expanded just once, at the start of Exim's processing. If this
17885 option is set, any process that is running in one of the listed groups, or
17886 which has one of them as a supplementary group, is trusted. The groups can be
17887 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17888 details of what trusted callers are permitted to do. If neither
17889 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17890 are trusted.
17891
17892 .option trusted_users main "string list&!!" unset
17893 .cindex "trusted users"
17894 .cindex "user" "trusted"
17895 This option is expanded just once, at the start of Exim's processing. If this
17896 option is set, any process that is running as one of the listed users is
17897 trusted. The users can be specified numerically or by name. See section
17898 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17899 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17900 Exim user are trusted.
17901
17902 .option unknown_login main string&!! unset
17903 .cindex "uid (user id)" "unknown caller"
17904 .vindex "&$caller_uid$&"
17905 This is a specialized feature for use in unusual configurations. By default, if
17906 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17907 gives up. The &%unknown_login%& option can be used to set a login name to be
17908 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17909 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17910 is used for the user's real name (gecos field), unless this has been set by the
17911 &%-F%& option.
17912
17913 .option unknown_username main string unset
17914 See &%unknown_login%&.
17915
17916 .option untrusted_set_sender main "address list&!!" unset
17917 .cindex "trusted users"
17918 .cindex "sender" "setting by untrusted user"
17919 .cindex "untrusted user setting sender"
17920 .cindex "user" "untrusted setting sender"
17921 .cindex "envelope sender"
17922 When an untrusted user submits a message to Exim using the standard input, Exim
17923 normally creates an envelope sender address from the user's login and the
17924 default qualification domain. Data from the &%-f%& option (for setting envelope
17925 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17926 is used) is ignored.
17927
17928 However, untrusted users are permitted to set an empty envelope sender address,
17929 to declare that a message should never generate any bounces. For example:
17930 .code
17931 exim -f '<>' user@domain.example
17932 .endd
17933 .vindex "&$sender_ident$&"
17934 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17935 other envelope sender addresses in a controlled way. When it is set, untrusted
17936 users are allowed to set envelope sender addresses that match any of the
17937 patterns in the list. Like all address lists, the string is expanded. The
17938 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17939 users to setting senders that start with their login ids
17940 followed by a hyphen
17941 by a setting like this:
17942 .code
17943 untrusted_set_sender = ^$sender_ident-
17944 .endd
17945 If you want to allow untrusted users to set envelope sender addresses without
17946 restriction, you can use
17947 .code
17948 untrusted_set_sender = *
17949 .endd
17950 The &%untrusted_set_sender%& option applies to all forms of local input, but
17951 only to the setting of the envelope sender. It does not permit untrusted users
17952 to use the other options which trusted user can use to override message
17953 parameters. Furthermore, it does not stop Exim from removing an existing
17954 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17955 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17956 overriding these actions. The handling of the &'Sender:'& header is also
17957 described in section &<<SECTthesenhea>>&.
17958
17959 The log line for a message's arrival shows the envelope sender following
17960 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17961 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17962 envelope sender address, the user's login is shown in parentheses after the
17963 sender address.
17964
17965
17966 .option uucp_from_pattern main string "see below"
17967 .cindex "&""From""& line"
17968 .cindex "UUCP" "&""From""& line"
17969 Some applications that pass messages to an MTA via a command line interface use
17970 an initial line starting with &"From&~"& to pass the envelope sender. In
17971 particular, this is used by UUCP software. Exim recognizes such a line by means
17972 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17973 matches, the sender address is constructed by expanding the contents of
17974 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17975 default pattern recognizes lines in the following two forms:
17976 .code
17977 From ph10 Fri Jan  5 12:35 GMT 1996
17978 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17979 .endd
17980 The pattern can be seen by running
17981 .code
17982 exim -bP uucp_from_pattern
17983 .endd
17984 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17985 year in the second case. The first word after &"From&~"& is matched in the
17986 regular expression by a parenthesized subpattern. The default value for
17987 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17988 (&"ph10"& in the example above) as the message's sender. See also
17989 &%ignore_fromline_hosts%&.
17990
17991
17992 .option uucp_from_sender main string&!! &`$1`&
17993 See &%uucp_from_pattern%& above.
17994
17995
17996 .option warn_message_file main string unset
17997 .cindex "warning of delay" "customizing the message"
17998 .cindex "customizing" "warning message"
17999 This option defines a template file containing paragraphs of text to be used
18000 for constructing the warning message which is sent by Exim when a message has
18001 been in the queue for a specified amount of time, as specified by
18002 &%delay_warning%&. Details of the file's contents are given in chapter
18003 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18004
18005
18006 .option write_rejectlog main boolean true
18007 .cindex "reject log" "disabling"
18008 If this option is set false, Exim no longer writes anything to the reject log.
18009 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18010 .ecindex IIDconfima
18011 .ecindex IIDmaiconf
18012
18013
18014
18015
18016 . ////////////////////////////////////////////////////////////////////////////
18017 . ////////////////////////////////////////////////////////////////////////////
18018
18019 .chapter "Generic options for routers" "CHAProutergeneric"
18020 .scindex IIDgenoprou1 "options" "generic; for routers"
18021 .scindex IIDgenoprou2 "generic options" "router"
18022 This chapter describes the generic options that apply to all routers.
18023 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18024
18025 For a general description of how a router operates, see sections
18026 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18027 which the preconditions are tested. The order of expansion of the options that
18028 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18029 &%headers_remove%&, &%transport%&.
18030
18031
18032
18033 .option address_data routers string&!! unset
18034 .cindex "router" "data attached to address"
18035 The string is expanded just before the router is run, that is, after all the
18036 precondition tests have succeeded. If the expansion is forced to fail, the
18037 router declines, the value of &%address_data%& remains unchanged, and the
18038 &%more%& option controls what happens next. Other expansion failures cause
18039 delivery of the address to be deferred.
18040
18041 .vindex "&$address_data$&"
18042 When the expansion succeeds, the value is retained with the address, and can be
18043 accessed using the variable &$address_data$& in the current router, subsequent
18044 routers, and the eventual transport.
18045
18046 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18047 that runs a user's filter file, the contents of &$address_data$& are accessible
18048 in the filter. This is not normally a problem, because such data is usually
18049 either not confidential or it &"belongs"& to the current user, but if you do
18050 put confidential data into &$address_data$& you need to remember this point.
18051
18052 Even if the router declines or passes, the value of &$address_data$& remains
18053 with the address, though it can be changed by another &%address_data%& setting
18054 on a subsequent router. If a router generates child addresses, the value of
18055 &$address_data$& propagates to them. This also applies to the special kind of
18056 &"child"& that is generated by a router with the &%unseen%& option.
18057
18058 The idea of &%address_data%& is that you can use it to look up a lot of data
18059 for the address once, and then pick out parts of the data later. For example,
18060 you could use a single LDAP lookup to return a string of the form
18061 .code
18062 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18063 .endd
18064 In the transport you could pick out the mailbox by a setting such as
18065 .code
18066 file = ${extract{mailbox}{$address_data}}
18067 .endd
18068 This makes the configuration file less messy, and also reduces the number of
18069 lookups (though Exim does cache lookups).
18070
18071 .vindex "&$sender_address_data$&"
18072 .vindex "&$address_data$&"
18073 The &%address_data%& facility is also useful as a means of passing information
18074 from one router to another, and from a router to a transport. In addition, if
18075 &$address_data$& is set by a router when verifying a recipient address from an
18076 ACL, it remains available for use in the rest of the ACL statement. After
18077 verifying a sender, the value is transferred to &$sender_address_data$&.
18078
18079
18080
18081 .option address_test routers&!? boolean true
18082 .oindex "&%-bt%&"
18083 .cindex "router" "skipping when address testing"
18084 If this option is set false, the router is skipped when routing is being tested
18085 by means of the &%-bt%& command line option. This can be a convenience when
18086 your first router sends messages to an external scanner, because it saves you
18087 having to set the &"already scanned"& indicator when testing real address
18088 routing.
18089
18090
18091
18092 .option cannot_route_message routers string&!! unset
18093 .cindex "router" "customizing &""cannot route""& message"
18094 .cindex "customizing" "&""cannot route""& message"
18095 This option specifies a text message that is used when an address cannot be
18096 routed because Exim has run out of routers. The default message is
18097 &"Unrouteable address"&. This option is useful only on routers that have
18098 &%more%& set false, or on the very last router in a configuration, because the
18099 value that is used is taken from the last router that is considered. This
18100 includes a router that is skipped because its preconditions are not met, as
18101 well as a router that declines. For example, using the default configuration,
18102 you could put:
18103 .code
18104 cannot_route_message = Remote domain not found in DNS
18105 .endd
18106 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18107 and
18108 .code
18109 cannot_route_message = Unknown local user
18110 .endd
18111 on the final router that checks for local users. If string expansion fails for
18112 this option, the default message is used. Unless the expansion failure was
18113 explicitly forced, a message about the failure is written to the main and panic
18114 logs, in addition to the normal message about the routing failure.
18115
18116
18117 .option caseful_local_part routers boolean false
18118 .cindex "case of local parts"
18119 .cindex "router" "case of local parts"
18120 By default, routers handle the local parts of addresses in a case-insensitive
18121 manner, though the actual case is preserved for transmission with the message.
18122 If you want the case of letters to be significant in a router, you must set
18123 this option true. For individual router options that contain address or local
18124 part lists (for example, &%local_parts%&), case-sensitive matching can be
18125 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18126 more details.
18127
18128 .vindex "&$local_part$&"
18129 .vindex "&$original_local_part$&"
18130 .vindex "&$parent_local_part$&"
18131 The value of the &$local_part$& variable is forced to lower case while a
18132 router is running unless &%caseful_local_part%& is set. When a router assigns
18133 an address to a transport, the value of &$local_part$& when the transport runs
18134 is the same as it was in the router. Similarly, when a router generates child
18135 addresses by aliasing or forwarding, the values of &$original_local_part$&
18136 and &$parent_local_part$& are those that were used by the redirecting router.
18137
18138 This option applies to the processing of an address by a router. When a
18139 recipient address is being processed in an ACL, there is a separate &%control%&
18140 modifier that can be used to specify case-sensitive processing within the ACL
18141 (see section &<<SECTcontrols>>&).
18142
18143
18144
18145 .option check_local_user routers&!? boolean false
18146 .cindex "local user, checking in router"
18147 .cindex "router" "checking for local user"
18148 .cindex "&_/etc/passwd_&"
18149 .vindex "&$home$&"
18150 When this option is true, Exim checks that the local part of the recipient
18151 address (with affixes removed if relevant) is the name of an account on the
18152 local system. The check is done by calling the &[getpwnam()]& function rather
18153 than trying to read &_/etc/passwd_& directly. This means that other methods of
18154 holding password data (such as NIS) are supported. If the local part is a local
18155 user, &$home$& is set from the password data, and can be tested in other
18156 preconditions that are evaluated after this one (the order of evaluation is
18157 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18158 overridden by &%router_home_directory%&. If the local part is not a local user,
18159 the router is skipped.
18160
18161 If you want to check that the local part is either the name of a local user
18162 or matches something else, you cannot combine &%check_local_user%& with a
18163 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18164 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18165 setting to achieve this. For example:
18166 .code
18167 local_parts = passwd;$local_part : lsearch;/etc/other/users
18168 .endd
18169 Note, however, that the side effects of &%check_local_user%& (such as setting
18170 up a home directory) do not occur when a &(passwd)& lookup is used in a
18171 &%local_parts%& (or any other) precondition.
18172
18173
18174
18175 .option condition routers&!? string&!! unset
18176 .cindex "router" "customized precondition"
18177 This option specifies a general precondition test that has to succeed for the
18178 router to be called. The &%condition%& option is the last precondition to be
18179 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18180 result is a forced failure, or an empty string, or one of the strings &"0"& or
18181 &"no"& or &"false"& (checked without regard to the case of the letters), the
18182 router is skipped, and the address is offered to the next one.
18183
18184 If the result is any other value, the router is run (as this is the last
18185 precondition to be evaluated, all the other preconditions must be true).
18186
18187 This option is unusual in that multiple &%condition%& options may be present.
18188 All &%condition%& options must succeed.
18189
18190 The &%condition%& option provides a means of applying custom conditions to the
18191 running of routers. Note that in the case of a simple conditional expansion,
18192 the default expansion values are exactly what is wanted. For example:
18193 .code
18194 condition = ${if >{$message_age}{600}}
18195 .endd
18196 Because of the default behaviour of the string expansion, this is equivalent to
18197 .code
18198 condition = ${if >{$message_age}{600}{true}{}}
18199 .endd
18200
18201 A multiple condition example, which succeeds:
18202 .code
18203 condition = ${if >{$message_age}{600}}
18204 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18205 condition = foobar
18206 .endd
18207
18208 If the expansion fails (other than forced failure) delivery is deferred. Some
18209 of the other precondition options are common special cases that could in fact
18210 be specified using &%condition%&.
18211
18212 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18213 are far older, and use one set of semantics.  ACLs are newer and when
18214 they were created, the ACL &%condition%& process was given far stricter
18215 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18216 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18217 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18218 Router rules processing behavior.
18219
18220 This is best illustrated in an example:
18221 .code
18222 # If used in an ACL condition will fail with a syntax error, but
18223 # in a router condition any extra characters are treated as a string
18224
18225 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18226 true {yes} {no}}
18227
18228 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18229  {yes} {no}}
18230 .endd
18231 In each example above, the &%if%& statement actually ends after
18232 &"{google.com}}"&.  Since no true or false braces were defined, the
18233 default &%if%& behavior is to return a boolean true or a null answer
18234 (which evaluates to false). The rest of the line is then treated as a
18235 string. So the first example resulted in the boolean answer &"true"&
18236 with the string &" {yes} {no}}"& appended to it. The second example
18237 resulted in the null output (indicating false) with the string
18238 &" {yes} {no}}"& appended to it.
18239
18240 In fact you can put excess forward braces in too.  In the router
18241 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18242 mean something, like after a &"$"& or when required as part of a
18243 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18244 string characters.
18245
18246 Thus, in a Router, the above expansion strings will both always evaluate
18247 true, as the result of expansion is a non-empty string which doesn't
18248 match an explicit false value.  This can be tricky to debug.  By
18249 contrast, in an ACL either of those strings will always result in an
18250 expansion error because the result doesn't look sufficiently boolean.
18251
18252
18253 .option debug_print routers string&!! unset
18254 .cindex "testing" "variables in drivers"
18255 If this option is set and debugging is enabled (see the &%-d%& command line
18256 option) or in address-testing mode (see the &%-bt%& command line option),
18257 the string is expanded and included in the debugging output.
18258 If expansion of the string fails, the error message is written to the debugging
18259 output, and Exim carries on processing.
18260 This option is provided to help with checking out the values of variables and
18261 so on when debugging router configurations. For example, if a &%condition%&
18262 option appears not to be working, &%debug_print%& can be used to output the
18263 variables it references. The output happens after checks for &%domains%&,
18264 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18265 are tested. A newline is added to the text if it does not end with one.
18266 The variable &$router_name$& contains the name of the router.
18267
18268
18269
18270 .option disable_logging routers boolean false
18271 If this option is set true, nothing is logged for any routing errors
18272 or for any deliveries caused by this router. You should not set this option
18273 unless you really, really know what you are doing. See also the generic
18274 transport option of the same name.
18275
18276 .option dnssec_request_domains routers "domain list&!!" unset
18277 .cindex "MX record" "security"
18278 .cindex "DNSSEC" "MX lookup"
18279 .cindex "security" "MX lookup"
18280 .cindex "DNS" "DNSSEC"
18281 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18282 the dnssec request bit set.
18283 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18284
18285 .option dnssec_require_domains routers "domain list&!!" unset
18286 .cindex "MX record" "security"
18287 .cindex "DNSSEC" "MX lookup"
18288 .cindex "security" "MX lookup"
18289 .cindex "DNS" "DNSSEC"
18290 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18291 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18292 (AD bit) set will be ignored and logged as a host-lookup failure.
18293 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18294
18295
18296 .option domains routers&!? "domain list&!!" unset
18297 .cindex "router" "restricting to specific domains"
18298 .vindex "&$domain_data$&"
18299 If this option is set, the router is skipped unless the current domain matches
18300 the list. If the match is achieved by means of a file lookup, the data that the
18301 lookup returned for the domain is placed in &$domain_data$& for use in string
18302 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18303 a list of the order in which preconditions are evaluated.
18304
18305
18306
18307 .option driver routers string unset
18308 This option must always be set. It specifies which of the available routers is
18309 to be used.
18310
18311
18312 .option dsn_lasthop routers boolean false
18313 .cindex "DSN" "success"
18314 .cindex "Delivery Status Notification" "success"
18315 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18316 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18317 instead send a success DSN as if the next hop does not support DSN.
18318 Not effective on redirect routers.
18319
18320
18321
18322 .option errors_to routers string&!! unset
18323 .cindex "envelope sender"
18324 .cindex "router" "changing address for errors"
18325 If a router successfully handles an address, it may assign the address to a
18326 transport for delivery or it may generate child addresses. In both cases, if
18327 there is a delivery problem during later processing, the resulting bounce
18328 message is sent to the address that results from expanding this string,
18329 provided that the address verifies successfully. The &%errors_to%& option is
18330 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18331
18332 The &%errors_to%& setting associated with an address can be overridden if it
18333 subsequently passes through other routers that have their own &%errors_to%&
18334 settings, or if the message is delivered by a transport with a &%return_path%&
18335 setting.
18336
18337 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18338 the expansion fails to verify, the errors address associated with the incoming
18339 address is used. At top level, this is the envelope sender. A non-forced
18340 expansion failure causes delivery to be deferred.
18341
18342 If an address for which &%errors_to%& has been set ends up being delivered over
18343 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18344 any bounces that are generated by other MTAs on the delivery route are also
18345 sent there. You can set &%errors_to%& to the empty string by either of these
18346 settings:
18347 .code
18348 errors_to =
18349 errors_to = ""
18350 .endd
18351 An expansion item that yields an empty string has the same effect. If you do
18352 this, a locally detected delivery error for addresses processed by this router
18353 no longer gives rise to a bounce message; the error is discarded. If the
18354 address is delivered to a remote host, the return path is set to &`<>`&, unless
18355 overridden by the &%return_path%& option on the transport.
18356
18357 .vindex "&$address_data$&"
18358 If for some reason you want to discard local errors, but use a non-empty
18359 MAIL command for remote delivery, you can preserve the original return
18360 path in &$address_data$& in the router, and reinstate it in the transport by
18361 setting &%return_path%&.
18362
18363 The most common use of &%errors_to%& is to direct mailing list bounces to the
18364 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18365 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18366
18367
18368
18369 .option expn routers&!? boolean true
18370 .cindex "address" "testing"
18371 .cindex "testing" "addresses"
18372 .cindex "EXPN" "router skipping"
18373 .cindex "router" "skipping for EXPN"
18374 If this option is turned off, the router is skipped when testing an address
18375 as a result of processing an SMTP EXPN command. You might, for example,
18376 want to turn it off on a router for users' &_.forward_& files, while leaving it
18377 on for the system alias file.
18378 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18379 are evaluated.
18380
18381 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18382 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18383 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18384
18385
18386
18387 .option fail_verify routers boolean false
18388 .cindex "router" "forcing verification failure"
18389 Setting this option has the effect of setting both &%fail_verify_sender%& and
18390 &%fail_verify_recipient%& to the same value.
18391
18392
18393
18394 .option fail_verify_recipient routers boolean false
18395 If this option is true and an address is accepted by this router when
18396 verifying a recipient, verification fails.
18397
18398
18399
18400 .option fail_verify_sender routers boolean false
18401 If this option is true and an address is accepted by this router when
18402 verifying a sender, verification fails.
18403
18404
18405
18406 .option fallback_hosts routers "string list" unset
18407 .cindex "router" "fallback hosts"
18408 .cindex "fallback" "hosts specified on router"
18409 String expansion is not applied to this option. The argument must be a
18410 colon-separated list of host names or IP addresses. The list separator can be
18411 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18412 each name or address. In fact, the format of each item is exactly the same as
18413 defined for the list of hosts in a &(manualroute)& router (see section
18414 &<<SECTformatonehostitem>>&).
18415
18416 If a router queues an address for a remote transport, this host list is
18417 associated with the address, and used instead of the transport's fallback host
18418 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18419 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18420 transport for further details.
18421
18422
18423 .option group routers string&!! "see below"
18424 .cindex "gid (group id)" "local delivery"
18425 .cindex "local transports" "uid and gid"
18426 .cindex "transport" "local"
18427 .cindex "router" "setting group"
18428 When a router queues an address for a transport, and the transport does not
18429 specify a group, the group given here is used when running the delivery
18430 process.
18431 The group may be specified numerically or by name. If expansion fails, the
18432 error is logged and delivery is deferred.
18433 The default is unset, unless &%check_local_user%& is set, when the default
18434 is taken from the password information. See also &%initgroups%& and &%user%&
18435 and the discussion in chapter &<<CHAPenvironment>>&.
18436
18437
18438
18439 .option headers_add routers list&!! unset
18440 .cindex "header lines" "adding"
18441 .cindex "router" "adding header lines"
18442 This option specifies a list of text headers,
18443 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18444 that is associated with any addresses that are accepted by the router.
18445 Each item is separately expanded, at routing time.  However, this
18446 option has no effect when an address is just being verified. The way in which
18447 the text is used to add header lines at transport time is described in section
18448 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18449 message is in the process of being transported. This means that references to
18450 header lines in string expansions in the transport's configuration do not
18451 &"see"& the added header lines.
18452
18453 The &%headers_add%& option is expanded after &%errors_to%&, but before
18454 &%headers_remove%& and &%transport%&. If an item is empty, or if
18455 an item expansion is forced to fail, the item has no effect. Other expansion
18456 failures are treated as configuration errors.
18457
18458 Unlike most options, &%headers_add%& can be specified multiple times
18459 for a router; all listed headers are added.
18460
18461 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18462 router that has the &%one_time%& option set.
18463
18464 .cindex "duplicate addresses"
18465 .oindex "&%unseen%&"
18466 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18467 additions are deleted when the address is passed on to subsequent routers.
18468 For a &%redirect%& router, if a generated address is the same as the incoming
18469 address, this can lead to duplicate addresses with different header
18470 modifications. Exim does not do duplicate deliveries (except, in certain
18471 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18472 which of the duplicates is discarded, so this ambiguous situation should be
18473 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18474
18475
18476
18477 .option headers_remove routers list&!! unset
18478 .cindex "header lines" "removing"
18479 .cindex "router" "removing header lines"
18480 This option specifies a list of text headers,
18481 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18482 that is associated with any addresses that are accepted by the router.
18483 Each item is separately expanded, at routing time.  However, this
18484 option has no effect when an address is just being verified. The way in which
18485 the text is used to remove header lines at transport time is described in
18486 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18487 the message is in the process of being transported. This means that references
18488 to header lines in string expansions in the transport's configuration still
18489 &"see"& the original header lines.
18490
18491 The &%headers_remove%& option is expanded after &%errors_to%& and
18492 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18493 the item has no effect. Other expansion failures are treated as configuration
18494 errors.
18495
18496 Unlike most options, &%headers_remove%& can be specified multiple times
18497 for a router; all listed headers are removed.
18498
18499 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18500 router that has the &%one_time%& option set.
18501
18502 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18503 removal requests are deleted when the address is passed on to subsequent
18504 routers, and this can lead to problems with duplicates -- see the similar
18505 warning for &%headers_add%& above.
18506
18507 &*Warning 3*&: Because of the separate expansion of the list items,
18508 items that contain a list separator must have it doubled.
18509 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18510
18511
18512
18513 .option ignore_target_hosts routers "host list&!!" unset
18514 .cindex "IP address" "discarding"
18515 .cindex "router" "discarding IP addresses"
18516 Although this option is a host list, it should normally contain IP address
18517 entries rather than names. If any host that is looked up by the router has an
18518 IP address that matches an item in this list, Exim behaves as if that IP
18519 address did not exist. This option allows you to cope with rogue DNS entries
18520 like
18521 .code
18522 remote.domain.example.  A  127.0.0.1
18523 .endd
18524 by setting
18525 .code
18526 ignore_target_hosts = 127.0.0.1
18527 .endd
18528 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18529 discarded in this way, the router declines. In a conventional configuration, an
18530 attempt to mail to such a domain would normally provoke the &"unrouteable
18531 domain"& error, and an attempt to verify an address in the domain would fail.
18532 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18533 router declines if presented with one of the listed addresses.
18534
18535 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18536 means of the first or the second of the following settings, respectively:
18537 .code
18538 ignore_target_hosts = 0.0.0.0/0
18539 ignore_target_hosts = <; 0::0/0
18540 .endd
18541 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18542 in the second line matches all IPv6 addresses.
18543
18544 This option may also be useful for ignoring link-local and site-local IPv6
18545 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18546 is expanded before use as a list, it is possible to make it dependent on the
18547 domain that is being routed.
18548
18549 .vindex "&$host_address$&"
18550 During its expansion, &$host_address$& is set to the IP address that is being
18551 checked.
18552
18553 .option initgroups routers boolean false
18554 .cindex "additional groups"
18555 .cindex "groups" "additional"
18556 .cindex "local transports" "uid and gid"
18557 .cindex "transport" "local"
18558 If the router queues an address for a transport, and this option is true, and
18559 the uid supplied by the router is not overridden by the transport, the
18560 &[initgroups()]& function is called when running the transport to ensure that
18561 any additional groups associated with the uid are set up. See also &%group%&
18562 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18563
18564
18565
18566 .option local_part_prefix routers&!? "string list" unset
18567 .cindex affix "router precondition"
18568 .cindex "router" "prefix for local part"
18569 .cindex "prefix" "for local part, used in router"
18570 If this option is set, the router is skipped unless the local part starts with
18571 one of the given strings, or &%local_part_prefix_optional%& is true. See
18572 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18573 evaluated.
18574
18575 The list is scanned from left to right, and the first prefix that matches is
18576 used. A limited form of wildcard is available; if the prefix begins with an
18577 asterisk, it matches the longest possible sequence of arbitrary characters at
18578 the start of the local part. An asterisk should therefore always be followed by
18579 some character that does not occur in normal local parts.
18580 .cindex "multiple mailboxes"
18581 .cindex "mailbox" "multiple"
18582 Wildcarding can be used to set up multiple user mailboxes, as described in
18583 section &<<SECTmulbox>>&.
18584
18585 .vindex "&$local_part$&"
18586 .vindex "&$local_part_prefix$&"
18587 During the testing of the &%local_parts%& option, and while the router is
18588 running, the prefix is removed from the local part, and is available in the
18589 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18590 the router accepts the address, this remains true during subsequent delivery by
18591 a transport. In particular, the local part that is transmitted in the RCPT
18592 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18593 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18594 the relevant transport.
18595
18596 When an address is being verified, &%local_part_prefix%& affects only the
18597 behaviour of the router. If the callout feature of verification is in use, this
18598 means that the full address, including the prefix, will be used during the
18599 callout.
18600
18601 The prefix facility is commonly used to handle local parts of the form
18602 &%owner-something%&. Another common use is to support local parts of the form
18603 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18604 to tell a user their forwarding is broken &-- by placing a router like this one
18605 immediately before the router that handles &_.forward_& files:
18606 .code
18607 real_localuser:
18608   driver = accept
18609   local_part_prefix = real-
18610   check_local_user
18611   transport = local_delivery
18612 .endd
18613 For security, it would probably be a good idea to restrict the use of this
18614 router to locally-generated messages, using a condition such as this:
18615 .code
18616   condition = ${if match {$sender_host_address}\
18617                          {\N^(|127\.0\.0\.1)$\N}}
18618 .endd
18619
18620 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18621 both conditions must be met if not optional. Care must be taken if wildcards
18622 are used in both a prefix and a suffix on the same router. Different
18623 separator characters must be used to avoid ambiguity.
18624
18625
18626 .option local_part_prefix_optional routers boolean false
18627 See &%local_part_prefix%& above.
18628
18629
18630
18631 .option local_part_suffix routers&!? "string list" unset
18632 .cindex "router" "suffix for local part"
18633 .cindex "suffix for local part" "used in router"
18634 This option operates in the same way as &%local_part_prefix%&, except that the
18635 local part must end (rather than start) with the given string, the
18636 &%local_part_suffix_optional%& option determines whether the suffix is
18637 mandatory, and the wildcard * character, if present, must be the last
18638 character of the suffix. This option facility is commonly used to handle local
18639 parts of the form &%something-request%& and multiple user mailboxes of the form
18640 &%username-foo%&.
18641
18642
18643 .option local_part_suffix_optional routers boolean false
18644 See &%local_part_suffix%& above.
18645
18646
18647
18648 .option local_parts routers&!? "local part list&!!" unset
18649 .cindex "router" "restricting to specific local parts"
18650 .cindex "local part" "checking in router"
18651 The router is run only if the local part of the address matches the list.
18652 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18653 are evaluated, and
18654 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18655 string is expanded, it is possible to make it depend on the domain, for
18656 example:
18657 .code
18658 local_parts = dbm;/usr/local/specials/$domain
18659 .endd
18660 .vindex "&$local_part_data$&"
18661 If the match is achieved by a lookup, the data that the lookup returned
18662 for the local part is placed in the variable &$local_part_data$& for use in
18663 expansions of the router's private options. You might use this option, for
18664 example, if you have a large number of local virtual domains, and you want to
18665 send all postmaster mail to the same place without having to set up an alias in
18666 each virtual domain:
18667 .code
18668 postmaster:
18669   driver = redirect
18670   local_parts = postmaster
18671   data = postmaster@real.domain.example
18672 .endd
18673
18674
18675 .option log_as_local routers boolean "see below"
18676 .cindex "log" "delivery line"
18677 .cindex "delivery" "log line format"
18678 Exim has two logging styles for delivery, the idea being to make local
18679 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18680 recipient address is given just as the local part, without a domain. The use of
18681 this style is controlled by this option. It defaults to true for the &(accept)&
18682 router, and false for all the others. This option applies only when a
18683 router assigns an address to a transport. It has no effect on routers that
18684 redirect addresses.
18685
18686
18687
18688 .option more routers boolean&!! true
18689 The result of string expansion for this option must be a valid boolean value,
18690 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18691 result causes an error, and delivery is deferred. If the expansion is forced to
18692 fail, the default value for the option (true) is used. Other failures cause
18693 delivery to be deferred.
18694
18695 If this option is set false, and the router declines to handle the address, no
18696 further routers are tried, routing fails, and the address is bounced.
18697 .oindex "&%self%&"
18698 However, if the router explicitly passes an address to the following router by
18699 means of the setting
18700 .code
18701 self = pass
18702 .endd
18703 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18704 does not affect the behaviour if one of the precondition tests fails. In that
18705 case, the address is always passed to the next router.
18706
18707 Note that &%address_data%& is not considered to be a precondition. If its
18708 expansion is forced to fail, the router declines, and the value of &%more%&
18709 controls what happens next.
18710
18711
18712 .option pass_on_timeout routers boolean false
18713 .cindex "timeout" "of router"
18714 .cindex "router" "timeout"
18715 If a router times out during a host lookup, it normally causes deferral of the
18716 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18717 router, overriding &%no_more%&. This may be helpful for systems that are
18718 intermittently connected to the Internet, or those that want to pass to a smart
18719 host any messages that cannot immediately be delivered.
18720
18721 There are occasional other temporary errors that can occur while doing DNS
18722 lookups. They are treated in the same way as a timeout, and this option
18723 applies to all of them.
18724
18725
18726
18727 .option pass_router routers string unset
18728 .cindex "router" "go to after &""pass""&"
18729 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18730 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18731 routing to continue, and overriding a false setting of &%more%&. When one of
18732 these routers returns &"pass"&, the address is normally handed on to the next
18733 router in sequence. This can be changed by setting &%pass_router%& to the name
18734 of another router. However (unlike &%redirect_router%&) the named router must
18735 be below the current router, to avoid loops. Note that this option applies only
18736 to the special case of &"pass"&. It does not apply when a router returns
18737 &"decline"& because it cannot handle an address.
18738
18739
18740
18741 .option redirect_router routers string unset
18742 .cindex "router" "start at after redirection"
18743 Sometimes an administrator knows that it is pointless to reprocess addresses
18744 generated from alias or forward files with the same router again. For
18745 example, if an alias file translates real names into login ids there is no
18746 point searching the alias file a second time, especially if it is a large file.
18747
18748 The &%redirect_router%& option can be set to the name of any router instance.
18749 It causes the routing of any generated addresses to start at the named router
18750 instead of at the first router. This option has no effect if the router in
18751 which it is set does not generate new addresses.
18752
18753
18754
18755 .option require_files routers&!? "string list&!!" unset
18756 .cindex "file" "requiring for router"
18757 .cindex "router" "requiring file existence"
18758 This option provides a general mechanism for predicating the running of a
18759 router on the existence or non-existence of certain files or directories.
18760 Before running a router, as one of its precondition tests, Exim works its way
18761 through the &%require_files%& list, expanding each item separately.
18762
18763 Because the list is split before expansion, any colons in expansion items must
18764 be doubled, or the facility for using a different list separator must be used
18765 (&<<SECTlistsepchange>>&).
18766 If any expansion is forced to fail, the item is ignored. Other expansion
18767 failures cause routing of the address to be deferred.
18768
18769 If any expanded string is empty, it is ignored. Otherwise, except as described
18770 below, each string must be a fully qualified file path, optionally preceded by
18771 &"!"&. The paths are passed to the &[stat()]& function to test for the
18772 existence of the files or directories. The router is skipped if any paths not
18773 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18774
18775 .cindex "NFS"
18776 If &[stat()]& cannot determine whether a file exists or not, delivery of
18777 the message is deferred. This can happen when NFS-mounted filesystems are
18778 unavailable.
18779
18780 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18781 options, so you cannot use it to check for the existence of a file in which to
18782 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18783 full list of the order in which preconditions are evaluated.) However, as
18784 these options are all expanded, you can use the &%exists%& expansion condition
18785 to make such tests. The &%require_files%& option is intended for checking files
18786 that the router may be going to use internally, or which are needed by a
18787 transport (e.g., &_.procmailrc_&).
18788
18789 During delivery, the &[stat()]& function is run as root, but there is a
18790 facility for some checking of the accessibility of a file by another user.
18791 This is not a proper permissions check, but just a &"rough"& check that
18792 operates as follows:
18793
18794 If an item in a &%require_files%& list does not contain any forward slash
18795 characters, it is taken to be the user (and optional group, separated by a
18796 comma) to be checked for subsequent files in the list. If no group is specified
18797 but the user is specified symbolically, the gid associated with the uid is
18798 used. For example:
18799 .code
18800 require_files = mail:/some/file
18801 require_files = $local_part:$home/.procmailrc
18802 .endd
18803 If a user or group name in a &%require_files%& list does not exist, the
18804 &%require_files%& condition fails.
18805
18806 Exim performs the check by scanning along the components of the file path, and
18807 checking the access for the given uid and gid. It checks for &"x"& access on
18808 directories, and &"r"& access on the final file. Note that this means that file
18809 access control lists, if the operating system has them, are ignored.
18810
18811 &*Warning 1*&: When the router is being run to verify addresses for an
18812 incoming SMTP message, Exim is not running as root, but under its own uid. This
18813 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18814 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18815 user is not permitted to read one of the directories on the file's path.
18816
18817 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18818 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18819 without root access. In this case, if a check for access by a particular user
18820 is requested, Exim creates a subprocess that runs as that user, and tries the
18821 check again in that process.
18822
18823 The default action for handling an unresolved EACCES is to consider it to
18824 be caused by a configuration error, and routing is deferred because the
18825 existence or non-existence of the file cannot be determined. However, in some
18826 circumstances it may be desirable to treat this condition as if the file did
18827 not exist. If the filename (or the exclamation mark that precedes the filename
18828 for non-existence) is preceded by a plus sign, the EACCES error is treated
18829 as if the file did not exist. For example:
18830 .code
18831 require_files = +/some/file
18832 .endd
18833 If the router is not an essential part of verification (for example, it
18834 handles users' &_.forward_& files), another solution is to set the &%verify%&
18835 option false so that the router is skipped when verifying.
18836
18837
18838
18839 .option retry_use_local_part routers boolean "see below"
18840 .cindex "hints database" "retry keys"
18841 .cindex "local part" "in retry keys"
18842 When a delivery suffers a temporary routing failure, a retry record is created
18843 in Exim's hints database. For addresses whose routing depends only on the
18844 domain, the key for the retry record should not involve the local part, but for
18845 other addresses, both the domain and the local part should be included.
18846 Usually, remote routing is of the former kind, and local routing is of the
18847 latter kind.
18848
18849 This option controls whether the local part is used to form the key for retry
18850 hints for addresses that suffer temporary errors while being handled by this
18851 router. The default value is true for any router that has &%check_local_user%&
18852 set, and false otherwise. Note that this option does not apply to hints keys
18853 for transport delays; they are controlled by a generic transport option of the
18854 same name.
18855
18856 The setting of &%retry_use_local_part%& applies only to the router on which it
18857 appears. If the router generates child addresses, they are routed
18858 independently; this setting does not become attached to them.
18859
18860
18861
18862 .option router_home_directory routers string&!! unset
18863 .cindex "router" "home directory for"
18864 .cindex "home directory" "for router"
18865 .vindex "&$home$&"
18866 This option sets a home directory for use while the router is running. (Compare
18867 &%transport_home_directory%&, which sets a home directory for later
18868 transporting.) In particular, if used on a &(redirect)& router, this option
18869 sets a value for &$home$& while a filter is running. The value is expanded;
18870 forced expansion failure causes the option to be ignored &-- other failures
18871 cause the router to defer.
18872
18873 Expansion of &%router_home_directory%& happens immediately after the
18874 &%check_local_user%& test (if configured), before any further expansions take
18875 place.
18876 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18877 are evaluated.)
18878 While the router is running, &%router_home_directory%& overrides the value of
18879 &$home$& that came from &%check_local_user%&.
18880
18881 When a router accepts an address and assigns it to a local transport (including
18882 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18883 delivery), the home directory setting for the transport is taken from the first
18884 of these values that is set:
18885
18886 .ilist
18887 The &%home_directory%& option on the transport;
18888 .next
18889 The &%transport_home_directory%& option on the router;
18890 .next
18891 The password data if &%check_local_user%& is set on the router;
18892 .next
18893 The &%router_home_directory%& option on the router.
18894 .endlist
18895
18896 In other words, &%router_home_directory%& overrides the password data for the
18897 router, but not for the transport.
18898
18899
18900
18901 .option self routers string freeze
18902 .cindex "MX record" "pointing to local host"
18903 .cindex "local host" "MX pointing to"
18904 This option applies to those routers that use a recipient address to find a
18905 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18906 and &(manualroute)& routers.
18907 Certain configurations of the &(queryprogram)& router can also specify a list
18908 of remote hosts.
18909 Usually such routers are configured to send the message to a remote host via an
18910 &(smtp)& transport. The &%self%& option specifies what happens when the first
18911 host on the list turns out to be the local host.
18912 The way in which Exim checks for the local host is described in section
18913 &<<SECTreclocipadd>>&.
18914
18915 Normally this situation indicates either an error in Exim's configuration (for
18916 example, the router should be configured not to process this domain), or an
18917 error in the DNS (for example, the MX should not point to this host). For this
18918 reason, the default action is to log the incident, defer the address, and
18919 freeze the message. The following alternatives are provided for use in special
18920 cases:
18921
18922 .vlist
18923 .vitem &%defer%&
18924 Delivery of the message is tried again later, but the message is not frozen.
18925
18926 .vitem "&%reroute%&: <&'domain'&>"
18927 The domain is changed to the given domain, and the address is passed back to
18928 be reprocessed by the routers. No rewriting of headers takes place. This
18929 behaviour is essentially a redirection.
18930
18931 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18932 The domain is changed to the given domain, and the address is passed back to be
18933 reprocessed by the routers. Any headers that contain the original domain are
18934 rewritten.
18935
18936 .vitem &%pass%&
18937 .oindex "&%more%&"
18938 .vindex "&$self_hostname$&"
18939 The router passes the address to the next router, or to the router named in the
18940 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18941 subsequent routing and delivery, the variable &$self_hostname$& contains the
18942 name of the local host that the router encountered. This can be used to
18943 distinguish between different cases for hosts with multiple names. The
18944 combination
18945 .code
18946 self = pass
18947 no_more
18948 .endd
18949 ensures that only those addresses that routed to the local host are passed on.
18950 Without &%no_more%&, addresses that were declined for other reasons would also
18951 be passed to the next router.
18952
18953 .vitem &%fail%&
18954 Delivery fails and an error report is generated.
18955
18956 .vitem &%send%&
18957 .cindex "local host" "sending to"
18958 The anomaly is ignored and the address is queued for the transport. This
18959 setting should be used with extreme caution. For an &(smtp)& transport, it
18960 makes sense only in cases where the program that is listening on the SMTP port
18961 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18962 different configuration file that handles the domain in another way.
18963 .endlist
18964
18965
18966
18967 .option senders routers&!? "address list&!!" unset
18968 .cindex "router" "checking senders"
18969 If this option is set, the router is skipped unless the message's sender
18970 address matches something on the list.
18971 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18972 are evaluated.
18973
18974 There are issues concerning verification when the running of routers is
18975 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18976 setting, it sets the sender to the null string. When using the &%-bt%& option
18977 to check a configuration file, it is necessary also to use the &%-f%& option to
18978 set an appropriate sender. For incoming mail, the sender is unset when
18979 verifying the sender, but is available when verifying any recipients. If the
18980 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18981 matters.
18982
18983
18984 .option translate_ip_address routers string&!! unset
18985 .cindex "IP address" "translating"
18986 .cindex "packet radio"
18987 .cindex "router" "IP address translation"
18988 There exist some rare networking situations (for example, packet radio) where
18989 it is helpful to be able to translate IP addresses generated by normal routing
18990 mechanisms into other IP addresses, thus performing a kind of manual IP
18991 routing. This should be done only if the normal IP routing of the TCP/IP stack
18992 is inadequate or broken. Because this is an extremely uncommon requirement, the
18993 code to support this option is not included in the Exim binary unless
18994 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18995
18996 .vindex "&$host_address$&"
18997 The &%translate_ip_address%& string is expanded for every IP address generated
18998 by the router, with the generated address set in &$host_address$&. If the
18999 expansion is forced to fail, no action is taken.
19000 For any other expansion error, delivery of the message is deferred.
19001 If the result of the expansion is an IP address, that replaces the original
19002 address; otherwise the result is assumed to be a host name &-- this is looked
19003 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19004 produce one or more replacement IP addresses. For example, to subvert all IP
19005 addresses in some specific networks, this could be added to a router:
19006 .code
19007 translate_ip_address = \
19008   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19009     {$value}fail}}
19010 .endd
19011 The file would contain lines like
19012 .code
19013 10.2.3.128/26    some.host
19014 10.8.4.34/26     10.44.8.15
19015 .endd
19016 You should not make use of this facility unless you really understand what you
19017 are doing.
19018
19019
19020
19021 .option transport routers string&!! unset
19022 This option specifies the transport to be used when a router accepts an address
19023 and sets it up for delivery. A transport is never needed if a router is used
19024 only for verification. The value of the option is expanded at routing time,
19025 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19026 and result must be the name of one of the configured transports. If it is not,
19027 delivery is deferred.
19028
19029 The &%transport%& option is not used by the &(redirect)& router, but it does
19030 have some private options that set up transports for pipe and file deliveries
19031 (see chapter &<<CHAPredirect>>&).
19032
19033
19034
19035 .option transport_current_directory routers string&!! unset
19036 .cindex "current directory for local transport"
19037 This option associates a current directory with any address that is routed
19038 to a local transport. This can happen either because a transport is
19039 explicitly configured for the router, or because it generates a delivery to a
19040 file or a pipe. During the delivery process (that is, at transport time), this
19041 option string is expanded and is set as the current directory, unless
19042 overridden by a setting on the transport.
19043 If the expansion fails for any reason, including forced failure, an error is
19044 logged, and delivery is deferred.
19045 See chapter &<<CHAPenvironment>>& for details of the local delivery
19046 environment.
19047
19048
19049
19050
19051 .option transport_home_directory routers string&!! "see below"
19052 .cindex "home directory" "for local transport"
19053 This option associates a home directory with any address that is routed to a
19054 local transport. This can happen either because a transport is explicitly
19055 configured for the router, or because it generates a delivery to a file or a
19056 pipe. During the delivery process (that is, at transport time), the option
19057 string is expanded and is set as the home directory, unless overridden by a
19058 setting of &%home_directory%& on the transport.
19059 If the expansion fails for any reason, including forced failure, an error is
19060 logged, and delivery is deferred.
19061
19062 If the transport does not specify a home directory, and
19063 &%transport_home_directory%& is not set for the router, the home directory for
19064 the transport is taken from the password data if &%check_local_user%& is set for
19065 the router. Otherwise it is taken from &%router_home_directory%& if that option
19066 is set; if not, no home directory is set for the transport.
19067
19068 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19069 environment.
19070
19071
19072
19073
19074 .option unseen routers boolean&!! false
19075 .cindex "router" "carrying on after success"
19076 The result of string expansion for this option must be a valid boolean value,
19077 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19078 result causes an error, and delivery is deferred. If the expansion is forced to
19079 fail, the default value for the option (false) is used. Other failures cause
19080 delivery to be deferred.
19081
19082 When this option is set true, routing does not cease if the router accepts the
19083 address. Instead, a copy of the incoming address is passed to the next router,
19084 overriding a false setting of &%more%&. There is little point in setting
19085 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19086 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19087 sometimes true and sometimes false).
19088
19089 .cindex "copy of message (&%unseen%& option)"
19090 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19091 qualifier in filter files. It can be used to cause copies of messages to be
19092 delivered to some other destination, while also carrying out a normal delivery.
19093 In effect, the current address is made into a &"parent"& that has two children
19094 &-- one that is delivered as specified by this router, and a clone that goes on
19095 to be routed further. For this reason, &%unseen%& may not be combined with the
19096 &%one_time%& option in a &(redirect)& router.
19097
19098 &*Warning*&: Header lines added to the address (or specified for removal) by
19099 this router or by previous routers affect the &"unseen"& copy of the message
19100 only. The clone that continues to be processed by further routers starts with
19101 no added headers and none specified for removal. For a &%redirect%& router, if
19102 a generated address is the same as the incoming address, this can lead to
19103 duplicate addresses with different header modifications. Exim does not do
19104 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19105 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19106 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19107 &%redirect%& router may be of help.
19108
19109 Unlike the handling of header modifications, any data that was set by the
19110 &%address_data%& option in the current or previous routers &'is'& passed on to
19111 subsequent routers.
19112
19113
19114 .option user routers string&!! "see below"
19115 .cindex "uid (user id)" "local delivery"
19116 .cindex "local transports" "uid and gid"
19117 .cindex "transport" "local"
19118 .cindex "router" "user for filter processing"
19119 .cindex "filter" "user for processing"
19120 When a router queues an address for a transport, and the transport does not
19121 specify a user, the user given here is used when running the delivery process.
19122 The user may be specified numerically or by name. If expansion fails, the
19123 error is logged and delivery is deferred.
19124 This user is also used by the &(redirect)& router when running a filter file.
19125 The default is unset, except when &%check_local_user%& is set. In this case,
19126 the default is taken from the password information. If the user is specified as
19127 a name, and &%group%& is not set, the group associated with the user is used.
19128 See also &%initgroups%& and &%group%& and the discussion in chapter
19129 &<<CHAPenvironment>>&.
19130
19131
19132
19133 .option verify routers&!? boolean true
19134 Setting this option has the effect of setting &%verify_sender%& and
19135 &%verify_recipient%& to the same value.
19136
19137
19138 .option verify_only routers&!? boolean false
19139 .cindex "EXPN" "with &%verify_only%&"
19140 .oindex "&%-bv%&"
19141 .cindex "router" "used only when verifying"
19142 If this option is set, the router is used only when verifying an address,
19143 delivering in cutthrough mode or
19144 testing with the &%-bv%& option, not when actually doing a delivery, testing
19145 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19146 restricted to verifying only senders or recipients by means of
19147 &%verify_sender%& and &%verify_recipient%&.
19148
19149 &*Warning*&: When the router is being run to verify addresses for an incoming
19150 SMTP message, Exim is not running as root, but under its own uid. If the router
19151 accesses any files, you need to make sure that they are accessible to the Exim
19152 user or group.
19153
19154
19155 .option verify_recipient routers&!? boolean true
19156 If this option is false, the router is skipped when verifying recipient
19157 addresses,
19158 delivering in cutthrough mode
19159 or testing recipient verification using &%-bv%&.
19160 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19161 are evaluated.
19162 See also the &$verify_mode$& variable.
19163
19164
19165 .option verify_sender routers&!? boolean true
19166 If this option is false, the router is skipped when verifying sender addresses
19167 or testing sender verification using &%-bvs%&.
19168 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19169 are evaluated.
19170 See also the &$verify_mode$& variable.
19171 .ecindex IIDgenoprou1
19172 .ecindex IIDgenoprou2
19173
19174
19175
19176
19177
19178
19179 . ////////////////////////////////////////////////////////////////////////////
19180 . ////////////////////////////////////////////////////////////////////////////
19181
19182 .chapter "The accept router" "CHID4"
19183 .cindex "&(accept)& router"
19184 .cindex "routers" "&(accept)&"
19185 The &(accept)& router has no private options of its own. Unless it is being
19186 used purely for verification (see &%verify_only%&) a transport is required to
19187 be defined by the generic &%transport%& option. If the preconditions that are
19188 specified by generic options are met, the router accepts the address and queues
19189 it for the given transport. The most common use of this router is for setting
19190 up deliveries to local mailboxes. For example:
19191 .code
19192 localusers:
19193   driver = accept
19194   domains = mydomain.example
19195   check_local_user
19196   transport = local_delivery
19197 .endd
19198 The &%domains%& condition in this example checks the domain of the address, and
19199 &%check_local_user%& checks that the local part is the login of a local user.
19200 When both preconditions are met, the &(accept)& router runs, and queues the
19201 address for the &(local_delivery)& transport.
19202
19203
19204
19205
19206
19207
19208 . ////////////////////////////////////////////////////////////////////////////
19209 . ////////////////////////////////////////////////////////////////////////////
19210
19211 .chapter "The dnslookup router" "CHAPdnslookup"
19212 .scindex IIDdnsrou1 "&(dnslookup)& router"
19213 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19214 The &(dnslookup)& router looks up the hosts that handle mail for the
19215 recipient's domain in the DNS. A transport must always be set for this router,
19216 unless &%verify_only%& is set.
19217
19218 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19219 SRV records. If none are found, or if SRV support is not configured,
19220 MX records are looked up. If no MX records exist, address records are sought.
19221 However, &%mx_domains%& can be set to disable the direct use of address
19222 records.
19223
19224 MX records of equal priority are sorted by Exim into a random order. Exim then
19225 looks for address records for the host names obtained from MX or SRV records.
19226 When a host has more than one IP address, they are sorted into a random order,
19227 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19228 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19229 generic option, the router declines.
19230
19231 Unless they have the highest priority (lowest MX value), MX records that point
19232 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19233 are discarded, together with any other MX records of equal or lower priority.
19234
19235 .cindex "MX record" "pointing to local host"
19236 .cindex "local host" "MX pointing to"
19237 .oindex "&%self%&" "in &(dnslookup)& router"
19238 If the host pointed to by the highest priority MX record, or looked up as an
19239 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19240 happens is controlled by the generic &%self%& option.
19241
19242
19243 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19244 There have been problems with DNS servers when SRV records are looked up.
19245 Some misbehaving servers return a DNS error or timeout when a non-existent
19246 SRV record is sought. Similar problems have in the past been reported for
19247 MX records. The global &%dns_again_means_nonexist%& option can help with this
19248 problem, but it is heavy-handed because it is a global option.
19249
19250 For this reason, there are two options, &%srv_fail_domains%& and
19251 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19252 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19253 an attempt to look up an SRV or MX record causes one of these results, and the
19254 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19255 such record"&. In the case of an SRV lookup, this means that the router
19256 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19257 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19258 case routing fails.
19259
19260
19261 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19262 .cindex "&(dnslookup)& router" "declines"
19263 There are a few cases where a &(dnslookup)& router will decline to accept
19264 an address; if such a router is expected to handle "all remaining non-local
19265 domains", then it is important to set &%no_more%&.
19266
19267 The router will defer rather than decline if the domain
19268 is found in the &%fail_defer_domains%& router option.
19269
19270 Reasons for a &(dnslookup)& router to decline currently include:
19271 .ilist
19272 The domain does not exist in DNS
19273 .next
19274 The domain exists but the MX record's host part is just "."; this is a common
19275 convention (borrowed from SRV) used to indicate that there is no such service
19276 for this domain and to not fall back to trying A/AAAA records.
19277 .next
19278 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19279 .next
19280 MX record points to a non-existent host.
19281 .next
19282 MX record points to an IP address and the main section option
19283 &%allow_mx_to_ip%& is not set.
19284 .next
19285 MX records exist and point to valid hosts, but all hosts resolve only to
19286 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19287 .next
19288 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19289 &%dns_check_names_pattern%& for handling one variant of this)
19290 .next
19291 &%check_secondary_mx%& is set on this router but the local host can
19292 not be found in the MX records (see below)
19293 .endlist
19294
19295
19296
19297
19298 .section "Private options for dnslookup" "SECID118"
19299 .cindex "options" "&(dnslookup)& router"
19300 The private options for the &(dnslookup)& router are as follows:
19301
19302 .option check_secondary_mx dnslookup boolean false
19303 .cindex "MX record" "checking for secondary"
19304 If this option is set, the router declines unless the local host is found in
19305 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19306 process domains for which the local host is a secondary mail exchanger
19307 differently to other domains. The way in which Exim decides whether a host is
19308 the local host is described in section &<<SECTreclocipadd>>&.
19309
19310
19311 .option check_srv dnslookup string&!! unset
19312 .cindex "SRV record" "enabling use of"
19313 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19314 addition to MX and address records. The support is disabled by default. To
19315 enable SRV support, set the &%check_srv%& option to the name of the service
19316 required. For example,
19317 .code
19318 check_srv = smtp
19319 .endd
19320 looks for SRV records that refer to the normal smtp service. The option is
19321 expanded, so the service name can vary from message to message or address
19322 to address. This might be helpful if SRV records are being used for a
19323 submission service. If the expansion is forced to fail, the &%check_srv%&
19324 option is ignored, and the router proceeds to look for MX records in the
19325 normal way.
19326
19327 When the expansion succeeds, the router searches first for SRV records for
19328 the given service (it assumes TCP protocol). A single SRV record with a
19329 host name that consists of just a single dot indicates &"no such service for
19330 this domain"&; if this is encountered, the router declines. If other kinds of
19331 SRV record are found, they are used to construct a host list for delivery
19332 according to the rules of RFC 2782. MX records are not sought in this case.
19333
19334 When no SRV records are found, MX records (and address records) are sought in
19335 the traditional way. In other words, SRV records take precedence over MX
19336 records, just as MX records take precedence over address records. Note that
19337 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19338 defined it. It is apparently believed that MX records are sufficient for email
19339 and that SRV records should not be used for this purpose. However, SRV records
19340 have an additional &"weight"& feature which some people might find useful when
19341 trying to split an SMTP load between hosts of different power.
19342
19343 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19344 when there is a DNS lookup error.
19345
19346
19347
19348
19349 .option fail_defer_domains dnslookup "domain list&!!" unset
19350 .cindex "MX record" "not found"
19351 DNS lookups for domains matching &%fail_defer_domains%&
19352 which find no matching record will cause the router to defer
19353 rather than the default behaviour of decline.
19354 This maybe be useful for queueing messages for a newly created
19355 domain while the DNS configuration is not ready.
19356 However, it will result in any message with mistyped domains
19357 also being queued.
19358
19359
19360 .option ipv4_only "string&!!" unset
19361 .cindex IPv6 disabling
19362 .cindex DNS "IPv6 disabling"
19363 The string is expanded, and if the result is anything but a forced failure,
19364 or an empty string, or one of the strings “0” or “no” or “false”
19365 (checked without regard to the case of the letters),
19366 only A records are used.
19367
19368 .option ipv4_prefer "string&!!" unset
19369 .cindex IPv4 preference
19370 .cindex DNS "IPv4 preference"
19371 The string is expanded, and if the result is anything but a forced failure,
19372 or an empty string, or one of the strings “0” or “no” or “false”
19373 (checked without regard to the case of the letters),
19374 A records are sorted before AAAA records (inverting the default).
19375
19376 .option mx_domains dnslookup "domain list&!!" unset
19377 .cindex "MX record" "required to exist"
19378 .cindex "SRV record" "required to exist"
19379 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19380 record in order to be recognized. (The name of this option could be improved.)
19381 For example, if all the mail hosts in &'fict.example'& are known to have MX
19382 records, except for those in &'discworld.fict.example'&, you could use this
19383 setting:
19384 .code
19385 mx_domains = ! *.discworld.fict.example : *.fict.example
19386 .endd
19387 This specifies that messages addressed to a domain that matches the list but
19388 has no MX record should be bounced immediately instead of being routed using
19389 the address record.
19390
19391
19392 .option mx_fail_domains dnslookup "domain list&!!" unset
19393 If the DNS lookup for MX records for one of the domains in this list causes a
19394 DNS lookup error, Exim behaves as if no MX records were found. See section
19395 &<<SECTprowitdnsloo>>& for more discussion.
19396
19397
19398
19399
19400 .option qualify_single dnslookup boolean true
19401 .cindex "DNS" "resolver options"
19402 .cindex "DNS" "qualifying single-component names"
19403 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19404 lookups. Typically, but not standardly, this causes the resolver to qualify
19405 single-component names with the default domain. For example, on a machine
19406 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19407 &'thesaurus.ref.example'& inside the resolver. For details of what your
19408 resolver actually does, consult your man pages for &'resolver'& and
19409 &'resolv.conf'&.
19410
19411
19412
19413 .option rewrite_headers dnslookup boolean true
19414 .cindex "rewriting" "header lines"
19415 .cindex "header lines" "rewriting"
19416 If the domain name in the address that is being processed is not fully
19417 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19418 an address is specified as &'dormouse@teaparty'&, the domain might be
19419 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19420 occur as a result of setting the &%widen_domains%& option. If
19421 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19422 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19423 header lines of the message are rewritten with the full domain name.
19424
19425 This option should be turned off only when it is known that no message is
19426 ever going to be sent outside an environment where the abbreviation makes
19427 sense.
19428
19429 When an MX record is looked up in the DNS and matches a wildcard record, name
19430 servers normally return a record containing the name that has been looked up,
19431 making it impossible to detect whether a wildcard was present or not. However,
19432 some name servers have recently been seen to return the wildcard entry. If the
19433 name returned by a DNS lookup begins with an asterisk, it is not used for
19434 header rewriting.
19435
19436
19437 .option same_domain_copy_routing dnslookup boolean false
19438 .cindex "address" "copying routing"
19439 Addresses with the same domain are normally routed by the &(dnslookup)& router
19440 to the same list of hosts. However, this cannot be presumed, because the router
19441 options and preconditions may refer to the local part of the address. By
19442 default, therefore, Exim routes each address in a message independently. DNS
19443 servers run caches, so repeated DNS lookups are not normally expensive, and in
19444 any case, personal messages rarely have more than a few recipients.
19445
19446 If you are running mailing lists with large numbers of subscribers at the same
19447 domain, and you are using a &(dnslookup)& router which is independent of the
19448 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19449 lookups for identical domains in one message. In this case, when &(dnslookup)&
19450 routes an address to a remote transport, any other unrouted addresses in the
19451 message that have the same domain are automatically given the same routing
19452 without processing them independently,
19453 provided the following conditions are met:
19454
19455 .ilist
19456 No router that processed the address specified &%headers_add%& or
19457 &%headers_remove%&.
19458 .next
19459 The router did not change the address in any way, for example, by &"widening"&
19460 the domain.
19461 .endlist
19462
19463
19464
19465
19466 .option search_parents dnslookup boolean false
19467 .cindex "DNS" "resolver options"
19468 When this option is true, the resolver option RES_DNSRCH is set for DNS
19469 lookups. This is different from the &%qualify_single%& option in that it
19470 applies to domains containing dots. Typically, but not standardly, it causes
19471 the resolver to search for the name in the current domain and in parent
19472 domains. For example, on a machine in the &'fict.example'& domain, if looking
19473 up &'teaparty.wonderland'& failed, the resolver would try
19474 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19475 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19476
19477 Setting this option true can cause problems in domains that have a wildcard MX
19478 record, because any domain that does not have its own MX record matches the
19479 local wildcard.
19480
19481
19482
19483 .option srv_fail_domains dnslookup "domain list&!!" unset
19484 If the DNS lookup for SRV records for one of the domains in this list causes a
19485 DNS lookup error, Exim behaves as if no SRV records were found. See section
19486 &<<SECTprowitdnsloo>>& for more discussion.
19487
19488
19489
19490
19491 .option widen_domains dnslookup "string list" unset
19492 .cindex "domain" "partial; widening"
19493 If a DNS lookup fails and this option is set, each of its strings in turn is
19494 added onto the end of the domain, and the lookup is tried again. For example,
19495 if
19496 .code
19497 widen_domains = fict.example:ref.example
19498 .endd
19499 is set and a lookup of &'klingon.dictionary'& fails,
19500 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19501 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19502 and &%search_parents%& options can cause some widening to be undertaken inside
19503 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19504 when verifying, unless &%rewrite_headers%& is false (not the default).
19505
19506
19507 .section "Effect of qualify_single and search_parents" "SECID119"
19508 When a domain from an envelope recipient is changed by the resolver as a result
19509 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19510 corresponding address in the message's header lines unless &%rewrite_headers%&
19511 is set false. Exim then re-routes the address, using the full domain.
19512
19513 These two options affect only the DNS lookup that takes place inside the router
19514 for the domain of the address that is being routed. They do not affect lookups
19515 such as that implied by
19516 .code
19517 domains = @mx_any
19518 .endd
19519 that may happen while processing a router precondition before the router is
19520 entered. No widening ever takes place for these lookups.
19521 .ecindex IIDdnsrou1
19522 .ecindex IIDdnsrou2
19523
19524
19525
19526
19527
19528
19529
19530
19531
19532 . ////////////////////////////////////////////////////////////////////////////
19533 . ////////////////////////////////////////////////////////////////////////////
19534
19535 .chapter "The ipliteral router" "CHID5"
19536 .cindex "&(ipliteral)& router"
19537 .cindex "domain literal" "routing"
19538 .cindex "routers" "&(ipliteral)&"
19539 This router has no private options. Unless it is being used purely for
19540 verification (see &%verify_only%&) a transport is required to be defined by the
19541 generic &%transport%& option. The router accepts the address if its domain part
19542 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19543 router handles the address
19544 .code
19545 root@[192.168.1.1]
19546 .endd
19547 by setting up delivery to the host with that IP address. IPv4 domain literals
19548 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19549 are similar, but the address is preceded by &`ipv6:`&. For example:
19550 .code
19551 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19552 .endd
19553 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19554 grounds that sooner or later somebody will try it.
19555
19556 .oindex "&%self%&" "in &(ipliteral)& router"
19557 If the IP address matches something in &%ignore_target_hosts%&, the router
19558 declines. If an IP literal turns out to refer to the local host, the generic
19559 &%self%& option determines what happens.
19560
19561 The RFCs require support for domain literals; however, their use is
19562 controversial in today's Internet. If you want to use this router, you must
19563 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19564 Exim will not recognize the domain literal syntax in addresses.
19565
19566
19567
19568 . ////////////////////////////////////////////////////////////////////////////
19569 . ////////////////////////////////////////////////////////////////////////////
19570
19571 .chapter "The iplookup router" "CHID6"
19572 .cindex "&(iplookup)& router"
19573 .cindex "routers" "&(iplookup)&"
19574 The &(iplookup)& router was written to fulfil a specific requirement in
19575 Cambridge University (which in fact no longer exists). For this reason, it is
19576 not included in the binary of Exim by default. If you want to include it, you
19577 must set
19578 .code
19579 ROUTER_IPLOOKUP=yes
19580 .endd
19581 in your &_Local/Makefile_& configuration file.
19582
19583 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19584 connection to one or more specific hosts. The host can then return the same or
19585 a different address &-- in effect rewriting the recipient address in the
19586 message's envelope. The new address is then passed on to subsequent routers. If
19587 this process fails, the address can be passed on to other routers, or delivery
19588 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19589 must not be specified for it.
19590
19591 .cindex "options" "&(iplookup)& router"
19592 .option hosts iplookup string unset
19593 This option must be supplied. Its value is a colon-separated list of host
19594 names. The hosts are looked up using &[gethostbyname()]&
19595 (or &[getipnodebyname()]& when available)
19596 and are tried in order until one responds to the query. If none respond, what
19597 happens is controlled by &%optional%&.
19598
19599
19600 .option optional iplookup boolean false
19601 If &%optional%& is true, if no response is obtained from any host, the address
19602 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19603 delivery to the address is deferred.
19604
19605
19606 .option port iplookup integer 0
19607 .cindex "port" "&(iplookup)& router"
19608 This option must be supplied. It specifies the port number for the TCP or UDP
19609 call.
19610
19611
19612 .option protocol iplookup string udp
19613 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19614 protocols is to be used.
19615
19616
19617 .option query iplookup string&!! "see below"
19618 This defines the content of the query that is sent to the remote hosts. The
19619 default value is:
19620 .code
19621 $local_part@$domain $local_part@$domain
19622 .endd
19623 The repetition serves as a way of checking that a response is to the correct
19624 query in the default case (see &%response_pattern%& below).
19625
19626
19627 .option reroute iplookup string&!! unset
19628 If this option is not set, the rerouted address is precisely the byte string
19629 returned by the remote host, up to the first white space, if any. If set, the
19630 string is expanded to form the rerouted address. It can include parts matched
19631 in the response by &%response_pattern%& by means of numeric variables such as
19632 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19633 whether or not a pattern is in use. In all cases, the rerouted address must end
19634 up in the form &'local_part@domain'&.
19635
19636
19637 .option response_pattern iplookup string unset
19638 This option can be set to a regular expression that is applied to the string
19639 returned from the remote host. If the pattern does not match the response, the
19640 router declines. If &%response_pattern%& is not set, no checking of the
19641 response is done, unless the query was defaulted, in which case there is a
19642 check that the text returned after the first white space is the original
19643 address. This checks that the answer that has been received is in response to
19644 the correct question. For example, if the response is just a new domain, the
19645 following could be used:
19646 .code
19647 response_pattern = ^([^@]+)$
19648 reroute = $local_part@$1
19649 .endd
19650
19651 .option timeout iplookup time 5s
19652 This specifies the amount of time to wait for a response from the remote
19653 machine. The same timeout is used for the &[connect()]& function for a TCP
19654 call. It does not apply to UDP.
19655
19656
19657
19658
19659 . ////////////////////////////////////////////////////////////////////////////
19660 . ////////////////////////////////////////////////////////////////////////////
19661
19662 .chapter "The manualroute router" "CHID7"
19663 .scindex IIDmanrou1 "&(manualroute)& router"
19664 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19665 .cindex "domain" "manually routing"
19666 The &(manualroute)& router is so-called because it provides a way of manually
19667 routing an address according to its domain. It is mainly used when you want to
19668 route addresses to remote hosts according to your own rules, bypassing the
19669 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19670 route to local transports, a facility that may be useful if you want to save
19671 messages for dial-in hosts in local files.
19672
19673 The &(manualroute)& router compares a list of domain patterns with the domain
19674 it is trying to route. If there is no match, the router declines. Each pattern
19675 has associated with it a list of hosts and some other optional data, which may
19676 include a transport. The combination of a pattern and its data is called a
19677 &"routing rule"&. For patterns that do not have an associated transport, the
19678 generic &%transport%& option must specify a transport, unless the router is
19679 being used purely for verification (see &%verify_only%&).
19680
19681 .vindex "&$host$&"
19682 In the case of verification, matching the domain pattern is sufficient for the
19683 router to accept the address. When actually routing an address for delivery,
19684 an address that matches a domain pattern is queued for the associated
19685 transport. If the transport is not a local one, a host list must be associated
19686 with the pattern; IP addresses are looked up for the hosts, and these are
19687 passed to the transport along with the mail address. For local transports, a
19688 host list is optional. If it is present, it is passed in &$host$& as a single
19689 text string.
19690
19691 The list of routing rules can be provided as an inline string in
19692 &%route_list%&, or the data can be obtained by looking up the domain in a file
19693 or database by setting &%route_data%&. Only one of these settings may appear in
19694 any one instance of &(manualroute)&. The format of routing rules is described
19695 below, following the list of private options.
19696
19697
19698 .section "Private options for manualroute" "SECTprioptman"
19699
19700 .cindex "options" "&(manualroute)& router"
19701 The private options for the &(manualroute)& router are as follows:
19702
19703 .option host_all_ignored manualroute string defer
19704 See &%host_find_failed%&.
19705
19706 .option host_find_failed manualroute string freeze
19707 This option controls what happens when &(manualroute)& tries to find an IP
19708 address for a host, and the host does not exist. The option can be set to one
19709 of the following values:
19710 .code
19711 decline
19712 defer
19713 fail
19714 freeze
19715 ignore
19716 pass
19717 .endd
19718 The default (&"freeze"&) assumes that this state is a serious configuration
19719 error. The difference between &"pass"& and &"decline"& is that the former
19720 forces the address to be passed to the next router (or the router defined by
19721 &%pass_router%&),
19722 .oindex "&%more%&"
19723 overriding &%no_more%&, whereas the latter passes the address to the next
19724 router only if &%more%& is true.
19725
19726 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19727 cannot be found. If all the hosts in the list are ignored, the behaviour is
19728 controlled by the &%host_all_ignored%& option. This takes the same values
19729 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19730
19731 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19732 state; if a host lookup gets a temporary error, delivery is deferred unless the
19733 generic &%pass_on_timeout%& option is set.
19734
19735
19736 .option hosts_randomize manualroute boolean false
19737 .cindex "randomized host list"
19738 .cindex "host" "list of; randomized"
19739 If this option is set, the order of the items in a host list in a routing rule
19740 is randomized each time the list is used, unless an option in the routing rule
19741 overrides (see below). Randomizing the order of a host list can be used to do
19742 crude load sharing. However, if more than one mail address is routed by the
19743 same router to the same host list, the host lists are considered to be the same
19744 (even though they may be randomized into different orders) for the purpose of
19745 deciding whether to batch the deliveries into a single SMTP transaction.
19746
19747 When &%hosts_randomize%& is true, a host list may be split
19748 into groups whose order is separately randomized. This makes it possible to
19749 set up MX-like behaviour. The boundaries between groups are indicated by an
19750 item that is just &`+`& in the host list. For example:
19751 .code
19752 route_list = * host1:host2:host3:+:host4:host5
19753 .endd
19754 The order of the first three hosts and the order of the last two hosts is
19755 randomized for each use, but the first three always end up before the last two.
19756 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19757 randomized host list is passed to an &(smtp)& transport that also has
19758 &%hosts_randomize set%&, the list is not re-randomized.
19759
19760
19761 .option route_data manualroute string&!! unset
19762 If this option is set, it must expand to yield the data part of a routing rule.
19763 Typically, the expansion string includes a lookup based on the domain. For
19764 example:
19765 .code
19766 route_data = ${lookup{$domain}dbm{/etc/routes}}
19767 .endd
19768 If the expansion is forced to fail, or the result is an empty string, the
19769 router declines. Other kinds of expansion failure cause delivery to be
19770 deferred.
19771
19772
19773 .option route_list manualroute "string list" unset
19774 This string is a list of routing rules, in the form defined below. Note that,
19775 unlike most string lists, the items are separated by semicolons. This is so
19776 that they may contain colon-separated host lists.
19777
19778
19779 .option same_domain_copy_routing manualroute boolean false
19780 .cindex "address" "copying routing"
19781 Addresses with the same domain are normally routed by the &(manualroute)&
19782 router to the same list of hosts. However, this cannot be presumed, because the
19783 router options and preconditions may refer to the local part of the address. By
19784 default, therefore, Exim routes each address in a message independently. DNS
19785 servers run caches, so repeated DNS lookups are not normally expensive, and in
19786 any case, personal messages rarely have more than a few recipients.
19787
19788 If you are running mailing lists with large numbers of subscribers at the same
19789 domain, and you are using a &(manualroute)& router which is independent of the
19790 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19791 lookups for identical domains in one message. In this case, when
19792 &(manualroute)& routes an address to a remote transport, any other unrouted
19793 addresses in the message that have the same domain are automatically given the
19794 same routing without processing them independently. However, this is only done
19795 if &%headers_add%& and &%headers_remove%& are unset.
19796
19797
19798
19799
19800 .section "Routing rules in route_list" "SECID120"
19801 The value of &%route_list%& is a string consisting of a sequence of routing
19802 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19803 entered as two semicolons. Alternatively, the list separator can be changed as
19804 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19805 Empty rules are ignored. The format of each rule is
19806 .display
19807 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19808 .endd
19809 The following example contains two rules, each with a simple domain pattern and
19810 no options:
19811 .code
19812 route_list = \
19813   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19814   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19815 .endd
19816 The three parts of a rule are separated by white space. The pattern and the
19817 list of hosts can be enclosed in quotes if necessary, and if they are, the
19818 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19819 single domain pattern, which is the only mandatory item in the rule. The
19820 pattern is in the same format as one item in a domain list (see section
19821 &<<SECTdomainlist>>&),
19822 except that it may not be the name of an interpolated file.
19823 That is, it may be wildcarded, or a regular expression, or a file or database
19824 lookup (with semicolons doubled, because of the use of semicolon as a separator
19825 in a &%route_list%&).
19826
19827 The rules in &%route_list%& are searched in order until one of the patterns
19828 matches the domain that is being routed. The list of hosts and then options are
19829 then used as described below. If there is no match, the router declines. When
19830 &%route_list%& is set, &%route_data%& must not be set.
19831
19832
19833
19834 .section "Routing rules in route_data" "SECID121"
19835 The use of &%route_list%& is convenient when there are only a small number of
19836 routing rules. For larger numbers, it is easier to use a file or database to
19837 hold the routing information, and use the &%route_data%& option instead.
19838 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19839 Most commonly, &%route_data%& is set as a string that contains an
19840 expansion lookup. For example, suppose we place two routing rules in a file
19841 like this:
19842 .code
19843 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19844 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19845 .endd
19846 This data can be accessed by setting
19847 .code
19848 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19849 .endd
19850 Failure of the lookup results in an empty string, causing the router to
19851 decline. However, you do not have to use a lookup in &%route_data%&. The only
19852 requirement is that the result of expanding the string is a list of hosts,
19853 possibly followed by options, separated by white space. The list of hosts must
19854 be enclosed in quotes if it contains white space.
19855
19856
19857
19858
19859 .section "Format of the list of hosts" "SECID122"
19860 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19861 always separately expanded before use. If the expansion fails, the router
19862 declines. The result of the expansion must be a colon-separated list of names
19863 and/or IP addresses, optionally also including ports.
19864 If the list is written with spaces, it must be protected with quotes.
19865 The format of each item
19866 in the list is described in the next section. The list separator can be changed
19867 as described in section &<<SECTlistsepchange>>&.
19868
19869 If the list of hosts was obtained from a &%route_list%& item, the following
19870 variables are set during its expansion:
19871
19872 .ilist
19873 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19874 If the domain was matched against a regular expression, the numeric variables
19875 &$1$&, &$2$&, etc. may be set. For example:
19876 .code
19877 route_list = ^domain(\d+)   host-$1.text.example
19878 .endd
19879 .next
19880 &$0$& is always set to the entire domain.
19881 .next
19882 &$1$& is also set when partial matching is done in a file lookup.
19883
19884 .next
19885 .vindex "&$value$&"
19886 If the pattern that matched the domain was a lookup item, the data that was
19887 looked up is available in the expansion variable &$value$&. For example:
19888 .code
19889 route_list = lsearch;;/some/file.routes  $value
19890 .endd
19891 .endlist
19892
19893 Note the doubling of the semicolon in the pattern that is necessary because
19894 semicolon is the default route list separator.
19895
19896
19897
19898 .section "Format of one host item" "SECTformatonehostitem"
19899 Each item in the list of hosts is either a host name or an IP address,
19900 optionally with an attached port number. When no port is given, an IP address
19901 is not enclosed in brackets. When a port is specified, it overrides the port
19902 specification on the transport. The port is separated from the name or address
19903 by a colon. This leads to some complications:
19904
19905 .ilist
19906 Because colon is the default separator for the list of hosts, either
19907 the colon that specifies a port must be doubled, or the list separator must
19908 be changed. The following two examples have the same effect:
19909 .code
19910 route_list = * "host1.tld::1225 : host2.tld::1226"
19911 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19912 .endd
19913 .next
19914 When IPv6 addresses are involved, it gets worse, because they contain
19915 colons of their own. To make this case easier, it is permitted to
19916 enclose an IP address (either v4 or v6) in square brackets if a port
19917 number follows. For example:
19918 .code
19919 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19920 .endd
19921 .endlist
19922
19923 .section "How the list of hosts is used" "SECThostshowused"
19924 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19925 the hosts is tried, in the order specified, when carrying out the SMTP
19926 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19927 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19928 transport.
19929
19930 Hosts may be listed by name or by IP address. An unadorned name in the list of
19931 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19932 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19933 records in the DNS. For example:
19934 .code
19935 route_list = *  x.y.z:p.q.r/MX:e.f.g
19936 .endd
19937 If this feature is used with a port specifier, the port must come last. For
19938 example:
19939 .code
19940 route_list = *  dom1.tld/mx::1225
19941 .endd
19942 If the &%hosts_randomize%& option is set, the order of the items in the list is
19943 randomized before any lookups are done. Exim then scans the list; for any name
19944 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19945 be an interface on the local host and the item is not the first in the list,
19946 Exim discards it and any subsequent items. If it is the first item, what
19947 happens is controlled by the
19948 .oindex "&%self%&" "in &(manualroute)& router"
19949 &%self%& option of the router.
19950
19951 A name on the list that is followed by &`/MX`& is replaced with the list of
19952 hosts obtained by looking up MX records for the name. This is always a DNS
19953 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19954 below) are not relevant here. The order of these hosts is determined by the
19955 preference values in the MX records, according to the usual rules. Because
19956 randomizing happens before the MX lookup, it does not affect the order that is
19957 defined by MX preferences.
19958
19959 If the local host is present in the sublist obtained from MX records, but is
19960 not the most preferred host in that list, it and any equally or less
19961 preferred hosts are removed before the sublist is inserted into the main list.
19962
19963 If the local host is the most preferred host in the MX list, what happens
19964 depends on where in the original list of hosts the &`/MX`& item appears. If it
19965 is not the first item (that is, there are previous hosts in the main list),
19966 Exim discards this name and any subsequent items in the main list.
19967
19968 If the MX item is first in the list of hosts, and the local host is the
19969 most preferred host, what happens is controlled by the &%self%& option of the
19970 router.
19971
19972 DNS failures when lookup up the MX records are treated in the same way as DNS
19973 failures when looking up IP addresses: &%pass_on_timeout%& and
19974 &%host_find_failed%& are used when relevant.
19975
19976 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19977 whether obtained from an MX lookup or not.
19978
19979
19980
19981 .section "How the options are used" "SECThowoptused"
19982 The options are a sequence of words, space-separated.
19983 One of the words can be the name of a transport; this overrides the
19984 &%transport%& option on the router for this particular routing rule only. The
19985 other words (if present) control randomization of the list of hosts on a
19986 per-rule basis, and how the IP addresses of the hosts are to be found when
19987 routing to a remote transport. These options are as follows:
19988
19989 .ilist
19990 &%randomize%&: randomize the order of the hosts in this list, overriding the
19991 setting of &%hosts_randomize%& for this routing rule only.
19992 .next
19993 &%no_randomize%&: do not randomize the order of the hosts in this list,
19994 overriding the setting of &%hosts_randomize%& for this routing rule only.
19995 .next
19996 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19997 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19998 also look in &_/etc/hosts_& or other sources of information.
19999 .next
20000 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20001 no address records are found. If there is a temporary DNS error (such as a
20002 timeout), delivery is deferred.
20003 .next
20004 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20005 .next
20006 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20007 .endlist
20008
20009 For example:
20010 .code
20011 route_list = domain1  host1:host2:host3  randomize bydns;\
20012              domain2  host4:host5
20013 .endd
20014 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20015 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20016 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20017 or &[gethostbyname()]&, and the result of the lookup is the result of that
20018 call.
20019
20020 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20021 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20022 instead of TRY_AGAIN. That is why the default action is to try a DNS
20023 lookup first. Only if that gives a definite &"no such host"& is the local
20024 function called.
20025
20026 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20027 inadvertent constraint that a transport name as an option had to be the last
20028 option specified.
20029
20030
20031
20032 If no IP address for a host can be found, what happens is controlled by the
20033 &%host_find_failed%& option.
20034
20035 .vindex "&$host$&"
20036 When an address is routed to a local transport, IP addresses are not looked up.
20037 The host list is passed to the transport in the &$host$& variable.
20038
20039
20040
20041 .section "Manualroute examples" "SECID123"
20042 In some of the examples that follow, the presence of the &%remote_smtp%&
20043 transport, as defined in the default configuration file, is assumed:
20044
20045 .ilist
20046 .cindex "smart host" "example router"
20047 The &(manualroute)& router can be used to forward all external mail to a
20048 &'smart host'&. If you have set up, in the main part of the configuration, a
20049 named domain list that contains your local domains, for example:
20050 .code
20051 domainlist local_domains = my.domain.example
20052 .endd
20053 You can arrange for all other domains to be routed to a smart host by making
20054 your first router something like this:
20055 .code
20056 smart_route:
20057   driver = manualroute
20058   domains = !+local_domains
20059   transport = remote_smtp
20060   route_list = * smarthost.ref.example
20061 .endd
20062 This causes all non-local addresses to be sent to the single host
20063 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20064 they are tried in order
20065 (but you can use &%hosts_randomize%& to vary the order each time).
20066 Another way of configuring the same thing is this:
20067 .code
20068 smart_route:
20069   driver = manualroute
20070   transport = remote_smtp
20071   route_list = !+local_domains  smarthost.ref.example
20072 .endd
20073 There is no difference in behaviour between these two routers as they stand.
20074 However, they behave differently if &%no_more%& is added to them. In the first
20075 example, the router is skipped if the domain does not match the &%domains%&
20076 precondition; the following router is always tried. If the router runs, it
20077 always matches the domain and so can never decline. Therefore, &%no_more%&
20078 would have no effect. In the second case, the router is never skipped; it
20079 always runs. However, if it doesn't match the domain, it declines. In this case
20080 &%no_more%& would prevent subsequent routers from running.
20081
20082 .next
20083 .cindex "mail hub example"
20084 A &'mail hub'& is a host which receives mail for a number of domains via MX
20085 records in the DNS and delivers it via its own private routing mechanism. Often
20086 the final destinations are behind a firewall, with the mail hub being the one
20087 machine that can connect to machines both inside and outside the firewall. The
20088 &(manualroute)& router is usually used on a mail hub to route incoming messages
20089 to the correct hosts. For a small number of domains, the routing can be inline,
20090 using the &%route_list%& option, but for a larger number a file or database
20091 lookup is easier to manage.
20092
20093 If the domain names are in fact the names of the machines to which the mail is
20094 to be sent by the mail hub, the configuration can be quite simple. For
20095 example:
20096 .code
20097 hub_route:
20098   driver = manualroute
20099   transport = remote_smtp
20100   route_list = *.rhodes.tvs.example  $domain
20101 .endd
20102 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20103 whose names are the same as the mail domains. A similar approach can be taken
20104 if the host name can be obtained from the domain name by a string manipulation
20105 that the expansion facilities can handle. Otherwise, a lookup based on the
20106 domain can be used to find the host:
20107 .code
20108 through_firewall:
20109   driver = manualroute
20110   transport = remote_smtp
20111   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20112 .endd
20113 The result of the lookup must be the name or IP address of the host (or
20114 hosts) to which the address is to be routed. If the lookup fails, the route
20115 data is empty, causing the router to decline. The address then passes to the
20116 next router.
20117
20118 .next
20119 .cindex "batched SMTP output example"
20120 .cindex "SMTP" "batched outgoing; example"
20121 You can use &(manualroute)& to deliver messages to pipes or files in batched
20122 SMTP format for onward transportation by some other means. This is one way of
20123 storing mail for a dial-up host when it is not connected. The route list entry
20124 can be as simple as a single domain name in a configuration like this:
20125 .code
20126 save_in_file:
20127   driver = manualroute
20128   transport = batchsmtp_appendfile
20129   route_list = saved.domain.example
20130 .endd
20131 though often a pattern is used to pick up more than one domain. If there are
20132 several domains or groups of domains with different transport requirements,
20133 different transports can be listed in the routing information:
20134 .code
20135 save_in_file:
20136   driver = manualroute
20137   route_list = \
20138     *.saved.domain1.example  $domain  batch_appendfile; \
20139     *.saved.domain2.example  \
20140       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20141       batch_pipe
20142 .endd
20143 .vindex "&$domain$&"
20144 .vindex "&$host$&"
20145 The first of these just passes the domain in the &$host$& variable, which
20146 doesn't achieve much (since it is also in &$domain$&), but the second does a
20147 file lookup to find a value to pass, causing the router to decline to handle
20148 the address if the lookup fails.
20149
20150 .next
20151 .cindex "UUCP" "example of router for"
20152 Routing mail directly to UUCP software is a specific case of the use of
20153 &(manualroute)& in a gateway to another mail environment. This is an example of
20154 one way it can be done:
20155 .code
20156 # Transport
20157 uucp:
20158   driver = pipe
20159   user = nobody
20160   command = /usr/local/bin/uux -r - \
20161     ${substr_-5:$host}!rmail ${local_part}
20162   return_fail_output = true
20163
20164 # Router
20165 uucphost:
20166   transport = uucp
20167   driver = manualroute
20168   route_data = \
20169     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20170 .endd
20171 The file &_/usr/local/exim/uucphosts_& contains entries like
20172 .code
20173 darksite.ethereal.example:           darksite.UUCP
20174 .endd
20175 It can be set up more simply without adding and removing &".UUCP"& but this way
20176 makes clear the distinction between the domain name
20177 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20178 .endlist
20179 .ecindex IIDmanrou1
20180 .ecindex IIDmanrou2
20181
20182
20183
20184
20185
20186
20187
20188
20189 . ////////////////////////////////////////////////////////////////////////////
20190 . ////////////////////////////////////////////////////////////////////////////
20191
20192 .chapter "The queryprogram router" "CHAPdriverlast"
20193 .scindex IIDquerou1 "&(queryprogram)& router"
20194 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20195 .cindex "routing" "by external program"
20196 The &(queryprogram)& router routes an address by running an external command
20197 and acting on its output. This is an expensive way to route, and is intended
20198 mainly for use in lightly-loaded systems, or for performing experiments.
20199 However, if it is possible to use the precondition options (&%domains%&,
20200 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20201 be used in special cases, even on a busy host. There are the following private
20202 options:
20203 .cindex "options" "&(queryprogram)& router"
20204
20205 .option command queryprogram string&!! unset
20206 This option must be set. It specifies the command that is to be run. The
20207 command is split up into a command name and arguments, and then each is
20208 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20209 &<<CHAPpipetransport>>&).
20210
20211
20212 .option command_group queryprogram string unset
20213 .cindex "gid (group id)" "in &(queryprogram)& router"
20214 This option specifies a gid to be set when running the command while routing an
20215 address for deliver. It must be set if &%command_user%& specifies a numerical
20216 uid. If it begins with a digit, it is interpreted as the numerical value of the
20217 gid. Otherwise it is looked up using &[getgrnam()]&.
20218
20219
20220 .option command_user queryprogram string unset
20221 .cindex "uid (user id)" "for &(queryprogram)&"
20222 This option must be set. It specifies the uid which is set when running the
20223 command while routing an address for delivery. If the value begins with a digit,
20224 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20225 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20226 not set, a value for the gid also.
20227
20228 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20229 root, which it does during a normal delivery in a conventional configuration.
20230 However, when an address is being verified during message reception, Exim is
20231 usually running as the Exim user, not as root. If the &(queryprogram)& router
20232 is called from a non-root process, Exim cannot change uid or gid before running
20233 the command. In this circumstance the command runs under the current uid and
20234 gid.
20235
20236
20237 .option current_directory queryprogram string /
20238 This option specifies an absolute path which is made the current directory
20239 before running the command.
20240
20241
20242 .option timeout queryprogram time 1h
20243 If the command does not complete within the timeout period, its process group
20244 is killed and the message is frozen. A value of zero time specifies no
20245 timeout.
20246
20247
20248 The standard output of the command is connected to a pipe, which is read when
20249 the command terminates. It should consist of a single line of output,
20250 containing up to five fields, separated by white space. The maximum length of
20251 the line is 1023 characters. Longer lines are silently truncated. The first
20252 field is one of the following words (case-insensitive):
20253
20254 .ilist
20255 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20256 below).
20257 .next
20258 &'Decline'&: the router declines; pass the address to the next router, unless
20259 &%no_more%& is set.
20260 .next
20261 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20262 subsequent text on the line is an error message. If the router is run as part
20263 of address verification during an incoming SMTP message, the message is
20264 included in the SMTP response.
20265 .next
20266 &'Defer'&: routing could not be completed at this time; try again later. Any
20267 subsequent text on the line is an error message which is logged. It is not
20268 included in any SMTP response.
20269 .next
20270 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20271 .next
20272 &'Pass'&: pass the address to the next router (or the router specified by
20273 &%pass_router%&), overriding &%no_more%&.
20274 .next
20275 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20276 new addresses, which are routed independently, starting with the first router,
20277 or the router specified by &%redirect_router%&, if set.
20278 .endlist
20279
20280 When the first word is &'accept'&, the remainder of the line consists of a
20281 number of keyed data values, as follows (split into two lines here, to fit on
20282 the page):
20283 .code
20284 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20285 LOOKUP=byname|bydns DATA=<text>
20286 .endd
20287 The data items can be given in any order, and all are optional. If no transport
20288 is included, the transport specified by the generic &%transport%& option is
20289 used. The list of hosts and the lookup type are needed only if the transport is
20290 an &(smtp)& transport that does not itself supply a list of hosts.
20291
20292 The format of the list of hosts is the same as for the &(manualroute)& router.
20293 As well as host names and IP addresses with optional port numbers, as described
20294 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20295 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20296 (see section &<<SECThostshowused>>&).
20297
20298 If the lookup type is not specified, Exim behaves as follows when trying to
20299 find an IP address for each host: First, a DNS lookup is done. If this yields
20300 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20301 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20302 result of the lookup is the result of that call.
20303
20304 .vindex "&$address_data$&"
20305 If the DATA field is set, its value is placed in the &$address_data$&
20306 variable. For example, this return line
20307 .code
20308 accept hosts=x1.y.example:x2.y.example data="rule1"
20309 .endd
20310 routes the address to the default transport, passing a list of two hosts. When
20311 the transport runs, the string &"rule1"& is in &$address_data$&.
20312 .ecindex IIDquerou1
20313 .ecindex IIDquerou2
20314
20315
20316
20317
20318 . ////////////////////////////////////////////////////////////////////////////
20319 . ////////////////////////////////////////////////////////////////////////////
20320
20321 .chapter "The redirect router" "CHAPredirect"
20322 .scindex IIDredrou1 "&(redirect)& router"
20323 .scindex IIDredrou2 "routers" "&(redirect)&"
20324 .cindex "alias file" "in a &(redirect)& router"
20325 .cindex "address redirection" "&(redirect)& router"
20326 The &(redirect)& router handles several kinds of address redirection. Its most
20327 common uses are for resolving local part aliases from a central alias file
20328 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20329 files, but it has many other potential uses. The incoming address can be
20330 redirected in several different ways:
20331
20332 .ilist
20333 It can be replaced by one or more new addresses which are themselves routed
20334 independently.
20335 .next
20336 It can be routed to be delivered to a given file or directory.
20337 .next
20338 It can be routed to be delivered to a specified pipe command.
20339 .next
20340 It can cause an automatic reply to be generated.
20341 .next
20342 It can be forced to fail, optionally with a custom error message.
20343 .next
20344 It can be temporarily deferred, optionally with a custom message.
20345 .next
20346 It can be discarded.
20347 .endlist
20348
20349 The generic &%transport%& option must not be set for &(redirect)& routers.
20350 However, there are some private options which define transports for delivery to
20351 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20352 &%pipe_transport%& and &%reply_transport%& descriptions below.
20353
20354 If success DSNs have been requested
20355 .cindex "DSN" "success"
20356 .cindex "Delivery Status Notification" "success"
20357 redirection triggers one and the DSN options are not passed any further.
20358
20359
20360
20361 .section "Redirection data" "SECID124"
20362 The router operates by interpreting a text string which it obtains either by
20363 expanding the contents of the &%data%& option, or by reading the entire
20364 contents of a file whose name is given in the &%file%& option. These two
20365 options are mutually exclusive. The first is commonly used for handling system
20366 aliases, in a configuration like this:
20367 .code
20368 system_aliases:
20369   driver = redirect
20370   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20371 .endd
20372 If the lookup fails, the expanded string in this example is empty. When the
20373 expansion of &%data%& results in an empty string, the router declines. A forced
20374 expansion failure also causes the router to decline; other expansion failures
20375 cause delivery to be deferred.
20376
20377 A configuration using &%file%& is commonly used for handling users'
20378 &_.forward_& files, like this:
20379 .code
20380 userforward:
20381   driver = redirect
20382   check_local_user
20383   file = $home/.forward
20384   no_verify
20385 .endd
20386 If the file does not exist, or causes no action to be taken (for example, it is
20387 empty or consists only of comments), the router declines. &*Warning*&: This
20388 is not the case when the file contains syntactically valid items that happen to
20389 yield empty addresses, for example, items containing only RFC 2822 address
20390 comments.
20391
20392
20393
20394 .section "Forward files and address verification" "SECID125"
20395 .cindex "address redirection" "while verifying"
20396 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20397 &_.forward_& files, as in the example above. There are two reasons for this:
20398
20399 .ilist
20400 When Exim is receiving an incoming SMTP message from a remote host, it is
20401 running under the Exim uid, not as root. Exim is unable to change uid to read
20402 the file as the user, and it may not be able to read it as the Exim user. So in
20403 practice the router may not be able to operate.
20404 .next
20405 However, even when the router can operate, the existence of a &_.forward_& file
20406 is unimportant when verifying an address. What should be checked is whether the
20407 local part is a valid user name or not. Cutting out the redirection processing
20408 saves some resources.
20409 .endlist
20410
20411
20412
20413
20414
20415
20416 .section "Interpreting redirection data" "SECID126"
20417 .cindex "Sieve filter" "specifying in redirection data"
20418 .cindex "filter" "specifying in redirection data"
20419 The contents of the data string, whether obtained from &%data%& or &%file%&,
20420 can be interpreted in two different ways:
20421
20422 .ilist
20423 If the &%allow_filter%& option is set true, and the data begins with the text
20424 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20425 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20426 respectively. Details of the syntax and semantics of filter files are described
20427 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20428 document is intended for use by end users.
20429 .next
20430 Otherwise, the data must be a comma-separated list of redirection items, as
20431 described in the next section.
20432 .endlist
20433
20434 When a message is redirected to a file (a &"mail folder"&), the filename given
20435 in a non-filter redirection list must always be an absolute path. A filter may
20436 generate a relative path &-- how this is handled depends on the transport's
20437 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20438 for the &(appendfile)& transport.
20439
20440
20441
20442 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20443 .cindex "address redirection" "non-filter list items"
20444 When the redirection data is not an Exim or Sieve filter, for example, if it
20445 comes from a conventional alias or forward file, it consists of a list of
20446 addresses, filenames, pipe commands, or certain special items (see section
20447 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20448 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20449 depending on their default values. The items in the list are separated by
20450 commas or newlines.
20451 If a comma is required in an item, the entire item must be enclosed in double
20452 quotes.
20453
20454 Lines starting with a # character are comments, and are ignored, and # may
20455 also appear following a comma, in which case everything between the # and the
20456 next newline character is ignored.
20457
20458 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20459 double quotes are retained because some forms of mail address require their use
20460 (but never to enclose the entire address). In the following description,
20461 &"item"& refers to what remains after any surrounding double quotes have been
20462 removed.
20463
20464 .vindex "&$local_part$&"
20465 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20466 and the expansion contains a reference to &$local_part$&, you should make use
20467 of the &%quote_local_part%& expansion operator, in case the local part contains
20468 special characters. For example, to redirect all mail for the domain
20469 &'obsolete.example'&, retaining the existing local part, you could use this
20470 setting:
20471 .code
20472 data = ${quote_local_part:$local_part}@newdomain.example
20473 .endd
20474
20475
20476 .section "Redirecting to a local mailbox" "SECTredlocmai"
20477 .cindex "routing" "loops in"
20478 .cindex "loop" "while routing, avoidance of"
20479 .cindex "address redirection" "to local mailbox"
20480 A redirection item may safely be the same as the address currently under
20481 consideration. This does not cause a routing loop, because a router is
20482 automatically skipped if any ancestor of the address that is being processed
20483 is the same as the current address and was processed by the current router.
20484 Such an address is therefore passed to the following routers, so it is handled
20485 as if there were no redirection. When making this loop-avoidance test, the
20486 complete local part, including any prefix or suffix, is used.
20487
20488 .cindex "address redirection" "local part without domain"
20489 Specifying the same local part without a domain is a common usage in personal
20490 filter files when the user wants to have messages delivered to the local
20491 mailbox and also forwarded elsewhere. For example, the user whose login is
20492 &'cleo'& might have a &_.forward_& file containing this:
20493 .code
20494 cleo, cleopatra@egypt.example
20495 .endd
20496 .cindex "backslash in alias file"
20497 .cindex "alias file" "backslash in"
20498 For compatibility with other MTAs, such unqualified local parts may be
20499 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20500 it does make a difference if more than one domain is being handled
20501 synonymously.
20502
20503 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20504 2822 address that does not include a domain, the item is qualified using the
20505 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20506 addresses are qualified using the value in &%qualify_recipient%&, but you can
20507 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20508
20509 Care must be taken if there are alias names for local users.
20510 Consider an MTA handling a single local domain where the system alias file
20511 contains:
20512 .code
20513 Sam.Reman: spqr
20514 .endd
20515 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20516 messages in the local mailbox, and also forward copies elsewhere. He creates
20517 this forward file:
20518 .code
20519 Sam.Reman, spqr@reme.elsewhere.example
20520 .endd
20521 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20522 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20523 second time round, because it has previously routed it,
20524 and the following routers presumably cannot handle the alias. The forward file
20525 should really contain
20526 .code
20527 spqr, spqr@reme.elsewhere.example
20528 .endd
20529 but because this is such a common error, the &%check_ancestor%& option (see
20530 below) exists to provide a way to get round it. This is normally set on a
20531 &(redirect)& router that is handling users' &_.forward_& files.
20532
20533
20534
20535 .section "Special items in redirection lists" "SECTspecitredli"
20536 In addition to addresses, the following types of item may appear in redirection
20537 lists (that is, in non-filter redirection data):
20538
20539 .ilist
20540 .cindex "pipe" "in redirection list"
20541 .cindex "address redirection" "to pipe"
20542 An item is treated as a pipe command if it begins with &"|"& and does not parse
20543 as a valid RFC 2822 address that includes a domain. A transport for running the
20544 command must be specified by the &%pipe_transport%& option.
20545 Normally, either the router or the transport specifies a user and a group under
20546 which to run the delivery. The default is to use the Exim user and group.
20547
20548 Single or double quotes can be used for enclosing the individual arguments of
20549 the pipe command; no interpretation of escapes is done for single quotes. If
20550 the command contains a comma character, it is necessary to put the whole item
20551 in double quotes, for example:
20552 .code
20553 "|/some/command ready,steady,go"
20554 .endd
20555 since items in redirection lists are terminated by commas. Do not, however,
20556 quote just the command. An item such as
20557 .code
20558 |"/some/command ready,steady,go"
20559 .endd
20560 is interpreted as a pipe with a rather strange command name, and no arguments.
20561
20562 Note that the above example assumes that the text comes from a lookup source
20563 of some sort, so that the quotes are part of the data.  If composing a
20564 redirect router with a &%data%& option directly specifying this command, the
20565 quotes will be used by the configuration parser to define the extent of one
20566 string, but will not be passed down into the redirect router itself.  There
20567 are two main approaches to get around this: escape quotes to be part of the
20568 data itself, or avoid using this mechanism and instead create a custom
20569 transport with the &%command%& option set and reference that transport from
20570 an &%accept%& router.
20571
20572 .next
20573 .cindex "file" "in redirection list"
20574 .cindex "address redirection" "to file"
20575 An item is interpreted as a path name if it begins with &"/"& and does not
20576 parse as a valid RFC 2822 address that includes a domain. For example,
20577 .code
20578 /home/world/minbari
20579 .endd
20580 is treated as a filename, but
20581 .code
20582 /s=molari/o=babylon/@x400gate.way
20583 .endd
20584 is treated as an address. For a filename, a transport must be specified using
20585 the &%file_transport%& option. However, if the generated path name ends with a
20586 forward slash character, it is interpreted as a directory name rather than a
20587 filename, and &%directory_transport%& is used instead.
20588
20589 Normally, either the router or the transport specifies a user and a group under
20590 which to run the delivery. The default is to use the Exim user and group.
20591
20592 .cindex "&_/dev/null_&"
20593 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20594 bypassed at a high level, and the log entry shows &"**bypassed**"&
20595 instead of a transport name. In this case the user and group are not used.
20596
20597 .next
20598 .cindex "included address list"
20599 .cindex "address redirection" "included external list"
20600 If an item is of the form
20601 .code
20602 :include:<path name>
20603 .endd
20604 a list of further items is taken from the given file and included at that
20605 point. &*Note*&: Such a file can not be a filter file; it is just an
20606 out-of-line addition to the list. The items in the included list are separated
20607 by commas or newlines and are not subject to expansion. If this is the first
20608 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20609 the alias name. This example is incorrect:
20610 .code
20611 list1    :include:/opt/lists/list1
20612 .endd
20613 It must be given as
20614 .code
20615 list1:   :include:/opt/lists/list1
20616 .endd
20617 .next
20618 .cindex "address redirection" "to black hole"
20619 .cindex "delivery" "discard"
20620 .cindex "delivery" "blackhole"
20621 .cindex "black hole"
20622 .cindex "abandoning mail"
20623 Sometimes you want to throw away mail to a particular local part.  Making the
20624 &%data%& option expand to an empty string does not work, because that causes
20625 the router to decline. Instead, the alias item
20626 .code
20627 :blackhole:
20628 .endd
20629 can be used. It does what its name implies. No delivery is
20630 done, and no error message is generated. This has the same effect as specifying
20631 &_/dev/null_& as a destination, but it can be independently disabled.
20632
20633 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20634 delivery is done for the original local part, even if other redirection items
20635 are present. If you are generating a multi-item list (for example, by reading a
20636 database) and need the ability to provide a no-op item, you must use
20637 &_/dev/null_&.
20638
20639 .next
20640 .cindex "delivery" "forcing failure"
20641 .cindex "delivery" "forcing deferral"
20642 .cindex "failing delivery" "forcing"
20643 .cindex "deferred delivery, forcing"
20644 .cindex "customizing" "failure message"
20645 An attempt to deliver a particular address can be deferred or forced to fail by
20646 redirection items of the form
20647 .code
20648 :defer:
20649 :fail:
20650 .endd
20651 respectively. When a redirection list contains such an item, it applies
20652 to the entire redirection; any other items in the list are ignored. Any
20653 text following &':fail:'& or &':defer:'& is placed in the error text
20654 associated with the failure. For example, an alias file might contain:
20655 .code
20656 X.Employee:  :fail: Gone away, no forwarding address
20657 .endd
20658 In the case of an address that is being verified from an ACL or as the subject
20659 of a
20660 .cindex "VRFY" "error text, display of"
20661 VRFY command, the text is included in the SMTP error response by
20662 default.
20663 .cindex "EXPN" "error text, display of"
20664 The text is not included in the response to an EXPN command. In non-SMTP cases
20665 the text is included in the error message that Exim generates.
20666
20667 .cindex "SMTP" "error codes"
20668 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20669 &':fail:'&. However, if the message starts with three digits followed by a
20670 space, optionally followed by an extended code of the form &'n.n.n'&, also
20671 followed by a space, and the very first digit is the same as the default error
20672 code, the code from the message is used instead. If the very first digit is
20673 incorrect, a panic error is logged, and the default code is used. You can
20674 suppress the use of the supplied code in a redirect router by setting the
20675 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20676 ignored.
20677
20678 .vindex "&$acl_verify_message$&"
20679 In an ACL, an explicitly provided message overrides the default, but the
20680 default message is available in the variable &$acl_verify_message$& and can
20681 therefore be included in a custom message if this is desired.
20682
20683 Normally the error text is the rest of the redirection list &-- a comma does
20684 not terminate it &-- but a newline does act as a terminator. Newlines are not
20685 normally present in alias expansions. In &(lsearch)& lookups they are removed
20686 as part of the continuation process, but they may exist in other kinds of
20687 lookup and in &':include:'& files.
20688
20689 During routing for message delivery (as opposed to verification), a redirection
20690 containing &':fail:'& causes an immediate failure of the incoming address,
20691 whereas &':defer:'& causes the message to remain in the queue so that a
20692 subsequent delivery attempt can happen at a later time. If an address is
20693 deferred for too long, it will ultimately fail, because the normal retry
20694 rules still apply.
20695
20696 .next
20697 .cindex "alias file" "exception to default"
20698 Sometimes it is useful to use a single-key search type with a default (see
20699 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20700 for exceptions to the default. These can be handled by aliasing them to
20701 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20702 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20703 results in an empty redirection list has the same effect.
20704 .endlist
20705
20706
20707 .section "Duplicate addresses" "SECTdupaddr"
20708 .cindex "duplicate addresses"
20709 .cindex "address duplicate, discarding"
20710 .cindex "pipe" "duplicated"
20711 Exim removes duplicate addresses from the list to which it is delivering, so as
20712 to deliver just one copy to each address. This does not apply to deliveries
20713 routed to pipes by different immediate parent addresses, but an indirect
20714 aliasing scheme of the type
20715 .code
20716 pipe:       |/some/command $local_part
20717 localpart1: pipe
20718 localpart2: pipe
20719 .endd
20720 does not work with a message that is addressed to both local parts, because
20721 when the second is aliased to the intermediate local part &"pipe"& it gets
20722 discarded as being the same as a previously handled address. However, a scheme
20723 such as
20724 .code
20725 localpart1: |/some/command $local_part
20726 localpart2: |/some/command $local_part
20727 .endd
20728 does result in two different pipe deliveries, because the immediate parents of
20729 the pipes are distinct.
20730
20731
20732
20733 .section "Repeated redirection expansion" "SECID128"
20734 .cindex "repeated redirection expansion"
20735 .cindex "address redirection" "repeated for each delivery attempt"
20736 When a message cannot be delivered to all of its recipients immediately,
20737 leading to two or more delivery attempts, redirection expansion is carried out
20738 afresh each time for those addresses whose children were not all previously
20739 delivered. If redirection is being used as a mailing list, this can lead to new
20740 members of the list receiving copies of old messages. The &%one_time%& option
20741 can be used to avoid this.
20742
20743
20744 .section "Errors in redirection lists" "SECID129"
20745 .cindex "address redirection" "errors"
20746 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20747 error is skipped, and an entry is written to the main log. This may be useful
20748 for mailing lists that are automatically managed. Otherwise, if an error is
20749 detected while generating the list of new addresses, the original address is
20750 deferred. See also &%syntax_errors_to%&.
20751
20752
20753
20754 .section "Private options for the redirect router" "SECID130"
20755
20756 .cindex "options" "&(redirect)& router"
20757 The private options for the &(redirect)& router are as follows:
20758
20759
20760 .option allow_defer redirect boolean false
20761 Setting this option allows the use of &':defer:'& in non-filter redirection
20762 data, or the &%defer%& command in an Exim filter file.
20763
20764
20765 .option allow_fail redirect boolean false
20766 .cindex "failing delivery" "from filter"
20767 If this option is true, the &':fail:'& item can be used in a redirection list,
20768 and the &%fail%& command may be used in an Exim filter file.
20769
20770
20771 .option allow_filter redirect boolean false
20772 .cindex "filter" "enabling use of"
20773 .cindex "Sieve filter" "enabling use of"
20774 Setting this option allows Exim to interpret redirection data that starts with
20775 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20776 are some features of Exim filter files that some administrators may wish to
20777 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20778
20779 It is also possible to lock out Exim filters or Sieve filters while allowing
20780 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20781
20782
20783 The filter is run using the uid and gid set by the generic &%user%& and
20784 &%group%& options. These take their defaults from the password data if
20785 &%check_local_user%& is set, so in the normal case of users' personal filter
20786 files, the filter is run as the relevant user. When &%allow_filter%& is set
20787 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20788
20789
20790
20791 .option allow_freeze redirect boolean false
20792 .cindex "freezing messages" "allowing in filter"
20793 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20794 This command is more normally encountered in system filters, and is disabled by
20795 default for redirection filters because it isn't something you usually want to
20796 let ordinary users do.
20797
20798
20799
20800 .option check_ancestor redirect boolean false
20801 This option is concerned with handling generated addresses that are the same
20802 as some address in the list of redirection ancestors of the current address.
20803 Although it is turned off by default in the code, it is set in the default
20804 configuration file for handling users' &_.forward_& files. It is recommended
20805 for this use of the &(redirect)& router.
20806
20807 When &%check_ancestor%& is set, if a generated address (including the domain)
20808 is the same as any ancestor of the current address, it is replaced by a copy of
20809 the current address. This helps in the case where local part A is aliased to B,
20810 and B has a &_.forward_& file pointing back to A. For example, within a single
20811 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20812 &_&~jb/.forward_& contains:
20813 .code
20814 \Joe.Bloggs, <other item(s)>
20815 .endd
20816 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20817 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20818 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20819 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20820 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20821 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20822 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20823 original address. See also the &%repeat_use%& option below.
20824
20825
20826 .option check_group redirect boolean "see below"
20827 When the &%file%& option is used, the group owner of the file is checked only
20828 when this option is set. The permitted groups are those listed in the
20829 &%owngroups%& option, together with the user's default group if
20830 &%check_local_user%& is set. If the file has the wrong group, routing is
20831 deferred. The default setting for this option is true if &%check_local_user%&
20832 is set and the &%modemask%& option permits the group write bit, or if the
20833 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20834
20835
20836
20837 .option check_owner redirect boolean "see below"
20838 When the &%file%& option is used, the owner of the file is checked only when
20839 this option is set. If &%check_local_user%& is set, the local user is
20840 permitted; otherwise the owner must be one of those listed in the &%owners%&
20841 option. The default value for this option is true if &%check_local_user%& or
20842 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20843
20844
20845 .option data redirect string&!! unset
20846 This option is mutually exclusive with &%file%&. One or other of them must be
20847 set, but not both. The contents of &%data%& are expanded, and then used as the
20848 list of forwarding items, or as a set of filtering instructions. If the
20849 expansion is forced to fail, or the result is an empty string or a string that
20850 has no effect (consists entirely of comments), the router declines.
20851
20852 When filtering instructions are used, the string must begin with &"#Exim
20853 filter"&, and all comments in the string, including this initial one, must be
20854 terminated with newline characters. For example:
20855 .code
20856 data = #Exim filter\n\
20857        if $h_to: contains Exim then save $home/mail/exim endif
20858 .endd
20859 If you are reading the data from a database where newlines cannot be included,
20860 you can use the &${sg}$& expansion item to turn the escape string of your
20861 choice into a newline.
20862
20863
20864 .option directory_transport redirect string&!! unset
20865 A &(redirect)& router sets up a direct delivery to a directory when a path name
20866 ending with a slash is specified as a new &"address"&. The transport used is
20867 specified by this option, which, after expansion, must be the name of a
20868 configured transport. This should normally be an &(appendfile)& transport.
20869
20870
20871 .option file redirect string&!! unset
20872 This option specifies the name of a file that contains the redirection data. It
20873 is mutually exclusive with the &%data%& option. The string is expanded before
20874 use; if the expansion is forced to fail, the router declines. Other expansion
20875 failures cause delivery to be deferred. The result of a successful expansion
20876 must be an absolute path. The entire file is read and used as the redirection
20877 data. If the data is an empty string or a string that has no effect (consists
20878 entirely of comments), the router declines.
20879
20880 .cindex "NFS" "checking for file existence"
20881 If the attempt to open the file fails with a &"does not exist"& error, Exim
20882 runs a check on the containing directory,
20883 unless &%ignore_enotdir%& is true (see below).
20884 If the directory does not appear to exist, delivery is deferred. This can
20885 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20886 is a mount problem. If the containing directory does exist, but the file does
20887 not, the router declines.
20888
20889
20890 .option file_transport redirect string&!! unset
20891 .vindex "&$address_file$&"
20892 A &(redirect)& router sets up a direct delivery to a file when a path name not
20893 ending in a slash is specified as a new &"address"&. The transport used is
20894 specified by this option, which, after expansion, must be the name of a
20895 configured transport. This should normally be an &(appendfile)& transport. When
20896 it is running, the filename is in &$address_file$&.
20897
20898
20899 .option filter_prepend_home redirect boolean true
20900 When this option is true, if a &(save)& command in an Exim filter specifies a
20901 relative path, and &$home$& is defined, it is automatically prepended to the
20902 relative path. If this option is set false, this action does not happen. The
20903 relative path is then passed to the transport unmodified.
20904
20905
20906 .option forbid_blackhole redirect boolean false
20907 .cindex "restricting access to features"
20908 .cindex "filter" "locking out certain features"
20909 If this option is true, the &':blackhole:'& item may not appear in a
20910 redirection list.
20911
20912
20913 .option forbid_exim_filter redirect boolean false
20914 .cindex "restricting access to features"
20915 .cindex "filter" "locking out certain features"
20916 If this option is set true, only Sieve filters are permitted when
20917 &%allow_filter%& is true.
20918
20919
20920
20921
20922 .option forbid_file redirect boolean false
20923 .cindex "restricting access to features"
20924 .cindex "delivery" "to file; forbidding"
20925 .cindex "filter" "locking out certain features"
20926 .cindex "Sieve filter" "forbidding delivery to a file"
20927 .cindex "Sieve filter" "&""keep""& facility; disabling"
20928 If this option is true, this router may not generate a new address that
20929 specifies delivery to a local file or directory, either from a filter or from a
20930 conventional forward file. This option is forced to be true if &%one_time%& is
20931 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20932 locks out the Sieve's &"keep"& facility.
20933
20934
20935 .option forbid_filter_dlfunc redirect boolean false
20936 .cindex "restricting access to features"
20937 .cindex "filter" "locking out certain features"
20938 If this option is true, string expansions in Exim filters are not allowed to
20939 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20940 functions.
20941
20942 .option forbid_filter_existstest redirect boolean false
20943 .cindex "restricting access to features"
20944 .cindex "filter" "locking out certain features"
20945 .cindex "expansion" "statting a file"
20946 If this option is true, string expansions in Exim filters are not allowed to
20947 make use of the &%exists%& condition or the &%stat%& expansion item.
20948
20949 .option forbid_filter_logwrite redirect boolean false
20950 .cindex "restricting access to features"
20951 .cindex "filter" "locking out certain features"
20952 If this option is true, use of the logging facility in Exim filters is not
20953 permitted. Logging is in any case available only if the filter is being run
20954 under some unprivileged uid (which is normally the case for ordinary users'
20955 &_.forward_& files).
20956
20957
20958 .option forbid_filter_lookup redirect boolean false
20959 .cindex "restricting access to features"
20960 .cindex "filter" "locking out certain features"
20961 If this option is true, string expansions in Exim filter files are not allowed
20962 to make use of &%lookup%& items.
20963
20964
20965 .option forbid_filter_perl redirect boolean false
20966 .cindex "restricting access to features"
20967 .cindex "filter" "locking out certain features"
20968 This option has an effect only if Exim is built with embedded Perl support. If
20969 it is true, string expansions in Exim filter files are not allowed to make use
20970 of the embedded Perl support.
20971
20972
20973 .option forbid_filter_readfile redirect boolean false
20974 .cindex "restricting access to features"
20975 .cindex "filter" "locking out certain features"
20976 If this option is true, string expansions in Exim filter files are not allowed
20977 to make use of &%readfile%& items.
20978
20979
20980 .option forbid_filter_readsocket redirect boolean false
20981 .cindex "restricting access to features"
20982 .cindex "filter" "locking out certain features"
20983 If this option is true, string expansions in Exim filter files are not allowed
20984 to make use of &%readsocket%& items.
20985
20986
20987 .option forbid_filter_reply redirect boolean false
20988 .cindex "restricting access to features"
20989 .cindex "filter" "locking out certain features"
20990 If this option is true, this router may not generate an automatic reply
20991 message. Automatic replies can be generated only from Exim or Sieve filter
20992 files, not from traditional forward files. This option is forced to be true if
20993 &%one_time%& is set.
20994
20995
20996 .option forbid_filter_run redirect boolean false
20997 .cindex "restricting access to features"
20998 .cindex "filter" "locking out certain features"
20999 If this option is true, string expansions in Exim filter files are not allowed
21000 to make use of &%run%& items.
21001
21002
21003 .option forbid_include redirect boolean false
21004 .cindex "restricting access to features"
21005 .cindex "filter" "locking out certain features"
21006 If this option is true, items of the form
21007 .code
21008 :include:<path name>
21009 .endd
21010 are not permitted in non-filter redirection lists.
21011
21012
21013 .option forbid_pipe redirect boolean false
21014 .cindex "restricting access to features"
21015 .cindex "filter" "locking out certain features"
21016 .cindex "delivery" "to pipe; forbidding"
21017 If this option is true, this router may not generate a new address which
21018 specifies delivery to a pipe, either from an Exim filter or from a conventional
21019 forward file. This option is forced to be true if &%one_time%& is set.
21020
21021
21022 .option forbid_sieve_filter redirect boolean false
21023 .cindex "restricting access to features"
21024 .cindex "filter" "locking out certain features"
21025 If this option is set true, only Exim filters are permitted when
21026 &%allow_filter%& is true.
21027
21028
21029 .cindex "SMTP" "error codes"
21030 .option forbid_smtp_code redirect boolean false
21031 If this option is set true, any SMTP error codes that are present at the start
21032 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21033 the default codes (451 and 550, respectively) are always used.
21034
21035
21036
21037
21038 .option hide_child_in_errmsg redirect boolean false
21039 .cindex "bounce message" "redirection details; suppressing"
21040 If this option is true, it prevents Exim from quoting a child address if it
21041 generates a bounce or delay message for it. Instead it says &"an address
21042 generated from <&'the top level address'&>"&. Of course, this applies only to
21043 bounces generated locally. If a message is forwarded to another host, &'its'&
21044 bounce may well quote the generated address.
21045
21046
21047 .option ignore_eacces redirect boolean false
21048 .cindex "EACCES"
21049 If this option is set and an attempt to open a redirection file yields the
21050 EACCES error (permission denied), the &(redirect)& router behaves as if the
21051 file did not exist.
21052
21053
21054 .option ignore_enotdir redirect boolean false
21055 .cindex "ENOTDIR"
21056 If this option is set and an attempt to open a redirection file yields the
21057 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21058 router behaves as if the file did not exist.
21059
21060 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21061 router that has the &%file%& option set discovers that the file does not exist
21062 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21063 against unmounted NFS directories. If the parent can not be statted, delivery
21064 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21065 is set, because that option tells Exim to ignore &"something on the path is not
21066 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21067 that some operating systems give ENOENT where others give ENOTDIR.
21068
21069
21070
21071 .option include_directory redirect string unset
21072 If this option is set, the path names of any &':include:'& items in a
21073 redirection list must start with this directory.
21074
21075
21076 .option modemask redirect "octal integer" 022
21077 This specifies mode bits which must not be set for a file specified by the
21078 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21079
21080
21081 .option one_time redirect boolean false
21082 .cindex "one-time aliasing/forwarding expansion"
21083 .cindex "alias file" "one-time expansion"
21084 .cindex "forward file" "one-time expansion"
21085 .cindex "mailing lists" "one-time expansion"
21086 .cindex "address redirection" "one-time expansion"
21087 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21088 files each time it tries to deliver a message causes a problem when one or more
21089 of the generated addresses fails be delivered at the first attempt. The problem
21090 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21091 but of what happens when the redirection list changes during the time that the
21092 message is on Exim's queue. This is particularly true in the case of mailing
21093 lists, where new subscribers might receive copies of messages that were posted
21094 before they subscribed.
21095
21096 If &%one_time%& is set and any addresses generated by the router fail to
21097 deliver at the first attempt, the failing addresses are added to the message as
21098 &"top level"& addresses, and the parent address that generated them is marked
21099 &"delivered"&. Thus, redirection does not happen again at the next delivery
21100 attempt.
21101
21102 &*Warning 1*&: Any header line addition or removal that is specified by this
21103 router would be lost if delivery did not succeed at the first attempt. For this
21104 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21105 permitted when &%one_time%& is set.
21106
21107 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21108 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21109 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21110
21111 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21112 &%one_time%&.
21113
21114 The original top-level address is remembered with each of the generated
21115 addresses, and is output in any log messages. However, any intermediate parent
21116 addresses are not recorded. This makes a difference to the log only if
21117 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21118 typically be used for mailing lists, where there is normally just one level of
21119 expansion.
21120
21121
21122 .option owners redirect "string list" unset
21123 .cindex "ownership" "alias file"
21124 .cindex "ownership" "forward file"
21125 .cindex "alias file" "ownership"
21126 .cindex "forward file" "ownership"
21127 This specifies a list of permitted owners for the file specified by &%file%&.
21128 This list is in addition to the local user when &%check_local_user%& is set.
21129 See &%check_owner%& above.
21130
21131
21132 .option owngroups redirect "string list" unset
21133 This specifies a list of permitted groups for the file specified by &%file%&.
21134 The list is in addition to the local user's primary group when
21135 &%check_local_user%& is set. See &%check_group%& above.
21136
21137
21138 .option pipe_transport redirect string&!! unset
21139 .vindex "&$address_pipe$&"
21140 A &(redirect)& router sets up a direct delivery to a pipe when a string
21141 starting with a vertical bar character is specified as a new &"address"&. The
21142 transport used is specified by this option, which, after expansion, must be the
21143 name of a configured transport. This should normally be a &(pipe)& transport.
21144 When the transport is run, the pipe command is in &$address_pipe$&.
21145
21146
21147 .option qualify_domain redirect string&!! unset
21148 .vindex "&$qualify_recipient$&"
21149 If this option is set, and an unqualified address (one without a domain) is
21150 generated, and that address would normally be qualified by the global setting
21151 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21152 expanding this string. If the expansion fails, the router declines. If you want
21153 to revert to the default, you can have the expansion generate
21154 &$qualify_recipient$&.
21155
21156 This option applies to all unqualified addresses generated by Exim filters,
21157 but for traditional &_.forward_& files, it applies only to addresses that are
21158 not preceded by a backslash. Sieve filters cannot generate unqualified
21159 addresses.
21160
21161 .option qualify_preserve_domain redirect boolean false
21162 .cindex "domain" "in redirection; preserving"
21163 .cindex "preserving domain in redirection"
21164 .cindex "address redirection" "domain; preserving"
21165 If this option is set, the router's local &%qualify_domain%& option must not be
21166 set (a configuration error occurs if it is). If an unqualified address (one
21167 without a domain) is generated, it is qualified with the domain of the parent
21168 address (the immediately preceding ancestor) instead of the global
21169 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21170 this applies whether or not the address is preceded by a backslash.
21171
21172
21173 .option repeat_use redirect boolean true
21174 If this option is set false, the router is skipped for a child address that has
21175 any ancestor that was routed by this router. This test happens before any of
21176 the other preconditions are tested. Exim's default anti-looping rules skip
21177 only when the ancestor is the same as the current address. See also
21178 &%check_ancestor%& above and the generic &%redirect_router%& option.
21179
21180
21181 .option reply_transport redirect string&!! unset
21182 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21183 &%vacation%& command is used in a filter file. The transport used is specified
21184 by this option, which, after expansion, must be the name of a configured
21185 transport. This should normally be an &(autoreply)& transport. Other transports
21186 are unlikely to do anything sensible or useful.
21187
21188
21189 .option rewrite redirect boolean true
21190 .cindex "address redirection" "disabling rewriting"
21191 If this option is set false, addresses generated by the router are not
21192 subject to address rewriting. Otherwise, they are treated like new addresses
21193 and are rewritten according to the global rewriting rules.
21194
21195
21196 .option sieve_subaddress redirect string&!! unset
21197 The value of this option is passed to a Sieve filter to specify the
21198 :subaddress part of an address.
21199
21200 .option sieve_useraddress redirect string&!! unset
21201 The value of this option is passed to a Sieve filter to specify the :user part
21202 of an address. However, if it is unset, the entire original local part
21203 (including any prefix or suffix) is used for :user.
21204
21205
21206 .option sieve_vacation_directory redirect string&!! unset
21207 .cindex "Sieve filter" "vacation directory"
21208 To enable the &"vacation"& extension for Sieve filters, you must set
21209 &%sieve_vacation_directory%& to the directory where vacation databases are held
21210 (do not put anything else in that directory), and ensure that the
21211 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21212 needs their own directory; Exim will create it if necessary.
21213
21214
21215
21216 .option skip_syntax_errors redirect boolean false
21217 .cindex "forward file" "broken"
21218 .cindex "address redirection" "broken files"
21219 .cindex "alias file" "broken"
21220 .cindex "broken alias or forward files"
21221 .cindex "ignoring faulty addresses"
21222 .cindex "skipping faulty addresses"
21223 .cindex "error" "skipping bad syntax"
21224 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21225 non-filter redirection data are skipped, and each failing address is logged. If
21226 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21227 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21228 are expanded and placed at the head of the error message generated by
21229 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21230 be the same address as the generic &%errors_to%& option. The
21231 &%skip_syntax_errors%& option is often used when handling mailing lists.
21232
21233 If all the addresses in a redirection list are skipped because of syntax
21234 errors, the router declines to handle the original address, and it is passed to
21235 the following routers.
21236
21237 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21238 error in the filter causes filtering to be abandoned without any action being
21239 taken. The incident is logged, and the router declines to handle the address,
21240 so it is passed to the following routers.
21241
21242 .cindex "Sieve filter" "syntax errors in"
21243 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21244 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21245 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21246
21247 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21248 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21249 option, used with an address that does not get redirected, can be used to
21250 notify users of these errors, by means of a router like this:
21251 .code
21252 userforward:
21253   driver = redirect
21254   allow_filter
21255   check_local_user
21256   file = $home/.forward
21257   file_transport = address_file
21258   pipe_transport = address_pipe
21259   reply_transport = address_reply
21260   no_verify
21261   skip_syntax_errors
21262   syntax_errors_to = real-$local_part@$domain
21263   syntax_errors_text = \
21264    This is an automatically generated message. An error has\n\
21265    been found in your .forward file. Details of the error are\n\
21266    reported below. While this error persists, you will receive\n\
21267    a copy of this message for every message that is addressed\n\
21268    to you. If your .forward file is a filter file, or if it is\n\
21269    a non-filter file containing no valid forwarding addresses,\n\
21270    a copy of each incoming message will be put in your normal\n\
21271    mailbox. If a non-filter file contains at least one valid\n\
21272    forwarding address, forwarding to the valid addresses will\n\
21273    happen, and those will be the only deliveries that occur.
21274 .endd
21275 You also need a router to ensure that local addresses that are prefixed by
21276 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21277 put this immediately before the &(userforward)& router:
21278 .code
21279 real_localuser:
21280   driver = accept
21281   check_local_user
21282   local_part_prefix = real-
21283   transport = local_delivery
21284 .endd
21285 For security, it would probably be a good idea to restrict the use of this
21286 router to locally-generated messages, using a condition such as this:
21287 .code
21288   condition = ${if match {$sender_host_address}\
21289                          {\N^(|127\.0\.0\.1)$\N}}
21290 .endd
21291
21292
21293 .option syntax_errors_text redirect string&!! unset
21294 See &%skip_syntax_errors%& above.
21295
21296
21297 .option syntax_errors_to redirect string unset
21298 See &%skip_syntax_errors%& above.
21299 .ecindex IIDredrou1
21300 .ecindex IIDredrou2
21301
21302
21303
21304
21305
21306
21307 . ////////////////////////////////////////////////////////////////////////////
21308 . ////////////////////////////////////////////////////////////////////////////
21309
21310 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21311          "Environment for local transports"
21312 .scindex IIDenvlotra1 "local transports" "environment for"
21313 .scindex IIDenvlotra2 "environment" "local transports"
21314 .scindex IIDenvlotra3 "transport" "local; environment for"
21315 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21316 transport can be thought of as similar to a pipe.) Exim always runs transports
21317 in subprocesses, under specified uids and gids. Typical deliveries to local
21318 mailboxes run under the uid and gid of the local user.
21319
21320 Exim also sets a specific current directory while running the transport; for
21321 some transports a home directory setting is also relevant. The &(pipe)&
21322 transport is the only one that sets up environment variables; see section
21323 &<<SECTpipeenv>>& for details.
21324
21325 The values used for the uid, gid, and the directories may come from several
21326 different places. In many cases, the router that handles the address associates
21327 settings with that address as a result of its &%check_local_user%&, &%group%&,
21328 or &%user%& options. However, values may also be given in the transport's own
21329 configuration, and these override anything that comes from the router.
21330
21331
21332
21333 .section "Concurrent deliveries" "SECID131"
21334 .cindex "concurrent deliveries"
21335 .cindex "simultaneous deliveries"
21336 If two different messages for the same local recipient arrive more or less
21337 simultaneously, the two delivery processes are likely to run concurrently. When
21338 the &(appendfile)& transport is used to write to a file, Exim applies locking
21339 rules to stop concurrent processes from writing to the same file at the same
21340 time.
21341
21342 However, when you use a &(pipe)& transport, it is up to you to arrange any
21343 locking that is needed. Here is a silly example:
21344 .code
21345 my_transport:
21346   driver = pipe
21347   command = /bin/sh -c 'cat >>/some/file'
21348 .endd
21349 This is supposed to write the message at the end of the file. However, if two
21350 messages arrive at the same time, the file will be scrambled. You can use the
21351 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21352 file using the same algorithm that Exim itself uses.
21353
21354
21355
21356
21357 .section "Uids and gids" "SECTenvuidgid"
21358 .cindex "local transports" "uid and gid"
21359 .cindex "transport" "local; uid and gid"
21360 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21361 overrides any group that the router set in the address, even if &%user%& is not
21362 set for the transport. This makes it possible, for example, to run local mail
21363 delivery under the uid of the recipient (set by the router), but in a special
21364 group (set by the transport). For example:
21365 .code
21366 # Routers ...
21367 # User/group are set by check_local_user in this router
21368 local_users:
21369   driver = accept
21370   check_local_user
21371   transport = group_delivery
21372
21373 # Transports ...
21374 # This transport overrides the group
21375 group_delivery:
21376   driver = appendfile
21377   file = /var/spool/mail/$local_part
21378   group = mail
21379 .endd
21380 If &%user%& is set for a transport, its value overrides what is set in the
21381 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21382 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21383 set.
21384
21385 .oindex "&%initgroups%&"
21386 When the uid is taken from the transport's configuration, the &[initgroups()]&
21387 function is called for the groups associated with that uid if the
21388 &%initgroups%& option is set for the transport. When the uid is not specified
21389 by the transport, but is associated with the address by a router, the option
21390 for calling &[initgroups()]& is taken from the router configuration.
21391
21392 .cindex "&(pipe)& transport" "uid for"
21393 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21394 is set and &%user%& is not set, the uid of the process that called Exim to
21395 receive the message is used, and if &%group%& is not set, the corresponding
21396 original gid is also used.
21397
21398 This is the detailed preference order for obtaining a gid; the first of the
21399 following that is set is used:
21400
21401 .ilist
21402 A &%group%& setting of the transport;
21403 .next
21404 A &%group%& setting of the router;
21405 .next
21406 A gid associated with a user setting of the router, either as a result of
21407 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21408 .next
21409 The group associated with a non-numeric &%user%& setting of the transport;
21410 .next
21411 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21412 the uid is the creator's uid;
21413 .next
21414 The Exim gid if the Exim uid is being used as a default.
21415 .endlist
21416
21417 If, for example, the user is specified numerically on the router and there are
21418 no group settings, no gid is available. In this situation, an error occurs.
21419 This is different for the uid, for which there always is an ultimate default.
21420 The first of the following that is set is used:
21421
21422 .ilist
21423 A &%user%& setting of the transport;
21424 .next
21425 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21426 .next
21427 A &%user%& setting of the router;
21428 .next
21429 A &%check_local_user%& setting of the router;
21430 .next
21431 The Exim uid.
21432 .endlist
21433
21434 Of course, an error will still occur if the uid that is chosen is on the
21435 &%never_users%& list.
21436
21437
21438
21439
21440
21441 .section "Current and home directories" "SECID132"
21442 .cindex "current directory for local transport"
21443 .cindex "home directory" "for local transport"
21444 .cindex "transport" "local; home directory for"
21445 .cindex "transport" "local; current directory for"
21446 Routers may set current and home directories for local transports by means of
21447 the &%transport_current_directory%& and &%transport_home_directory%& options.
21448 However, if the transport's &%current_directory%& or &%home_directory%& options
21449 are set, they override the router's values. In detail, the home directory
21450 for a local transport is taken from the first of these values that is set:
21451
21452 .ilist
21453 The &%home_directory%& option on the transport;
21454 .next
21455 The &%transport_home_directory%& option on the router;
21456 .next
21457 The password data if &%check_local_user%& is set on the router;
21458 .next
21459 The &%router_home_directory%& option on the router.
21460 .endlist
21461
21462 The current directory is taken from the first of these values that is set:
21463
21464 .ilist
21465 The &%current_directory%& option on the transport;
21466 .next
21467 The &%transport_current_directory%& option on the router.
21468 .endlist
21469
21470
21471 If neither the router nor the transport sets a current directory, Exim uses the
21472 value of the home directory, if it is set. Otherwise it sets the current
21473 directory to &_/_& before running a local transport.
21474
21475
21476
21477 .section "Expansion variables derived from the address" "SECID133"
21478 .vindex "&$domain$&"
21479 .vindex "&$local_part$&"
21480 .vindex "&$original_domain$&"
21481 Normally a local delivery is handling a single address, and in that case the
21482 variables such as &$domain$& and &$local_part$& are set during local
21483 deliveries. However, in some circumstances more than one address may be handled
21484 at once (for example, while writing batch SMTP for onward transmission by some
21485 other means). In this case, the variables associated with the local part are
21486 never set, &$domain$& is set only if all the addresses have the same domain,
21487 and &$original_domain$& is never set.
21488 .ecindex IIDenvlotra1
21489 .ecindex IIDenvlotra2
21490 .ecindex IIDenvlotra3
21491
21492
21493
21494
21495
21496
21497
21498 . ////////////////////////////////////////////////////////////////////////////
21499 . ////////////////////////////////////////////////////////////////////////////
21500
21501 .chapter "Generic options for transports" "CHAPtransportgeneric"
21502 .scindex IIDgenoptra1 "generic options" "transport"
21503 .scindex IIDgenoptra2 "options" "generic; for transports"
21504 .scindex IIDgenoptra3 "transport" "generic options for"
21505 The following generic options apply to all transports:
21506
21507
21508 .option body_only transports boolean false
21509 .cindex "transport" "body only"
21510 .cindex "message" "transporting body only"
21511 .cindex "body of message" "transporting"
21512 If this option is set, the message's headers are not transported. It is
21513 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21514 or &(pipe)& transports, the settings of &%message_prefix%& and
21515 &%message_suffix%& should be checked, because this option does not
21516 automatically suppress them.
21517
21518
21519 .option current_directory transports string&!! unset
21520 .cindex "transport" "current directory for"
21521 This specifies the current directory that is to be set while running the
21522 transport, overriding any value that may have been set by the router.
21523 If the expansion fails for any reason, including forced failure, an error is
21524 logged, and delivery is deferred.
21525
21526
21527 .option disable_logging transports boolean false
21528 If this option is set true, nothing is logged for any
21529 deliveries by the transport or for any
21530 transport errors. You should not set this option unless you really, really know
21531 what you are doing.
21532
21533
21534 .option debug_print transports string&!! unset
21535 .cindex "testing" "variables in drivers"
21536 If this option is set and debugging is enabled (see the &%-d%& command line
21537 option), the string is expanded and included in the debugging output when the
21538 transport is run.
21539 If expansion of the string fails, the error message is written to the debugging
21540 output, and Exim carries on processing.
21541 This facility is provided to help with checking out the values of variables and
21542 so on when debugging driver configurations. For example, if a &%headers_add%&
21543 option is not working properly, &%debug_print%& could be used to output the
21544 variables it references. A newline is added to the text if it does not end with
21545 one.
21546 The variables &$transport_name$& and &$router_name$& contain the name of the
21547 transport and the router that called it.
21548
21549 .option delivery_date_add transports boolean false
21550 .cindex "&'Delivery-date:'& header line"
21551 If this option is true, a &'Delivery-date:'& header is added to the message.
21552 This gives the actual time the delivery was made. As this is not a standard
21553 header, Exim has a configuration option (&%delivery_date_remove%&) which
21554 requests its removal from incoming messages, so that delivered messages can
21555 safely be resent to other recipients.
21556
21557
21558 .option driver transports string unset
21559 This specifies which of the available transport drivers is to be used.
21560 There is no default, and this option must be set for every transport.
21561
21562
21563 .option envelope_to_add transports boolean false
21564 .cindex "&'Envelope-to:'& header line"
21565 If this option is true, an &'Envelope-to:'& header is added to the message.
21566 This gives the original address(es) in the incoming envelope that caused this
21567 delivery to happen. More than one address may be present if the transport is
21568 configured to handle several addresses at once, or if more than one original
21569 address was redirected to the same final address. As this is not a standard
21570 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21571 its removal from incoming messages, so that delivered messages can safely be
21572 resent to other recipients.
21573
21574
21575 .option event_action transports string&!! unset
21576 .cindex events
21577 This option declares a string to be expanded for Exim's events mechanism.
21578 For details see chapter &<<CHAPevents>>&.
21579
21580
21581 .option group transports string&!! "Exim group"
21582 .cindex "transport" "group; specifying"
21583 This option specifies a gid for running the transport process, overriding any
21584 value that the router supplies, and also overriding any value associated with
21585 &%user%& (see below).
21586
21587
21588 .option headers_add transports list&!! unset
21589 .cindex "header lines" "adding in transport"
21590 .cindex "transport" "header lines; adding"
21591 This option specifies a list of text headers,
21592 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21593 which are (separately) expanded and added to the header
21594 portion of a message as it is transported, as described in section
21595 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21596 routers. If the result of the expansion is an empty string, or if the expansion
21597 is forced to fail, no action is taken. Other expansion failures are treated as
21598 errors and cause the delivery to be deferred.
21599
21600 Unlike most options, &%headers_add%& can be specified multiple times
21601 for a transport; all listed headers are added.
21602
21603
21604 .option headers_only transports boolean false
21605 .cindex "transport" "header lines only"
21606 .cindex "message" "transporting headers only"
21607 .cindex "header lines" "transporting"
21608 If this option is set, the message's body is not transported. It is mutually
21609 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21610 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21611 checked, since this option does not automatically suppress them.
21612
21613
21614 .option headers_remove transports list&!! unset
21615 .cindex "header lines" "removing"
21616 .cindex "transport" "header lines; removing"
21617 This option specifies a list of header names,
21618 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21619 these headers are omitted from the message as it is transported, as described
21620 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21621 routers.
21622 Each list item is separately expanded.
21623 If the result of the expansion is an empty string, or if the expansion
21624 is forced to fail, no action is taken. Other expansion failures are treated as
21625 errors and cause the delivery to be deferred.
21626
21627 Unlike most options, &%headers_remove%& can be specified multiple times
21628 for a transport; all listed headers are removed.
21629
21630 &*Warning*&: Because of the separate expansion of the list items,
21631 items that contain a list separator must have it doubled.
21632 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21633
21634
21635
21636 .option headers_rewrite transports string unset
21637 .cindex "transport" "header lines; rewriting"
21638 .cindex "rewriting" "at transport time"
21639 This option allows addresses in header lines to be rewritten at transport time,
21640 that is, as the message is being copied to its destination. The contents of the
21641 option are a colon-separated list of rewriting rules. Each rule is in exactly
21642 the same form as one of the general rewriting rules that are applied when a
21643 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21644 example,
21645 .code
21646 headers_rewrite = a@b c@d f : \
21647                   x@y w@z
21648 .endd
21649 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21650 &'w@z'& in all address-bearing header lines. The rules are applied to the
21651 header lines just before they are written out at transport time, so they affect
21652 only those copies of the message that pass through the transport. However, only
21653 the message's original header lines, and any that were added by a system
21654 filter, are rewritten. If a router or transport adds header lines, they are not
21655 affected by this option. These rewriting rules are &'not'& applied to the
21656 envelope. You can change the return path using &%return_path%&, but you cannot
21657 change envelope recipients at this time.
21658
21659
21660 .option home_directory transports string&!! unset
21661 .cindex "transport" "home directory for"
21662 .vindex "&$home$&"
21663 This option specifies a home directory setting for a local transport,
21664 overriding any value that may be set by the router. The home directory is
21665 placed in &$home$& while expanding the transport's private options. It is also
21666 used as the current directory if no current directory is set by the
21667 &%current_directory%& option on the transport or the
21668 &%transport_current_directory%& option on the router. If the expansion fails
21669 for any reason, including forced failure, an error is logged, and delivery is
21670 deferred.
21671
21672
21673 .option initgroups transports boolean false
21674 .cindex "additional groups"
21675 .cindex "groups" "additional"
21676 .cindex "transport" "group; additional"
21677 If this option is true and the uid for the delivery process is provided by the
21678 transport, the &[initgroups()]& function is called when running the transport
21679 to ensure that any additional groups associated with the uid are set up.
21680
21681
21682 .option max_parallel transports integer&!! unset
21683 .cindex limit "transport parallelism"
21684 .cindex transport "parallel processes"
21685 .cindex transport "concurrency limit"
21686 .cindex "delivery" "parallelism for transport"
21687 If this option is set and expands to an integer greater than zero
21688 it limits the number of concurrent runs of the transport.
21689 The control does not apply to shadow transports.
21690
21691 .cindex "hints database" "transport concurrency control"
21692 Exim implements this control by means of a hints database in which a record is
21693 incremented whenever a transport process is being created. The record
21694 is decremented and possibly removed when the process terminates.
21695 Obviously there is scope for
21696 records to get left lying around if there is a system or program crash. To
21697 guard against this, Exim ignores any records that are more than six hours old.
21698
21699 If you use this option, you should also arrange to delete the
21700 relevant hints database whenever your system reboots. The names of the files
21701 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21702 may be one or two files, depending on the type of DBM in use. The same files
21703 are used for ETRN and smtp transport serialization.
21704
21705
21706 .option message_size_limit transports string&!! 0
21707 .cindex "limit" "message size per transport"
21708 .cindex "size" "of message, limit"
21709 .cindex "transport" "message size; limiting"
21710 This option controls the size of messages passed through the transport. It is
21711 expanded before use; the result of the expansion must be a sequence of decimal
21712 digits, optionally followed by K or M. If the expansion fails for any reason,
21713 including forced failure, or if the result is not of the required form,
21714 delivery is deferred. If the value is greater than zero and the size of a
21715 message exceeds this limit, the address is failed. If there is any chance that
21716 the resulting bounce message could be routed to the same transport, you should
21717 ensure that &%return_size_limit%& is less than the transport's
21718 &%message_size_limit%&, as otherwise the bounce message will fail to get
21719 delivered.
21720
21721
21722
21723 .option rcpt_include_affixes transports boolean false
21724 .cindex "prefix" "for local part, including in envelope"
21725 .cindex "suffix for local part" "including in envelope"
21726 .cindex "local part" "prefix"
21727 .cindex "local part" "suffix"
21728 When this option is false (the default), and an address that has had any
21729 affixes (prefixes or suffixes) removed from the local part is delivered by any
21730 form of SMTP or LMTP, the affixes are not included. For example, if a router
21731 that contains
21732 .code
21733 local_part_prefix = *-
21734 .endd
21735 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21736 is delivered with
21737 .code
21738 RCPT TO:<xyz@some.domain>
21739 .endd
21740 This is also the case when an ACL-time callout is being used to verify a
21741 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21742 whole local part is included in the RCPT command. This option applies to BSMTP
21743 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21744 &(lmtp)& and &(smtp)& transports.
21745
21746
21747 .option retry_use_local_part transports boolean "see below"
21748 .cindex "hints database" "retry keys"
21749 When a delivery suffers a temporary failure, a retry record is created
21750 in Exim's hints database. For remote deliveries, the key for the retry record
21751 is based on the name and/or IP address of the failing remote host. For local
21752 deliveries, the key is normally the entire address, including both the local
21753 part and the domain. This is suitable for most common cases of local delivery
21754 temporary failure &-- for example, exceeding a mailbox quota should delay only
21755 deliveries to that mailbox, not to the whole domain.
21756
21757 However, in some special cases you may want to treat a temporary local delivery
21758 as a failure associated with the domain, and not with a particular local part.
21759 (For example, if you are storing all mail for some domain in files.) You can do
21760 this by setting &%retry_use_local_part%& false.
21761
21762 For all the local transports, its default value is true. For remote transports,
21763 the default value is false for tidiness, but changing the value has no effect
21764 on a remote transport in the current implementation.
21765
21766
21767 .option return_path transports string&!! unset
21768 .cindex "envelope sender"
21769 .cindex "transport" "return path; changing"
21770 .cindex "return path" "changing in transport"
21771 If this option is set, the string is expanded at transport time and replaces
21772 the existing return path (envelope sender) value in the copy of the message
21773 that is being delivered. An empty return path is permitted. This feature is
21774 designed for remote deliveries, where the value of this option is used in the
21775 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21776 only effect is to change the address that is placed in the &'Return-path:'&
21777 header line, if one is added to the message (see the next option).
21778
21779 &*Note:*& A changed return path is not logged unless you add
21780 &%return_path_on_delivery%& to the log selector.
21781
21782 .vindex "&$return_path$&"
21783 The expansion can refer to the existing value via &$return_path$&. This is
21784 either the message's envelope sender, or an address set by the
21785 &%errors_to%& option on a router. If the expansion is forced to fail, no
21786 replacement occurs; if it fails for another reason, delivery is deferred. This
21787 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21788 section &<<SECTverp>>&.
21789
21790 &*Note*&: If a delivery error is detected locally, including the case when a
21791 remote server rejects a message at SMTP time, the bounce message is not sent to
21792 the value of this option. It is sent to the previously set errors address.
21793 This defaults to the incoming sender address, but can be changed by setting
21794 &%errors_to%& in a router.
21795
21796
21797
21798 .option return_path_add transports boolean false
21799 .cindex "&'Return-path:'& header line"
21800 If this option is true, a &'Return-path:'& header is added to the message.
21801 Although the return path is normally available in the prefix line of BSD
21802 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21803 have easy access to it.
21804
21805 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21806 the delivery SMTP server makes the final delivery"&. This implies that this
21807 header should not be present in incoming messages. Exim has a configuration
21808 option, &%return_path_remove%&, which requests removal of this header from
21809 incoming messages, so that delivered messages can safely be resent to other
21810 recipients.
21811
21812
21813 .option shadow_condition transports string&!! unset
21814 See &%shadow_transport%& below.
21815
21816
21817 .option shadow_transport transports string unset
21818 .cindex "shadow transport"
21819 .cindex "transport" "shadow"
21820 A local transport may set the &%shadow_transport%& option to the name of
21821 another local transport. Shadow remote transports are not supported.
21822
21823 Whenever a delivery to the main transport succeeds, and either
21824 &%shadow_condition%& is unset, or its expansion does not result in the empty
21825 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21826 passed to the shadow transport, with the same delivery address or addresses. If
21827 expansion fails, no action is taken except that non-forced expansion failures
21828 cause a log line to be written.
21829
21830 The result of the shadow transport is discarded and does not affect the
21831 subsequent processing of the message. Only a single level of shadowing is
21832 provided; the &%shadow_transport%& option is ignored on any transport when it
21833 is running as a shadow. Options concerned with output from pipes are also
21834 ignored. The log line for the successful delivery has an item added on the end,
21835 of the form
21836 .code
21837 ST=<shadow transport name>
21838 .endd
21839 If the shadow transport did not succeed, the error message is put in
21840 parentheses afterwards. Shadow transports can be used for a number of different
21841 purposes, including keeping more detailed log information than Exim normally
21842 provides, and implementing automatic acknowledgment policies based on message
21843 headers that some sites insist on.
21844
21845
21846 .option transport_filter transports string&!! unset
21847 .cindex "transport" "filter"
21848 .cindex "filter" "transport filter"
21849 This option sets up a filtering (in the Unix shell sense) process for messages
21850 at transport time. It should not be confused with mail filtering as set up by
21851 individual users or via a system filter.
21852 If unset, or expanding to an empty string, no filtering is done.
21853
21854 When the message is about to be written out, the command specified by
21855 &%transport_filter%& is started up in a separate, parallel process, and
21856 the entire message, including the header lines, is passed to it on its standard
21857 input (this in fact is done from a third process, to avoid deadlock). The
21858 command must be specified as an absolute path.
21859
21860 The lines of the message that are written to the transport filter are
21861 terminated by newline (&"\n"&). The message is passed to the filter before any
21862 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21863 lines beginning with a dot, and also before any processing implied by the
21864 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21865 &(pipe)& transports.
21866
21867 The standard error for the filter process is set to the same destination as its
21868 standard output; this is read and written to the message's ultimate
21869 destination. The process that writes the message to the filter, the
21870 filter itself, and the original process that reads the result and delivers it
21871 are all run in parallel, like a shell pipeline.
21872
21873 The filter can perform any transformations it likes, but of course should take
21874 care not to break RFC 2822 syntax. Exim does not check the result, except to
21875 test for a final newline when SMTP is in use. All messages transmitted over
21876 SMTP must end with a newline, so Exim supplies one if it is missing.
21877
21878 .cindex "content scanning" "per user"
21879 A transport filter can be used to provide content-scanning on a per-user basis
21880 at delivery time if the only required effect of the scan is to modify the
21881 message. For example, a content scan could insert a new header line containing
21882 a spam score. This could be interpreted by a filter in the user's MUA. It is
21883 not possible to discard a message at this stage.
21884
21885 .cindex "SMTP" "SIZE"
21886 A problem might arise if the filter increases the size of a message that is
21887 being sent down an SMTP connection. If the receiving SMTP server has indicated
21888 support for the SIZE parameter, Exim will have sent the size of the message
21889 at the start of the SMTP session. If what is actually sent is substantially
21890 more, the server might reject the message. This can be worked round by setting
21891 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21892 additions to the message, or to disable the use of SIZE altogether.
21893
21894 .vindex "&$pipe_addresses$&"
21895 The value of the &%transport_filter%& option is the command string for starting
21896 the filter, which is run directly from Exim, not under a shell. The string is
21897 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21898 Exim breaks it up into arguments and then expands each argument separately (see
21899 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21900 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21901 of arguments, one for each address that applies to this delivery. (This isn't
21902 an ideal name for this feature here, but as it was already implemented for the
21903 &(pipe)& transport, it seemed sensible not to change it.)
21904
21905 .vindex "&$host$&"
21906 .vindex "&$host_address$&"
21907 The expansion variables &$host$& and &$host_address$& are available when the
21908 transport is a remote one. They contain the name and IP address of the host to
21909 which the message is being sent. For example:
21910 .code
21911 transport_filter = /some/directory/transport-filter.pl \
21912   $host $host_address $sender_address $pipe_addresses
21913 .endd
21914
21915 Two problems arise if you want to use more complicated expansion items to
21916 generate transport filter commands, both of which due to the fact that the
21917 command is split up &'before'& expansion.
21918 .ilist
21919 If an expansion item contains white space, you must quote it, so that it is all
21920 part of the same command item. If the entire option setting is one such
21921 expansion item, you have to take care what kind of quoting you use. For
21922 example:
21923 .code
21924 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21925 .endd
21926 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21927 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21928 stripped by Exim when it read the option's value. When the value is used, if
21929 the single quotes were missing, the line would be split into two items,
21930 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21931 Exim tried to expand the first one.
21932 .next
21933 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21934 expansion cannot generate multiple arguments, or a command name followed by
21935 arguments. Consider this example:
21936 .code
21937 transport_filter = ${lookup{$host}lsearch{/a/file}\
21938                     {$value}{/bin/cat}}
21939 .endd
21940 The result of the lookup is interpreted as the name of the command, even
21941 if it contains white space. The simplest way round this is to use a shell:
21942 .code
21943 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21944                                {$value}{/bin/cat}}
21945 .endd
21946 .endlist
21947
21948 The filter process is run under the same uid and gid as the normal delivery.
21949 For remote deliveries this is the Exim uid/gid by default. The command should
21950 normally yield a zero return code. Transport filters are not supposed to fail.
21951 A non-zero code is taken to mean that the transport filter encountered some
21952 serious problem. Delivery of the message is deferred; the message remains on
21953 the queue and is tried again later. It is not possible to cause a message to be
21954 bounced from a transport filter.
21955
21956 If a transport filter is set on an autoreply transport, the original message is
21957 passed through the filter as it is being copied into the newly generated
21958 message, which happens if the &%return_message%& option is set.
21959
21960
21961 .option transport_filter_timeout transports time 5m
21962 .cindex "transport" "filter, timeout"
21963 When Exim is reading the output of a transport filter, it applies a timeout
21964 that can be set by this option. Exceeding the timeout is normally treated as a
21965 temporary delivery failure. However, if a transport filter is used with a
21966 &(pipe)& transport, a timeout in the transport filter is treated in the same
21967 way as a timeout in the pipe command itself. By default, a timeout is a hard
21968 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21969 becomes a temporary error.
21970
21971
21972 .option user transports string&!! "Exim user"
21973 .cindex "uid (user id)" "local delivery"
21974 .cindex "transport" "user, specifying"
21975 This option specifies the user under whose uid the delivery process is to be
21976 run, overriding any uid that may have been set by the router. If the user is
21977 given as a name, the uid is looked up from the password data, and the
21978 associated group is taken as the value of the gid to be used if the &%group%&
21979 option is not set.
21980
21981 For deliveries that use local transports, a user and group are normally
21982 specified explicitly or implicitly (for example, as a result of
21983 &%check_local_user%&) by the router or transport.
21984
21985 .cindex "hints database" "access by remote transport"
21986 For remote transports, you should leave this option unset unless you really are
21987 sure you know what you are doing. When a remote transport is running, it needs
21988 to be able to access Exim's hints databases, because each host may have its own
21989 retry data.
21990 .ecindex IIDgenoptra1
21991 .ecindex IIDgenoptra2
21992 .ecindex IIDgenoptra3
21993
21994
21995
21996
21997
21998
21999 . ////////////////////////////////////////////////////////////////////////////
22000 . ////////////////////////////////////////////////////////////////////////////
22001
22002 .chapter "Address batching in local transports" "CHAPbatching" &&&
22003          "Address batching"
22004 .cindex "transport" "local; address batching in"
22005 The only remote transport (&(smtp)&) is normally configured to handle more than
22006 one address at a time, so that when several addresses are routed to the same
22007 remote host, just one copy of the message is sent. Local transports, however,
22008 normally handle one address at a time. That is, a separate instance of the
22009 transport is run for each address that is routed to the transport. A separate
22010 copy of the message is delivered each time.
22011
22012 .cindex "batched local delivery"
22013 .oindex "&%batch_max%&"
22014 .oindex "&%batch_id%&"
22015 In special cases, it may be desirable to handle several addresses at once in a
22016 local transport, for example:
22017
22018 .ilist
22019 In an &(appendfile)& transport, when storing messages in files for later
22020 delivery by some other means, a single copy of the message with multiple
22021 recipients saves space.
22022 .next
22023 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22024 a single copy saves time, and is the normal way LMTP is expected to work.
22025 .next
22026 In a &(pipe)& transport, when passing the message
22027 to a scanner program or
22028 to some other delivery mechanism such as UUCP, multiple recipients may be
22029 acceptable.
22030 .endlist
22031
22032 These three local transports all have the same options for controlling multiple
22033 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22034 repeating the information for each transport, these options are described here.
22035
22036 The &%batch_max%& option specifies the maximum number of addresses that can be
22037 delivered together in a single run of the transport. Its default value is one
22038 (no batching). When more than one address is routed to a transport that has a
22039 &%batch_max%& value greater than one, the addresses are delivered in a batch
22040 (that is, in a single run of the transport with multiple recipients), subject
22041 to certain conditions:
22042
22043 .ilist
22044 .vindex "&$local_part$&"
22045 If any of the transport's options contain a reference to &$local_part$&, no
22046 batching is possible.
22047 .next
22048 .vindex "&$domain$&"
22049 If any of the transport's options contain a reference to &$domain$&, only
22050 addresses with the same domain are batched.
22051 .next
22052 .cindex "customizing" "batching condition"
22053 If &%batch_id%& is set, it is expanded for each address, and only those
22054 addresses with the same expanded value are batched. This allows you to specify
22055 customized batching conditions. Failure of the expansion for any reason,
22056 including forced failure, disables batching, but it does not stop the delivery
22057 from taking place.
22058 .next
22059 Batched addresses must also have the same errors address (where to send
22060 delivery errors), the same header additions and removals, the same user and
22061 group for the transport, and if a host list is present, the first host must
22062 be the same.
22063 .endlist
22064
22065 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22066 both when the file or pipe command is specified in the transport, and when it
22067 is specified by a &(redirect)& router, but all the batched addresses must of
22068 course be routed to the same file or pipe command. These two transports have an
22069 option called &%use_bsmtp%&, which causes them to deliver the message in
22070 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22071 &%check_string%& and &%escape_string%& options are forced to the values
22072 .code
22073 check_string = "."
22074 escape_string = ".."
22075 .endd
22076 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22077 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22078 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22079
22080 .cindex "&'Envelope-to:'& header line"
22081 If the generic &%envelope_to_add%& option is set for a batching transport, the
22082 &'Envelope-to:'& header that is added to the message contains all the addresses
22083 that are being processed together. If you are using a batching &(appendfile)&
22084 transport without &%use_bsmtp%&, the only way to preserve the recipient
22085 addresses is to set the &%envelope_to_add%& option.
22086
22087 .cindex "&(pipe)& transport" "with multiple addresses"
22088 .vindex "&$pipe_addresses$&"
22089 If you are using a &(pipe)& transport without BSMTP, and setting the
22090 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22091 the command. This is not a true variable; it is a bit of magic that causes each
22092 of the recipient addresses to be inserted into the command as a separate
22093 argument. This provides a way of accessing all the addresses that are being
22094 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22095 are specified by a &(redirect)& router.
22096
22097
22098
22099
22100 . ////////////////////////////////////////////////////////////////////////////
22101 . ////////////////////////////////////////////////////////////////////////////
22102
22103 .chapter "The appendfile transport" "CHAPappendfile"
22104 .scindex IIDapptra1 "&(appendfile)& transport"
22105 .scindex IIDapptra2 "transports" "&(appendfile)&"
22106 .cindex "directory creation"
22107 .cindex "creating directories"
22108 The &(appendfile)& transport delivers a message by appending it to an existing
22109 file, or by creating an entirely new file in a specified directory. Single
22110 files to which messages are appended can be in the traditional Unix mailbox
22111 format, or optionally in the MBX format supported by the Pine MUA and
22112 University of Washington IMAP daemon, &'inter alia'&. When each message is
22113 being delivered as a separate file, &"maildir"& format can optionally be used
22114 to give added protection against failures that happen part-way through the
22115 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22116 supported. For all file formats, Exim attempts to create as many levels of
22117 directory as necessary, provided that &%create_directory%& is set.
22118
22119 The code for the optional formats is not included in the Exim binary by
22120 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22121 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22122 included.
22123
22124 .cindex "quota" "system"
22125 Exim recognizes system quota errors, and generates an appropriate message. Exim
22126 also supports its own quota control within the transport, for use when the
22127 system facility is unavailable or cannot be used for some reason.
22128
22129 If there is an error while appending to a file (for example, quota exceeded or
22130 partition filled), Exim attempts to reset the file's length and last
22131 modification time back to what they were before. If there is an error while
22132 creating an entirely new file, the new file is removed.
22133
22134 Before appending to a file, a number of security checks are made, and the
22135 file is locked. A detailed description is given below, after the list of
22136 private options.
22137
22138 The &(appendfile)& transport is most commonly used for local deliveries to
22139 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22140 putting messages into files for remote delivery by some means other than Exim.
22141 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22142 option).
22143
22144
22145
22146 .section "The file and directory options" "SECTfildiropt"
22147 The &%file%& option specifies a single file, to which the message is appended;
22148 the &%directory%& option specifies a directory, in which a new file containing
22149 the message is created. Only one of these two options can be set, and for
22150 normal deliveries to mailboxes, one of them &'must'& be set.
22151
22152 .vindex "&$address_file$&"
22153 .vindex "&$local_part$&"
22154 However, &(appendfile)& is also used for delivering messages to files or
22155 directories whose names (or parts of names) are obtained from alias,
22156 forwarding, or filtering operations (for example, a &%save%& command in a
22157 user's Exim filter). When such a transport is running, &$local_part$& contains
22158 the local part that was aliased or forwarded, and &$address_file$& contains the
22159 name (or partial name) of the file or directory generated by the redirection
22160 operation. There are two cases:
22161
22162 .ilist
22163 If neither &%file%& nor &%directory%& is set, the redirection operation
22164 must specify an absolute path (one that begins with &`/`&). This is the most
22165 common case when users with local accounts use filtering to sort mail into
22166 different folders. See for example, the &(address_file)& transport in the
22167 default configuration. If the path ends with a slash, it is assumed to be the
22168 name of a directory. A delivery to a directory can also be forced by setting
22169 &%maildir_format%& or &%mailstore_format%&.
22170 .next
22171 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22172 used to determine the file or directory name for the delivery. Normally, the
22173 contents of &$address_file$& are used in some way in the string expansion.
22174 .endlist
22175
22176
22177 .cindex "Sieve filter" "configuring &(appendfile)&"
22178 .cindex "Sieve filter" "relative mailbox path handling"
22179 As an example of the second case, consider an environment where users do not
22180 have home directories. They may be permitted to use Exim filter commands of the
22181 form:
22182 .code
22183 save folder23
22184 .endd
22185 or Sieve filter commands of the form:
22186 .code
22187 require "fileinto";
22188 fileinto "folder23";
22189 .endd
22190 In this situation, the expansion of &%file%& or &%directory%& in the transport
22191 must transform the relative path into an appropriate absolute filename. In the
22192 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22193 is used as a result of a &"keep"& action in the filter. This example shows one
22194 way of handling this requirement:
22195 .code
22196 file = ${if eq{$address_file}{inbox} \
22197             {/var/mail/$local_part} \
22198             {${if eq{${substr_0_1:$address_file}}{/} \
22199                   {$address_file} \
22200                   {$home/mail/$address_file} \
22201             }} \
22202        }
22203 .endd
22204 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22205 location, absolute paths are used without change, and other folders are in the
22206 &_mail_& directory within the home directory.
22207
22208 &*Note 1*&: While processing an Exim filter, a relative path such as
22209 &_folder23_& is turned into an absolute path if a home directory is known to
22210 the router. In particular, this is the case if &%check_local_user%& is set. If
22211 you want to prevent this happening at routing time, you can set
22212 &%router_home_directory%& empty. This forces the router to pass the relative
22213 path to the transport.
22214
22215 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22216 the &%file%& or &%directory%& option is still used if it is set.
22217
22218
22219
22220
22221 .section "Private options for appendfile" "SECID134"
22222 .cindex "options" "&(appendfile)& transport"
22223
22224
22225
22226 .option allow_fifo appendfile boolean false
22227 .cindex "fifo (named pipe)"
22228 .cindex "named pipe (fifo)"
22229 .cindex "pipe" "named (fifo)"
22230 Setting this option permits delivery to named pipes (FIFOs) as well as to
22231 regular files. If no process is reading the named pipe at delivery time, the
22232 delivery is deferred.
22233
22234
22235 .option allow_symlink appendfile boolean false
22236 .cindex "symbolic link" "to mailbox"
22237 .cindex "mailbox" "symbolic link"
22238 By default, &(appendfile)& will not deliver if the path name for the file is
22239 that of a symbolic link. Setting this option relaxes that constraint, but there
22240 are security issues involved in the use of symbolic links. Be sure you know
22241 what you are doing if you set this. Details of exactly what this option affects
22242 are included in the discussion which follows this list of options.
22243
22244
22245 .option batch_id appendfile string&!! unset
22246 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22247 However, batching is automatically disabled for &(appendfile)& deliveries that
22248 happen as a result of forwarding or aliasing or other redirection directly to a
22249 file.
22250
22251
22252 .option batch_max appendfile integer 1
22253 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22254
22255
22256 .option check_group appendfile boolean false
22257 When this option is set, the group owner of the file defined by the &%file%&
22258 option is checked to see that it is the same as the group under which the
22259 delivery process is running. The default setting is false because the default
22260 file mode is 0600, which means that the group is irrelevant.
22261
22262
22263 .option check_owner appendfile boolean true
22264 When this option is set, the owner of the file defined by the &%file%& option
22265 is checked to ensure that it is the same as the user under which the delivery
22266 process is running.
22267
22268
22269 .option check_string appendfile string "see below"
22270 .cindex "&""From""& line"
22271 As &(appendfile)& writes the message, the start of each line is tested for
22272 matching &%check_string%&, and if it does, the initial matching characters are
22273 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22274 a literal string, not a regular expression, and the case of any letters it
22275 contains is significant.
22276
22277 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22278 are forced to &"."& and &".."& respectively, and any settings in the
22279 configuration are ignored. Otherwise, they default to &"From&~"& and
22280 &">From&~"& when the &%file%& option is set, and unset when any of the
22281 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22282
22283 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22284 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22285 &"From&~"& indicates the start of a new message. All four options need changing
22286 if another format is used. For example, to deliver to mailboxes in MMDF format:
22287 .cindex "MMDF format mailbox"
22288 .cindex "mailbox" "MMDF format"
22289 .code
22290 check_string = "\1\1\1\1\n"
22291 escape_string = "\1\1\1\1 \n"
22292 message_prefix = "\1\1\1\1\n"
22293 message_suffix = "\1\1\1\1\n"
22294 .endd
22295 .option create_directory appendfile boolean true
22296 .cindex "directory creation"
22297 When this option is true, Exim attempts to create any missing superior
22298 directories for the file that it is about to write. A created directory's mode
22299 is given by the &%directory_mode%& option.
22300
22301 The group ownership of a newly created directory is highly dependent on the
22302 operating system (and possibly the file system) that is being used. For
22303 example, in Solaris, if the parent directory has the setgid bit set, its group
22304 is propagated to the child; if not, the currently set group is used. However,
22305 in FreeBSD, the parent's group is always used.
22306
22307
22308
22309 .option create_file appendfile string anywhere
22310 This option constrains the location of files and directories that are created
22311 by this transport. It applies to files defined by the &%file%& option and
22312 directories defined by the &%directory%& option. In the case of maildir
22313 delivery, it applies to the top level directory, not the maildir directories
22314 beneath.
22315
22316 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22317 &"belowhome"&. In the second and third cases, a home directory must have been
22318 set for the transport. This option is not useful when an explicit filename is
22319 given for normal mailbox deliveries. It is intended for the case when filenames
22320 are generated from users' &_.forward_& files. These are usually handled
22321 by an &(appendfile)& transport called &%address_file%&. See also
22322 &%file_must_exist%&.
22323
22324
22325 .option directory appendfile string&!! unset
22326 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22327 or &%directory%& must be set, unless the delivery is the direct result of a
22328 redirection (see section &<<SECTfildiropt>>&).
22329
22330 When &%directory%& is set, the string is expanded, and the message is delivered
22331 into a new file or files in or below the given directory, instead of being
22332 appended to a single mailbox file. A number of different formats are provided
22333 (see &%maildir_format%& and &%mailstore_format%&), and see section
22334 &<<SECTopdir>>& for further details of this form of delivery.
22335
22336
22337 .option directory_file appendfile string&!! "see below"
22338 .cindex "base62"
22339 .vindex "&$inode$&"
22340 When &%directory%& is set, but neither &%maildir_format%& nor
22341 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22342 whose name is obtained by expanding this string. The default value is:
22343 .code
22344 q${base62:$tod_epoch}-$inode
22345 .endd
22346 This generates a unique name from the current time, in base 62 form, and the
22347 inode of the file. The variable &$inode$& is available only when expanding this
22348 option.
22349
22350
22351 .option directory_mode appendfile "octal integer" 0700
22352 If &(appendfile)& creates any directories as a result of the
22353 &%create_directory%& option, their mode is specified by this option.
22354
22355
22356 .option escape_string appendfile string "see description"
22357 See &%check_string%& above.
22358
22359
22360 .option file appendfile string&!! unset
22361 This option is mutually exclusive with the &%directory%& option, but one of
22362 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22363 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22364 specifies a single file, to which the message is appended. One or more of
22365 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22366 &%file%&.
22367
22368 .cindex "NFS" "lock file"
22369 .cindex "locking files"
22370 .cindex "lock files"
22371 If you are using more than one host to deliver over NFS into the same
22372 mailboxes, you should always use lock files.
22373
22374 The string value is expanded for each delivery, and must yield an absolute
22375 path. The most common settings of this option are variations on one of these
22376 examples:
22377 .code
22378 file = /var/spool/mail/$local_part
22379 file = /home/$local_part/inbox
22380 file = $home/inbox
22381 .endd
22382 .cindex "&""sticky""& bit"
22383 In the first example, all deliveries are done into the same directory. If Exim
22384 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22385 create a file in the directory, so the &"sticky"& bit must be turned on for
22386 deliveries to be possible, or alternatively the &%group%& option can be used to
22387 run the delivery under a group id which has write access to the directory.
22388
22389
22390
22391 .option file_format appendfile string unset
22392 .cindex "file" "mailbox; checking existing format"
22393 This option requests the transport to check the format of an existing file
22394 before adding to it. The check consists of matching a specific string at the
22395 start of the file. The value of the option consists of an even number of
22396 colon-separated strings. The first of each pair is the test string, and the
22397 second is the name of a transport. If the transport associated with a matched
22398 string is not the current transport, control is passed over to the other
22399 transport. For example, suppose the standard &(local_delivery)& transport has
22400 this added to it:
22401 .code
22402 file_format = "From       : local_delivery :\
22403                \1\1\1\1\n : local_mmdf_delivery"
22404 .endd
22405 Mailboxes that begin with &"From"& are still handled by this transport, but if
22406 a mailbox begins with four binary ones followed by a newline, control is passed
22407 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22408 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22409 is assumed to match the current transport. If the start of a mailbox doesn't
22410 match any string, or if the transport named for a given string is not defined,
22411 delivery is deferred.
22412
22413
22414 .option file_must_exist appendfile boolean false
22415 If this option is true, the file specified by the &%file%& option must exist.
22416 A temporary error occurs if it does not, causing delivery to be deferred.
22417 If this option is false, the file is created if it does not exist.
22418
22419
22420 .option lock_fcntl_timeout appendfile time 0s
22421 .cindex "timeout" "mailbox locking"
22422 .cindex "mailbox" "locking, blocking and non-blocking"
22423 .cindex "locking files"
22424 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22425 when locking an open mailbox file. If the call fails, the delivery process
22426 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22427 Non-blocking calls are used so that the file is not kept open during the wait
22428 for the lock; the reason for this is to make it as safe as possible for
22429 deliveries over NFS in the case when processes might be accessing an NFS
22430 mailbox without using a lock file. This should not be done, but
22431 misunderstandings and hence misconfigurations are not unknown.
22432
22433 On a busy system, however, the performance of a non-blocking lock approach is
22434 not as good as using a blocking lock with a timeout. In this case, the waiting
22435 is done inside the system call, and Exim's delivery process acquires the lock
22436 and can proceed as soon as the previous lock holder releases it.
22437
22438 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22439 timeout, are used. There may still be some retrying: the maximum number of
22440 retries is
22441 .code
22442 (lock_retries * lock_interval) / lock_fcntl_timeout
22443 .endd
22444 rounded up to the next whole number. In other words, the total time during
22445 which &(appendfile)& is trying to get a lock is roughly the same, unless
22446 &%lock_fcntl_timeout%& is set very large.
22447
22448 You should consider setting this option if you are getting a lot of delayed
22449 local deliveries because of errors of the form
22450 .code
22451 failed to lock mailbox /some/file (fcntl)
22452 .endd
22453
22454 .option lock_flock_timeout appendfile time 0s
22455 This timeout applies to file locking when using &[flock()]& (see
22456 &%use_flock%&); the timeout operates in a similar manner to
22457 &%lock_fcntl_timeout%&.
22458
22459
22460 .option lock_interval appendfile time 3s
22461 This specifies the time to wait between attempts to lock the file. See below
22462 for details of locking.
22463
22464
22465 .option lock_retries appendfile integer 10
22466 This specifies the maximum number of attempts to lock the file. A value of zero
22467 is treated as 1. See below for details of locking.
22468
22469
22470 .option lockfile_mode appendfile "octal integer" 0600
22471 This specifies the mode of the created lock file, when a lock file is being
22472 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22473
22474
22475 .option lockfile_timeout appendfile time 30m
22476 .cindex "timeout" "mailbox locking"
22477 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22478 exists and is older than this value, it is assumed to have been left behind by
22479 accident, and Exim attempts to remove it.
22480
22481
22482 .option mailbox_filecount appendfile string&!! unset
22483 .cindex "mailbox" "specifying size of"
22484 .cindex "size" "of mailbox"
22485 If this option is set, it is expanded, and the result is taken as the current
22486 number of files in the mailbox. It must be a decimal number, optionally
22487 followed by K or M. This provides a way of obtaining this information from an
22488 external source that maintains the data.
22489
22490
22491 .option mailbox_size appendfile string&!! unset
22492 .cindex "mailbox" "specifying size of"
22493 .cindex "size" "of mailbox"
22494 If this option is set, it is expanded, and the result is taken as the current
22495 size the mailbox. It must be a decimal number, optionally followed by K or M.
22496 This provides a way of obtaining this information from an external source that
22497 maintains the data. This is likely to be helpful for maildir deliveries where
22498 it is computationally expensive to compute the size of a mailbox.
22499
22500
22501
22502 .option maildir_format appendfile boolean false
22503 .cindex "maildir format" "specifying"
22504 If this option is set with the &%directory%& option, the delivery is into a new
22505 file, in the &"maildir"& format that is used by other mail software. When the
22506 transport is activated directly from a &(redirect)& router (for example, the
22507 &(address_file)& transport in the default configuration), setting
22508 &%maildir_format%& causes the path received from the router to be treated as a
22509 directory, whether or not it ends with &`/`&. This option is available only if
22510 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22511 &<<SECTmaildirdelivery>>& below for further details.
22512
22513
22514 .option maildir_quota_directory_regex appendfile string "See below"
22515 .cindex "maildir format" "quota; directories included in"
22516 .cindex "quota" "maildir; directories included in"
22517 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22518 a regular expression for specifying directories, relative to the quota
22519 directory (see &%quota_directory%&), that should be included in the quota
22520 calculation. The default value is:
22521 .code
22522 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22523 .endd
22524 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22525 (directories whose names begin with a dot). If you want to exclude the
22526 &_Trash_&
22527 folder from the count (as some sites do), you need to change this setting to
22528 .code
22529 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22530 .endd
22531 This uses a negative lookahead in the regular expression to exclude the
22532 directory whose name is &_.Trash_&. When a directory is excluded from quota
22533 calculations, quota processing is bypassed for any messages that are delivered
22534 directly into that directory.
22535
22536
22537 .option maildir_retries appendfile integer 10
22538 This option specifies the number of times to retry when writing a file in
22539 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22540
22541
22542 .option maildir_tag appendfile string&!! unset
22543 This option applies only to deliveries in maildir format, and is described in
22544 section &<<SECTmaildirdelivery>>& below.
22545
22546
22547 .option maildir_use_size_file appendfile&!! boolean false
22548 .cindex "maildir format" "&_maildirsize_& file"
22549 The result of string expansion for this option must be a valid boolean value.
22550 If it is true, it enables support for &_maildirsize_& files. Exim
22551 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22552 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22553 value is zero. See &%maildir_quota_directory_regex%& above and section
22554 &<<SECTmaildirdelivery>>& below for further details.
22555
22556 .option maildirfolder_create_regex appendfile string unset
22557 .cindex "maildir format" "&_maildirfolder_& file"
22558 .cindex "&_maildirfolder_&, creating"
22559 The value of this option is a regular expression. If it is unset, it has no
22560 effect. Otherwise, before a maildir delivery takes place, the pattern is
22561 matched against the name of the maildir directory, that is, the directory
22562 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22563 delivery. If there is a match, Exim checks for the existence of a file called
22564 &_maildirfolder_& in the directory, and creates it if it does not exist.
22565 See section &<<SECTmaildirdelivery>>& for more details.
22566
22567
22568 .option mailstore_format appendfile boolean false
22569 .cindex "mailstore format" "specifying"
22570 If this option is set with the &%directory%& option, the delivery is into two
22571 new files in  &"mailstore"& format. The option is available only if
22572 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22573 below for further details.
22574
22575
22576 .option mailstore_prefix appendfile string&!! unset
22577 This option applies only to deliveries in mailstore format, and is described in
22578 section &<<SECTopdir>>& below.
22579
22580
22581 .option mailstore_suffix appendfile string&!! unset
22582 This option applies only to deliveries in mailstore format, and is described in
22583 section &<<SECTopdir>>& below.
22584
22585
22586 .option mbx_format appendfile boolean false
22587 .cindex "locking files"
22588 .cindex "file" "locking"
22589 .cindex "file" "MBX format"
22590 .cindex "MBX format, specifying"
22591 This option is available only if Exim has been compiled with SUPPORT_MBX
22592 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22593 the message is appended to the mailbox file in MBX format instead of
22594 traditional Unix format. This format is supported by Pine4 and its associated
22595 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22596
22597 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22598 automatically changed by the use of &%mbx_format%&. They should normally be set
22599 empty when using MBX format, so this option almost always appears in this
22600 combination:
22601 .code
22602 mbx_format = true
22603 message_prefix =
22604 message_suffix =
22605 .endd
22606 If none of the locking options are mentioned in the configuration,
22607 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22608 is possible to specify the other kinds of locking with &%mbx_format%&, but
22609 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22610 interworks with &'c-client'&, providing for shared access to the mailbox. It
22611 should not be used if any program that does not use this form of locking is
22612 going to access the mailbox, nor should it be used if the mailbox file is NFS
22613 mounted, because it works only when the mailbox is accessed from a single host.
22614
22615 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22616 the standard version of &'c-client'&, because as long as it has a mailbox open
22617 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22618 append messages to it.
22619
22620
22621 .option message_prefix appendfile string&!! "see below"
22622 .cindex "&""From""& line"
22623 The string specified here is expanded and output at the start of every message.
22624 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22625 in which case it is:
22626 .code
22627 message_prefix = "From ${if def:return_path{$return_path}\
22628   {MAILER-DAEMON}} $tod_bsdinbox\n"
22629 .endd
22630 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22631 &`\n`& to &`\r\n`& in &%message_prefix%&.
22632
22633 .option message_suffix appendfile string&!! "see below"
22634 The string specified here is expanded and output at the end of every message.
22635 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22636 in which case it is a single newline character. The suffix can be suppressed by
22637 setting
22638 .code
22639 message_suffix =
22640 .endd
22641 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22642 &`\n`& to &`\r\n`& in &%message_suffix%&.
22643
22644 .option mode appendfile "octal integer" 0600
22645 If the output file is created, it is given this mode. If it already exists and
22646 has wider permissions, they are reduced to this mode. If it has narrower
22647 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22648 if the delivery is the result of a &%save%& command in a filter file specifying
22649 a particular mode, the mode of the output file is always forced to take that
22650 value, and this option is ignored.
22651
22652
22653 .option mode_fail_narrower appendfile boolean true
22654 This option applies in the case when an existing mailbox file has a narrower
22655 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22656 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22657 continues with the delivery attempt, using the existing mode of the file.
22658
22659
22660 .option notify_comsat appendfile boolean false
22661 If this option is true, the &'comsat'& daemon is notified after every
22662 successful delivery to a user mailbox. This is the daemon that notifies logged
22663 on users about incoming mail.
22664
22665
22666 .option quota appendfile string&!! unset
22667 .cindex "quota" "imposed by Exim"
22668 This option imposes a limit on the size of the file to which Exim is appending,
22669 or to the total space used in the directory tree when the &%directory%& option
22670 is set. In the latter case, computation of the space used is expensive, because
22671 all the files in the directory (and any sub-directories) have to be
22672 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22673 &%maildir_use_size_file%& for ways to avoid this in environments where users
22674 have no shell access to their mailboxes).
22675
22676 As there is no interlock against two simultaneous deliveries into a
22677 multi-file mailbox, it is possible for the quota to be overrun in this case.
22678 For single-file mailboxes, of course, an interlock is a necessity.
22679
22680 A file's size is taken as its &'used'& value. Because of blocking effects, this
22681 may be a lot less than the actual amount of disk space allocated to the file.
22682 If the sizes of a number of files are being added up, the rounding effect can
22683 become quite noticeable, especially on systems that have large block sizes.
22684 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22685 the obvious value which users understand most easily.
22686
22687 The value of the option is expanded, and must then be a numerical value
22688 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22689 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22690 and further option modifiers. If Exim is running on a system with
22691 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22692 be handled.
22693
22694 The option modifier &%no_check%& can be used to force delivery even if the over
22695 quota condition is met. The quota gets updated as usual.
22696
22697 &*Note*&: A value of zero is interpreted as &"no quota"&.
22698
22699 The expansion happens while Exim is running as root, before it changes uid for
22700 the delivery. This means that files that are inaccessible to the end user can
22701 be used to hold quota values that are looked up in the expansion. When delivery
22702 fails because this quota is exceeded, the handling of the error is as for
22703 system quota failures.
22704
22705 By default, Exim's quota checking mimics system quotas, and restricts the
22706 mailbox to the specified maximum size, though the value is not accurate to the
22707 last byte, owing to separator lines and additional headers that may get added
22708 during message delivery. When a mailbox is nearly full, large messages may get
22709 refused even though small ones are accepted, because the size of the current
22710 message is added to the quota when the check is made. This behaviour can be
22711 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22712 for exceeding the quota does not include the current message. Thus, deliveries
22713 continue until the quota has been exceeded; thereafter, no further messages are
22714 delivered. See also &%quota_warn_threshold%&.
22715
22716
22717 .option quota_directory appendfile string&!! unset
22718 This option defines the directory to check for quota purposes when delivering
22719 into individual files. The default is the delivery directory, or, if a file
22720 called &_maildirfolder_& exists in a maildir directory, the parent of the
22721 delivery directory.
22722
22723
22724 .option quota_filecount appendfile string&!! 0
22725 This option applies when the &%directory%& option is set. It limits the total
22726 number of files in the directory (compare the inode limit in system quotas). It
22727 can only be used if &%quota%& is also set. The value is expanded; an expansion
22728 failure causes delivery to be deferred. A value of zero is interpreted as
22729 &"no quota"&.
22730
22731 The option modifier &%no_check%& can be used to force delivery even if the over
22732 quota condition is met. The quota gets updated as usual.
22733
22734 .option quota_is_inclusive appendfile boolean true
22735 See &%quota%& above.
22736
22737
22738 .option quota_size_regex appendfile string unset
22739 This option applies when one of the delivery modes that writes a separate file
22740 for each message is being used. When Exim wants to find the size of one of
22741 these files in order to test the quota, it first checks &%quota_size_regex%&.
22742 If this is set to a regular expression that matches the filename, and it
22743 captures one string, that string is interpreted as a representation of the
22744 file's size. The value of &%quota_size_regex%& is not expanded.
22745
22746 This feature is useful only when users have no shell access to their mailboxes
22747 &-- otherwise they could defeat the quota simply by renaming the files. This
22748 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22749 the file length to the filename. For example:
22750 .code
22751 maildir_tag = ,S=$message_size
22752 quota_size_regex = ,S=(\d+)
22753 .endd
22754 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22755 number of lines in the message.
22756
22757 The regular expression should not assume that the length is at the end of the
22758 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22759 sometimes add other information onto the ends of message filenames.
22760
22761 Section &<<SECID136>>& contains further information.
22762
22763
22764 .option quota_warn_message appendfile string&!! "see below"
22765 See below for the use of this option. If it is not set when
22766 &%quota_warn_threshold%& is set, it defaults to
22767 .code
22768 quota_warn_message = "\
22769   To: $local_part@$domain\n\
22770   Subject: Your mailbox\n\n\
22771   This message is automatically created \
22772   by mail delivery software.\n\n\
22773   The size of your mailbox has exceeded \
22774   a warning threshold that is\n\
22775   set by the system administrator.\n"
22776 .endd
22777
22778
22779 .option quota_warn_threshold appendfile string&!! 0
22780 .cindex "quota" "warning threshold"
22781 .cindex "mailbox" "size warning"
22782 .cindex "size" "of mailbox"
22783 This option is expanded in the same way as &%quota%& (see above). If the
22784 resulting value is greater than zero, and delivery of the message causes the
22785 size of the file or total space in the directory tree to cross the given
22786 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22787 may be specified as a percentage of it by following the value with a percent
22788 sign. For example:
22789 .code
22790 quota = 10M
22791 quota_warn_threshold = 75%
22792 .endd
22793 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22794 percent sign is ignored.
22795
22796 The warning message itself is specified by the &%quota_warn_message%& option,
22797 and it must start with a &'To:'& header line containing the recipient(s) of the
22798 warning message. These do not necessarily have to include the recipient(s) of
22799 the original message. A &'Subject:'& line should also normally be supplied. You
22800 can include any other header lines that you want. If you do not include a
22801 &'From:'& line, the default is:
22802 .code
22803 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22804 .endd
22805 .oindex &%errors_reply_to%&
22806 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22807 option.
22808
22809 The &%quota%& option does not have to be set in order to use this option; they
22810 are independent of one another except when the threshold is specified as a
22811 percentage.
22812
22813
22814 .option use_bsmtp appendfile boolean false
22815 .cindex "envelope sender"
22816 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22817 format, with the envelope sender and recipient(s) included as SMTP commands. If
22818 you want to include a leading HELO command with such messages, you can do
22819 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22820 for details of batch SMTP.
22821
22822
22823 .option use_crlf appendfile boolean false
22824 .cindex "carriage return"
22825 .cindex "linefeed"
22826 This option causes lines to be terminated with the two-character CRLF sequence
22827 (carriage return, linefeed) instead of just a linefeed character. In the case
22828 of batched SMTP, the byte sequence written to the file is then an exact image
22829 of what would be sent down a real SMTP connection.
22830
22831 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22832 (which are used to supply the traditional &"From&~"& and blank line separators
22833 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22834 carriage return characters if these are needed. In cases where these options
22835 have non-empty defaults, the values end with a single linefeed, so they must be
22836 changed to end with &`\r\n`& if &%use_crlf%& is set.
22837
22838
22839 .option use_fcntl_lock appendfile boolean "see below"
22840 This option controls the use of the &[fcntl()]& function to lock a file for
22841 exclusive use when a message is being appended. It is set by default unless
22842 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22843 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22844 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22845
22846
22847 .option use_flock_lock appendfile boolean false
22848 This option is provided to support the use of &[flock()]& for file locking, for
22849 the few situations where it is needed. Most modern operating systems support
22850 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22851 each other. Exim uses &[fcntl()]& locking by default.
22852
22853 This option is required only if you are using an operating system where
22854 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22855 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22856 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22857
22858 .cindex "Solaris" "&[flock()]& support"
22859 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22860 have it (and some, I think, provide a not quite right version built on top of
22861 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22862 the ability to use it, and any attempt to do so will cause a configuration
22863 error.
22864
22865 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22866 is just being mapped onto &[fcntl()]& by the OS).
22867
22868
22869 .option use_lockfile appendfile boolean "see below"
22870 If this option is turned off, Exim does not attempt to create a lock file when
22871 appending to a mailbox file. In this situation, the only locking is by
22872 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22873 sure that every MUA that is ever going to look at your users' mailboxes uses
22874 &[fcntl()]& rather than a lock file, and even then only when you are not
22875 delivering over NFS from more than one host.
22876
22877 .cindex "NFS" "lock file"
22878 In order to append to an NFS file safely from more than one host, it is
22879 necessary to take out a lock &'before'& opening the file, and the lock file
22880 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22881 file corruption.
22882
22883 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22884 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22885 except when &%mbx_format%& is set.
22886
22887
22888 .option use_mbx_lock appendfile boolean "see below"
22889 This option is available only if Exim has been compiled with SUPPORT_MBX
22890 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22891 locking rules be used. It is set by default if &%mbx_format%& is set and none
22892 of the locking options are mentioned in the configuration. The locking rules
22893 are the same as are used by the &'c-client'& library that underlies Pine and
22894 the IMAP4 and POP daemons that come with it (see the discussion below). The
22895 rules allow for shared access to the mailbox. However, this kind of locking
22896 does not work when the mailbox is NFS mounted.
22897
22898 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22899 &%use_flock_lock%& to control what kind of locking is used in implementing the
22900 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22901 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22902
22903
22904
22905
22906 .section "Operational details for appending" "SECTopappend"
22907 .cindex "appending to a file"
22908 .cindex "file" "appending"
22909 Before appending to a file, the following preparations are made:
22910
22911 .ilist
22912 If the name of the file is &_/dev/null_&, no action is taken, and a success
22913 return is given.
22914
22915 .next
22916 .cindex "directory creation"
22917 If any directories on the file's path are missing, Exim creates them if the
22918 &%create_directory%& option is set. A created directory's mode is given by the
22919 &%directory_mode%& option.
22920
22921 .next
22922 If &%file_format%& is set, the format of an existing file is checked. If this
22923 indicates that a different transport should be used, control is passed to that
22924 transport.
22925
22926 .next
22927 .cindex "file" "locking"
22928 .cindex "locking files"
22929 .cindex "NFS" "lock file"
22930 If &%use_lockfile%& is set, a lock file is built in a way that will work
22931 reliably over NFS, as follows:
22932
22933 .olist
22934 Create a &"hitching post"& file whose name is that of the lock file with the
22935 current time, primary host name, and process id added, by opening for writing
22936 as a new file. If this fails with an access error, delivery is deferred.
22937 .next
22938 Close the hitching post file, and hard link it to the lock filename.
22939 .next
22940 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22941 Unlink the hitching post name.
22942 .next
22943 Otherwise, use &[stat()]& to get information about the hitching post file, and
22944 then unlink hitching post name. If the number of links is exactly two, creation
22945 of the lock file succeeded but something (for example, an NFS server crash and
22946 restart) caused this fact not to be communicated to the &[link()]& call.
22947 .next
22948 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22949 up to &%lock_retries%& times. However, since any program that writes to a
22950 mailbox should complete its task very quickly, it is reasonable to time out old
22951 lock files that are normally the result of user agent and system crashes. If an
22952 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22953 it before trying again.
22954 .endlist olist
22955
22956 .next
22957 A call is made to &[lstat()]& to discover whether the main file exists, and if
22958 so, what its characteristics are. If &[lstat()]& fails for any reason other
22959 than non-existence, delivery is deferred.
22960
22961 .next
22962 .cindex "symbolic link" "to mailbox"
22963 .cindex "mailbox" "symbolic link"
22964 If the file does exist and is a symbolic link, delivery is deferred, unless the
22965 &%allow_symlink%& option is set, in which case the ownership of the link is
22966 checked, and then &[stat()]& is called to find out about the real file, which
22967 is then subjected to the checks below. The check on the top-level link
22968 ownership prevents one user creating a link for another's mailbox in a sticky
22969 directory, though allowing symbolic links in this case is definitely not a good
22970 idea. If there is a chain of symbolic links, the intermediate ones are not
22971 checked.
22972
22973 .next
22974 If the file already exists but is not a regular file, or if the file's owner
22975 and group (if the group is being checked &-- see &%check_group%& above) are
22976 different from the user and group under which the delivery is running,
22977 delivery is deferred.
22978
22979 .next
22980 If the file's permissions are more generous than specified, they are reduced.
22981 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22982 is set false, in which case the delivery is tried using the existing
22983 permissions.
22984
22985 .next
22986 The file's inode number is saved, and the file is then opened for appending.
22987 If this fails because the file has vanished, &(appendfile)& behaves as if it
22988 hadn't existed (see below). For any other failures, delivery is deferred.
22989
22990 .next
22991 If the file is opened successfully, check that the inode number hasn't
22992 changed, that it is still a regular file, and that the owner and permissions
22993 have not changed. If anything is wrong, defer delivery and freeze the message.
22994
22995 .next
22996 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22997 option is set. Otherwise, check that the file is being created in a permitted
22998 directory if the &%create_file%& option is set (deferring on failure), and then
22999 open for writing as a new file, with the O_EXCL and O_CREAT options,
23000 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23001 set). In this case, which can happen if the link points to a non-existent file,
23002 the file is opened for writing using O_CREAT but not O_EXCL, because
23003 that prevents link following.
23004
23005 .next
23006 .cindex "loop" "while file testing"
23007 If opening fails because the file exists, obey the tests given above for
23008 existing files. However, to avoid looping in a situation where the file is
23009 being continuously created and destroyed, the exists/not-exists loop is broken
23010 after 10 repetitions, and the message is then frozen.
23011
23012 .next
23013 If opening fails with any other error, defer delivery.
23014
23015 .next
23016 .cindex "file" "locking"
23017 .cindex "locking files"
23018 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23019 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23020 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23021 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23022 file, and an exclusive lock on the file whose name is
23023 .code
23024 /tmp/.<device-number>.<inode-number>
23025 .endd
23026 using the device and inode numbers of the open mailbox file, in accordance with
23027 the MBX locking rules. This file is created with a mode that is specified by
23028 the &%lockfile_mode%& option.
23029
23030 If Exim fails to lock the file, there are two possible courses of action,
23031 depending on the value of the locking timeout. This is obtained from
23032 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23033
23034 If the timeout value is zero, the file is closed, Exim waits for
23035 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23036 to lock it again. This happens up to &%lock_retries%& times, after which the
23037 delivery is deferred.
23038
23039 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23040 &[flock()]& are used (with the given timeout), so there has already been some
23041 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23042 immediately. It retries up to
23043 .code
23044 (lock_retries * lock_interval) / <timeout>
23045 .endd
23046 times (rounded up).
23047 .endlist
23048
23049 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23050 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23051
23052
23053 .section "Operational details for delivery to a new file" "SECTopdir"
23054 .cindex "delivery" "to single file"
23055 .cindex "&""From""& line"
23056 When the &%directory%& option is set instead of &%file%&, each message is
23057 delivered into a newly-created file or set of files. When &(appendfile)& is
23058 activated directly from a &(redirect)& router, neither &%file%& nor
23059 &%directory%& is normally set, because the path for delivery is supplied by the
23060 router. (See for example, the &(address_file)& transport in the default
23061 configuration.) In this case, delivery is to a new file if either the path name
23062 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23063
23064 No locking is required while writing the message to a new file, so the various
23065 locking options of the transport are ignored. The &"From"& line that by default
23066 separates messages in a single file is not normally needed, nor is the escaping
23067 of message lines that start with &"From"&, and there is no need to ensure a
23068 newline at the end of each message. Consequently, the default values for
23069 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23070 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23071
23072 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23073 the files in the delivery directory by default. However, you can specify a
23074 different directory by setting &%quota_directory%&. Also, for maildir
23075 deliveries (see below) the &_maildirfolder_& convention is honoured.
23076
23077
23078 .cindex "maildir format"
23079 .cindex "mailstore format"
23080 There are three different ways in which delivery to individual files can be
23081 done, controlled by the settings of the &%maildir_format%& and
23082 &%mailstore_format%& options. Note that code to support maildir or mailstore
23083 formats is not included in the binary unless SUPPORT_MAILDIR or
23084 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23085
23086 .cindex "directory creation"
23087 In all three cases an attempt is made to create the directory and any necessary
23088 sub-directories if they do not exist, provided that the &%create_directory%&
23089 option is set (the default). The location of a created directory can be
23090 constrained by setting &%create_file%&. A created directory's mode is given by
23091 the &%directory_mode%& option. If creation fails, or if the
23092 &%create_directory%& option is not set when creation is required, delivery is
23093 deferred.
23094
23095
23096
23097 .section "Maildir delivery" "SECTmaildirdelivery"
23098 .cindex "maildir format" "description of"
23099 If the &%maildir_format%& option is true, Exim delivers each message by writing
23100 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23101 directory that is defined by the &%directory%& option (the &"delivery
23102 directory"&). If the delivery is successful, the file is renamed into the
23103 &_new_& subdirectory.
23104
23105 In the filename, <&'stime'&> is the current time of day in seconds, and
23106 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23107 Exim checks that the time-of-day clock has moved on by at least one microsecond
23108 before terminating the delivery process. This guarantees uniqueness for the
23109 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23110 opening it. If any response other than ENOENT (does not exist) is given,
23111 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23112
23113 Before Exim carries out a maildir delivery, it ensures that subdirectories
23114 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23115 do not exist, Exim tries to create them and any superior directories in their
23116 path, subject to the &%create_directory%& and &%create_file%& options. If the
23117 &%maildirfolder_create_regex%& option is set, and the regular expression it
23118 contains matches the delivery directory, Exim also ensures that a file called
23119 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23120 &_maildirfolder_& file cannot be created, delivery is deferred.
23121
23122 These features make it possible to use Exim to create all the necessary files
23123 and directories in a maildir mailbox, including subdirectories for maildir++
23124 folders. Consider this example:
23125 .code
23126 maildir_format = true
23127 directory = /var/mail/$local_part\
23128            ${if eq{$local_part_suffix}{}{}\
23129            {/.${substr_1:$local_part_suffix}}}
23130 maildirfolder_create_regex = /\.[^/]+$
23131 .endd
23132 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23133 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23134 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23135 not match this name, so Exim will not look for or create the file
23136 &_/var/mail/pimbo/maildirfolder_&, though it will create
23137 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23138
23139 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23140 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23141 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23142 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23143 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23144
23145 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23146 not inadvertently match the toplevel maildir directory, because a
23147 &_maildirfolder_& file at top level would completely break quota calculations.
23148
23149 .cindex "quota" "in maildir delivery"
23150 .cindex "maildir++"
23151 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23152 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23153 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23154 Exim assumes the directory is a maildir++ folder directory, which is one level
23155 down from the user's top level mailbox directory. This causes it to start at
23156 the parent directory instead of the current directory when calculating the
23157 amount of space used.
23158
23159 One problem with delivering into a multi-file mailbox is that it is
23160 computationally expensive to compute the size of the mailbox for quota
23161 checking. Various approaches have been taken to reduce the amount of work
23162 needed. The next two sections describe two of them. A third alternative is to
23163 use some external process for maintaining the size data, and use the expansion
23164 of the &%mailbox_size%& option as a way of importing it into Exim.
23165
23166
23167
23168
23169 .section "Using tags to record message sizes" "SECID135"
23170 If &%maildir_tag%& is set, the string is expanded for each delivery.
23171 When the maildir file is renamed into the &_new_& sub-directory, the
23172 tag is added to its name. However, if adding the tag takes the length of the
23173 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23174 the tag is dropped and the maildir file is created with no tag.
23175
23176
23177 .vindex "&$message_size$&"
23178 Tags can be used to encode the size of files in their names; see
23179 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23180 happens after the message has been written. The value of the &$message_size$&
23181 variable is set to the number of bytes actually written. If the expansion is
23182 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23183 be deferred. The expanded tag may contain any printing characters except &"/"&.
23184 Non-printing characters in the string are ignored; if the resulting string is
23185 empty, it is ignored. If it starts with an alphanumeric character, a leading
23186 colon is inserted; this default has not proven to be the path that popular
23187 maildir implementations have chosen (but changing it in Exim would break
23188 backwards compatibility).
23189
23190 For one common implementation, you might set:
23191 .code
23192 maildir_tag = ,S=${message_size}
23193 .endd
23194 but you should check the documentation of the other software to be sure.
23195
23196 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23197 as this allows Exim to extract the size from your tag, instead of having to
23198 &[stat()]& each message file.
23199
23200
23201 .section "Using a maildirsize file" "SECID136"
23202 .cindex "quota" "in maildir delivery"
23203 .cindex "maildir format" "&_maildirsize_& file"
23204 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23205 storing quota and message size information in a file called &_maildirsize_&
23206 within the toplevel maildir directory. If this file does not exist, Exim
23207 creates it, setting the quota from the &%quota%& option of the transport. If
23208 the maildir directory itself does not exist, it is created before any attempt
23209 to write a &_maildirsize_& file.
23210
23211 The &_maildirsize_& file is used to hold information about the sizes of
23212 messages in the maildir, thus speeding up quota calculations. The quota value
23213 in the file is just a cache; if the quota is changed in the transport, the new
23214 value overrides the cached value when the next message is delivered. The cache
23215 is maintained for the benefit of other programs that access the maildir and
23216 need to know the quota.
23217
23218 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23219 file is maintained (with a zero quota setting), but no quota is imposed.
23220
23221 A regular expression is available for controlling which directories in the
23222 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23223 See the description of the &%maildir_quota_directory_regex%& option above for
23224 details.
23225
23226
23227 .section "Mailstore delivery" "SECID137"
23228 .cindex "mailstore format" "description of"
23229 If the &%mailstore_format%& option is true, each message is written as two
23230 files in the given directory. A unique base name is constructed from the
23231 message id and the current delivery process, and the files that are written use
23232 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23233 contains the message's envelope, and the &_.msg_& file contains the message
23234 itself. The base name is placed in the variable &$mailstore_basename$&.
23235
23236 During delivery, the envelope is first written to a file with the suffix
23237 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23238 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23239 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23240 file before accessing either of them. An alternative approach is to wait for
23241 the absence of a &_.tmp_& file.
23242
23243 The envelope file starts with any text defined by the &%mailstore_prefix%&
23244 option, expanded and terminated by a newline if there isn't one. Then follows
23245 the sender address on one line, then all the recipient addresses, one per line.
23246 There can be more than one recipient only if the &%batch_max%& option is set
23247 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23248 appended to the file, followed by a newline if it does not end with one.
23249
23250 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23251 failure, it is ignored. Other expansion errors are treated as serious
23252 configuration errors, and delivery is deferred. The variable
23253 &$mailstore_basename$& is available for use during these expansions.
23254
23255
23256 .section "Non-special new file delivery" "SECID138"
23257 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23258 file is created directly in the named directory. For example, when delivering
23259 messages into files in batched SMTP format for later delivery to some host (see
23260 section &<<SECTbatchSMTP>>&), a setting such as
23261 .code
23262 directory = /var/bsmtp/$host
23263 .endd
23264 might be used. A message is written to a file with a temporary name, which is
23265 then renamed when the delivery is complete. The final name is obtained by
23266 expanding the contents of the &%directory_file%& option.
23267 .ecindex IIDapptra1
23268 .ecindex IIDapptra2
23269
23270
23271
23272
23273
23274
23275 . ////////////////////////////////////////////////////////////////////////////
23276 . ////////////////////////////////////////////////////////////////////////////
23277
23278 .chapter "The autoreply transport" "CHID8"
23279 .scindex IIDauttra1 "transports" "&(autoreply)&"
23280 .scindex IIDauttra2 "&(autoreply)& transport"
23281 The &(autoreply)& transport is not a true transport in that it does not cause
23282 the message to be transmitted. Instead, it generates a new mail message as an
23283 automatic reply to the incoming message. &'References:'& and
23284 &'Auto-Submitted:'& header lines are included. These are constructed according
23285 to the rules in RFCs 2822 and 3834, respectively.
23286
23287 If the router that passes the message to this transport does not have the
23288 &%unseen%& option set, the original message (for the current recipient) is not
23289 delivered anywhere. However, when the &%unseen%& option is set on the router
23290 that passes the message to this transport, routing of the address continues, so
23291 another router can set up a normal message delivery.
23292
23293
23294 The &(autoreply)& transport is usually run as the result of mail filtering, a
23295 &"vacation"& message being the standard example. However, it can also be run
23296 directly from a router like any other transport. To reduce the possibility of
23297 message cascades, messages created by the &(autoreply)& transport always have
23298 empty envelope sender addresses, like bounce messages.
23299
23300 The parameters of the message to be sent can be specified in the configuration
23301 by options described below. However, these are used only when the address
23302 passed to the transport does not contain its own reply information. When the
23303 transport is run as a consequence of a
23304 &%mail%&
23305 or &%vacation%& command in a filter file, the parameters of the message are
23306 supplied by the filter, and passed with the address. The transport's options
23307 that define the message are then ignored (so they are not usually set in this
23308 case). The message is specified entirely by the filter or by the transport; it
23309 is never built from a mixture of options. However, the &%file_optional%&,
23310 &%mode%&, and &%return_message%& options apply in all cases.
23311
23312 &(Autoreply)& is implemented as a local transport. When used as a result of a
23313 command in a user's filter file, &(autoreply)& normally runs under the uid and
23314 gid of the user, and with appropriate current and home directories (see chapter
23315 &<<CHAPenvironment>>&).
23316
23317 There is a subtle difference between routing a message to a &(pipe)& transport
23318 that generates some text to be returned to the sender, and routing it to an
23319 &(autoreply)& transport. This difference is noticeable only if more than one
23320 address from the same message is so handled. In the case of a pipe, the
23321 separate outputs from the different addresses are gathered up and returned to
23322 the sender in a single message, whereas if &(autoreply)& is used, a separate
23323 message is generated for each address that is passed to it.
23324
23325 Non-printing characters are not permitted in the header lines generated for the
23326 message that &(autoreply)& creates, with the exception of newlines that are
23327 immediately followed by white space. If any non-printing characters are found,
23328 the transport defers.
23329 Whether characters with the top bit set count as printing characters or not is
23330 controlled by the &%print_topbitchars%& global option.
23331
23332 If any of the generic options for manipulating headers (for example,
23333 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23334 of the original message that is included in the generated message when
23335 &%return_message%& is set. They do not apply to the generated message itself.
23336
23337 .vindex "&$sender_address$&"
23338 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23339 the message, indicating that there were no recipients, it does not treat this
23340 as an error. This means that autoreplies sent to &$sender_address$& when this
23341 is empty (because the incoming message is a bounce message) do not cause
23342 problems. They are just discarded.
23343
23344
23345
23346 .section "Private options for autoreply" "SECID139"
23347 .cindex "options" "&(autoreply)& transport"
23348
23349 .option bcc autoreply string&!! unset
23350 This specifies the addresses that are to receive &"blind carbon copies"& of the
23351 message when the message is specified by the transport.
23352
23353
23354 .option cc autoreply string&!! unset
23355 This specifies recipients of the message and the contents of the &'Cc:'& header
23356 when the message is specified by the transport.
23357
23358
23359 .option file autoreply string&!! unset
23360 The contents of the file are sent as the body of the message when the message
23361 is specified by the transport. If both &%file%& and &%text%& are set, the text
23362 string comes first.
23363
23364
23365 .option file_expand autoreply boolean false
23366 If this is set, the contents of the file named by the &%file%& option are
23367 subjected to string expansion as they are added to the message.
23368
23369
23370 .option file_optional autoreply boolean false
23371 If this option is true, no error is generated if the file named by the &%file%&
23372 option or passed with the address does not exist or cannot be read.
23373
23374
23375 .option from autoreply string&!! unset
23376 This specifies the contents of the &'From:'& header when the message is
23377 specified by the transport.
23378
23379
23380 .option headers autoreply string&!! unset
23381 This specifies additional RFC 2822 headers that are to be added to the message
23382 when the message is specified by the transport. Several can be given by using
23383 &"\n"& to separate them. There is no check on the format.
23384
23385
23386 .option log autoreply string&!! unset
23387 This option names a file in which a record of every message sent is logged when
23388 the message is specified by the transport.
23389
23390
23391 .option mode autoreply "octal integer" 0600
23392 If either the log file or the &"once"& file has to be created, this mode is
23393 used.
23394
23395
23396 .option never_mail autoreply "address list&!!" unset
23397 If any run of the transport creates a message with a recipient that matches any
23398 item in the list, that recipient is quietly discarded. If all recipients are
23399 discarded, no message is created. This applies both when the recipients are
23400 generated by a filter and when they are specified in the transport.
23401
23402
23403
23404 .option once autoreply string&!! unset
23405 This option names a file or DBM database in which a record of each &'To:'&
23406 recipient is kept when the message is specified by the transport. &*Note*&:
23407 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23408
23409 If &%once%& is unset, or is set to an empty string, the message is always sent.
23410 By default, if &%once%& is set to a non-empty filename, the message
23411 is not sent if a potential recipient is already listed in the database.
23412 However, if the &%once_repeat%& option specifies a time greater than zero, the
23413 message is sent if that much time has elapsed since a message was last sent to
23414 this recipient. A setting of zero time for &%once_repeat%& (the default)
23415 prevents a message from being sent a second time &-- in this case, zero means
23416 infinity.
23417
23418 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23419 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23420 greater than zero, it changes the way Exim implements the &%once%& option.
23421 Instead of using a DBM file to record every recipient it sends to, it uses a
23422 regular file, whose size will never get larger than the given value.
23423
23424 In the file, Exim keeps a linear list of recipient addresses and the times at
23425 which they were sent messages. If the file is full when a new address needs to
23426 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23427 means that a given recipient may receive multiple messages, but at
23428 unpredictable intervals that depend on the rate of turnover of addresses in the
23429 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23430
23431
23432 .option once_file_size autoreply integer 0
23433 See &%once%& above.
23434
23435
23436 .option once_repeat autoreply time&!! 0s
23437 See &%once%& above.
23438 After expansion, the value of this option must be a valid time value.
23439
23440
23441 .option reply_to autoreply string&!! unset
23442 This specifies the contents of the &'Reply-To:'& header when the message is
23443 specified by the transport.
23444
23445
23446 .option return_message autoreply boolean false
23447 If this is set, a copy of the original message is returned with the new
23448 message, subject to the maximum size set in the &%return_size_limit%& global
23449 configuration option.
23450
23451
23452 .option subject autoreply string&!! unset
23453 This specifies the contents of the &'Subject:'& header when the message is
23454 specified by the transport. It is tempting to quote the original subject in
23455 automatic responses. For example:
23456 .code
23457 subject = Re: $h_subject:
23458 .endd
23459 There is a danger in doing this, however. It may allow a third party to
23460 subscribe your users to an opt-in mailing list, provided that the list accepts
23461 bounce messages as subscription confirmations. Well-managed lists require a
23462 non-bounce message to confirm a subscription, so the danger is relatively
23463 small.
23464
23465
23466
23467 .option text autoreply string&!! unset
23468 This specifies a single string to be used as the body of the message when the
23469 message is specified by the transport. If both &%text%& and &%file%& are set,
23470 the text comes first.
23471
23472
23473 .option to autoreply string&!! unset
23474 This specifies recipients of the message and the contents of the &'To:'& header
23475 when the message is specified by the transport.
23476 .ecindex IIDauttra1
23477 .ecindex IIDauttra2
23478
23479
23480
23481
23482 . ////////////////////////////////////////////////////////////////////////////
23483 . ////////////////////////////////////////////////////////////////////////////
23484
23485 .chapter "The lmtp transport" "CHAPLMTP"
23486 .cindex "transports" "&(lmtp)&"
23487 .cindex "&(lmtp)& transport"
23488 .cindex "LMTP" "over a pipe"
23489 .cindex "LMTP" "over a socket"
23490 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23491 specified command
23492 or by interacting with a Unix domain socket.
23493 This transport is something of a cross between the &(pipe)& and &(smtp)&
23494 transports. Exim also has support for using LMTP over TCP/IP; this is
23495 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23496 to be of minority interest, the default build-time configure in &_src/EDITME_&
23497 has it commented out. You need to ensure that
23498 .code
23499 TRANSPORT_LMTP=yes
23500 .endd
23501 .cindex "options" "&(lmtp)& transport"
23502 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23503 included in the Exim binary. The private options of the &(lmtp)& transport are
23504 as follows:
23505
23506 .option batch_id lmtp string&!! unset
23507 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23508
23509
23510 .option batch_max lmtp integer 1
23511 This limits the number of addresses that can be handled in a single delivery.
23512 Most LMTP servers can handle several addresses at once, so it is normally a
23513 good idea to increase this value. See the description of local delivery
23514 batching in chapter &<<CHAPbatching>>&.
23515
23516
23517 .option command lmtp string&!! unset
23518 This option must be set if &%socket%& is not set. The string is a command which
23519 is run in a separate process. It is split up into a command name and list of
23520 arguments, each of which is separately expanded (so expansion cannot change the
23521 number of arguments). The command is run directly, not via a shell. The message
23522 is passed to the new process using the standard input and output to operate the
23523 LMTP protocol.
23524
23525 .option ignore_quota lmtp boolean false
23526 .cindex "LMTP" "ignoring quota errors"
23527 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23528 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23529 in its response to the LHLO command.
23530
23531 .option socket lmtp string&!! unset
23532 This option must be set if &%command%& is not set. The result of expansion must
23533 be the name of a Unix domain socket. The transport connects to the socket and
23534 delivers the message to it using the LMTP protocol.
23535
23536
23537 .option timeout lmtp time 5m
23538 The transport is aborted if the created process or Unix domain socket does not
23539 respond to LMTP commands or message input within this timeout. Delivery
23540 is deferred, and will be tried again later. Here is an example of a typical
23541 LMTP transport:
23542 .code
23543 lmtp:
23544   driver = lmtp
23545   command = /some/local/lmtp/delivery/program
23546   batch_max = 20
23547   user = exim
23548 .endd
23549 This delivers up to 20 addresses at a time, in a mixture of domains if
23550 necessary, running as the user &'exim'&.
23551
23552
23553
23554 . ////////////////////////////////////////////////////////////////////////////
23555 . ////////////////////////////////////////////////////////////////////////////
23556
23557 .chapter "The pipe transport" "CHAPpipetransport"
23558 .scindex IIDpiptra1 "transports" "&(pipe)&"
23559 .scindex IIDpiptra2 "&(pipe)& transport"
23560 The &(pipe)& transport is used to deliver messages via a pipe to a command
23561 running in another process. One example is the use of &(pipe)& as a
23562 pseudo-remote transport for passing messages to some other delivery mechanism
23563 (such as UUCP). Another is the use by individual users to automatically process
23564 their incoming messages. The &(pipe)& transport can be used in one of the
23565 following ways:
23566
23567 .ilist
23568 .vindex "&$local_part$&"
23569 A router routes one address to a transport in the normal way, and the
23570 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23571 contains the local part of the address (as usual), and the command that is run
23572 is specified by the &%command%& option on the transport.
23573 .next
23574 .vindex "&$pipe_addresses$&"
23575 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23576 transport can handle more than one address in a single run. In this case, when
23577 more than one address is routed to the transport, &$local_part$& is not set
23578 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23579 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23580 that are routed to the transport.
23581 .next
23582 .vindex "&$address_pipe$&"
23583 A router redirects an address directly to a pipe command (for example, from an
23584 alias or forward file). In this case, &$address_pipe$& contains the text of the
23585 pipe command, and the &%command%& option on the transport is ignored unless
23586 &%force_command%& is set. If only one address is being transported
23587 (&%batch_max%& is not greater than one, or only one address was redirected to
23588 this pipe command), &$local_part$& contains the local part that was redirected.
23589 .endlist
23590
23591
23592 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23593 deliver messages over pipes using the LMTP interactive protocol. This is
23594 implemented by the &(lmtp)& transport.
23595
23596 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23597 &_.forward_& file, the command runs under the uid and gid of that user. In
23598 other cases, the uid and gid have to be specified explicitly, either on the
23599 transport or on the router that handles the address. Current and &"home"&
23600 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23601 details of the local delivery environment and chapter &<<CHAPbatching>>&
23602 for a discussion of local delivery batching.
23603
23604
23605 .section "Concurrent delivery" "SECID140"
23606 If two messages arrive at almost the same time, and both are routed to a pipe
23607 delivery, the two pipe transports may be run concurrently. You must ensure that
23608 any pipe commands you set up are robust against this happening. If the commands
23609 write to a file, the &%exim_lock%& utility might be of use.
23610 Alternatively the &%max_parallel%& option could be used with a value
23611 of "1" to enforce serialization.
23612
23613
23614
23615
23616 .section "Returned status and data" "SECID141"
23617 .cindex "&(pipe)& transport" "returned data"
23618 If the command exits with a non-zero return code, the delivery is deemed to
23619 have failed, unless either the &%ignore_status%& option is set (in which case
23620 the return code is treated as zero), or the return code is one of those listed
23621 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23622 later"&. In this case, delivery is deferred. Details of a permanent failure are
23623 logged, but are not included in the bounce message, which merely contains
23624 &"local delivery failed"&.
23625
23626 If the command exits on a signal and the &%freeze_signal%& option is set then
23627 the message will be frozen in the queue. If that option is not set, a bounce
23628 will be sent as normal.
23629
23630 If the return code is greater than 128 and the command being run is a shell
23631 script, it normally means that the script was terminated by a signal whose
23632 value is the return code minus 128. The &%freeze_signal%& option does not
23633 apply in this case.
23634
23635 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23636 return code is set to 127. This is the value that a shell returns if it is
23637 asked to run a non-existent command. The wording for the log line suggests that
23638 a non-existent command may be the problem.
23639
23640 The &%return_output%& option can affect the result of a pipe delivery. If it is
23641 set and the command produces any output on its standard output or standard
23642 error streams, the command is considered to have failed, even if it gave a zero
23643 return code or if &%ignore_status%& is set. The output from the command is
23644 included as part of the bounce message. The &%return_fail_output%& option is
23645 similar, except that output is returned only when the command exits with a
23646 failure return code, that is, a value other than zero or a code that matches
23647 &%temp_errors%&.
23648
23649
23650
23651 .section "How the command is run" "SECThowcommandrun"
23652 .cindex "&(pipe)& transport" "path for command"
23653 The command line is (by default) broken down into a command name and arguments
23654 by the &(pipe)& transport itself. The &%allow_commands%& and
23655 &%restrict_to_path%& options can be used to restrict the commands that may be
23656 run.
23657
23658 .cindex "quoting" "in pipe command"
23659 Unquoted arguments are delimited by white space. If an argument appears in
23660 double quotes, backslash is interpreted as an escape character in the usual
23661 way. If an argument appears in single quotes, no escaping is done.
23662
23663 String expansion is applied to the command line except when it comes from a
23664 traditional &_.forward_& file (commands from a filter file are expanded). The
23665 expansion is applied to each argument in turn rather than to the whole line.
23666 For this reason, any string expansion item that contains white space must be
23667 quoted so as to be contained within a single argument. A setting such as
23668 .code
23669 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23670 .endd
23671 will not work, because the expansion item gets split between several
23672 arguments. You have to write
23673 .code
23674 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23675 .endd
23676 to ensure that it is all in one argument. The expansion is done in this way,
23677 argument by argument, so that the number of arguments cannot be changed as a
23678 result of expansion, and quotes or backslashes in inserted variables do not
23679 interact with external quoting. However, this leads to problems if you want to
23680 generate multiple arguments (or the command name plus arguments) from a single
23681 expansion. In this situation, the simplest solution is to use a shell. For
23682 example:
23683 .code
23684 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23685 .endd
23686
23687 .cindex "transport" "filter"
23688 .cindex "filter" "transport filter"
23689 .vindex "&$pipe_addresses$&"
23690 Special handling takes place when an argument consists of precisely the text
23691 &`$pipe_addresses`& (no quotes).
23692 This is not a general expansion variable; the only
23693 place this string is recognized is when it appears as an argument for a pipe or
23694 transport filter command. It causes each address that is being handled to be
23695 inserted in the argument list at that point &'as a separate argument'&. This
23696 avoids any problems with spaces or shell metacharacters, and is of use when a
23697 &(pipe)& transport is handling groups of addresses in a batch.
23698
23699 If &%force_command%& is enabled on the transport, Special handling takes place
23700 for an argument that consists of precisely the text &`$address_pipe`&.  It
23701 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23702 argument is inserted in the argument list at that point
23703 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23704 the only item in the argument; in fact, if it were then &%force_command%&
23705 should behave as a no-op.  Rather, it should be used to adjust the command
23706 run while preserving the argument vector separation.
23707
23708 After splitting up into arguments and expansion, the resulting command is run
23709 in a subprocess directly from the transport, &'not'& under a shell. The
23710 message that is being delivered is supplied on the standard input, and the
23711 standard output and standard error are both connected to a single pipe that is
23712 read by Exim. The &%max_output%& option controls how much output the command
23713 may produce, and the &%return_output%& and &%return_fail_output%& options
23714 control what is done with it.
23715
23716 Not running the command under a shell (by default) lessens the security risks
23717 in cases when a command from a user's filter file is built out of data that was
23718 taken from an incoming message. If a shell is required, it can of course be
23719 explicitly specified as the command to be run. However, there are circumstances
23720 where existing commands (for example, in &_.forward_& files) expect to be run
23721 under a shell and cannot easily be modified. To allow for these cases, there is
23722 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23723 works. Instead of breaking up the command line as just described, it expands it
23724 as a single string and passes the result to &_/bin/sh_&. The
23725 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23726 with &%use_shell%&, and the whole mechanism is inherently less secure.
23727
23728
23729
23730 .section "Environment variables" "SECTpipeenv"
23731 .cindex "&(pipe)& transport" "environment for command"
23732 .cindex "environment" "&(pipe)& transport"
23733 The environment variables listed below are set up when the command is invoked.
23734 This list is a compromise for maximum compatibility with other MTAs. Note that
23735 the &%environment%& option can be used to add additional variables to this
23736 environment. The environment for the &(pipe)& transport is not subject
23737 to the &%add_environment%& and &%keep_environment%& main config options.
23738 .display
23739 &`DOMAIN            `&   the domain of the address
23740 &`HOME              `&   the home directory, if set
23741 &`HOST              `&   the host name when called from a router (see below)
23742 &`LOCAL_PART        `&   see below
23743 &`LOCAL_PART_PREFIX `&   see below
23744 &`LOCAL_PART_SUFFIX `&   see below
23745 &`LOGNAME           `&   see below
23746 &`MESSAGE_ID        `&   Exim's local ID for the message
23747 &`PATH              `&   as specified by the &%path%& option below
23748 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23749 &`RECIPIENT         `&   the complete recipient address
23750 &`SENDER            `&   the sender of the message (empty if a bounce)
23751 &`SHELL             `&   &`/bin/sh`&
23752 &`TZ                `&   the value of the &%timezone%& option, if set
23753 &`USER              `&   see below
23754 .endd
23755 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23756 router, LOCAL_PART is set to the local part of the address. When it is
23757 called as a result of a forward or alias expansion, LOCAL_PART is set to
23758 the local part of the address that was expanded. In both cases, any affixes are
23759 removed from the local part, and made available in LOCAL_PART_PREFIX and
23760 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23761 same value as LOCAL_PART for compatibility with other MTAs.
23762
23763 .cindex "HOST"
23764 HOST is set only when a &(pipe)& transport is called from a router that
23765 associates hosts with an address, typically when using &(pipe)& as a
23766 pseudo-remote transport. HOST is set to the first host name specified by
23767 the router.
23768
23769 .cindex "HOME"
23770 If the transport's generic &%home_directory%& option is set, its value is used
23771 for the HOME environment variable. Otherwise, a home directory may be set
23772 by the router's &%transport_home_directory%& option, which defaults to the
23773 user's home directory if &%check_local_user%& is set.
23774
23775
23776 .section "Private options for pipe" "SECID142"
23777 .cindex "options" "&(pipe)& transport"
23778
23779
23780
23781 .option allow_commands pipe "string list&!!" unset
23782 .cindex "&(pipe)& transport" "permitted commands"
23783 The string is expanded, and is then interpreted as a colon-separated list of
23784 permitted commands. If &%restrict_to_path%& is not set, the only commands
23785 permitted are those in the &%allow_commands%& list. They need not be absolute
23786 paths; the &%path%& option is still used for relative paths. If
23787 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23788 in the &%allow_commands%& list, or a name without any slashes that is found on
23789 the path. In other words, if neither &%allow_commands%& nor
23790 &%restrict_to_path%& is set, there is no restriction on the command, but
23791 otherwise only commands that are permitted by one or the other are allowed. For
23792 example, if
23793 .code
23794 allow_commands = /usr/bin/vacation
23795 .endd
23796 and &%restrict_to_path%& is not set, the only permitted command is
23797 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23798 &%use_shell%& is set.
23799
23800
23801 .option batch_id pipe string&!! unset
23802 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23803
23804
23805 .option batch_max pipe integer 1
23806 This limits the number of addresses that can be handled in a single delivery.
23807 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23808
23809
23810 .option check_string pipe string unset
23811 As &(pipe)& writes the message, the start of each line is tested for matching
23812 &%check_string%&, and if it does, the initial matching characters are replaced
23813 by the contents of &%escape_string%&, provided both are set. The value of
23814 &%check_string%& is a literal string, not a regular expression, and the case of
23815 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23816 of &%check_string%& and &%escape_string%& are forced to values that implement
23817 the SMTP escaping protocol. Any settings made in the configuration file are
23818 ignored.
23819
23820
23821 .option command pipe string&!! unset
23822 This option need not be set when &(pipe)& is being used to deliver to pipes
23823 obtained directly from address redirections. In other cases, the option must be
23824 set, to provide a command to be run. It need not yield an absolute path (see
23825 the &%path%& option below). The command is split up into separate arguments by
23826 Exim, and each argument is separately expanded, as described in section
23827 &<<SECThowcommandrun>>& above.
23828
23829
23830 .option environment pipe string&!! unset
23831 .cindex "&(pipe)& transport" "environment for command"
23832 .cindex "environment" "&(pipe)& transport"
23833 This option is used to add additional variables to the environment in which the
23834 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23835 a string which is expanded, and then interpreted as a colon-separated list of
23836 environment settings of the form <&'name'&>=<&'value'&>.
23837
23838
23839 .option escape_string pipe string unset
23840 See &%check_string%& above.
23841
23842
23843 .option freeze_exec_fail pipe boolean false
23844 .cindex "exec failure"
23845 .cindex "failure of exec"
23846 .cindex "&(pipe)& transport" "failure of exec"
23847 Failure to exec the command in a pipe transport is by default treated like
23848 any other failure while running the command. However, if &%freeze_exec_fail%&
23849 is set, failure to exec is treated specially, and causes the message to be
23850 frozen, whatever the setting of &%ignore_status%&.
23851
23852
23853 .option freeze_signal pipe boolean false
23854 .cindex "signal exit"
23855 .cindex "&(pipe)& transport", "signal exit"
23856 Normally if the process run by a command in a pipe transport exits on a signal,
23857 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23858 frozen in Exim's queue instead.
23859
23860
23861 .option force_command pipe boolean false
23862 .cindex "force command"
23863 .cindex "&(pipe)& transport", "force command"
23864 Normally when a router redirects an address directly to a pipe command
23865 the &%command%& option on the transport is ignored.  If &%force_command%&
23866 is set, the &%command%& option will used. This is especially
23867 useful for forcing a wrapper or additional argument to be added to the
23868 command. For example:
23869 .code
23870 command = /usr/bin/remote_exec myhost -- $address_pipe
23871 force_command
23872 .endd
23873
23874 Note that &$address_pipe$& is handled specially in &%command%& when
23875 &%force_command%& is set, expanding out to the original argument vector as
23876 separate items, similarly to a Unix shell &`"$@"`& construct.
23877
23878
23879 .option ignore_status pipe boolean false
23880 If this option is true, the status returned by the subprocess that is set up to
23881 run the command is ignored, and Exim behaves as if zero had been returned.
23882 Otherwise, a non-zero status or termination by signal causes an error return
23883 from the transport unless the status value is one of those listed in
23884 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23885
23886 &*Note*&: This option does not apply to timeouts, which do not return a status.
23887 See the &%timeout_defer%& option for how timeouts are handled.
23888
23889
23890 .option log_defer_output pipe boolean false
23891 .cindex "&(pipe)& transport" "logging output"
23892 If this option is set, and the status returned by the command is
23893 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23894 and any output was produced on stdout or stderr, the first line of it is
23895 written to the main log.
23896
23897
23898 .option log_fail_output pipe boolean false
23899 If this option is set, and the command returns any output on stdout or
23900 stderr, and also ends with a return code that is neither zero nor one of
23901 the return codes listed in &%temp_errors%& (that is, the delivery
23902 failed), the first line of output is written to the main log. This
23903 option and &%log_output%& are mutually exclusive.  Only one of them may
23904 be set.
23905
23906
23907 .option log_output pipe boolean false
23908 If this option is set and the command returns any output on stdout or
23909 stderr, the first line of output is written to the main log, whatever
23910 the return code. This option and &%log_fail_output%& are mutually
23911 exclusive. Only one of them may be set.
23912
23913
23914 .option max_output pipe integer 20K
23915 This specifies the maximum amount of output that the command may produce on its
23916 standard output and standard error file combined. If the limit is exceeded, the
23917 process running the command is killed. This is intended as a safety measure to
23918 catch runaway processes. The limit is applied independently of the settings of
23919 the options that control what is done with such output (for example,
23920 &%return_output%&). Because of buffering effects, the amount of output may
23921 exceed the limit by a small amount before Exim notices.
23922
23923
23924 .option message_prefix pipe string&!! "see below"
23925 The string specified here is expanded and output at the start of every message.
23926 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23927 .code
23928 message_prefix = \
23929   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23930   ${tod_bsdinbox}\n
23931 .endd
23932 .cindex "Cyrus"
23933 .cindex "&%tmail%&"
23934 .cindex "&""From""& line"
23935 This is required by the commonly used &_/usr/bin/vacation_& program.
23936 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23937 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23938 setting
23939 .code
23940 message_prefix =
23941 .endd
23942 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23943 &`\n`& to &`\r\n`& in &%message_prefix%&.
23944
23945
23946 .option message_suffix pipe string&!! "see below"
23947 The string specified here is expanded and output at the end of every message.
23948 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23949 The suffix can be suppressed by setting
23950 .code
23951 message_suffix =
23952 .endd
23953 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23954 &`\n`& to &`\r\n`& in &%message_suffix%&.
23955
23956
23957 .option path pipe string&!! "/bin:/usr/bin"
23958 This option is expanded and
23959 specifies the string that is set up in the PATH environment
23960 variable of the subprocess.
23961 If the &%command%& option does not yield an absolute path name, the command is
23962 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23963 apply to a command specified as a transport filter.
23964
23965
23966 .option permit_coredump pipe boolean false
23967 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23968 a core-dump of a pipe command, enable this command.  This enables core-dumps
23969 during delivery and affects both the Exim binary and the pipe command run.
23970 It is recommended that this option remain off unless and until you have a need
23971 for it and that this only be enabled when needed, as the risk of excessive
23972 resource consumption can be quite high.  Note also that Exim is typically
23973 installed as a setuid binary and most operating systems will inhibit coredumps
23974 of these by default, so further OS-specific action may be required.
23975
23976
23977 .option pipe_as_creator pipe boolean false
23978 .cindex "uid (user id)" "local delivery"
23979 If the generic &%user%& option is not set and this option is true, the delivery
23980 process is run under the uid that was in force when Exim was originally called
23981 to accept the message. If the group id is not otherwise set (via the generic
23982 &%group%& option), the gid that was in force when Exim was originally called to
23983 accept the message is used.
23984
23985
23986 .option restrict_to_path pipe boolean false
23987 When this option is set, any command name not listed in &%allow_commands%& must
23988 contain no slashes. The command is searched for only in the directories listed
23989 in the &%path%& option. This option is intended for use in the case when a pipe
23990 command has been generated from a user's &_.forward_& file. This is usually
23991 handled by a &(pipe)& transport called &%address_pipe%&.
23992
23993
23994 .option return_fail_output pipe boolean false
23995 If this option is true, and the command produced any output and ended with a
23996 return code other than zero or one of the codes listed in &%temp_errors%& (that
23997 is, the delivery failed), the output is returned in the bounce message.
23998 However, if the message has a null sender (that is, it is itself a bounce
23999 message), output from the command is discarded. This option and
24000 &%return_output%& are mutually exclusive. Only one of them may be set.
24001
24002
24003
24004 .option return_output pipe boolean false
24005 If this option is true, and the command produced any output, the delivery is
24006 deemed to have failed whatever the return code from the command, and the output
24007 is returned in the bounce message. Otherwise, the output is just discarded.
24008 However, if the message has a null sender (that is, it is a bounce message),
24009 output from the command is always discarded, whatever the setting of this
24010 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24011 of them may be set.
24012
24013
24014
24015 .option temp_errors pipe "string list" "see below"
24016 .cindex "&(pipe)& transport" "temporary failure"
24017 This option contains either a colon-separated list of numbers, or a single
24018 asterisk. If &%ignore_status%& is false
24019 and &%return_output%& is not set,
24020 and the command exits with a non-zero return code, the failure is treated as
24021 temporary and the delivery is deferred if the return code matches one of the
24022 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24023 codes are treated as permanent errors. The default setting contains the codes
24024 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24025 compiled on a system that does not define these macros, it assumes values of 75
24026 and 73, respectively.
24027
24028
24029 .option timeout pipe time 1h
24030 If the command fails to complete within this time, it is killed. This normally
24031 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24032 specifies no timeout. In order to ensure that any subprocesses created by the
24033 command are also killed, Exim makes the initial process a process group leader,
24034 and kills the whole process group on a timeout. However, this can be defeated
24035 if one of the processes starts a new process group.
24036
24037 .option timeout_defer pipe boolean false
24038 A timeout in a &(pipe)& transport, either in the command that the transport
24039 runs, or in a transport filter that is associated with it, is by default
24040 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24041 is set true, both kinds of timeout become temporary errors, causing the
24042 delivery to be deferred.
24043
24044 .option umask pipe "octal integer" 022
24045 This specifies the umask setting for the subprocess that runs the command.
24046
24047
24048 .option use_bsmtp pipe boolean false
24049 .cindex "envelope sender"
24050 If this option is set true, the &(pipe)& transport writes messages in &"batch
24051 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24052 commands. If you want to include a leading HELO command with such messages,
24053 you can do so by setting the &%message_prefix%& option. See section
24054 &<<SECTbatchSMTP>>& for details of batch SMTP.
24055
24056 .option use_classresources pipe boolean false
24057 .cindex "class resources (BSD)"
24058 This option is available only when Exim is running on FreeBSD, NetBSD, or
24059 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24060 resource limits when a &(pipe)& transport is run to perform a delivery. The
24061 limits for the uid under which the pipe is to run are obtained from the login
24062 class database.
24063
24064
24065 .option use_crlf pipe boolean false
24066 .cindex "carriage return"
24067 .cindex "linefeed"
24068 This option causes lines to be terminated with the two-character CRLF sequence
24069 (carriage return, linefeed) instead of just a linefeed character. In the case
24070 of batched SMTP, the byte sequence written to the pipe is then an exact image
24071 of what would be sent down a real SMTP connection.
24072
24073 The contents of the &%message_prefix%& and &%message_suffix%& options are
24074 written verbatim, so must contain their own carriage return characters if these
24075 are needed. When &%use_bsmtp%& is not set, the default values for both
24076 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24077 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24078
24079
24080 .option use_shell pipe boolean false
24081 .vindex "&$pipe_addresses$&"
24082 If this option is set, it causes the command to be passed to &_/bin/sh_&
24083 instead of being run directly from the transport, as described in section
24084 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24085 where the command is expected to be run under a shell and cannot easily be
24086 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24087 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24088 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24089 its &%-c%& option.
24090
24091
24092
24093 .section "Using an external local delivery agent" "SECID143"
24094 .cindex "local delivery" "using an external agent"
24095 .cindex "&'procmail'&"
24096 .cindex "external local delivery"
24097 .cindex "delivery" "&'procmail'&"
24098 .cindex "delivery" "by external agent"
24099 The &(pipe)& transport can be used to pass all messages that require local
24100 delivery to a separate local delivery agent such as &%procmail%&. When doing
24101 this, care must be taken to ensure that the pipe is run under an appropriate
24102 uid and gid. In some configurations one wants this to be a uid that is trusted
24103 by the delivery agent to supply the correct sender of the message. It may be
24104 necessary to recompile or reconfigure the delivery agent so that it trusts an
24105 appropriate user. The following is an example transport and router
24106 configuration for &%procmail%&:
24107 .code
24108 # transport
24109 procmail_pipe:
24110   driver = pipe
24111   command = /usr/local/bin/procmail -d $local_part
24112   return_path_add
24113   delivery_date_add
24114   envelope_to_add
24115   check_string = "From "
24116   escape_string = ">From "
24117   umask = 077
24118   user = $local_part
24119   group = mail
24120
24121 # router
24122 procmail:
24123   driver = accept
24124   check_local_user
24125   transport = procmail_pipe
24126 .endd
24127 In this example, the pipe is run as the local user, but with the group set to
24128 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24129 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24130 user to supply a correct sender address. If you do not specify either a
24131 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24132 home directory is the user's home directory by default.
24133
24134 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24135 .code
24136 IFS=" "
24137 .endd
24138 as shown in some &%procmail%& documentation, because Exim does not by default
24139 use a shell to run pipe commands.
24140
24141 .cindex "Cyrus"
24142 The next example shows a transport and a router for a system where local
24143 deliveries are handled by the Cyrus IMAP server.
24144 .code
24145 # transport
24146 local_delivery_cyrus:
24147   driver = pipe
24148   command = /usr/cyrus/bin/deliver \
24149             -m ${substr_1:$local_part_suffix} -- $local_part
24150   user = cyrus
24151   group = mail
24152   return_output
24153   log_output
24154   message_prefix =
24155   message_suffix =
24156
24157 # router
24158 local_user_cyrus:
24159   driver = accept
24160   check_local_user
24161   local_part_suffix = .*
24162   transport = local_delivery_cyrus
24163 .endd
24164 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24165 &%return_output%& to cause any text written by Cyrus to be returned to the
24166 sender.
24167 .ecindex IIDpiptra1
24168 .ecindex IIDpiptra2
24169
24170
24171 . ////////////////////////////////////////////////////////////////////////////
24172 . ////////////////////////////////////////////////////////////////////////////
24173
24174 .chapter "The smtp transport" "CHAPsmtptrans"
24175 .scindex IIDsmttra1 "transports" "&(smtp)&"
24176 .scindex IIDsmttra2 "&(smtp)& transport"
24177 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24178 or LMTP protocol. The list of hosts to try can either be taken from the address
24179 that is being processed (having been set up by the router), or specified
24180 explicitly for the transport. Timeout and retry processing (see chapter
24181 &<<CHAPretry>>&) is applied to each IP address independently.
24182
24183
24184 .section "Multiple messages on a single connection" "SECID144"
24185 The sending of multiple messages over a single TCP/IP connection can arise in
24186 two ways:
24187
24188 .ilist
24189 If a message contains more than &%max_rcpt%& (see below) addresses that are
24190 routed to the same host, more than one copy of the message has to be sent to
24191 that host. In this situation, multiple copies may be sent in a single run of
24192 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24193 does when it has too many addresses to send in one message also depends on the
24194 value of the global &%remote_max_parallel%& option. Details are given in
24195 section &<<SECToutSMTPTCP>>&.)
24196 .next
24197 .cindex "hints database" "remembering routing"
24198 When a message has been successfully delivered over a TCP/IP connection, Exim
24199 looks in its hints database to see if there are any other messages awaiting a
24200 connection to the same host. If there are, a new delivery process is started
24201 for one of them, and the current TCP/IP connection is passed on to it. The new
24202 process may in turn send multiple copies and possibly create yet another
24203 process.
24204 .endlist
24205
24206
24207 For each copy sent over the same TCP/IP connection, a sequence counter is
24208 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24209 no further messages are sent over that connection.
24210
24211
24212
24213 .section "Use of the $host and $host_address variables" "SECID145"
24214 .vindex "&$host$&"
24215 .vindex "&$host_address$&"
24216 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24217 &$host_address$& are the name and IP address of the first host on the host list
24218 passed by the router. However, when the transport is about to connect to a
24219 specific host, and while it is connected to that host, &$host$& and
24220 &$host_address$& are set to the values for that host. These are the values
24221 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24222 &%serialize_hosts%&, and the various TLS options are expanded.
24223
24224
24225 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24226 .vindex &$tls_bits$&
24227 .vindex &$tls_cipher$&
24228 .vindex &$tls_peerdn$&
24229 .vindex &$tls_sni$&
24230 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24231 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24232 are the values that were set when the message was received.
24233 These are the values that are used for options that are expanded before any
24234 SMTP connections are made. Just before each connection is made, these four
24235 variables are emptied. If TLS is subsequently started, they are set to the
24236 appropriate values for the outgoing connection, and these are the values that
24237 are in force when any authenticators are run and when the
24238 &%authenticated_sender%& option is expanded.
24239
24240 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24241 and will be removed in a future release.
24242
24243
24244 .section "Private options for smtp" "SECID146"
24245 .cindex "options" "&(smtp)& transport"
24246 The private options of the &(smtp)& transport are as follows:
24247
24248
24249 .option address_retry_include_sender smtp boolean true
24250 .cindex "4&'xx'& responses" "retrying after"
24251 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24252 is the combination of sender and recipient that is delayed in subsequent queue
24253 runs until the retry time is reached. You can delay the recipient without
24254 reference to the sender (which is what earlier versions of Exim did), by
24255 setting &%address_retry_include_sender%& false. However, this can lead to
24256 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24257
24258 .option allow_localhost smtp boolean false
24259 .cindex "local host" "sending to"
24260 .cindex "fallback" "hosts specified on transport"
24261 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24262 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24263 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24264 the delivery anyway. This should be used only in special cases when the
24265 configuration ensures that no looping will result (for example, a differently
24266 configured Exim is listening on the port to which the message is sent).
24267
24268
24269 .option authenticated_sender smtp string&!! unset
24270 .cindex "Cyrus"
24271 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24272 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24273 overriding any existing authenticated sender value. If the string expansion is
24274 forced to fail, the option is ignored. Other expansion failures cause delivery
24275 to be deferred. If the result of expansion is an empty string, that is also
24276 ignored.
24277
24278 The expansion happens after the outgoing connection has been made and TLS
24279 started, if required. This means that the &$host$&, &$host_address$&,
24280 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24281 particular connection.
24282
24283 If the SMTP session is not authenticated, the expansion of
24284 &%authenticated_sender%& still happens (and can cause the delivery to be
24285 deferred if it fails), but no AUTH= item is added to MAIL commands
24286 unless &%authenticated_sender_force%& is true.
24287
24288 This option allows you to use the &(smtp)& transport in LMTP mode to
24289 deliver mail to Cyrus IMAP and provide the proper local part as the
24290 &"authenticated sender"&, via a setting such as:
24291 .code
24292 authenticated_sender = $local_part
24293 .endd
24294 This removes the need for IMAP subfolders to be assigned special ACLs to
24295 allow direct delivery to those subfolders.
24296
24297 Because of expected uses such as that just described for Cyrus (when no
24298 domain is involved), there is no checking on the syntax of the provided
24299 value.
24300
24301
24302 .option authenticated_sender_force smtp boolean false
24303 If this option is set true, the &%authenticated_sender%& option's value
24304 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24305 authenticated as a client.
24306
24307
24308 .option command_timeout smtp time 5m
24309 This sets a timeout for receiving a response to an SMTP command that has been
24310 sent out. It is also used when waiting for the initial banner line from the
24311 remote host. Its value must not be zero.
24312
24313
24314 .option connect_timeout smtp time 5m
24315 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24316 to a remote host. A setting of zero allows the system timeout (typically
24317 several minutes) to act. To have any effect, the value of this option must be
24318 less than the system timeout. However, it has been observed that on some
24319 systems there is no system timeout, which is why the default value for this
24320 option is 5 minutes, a value recommended by RFC 1123.
24321
24322
24323 .option connection_max_messages smtp integer 500
24324 .cindex "SMTP" "passed connection"
24325 .cindex "SMTP" "multiple deliveries"
24326 .cindex "multiple SMTP deliveries"
24327 This controls the maximum number of separate message deliveries that are sent
24328 over a single TCP/IP connection. If the value is zero, there is no limit.
24329 For testing purposes, this value can be overridden by the &%-oB%& command line
24330 option.
24331
24332
24333 .option dane_require_tls_ciphers smtp string&!! unset
24334 .cindex "TLS" "requiring specific ciphers for DANE"
24335 .cindex "cipher" "requiring specific"
24336 .cindex DANE "TLS ciphers"
24337 This option may be used to override &%tls_require_ciphers%& for connections
24338 where DANE has been determined to be in effect.
24339 If not set, then &%tls_require_ciphers%& will be used.
24340 Normal SMTP delivery is not able to make strong demands of TLS cipher
24341 configuration, because delivery will fall back to plaintext.  Once DANE has
24342 been determined to be in effect, there is no plaintext fallback and making the
24343 TLS cipherlist configuration stronger will increase security, rather than
24344 counter-intuitively decreasing it.
24345 If the option expands to be empty or is forced to fail, then it will
24346 be treated as unset and &%tls_require_ciphers%& will be used instead.
24347
24348
24349 .option data_timeout smtp time 5m
24350 This sets a timeout for the transmission of each block in the data portion of
24351 the message. As a result, the overall timeout for a message depends on the size
24352 of the message. Its value must not be zero. See also &%final_timeout%&.
24353
24354
24355 .option dkim_canon smtp string&!! unset
24356 .option dkim_domain smtp string list&!! unset
24357 .option dkim_hash smtp string&!! sha256
24358 .option dkim_identity smtp string&!! unset
24359 .option dkim_private_key smtp string&!! unset
24360 .option dkim_selector smtp string&!! unset
24361 .option dkim_strict smtp string&!! unset
24362 .option dkim_sign_headers smtp string&!! "per RFC"
24363 .option dkim_timestamps smtp string&!! unset
24364 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
24365
24366
24367 .option delay_after_cutoff smtp boolean true
24368 .cindex "final cutoff" "retries, controlling"
24369 .cindex retry "final cutoff"
24370 This option controls what happens when all remote IP addresses for a given
24371 domain have been inaccessible for so long that they have passed their retry
24372 cutoff times.
24373
24374 In the default state, if the next retry time has not been reached for any of
24375 them, the address is bounced without trying any deliveries. In other words,
24376 Exim delays retrying an IP address after the final cutoff time until a new
24377 retry time is reached, and can therefore bounce an address without ever trying
24378 a delivery, when machines have been down for a long time. Some people are
24379 unhappy at this prospect, so...
24380
24381 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24382 addresses are past their final cutoff time, Exim tries to deliver to those
24383 IP addresses that have not been tried since the message arrived. If there are
24384 none, of if they all fail, the address is bounced. In other words, it does not
24385 delay when a new message arrives, but immediately tries those expired IP
24386 addresses that haven't been tried since the message arrived. If there is a
24387 continuous stream of messages for the dead hosts, unsetting
24388 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24389 to them.
24390
24391
24392 .option dns_qualify_single smtp boolean true
24393 If the &%hosts%& or &%fallback_hosts%& option is being used,
24394 and the &%gethostbyname%& option is false,
24395 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24396 in chapter &<<CHAPdnslookup>>& for more details.
24397
24398
24399 .option dns_search_parents smtp boolean false
24400 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24401 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24402 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24403 details.
24404
24405
24406 .option dnssec_request_domains smtp "domain list&!!" unset
24407 .cindex "MX record" "security"
24408 .cindex "DNSSEC" "MX lookup"
24409 .cindex "security" "MX lookup"
24410 .cindex "DNS" "DNSSEC"
24411 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24412 the dnssec request bit set.
24413 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24414
24415
24416
24417 .option dnssec_require_domains smtp "domain list&!!" unset
24418 .cindex "MX record" "security"
24419 .cindex "DNSSEC" "MX lookup"
24420 .cindex "security" "MX lookup"
24421 .cindex "DNS" "DNSSEC"
24422 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24423 the dnssec request bit set.  Any returns not having the Authenticated Data bit
24424 (AD bit) set will be ignored and logged as a host-lookup failure.
24425 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24426
24427
24428
24429 .option dscp smtp string&!! unset
24430 .cindex "DCSP" "outbound"
24431 This option causes the DSCP value associated with a socket to be set to one
24432 of a number of fixed strings or to numeric value.
24433 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24434 Common values include &`throughput`&, &`mincost`&, and on newer systems
24435 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24436
24437 The outbound packets from Exim will be marked with this value in the header
24438 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24439 that these values will have any effect, not be stripped by networking
24440 equipment, or do much of anything without cooperation with your Network
24441 Engineer and those of all network operators between the source and destination.
24442
24443
24444 .option fallback_hosts smtp "string list" unset
24445 .cindex "fallback" "hosts specified on transport"
24446 String expansion is not applied to this option. The argument must be a
24447 colon-separated list of host names or IP addresses, optionally also including
24448 port numbers, though the separator can be changed, as described in section
24449 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24450 item in a &%route_list%& setting for the &(manualroute)& router, as described
24451 in section &<<SECTformatonehostitem>>&.
24452
24453 Fallback hosts can also be specified on routers, which associate them with the
24454 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24455 &%fallback_hosts%& specified on the transport is used only if the address does
24456 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24457 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24458 However, &%hosts_randomize%& does apply to fallback host lists.
24459
24460 If Exim is unable to deliver to any of the hosts for a particular address, and
24461 the errors are not permanent rejections, the address is put on a separate
24462 transport queue with its host list replaced by the fallback hosts, unless the
24463 address was routed via MX records and the current host was in the original MX
24464 list. In that situation, the fallback host list is not used.
24465
24466 Once normal deliveries are complete, the fallback queue is delivered by
24467 re-running the same transports with the new host lists. If several failing
24468 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24469 copy of the message is sent.
24470
24471 The resolution of the host names on the fallback list is controlled by the
24472 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24473 both to cases when the host list comes with the address and when it is taken
24474 from &%hosts%&. This option provides a &"use a smart host only if delivery
24475 fails"& facility.
24476
24477
24478 .option final_timeout smtp time 10m
24479 This is the timeout that applies while waiting for the response to the final
24480 line containing just &"."& that terminates a message. Its value must not be
24481 zero.
24482
24483 .option gethostbyname smtp boolean false
24484 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24485 being used, names are looked up using &[gethostbyname()]&
24486 (or &[getipnodebyname()]& when available)
24487 instead of using the DNS. Of course, that function may in fact use the DNS, but
24488 it may also consult other sources of information such as &_/etc/hosts_&.
24489
24490 .option gnutls_compat_mode smtp boolean unset
24491 This option controls whether GnuTLS is used in compatibility mode in an Exim
24492 server. This reduces security slightly, but improves interworking with older
24493 implementations of TLS.
24494
24495 .option helo_data smtp string&!! "see below"
24496 .cindex "HELO" "argument, setting"
24497 .cindex "EHLO" "argument, setting"
24498 .cindex "LHLO argument setting"
24499 The value of this option is expanded after a connection to a another host has
24500 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24501 command that starts the outgoing SMTP or LMTP session. The default value of the
24502 option is:
24503 .code
24504 $primary_hostname
24505 .endd
24506 During the expansion, the variables &$host$& and &$host_address$& are set to
24507 the identity of the remote host, and the variables &$sending_ip_address$& and
24508 &$sending_port$& are set to the local IP address and port number that are being
24509 used. These variables can be used to generate different values for different
24510 servers or different local IP addresses. For example, if you want the string
24511 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24512 interface address, you could use this:
24513 .code
24514 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24515   {$primary_hostname}}
24516 .endd
24517 The use of &%helo_data%& applies both to sending messages and when doing
24518 callouts.
24519
24520 .option hosts smtp "string list&!!" unset
24521 Hosts are associated with an address by a router such as &(dnslookup)&, which
24522 finds the hosts by looking up the address domain in the DNS, or by
24523 &(manualroute)&, which has lists of hosts in its configuration. However,
24524 email addresses can be passed to the &(smtp)& transport by any router, and not
24525 all of them can provide an associated list of hosts.
24526
24527 The &%hosts%& option specifies a list of hosts to be used if the address being
24528 processed does not have any hosts associated with it. The hosts specified by
24529 &%hosts%& are also used, whether or not the address has its own hosts, if
24530 &%hosts_override%& is set.
24531
24532 The string is first expanded, before being interpreted as a colon-separated
24533 list of host names or IP addresses, possibly including port numbers. The
24534 separator may be changed to something other than colon, as described in section
24535 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24536 item in a &%route_list%& setting for the &(manualroute)& router, as described
24537 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24538 of the &(manualroute)& router is not available here.
24539
24540 If the expansion fails, delivery is deferred. Unless the failure was caused by
24541 the inability to complete a lookup, the error is logged to the panic log as
24542 well as the main log. Host names are looked up either by searching directly for
24543 address records in the DNS or by calling &[gethostbyname()]& (or
24544 &[getipnodebyname()]& when available), depending on the setting of the
24545 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24546 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24547 address are used.
24548
24549 During delivery, the hosts are tried in order, subject to their retry status,
24550 unless &%hosts_randomize%& is set.
24551
24552
24553 .option hosts_avoid_esmtp smtp "host list&!!" unset
24554 .cindex "ESMTP, avoiding use of"
24555 .cindex "HELO" "forcing use of"
24556 .cindex "EHLO" "avoiding use of"
24557 .cindex "PIPELINING" "avoiding the use of"
24558 This option is for use with broken hosts that announce ESMTP facilities (for
24559 example, PIPELINING) and then fail to implement them properly. When a host
24560 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24561 start of the SMTP session. This means that it cannot use any of the ESMTP
24562 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24563
24564
24565 .option hosts_avoid_pipelining smtp "host list&!!" unset
24566 .cindex "PIPELINING" "avoiding the use of"
24567 Exim will not use the SMTP PIPELINING extension when delivering to any host
24568 that matches this list, even if the server host advertises PIPELINING support.
24569
24570 .new
24571 .option hosts_pipe_connect smtp "host list&!!" unset
24572 .cindex "pipelining" "early connection"
24573 .cindex "pipelining" PIPE_CONNECT
24574 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24575 this option controls which to hosts the facility watched for
24576 and recorded, and used for subsequent connections.
24577
24578 The retry hints database is used for the record,
24579 and records are subject to the &%retry_data_expire%& option.
24580 When used, the pipelining saves on roundtrip times.
24581 It also turns SMTP into a client-first protocol
24582 so combines well with TCP Fast Open.
24583
24584 Note:
24585 When the facility is used, the transport &%helo_data%& option
24586 will be expanded before the &$sending_ip_address$& variable
24587 is filled in.
24588 A check is made for the use of that variable, without the
24589 presence of a &"def:"& test on it, but suitably complex coding
24590 can avoid the check and produce unexpected results.
24591 You have been warned.
24592 .wen
24593
24594
24595 .option hosts_avoid_tls smtp "host list&!!" unset
24596 .cindex "TLS" "avoiding for certain hosts"
24597 Exim will not try to start a TLS session when delivering to any host that
24598 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24599
24600 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24601 .cindex "TLS" "avoiding for certain hosts"
24602 Exim will not try to start a TLS session for a verify callout,
24603 or when delivering in cutthrough mode,
24604 to any host that matches this list.
24605
24606
24607 .option hosts_max_try smtp integer 5
24608 .cindex "host" "maximum number to try"
24609 .cindex "limit" "number of hosts tried"
24610 .cindex "limit" "number of MX tried"
24611 .cindex "MX record" "maximum tried"
24612 This option limits the number of IP addresses that are tried for any one
24613 delivery in cases where there are temporary delivery errors. Section
24614 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24615
24616
24617 .option hosts_max_try_hardlimit smtp integer 50
24618 This is an additional check on the maximum number of IP addresses that Exim
24619 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24620 why it exists.
24621
24622
24623
24624 .option hosts_nopass_tls smtp "host list&!!" unset
24625 .cindex "TLS" "passing connection"
24626 .cindex "multiple SMTP deliveries"
24627 .cindex "TLS" "multiple message deliveries"
24628 For any host that matches this list, a connection on which a TLS session has
24629 been started will not be passed to a new delivery process for sending another
24630 message on the same connection. See section &<<SECTmulmessam>>& for an
24631 explanation of when this might be needed.
24632
24633 .new
24634 .option hosts_noproxy_tls smtp "host list&!!" unset
24635 .cindex "TLS" "passing connection"
24636 .cindex "multiple SMTP deliveries"
24637 .cindex "TLS" "multiple message deliveries"
24638 For any host that matches this list, a TLS session which has
24639 been started will not be passed to a new delivery process for sending another
24640 message on the same session.
24641 .wen
24642
24643 The traditional implementation closes down TLS and re-starts it in the new
24644 process, on the same open TCP connection, for each successive message
24645 sent.  If permitted by this option a pipe to to the new process is set up
24646 instead, and the original process maintains the TLS connection and proxies
24647 the SMTP connection from and to the new process and any subsequents.
24648 The new process has no access to TLS information, so cannot include it in
24649 logging.
24650
24651
24652
24653 .option hosts_override smtp boolean false
24654 If this option is set and the &%hosts%& option is also set, any hosts that are
24655 attached to the address are ignored, and instead the hosts specified by the
24656 &%hosts%& option are always used. This option does not apply to
24657 &%fallback_hosts%&.
24658
24659
24660 .option hosts_randomize smtp boolean false
24661 .cindex "randomized host list"
24662 .cindex "host" "list of; randomized"
24663 .cindex "fallback" "randomized hosts"
24664 If this option is set, and either the list of hosts is taken from the
24665 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24666 were not obtained from MX records (this includes fallback hosts from the
24667 router), and were not randomized by the router, the order of trying the hosts
24668 is randomized each time the transport runs. Randomizing the order of a host
24669 list can be used to do crude load sharing.
24670
24671 When &%hosts_randomize%& is true, a host list may be split into groups whose
24672 order is separately randomized. This makes it possible to set up MX-like
24673 behaviour. The boundaries between groups are indicated by an item that is just
24674 &`+`& in the host list. For example:
24675 .code
24676 hosts = host1:host2:host3:+:host4:host5
24677 .endd
24678 The order of the first three hosts and the order of the last two hosts is
24679 randomized for each use, but the first three always end up before the last two.
24680 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24681
24682 .option hosts_require_auth smtp "host list&!!" unset
24683 .cindex "authentication" "required by client"
24684 This option provides a list of servers for which authentication must succeed
24685 before Exim will try to transfer a message. If authentication fails for
24686 servers which are not in this list, Exim tries to send unauthenticated. If
24687 authentication fails for one of these servers, delivery is deferred. This
24688 temporary error is detectable in the retry rules, so it can be turned into a
24689 hard failure if required. See also &%hosts_try_auth%&, and chapter
24690 &<<CHAPSMTPAUTH>>& for details of authentication.
24691
24692
24693 .option hosts_request_ocsp smtp "host list&!!" *
24694 .cindex "TLS" "requiring for certain servers"
24695 Exim will request a Certificate Status on a
24696 TLS session for any host that matches this list.
24697 &%tls_verify_certificates%& should also be set for the transport.
24698
24699 .option hosts_require_dane smtp "host list&!!" unset
24700 .cindex DANE "transport options"
24701 .cindex DANE "requiring for certain servers"
24702 If built with DANE support, Exim  will require that a DNSSEC-validated
24703 TLSA record is present for any host matching the list,
24704 and that a DANE-verified TLS connection is made.
24705 There will be no fallback to in-clear communication.
24706 See section &<<SECDANE>>&.
24707
24708 .option hosts_require_ocsp smtp "host list&!!" unset
24709 .cindex "TLS" "requiring for certain servers"
24710 Exim will request, and check for a valid Certificate Status being given, on a
24711 TLS session for any host that matches this list.
24712 &%tls_verify_certificates%& should also be set for the transport.
24713
24714 .option hosts_require_tls smtp "host list&!!" unset
24715 .cindex "TLS" "requiring for certain servers"
24716 Exim will insist on using a TLS session when delivering to any host that
24717 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24718 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24719 incoming messages, use an appropriate ACL.
24720
24721 .option hosts_try_auth smtp "host list&!!" unset
24722 .cindex "authentication" "optional in client"
24723 This option provides a list of servers to which, provided they announce
24724 authentication support, Exim will attempt to authenticate as a client when it
24725 connects. If authentication fails, Exim will try to transfer the message
24726 unauthenticated. See also &%hosts_require_auth%&, and chapter
24727 &<<CHAPSMTPAUTH>>& for details of authentication.
24728
24729 .option hosts_try_chunking smtp "host list&!!" *
24730 .cindex CHUNKING "enabling, in client"
24731 .cindex BDAT "SMTP command"
24732 .cindex "RFC 3030" "CHUNKING"
24733 This option provides a list of servers to which, provided they announce
24734 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24735 BDAT will not be used in conjunction with a transport filter.
24736
24737 .option hosts_try_dane smtp "host list&!!" *
24738 .cindex DANE "transport options"
24739 .cindex DANE "attempting for certain servers"
24740 If built with DANE support, Exim  will lookup a
24741 TLSA record for any host matching the list.
24742 If found and verified by DNSSEC,
24743 a DANE-verified TLS connection is made to that host;
24744 there will be no fallback to in-clear communication.
24745 See section &<<SECDANE>>&.
24746
24747 .option hosts_try_fastopen smtp "host list&!!" *
24748 .cindex "fast open, TCP" "enabling, in client"
24749 .cindex "TCP Fast Open" "enabling, in client"
24750 .cindex "RFC 7413" "TCP Fast Open"
24751 This option provides a list of servers to which, provided
24752 the facility is supported by this system, Exim will attempt to
24753 perform a TCP Fast Open.
24754 No data is sent on the SYN segment but, if the remote server also
24755 supports the facility, it can send its SMTP banner immediately after
24756 the SYN,ACK segment.  This can save up to one round-trip time.
24757
24758 The facility is only active for previously-contacted servers,
24759 as the initiator must present a cookie in the SYN segment.
24760
24761 On (at least some) current Linux distributions the facility must be enabled
24762 in the kernel by the sysadmin before the support is usable.
24763 There is no option for control of the server side; if the system supports
24764 it it is always enabled.  Note that lengthy operations in the connect ACL,
24765 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24766
24767 .option hosts_try_prdr smtp "host list&!!" *
24768 .cindex "PRDR" "enabling, optional in client"
24769 This option provides a list of servers to which, provided they announce
24770 PRDR support, Exim will attempt to negotiate PRDR
24771 for multi-recipient messages.
24772 The option can usually be left as default.
24773
24774 .option interface smtp "string list&!!" unset
24775 .cindex "bind IP address"
24776 .cindex "IP address" "binding"
24777 .vindex "&$host$&"
24778 .vindex "&$host_address$&"
24779 This option specifies which interface to bind to when making an outgoing SMTP
24780 call. The value is an IP address, not an interface name such as
24781 &`eth0`&. Do not confuse this with the interface address that was used when a
24782 message was received, which is in &$received_ip_address$&, formerly known as
24783 &$interface_address$&. The name was changed to minimize confusion with the
24784 outgoing interface address. There is no variable that contains an outgoing
24785 interface address because, unless it is set by this option, its value is
24786 unknown.
24787
24788 During the expansion of the &%interface%& option the variables &$host$& and
24789 &$host_address$& refer to the host to which a connection is about to be made
24790 during the expansion of the string. Forced expansion failure, or an empty
24791 string result causes the option to be ignored. Otherwise, after expansion, the
24792 string must be a list of IP addresses, colon-separated by default, but the
24793 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
24794 For example:
24795 .code
24796 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24797 .endd
24798 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24799 connection. If none of them are the correct type, the option is ignored. If
24800 &%interface%& is not set, or is ignored, the system's IP functions choose which
24801 interface to use if the host has more than one.
24802
24803
24804 .option keepalive smtp boolean true
24805 .cindex "keepalive" "on outgoing connection"
24806 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24807 connections. When set, it causes the kernel to probe idle connections
24808 periodically, by sending packets with &"old"& sequence numbers. The other end
24809 of the connection should send a acknowledgment if the connection is still okay
24810 or a reset if the connection has been aborted. The reason for doing this is
24811 that it has the beneficial effect of freeing up certain types of connection
24812 that can get stuck when the remote host is disconnected without tidying up the
24813 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24814 unreachable hosts.
24815
24816
24817 .option lmtp_ignore_quota smtp boolean false
24818 .cindex "LMTP" "ignoring quota errors"
24819 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24820 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24821 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24822
24823 .option max_rcpt smtp integer 100
24824 .cindex "RCPT" "maximum number of outgoing"
24825 This option limits the number of RCPT commands that are sent in a single
24826 SMTP message transaction. Each set of addresses is treated independently, and
24827 so can cause parallel connections to the same host if &%remote_max_parallel%&
24828 permits this.
24829
24830
24831 .option multi_domain smtp boolean&!! true
24832 .vindex "&$domain$&"
24833 When this option is set, the &(smtp)& transport can handle a number of
24834 addresses containing a mixture of different domains provided they all resolve
24835 to the same list of hosts. Turning the option off restricts the transport to
24836 handling only one domain at a time. This is useful if you want to use
24837 &$domain$& in an expansion for the transport, because it is set only when there
24838 is a single domain involved in a remote delivery.
24839
24840 It is expanded per-address and can depend on any of
24841 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24842 &$host$&, &$host_address$& and &$host_port$&.
24843
24844 .option port smtp string&!! "see below"
24845 .cindex "port" "sending TCP/IP"
24846 .cindex "TCP/IP" "setting outgoing port"
24847 This option specifies the TCP/IP port on the server to which Exim connects.
24848 &*Note:*& Do not confuse this with the port that was used when a message was
24849 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24850 The name was changed to minimize confusion with the outgoing port. There is no
24851 variable that contains an outgoing port.
24852
24853 If the value of this option begins with a digit it is taken as a port number;
24854 otherwise it is looked up using &[getservbyname()]&. The default value is
24855 normally &"smtp"&,
24856 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
24857 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
24858 If the expansion fails, or if a port number cannot be found, delivery
24859 is deferred.
24860
24861 Note that at least one Linux distribution has been seen failing
24862 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
24863
24864
24865
24866 .option protocol smtp string smtp
24867 .cindex "LMTP" "over TCP/IP"
24868 .cindex "ssmtp protocol" "outbound"
24869 .cindex "TLS" "SSL-on-connect outbound"
24870 .vindex "&$port$&"
24871 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24872 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24873 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24874 deliveries into closed message stores. Exim also has support for running LMTP
24875 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24876
24877 If this option is set to &"smtps"&, the default value for the &%port%& option
24878 changes to &"smtps"&, and the transport initiates TLS immediately after
24879 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24880 The Internet standards bodies used to strongly discourage use of this mode,
24881 but as of RFC 8314 it is perferred over STARTTLS for message submission
24882 (as distinct from MTA-MTA communication).
24883
24884
24885 .option retry_include_ip_address smtp boolean&!! true
24886 Exim normally includes both the host name and the IP address in the key it
24887 constructs for indexing retry data after a temporary delivery failure. This
24888 means that when one of several IP addresses for a host is failing, it gets
24889 tried periodically (controlled by the retry rules), but use of the other IP
24890 addresses is not affected.
24891
24892 However, in some dialup environments hosts are assigned a different IP address
24893 each time they connect. In this situation the use of the IP address as part of
24894 the retry key leads to undesirable behaviour. Setting this option false causes
24895 Exim to use only the host name.
24896 Since it is expanded it can be made to depend on the host or domain.
24897
24898
24899 .option serialize_hosts smtp "host list&!!" unset
24900 .cindex "serializing connections"
24901 .cindex "host" "serializing connections"
24902 Because Exim operates in a distributed manner, if several messages for the same
24903 host arrive at around the same time, more than one simultaneous connection to
24904 the remote host can occur. This is not usually a problem except when there is a
24905 slow link between the hosts. In that situation it may be helpful to restrict
24906 Exim to one connection at a time. This can be done by setting
24907 &%serialize_hosts%& to match the relevant hosts.
24908
24909 .cindex "hints database" "serializing deliveries to a host"
24910 Exim implements serialization by means of a hints database in which a record is
24911 written whenever a process connects to one of the restricted hosts. The record
24912 is deleted when the connection is completed. Obviously there is scope for
24913 records to get left lying around if there is a system or program crash. To
24914 guard against this, Exim ignores any records that are more than six hours old.
24915
24916 If you set up this kind of serialization, you should also arrange to delete the
24917 relevant hints database whenever your system reboots. The names of the files
24918 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24919 may be one or two files, depending on the type of DBM in use. The same files
24920 are used for ETRN serialization.
24921
24922 See also the &%max_parallel%& generic transport option.
24923
24924
24925 .option size_addition smtp integer 1024
24926 .cindex "SMTP" "SIZE"
24927 .cindex "message" "size issue for transport filter"
24928 .cindex "size" "of message"
24929 .cindex "transport" "filter"
24930 .cindex "filter" "transport filter"
24931 If a remote SMTP server indicates that it supports the SIZE option of the
24932 MAIL command, Exim uses this to pass over the message size at the start of
24933 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24934 sends, to allow for headers and other text that may be added during delivery by
24935 configuration options or in a transport filter. It may be necessary to increase
24936 this if a lot of text is added to messages.
24937
24938 Alternatively, if the value of &%size_addition%& is set negative, it disables
24939 the use of the SIZE option altogether.
24940
24941
24942 .option socks_proxy smtp string&!! unset
24943 .cindex proxy SOCKS
24944 This option enables use of SOCKS proxies for connections made by the
24945 transport.  For details see section &<<SECTproxySOCKS>>&.
24946
24947
24948 .option tls_certificate smtp string&!! unset
24949 .cindex "TLS" "client certificate, location of"
24950 .cindex "certificate" "client, location of"
24951 .vindex "&$host$&"
24952 .vindex "&$host_address$&"
24953 The value of this option must be the absolute path to a file which contains the
24954 client's certificate, for possible use when sending a message over an encrypted
24955 connection. The values of &$host$& and &$host_address$& are set to the name and
24956 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24957 details of TLS.
24958
24959 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24960 certificate when sending messages as a client. The global option of the same
24961 name specifies the certificate for Exim as a server; it is not automatically
24962 assumed that the same certificate should be used when Exim is operating as a
24963 client.
24964
24965
24966 .option tls_crl smtp string&!! unset
24967 .cindex "TLS" "client certificate revocation list"
24968 .cindex "certificate" "revocation list for client"
24969 This option specifies a certificate revocation list. The expanded value must
24970 be the name of a file that contains a CRL in PEM format.
24971
24972
24973 .option tls_dh_min_bits smtp integer 1024
24974 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24975 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24976 key agreement is negotiated, the server will provide a large prime number
24977 for use.  This option establishes the minimum acceptable size of that number.
24978 If the parameter offered by the server is too small, then the TLS handshake
24979 will fail.
24980
24981 Only supported when using GnuTLS.
24982
24983
24984 .option tls_privatekey smtp string&!! unset
24985 .cindex "TLS" "client private key, location of"
24986 .vindex "&$host$&"
24987 .vindex "&$host_address$&"
24988 The value of this option must be the absolute path to a file which contains the
24989 client's private key. This is used when sending a message over an encrypted
24990 connection using a client certificate. The values of &$host$& and
24991 &$host_address$& are set to the name and address of the server during the
24992 expansion. If this option is unset, or the expansion is forced to fail, or the
24993 result is an empty string, the private key is assumed to be in the same file as
24994 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24995
24996
24997 .option tls_require_ciphers smtp string&!! unset
24998 .cindex "TLS" "requiring specific ciphers"
24999 .cindex "cipher" "requiring specific"
25000 .vindex "&$host$&"
25001 .vindex "&$host_address$&"
25002 The value of this option must be a list of permitted cipher suites, for use
25003 when setting up an outgoing encrypted connection. (There is a global option of
25004 the same name for controlling incoming connections.) The values of &$host$& and
25005 &$host_address$& are set to the name and address of the server during the
25006 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25007 is used in different ways by OpenSSL and GnuTLS (see sections
25008 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25009 ciphers is a preference order.
25010
25011
25012
25013 .option tls_sni smtp string&!! unset
25014 .cindex "TLS" "Server Name Indication"
25015 .vindex "&$tls_sni$&"
25016 If this option is set then it sets the $tls_out_sni variable and causes any
25017 TLS session to pass this value as the Server Name Indication extension to
25018 the remote side, which can be used by the remote side to select an appropriate
25019 certificate and private key for the session.
25020
25021 See &<<SECTtlssni>>& for more information.
25022
25023 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25024 TLS extensions.
25025
25026
25027
25028
25029 .option tls_tempfail_tryclear smtp boolean true
25030 .cindex "4&'xx'& responses" "to STARTTLS"
25031 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25032 setting up a TLS session, this option determines whether or not Exim should try
25033 to deliver the message unencrypted. If it is set false, delivery to the
25034 current host is deferred; if there are other hosts, they are tried. If this
25035 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25036 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25037 TLS negotiation fails, Exim closes the current connection (because it is in an
25038 unknown state), opens a new one to the same host, and then tries the delivery
25039 in clear.
25040
25041
25042 .option tls_try_verify_hosts smtp "host list&!!" *
25043 .cindex "TLS" "server certificate verification"
25044 .cindex "certificate" "verification of server"
25045 This option gives a list of hosts for which, on encrypted connections,
25046 certificate verification will be tried but need not succeed.
25047 The &%tls_verify_certificates%& option must also be set.
25048 Note that unless the host is in this list
25049 TLS connections will be denied to hosts using self-signed certificates
25050 when &%tls_verify_certificates%& is matched.
25051 The &$tls_out_certificate_verified$& variable is set when
25052 certificate verification succeeds.
25053
25054
25055 .option tls_verify_cert_hostnames smtp "host list&!!" *
25056 .cindex "TLS" "server certificate hostname verification"
25057 .cindex "certificate" "verification of server"
25058 This option give a list of hosts for which,
25059 while verifying the server certificate,
25060 checks will be included on the host name
25061 (note that this will generally be the result of a DNS MX lookup)
25062 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25063 limited to being the initial component of a 3-or-more component FQDN.
25064
25065 There is no equivalent checking on client certificates.
25066
25067
25068 .option tls_verify_certificates smtp string&!! system
25069 .cindex "TLS" "server certificate verification"
25070 .cindex "certificate" "verification of server"
25071 .vindex "&$host$&"
25072 .vindex "&$host_address$&"
25073 The value of this option must be either the
25074 word "system"
25075 or the absolute path to
25076 a file or directory containing permitted certificates for servers,
25077 for use when setting up an encrypted connection.
25078
25079 The "system" value for the option will use a location compiled into the SSL library.
25080 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25081 is taken as empty and an explicit location
25082 must be specified.
25083
25084 The use of a directory for the option value is not available for GnuTLS versions
25085 preceding 3.3.6 and a single file must be used.
25086
25087 With OpenSSL the certificates specified
25088 explicitly
25089 either by file or directory
25090 are added to those given by the system default location.
25091
25092 The values of &$host$& and
25093 &$host_address$& are set to the name and address of the server during the
25094 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25095
25096 For back-compatibility,
25097 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25098 (a single-colon empty list counts as being set)
25099 and certificate verification fails the TLS connection is closed.
25100
25101
25102 .option tls_verify_hosts smtp "host list&!!" unset
25103 .cindex "TLS" "server certificate verification"
25104 .cindex "certificate" "verification of server"
25105 This option gives a list of hosts for which, on encrypted connections,
25106 certificate verification must succeed.
25107 The &%tls_verify_certificates%& option must also be set.
25108 If both this option and &%tls_try_verify_hosts%& are unset
25109 operation is as if this option selected all hosts.
25110
25111 .option utf8_downconvert smtp integer!! unset
25112 .cindex utf8 "address downconversion"
25113 .cindex i18n "utf8 address downconversion"
25114 If built with internationalization support,
25115 this option controls conversion of UTF-8 in message addresses
25116 to a-label form.
25117 For details see section &<<SECTi18nMTA>>&.
25118
25119
25120
25121
25122 .section "How the limits for the number of hosts to try are used" &&&
25123          "SECTvalhosmax"
25124 .cindex "host" "maximum number to try"
25125 .cindex "limit" "hosts; maximum number tried"
25126 There are two options that are concerned with the number of hosts that are
25127 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25128 &%hosts_max_try_hardlimit%&.
25129
25130
25131 The &%hosts_max_try%& option limits the number of hosts that are tried
25132 for a single delivery. However, despite the term &"host"& in its name, the
25133 option actually applies to each IP address independently. In other words, a
25134 multihomed host is treated as several independent hosts, just as it is for
25135 retrying.
25136
25137 Many of the larger ISPs have multiple MX records which often point to
25138 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25139 created as a result of routing one of these domains.
25140
25141 Trying every single IP address on such a long list does not seem sensible; if
25142 several at the top of the list fail, it is reasonable to assume there is some
25143 problem that is likely to affect all of them. Roughly speaking, the value of
25144 &%hosts_max_try%& is the maximum number that are tried before deferring the
25145 delivery. However, the logic cannot be quite that simple.
25146
25147 Firstly, IP addresses that are skipped because their retry times have not
25148 arrived do not count, and in addition, addresses that are past their retry
25149 limits are also not counted, even when they are tried. This means that when
25150 some IP addresses are past their retry limits, more than the value of
25151 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25152 that all IP addresses are considered before timing out an email address (but
25153 see below for an exception).
25154
25155 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25156 list to see if there is a subsequent host with a different (higher valued) MX.
25157 If there is, that host is considered next, and the current IP address is used
25158 but not counted. This behaviour helps in the case of a domain with a retry rule
25159 that hardly ever delays any hosts, as is now explained:
25160
25161 Consider the case of a long list of hosts with one MX value, and a few with a
25162 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25163 hosts at the top of the list are tried at first. With the default retry rule,
25164 which specifies increasing retry times, the higher MX hosts are eventually
25165 tried when those at the top of the list are skipped because they have not
25166 reached their retry times.
25167
25168 However, it is common practice to put a fixed short retry time on domains for
25169 large ISPs, on the grounds that their servers are rarely down for very long.
25170 Unfortunately, these are exactly the domains that tend to resolve to long lists
25171 of hosts. The short retry time means that the lowest MX hosts are tried every
25172 time. The attempts may be in a different order because of random sorting, but
25173 without the special MX check, the higher MX hosts would never be tried until
25174 all the lower MX hosts had timed out (which might be several days), because
25175 there are always some lower MX hosts that have reached their retry times. With
25176 the special check, Exim considers at least one IP address from each MX value at
25177 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25178 reached.
25179
25180 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25181 particular, Exim normally eventually tries all the IP addresses before timing
25182 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25183 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25184 been set up with hundreds of IP addresses for some domains. It can
25185 take a very long time indeed for an address to time out in these cases.
25186
25187 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25188 Exim never tries more than this number of IP addresses; if it hits this limit
25189 and they are all timed out, the email address is bounced, even though not all
25190 possible IP addresses have been tried.
25191 .ecindex IIDsmttra1
25192 .ecindex IIDsmttra2
25193
25194
25195
25196
25197
25198 . ////////////////////////////////////////////////////////////////////////////
25199 . ////////////////////////////////////////////////////////////////////////////
25200
25201 .chapter "Address rewriting" "CHAPrewrite"
25202 .scindex IIDaddrew "rewriting" "addresses"
25203 There are some circumstances in which Exim automatically rewrites domains in
25204 addresses. The two most common are when an address is given without a domain
25205 (referred to as an &"unqualified address"&) or when an address contains an
25206 abbreviated domain that is expanded by DNS lookup.
25207
25208 Unqualified envelope addresses are accepted only for locally submitted
25209 messages, or for messages that are received from hosts matching
25210 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25211 appropriate. Unqualified addresses in header lines are qualified if they are in
25212 locally submitted messages, or messages from hosts that are permitted to send
25213 unqualified envelope addresses. Otherwise, unqualified addresses in header
25214 lines are neither qualified nor rewritten.
25215
25216 One situation in which Exim does &'not'& automatically rewrite a domain is
25217 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25218 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25219 do this. The new RFCs do not contain this suggestion.
25220
25221
25222 .section "Explicitly configured address rewriting" "SECID147"
25223 This chapter describes the rewriting rules that can be used in the
25224 main rewrite section of the configuration file, and also in the generic
25225 &%headers_rewrite%& option that can be set on any transport.
25226
25227 Some people believe that configured address rewriting is a Mortal Sin.
25228 Others believe that life is not possible without it. Exim provides the
25229 facility; you do not have to use it.
25230
25231 The main rewriting rules that appear in the &"rewrite"& section of the
25232 configuration file are applied to addresses in incoming messages, both envelope
25233 addresses and addresses in header lines. Each rule specifies the types of
25234 address to which it applies.
25235
25236 Whether or not addresses in header lines are rewritten depends on the origin of
25237 the headers and the type of rewriting. Global rewriting, that is, rewriting
25238 rules from the rewrite section of the configuration file, is applied only to
25239 those headers that were received with the message. Header lines that are added
25240 by ACLs or by a system filter or by individual routers or transports (which
25241 are specific to individual recipient addresses) are not rewritten by the global
25242 rules.
25243
25244 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25245 applies all headers except those added by routers and transports. That is, as
25246 well as the headers that were received with the message, it also applies to
25247 headers that were added by an ACL or a system filter.
25248
25249
25250 In general, rewriting addresses from your own system or domain has some
25251 legitimacy. Rewriting other addresses should be done only with great care and
25252 in special circumstances. The author of Exim believes that rewriting should be
25253 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25254 Although it can sometimes be used as a routing tool, this is very strongly
25255 discouraged.
25256
25257 There are two commonly encountered circumstances where rewriting is used, as
25258 illustrated by these examples:
25259
25260 .ilist
25261 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25262 exchange mail with each other behind a firewall, but there is only a single
25263 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25264 &'hitch.fict.example'& when sending mail off-site.
25265 .next
25266 A host rewrites the local parts of its own users so that, for example,
25267 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25268 .endlist
25269
25270
25271
25272 .section "When does rewriting happen?" "SECID148"
25273 .cindex "rewriting" "timing of"
25274 .cindex "&ACL;" "rewriting addresses in"
25275 Configured address rewriting can take place at several different stages of a
25276 message's processing.
25277
25278 .vindex "&$sender_address$&"
25279 At the start of an ACL for MAIL, the sender address may have been rewritten
25280 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25281 ordinary rewrite rules have yet been applied. If, however, the sender address
25282 is verified in the ACL, it is rewritten before verification, and remains
25283 rewritten thereafter. The subsequent value of &$sender_address$& is the
25284 rewritten address. This also applies if sender verification happens in a
25285 RCPT ACL. Otherwise, when the sender address is not verified, it is
25286 rewritten as soon as a message's header lines have been received.
25287
25288 .vindex "&$domain$&"
25289 .vindex "&$local_part$&"
25290 Similarly, at the start of an ACL for RCPT, the current recipient's address
25291 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25292 rewrite rules have yet been applied to it. However, the behaviour is different
25293 from the sender address when a recipient is verified. The address is rewritten
25294 for the verification, but the rewriting is not remembered at this stage. The
25295 value of &$local_part$& and &$domain$& after verification are always the same
25296 as they were before (that is, they contain the unrewritten &-- except for
25297 SMTP-time rewriting &-- address).
25298
25299 As soon as a message's header lines have been received, all the envelope
25300 recipient addresses are permanently rewritten, and rewriting is also applied to
25301 the addresses in the header lines (if configured). This happens before adding
25302 any header lines that were specified in MAIL or RCPT ACLs, and
25303 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25304 before the DATA ACL and &[local_scan()]& functions are run.
25305
25306 When an address is being routed, either for delivery or for verification,
25307 rewriting is applied immediately to child addresses that are generated by
25308 redirection, unless &%no_rewrite%& is set on the router.
25309
25310 .cindex "envelope sender" "rewriting at transport time"
25311 .cindex "rewriting" "at transport time"
25312 .cindex "header lines" "rewriting at transport time"
25313 At transport time, additional rewriting of addresses in header lines can be
25314 specified by setting the generic &%headers_rewrite%& option on a transport.
25315 This option contains rules that are identical in form to those in the rewrite
25316 section of the configuration file. They are applied to the original message
25317 header lines and any that were added by ACLs or a system filter. They are not
25318 applied to header lines that are added by routers or the transport.
25319
25320 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25321 transport option. However, it is not possible to rewrite envelope recipients at
25322 transport time.
25323
25324
25325
25326
25327 .section "Testing the rewriting rules that apply on input" "SECID149"
25328 .cindex "rewriting" "testing"
25329 .cindex "testing" "rewriting"
25330 Exim's input rewriting configuration appears in a part of the runtime
25331 configuration file headed by &"begin rewrite"&. It can be tested by the
25332 &%-brw%& command line option. This takes an address (which can be a full RFC
25333 2822 address) as its argument. The output is a list of how the address would be
25334 transformed by the rewriting rules for each of the different places it might
25335 appear in an incoming message, that is, for each different header and for the
25336 envelope sender and recipient fields. For example,
25337 .code
25338 exim -brw ph10@exim.workshop.example
25339 .endd
25340 might produce the output
25341 .code
25342 sender: Philip.Hazel@exim.workshop.example
25343 from: Philip.Hazel@exim.workshop.example
25344 to: ph10@exim.workshop.example
25345 cc: ph10@exim.workshop.example
25346 bcc: ph10@exim.workshop.example
25347 reply-to: Philip.Hazel@exim.workshop.example
25348 env-from: Philip.Hazel@exim.workshop.example
25349 env-to: ph10@exim.workshop.example
25350 .endd
25351 which shows that rewriting has been set up for that address when used in any of
25352 the source fields, but not when it appears as a recipient address. At the
25353 present time, there is no equivalent way of testing rewriting rules that are
25354 set for a particular transport.
25355
25356
25357 .section "Rewriting rules" "SECID150"
25358 .cindex "rewriting" "rules"
25359 The rewrite section of the configuration file consists of lines of rewriting
25360 rules in the form
25361 .display
25362 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25363 .endd
25364 Rewriting rules that are specified for the &%headers_rewrite%& generic
25365 transport option are given as a colon-separated list. Each item in the list
25366 takes the same form as a line in the main rewriting configuration (except that
25367 any colons must be doubled, of course).
25368
25369 The formats of source patterns and replacement strings are described below.
25370 Each is terminated by white space, unless enclosed in double quotes, in which
25371 case normal quoting conventions apply inside the quotes. The flags are single
25372 characters which may appear in any order. Spaces and tabs between them are
25373 ignored.
25374
25375 For each address that could potentially be rewritten, the rules are scanned in
25376 order, and replacements for the address from earlier rules can themselves be
25377 replaced by later rules (but see the &"q"& and &"R"& flags).
25378
25379 The order in which addresses are rewritten is undefined, may change between
25380 releases, and must not be relied on, with one exception: when a message is
25381 received, the envelope sender is always rewritten first, before any header
25382 lines are rewritten. For example, the replacement string for a rewrite of an
25383 address in &'To:'& must not assume that the message's address in &'From:'& has
25384 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25385 that the envelope sender has already been rewritten.
25386
25387 .vindex "&$domain$&"
25388 .vindex "&$local_part$&"
25389 The variables &$local_part$& and &$domain$& can be used in the replacement
25390 string to refer to the address that is being rewritten. Note that lookup-driven
25391 rewriting can be done by a rule of the form
25392 .code
25393 *@*   ${lookup ...
25394 .endd
25395 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25396 refer to the address that is being rewritten.
25397
25398
25399 .section "Rewriting patterns" "SECID151"
25400 .cindex "rewriting" "patterns"
25401 .cindex "address list" "in a rewriting pattern"
25402 The source pattern in a rewriting rule is any item which may appear in an
25403 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25404 single-item address list, which means that it is expanded before being tested
25405 against the address. As always, if you use a regular expression as a pattern,
25406 you must take care to escape dollar and backslash characters, or use the &`\N`&
25407 facility to suppress string expansion within the regular expression.
25408
25409 Domains in patterns should be given in lower case. Local parts in patterns are
25410 case-sensitive. If you want to do case-insensitive matching of local parts, you
25411 can use a regular expression that starts with &`^(?i)`&.
25412
25413 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25414 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25415 depending on the type of match which occurred. These can be used in the
25416 replacement string to insert portions of the incoming address. &$0$& always
25417 refers to the complete incoming address. When a regular expression is used, the
25418 numerical variables are set from its capturing subexpressions. For other types
25419 of pattern they are set as follows:
25420
25421 .ilist
25422 If a local part or domain starts with an asterisk, the numerical variables
25423 refer to the character strings matched by asterisks, with &$1$& associated with
25424 the first asterisk, and &$2$& with the second, if present. For example, if the
25425 pattern
25426 .code
25427 *queen@*.fict.example
25428 .endd
25429 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25430 .code
25431 $0 = hearts-queen@wonderland.fict.example
25432 $1 = hearts-
25433 $2 = wonderland
25434 .endd
25435 Note that if the local part does not start with an asterisk, but the domain
25436 does, it is &$1$& that contains the wild part of the domain.
25437
25438 .next
25439 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25440 of the domain are placed in the next available numerical variables. Suppose,
25441 for example, that the address &'foo@bar.baz.example'& is processed by a
25442 rewriting rule of the form
25443 .display
25444 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25445 .endd
25446 and the key in the file that matches the domain is &`*.baz.example`&. Then
25447 .code
25448 $1 = foo
25449 $2 = bar
25450 $3 = baz.example
25451 .endd
25452 If the address &'foo@baz.example'& is looked up, this matches the same
25453 wildcard file entry, and in this case &$2$& is set to the empty string, but
25454 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25455 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25456 whole domain. For non-partial domain lookups, no numerical variables are set.
25457 .endlist
25458
25459
25460 .section "Rewriting replacements" "SECID152"
25461 .cindex "rewriting" "replacements"
25462 If the replacement string for a rule is a single asterisk, addresses that
25463 match the pattern and the flags are &'not'& rewritten, and no subsequent
25464 rewriting rules are scanned. For example,
25465 .code
25466 hatta@lookingglass.fict.example  *  f
25467 .endd
25468 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25469 &'From:'& headers.
25470
25471 .vindex "&$domain$&"
25472 .vindex "&$local_part$&"
25473 If the replacement string is not a single asterisk, it is expanded, and must
25474 yield a fully qualified address. Within the expansion, the variables
25475 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25476 Any letters they contain retain their original case &-- they are not lower
25477 cased. The numerical variables are set up according to the type of pattern that
25478 matched the address, as described above. If the expansion is forced to fail by
25479 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25480 current rule is abandoned, but subsequent rules may take effect. Any other
25481 expansion failure causes the entire rewriting operation to be abandoned, and an
25482 entry written to the panic log.
25483
25484
25485
25486 .section "Rewriting flags" "SECID153"
25487 There are three different kinds of flag that may appear on rewriting rules:
25488
25489 .ilist
25490 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25491 c, f, h, r, s, t.
25492 .next
25493 A flag that specifies rewriting at SMTP time: S.
25494 .next
25495 Flags that control the rewriting process: Q, q, R, w.
25496 .endlist
25497
25498 For rules that are part of the &%headers_rewrite%& generic transport option,
25499 E, F, T, and S are not permitted.
25500
25501
25502
25503 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25504          "SECID154"
25505 .cindex "rewriting" "flags"
25506 If none of the following flag letters, nor the &"S"& flag (see section
25507 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25508 and to both the sender and recipient fields of the envelope, whereas a
25509 transport-time rewriting rule just applies to all headers. Otherwise, the
25510 rewriting rule is skipped unless the relevant addresses are being processed.
25511 .display
25512 &`E`&       rewrite all envelope fields
25513 &`F`&       rewrite the envelope From field
25514 &`T`&       rewrite the envelope To field
25515 &`b`&       rewrite the &'Bcc:'& header
25516 &`c`&       rewrite the &'Cc:'& header
25517 &`f`&       rewrite the &'From:'& header
25518 &`h`&       rewrite all headers
25519 &`r`&       rewrite the &'Reply-To:'& header
25520 &`s`&       rewrite the &'Sender:'& header
25521 &`t`&       rewrite the &'To:'& header
25522 .endd
25523 "All headers" means all of the headers listed above that can be selected
25524 individually, plus their &'Resent-'& versions. It does not include
25525 other headers such as &'Subject:'& etc.
25526
25527 You should be particularly careful about rewriting &'Sender:'& headers, and
25528 restrict this to special known cases in your own domains.
25529
25530
25531 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25532 .cindex "SMTP" "rewriting malformed addresses"
25533 .cindex "RCPT" "rewriting argument of"
25534 .cindex "MAIL" "rewriting argument of"
25535 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25536 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25537 before any other processing; even before syntax checking. The pattern is
25538 required to be a regular expression, and it is matched against the whole of the
25539 data for the command, including any surrounding angle brackets.
25540
25541 .vindex "&$domain$&"
25542 .vindex "&$local_part$&"
25543 This form of rewrite rule allows for the handling of addresses that are not
25544 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25545 input). Because the input is not required to be a syntactically valid address,
25546 the variables &$local_part$& and &$domain$& are not available during the
25547 expansion of the replacement string. The result of rewriting replaces the
25548 original address in the MAIL or RCPT command.
25549
25550
25551 .section "Flags controlling the rewriting process" "SECID155"
25552 There are four flags which control the way the rewriting process works. These
25553 take effect only when a rule is invoked, that is, when the address is of the
25554 correct type (matches the flags) and matches the pattern:
25555
25556 .ilist
25557 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25558 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25559 absence of &"Q"& the rewritten address must always include a domain.
25560 .next
25561 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25562 even if no rewriting actually takes place because of a &"fail"& in the
25563 expansion. The &"q"& flag is not effective if the address is of the wrong type
25564 (does not match the flags) or does not match the pattern.
25565 .next
25566 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25567 address, up to ten times. It can be combined with the &"q"& flag, to stop
25568 rewriting once it fails to match (after at least one successful rewrite).
25569 .next
25570 .cindex "rewriting" "whole addresses"
25571 When an address in a header is rewritten, the rewriting normally applies only
25572 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25573 left unchanged. For example, rewriting might change
25574 .code
25575 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25576 .endd
25577 into
25578 .code
25579 From: Ford Prefect <prefectf@hitch.fict.example>
25580 .endd
25581 .cindex "RFC 2047"
25582 Sometimes there is a need to replace the whole address item, and this can be
25583 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25584 causes an address in a header line to be rewritten, the entire address is
25585 replaced, not just the working part. The replacement must be a complete RFC
25586 2822 address, including the angle brackets if necessary. If text outside angle
25587 brackets contains a character whose value is greater than 126 or less than 32
25588 (except for tab), the text is encoded according to RFC 2047. The character set
25589 is taken from &%headers_charset%&, which gets its default at build time.
25590
25591 When the &"w"& flag is set on a rule that causes an envelope address to be
25592 rewritten, all but the working part of the replacement address is discarded.
25593 .endlist
25594
25595
25596 .section "Rewriting examples" "SECID156"
25597 Here is an example of the two common rewriting paradigms:
25598 .code
25599 *@*.hitch.fict.example  $1@hitch.fict.example
25600 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25601                      {$value}fail}@hitch.fict.example bctfrF
25602 .endd
25603 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25604 the string expansion to fail if the lookup does not succeed. In this context it
25605 has the effect of leaving the original address unchanged, but Exim goes on to
25606 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25607 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25608 explicitly, which would cause the rewritten address to be the same as before,
25609 at the cost of a small bit of processing. Not supplying either of these is an
25610 error, since the rewritten address would then contain no local part.
25611
25612 The first example above replaces the domain with a superior, more general
25613 domain. This may not be desirable for certain local parts. If the rule
25614 .code
25615 root@*.hitch.fict.example  *
25616 .endd
25617 were inserted before the first rule, rewriting would be suppressed for the
25618 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25619
25620 Rewriting can be made conditional on a number of tests, by making use of
25621 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25622 messages that originate outside the local host:
25623 .code
25624 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25625                          {$1@hitch.fict.example}fail}"
25626 .endd
25627 The replacement string is quoted in this example because it contains white
25628 space.
25629
25630 .cindex "rewriting" "bang paths"
25631 .cindex "bang paths" "rewriting"
25632 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25633 an address it treats it as an unqualified local part which it qualifies with
25634 the local qualification domain (if the source of the message is local or if the
25635 remote host is permitted to send unqualified addresses). Rewriting can
25636 sometimes be used to handle simple bang paths with a fixed number of
25637 components. For example, the rule
25638 .code
25639 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25640 .endd
25641 rewrites a two-component bang path &'host.name!user'& as the domain address
25642 &'user@host.name'&. However, there is a security implication in using this as
25643 a global rewriting rule for envelope addresses. It can provide a backdoor
25644 method for using your system as a relay, because the incoming addresses appear
25645 to be local. If the bang path addresses are received via SMTP, it is safer to
25646 use the &"S"& flag to rewrite them as they are received, so that relay checking
25647 can be done on the rewritten addresses.
25648 .ecindex IIDaddrew
25649
25650
25651
25652
25653
25654 . ////////////////////////////////////////////////////////////////////////////
25655 . ////////////////////////////////////////////////////////////////////////////
25656
25657 .chapter "Retry configuration" "CHAPretry"
25658 .scindex IIDretconf1 "retry" "configuration, description of"
25659 .scindex IIDregconf2 "configuration file" "retry section"
25660 The &"retry"& section of the runtime configuration file contains a list of
25661 retry rules that control how often Exim tries to deliver messages that cannot
25662 be delivered at the first attempt. If there are no retry rules (the section is
25663 empty or not present), there are no retries. In this situation, temporary
25664 errors are treated as permanent. The default configuration contains a single,
25665 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25666 line option can be used to test which retry rule will be used for a given
25667 address, domain and error.
25668
25669 The most common cause of retries is temporary failure to deliver to a remote
25670 host because the host is down, or inaccessible because of a network problem.
25671 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25672 address) basis, not on a per-message basis. Thus, if one message has recently
25673 been delayed, delivery of a new message to the same host is not immediately
25674 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25675 log selector is set, the message
25676 .cindex "retry" "time not reached"
25677 &"retry time not reached"& is written to the main log whenever a delivery is
25678 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25679 the handling of errors during remote deliveries.
25680
25681 Retry processing applies to routing as well as to delivering, except as covered
25682 in the next paragraph. The retry rules do not distinguish between these
25683 actions. It is not possible, for example, to specify different behaviour for
25684 failures to route the domain &'snark.fict.example'& and failures to deliver to
25685 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25686 added complication, so did not implement it. However, although they share the
25687 same retry rule, the actual retry times for routing and transporting a given
25688 domain are maintained independently.
25689
25690 When a delivery is not part of a queue run (typically an immediate delivery on
25691 receipt of a message), the routers are always run, and local deliveries are
25692 always attempted, even if retry times are set for them. This makes for better
25693 behaviour if one particular message is causing problems (for example, causing
25694 quota overflow, or provoking an error in a filter file). If such a delivery
25695 suffers a temporary failure, the retry data is updated as normal, and
25696 subsequent delivery attempts from queue runs occur only when the retry time for
25697 the local address is reached.
25698
25699 .section "Changing retry rules" "SECID157"
25700 If you change the retry rules in your configuration, you should consider
25701 whether or not to delete the retry data that is stored in Exim's spool area in
25702 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25703 always safe; that is why they are called &"hints"&.
25704
25705 The hints retry data contains suggested retry times based on the previous
25706 rules. In the case of a long-running problem with a remote host, it might
25707 record the fact that the host has timed out. If your new rules increase the
25708 timeout time for such a host, you should definitely remove the old retry data
25709 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25710 messages that it should now be retaining.
25711
25712
25713
25714 .section "Format of retry rules" "SECID158"
25715 .cindex "retry" "rules"
25716 Each retry rule occupies one line and consists of three or four parts,
25717 separated by white space: a pattern, an error name, an optional list of sender
25718 addresses, and a list of retry parameters. The pattern and sender lists must be
25719 enclosed in double quotes if they contain white space. The rules are searched
25720 in order until one is found where the pattern, error name, and sender list (if
25721 present) match the failing host or address, the error that occurred, and the
25722 message's sender, respectively.
25723
25724
25725 The pattern is any single item that may appear in an address list (see section
25726 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25727 which means that it is expanded before being tested against the address that
25728 has been delayed. A negated address list item is permitted. Address
25729 list processing treats a plain domain name as if it were preceded by &"*@"&,
25730 which makes it possible for many retry rules to start with just a domain. For
25731 example,
25732 .code
25733 lookingglass.fict.example        *  F,24h,30m;
25734 .endd
25735 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25736 whereas
25737 .code
25738 alice@lookingglass.fict.example  *  F,24h,30m;
25739 .endd
25740 applies only to temporary failures involving the local part &%alice%&.
25741 In practice, almost all rules start with a domain name pattern without a local
25742 part.
25743
25744 .cindex "regular expressions" "in retry rules"
25745 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25746 must match a complete address, not just a domain, because that is how regular
25747 expressions work in address lists.
25748 .display
25749 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25750 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25751 .endd
25752
25753
25754 .section "Choosing which retry rule to use for address errors" "SECID159"
25755 When Exim is looking for a retry rule after a routing attempt has failed (for
25756 example, after a DNS timeout), each line in the retry configuration is tested
25757 against the complete address only if &%retry_use_local_part%& is set for the
25758 router. Otherwise, only the domain is used, except when matching against a
25759 regular expression, when the local part of the address is replaced with &"*"&.
25760 A domain on its own can match a domain pattern, or a pattern that starts with
25761 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25762 &%check_local_user%& is true, and false for other routers.
25763
25764 Similarly, when Exim is looking for a retry rule after a local delivery has
25765 failed (for example, after a mailbox full error), each line in the retry
25766 configuration is tested against the complete address only if
25767 &%retry_use_local_part%& is set for the transport (it defaults true for all
25768 local transports).
25769
25770 .cindex "4&'xx'& responses" "retry rules for"
25771 However, when Exim is looking for a retry rule after a remote delivery attempt
25772 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25773 whole address is always used as the key when searching the retry rules. The
25774 rule that is found is used to create a retry time for the combination of the
25775 failing address and the message's sender. It is the combination of sender and
25776 recipient that is delayed in subsequent queue runs until its retry time is
25777 reached. You can delay the recipient without regard to the sender by setting
25778 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25779 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25780 commands.
25781
25782
25783
25784 .section "Choosing which retry rule to use for host and message errors" &&&
25785          "SECID160"
25786 For a temporary error that is not related to an individual address (for
25787 example, a connection timeout), each line in the retry configuration is checked
25788 twice. First, the name of the remote host is used as a domain name (preceded by
25789 &"*@"& when matching a regular expression). If this does not match the line,
25790 the domain from the email address is tried in a similar fashion. For example,
25791 suppose the MX records for &'a.b.c.example'& are
25792 .code
25793 a.b.c.example  MX  5  x.y.z.example
25794                MX  6  p.q.r.example
25795                MX  7  m.n.o.example
25796 .endd
25797 and the retry rules are
25798 .code
25799 p.q.r.example    *      F,24h,30m;
25800 a.b.c.example    *      F,4d,45m;
25801 .endd
25802 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25803 first rule matches neither the host nor the domain, so Exim looks at the second
25804 rule. This does not match the host, but it does match the domain, so it is used
25805 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25806 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25807 first retry rule is used, because it matches the host.
25808
25809 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25810 first rule to determine retry times, but for all the other hosts for the domain
25811 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25812 routing to &'a.b.c.example'& suffers a temporary failure.
25813
25814 &*Note*&: The host name is used when matching the patterns, not its IP address.
25815 However, if a message is routed directly to an IP address without the use of a
25816 host name, for example, if a &(manualroute)& router contains a setting such as:
25817 .code
25818 route_list = *.a.example  192.168.34.23
25819 .endd
25820 then the &"host name"& that is used when searching for a retry rule is the
25821 textual form of the IP address.
25822
25823 .section "Retry rules for specific errors" "SECID161"
25824 .cindex "retry" "specific errors; specifying"
25825 The second field in a retry rule is the name of a particular error, or an
25826 asterisk, which matches any error. The errors that can be tested for are:
25827
25828 .vlist
25829 .vitem &%auth_failed%&
25830 Authentication failed when trying to send to a host in the
25831 &%hosts_require_auth%& list in an &(smtp)& transport.
25832
25833 .vitem &%data_4xx%&
25834 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25835 after the command, or after sending the message's data.
25836
25837 .vitem &%mail_4xx%&
25838 A 4&'xx'& error was received for an outgoing MAIL command.
25839
25840 .vitem &%rcpt_4xx%&
25841 A 4&'xx'& error was received for an outgoing RCPT command.
25842 .endlist
25843
25844 For the three 4&'xx'& errors, either the first or both of the x's can be given
25845 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25846 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25847 and have retries every ten minutes with a one-hour timeout, you could set up a
25848 retry rule of this form:
25849 .code
25850 the.domain.name  rcpt_452   F,1h,10m
25851 .endd
25852 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25853 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25854
25855 .vlist
25856 .vitem &%lost_connection%&
25857 A server unexpectedly closed the SMTP connection. There may, of course,
25858 legitimate reasons for this (host died, network died), but if it repeats a lot
25859 for the same host, it indicates something odd.
25860
25861 .vitem &%lookup%&
25862 A DNS lookup for a host failed.
25863 Note that a &%dnslookup%& router will need to have matched
25864 its &%fail_defer_domains%& option for this retry type to be usable.
25865 Also note that a &%manualroute%& router will probably need
25866 its &%host_find_failed%& option set to &%defer%&.
25867
25868 .vitem &%refused_MX%&
25869 A connection to a host obtained from an MX record was refused.
25870
25871 .vitem &%refused_A%&
25872 A connection to a host not obtained from an MX record was refused.
25873
25874 .vitem &%refused%&
25875 A connection was refused.
25876
25877 .vitem &%timeout_connect_MX%&
25878 A connection attempt to a host obtained from an MX record timed out.
25879
25880 .vitem &%timeout_connect_A%&
25881 A connection attempt to a host not obtained from an MX record timed out.
25882
25883 .vitem &%timeout_connect%&
25884 A connection attempt timed out.
25885
25886 .vitem &%timeout_MX%&
25887 There was a timeout while connecting or during an SMTP session with a host
25888 obtained from an MX record.
25889
25890 .vitem &%timeout_A%&
25891 There was a timeout while connecting or during an SMTP session with a host not
25892 obtained from an MX record.
25893
25894 .vitem &%timeout%&
25895 There was a timeout while connecting or during an SMTP session.
25896
25897 .vitem &%tls_required%&
25898 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25899 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25900 to STARTTLS, or there was a problem setting up the TLS connection.
25901
25902 .vitem &%quota%&
25903 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25904 transport.
25905
25906 .vitem &%quota_%&<&'time'&>
25907 .cindex "quota" "error testing in retry rule"
25908 .cindex "retry" "quota error testing"
25909 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25910 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25911 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25912 for four days.
25913 .endlist
25914
25915 .cindex "mailbox" "time of last read"
25916 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25917 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25918 it should be based on the last time that the user accessed the mailbox.
25919 However, it is not always possible to determine this. Exim uses the following
25920 heuristic rules:
25921
25922 .ilist
25923 If the mailbox is a single file, the time of last access (the &"atime"&) is
25924 used. As no new messages are being delivered (because the mailbox is over
25925 quota), Exim does not access the file, so this is the time of last user access.
25926 .next
25927 .cindex "maildir format" "time of last read"
25928 For a maildir delivery, the time of last modification of the &_new_&
25929 subdirectory is used. As the mailbox is over quota, no new files are created in
25930 the &_new_& subdirectory, because no new messages are being delivered. Any
25931 change to the &_new_& subdirectory is therefore assumed to be the result of an
25932 MUA moving a new message to the &_cur_& directory when it is first read. The
25933 time that is used is therefore the last time that the user read a new message.
25934 .next
25935 For other kinds of multi-file mailbox, the time of last access cannot be
25936 obtained, so a retry rule that uses this type of error field is never matched.
25937 .endlist
25938
25939 The quota errors apply both to system-enforced quotas and to Exim's own quota
25940 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25941 when a local delivery is deferred because a partition is full (the ENOSPC
25942 error).
25943
25944
25945
25946 .section "Retry rules for specified senders" "SECID162"
25947 .cindex "retry" "rules; sender-specific"
25948 You can specify retry rules that apply only when the failing message has a
25949 specific sender. In particular, this can be used to define retry rules that
25950 apply only to bounce messages. The third item in a retry rule can be of this
25951 form:
25952 .display
25953 &`senders=`&<&'address list'&>
25954 .endd
25955 The retry timings themselves are then the fourth item. For example:
25956 .code
25957 *   rcpt_4xx   senders=:   F,1h,30m
25958 .endd
25959 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25960 host. If the address list contains white space, it must be enclosed in quotes.
25961 For example:
25962 .code
25963 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25964 .endd
25965 &*Warning*&: This facility can be unhelpful if it is used for host errors
25966 (which do not depend on the recipient). The reason is that the sender is used
25967 only to match the retry rule. Once the rule has been found for a host error,
25968 its contents are used to set a retry time for the host, and this will apply to
25969 all messages, not just those with specific senders.
25970
25971 When testing retry rules using &%-brt%&, you can supply a sender using the
25972 &%-f%& command line option, like this:
25973 .code
25974 exim -f "" -brt user@dom.ain
25975 .endd
25976 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25977 list is never matched.
25978
25979
25980
25981
25982
25983 .section "Retry parameters" "SECID163"
25984 .cindex "retry" "parameters in rules"
25985 The third (or fourth, if a senders list is present) field in a retry rule is a
25986 sequence of retry parameter sets, separated by semicolons. Each set consists of
25987 .display
25988 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25989 .endd
25990 The letter identifies the algorithm for computing a new retry time; the cutoff
25991 time is the time beyond which this algorithm no longer applies, and the
25992 arguments vary the algorithm's action. The cutoff time is measured from the
25993 time that the first failure for the domain (combined with the local part if
25994 relevant) was detected, not from the time the message was received.
25995
25996 .cindex "retry" "algorithms"
25997 .cindex "retry" "fixed intervals"
25998 .cindex "retry" "increasing intervals"
25999 .cindex "retry" "random intervals"
26000 The available algorithms are:
26001
26002 .ilist
26003 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26004 the interval.
26005 .next
26006 &'G'&: retry at geometrically increasing intervals. The first argument
26007 specifies a starting value for the interval, and the second a multiplier, which
26008 is used to increase the size of the interval at each retry.
26009 .next
26010 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26011 retry, the previous interval is multiplied by the factor in order to get a
26012 maximum for the next interval. The minimum interval is the first argument of
26013 the parameter, and an actual interval is chosen randomly between them. Such a
26014 rule has been found to be helpful in cluster configurations when all the
26015 members of the cluster restart at once, and may therefore synchronize their
26016 queue processing times.
26017 .endlist
26018
26019 When computing the next retry time, the algorithm definitions are scanned in
26020 order until one whose cutoff time has not yet passed is reached. This is then
26021 used to compute a new retry time that is later than the current time. In the
26022 case of fixed interval retries, this simply means adding the interval to the
26023 current time. For geometrically increasing intervals, retry intervals are
26024 computed from the rule's parameters until one that is greater than the previous
26025 interval is found. The main configuration variable
26026 .cindex "limit" "retry interval"
26027 .cindex "retry" "interval, maximum"
26028 .oindex "&%retry_interval_max%&"
26029 &%retry_interval_max%& limits the maximum interval between retries. It
26030 cannot be set greater than &`24h`&, which is its default value.
26031
26032 A single remote domain may have a number of hosts associated with it, and each
26033 host may have more than one IP address. Retry algorithms are selected on the
26034 basis of the domain name, but are applied to each IP address independently. If,
26035 for example, a host has two IP addresses and one is unusable, Exim will
26036 generate retry times for it and will not try to use it until its next retry
26037 time comes. Thus the good IP address is likely to be tried first most of the
26038 time.
26039
26040 .cindex "hints database" "use for retrying"
26041 Retry times are hints rather than promises. Exim does not make any attempt to
26042 run deliveries exactly at the computed times. Instead, a queue runner process
26043 starts delivery processes for delayed messages periodically, and these attempt
26044 new deliveries only for those addresses that have passed their next retry time.
26045 If a new message arrives for a deferred address, an immediate delivery attempt
26046 occurs only if the address has passed its retry time. In the absence of new
26047 messages, the minimum time between retries is the interval between queue runner
26048 processes. There is not much point in setting retry times of five minutes if
26049 your queue runners happen only once an hour, unless there are a significant
26050 number of incoming messages (which might be the case on a system that is
26051 sending everything to a smart host, for example).
26052
26053 The data in the retry hints database can be inspected by using the
26054 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26055 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26056 &'exinext'& utility script can be used to find out what the next retry times
26057 are for the hosts associated with a particular mail domain, and also for local
26058 deliveries that have been deferred.
26059
26060
26061 .section "Retry rule examples" "SECID164"
26062 Here are some example retry rules:
26063 .code
26064 alice@wonderland.fict.example quota_5d  F,7d,3h
26065 wonderland.fict.example       quota_5d
26066 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26067 lookingglass.fict.example     *         F,24h,30m;
26068 *                 refused_A   F,2h,20m;
26069 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26070 .endd
26071 The first rule sets up special handling for mail to
26072 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26073 mailbox has not been read for at least 5 days. Retries continue every three
26074 hours for 7 days. The second rule handles over-quota errors for all other local
26075 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26076 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26077 fail are bounced immediately if the mailbox has not been read for at least 5
26078 days.
26079
26080 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26081 happen every 15 minutes for an hour, then with geometrically increasing
26082 intervals until two days have passed since a delivery first failed. After the
26083 first hour there is a delay of one hour, then two hours, then four hours, and
26084 so on (this is a rather extreme example).
26085
26086 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26087 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26088 all other domains, with special action for connection refusal from hosts that
26089 were not obtained from an MX record.
26090
26091 The final rule in a retry configuration should always have asterisks in the
26092 first two fields so as to provide a general catch-all for any addresses that do
26093 not have their own special handling. This example tries every 15 minutes for 2
26094 hours, then with intervals starting at one hour and increasing by a factor of
26095 1.5 up to 16 hours, then every 8 hours up to 5 days.
26096
26097
26098
26099 .section "Timeout of retry data" "SECID165"
26100 .cindex "timeout" "of retry data"
26101 .oindex "&%retry_data_expire%&"
26102 .cindex "hints database" "data expiry"
26103 .cindex "retry" "timeout of data"
26104 Exim timestamps the data that it writes to its retry hints database. When it
26105 consults the data during a delivery it ignores any that is older than the value
26106 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26107 been tried for 7 days, Exim will try to deliver to it immediately a message
26108 arrives, and if that fails, it will calculate a retry time as if it were
26109 failing for the first time.
26110
26111 This improves the behaviour for messages routed to rarely-used hosts such as MX
26112 backups. If such a host was down at one time, and happens to be down again when
26113 Exim tries a month later, using the old retry data would imply that it had been
26114 down all the time, which is not a justified assumption.
26115
26116 If a host really is permanently dead, this behaviour causes a burst of retries
26117 every now and again, but only if messages routed to it are rare. If there is a
26118 message at least once every 7 days the retry data never expires.
26119
26120
26121
26122
26123 .section "Long-term failures" "SECID166"
26124 .cindex "delivery failure, long-term"
26125 .cindex "retry" "after long-term failure"
26126 Special processing happens when an email address has been failing for so long
26127 that the cutoff time for the last algorithm is reached. For example, using the
26128 default retry rule:
26129 .code
26130 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26131 .endd
26132 the cutoff time is four days. Reaching the retry cutoff is independent of how
26133 long any specific message has been failing; it is the length of continuous
26134 failure for the recipient address that counts.
26135
26136 When the cutoff time is reached for a local delivery, or for all the IP
26137 addresses associated with a remote delivery, a subsequent delivery failure
26138 causes Exim to give up on the address, and a bounce message is generated.
26139 In order to cater for new messages that use the failing address, a next retry
26140 time is still computed from the final algorithm, and is used as follows:
26141
26142 For local deliveries, one delivery attempt is always made for any subsequent
26143 messages. If this delivery fails, the address fails immediately. The
26144 post-cutoff retry time is not used.
26145
26146 .cindex "final cutoff" "retries, controlling"
26147 .cindex retry "final cutoff"
26148 If the delivery is remote, there are two possibilities, controlled by the
26149 .oindex "&%delay_after_cutoff%&"
26150 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26151 default. Until the post-cutoff retry time for one of the IP addresses,
26152 as set by the &%retry_data_expire%& option, is
26153 reached, the failing email address is bounced immediately, without a delivery
26154 attempt taking place. After that time, one new delivery attempt is made to
26155 those IP addresses that are past their retry times, and if that still fails,
26156 the address is bounced and new retry times are computed.
26157
26158 In other words, when all the hosts for a given email address have been failing
26159 for a long time, Exim bounces rather then defers until one of the hosts' retry
26160 times is reached. Then it tries once, and bounces if that attempt fails. This
26161 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26162 to a broken destination, but if the host does recover, Exim will eventually
26163 notice.
26164
26165 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26166 addresses are past their final cutoff time, Exim tries to deliver to those IP
26167 addresses that have not been tried since the message arrived. If there are
26168 no suitable IP addresses, or if they all fail, the address is bounced. In other
26169 words, it does not delay when a new message arrives, but tries the expired
26170 addresses immediately, unless they have been tried since the message arrived.
26171 If there is a continuous stream of messages for the failing domains, setting
26172 &%delay_after_cutoff%& false means that there will be many more attempts to
26173 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26174 true.
26175
26176 .section "Deliveries that work intermittently" "SECID167"
26177 .cindex "retry" "intermittently working deliveries"
26178 Some additional logic is needed to cope with cases where a host is
26179 intermittently available, or when a message has some attribute that prevents
26180 its delivery when others to the same address get through. In this situation,
26181 because some messages are successfully delivered, the &"retry clock"& for the
26182 host or address keeps getting reset by the successful deliveries, and so
26183 failing messages remain in the queue for ever because the cutoff time is never
26184 reached.
26185
26186 Two exceptional actions are applied to prevent this happening. The first
26187 applies to errors that are related to a message rather than a remote host.
26188 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26189 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26190 commands, and quota failures. For this type of error, if a message's arrival
26191 time is earlier than the &"first failed"& time for the error, the earlier time
26192 is used when scanning the retry rules to decide when to try next and when to
26193 time out the address.
26194
26195 The exceptional second action applies in all cases. If a message has been on
26196 the queue for longer than the cutoff time of any applicable retry rule for a
26197 given address, a delivery is attempted for that address, even if it is not yet
26198 time, and if this delivery fails, the address is timed out. A new retry time is
26199 not computed in this case, so that other messages for the same address are
26200 considered immediately.
26201 .ecindex IIDretconf1
26202 .ecindex IIDregconf2
26203
26204
26205
26206
26207
26208
26209 . ////////////////////////////////////////////////////////////////////////////
26210 . ////////////////////////////////////////////////////////////////////////////
26211
26212 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26213 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26214 .scindex IIDauthconf2 "authentication"
26215 The &"authenticators"& section of Exim's runtime configuration is concerned
26216 with SMTP authentication. This facility is an extension to the SMTP protocol,
26217 described in RFC 2554, which allows a client SMTP host to authenticate itself
26218 to a server. This is a common way for a server to recognize clients that are
26219 permitted to use it as a relay. SMTP authentication is not of relevance to the
26220 transfer of mail between servers that have no managerial connection with each
26221 other.
26222
26223 .cindex "AUTH" "description of"
26224 Very briefly, the way SMTP authentication works is as follows:
26225
26226 .ilist
26227 The server advertises a number of authentication &'mechanisms'& in response to
26228 the client's EHLO command.
26229 .next
26230 The client issues an AUTH command, naming a specific mechanism. The command
26231 may, optionally, contain some authentication data.
26232 .next
26233 The server may issue one or more &'challenges'&, to which the client must send
26234 appropriate responses. In simple authentication mechanisms, the challenges are
26235 just prompts for user names and passwords. The server does not have to issue
26236 any challenges &-- in some mechanisms the relevant data may all be transmitted
26237 with the AUTH command.
26238 .next
26239 The server either accepts or denies authentication.
26240 .next
26241 If authentication succeeds, the client may optionally make use of the AUTH
26242 option on the MAIL command to pass an authenticated sender in subsequent
26243 mail transactions. Authentication lasts for the remainder of the SMTP
26244 connection.
26245 .next
26246 If authentication fails, the client may give up, or it may try a different
26247 authentication mechanism, or it may try transferring mail over the
26248 unauthenticated connection.
26249 .endlist
26250
26251 If you are setting up a client, and want to know which authentication
26252 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26253 SMTP port) on the server, and issue an EHLO command. The response to this
26254 includes the list of supported mechanisms. For example:
26255 .display
26256 &`$ `&&*&`telnet server.example 25`&*&
26257 &`Trying 192.168.34.25...`&
26258 &`Connected to server.example.`&
26259 &`Escape character is &#x0027;^]&#x0027;.`&
26260 &`220 server.example ESMTP Exim 4.20 ...`&
26261 &*&`ehlo client.example`&*&
26262 &`250-server.example Hello client.example [10.8.4.5]`&
26263 &`250-SIZE 52428800`&
26264 &`250-PIPELINING`&
26265 &`250-AUTH PLAIN`&
26266 &`250 HELP`&
26267 .endd
26268 The second-last line of this example output shows that the server supports
26269 authentication using the PLAIN mechanism. In Exim, the different authentication
26270 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26271 routers and transports, which authenticators are included in the binary is
26272 controlled by build-time definitions. The following are currently available,
26273 included by setting
26274 .code
26275 AUTH_CRAM_MD5=yes
26276 AUTH_CYRUS_SASL=yes
26277 AUTH_DOVECOT=yes
26278 AUTH_EXTERNAL=yes
26279 AUTH_GSASL=yes
26280 AUTH_HEIMDAL_GSSAPI=yes
26281 AUTH_PLAINTEXT=yes
26282 AUTH_SPA=yes
26283 AUTH_TLS=yes
26284 .endd
26285 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26286 authentication mechanism (RFC 2195), and the second provides an interface to
26287 the Cyrus SASL authentication library.
26288 The third is an interface to Dovecot's authentication system, delegating the
26289 work via a socket interface.
26290 .new
26291 The fourth provides for negotiation of authentication done via non-SMTP means,
26292 as defined by RFC 4422 Appendix A.
26293 .wen
26294 The fifth provides an interface to the GNU SASL authentication library, which
26295 provides mechanisms but typically not data sources.
26296 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26297 supporting setting a server keytab.
26298 The seventh can be configured to support
26299 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26300 not formally documented, but used by several MUAs.
26301 The eighth authenticator
26302 supports Microsoft's &'Secure Password Authentication'& mechanism.
26303 The last is an Exim authenticator but not an SMTP one;
26304 instead it can use information from a TLS negotiation.
26305
26306 The authenticators are configured using the same syntax as other drivers (see
26307 section &<<SECTfordricon>>&). If no authenticators are required, no
26308 authentication section need be present in the configuration file. Each
26309 authenticator can in principle have both server and client functions. When Exim
26310 is receiving SMTP mail, it is acting as a server; when it is sending out
26311 messages over SMTP, it is acting as a client. Authenticator configuration
26312 options are provided for use in both these circumstances.
26313
26314 To make it clear which options apply to which situation, the prefixes
26315 &%server_%& and &%client_%& are used on option names that are specific to
26316 either the server or the client function, respectively. Server and client
26317 functions are disabled if none of their options are set. If an authenticator is
26318 to be used for both server and client functions, a single definition, using
26319 both sets of options, is required. For example:
26320 .code
26321 cram:
26322   driver = cram_md5
26323   public_name = CRAM-MD5
26324   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26325   client_name = ph10
26326   client_secret = secret2
26327 .endd
26328 The &%server_%& option is used when Exim is acting as a server, and the
26329 &%client_%& options when it is acting as a client.
26330
26331 Descriptions of the individual authenticators are given in subsequent chapters.
26332 The remainder of this chapter covers the generic options for the
26333 authenticators, followed by general discussion of the way authentication works
26334 in Exim.
26335
26336 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26337 per-mechanism basis.  Please read carefully to determine which variables hold
26338 account labels such as usercodes and which hold passwords or other
26339 authenticating data.
26340
26341 Note that some mechanisms support two different identifiers for accounts: the
26342 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26343 and &'authz'& are commonly encountered.  The American spelling is standard here.
26344 Conceptually, authentication data such as passwords are tied to the identifier
26345 used to authenticate; servers may have rules to permit one user to act as a
26346 second user, so that after login the session is treated as though that second
26347 user had logged in.  That second user is the &'authorization id'&.  A robust
26348 configuration might confirm that the &'authz'& field is empty or matches the
26349 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26350 as verified data, the &'authz'& as an unverified request which the server might
26351 choose to honour.
26352
26353 A &'realm'& is a text string, typically a domain name, presented by a server
26354 to a client to help it select an account and credentials to use.  In some
26355 mechanisms, the client and server provably agree on the realm, but clients
26356 typically can not treat the realm as secure data to be blindly trusted.
26357
26358
26359
26360 .section "Generic options for authenticators" "SECID168"
26361 .cindex "authentication" "generic options"
26362 .cindex "options" "generic; for authenticators"
26363
26364 .option client_condition authenticators string&!! unset
26365 When Exim is authenticating as a client, it skips any authenticator whose
26366 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26367 used, for example, to skip plain text authenticators when the connection is not
26368 encrypted by a setting such as:
26369 .code
26370 client_condition = ${if !eq{$tls_out_cipher}{}}
26371 .endd
26372
26373
26374 .option client_set_id authenticators string&!! unset
26375 When client authentication succeeds, this condition is expanded; the
26376 result is used in the log lines for outbound messages.
26377 Typically it will be the user name used for authentication.
26378
26379
26380 .option driver authenticators string unset
26381 This option must always be set. It specifies which of the available
26382 authenticators is to be used.
26383
26384
26385 .option public_name authenticators string unset
26386 This option specifies the name of the authentication mechanism that the driver
26387 implements, and by which it is known to the outside world. These names should
26388 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26389 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26390 defaults to the driver's instance name.
26391
26392
26393 .option server_advertise_condition authenticators string&!! unset
26394 When a server is about to advertise an authentication mechanism, the condition
26395 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26396 mechanism is not advertised.
26397 If the expansion fails, the mechanism is not advertised. If the failure was not
26398 forced, and was not caused by a lookup defer, the incident is logged.
26399 See section &<<SECTauthexiser>>& below for further discussion.
26400
26401
26402 .option server_condition authenticators string&!! unset
26403 This option must be set for a &%plaintext%& server authenticator, where it
26404 is used directly to control authentication. See section &<<SECTplainserver>>&
26405 for details.
26406
26407 For the &(gsasl)& authenticator, this option is required for various
26408 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26409
26410 For the other authenticators, &%server_condition%& can be used as an additional
26411 authentication or authorization mechanism that is applied after the other
26412 authenticator conditions succeed. If it is set, it is expanded when the
26413 authenticator would otherwise return a success code. If the expansion is forced
26414 to fail, authentication fails. Any other expansion failure causes a temporary
26415 error code to be returned. If the result of a successful expansion is an empty
26416 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26417 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26418 other result, a temporary error code is returned, with the expanded string as
26419 the error text.
26420
26421
26422 .option server_debug_print authenticators string&!! unset
26423 If this option is set and authentication debugging is enabled (see the &%-d%&
26424 command line option), the string is expanded and included in the debugging
26425 output when the authenticator is run as a server. This can help with checking
26426 out the values of variables.
26427 If expansion of the string fails, the error message is written to the debugging
26428 output, and Exim carries on processing.
26429
26430
26431 .option server_set_id authenticators string&!! unset
26432 .vindex "&$authenticated_id$&"
26433 .vindex "&$authenticated_fail_id$&"
26434 When an Exim server successfully authenticates a client, this string is
26435 expanded using data from the authentication, and preserved for any incoming
26436 messages in the variable &$authenticated_id$&. It is also included in the log
26437 lines for incoming messages. For example, a user/password authenticator
26438 configuration might preserve the user name that was used to authenticate, and
26439 refer to it subsequently during delivery of the message.
26440 On a failing authentication the expansion result is instead saved in
26441 the &$authenticated_fail_id$& variable.
26442 If expansion fails, the option is ignored.
26443
26444
26445 .option server_mail_auth_condition authenticators string&!! unset
26446 This option allows a server to discard authenticated sender addresses supplied
26447 as part of MAIL commands in SMTP connections that are authenticated by the
26448 driver on which &%server_mail_auth_condition%& is set. The option is not used
26449 as part of the authentication process; instead its (unexpanded) value is
26450 remembered for later use.
26451 How it is used is described in the following section.
26452
26453
26454
26455
26456
26457 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26458 .cindex "authentication" "sender; authenticated"
26459 .cindex "AUTH" "on MAIL command"
26460 When a client supplied an AUTH= item on a MAIL command, Exim applies
26461 the following checks before accepting it as the authenticated sender of the
26462 message:
26463
26464 .ilist
26465 If the connection is not using extended SMTP (that is, HELO was used rather
26466 than EHLO), the use of AUTH= is a syntax error.
26467 .next
26468 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26469 .next
26470 .vindex "&$authenticated_sender$&"
26471 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26472 running, the value of &$authenticated_sender$& is set to the value obtained
26473 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26474 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26475 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26476 given for the MAIL command.
26477 .next
26478 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26479 is accepted and placed in &$authenticated_sender$& only if the client has
26480 authenticated.
26481 .next
26482 If the AUTH= value was accepted by either of the two previous rules, and
26483 the client has authenticated, and the authenticator has a setting for the
26484 &%server_mail_auth_condition%&, the condition is checked at this point. The
26485 valued that was saved from the authenticator is expanded. If the expansion
26486 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26487 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26488 the value of &$authenticated_sender$& is retained and passed on with the
26489 message.
26490 .endlist
26491
26492
26493 When &$authenticated_sender$& is set for a message, it is passed on to other
26494 hosts to which Exim authenticates as a client. Do not confuse this value with
26495 &$authenticated_id$&, which is a string obtained from the authentication
26496 process, and which is not usually a complete email address.
26497
26498 .vindex "&$sender_address$&"
26499 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26500 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26501 therefore make use of &$authenticated_sender$&. The converse is not true: the
26502 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26503 ACL is run.
26504
26505
26506
26507 .section "Authentication on an Exim server" "SECTauthexiser"
26508 .cindex "authentication" "on an Exim server"
26509 When Exim receives an EHLO command, it advertises the public names of those
26510 authenticators that are configured as servers, subject to the following
26511 conditions:
26512
26513 .ilist
26514 The client host must match &%auth_advertise_hosts%& (default *).
26515 .next
26516 It the &%server_advertise_condition%& option is set, its expansion must not
26517 yield the empty string, &"0"&, &"no"&, or &"false"&.
26518 .endlist
26519
26520 The order in which the authenticators are defined controls the order in which
26521 the mechanisms are advertised.
26522
26523 Some mail clients (for example, some versions of Netscape) require the user to
26524 provide a name and password for authentication whenever AUTH is advertised,
26525 even though authentication may not in fact be needed (for example, Exim may be
26526 set up to allow unconditional relaying from the client by an IP address check).
26527 You can make such clients more friendly by not advertising AUTH to them.
26528 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26529 that runs for RCPT) to relay without authentication, you should set
26530 .code
26531 auth_advertise_hosts = ! 10.9.8.0/24
26532 .endd
26533 so that no authentication mechanisms are advertised to them.
26534
26535 The &%server_advertise_condition%& controls the advertisement of individual
26536 authentication mechanisms. For example, it can be used to restrict the
26537 advertisement of a particular mechanism to encrypted connections, by a setting
26538 such as:
26539 .code
26540 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26541 .endd
26542 .vindex "&$tls_in_cipher$&"
26543 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26544 yields &"yes"&, which allows the advertisement to happen.
26545
26546 When an Exim server receives an AUTH command from a client, it rejects it
26547 immediately if AUTH was not advertised in response to an earlier EHLO
26548 command. This is the case if
26549
26550 .ilist
26551 The client host does not match &%auth_advertise_hosts%&; or
26552 .next
26553 No authenticators are configured with server options; or
26554 .next
26555 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26556 server authenticators.
26557 .endlist
26558
26559
26560 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26561 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26562 AUTH is accepted from any client host.
26563
26564 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26565 server authentication mechanism that was advertised in response to EHLO and
26566 that matches the one named in the AUTH command. If it finds one, it runs
26567 the appropriate authentication protocol, and authentication either succeeds or
26568 fails. If there is no matching advertised mechanism, the AUTH command is
26569 rejected with a 504 error.
26570
26571 .vindex "&$received_protocol$&"
26572 .vindex "&$sender_host_authenticated$&"
26573 When a message is received from an authenticated host, the value of
26574 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26575 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26576 public name) of the authenticator driver that successfully authenticated the
26577 client from which the message was received. This variable is empty if there was
26578 no successful authentication.
26579
26580 .cindex authentication "expansion item"
26581 Successful authentication sets up information used by the
26582 &$authresults$& expansion item.
26583
26584
26585
26586
26587 .section "Testing server authentication" "SECID169"
26588 .cindex "authentication" "testing a server"
26589 .cindex "AUTH" "testing a server"
26590 .cindex "base64 encoding" "creating authentication test data"
26591 Exim's &%-bh%& option can be useful for testing server authentication
26592 configurations. The data for the AUTH command has to be sent using base64
26593 encoding. A quick way to produce such data for testing is the following Perl
26594 script:
26595 .code
26596 use MIME::Base64;
26597 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26598 .endd
26599 .cindex "binary zero" "in authentication data"
26600 This interprets its argument as a Perl string, and then encodes it. The
26601 interpretation as a Perl string allows binary zeros, which are required for
26602 some kinds of authentication, to be included in the data. For example, a
26603 command line to run this script on such data might be
26604 .code
26605 encode '\0user\0password'
26606 .endd
26607 Note the use of single quotes to prevent the shell interpreting the
26608 backslashes, so that they can be interpreted by Perl to specify characters
26609 whose code value is zero.
26610
26611 &*Warning 1*&: If either of the user or password strings starts with an octal
26612 digit, you must use three zeros instead of one after the leading backslash. If
26613 you do not, the octal digit that starts your string will be incorrectly
26614 interpreted as part of the code for the first character.
26615
26616 &*Warning 2*&: If there are characters in the strings that Perl interprets
26617 specially, you must use a Perl escape to prevent them being misinterpreted. For
26618 example, a command such as
26619 .code
26620 encode '\0user@domain.com\0pas$$word'
26621 .endd
26622 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26623
26624 If you have the &%mimencode%& command installed, another way to do produce
26625 base64-encoded strings is to run the command
26626 .code
26627 echo -e -n `\0user\0password' | mimencode
26628 .endd
26629 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26630 in the argument, and the &%-n%& option specifies no newline at the end of its
26631 output. However, not all versions of &%echo%& recognize these options, so you
26632 should check your version before relying on this suggestion.
26633
26634
26635
26636 .section "Authentication by an Exim client" "SECID170"
26637 .cindex "authentication" "on an Exim client"
26638 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26639 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26640 announces support for authentication, and the host matches an entry in either
26641 of these options, Exim (as a client) tries to authenticate as follows:
26642
26643 .ilist
26644 For each authenticator that is configured as a client, in the order in which
26645 they are defined in the configuration, it searches the authentication
26646 mechanisms announced by the server for one whose name matches the public name
26647 of the authenticator.
26648 .next
26649 .vindex "&$host$&"
26650 .vindex "&$host_address$&"
26651 When it finds one that matches, it runs the authenticator's client code. The
26652 variables &$host$& and &$host_address$& are available for any string expansions
26653 that the client might do. They are set to the server's name and IP address. If
26654 any expansion is forced to fail, the authentication attempt is abandoned, and
26655 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26656 delivery to be deferred.
26657 .next
26658 If the result of the authentication attempt is a temporary error or a timeout,
26659 Exim abandons trying to send the message to the host for the moment. It will
26660 try again later. If there are any backup hosts available, they are tried in the
26661 usual way.
26662 .next
26663 If the response to authentication is a permanent error (5&'xx'& code), Exim
26664 carries on searching the list of authenticators and tries another one if
26665 possible. If all authentication attempts give permanent errors, or if there are
26666 no attempts because no mechanisms match (or option expansions force failure),
26667 what happens depends on whether the host matches &%hosts_require_auth%& or
26668 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26669 delivery is deferred. The error can be detected in the retry rules, and thereby
26670 turned into a permanent error if you wish. In the second case, Exim tries to
26671 deliver the message unauthenticated.
26672 .endlist
26673
26674 Note that the hostlist test for whether to do authentication can be
26675 confused if name-IP lookups change between the time the peer is decided
26676 upon and the time that the transport runs.  For example, with a manualroute
26677 router given a host name, and with DNS "round-robin" used by that name: if
26678 the local resolver cache times out between the router and the transport
26679 running, the transport may get an IP for the name for its authentication
26680 check which does not match the connection peer IP.
26681 No authentication will then be done, despite the names being identical.
26682
26683 For such cases use a separate transport which always authenticates.
26684
26685 .cindex "AUTH" "on MAIL command"
26686 When Exim has authenticated itself to a remote server, it adds the AUTH
26687 parameter to the MAIL commands it sends, if it has an authenticated sender for
26688 the message. If the message came from a remote host, the authenticated sender
26689 is the one that was receiving on an incoming MAIL command, provided that the
26690 incoming connection was authenticated and the &%server_mail_auth%& condition
26691 allowed the authenticated sender to be retained. If a local process calls Exim
26692 to send a message, the sender address that is built from the login name and
26693 &%qualify_domain%& is treated as authenticated. However, if the
26694 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26695 the authenticated sender that was received with the message.
26696 .ecindex IIDauthconf1
26697 .ecindex IIDauthconf2
26698
26699
26700
26701
26702
26703
26704 . ////////////////////////////////////////////////////////////////////////////
26705 . ////////////////////////////////////////////////////////////////////////////
26706
26707 .chapter "The plaintext authenticator" "CHAPplaintext"
26708 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26709 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26710 The &(plaintext)& authenticator can be configured to support the PLAIN and
26711 LOGIN authentication mechanisms, both of which transfer authentication data as
26712 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26713 security risk; you are strongly advised to insist on the use of SMTP encryption
26714 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26715 use unencrypted plain text, you should not use the same passwords for SMTP
26716 connections as you do for login accounts.
26717
26718 .section "Plaintext options" "SECID171"
26719 .cindex "options" "&(plaintext)& authenticator (server)"
26720 When configured as a server, &(plaintext)& uses the following options:
26721
26722 .option server_condition authenticators string&!! unset
26723 This is actually a global authentication option, but it must be set in order to
26724 configure the &(plaintext)& driver as a server. Its use is described below.
26725
26726 .option server_prompts plaintext string&!! unset
26727 The contents of this option, after expansion, must be a colon-separated list of
26728 prompt strings. If expansion fails, a temporary authentication rejection is
26729 given.
26730
26731 .section "Using plaintext in a server" "SECTplainserver"
26732 .cindex "AUTH" "in &(plaintext)& authenticator"
26733 .cindex "binary zero" "in &(plaintext)& authenticator"
26734 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26735         "in &(plaintext)& authenticator"
26736 .vindex "&$auth1$&, &$auth2$&, etc"
26737 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26738
26739 When running as a server, &(plaintext)& performs the authentication test by
26740 expanding a string. The data sent by the client with the AUTH command, or in
26741 response to subsequent prompts, is base64 encoded, and so may contain any byte
26742 values when decoded. If any data is supplied with the command, it is treated as
26743 a list of strings, separated by NULs (binary zeros), the first three of which
26744 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26745 (neither LOGIN nor PLAIN uses more than three strings).
26746
26747 For compatibility with previous releases of Exim, the values are also placed in
26748 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26749 variables for this purpose is now deprecated, as it can lead to confusion in
26750 string expansions that also use them for other things.
26751
26752 If there are more strings in &%server_prompts%& than the number of strings
26753 supplied with the AUTH command, the remaining prompts are used to obtain more
26754 data. Each response from the client may be a list of NUL-separated strings.
26755
26756 .vindex "&$authenticated_id$&"
26757 Once a sufficient number of data strings have been received,
26758 &%server_condition%& is expanded. If the expansion is forced to fail,
26759 authentication fails. Any other expansion failure causes a temporary error code
26760 to be returned. If the result of a successful expansion is an empty string,
26761 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26762 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26763 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26764 For any other result, a temporary error code is returned, with the expanded
26765 string as the error text.
26766
26767 &*Warning*&: If you use a lookup in the expansion to find the user's
26768 password, be sure to make the authentication fail if the user is unknown.
26769 There are good and bad examples at the end of the next section.
26770
26771
26772
26773 .section "The PLAIN authentication mechanism" "SECID172"
26774 .cindex "PLAIN authentication mechanism"
26775 .cindex "authentication" "PLAIN mechanism"
26776 .cindex "binary zero" "in &(plaintext)& authenticator"
26777 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26778 sent as one item of data (that is, one combined string containing two NUL
26779 separators). The data is sent either as part of the AUTH command, or
26780 subsequently in response to an empty prompt from the server.
26781
26782 The second and third strings are a user name and a corresponding password.
26783 Using a single fixed user name and password as an example, this could be
26784 configured as follows:
26785 .code
26786 fixed_plain:
26787   driver = plaintext
26788   public_name = PLAIN
26789   server_prompts = :
26790   server_condition = \
26791     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26792   server_set_id = $auth2
26793 .endd
26794 Note that the default result strings from &%if%& (&"true"& or an empty string)
26795 are exactly what we want here, so they need not be specified. Obviously, if the
26796 password contains expansion-significant characters such as dollar, backslash,
26797 or closing brace, they have to be escaped.
26798
26799 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26800 the end of a string list are ignored). If all the data comes as part of the
26801 AUTH command, as is commonly the case, the prompt is not used. This
26802 authenticator is advertised in the response to EHLO as
26803 .code
26804 250-AUTH PLAIN
26805 .endd
26806 and a client host can authenticate itself by sending the command
26807 .code
26808 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26809 .endd
26810 As this contains three strings (more than the number of prompts), no further
26811 data is required from the client. Alternatively, the client may just send
26812 .code
26813 AUTH PLAIN
26814 .endd
26815 to initiate authentication, in which case the server replies with an empty
26816 prompt. The client must respond with the combined data string.
26817
26818 The data string is base64 encoded, as required by the RFC. This example,
26819 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26820 represents a zero byte. This is split up into three strings, the first of which
26821 is empty. The &%server_condition%& option in the authenticator checks that the
26822 second two are &`username`& and &`mysecret`& respectively.
26823
26824 Having just one fixed user name and password, as in this example, is not very
26825 realistic, though for a small organization with only a handful of
26826 authenticating clients it could make sense.
26827
26828 A more sophisticated instance of this authenticator could use the user name in
26829 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26830 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26831 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26832 This is an incorrect example:
26833 .code
26834 server_condition = \
26835   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26836 .endd
26837 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26838 which it then compares to the supplied password (&$auth3$&). Why is this example
26839 incorrect? It works fine for existing users, but consider what happens if a
26840 non-existent user name is given. The lookup fails, but as no success/failure
26841 strings are given for the lookup, it yields an empty string. Thus, to defeat
26842 the authentication, all a client has to do is to supply a non-existent user
26843 name and an empty password. The correct way of writing this test is:
26844 .code
26845 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26846   {${if eq{$value}{$auth3}}} {false}}
26847 .endd
26848 In this case, if the lookup succeeds, the result is checked; if the lookup
26849 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26850 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26851 always fails if its second argument is empty. However, the second way of
26852 writing the test makes the logic clearer.
26853
26854
26855 .section "The LOGIN authentication mechanism" "SECID173"
26856 .cindex "LOGIN authentication mechanism"
26857 .cindex "authentication" "LOGIN mechanism"
26858 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26859 in a number of programs. No data is sent with the AUTH command. Instead, a
26860 user name and password are supplied separately, in response to prompts. The
26861 plaintext authenticator can be configured to support this as in this example:
26862 .code
26863 fixed_login:
26864   driver = plaintext
26865   public_name = LOGIN
26866   server_prompts = User Name : Password
26867   server_condition = \
26868     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26869   server_set_id = $auth1
26870 .endd
26871 Because of the way plaintext operates, this authenticator accepts data supplied
26872 with the AUTH command (in contravention of the specification of LOGIN), but
26873 if the client does not supply it (as is the case for LOGIN clients), the prompt
26874 strings are used to obtain two data items.
26875
26876 Some clients are very particular about the precise text of the prompts. For
26877 example, Outlook Express is reported to recognize only &"Username:"& and
26878 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26879 strings. It uses the &%ldapauth%& expansion condition to check the user
26880 name and password by binding to an LDAP server:
26881 .code
26882 login:
26883   driver = plaintext
26884   public_name = LOGIN
26885   server_prompts = Username:: : Password::
26886   server_condition = ${if and{{ \
26887     !eq{}{$auth1} }{ \
26888     ldapauth{\
26889       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26890       pass=${quote:$auth2} \
26891       ldap://ldap.example.org/} }} }
26892   server_set_id = uid=$auth1,ou=people,o=example.org
26893 .endd
26894 We have to check that the username is not empty before using it, because LDAP
26895 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26896 operator to correctly quote the DN for authentication. However, the basic
26897 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26898 correct one to use for the password, because quoting is needed only to make
26899 the password conform to the Exim syntax. At the LDAP level, the password is an
26900 uninterpreted string.
26901
26902
26903 .section "Support for different kinds of authentication" "SECID174"
26904 A number of string expansion features are provided for the purpose of
26905 interfacing to different ways of user authentication. These include checking
26906 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26907 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26908 &<<SECTexpcond>>&.
26909
26910
26911
26912
26913 .section "Using plaintext in a client" "SECID175"
26914 .cindex "options" "&(plaintext)& authenticator (client)"
26915 The &(plaintext)& authenticator has two client options:
26916
26917 .option client_ignore_invalid_base64 plaintext boolean false
26918 If the client receives a server prompt that is not a valid base64 string,
26919 authentication is abandoned by default. However, if this option is set true,
26920 the error in the challenge is ignored and the client sends the response as
26921 usual.
26922
26923 .option client_send plaintext string&!! unset
26924 The string is a colon-separated list of authentication data strings. Each
26925 string is independently expanded before being sent to the server. The first
26926 string is sent with the AUTH command; any more strings are sent in response
26927 to prompts from the server. Before each string is expanded, the value of the
26928 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26929 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26930 way. Thus, the prompt that is received in response to sending the first string
26931 (with the AUTH command) can be used in the expansion of the second string, and
26932 so on. If an invalid base64 string is received when
26933 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26934 &$auth$&<&'n'&> variable.
26935
26936 &*Note*&: You cannot use expansion to create multiple strings, because
26937 splitting takes priority and happens first.
26938
26939 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26940 the data, further processing is applied to each string before it is sent. If
26941 there are any single circumflex characters in the string, they are converted to
26942 NULs. Should an actual circumflex be required as data, it must be doubled in
26943 the string.
26944
26945 This is an example of a client configuration that implements the PLAIN
26946 authentication mechanism with a fixed user name and password:
26947 .code
26948 fixed_plain:
26949   driver = plaintext
26950   public_name = PLAIN
26951   client_send = ^username^mysecret
26952 .endd
26953 The lack of colons means that the entire text is sent with the AUTH
26954 command, with the circumflex characters converted to NULs. A similar example
26955 that uses the LOGIN mechanism is:
26956 .code
26957 fixed_login:
26958   driver = plaintext
26959   public_name = LOGIN
26960   client_send = : username : mysecret
26961 .endd
26962 The initial colon means that the first string is empty, so no data is sent with
26963 the AUTH command itself. The remaining strings are sent in response to
26964 prompts.
26965 .ecindex IIDplaiauth1
26966 .ecindex IIDplaiauth2
26967
26968
26969
26970
26971 . ////////////////////////////////////////////////////////////////////////////
26972 . ////////////////////////////////////////////////////////////////////////////
26973
26974 .chapter "The cram_md5 authenticator" "CHID9"
26975 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26976 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26977 .cindex "CRAM-MD5 authentication mechanism"
26978 .cindex "authentication" "CRAM-MD5 mechanism"
26979 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26980 sends a challenge string to the client, and the response consists of a user
26981 name and the CRAM-MD5 digest of the challenge string combined with a secret
26982 string (password) which is known to both server and client. Thus, the secret
26983 is not sent over the network as plain text, which makes this authenticator more
26984 secure than &(plaintext)&. However, the downside is that the secret has to be
26985 available in plain text at either end.
26986
26987
26988 .section "Using cram_md5 as a server" "SECID176"
26989 .cindex "options" "&(cram_md5)& authenticator (server)"
26990 This authenticator has one server option, which must be set to configure the
26991 authenticator as a server:
26992
26993 .option server_secret cram_md5 string&!! unset
26994 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26995 When the server receives the client's response, the user name is placed in
26996 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26997 obtain the password for that user. The server then computes the CRAM-MD5 digest
26998 that the client should have sent, and checks that it received the correct
26999 string. If the expansion of &%server_secret%& is forced to fail, authentication
27000 fails. If the expansion fails for some other reason, a temporary error code is
27001 returned to the client.
27002
27003 For compatibility with previous releases of Exim, the user name is also placed
27004 in &$1$&. However, the use of this variables for this purpose is now
27005 deprecated, as it can lead to confusion in string expansions that also use
27006 numeric variables for other things.
27007
27008 For example, the following authenticator checks that the user name given by the
27009 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27010 user name, authentication fails.
27011 .code
27012 fixed_cram:
27013   driver = cram_md5
27014   public_name = CRAM-MD5
27015   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27016   server_set_id = $auth1
27017 .endd
27018 .vindex "&$authenticated_id$&"
27019 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27020 name in &$authenticated_id$&. A more typical configuration might look up the
27021 secret string in a file, using the user name as the key. For example:
27022 .code
27023 lookup_cram:
27024   driver = cram_md5
27025   public_name = CRAM-MD5
27026   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27027                   {$value}fail}
27028   server_set_id = $auth1
27029 .endd
27030 Note that this expansion explicitly forces failure if the lookup fails
27031 because &$auth1$& contains an unknown user name.
27032
27033 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27034 using the relevant libraries, you need to know the realm to specify in the
27035 lookup and then ask for the &"userPassword"& attribute for that user in that
27036 realm, with:
27037 .code
27038 cyrusless_crammd5:
27039   driver = cram_md5
27040   public_name = CRAM-MD5
27041   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27042                   dbmjz{/etc/sasldb2}{$value}fail}
27043   server_set_id = $auth1
27044 .endd
27045
27046 .section "Using cram_md5 as a client" "SECID177"
27047 .cindex "options" "&(cram_md5)& authenticator (client)"
27048 When used as a client, the &(cram_md5)& authenticator has two options:
27049
27050
27051
27052 .option client_name cram_md5 string&!! "the primary host name"
27053 This string is expanded, and the result used as the user name data when
27054 computing the response to the server's challenge.
27055
27056
27057 .option client_secret cram_md5 string&!! unset
27058 This option must be set for the authenticator to work as a client. Its value is
27059 expanded and the result used as the secret string when computing the response.
27060
27061
27062 .vindex "&$host$&"
27063 .vindex "&$host_address$&"
27064 Different user names and secrets can be used for different servers by referring
27065 to &$host$& or &$host_address$& in the options. Forced failure of either
27066 expansion string is treated as an indication that this authenticator is not
27067 prepared to handle this case. Exim moves on to the next configured client
27068 authenticator. Any other expansion failure causes Exim to give up trying to
27069 send the message to the current server.
27070
27071 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27072 strings, is:
27073 .code
27074 fixed_cram:
27075   driver = cram_md5
27076   public_name = CRAM-MD5
27077   client_name = ph10
27078   client_secret = secret
27079 .endd
27080 .ecindex IIDcramauth1
27081 .ecindex IIDcramauth2
27082
27083
27084
27085 . ////////////////////////////////////////////////////////////////////////////
27086 . ////////////////////////////////////////////////////////////////////////////
27087
27088 .chapter "The cyrus_sasl authenticator" "CHID10"
27089 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27090 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27091 .cindex "Cyrus" "SASL library"
27092 .cindex "Kerberos"
27093 The code for this authenticator was provided by Matthew Byng-Maddick while
27094 at A L Digital Ltd.
27095
27096 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27097 library implementation of the RFC 2222 (&"Simple Authentication and Security
27098 Layer"&). This library supports a number of authentication mechanisms,
27099 including PLAIN and LOGIN, but also several others that Exim does not support
27100 directly. In particular, there is support for Kerberos authentication.
27101
27102 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27103 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27104 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27105 name of the driver to determine which mechanism to support.
27106
27107 Where access to some kind of secret file is required, for example, in GSSAPI
27108 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27109 user, and that the Cyrus SASL library has no way of escalating privileges
27110 by default. You may also find you need to set environment variables,
27111 depending on the driver you are using.
27112
27113 The application name provided by Exim is &"exim"&, so various SASL options may
27114 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27115 Kerberos, note that because of limitations in the GSSAPI interface,
27116 changing the server keytab might need to be communicated down to the Kerberos
27117 layer independently. The mechanism for doing so is dependent upon the Kerberos
27118 implementation.
27119
27120 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27121 may be set to point to an alternative keytab file. Exim will pass this
27122 variable through from its own inherited environment when started as root or the
27123 Exim user. The keytab file needs to be readable by the Exim user.
27124 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27125 environment variable.  In practice, for those releases, the Cyrus authenticator
27126 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27127 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27128
27129
27130 .section "Using cyrus_sasl as a server" "SECID178"
27131 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27132 (on a successful authentication) into &$auth1$&. For compatibility with
27133 previous releases of Exim, the username is also placed in &$1$&. However, the
27134 use of this variable for this purpose is now deprecated, as it can lead to
27135 confusion in string expansions that also use numeric variables for other
27136 things.
27137
27138
27139 .option server_hostname cyrus_sasl string&!! "see below"
27140 This option selects the hostname that is used when communicating with the
27141 library. The default value is &`$primary_hostname`&. It is up to the underlying
27142 SASL plug-in what it does with this data.
27143
27144
27145 .option server_mech cyrus_sasl string "see below"
27146 This option selects the authentication mechanism this driver should use. The
27147 default is the value of the generic &%public_name%& option. This option allows
27148 you to use a different underlying mechanism from the advertised name. For
27149 example:
27150 .code
27151 sasl:
27152   driver = cyrus_sasl
27153   public_name = X-ANYTHING
27154   server_mech = CRAM-MD5
27155   server_set_id = $auth1
27156 .endd
27157
27158 .option server_realm cyrus_sasl string&!! unset
27159 This specifies the SASL realm that the server claims to be in.
27160
27161
27162 .option server_service cyrus_sasl string &`smtp`&
27163 This is the SASL service that the server claims to implement.
27164
27165
27166 For straightforward cases, you do not need to set any of the authenticator's
27167 private options. All you need to do is to specify an appropriate mechanism as
27168 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27169 PLAIN, you could have two authenticators as follows:
27170 .code
27171 sasl_cram_md5:
27172   driver = cyrus_sasl
27173   public_name = CRAM-MD5
27174   server_set_id = $auth1
27175
27176 sasl_plain:
27177   driver = cyrus_sasl
27178   public_name = PLAIN
27179   server_set_id = $auth2
27180 .endd
27181 Cyrus SASL does implement the LOGIN authentication method, even though it is
27182 not a standard method. It is disabled by default in the source distribution,
27183 but it is present in many binary distributions.
27184 .ecindex IIDcyrauth1
27185 .ecindex IIDcyrauth2
27186
27187
27188
27189
27190 . ////////////////////////////////////////////////////////////////////////////
27191 . ////////////////////////////////////////////////////////////////////////////
27192 .chapter "The dovecot authenticator" "CHAPdovecot"
27193 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27194 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27195 This authenticator is an interface to the authentication facility of the
27196 Dovecot POP/IMAP server, which can support a number of authentication methods.
27197 Note that Dovecot must be configured to use auth-client not auth-userdb.
27198 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27199 to use the same mechanisms for SMTP authentication. This is a server
27200 authenticator only. There is only one option:
27201
27202 .option server_socket dovecot string unset
27203
27204 This option must specify the UNIX socket that is the interface to Dovecot
27205 authentication. The &%public_name%& option must specify an authentication
27206 mechanism that Dovecot is configured to support. You can have several
27207 authenticators for different mechanisms. For example:
27208 .code
27209 dovecot_plain:
27210   driver = dovecot
27211   public_name = PLAIN
27212   server_socket = /var/run/dovecot/auth-client
27213   server_set_id = $auth1
27214
27215 dovecot_ntlm:
27216   driver = dovecot
27217   public_name = NTLM
27218   server_socket = /var/run/dovecot/auth-client
27219   server_set_id = $auth1
27220 .endd
27221 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27222 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27223 option is passed in the Dovecot authentication command. If, for a TLS
27224 connection, a client certificate has been verified, the &"valid-client-cert"&
27225 option is passed. When authentication succeeds, the identity of the user
27226 who authenticated is placed in &$auth1$&.
27227 .ecindex IIDdcotauth1
27228 .ecindex IIDdcotauth2
27229
27230
27231 . ////////////////////////////////////////////////////////////////////////////
27232 . ////////////////////////////////////////////////////////////////////////////
27233 .chapter "The gsasl authenticator" "CHAPgsasl"
27234 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27235 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27236 .cindex "authentication" "GNU SASL"
27237 .cindex "authentication" "SASL"
27238 .cindex "authentication" "EXTERNAL"
27239 .cindex "authentication" "ANONYMOUS"
27240 .cindex "authentication" "PLAIN"
27241 .cindex "authentication" "LOGIN"
27242 .cindex "authentication" "DIGEST-MD5"
27243 .cindex "authentication" "CRAM-MD5"
27244 .cindex "authentication" "SCRAM-SHA-1"
27245 The &(gsasl)& authenticator provides server integration for the GNU SASL
27246 library and the mechanisms it provides.  This is new as of the 4.80 release
27247 and there are a few areas where the library does not let Exim smoothly
27248 scale to handle future authentication mechanisms, so no guarantee can be
27249 made that any particular new authentication mechanism will be supported
27250 without code changes in Exim.
27251
27252 Exim's &(gsasl)& authenticator does not have client-side support at this
27253 time; only the server-side support is implemented.  Patches welcome.
27254
27255
27256 .option server_channelbinding gsasl boolean false
27257 Do not set this true without consulting a cryptographic engineer.
27258
27259 Some authentication mechanisms are able to use external context at both ends
27260 of the session to bind the authentication to that context, and fail the
27261 authentication process if that context differs.  Specifically, some TLS
27262 ciphersuites can provide identifying information about the cryptographic
27263 context.
27264
27265 This should have meant that certificate identity and verification becomes a
27266 non-issue, as a man-in-the-middle attack will cause the correct client and
27267 server to see different identifiers and authentication will fail.
27268
27269 This is currently only supported when using the GnuTLS library.  This is
27270 only usable by mechanisms which support "channel binding"; at time of
27271 writing, that's the SCRAM family.
27272
27273 This defaults off to ensure smooth upgrade across Exim releases, in case
27274 this option causes some clients to start failing.  Some future release
27275 of Exim might have switched the default to be true.
27276
27277 However, Channel Binding in TLS has proven to be broken in current versions.
27278 Do not plan to rely upon this feature for security, ever, without consulting
27279 with a subject matter expert (a cryptographic engineer).
27280
27281
27282 .option server_hostname gsasl string&!! "see below"
27283 This option selects the hostname that is used when communicating with the
27284 library. The default value is &`$primary_hostname`&.
27285 Some mechanisms will use this data.
27286
27287
27288 .option server_mech gsasl string "see below"
27289 This option selects the authentication mechanism this driver should use. The
27290 default is the value of the generic &%public_name%& option. This option allows
27291 you to use a different underlying mechanism from the advertised name. For
27292 example:
27293 .code
27294 sasl:
27295   driver = gsasl
27296   public_name = X-ANYTHING
27297   server_mech = CRAM-MD5
27298   server_set_id = $auth1
27299 .endd
27300
27301
27302 .option server_password gsasl string&!! unset
27303 Various mechanisms need access to the cleartext password on the server, so
27304 that proof-of-possession can be demonstrated on the wire, without sending
27305 the password itself.
27306
27307 The data available for lookup varies per mechanism.
27308 In all cases, &$auth1$& is set to the &'authentication id'&.
27309 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27310 if available, else the empty string.
27311 The &$auth3$& variable will always be the &'realm'& if available,
27312 else the empty string.
27313
27314 A forced failure will cause authentication to defer.
27315
27316 If using this option, it may make sense to set the &%server_condition%&
27317 option to be simply "true".
27318
27319
27320 .option server_realm gsasl string&!! unset
27321 This specifies the SASL realm that the server claims to be in.
27322 Some mechanisms will use this data.
27323
27324
27325 .option server_scram_iter gsasl string&!! unset
27326 This option provides data for the SCRAM family of mechanisms.
27327 &$auth1$& is not available at evaluation time.
27328 (This may change, as we receive feedback on use)
27329
27330
27331 .option server_scram_salt gsasl string&!! unset
27332 This option provides data for the SCRAM family of mechanisms.
27333 &$auth1$& is not available at evaluation time.
27334 (This may change, as we receive feedback on use)
27335
27336
27337 .option server_service gsasl string &`smtp`&
27338 This is the SASL service that the server claims to implement.
27339 Some mechanisms will use this data.
27340
27341
27342 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27343 .vindex "&$auth1$&, &$auth2$&, etc"
27344 These may be set when evaluating specific options, as detailed above.
27345 They will also be set when evaluating &%server_condition%&.
27346
27347 Unless otherwise stated below, the &(gsasl)& integration will use the following
27348 meanings for these variables:
27349
27350 .ilist
27351 .vindex "&$auth1$&"
27352 &$auth1$&: the &'authentication id'&
27353 .next
27354 .vindex "&$auth2$&"
27355 &$auth2$&: the &'authorization id'&
27356 .next
27357 .vindex "&$auth3$&"
27358 &$auth3$&: the &'realm'&
27359 .endlist
27360
27361 On a per-mechanism basis:
27362
27363 .ilist
27364 .cindex "authentication" "EXTERNAL"
27365 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27366 the &%server_condition%& option must be present.
27367 .next
27368 .cindex "authentication" "ANONYMOUS"
27369 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27370 the &%server_condition%& option must be present.
27371 .next
27372 .cindex "authentication" "GSSAPI"
27373 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27374 &$auth2$& will be set to the &'authorization id'&,
27375 the &%server_condition%& option must be present.
27376 .endlist
27377
27378 An &'anonymous token'& is something passed along as an unauthenticated
27379 identifier; this is analogous to FTP anonymous authentication passing an
27380 email address, or software-identifier@, as the "password".
27381
27382
27383 An example showing the password having the realm specified in the callback
27384 and demonstrating a Cyrus SASL to GSASL migration approach is:
27385 .code
27386 gsasl_cyrusless_crammd5:
27387   driver = gsasl
27388   public_name = CRAM-MD5
27389   server_realm = imap.example.org
27390   server_password = ${lookup{$auth1:$auth3:userPassword}\
27391                     dbmjz{/etc/sasldb2}{$value}fail}
27392   server_set_id = ${quote:$auth1}
27393   server_condition = yes
27394 .endd
27395
27396
27397 . ////////////////////////////////////////////////////////////////////////////
27398 . ////////////////////////////////////////////////////////////////////////////
27399
27400 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27401 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27402 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27403 .cindex "authentication" "GSSAPI"
27404 .cindex "authentication" "Kerberos"
27405 The &(heimdal_gssapi)& authenticator provides server integration for the
27406 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27407 reliably.
27408
27409 .option server_hostname heimdal_gssapi string&!! "see below"
27410 This option selects the hostname that is used, with &%server_service%&,
27411 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27412 identifier.  The default value is &`$primary_hostname`&.
27413
27414 .option server_keytab heimdal_gssapi string&!! unset
27415 If set, then Heimdal will not use the system default keytab (typically
27416 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27417 The value should be a pathname, with no &"file:"& prefix.
27418
27419 .option server_service heimdal_gssapi string&!! "smtp"
27420 This option specifies the service identifier used, in conjunction with
27421 &%server_hostname%&, for building the identifier for finding credentials
27422 from the keytab.
27423
27424
27425 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27426 Beware that these variables will typically include a realm, thus will appear
27427 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27428 not verified, so a malicious client can set it to anything.
27429
27430 The &$auth1$& field should be safely trustable as a value from the Key
27431 Distribution Center.  Note that these are not quite email addresses.
27432 Each identifier is for a role, and so the left-hand-side may include a
27433 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27434
27435 .vindex "&$auth1$&, &$auth2$&, etc"
27436 .ilist
27437 .vindex "&$auth1$&"
27438 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27439 .next
27440 .vindex "&$auth2$&"
27441 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27442 authentication.  If that was empty, this will also be set to the
27443 GSS Display Name.
27444 .endlist
27445
27446
27447 . ////////////////////////////////////////////////////////////////////////////
27448 . ////////////////////////////////////////////////////////////////////////////
27449
27450 .chapter "The spa authenticator" "CHAPspa"
27451 .scindex IIDspaauth1 "&(spa)& authenticator"
27452 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27453 .cindex "authentication" "Microsoft Secure Password"
27454 .cindex "authentication" "NTLM"
27455 .cindex "Microsoft Secure Password Authentication"
27456 .cindex "NTLM authentication"
27457 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27458 Password Authentication'& mechanism,
27459 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27460 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27461 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27462 server side was subsequently contributed by Tom Kistner. The mechanism works as
27463 follows:
27464
27465 .ilist
27466 After the AUTH command has been accepted, the client sends an SPA
27467 authentication request based on the user name and optional domain.
27468 .next
27469 The server sends back a challenge.
27470 .next
27471 The client builds a challenge response which makes use of the user's password
27472 and sends it to the server, which then accepts or rejects it.
27473 .endlist
27474
27475 Encryption is used to protect the password in transit.
27476
27477
27478
27479 .section "Using spa as a server" "SECID179"
27480 .cindex "options" "&(spa)& authenticator (server)"
27481 The &(spa)& authenticator has just one server option:
27482
27483 .option server_password spa string&!! unset
27484 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27485 This option is expanded, and the result must be the cleartext password for the
27486 authenticating user, whose name is at this point in &$auth1$&. For
27487 compatibility with previous releases of Exim, the user name is also placed in
27488 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27489 it can lead to confusion in string expansions that also use numeric variables
27490 for other things. For example:
27491 .code
27492 spa:
27493   driver = spa
27494   public_name = NTLM
27495   server_password = \
27496     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27497 .endd
27498 If the expansion is forced to fail, authentication fails. Any other expansion
27499 failure causes a temporary error code to be returned.
27500
27501
27502
27503
27504
27505 .section "Using spa as a client" "SECID180"
27506 .cindex "options" "&(spa)& authenticator (client)"
27507 The &(spa)& authenticator has the following client options:
27508
27509
27510
27511 .option client_domain spa string&!! unset
27512 This option specifies an optional domain for the authentication.
27513
27514
27515 .option client_password spa string&!! unset
27516 This option specifies the user's password, and must be set.
27517
27518
27519 .option client_username spa string&!! unset
27520 This option specifies the user name, and must be set. Here is an example of a
27521 configuration of this authenticator for use with the mail servers at
27522 &'msn.com'&:
27523 .code
27524 msn:
27525   driver = spa
27526   public_name = MSN
27527   client_username = msn/msn_username
27528   client_password = msn_plaintext_password
27529   client_domain = DOMAIN_OR_UNSET
27530 .endd
27531 .ecindex IIDspaauth1
27532 .ecindex IIDspaauth2
27533
27534
27535
27536
27537
27538 . ////////////////////////////////////////////////////////////////////////////
27539 . ////////////////////////////////////////////////////////////////////////////
27540
27541 .chapter "The external authenticator" "CHAPexternauth"
27542 .scindex IIDexternauth1 "&(external)& authenticator"
27543 .scindex IIDexternauth2 "authenticators" "&(external)&"
27544 .cindex "authentication" "Client Certificate"
27545 .cindex "authentication" "X509"
27546 .cindex "Certificate-based authentication"
27547 The &(external)& authenticator provides support for
27548 authentication based on non-SMTP information.
27549 The specification is in RFC 4422 Appendix A
27550 (&url(https://tools.ietf.org/html/rfc4422)).
27551 It is only a transport and negotiation mechanism;
27552 the process of authentication is entirely controlled
27553 by the server configuration.
27554
27555 The client presents an identity in-clear.
27556 It is probably wise for a server to only advertise,
27557 and for clients to only attempt,
27558 this authentication method on a secure (eg. under TLS) connection.
27559
27560 One possible use, compatible with the
27561 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27562 is for using X509 client certificates.
27563
27564 It thus overlaps in function with the TLS authenticator
27565 (see &<<CHAPtlsauth>>&)
27566 but is a full SMTP SASL authenticator
27567 rather than being implicit for TLS-connection carried
27568 client certificates only.
27569
27570 The examples and discussion in this chapter assume that
27571 client-certificate authentication is being done.
27572
27573 The client must present a certificate,
27574 for which it must have been requested via the
27575 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27576 (see &<<CHAPTLS>>&).
27577 For authentication to be effective the certificate should be
27578 verifiable against a trust-anchor certificate known to the server.
27579
27580 .section "External options" "SECTexternsoptions"
27581 .cindex "options" "&(external)& authenticator (server)"
27582 The &(external)& authenticator has two server options:
27583
27584 .option server_param2 external string&!! unset
27585 .option server_param3 external string&!! unset
27586 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27587 These options are expanded before the &%server_condition%& option
27588 and the result are placed in &$auth2$& and &$auth3$& resectively.
27589 If the expansion is forced to fail, authentication fails. Any other expansion
27590 failure causes a temporary error code to be returned.
27591
27592 They can be used to clarify the coding of a complex &%server_condition%&.
27593
27594 .section "Using external in a server" "SECTexternserver"
27595 .cindex "AUTH" "in &(external)& authenticator"
27596 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27597         "in &(external)& authenticator"
27598 .vindex "&$auth1$&, &$auth2$&, etc"
27599 .cindex "base64 encoding" "in &(external)& authenticator"
27600
27601 When running as a server, &(external)& performs the authentication test by
27602 expanding a string. The data sent by the client with the AUTH command, or in
27603 response to subsequent prompts, is base64 encoded, and so may contain any byte
27604 values when decoded. The decoded value is treated as
27605 an identity for authentication and
27606 placed in the expansion variable &$auth1$&.
27607
27608 For compatibility with previous releases of Exim, the value is also placed in
27609 the expansion variable &$1$&. However, the use of this
27610 variable for this purpose is now deprecated, as it can lead to confusion in
27611 string expansions that also use them for other things.
27612
27613 .vindex "&$authenticated_id$&"
27614 Once an identity has been received,
27615 &%server_condition%& is expanded. If the expansion is forced to fail,
27616 authentication fails. Any other expansion failure causes a temporary error code
27617 to be returned. If the result of a successful expansion is an empty string,
27618 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27619 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27620 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27621 For any other result, a temporary error code is returned, with the expanded
27622 string as the error text.
27623
27624 Example:
27625 .code
27626 ext_ccert_san_mail:
27627   driver =            external
27628   public_name =       EXTERNAL
27629
27630   server_advertise_condition = $tls_in_certificate_verified
27631   server_param2 =     ${certextract {subj_altname,mail,>:} \
27632                                     {$tls_in_peercert}}
27633   server_condition =  ${if forany {$auth2} \
27634                             {eq {$item}{$auth1}}}
27635   server_set_id =     $auth1
27636 .endd
27637 This accepts a client certificate that is verifiable against any
27638 of your configured trust-anchors
27639 (which usually means the full set of public CAs)
27640 and which has a mail-SAN matching the claimed identity sent by the client.
27641
27642 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27643 The account name is therefore guessable by an opponent.
27644 TLS 1.3 protects both server and client certificates, and is not vulnerable
27645 in this way.
27646 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27647
27648
27649 .section "Using external in a client" "SECTexternclient"
27650 .cindex "options" "&(external)& authenticator (client)"
27651 The &(external)& authenticator has one client option:
27652
27653 .option client_send external string&!! unset
27654 This option is expanded and sent with the AUTH command as the
27655 identity being asserted.
27656
27657 Example:
27658 .code
27659 ext_ccert:
27660   driver =      external
27661   public_name = EXTERNAL
27662
27663   client_condition = ${if !eq{$tls_out_cipher}{}}
27664   client_send = myaccount@smarthost.example.net
27665 .endd
27666
27667
27668 .ecindex IIDexternauth1
27669 .ecindex IIDexternauth2
27670
27671
27672
27673
27674
27675 . ////////////////////////////////////////////////////////////////////////////
27676 . ////////////////////////////////////////////////////////////////////////////
27677
27678 .chapter "The tls authenticator" "CHAPtlsauth"
27679 .scindex IIDtlsauth1 "&(tls)& authenticator"
27680 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27681 .cindex "authentication" "Client Certificate"
27682 .cindex "authentication" "X509"
27683 .cindex "Certificate-based authentication"
27684 The &(tls)& authenticator provides server support for
27685 authentication based on client certificates.
27686
27687 It is not an SMTP authentication mechanism and is not
27688 advertised by the server as part of the SMTP EHLO response.
27689 It is an Exim authenticator in the sense that it affects
27690 the protocol element of the log line, can be tested for
27691 by the &%authenticated%& ACL condition, and can set
27692 the &$authenticated_id$& variable.
27693
27694 The client must present a verifiable certificate,
27695 for which it must have been requested via the
27696 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27697 (see &<<CHAPTLS>>&).
27698
27699 If an authenticator of this type is configured it is
27700 run before any SMTP-level communication is done,
27701 and can authenticate the connection.
27702 If it does, SMTP authentication is not offered.
27703
27704 A maximum of one authenticator of this type may be present.
27705
27706
27707 .cindex "options" "&(tls)& authenticator (server)"
27708 The &(tls)& authenticator has three server options:
27709
27710 .option server_param1 tls string&!! unset
27711 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27712 This option is expanded after the TLS negotiation and
27713 the result is placed in &$auth1$&.
27714 If the expansion is forced to fail, authentication fails. Any other expansion
27715 failure causes a temporary error code to be returned.
27716
27717 .option server_param2 tls string&!! unset
27718 .option server_param3 tls string&!! unset
27719 As above, for &$auth2$& and &$auth3$&.
27720
27721 &%server_param1%& may also be spelled &%server_param%&.
27722
27723
27724 Example:
27725 .code
27726 tls:
27727   driver = tls
27728   server_param1 =     ${certextract {subj_altname,mail,>:} \
27729                                     {$tls_in_peercert}}
27730   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
27731                                  {forany {$auth1} \
27732                             {!= {0} \
27733                                 {${lookup ldap{ldap:///\
27734                          mailname=${quote_ldap_dn:${lc:$item}},\
27735                          ou=users,LDAP_DC?mailid} {$value}{0} \
27736                        }    }  } }}}
27737   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27738 .endd
27739 This accepts a client certificate that is verifiable against any
27740 of your configured trust-anchors
27741 (which usually means the full set of public CAs)
27742 and which has a SAN with a good account name.
27743
27744 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27745 The account name is therefore guessable by an opponent.
27746 TLS 1.3 protects both server and client certificates, and is not vulnerable
27747 in this way.
27748 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27749
27750 . An alternative might use
27751 . .code
27752 .   server_param1 = ${sha256:$tls_in_peercert}
27753 . .endd
27754 . to require one of a set of specific certs that define a given account
27755 . (the verification is still required, but mostly irrelevant).
27756 . This would help for per-device use.
27757 .
27758 . However, for the future we really need support for checking a
27759 . user cert in LDAP - which probably wants a base-64 DER.
27760
27761 .ecindex IIDtlsauth1
27762 .ecindex IIDtlsauth2
27763
27764
27765 Note that because authentication is traditionally an SMTP operation,
27766 the &%authenticated%& ACL condition cannot be used in
27767 a connect- or helo-ACL.
27768
27769
27770
27771 . ////////////////////////////////////////////////////////////////////////////
27772 . ////////////////////////////////////////////////////////////////////////////
27773
27774 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27775          "Encrypted SMTP connections"
27776 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27777 .scindex IIDencsmtp2 "SMTP" "encryption"
27778 .cindex "TLS" "on SMTP connection"
27779 .cindex "OpenSSL"
27780 .cindex "GnuTLS"
27781 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27782 Sockets Layer), is implemented by making use of the OpenSSL library or the
27783 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27784 cryptographic code in the Exim distribution itself for implementing TLS. In
27785 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27786 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27787 You also need to understand the basic concepts of encryption at a managerial
27788 level, and in particular, the way that public keys, private keys, and
27789 certificates are used.
27790
27791 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27792 connection is established, the client issues a STARTTLS command. If the
27793 server accepts this, the client and the server negotiate an encryption
27794 mechanism. If the negotiation succeeds, the data that subsequently passes
27795 between them is encrypted.
27796
27797 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27798 and if so, what cipher suite is in use, whether the client supplied a
27799 certificate, and whether or not that certificate was verified. This makes it
27800 possible for an Exim server to deny or accept certain commands based on the
27801 encryption state.
27802
27803 &*Warning*&: Certain types of firewall and certain anti-virus products can
27804 disrupt TLS connections. You need to turn off SMTP scanning for these products
27805 in order to get TLS to work.
27806
27807
27808
27809 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
27810          "SECID284"
27811 .cindex "submissions protocol"
27812 .cindex "ssmtp protocol"
27813 .cindex "smtps protocol"
27814 .cindex "SMTP" "submissions protocol"
27815 .cindex "SMTP" "ssmtp protocol"
27816 .cindex "SMTP" "smtps protocol"
27817 The history of port numbers for TLS in SMTP is a little messy and has been
27818 contentious.  As of RFC 8314, the common practice of using the historically
27819 allocated port 465 for "email submission but with TLS immediately upon connect
27820 instead of using STARTTLS" is officially blessed by the IETF, and recommended
27821 by them in preference to STARTTLS.
27822
27823 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
27824 clarity emerged over the dual roles of SMTP, for MX delivery and Email
27825 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
27826
27827 This approach was, for a while, officially abandoned when encrypted SMTP was
27828 standardized, but many clients kept using it, even as the TCP port number was
27829 reassigned for other use.
27830 Thus you may encounter guidance claiming that you shouldn't enable use of
27831 this port.
27832 In practice, a number of mail-clients have only ever supported submissions,
27833 not submission with STARTTLS upgrade.
27834 Ideally, offer both submission (587) and submissions (465) service.
27835
27836 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
27837 global option. Its value must be a list of port numbers;
27838 the most common use is expected to be:
27839 .code
27840 tls_on_connect_ports = 465
27841 .endd
27842 The port numbers specified by this option apply to all SMTP connections, both
27843 via the daemon and via &'inetd'&. You still need to specify all the ports that
27844 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27845 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27846 an extra port &-- rather, it specifies different behaviour on a port that is
27847 defined elsewhere.
27848
27849 There is also a &%-tls-on-connect%& command line option. This overrides
27850 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
27851
27852
27853
27854
27855
27856
27857 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27858 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27859 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27860 followed later, when the first versions of GnuTLS were released. To build Exim
27861 to use GnuTLS, you need to set
27862 .code
27863 USE_GNUTLS=yes
27864 .endd
27865 in Local/Makefile, in addition to
27866 .code
27867 SUPPORT_TLS=yes
27868 .endd
27869 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27870 include files and libraries for GnuTLS can be found.
27871
27872 There are some differences in usage when using GnuTLS instead of OpenSSL:
27873
27874 .ilist
27875 The &%tls_verify_certificates%& option
27876 cannot be the path of a directory
27877 for GnuTLS versions before 3.3.6
27878 (for later versions, or OpenSSL, it can be either).
27879 .next
27880 The default value for &%tls_dhparam%& differs for historical reasons.
27881 .next
27882 .vindex "&$tls_in_peerdn$&"
27883 .vindex "&$tls_out_peerdn$&"
27884 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27885 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27886 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27887 .next
27888 OpenSSL identifies cipher suites using hyphens as separators, for example:
27889 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
27890 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
27891 in a cipher list. To make life simpler, Exim changes underscores to hyphens
27892 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
27893 to handle its own older variants) when processing lists of cipher suites in the
27894 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
27895 option).
27896 .next
27897 The &%tls_require_ciphers%& options operate differently, as described in the
27898 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27899 .next
27900 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27901 When using OpenSSL, this option is ignored.
27902 (If an API is found to let OpenSSL be configured in this way,
27903 let the Exim Maintainers know and we'll likely use it).
27904 .next
27905 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
27906 main option, it must be ordered to match the &%tls_certificate%& list.
27907 .next
27908 Some other recently added features may only be available in one or the other.
27909 This should be documented with the feature.  If the documentation does not
27910 explicitly state that the feature is infeasible in the other TLS
27911 implementation, then patches are welcome.
27912 .endlist
27913
27914
27915 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27916 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27917 an explicit path; if the latter, then the text about generation still applies,
27918 but not the chosen filename.
27919 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27920 See the documentation of &%tls_dhparam%& for more information.
27921
27922 GnuTLS uses D-H parameters that may take a substantial amount of time
27923 to compute. It is unreasonable to re-compute them for every TLS session.
27924 Therefore, Exim keeps this data in a file in its spool directory, called
27925 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27926 of bits requested.
27927 The file is owned by the Exim user and is readable only by
27928 its owner. Every Exim process that start up GnuTLS reads the D-H
27929 parameters from this file. If the file does not exist, the first Exim process
27930 that needs it computes the data and writes it to a temporary file which is
27931 renamed once it is complete. It does not matter if several Exim processes do
27932 this simultaneously (apart from wasting a few resources). Once a file is in
27933 place, new Exim processes immediately start using it.
27934
27935 For maximum security, the parameters that are stored in this file should be
27936 recalculated periodically, the frequency depending on your paranoia level.
27937 If you are avoiding using the fixed D-H primes published in RFCs, then you
27938 are concerned about some advanced attacks and will wish to do this; if you do
27939 not regenerate then you might as well stick to the standard primes.
27940
27941 Arranging this is easy in principle; just delete the file when you want new
27942 values to be computed. However, there may be a problem. The calculation of new
27943 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27944 If the system is not very active, &_/dev/random_& may delay returning data
27945 until enough randomness (entropy) is available. This may cause Exim to hang for
27946 a substantial amount of time, causing timeouts on incoming connections.
27947
27948 The solution is to generate the parameters externally to Exim. They are stored
27949 in &_gnutls-params-N_& in PEM format, which means that they can be
27950 generated externally using the &(certtool)& command that is part of GnuTLS.
27951
27952 To replace the parameters with new ones, instead of deleting the file
27953 and letting Exim re-create it, you can generate new parameters using
27954 &(certtool)& and, when this has been done, replace Exim's cache file by
27955 renaming. The relevant commands are something like this:
27956 .code
27957 # ls
27958 [ look for file; assume gnutls-params-2236 is the most recent ]
27959 # rm -f new-params
27960 # touch new-params
27961 # chown exim:exim new-params
27962 # chmod 0600 new-params
27963 # certtool --generate-dh-params --bits 2236 >>new-params
27964 # openssl dhparam -noout -text -in new-params | head
27965 [ check the first line, make sure it's not more than 2236;
27966   if it is, then go back to the start ("rm") and repeat
27967   until the size generated is at most the size requested ]
27968 # chmod 0400 new-params
27969 # mv new-params gnutls-params-2236
27970 .endd
27971 If Exim never has to generate the parameters itself, the possibility of
27972 stalling is removed.
27973
27974 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27975 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27976 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27977 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27978 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27979 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27980 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27981 which applies to all D-H usage, client or server.  If the value returned by
27982 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27983 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27984 limit, which is still much higher than Exim historically used.
27985
27986 The filename and bits used will change as the GnuTLS maintainers change the
27987 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27988 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27989 2432 bits, while NSS is limited to 2236 bits.
27990
27991 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27992 increase the chance of the generated prime actually being within acceptable
27993 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27994 procedure above.  There is no sane procedure available to Exim to double-check
27995 the size of the generated prime, so it might still be too large.
27996
27997
27998 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27999 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28000 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28001 There is a function in the OpenSSL library that can be passed a list of cipher
28002 suites before the cipher negotiation takes place. This specifies which ciphers
28003 are acceptable for TLS versions prior to 1.3.
28004 The list is colon separated and may contain names like
28005 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28006 directly to this function call.
28007 Many systems will install the OpenSSL manual-pages, so you may have
28008 &'ciphers(1)'& available to you.
28009 The following quotation from the OpenSSL
28010 documentation specifies what forms of item are allowed in the cipher string:
28011
28012 .ilist
28013 It can consist of a single cipher suite such as RC4-SHA.
28014 .next
28015 It can represent a list of cipher suites containing a certain algorithm,
28016 or cipher suites of a certain type. For example SHA1 represents all
28017 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28018 SSL v3 algorithms.
28019 .next
28020 Lists of cipher suites can be combined in a single cipher string using
28021 the + character. This is used as a logical and operation. For example
28022 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28023 algorithms.
28024 .endlist
28025
28026 Each cipher string can be optionally preceded by one of the characters &`!`&,
28027 &`-`& or &`+`&.
28028 .ilist
28029 If &`!`& is used, the ciphers are permanently deleted from the list. The
28030 ciphers deleted can never reappear in the list even if they are explicitly
28031 stated.
28032 .next
28033 If &`-`& is used, the ciphers are deleted from the list, but some or all
28034 of the ciphers can be added again by later options.
28035 .next
28036 If &`+`& is used, the ciphers are moved to the end of the list. This
28037 option does not add any new ciphers; it just moves matching existing ones.
28038 .endlist
28039
28040 If none of these characters is present, the string is interpreted as
28041 a list of ciphers to be appended to the current preference list. If the list
28042 includes any ciphers already present they will be ignored: that is, they will
28043 not be moved to the end of the list.
28044 .endlist
28045
28046 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28047 string:
28048 .code
28049 # note single-quotes to get ! past any shell history expansion
28050 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28051 .endd
28052
28053 This example will let the library defaults be permitted on the MX port, where
28054 there's probably no identity verification anyway, but ups the ante on the
28055 submission ports where the administrator might have some influence on the
28056 choice of clients used:
28057 .code
28058 # OpenSSL variant; see man ciphers(1)
28059 tls_require_ciphers = ${if =={$received_port}{25}\
28060                            {DEFAULT}\
28061                            {HIGH:!MD5:!SHA1}}
28062 .endd
28063
28064 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28065 .code
28066 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28067 .endd
28068
28069 For TLS version 1.3 the control available is less fine-grained
28070 and Exim does not provide access to it at present.
28071 The value of the &%tls_require_ciphers%& option is ignored when
28072 TLS version 1.3 is negotiated.
28073
28074 As of writing the library default cipher suite list for TLSv1.3 is
28075 .code
28076 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28077 .endd
28078
28079
28080 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28081          "SECTreqciphgnu"
28082 .cindex "GnuTLS" "specifying parameters for"
28083 .cindex "TLS" "specifying ciphers (GnuTLS)"
28084 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28085 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28086 .cindex "TLS" "specifying protocols (GnuTLS)"
28087 .cindex "TLS" "specifying priority string (GnuTLS)"
28088 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28089 The GnuTLS library allows the caller to provide a "priority string", documented
28090 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28091 ciphersuite specification in OpenSSL.
28092
28093 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28094 and controls both protocols and ciphers.
28095
28096 The &%tls_require_ciphers%& option is available both as an global option,
28097 controlling how Exim behaves as a server, and also as an option of the
28098 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28099 the value is string expanded.  The resulting string is not an Exim list and
28100 the string is given to the GnuTLS library, so that Exim does not need to be
28101 aware of future feature enhancements of GnuTLS.
28102
28103 Documentation of the strings accepted may be found in the GnuTLS manual, under
28104 "Priority strings".  This is online as
28105 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28106 but beware that this relates to GnuTLS 3, which may be newer than the version
28107 installed on your system.  If you are using GnuTLS 3,
28108 then the example code
28109 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28110 on that site can be used to test a given string.
28111
28112 For example:
28113 .code
28114 # Disable older versions of protocols
28115 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28116 .endd
28117
28118 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28119 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28120 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28121
28122 This example will let the library defaults be permitted on the MX port, where
28123 there's probably no identity verification anyway, and lowers security further
28124 by increasing compatibility; but this ups the ante on the submission ports
28125 where the administrator might have some influence on the choice of clients
28126 used:
28127 .code
28128 # GnuTLS variant
28129 tls_require_ciphers = ${if =={$received_port}{25}\
28130                            {NORMAL:%COMPAT}\
28131                            {SECURE128}}
28132 .endd
28133
28134
28135 .section "Configuring an Exim server to use TLS" "SECID182"
28136 .cindex "TLS" "configuring an Exim server"
28137 When Exim has been built with TLS support, it advertises the availability of
28138 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28139 but not to any others. The default value of this option is *, which means
28140 that STARTTLS is always advertised.  Set it to blank to never advertise;
28141 this is reasonable for systems that want to use TLS only as a client.
28142
28143 If STARTTLS is to be used you
28144 need to set some other options in order to make TLS available.
28145
28146 If a client issues a STARTTLS command and there is some configuration
28147 problem in the server, the command is rejected with a 454 error. If the client
28148 persists in trying to issue SMTP commands, all except QUIT are rejected
28149 with the error
28150 .code
28151 554 Security failure
28152 .endd
28153 If a STARTTLS command is issued within an existing TLS session, it is
28154 rejected with a 554 error code.
28155
28156 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28157 must be set to match some hosts. The default is * which matches all hosts.
28158
28159 If this is all you do, TLS encryption will be enabled but not authentication -
28160 meaning that the peer has no assurance it is actually you he is talking to.
28161 You gain protection from a passive sniffer listening on the wire but not
28162 from someone able to intercept the communication.
28163
28164 Further protection requires some further configuration at the server end.
28165
28166 To make TLS work you need to set, in the server,
28167 .code
28168 tls_certificate = /some/file/name
28169 tls_privatekey = /some/file/name
28170 .endd
28171 These options are, in fact, expanded strings, so you can make them depend on
28172 the identity of the client that is connected if you wish. The first file
28173 contains the server's X509 certificate, and the second contains the private key
28174 that goes with it. These files need to be
28175 PEM format and readable by the Exim user, and must
28176 always be given as full path names.
28177 The key must not be password-protected.
28178 They can be the same file if both the
28179 certificate and the key are contained within it. If &%tls_privatekey%& is not
28180 set, or if its expansion is forced to fail or results in an empty string, this
28181 is assumed to be the case. The certificate file may also contain intermediate
28182 certificates that need to be sent to the client to enable it to authenticate
28183 the server's certificate.
28184
28185 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28186 colon-separated lists of file paths.  Ciphers using given authentication
28187 algorithms require the presence of a suitable certificate to supply the
28188 public-key.  The server selects among the certificates to present to the
28189 client depending on the selected cipher, hence the priority ordering for
28190 ciphers will affect which certificate is used.
28191
28192 If you do not understand about certificates and keys, please try to find a
28193 source of this background information, which is not Exim-specific. (There are a
28194 few comments below in section &<<SECTcerandall>>&.)
28195
28196 &*Note*&: These options do not apply when Exim is operating as a client &--
28197 they apply only in the case of a server. If you need to use a certificate in an
28198 Exim client, you must set the options of the same names in an &(smtp)&
28199 transport.
28200
28201 With just these options, an Exim server will be able to use TLS. It does not
28202 require the client to have a certificate (but see below for how to insist on
28203 this). There is one other option that may be needed in other situations. If
28204 .code
28205 tls_dhparam = /some/file/name
28206 .endd
28207 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28208 with the parameters contained in the file.
28209 Set this to &`none`& to disable use of DH entirely, by making no prime
28210 available:
28211 .code
28212 tls_dhparam = none
28213 .endd
28214 This may also be set to a string identifying a standard prime to be used for
28215 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28216 used is &`ike23`&.  There are a few standard primes available, see the
28217 documentation for &%tls_dhparam%& for the complete list.
28218
28219 See the command
28220 .code
28221 openssl dhparam
28222 .endd
28223 for a way of generating file data.
28224
28225 The strings supplied for these three options are expanded every time a client
28226 host connects. It is therefore possible to use different certificates and keys
28227 for different hosts, if you so wish, by making use of the client's IP address
28228 in &$sender_host_address$& to control the expansion. If a string expansion is
28229 forced to fail, Exim behaves as if the option is not set.
28230
28231 .cindex "cipher" "logging"
28232 .cindex "log" "TLS cipher"
28233 .vindex "&$tls_in_cipher$&"
28234 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28235 an incoming TLS connection. It is included in the &'Received:'& header of an
28236 incoming message (by default &-- you can, of course, change this), and it is
28237 also included in the log line that records a message's arrival, keyed by
28238 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28239 condition can be used to test for specific cipher suites in ACLs.
28240
28241 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28242 can check the name of the cipher suite and vary their actions accordingly. The
28243 cipher suite names vary, depending on which TLS library is being used. For
28244 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28245 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28246 documentation for more details.
28247
28248 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28249 (again depending on the &%tls_cipher%& log selector).
28250
28251
28252 .section "Requesting and verifying client certificates" "SECID183"
28253 .cindex "certificate" "verification of client"
28254 .cindex "TLS" "client certificate verification"
28255 If you want an Exim server to request a certificate when negotiating a TLS
28256 session with a client, you must set either &%tls_verify_hosts%& or
28257 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28258 apply to all TLS connections. For any host that matches one of these options,
28259 Exim requests a certificate as part of the setup of the TLS session. The
28260 contents of the certificate are verified by comparing it with a list of
28261 expected trust-anchors or certificates.
28262 These may be the system default set (depending on library version),
28263 an explicit file or,
28264 depending on library version, a directory, identified by
28265 &%tls_verify_certificates%&.
28266
28267 A file can contain multiple certificates, concatenated end to end. If a
28268 directory is used
28269 (OpenSSL only),
28270 each certificate must be in a separate file, with a name (or a symbolic link)
28271 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28272 certificate. You can compute the relevant hash by running the command
28273 .code
28274 openssl x509 -hash -noout -in /cert/file
28275 .endd
28276 where &_/cert/file_& contains a single certificate.
28277
28278 There is no checking of names of the client against the certificate
28279 Subject Name or Subject Alternate Names.
28280
28281 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28282 what happens if the client does not supply a certificate, or if the certificate
28283 does not match any of the certificates in the collection named by
28284 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28285 attempt to set up a TLS session is aborted, and the incoming connection is
28286 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28287 session continues. ACLs that run for subsequent SMTP commands can detect the
28288 fact that no certificate was verified, and vary their actions accordingly. For
28289 example, you can insist on a certificate before accepting a message for
28290 relaying, but not when the message is destined for local delivery.
28291
28292 .vindex "&$tls_in_peerdn$&"
28293 When a client supplies a certificate (whether it verifies or not), the value of
28294 the Distinguished Name of the certificate is made available in the variable
28295 &$tls_in_peerdn$& during subsequent processing of the message.
28296
28297 .cindex "log" "distinguished name"
28298 Because it is often a long text string, it is not included in the log line or
28299 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28300 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28301 &%received_header_text%& to change the &'Received:'& header. When no
28302 certificate is supplied, &$tls_in_peerdn$& is empty.
28303
28304
28305 .section "Revoked certificates" "SECID184"
28306 .cindex "TLS" "revoked certificates"
28307 .cindex "revocation list"
28308 .cindex "certificate" "revocation list"
28309 .cindex "OCSP" "stapling"
28310 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28311 certificates are revoked. If you have such a list, you can pass it to an Exim
28312 server using the global option called &%tls_crl%& and to an Exim client using
28313 an identically named option for the &(smtp)& transport. In each case, the value
28314 of the option is expanded and must then be the name of a file that contains a
28315 CRL in PEM format.
28316 The downside is that clients have to periodically re-download a potentially huge
28317 file from every certificate authority they know of.
28318
28319 The way with most moving parts at query time is Online Certificate
28320 Status Protocol (OCSP), where the client verifies the certificate
28321 against an OCSP server run by the CA.  This lets the CA track all
28322 usage of the certs.  It requires running software with access to the
28323 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28324 is based on HTTP and can be proxied accordingly.
28325
28326 The only widespread OCSP server implementation (known to this writer)
28327 comes as part of OpenSSL and aborts on an invalid request, such as
28328 connecting to the port and then disconnecting.  This requires
28329 re-entering the passphrase each time some random client does this.
28330
28331 The third way is OCSP Stapling; in this, the server using a certificate
28332 issued by the CA periodically requests an OCSP proof of validity from
28333 the OCSP server, then serves it up inline as part of the TLS
28334 negotiation.   This approach adds no extra round trips, does not let the
28335 CA track users, scales well with number of certs issued by the CA and is
28336 resilient to temporary OCSP server failures, as long as the server
28337 starts retrying to fetch an OCSP proof some time before its current
28338 proof expires.  The downside is that it requires server support.
28339
28340 Unless Exim is built with the support disabled,
28341 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28342 support for OCSP stapling is included.
28343
28344 There is a global option called &%tls_ocsp_file%&.
28345 The file specified therein is expected to be in DER format, and contain
28346 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28347 option will be re-expanded for SNI, if the &%tls_certificate%& option
28348 contains &`tls_in_sni`&, as per other TLS options.
28349
28350 Exim does not at this time implement any support for fetching a new OCSP
28351 proof.  The burden is on the administrator to handle this, outside of
28352 Exim.  The file specified should be replaced atomically, so that the
28353 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28354 on each connection, so a new file will be handled transparently on the
28355 next connection.
28356
28357 When built with OpenSSL Exim will check for a valid next update timestamp
28358 in the OCSP proof; if not present, or if the proof has expired, it will be
28359 ignored.
28360
28361 For the client to be able to verify the stapled OCSP the server must
28362 also supply, in its stapled information, any intermediate
28363 certificates for the chain leading to the OCSP proof from the signer
28364 of the server certificate.  There may be zero or one such. These
28365 intermediate certificates should be added to the server OCSP stapling
28366 file named by &%tls_ocsp_file%&.
28367
28368 Note that the proof only covers the terminal server certificate,
28369 not any of the chain from CA to it.
28370
28371 There is no current way to staple a proof for a client certificate.
28372
28373 .code
28374   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28375   OCSP server is supplied.  The server URL may be included in the
28376   server certificate, if the CA is helpful.
28377
28378   One failure mode seen was the OCSP Signer cert expiring before the end
28379   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28380   noted this as invalid overall, but the re-fetch script did not.
28381 .endd
28382
28383
28384
28385
28386 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28387 .cindex "cipher" "logging"
28388 .cindex "log" "TLS cipher"
28389 .cindex "log" "distinguished name"
28390 .cindex "TLS" "configuring an Exim client"
28391 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28392 deliveries as well as to incoming, the latter one causing logging of the
28393 server certificate's DN. The remaining client configuration for TLS is all
28394 within the &(smtp)& transport.
28395
28396 It is not necessary to set any options to have TLS work in the &(smtp)&
28397 transport. If Exim is built with TLS support, and TLS is advertised by a
28398 server, the &(smtp)& transport always tries to start a TLS session. However,
28399 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28400 transport) to a list of server hosts for which TLS should not be used.
28401
28402 If you do not want Exim to attempt to send messages unencrypted when an attempt
28403 to set up an encrypted connection fails in any way, you can set
28404 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28405 those hosts, delivery is always deferred if an encrypted connection cannot be
28406 set up. If there are any other hosts for the address, they are tried in the
28407 usual way.
28408
28409 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28410 the message unencrypted. It always does this if the response to STARTTLS is
28411 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28412 session after a success response code, what happens is controlled by the
28413 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28414 delivery to this host is deferred, and other hosts (if available) are tried. If
28415 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28416 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28417 negotiation fails, Exim closes the current connection (because it is in an
28418 unknown state), opens a new one to the same host, and then tries the delivery
28419 unencrypted.
28420
28421 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28422 transport provide the client with a certificate, which is passed to the server
28423 if it requests it. If the server is Exim, it will request a certificate only if
28424 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28425
28426 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28427 specifies a collection of expected server certificates.
28428 These may be
28429 the system default set (depending on library version),
28430 a file,
28431 or (depending on library version) a directory.
28432 The client verifies the server's certificate
28433 against this collection, taking into account any revoked certificates that are
28434 in the list defined by &%tls_crl%&.
28435 Failure to verify fails the TLS connection unless either of the
28436 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28437
28438 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28439 certificate verification to the listed servers.  Verification either must
28440 or need not succeed respectively.
28441
28442 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28443 checks are made: that the host name (the one in the DNS A record)
28444 is valid for the certificate.
28445 The option defaults to always checking.
28446
28447 The &(smtp)& transport has two OCSP-related options:
28448 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28449 is requested and required for the connection to proceed.  The default
28450 value is empty.
28451 &%hosts_request_ocsp%&; a host-list for which (additionally)
28452 a Certificate Status is requested (but not necessarily verified).  The default
28453 value is "*" meaning that requests are made unless configured
28454 otherwise.
28455
28456 The host(s) should also be in &%hosts_require_tls%&, and
28457 &%tls_verify_certificates%& configured for the transport,
28458 for OCSP to be relevant.
28459
28460 If
28461 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28462 list of permitted cipher suites. If either of these checks fails, delivery to
28463 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28464 alternative hosts, if any.
28465
28466  &*Note*&:
28467 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28468 is operating as a client. Exim does not assume that a server certificate (set
28469 by the global options of the same name) should also be used when operating as a
28470 client.
28471
28472 .vindex "&$host$&"
28473 .vindex "&$host_address$&"
28474 All the TLS options in the &(smtp)& transport are expanded before use, with
28475 &$host$& and &$host_address$& containing the name and address of the server to
28476 which the client is connected. Forced failure of an expansion causes Exim to
28477 behave as if the relevant option were unset.
28478
28479 .vindex &$tls_out_bits$&
28480 .vindex &$tls_out_cipher$&
28481 .vindex &$tls_out_peerdn$&
28482 .vindex &$tls_out_sni$&
28483 Before an SMTP connection is established, the
28484 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28485 variables are emptied. (Until the first connection, they contain the values
28486 that were set when the message was received.) If STARTTLS is subsequently
28487 successfully obeyed, these variables are set to the relevant values for the
28488 outgoing connection.
28489
28490
28491
28492 .section "Use of TLS Server Name Indication" "SECTtlssni"
28493 .cindex "TLS" "Server Name Indication"
28494 .vindex "&$tls_in_sni$&"
28495 .oindex "&%tls_in_sni%&"
28496 With TLS1.0 or above, there is an extension mechanism by which extra
28497 information can be included at various points in the protocol.  One of these
28498 extensions, documented in RFC 6066 (and before that RFC 4366) is
28499 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28500 client in the initial handshake, so that the server can examine the servername
28501 within and possibly choose to use different certificates and keys (and more)
28502 for this session.
28503
28504 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28505 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28506 address.
28507
28508 With SMTP to MX, there are the same problems here as in choosing the identity
28509 against which to validate a certificate: you can't rely on insecure DNS to
28510 provide the identity which you then cryptographically verify.  So this will
28511 be of limited use in that environment.
28512
28513 With SMTP to Submission, there is a well-defined hostname which clients are
28514 connecting to and can validate certificates against.  Thus clients &*can*&
28515 choose to include this information in the TLS negotiation.  If this becomes
28516 wide-spread, then hosters can choose to present different certificates to
28517 different clients.  Or even negotiate different cipher suites.
28518
28519 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28520 if not empty, will be sent on a TLS session as part of the handshake.  There's
28521 nothing more to it.  Choosing a sensible value not derived insecurely is the
28522 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28523 for the lifetime of the client connection (including during authentication).
28524
28525 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28526 received from a client.
28527 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28528
28529 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28530 option (prior to expansion) then the following options will be re-expanded
28531 during TLS session handshake, to permit alternative values to be chosen:
28532
28533 .ilist
28534 &%tls_certificate%&
28535 .next
28536 &%tls_crl%&
28537 .next
28538 &%tls_privatekey%&
28539 .next
28540 &%tls_verify_certificates%&
28541 .next
28542 &%tls_ocsp_file%&
28543 .endlist
28544
28545 Great care should be taken to deal with matters of case, various injection
28546 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28547 can always be referenced; it is important to remember that &$tls_in_sni$& is
28548 arbitrary unverified data provided prior to authentication.
28549 Further, the initial certificate is loaded before SNI is arrived, so
28550 an expansion for &%tls_certificate%& must have a default which is used
28551 when &$tls_in_sni$& is empty.
28552
28553 The Exim developers are proceeding cautiously and so far no other TLS options
28554 are re-expanded.
28555
28556 When Exim is built against OpenSSL, OpenSSL must have been built with support
28557 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28558 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28559 see &`-servername`& in the output, then OpenSSL has support.
28560
28561 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28562 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28563 built, then you have SNI support).
28564
28565
28566
28567 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28568          "SECTmulmessam"
28569 .cindex "multiple SMTP deliveries with TLS"
28570 .cindex "TLS" "multiple message deliveries"
28571 Exim sends multiple messages down the same TCP/IP connection by starting up
28572 an entirely new delivery process for each message, passing the socket from
28573 one process to the next. This implementation does not fit well with the use
28574 of TLS, because there is quite a lot of state information associated with a TLS
28575 connection, not just a socket identification. Passing all the state information
28576 to a new process is not feasible. Consequently, for sending using TLS Exim
28577 starts an additional proxy process for handling the encryption, piping the
28578 unencrypted data stream from and to the delivery processes.
28579
28580 An older mode of operation can be enabled on a per-host basis by the
28581 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28582 this list the proxy process described above is not used; instead Exim
28583 shuts down an existing TLS session being run by the delivery process
28584 before passing the socket to a new process. The new process may then
28585 try to start a new TLS session, and if successful, may try to re-authenticate
28586 if AUTH is in use, before sending the next message.
28587
28588 The RFC is not clear as to whether or not an SMTP session continues in clear
28589 after TLS has been shut down, or whether TLS may be restarted again later, as
28590 just described. However, if the server is Exim, this shutdown and
28591 reinitialization works. It is not known which (if any) other servers operate
28592 successfully if the client closes a TLS session and continues with unencrypted
28593 SMTP, but there are certainly some that do not work. For such servers, Exim
28594 should not pass the socket to another process, because the failure of the
28595 subsequent attempt to use it would cause Exim to record a temporary host error,
28596 and delay other deliveries to that host.
28597
28598 To test for this case, Exim sends an EHLO command to the server after
28599 closing down the TLS session. If this fails in any way, the connection is
28600 closed instead of being passed to a new delivery process, but no retry
28601 information is recorded.
28602
28603 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28604 &(smtp)& transport to match those hosts for which Exim should not pass
28605 connections to new processes if TLS has been used.
28606
28607
28608
28609
28610 .section "Certificates and all that" "SECTcerandall"
28611 .cindex "certificate" "references to discussion"
28612 In order to understand fully how TLS works, you need to know about
28613 certificates, certificate signing, and certificate authorities.
28614 This is a large topic and an introductory guide is unsuitable for the Exim
28615 reference manual, so instead we provide pointers to existing documentation.
28616
28617 The Apache web-server was for a long time the canonical guide, so their
28618 documentation is a good place to start; their SSL module's Introduction
28619 document is currently at
28620 .display
28621 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28622 .endd
28623 and their FAQ is at
28624 .display
28625 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28626 .endd
28627
28628 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28629 0-201-61598-3) in 2001, contains both introductory and more in-depth
28630 descriptions.
28631 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28632 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28633 Ivan is the author of the popular TLS testing tools at
28634 &url(https://www.ssllabs.com/).
28635
28636
28637 .section "Certificate chains" "SECID186"
28638 The file named by &%tls_certificate%& may contain more than one
28639 certificate. This is useful in the case where the certificate that is being
28640 sent is validated by an intermediate certificate which the other end does
28641 not have. Multiple certificates must be in the correct order in the file.
28642 First the host's certificate itself, then the first intermediate
28643 certificate to validate the issuer of the host certificate, then the next
28644 intermediate certificate to validate the issuer of the first intermediate
28645 certificate, and so on, until finally (optionally) the root certificate.
28646 The root certificate must already be trusted by the recipient for
28647 validation to succeed, of course, but if it's not preinstalled, sending the
28648 root certificate along with the rest makes it available for the user to
28649 install if the receiving end is a client MUA that can interact with a user.
28650
28651 Note that certificates using MD5 are unlikely to work on today's Internet;
28652 even if your libraries allow loading them for use in Exim when acting as a
28653 server, increasingly clients will not accept such certificates.  The error
28654 diagnostics in such a case can be frustratingly vague.
28655
28656
28657
28658 .section "Self-signed certificates" "SECID187"
28659 .cindex "certificate" "self-signed"
28660 You can create a self-signed certificate using the &'req'& command provided
28661 with OpenSSL, like this:
28662 . ==== Do not shorten the duration here without reading and considering
28663 . ==== the text below.  Please leave it at 9999 days.
28664 .code
28665 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28666             -days 9999 -nodes
28667 .endd
28668 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28669 delimited and so can be identified independently. The &%-days%& option
28670 specifies a period for which the certificate is valid. The &%-nodes%& option is
28671 important: if you do not set it, the key is encrypted with a passphrase
28672 that you are prompted for, and any use that is made of the key causes more
28673 prompting for the passphrase. This is not helpful if you are going to use
28674 this certificate and key in an MTA, where prompting is not possible.
28675
28676 . ==== I expect to still be working 26 years from now.  The less technical
28677 . ==== debt I create, in terms of storing up trouble for my later years, the
28678 . ==== happier I will be then.  We really have reached the point where we
28679 . ==== should start, at the very least, provoking thought and making folks
28680 . ==== pause before proceeding, instead of leaving all the fixes until two
28681 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28682 . ==== -pdp, 2012
28683 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28684 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28685 the above command might produce a date in the past.  Think carefully about
28686 the lifetime of the systems you're deploying, and either reduce the duration
28687 of the certificate or reconsider your platform deployment.  (At time of
28688 writing, reducing the duration is the most likely choice, but the inexorable
28689 progression of time takes us steadily towards an era where this will not
28690 be a sensible resolution).
28691
28692 A self-signed certificate made in this way is sufficient for testing, and
28693 may be adequate for all your requirements if you are mainly interested in
28694 encrypting transfers, and not in secure identification.
28695
28696 However, many clients require that the certificate presented by the server be a
28697 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28698 certificate. In this situation, the self-signed certificate described above
28699 must be installed on the client host as a trusted root &'certification
28700 authority'& (CA), and the certificate used by Exim must be a user certificate
28701 signed with that self-signed certificate.
28702
28703 For information on creating self-signed CA certificates and using them to sign
28704 user certificates, see the &'General implementation overview'& chapter of the
28705 Open-source PKI book, available online at
28706 &url(https://sourceforge.net/projects/ospkibook/).
28707 .ecindex IIDencsmtp1
28708 .ecindex IIDencsmtp2
28709
28710
28711
28712 .section DANE "SECDANE"
28713 .cindex DANE
28714 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28715 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28716 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28717 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28718 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28719 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28720
28721 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28722 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28723 by (a) is thought to be smaller than that of the set of root CAs.
28724
28725 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28726 fail to pass on a server's STARTTLS.
28727
28728 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28729 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28730 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28731
28732 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28733 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28734 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28735 DNSSEC.
28736 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28737 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28738
28739 There are no changes to Exim specific to server-side operation of DANE.
28740 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28741 in &_Local/Makefile_&.
28742 If it has been included, the macro "_HAVE_DANE" will be defined.
28743
28744 The TLSA record for the server may have "certificate usage" of DANE-TA(2) or DANE-EE(3).
28745 These are the "Trust Anchor" and "End Entity" variants.
28746 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28747 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28748 this is appropriate for a single system, using a self-signed certificate.
28749 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28750 well-known one.
28751 A private CA at simplest is just a self-signed certificate (with certain
28752 attributes) which is used to sign server certificates, but running one securely
28753 does require careful arrangement.
28754 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28755 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28756 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28757 all of which point to a single TLSA record.
28758 DANE-TA and DANE-EE can both be used together.
28759
28760 Our recommendation is to use DANE with a certificate from a public CA,
28761 because this enables a variety of strategies for remote clients to verify
28762 your certificate.
28763 You can then publish information both via DANE and another technology,
28764 "MTA-STS", described below.
28765
28766 When you use DANE-TA to publish trust anchor information, you ask entities
28767 outside your administrative control to trust the Certificate Authority for
28768 connections to you.
28769 If using a private CA then you should expect others to still apply the
28770 technical criteria they'd use for a public CA to your certificates.
28771 In particular, you should probably try to follow current best practices for CA
28772 operation around hash algorithms and key sizes.
28773 Do not expect other organizations to lower their security expectations just
28774 because a particular profile might be reasonable for your own internal use.
28775
28776 When this text was last updated, this in practice means to avoid use of SHA-1
28777 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28778 than 4096, for interoperability); to use keyUsage fields correctly; to use
28779 random serial numbers.
28780 The list of requirements is subject to change as best practices evolve.
28781 If you're not already using a private CA, or it doesn't meet these
28782 requirements, then we encourage you to avoid all these issues and use a public
28783 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28784
28785 The TLSA record should have a Selector field of SPKI(1) and a Matching Type field of SHA2-512(2).
28786
28787 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
28788 is useful for quickly generating TLSA records; and commands like
28789
28790 .code
28791   openssl x509 -in -pubkey -noout <certificate.pem \
28792   | openssl rsa -outform der -pubin 2>/dev/null \
28793   | openssl sha512 \
28794   | awk '{print $2}'
28795 .endd
28796
28797 are workable for 4th-field hashes.
28798
28799 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
28800
28801 The Certificate issued by the CA published in the DANE-TA model should be
28802 issued using a strong hash algorithm.
28803 Exim, and importantly various other MTAs sending to you, will not
28804 re-enable hash algorithms which have been disabled by default in TLS
28805 libraries.
28806 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
28807 interoperability (and probably the maximum too, in 2018).
28808
28809 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
28810 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
28811 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
28812
28813 .code
28814   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
28815                                  {= {4}{$tls_out_tlsa_usage}} } \
28816                          {*}{}}
28817 .endd
28818
28819 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
28820 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
28821 found. If the definition of &%hosts_request_ocsp%& includes the
28822 string "tls_out_tlsa_usage", they are re-expanded in time to
28823 control the OCSP request.
28824
28825 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
28826 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
28827
28828
28829 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
28830 and &%dane_require_tls_ciphers%&.
28831 The require variant will result in failure if the target host is not DNSSEC-secured.
28832
28833 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
28834
28835 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
28836 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
28837 will be required for the host.  If it does not, the host will not
28838 be used; there is no fallback to non-DANE or non-TLS.
28839
28840 If DANE is requested and usable, then the TLS cipher list configuration
28841 prefers to use the option &%dane_require_tls_ciphers%& and falls
28842 back to &%tls_require_ciphers%& only if that is unset.
28843 This lets you configure "decent crypto" for DANE and "better than nothing
28844 crypto" as the default.  Note though that while GnuTLS lets the string control
28845 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
28846 limited to ciphersuite constraints.
28847
28848 If DANE is requested and useable (see above) the following transport options are ignored:
28849 .code
28850   hosts_require_tls
28851   tls_verify_hosts
28852   tls_try_verify_hosts
28853   tls_verify_certificates
28854   tls_crl
28855   tls_verify_cert_hostnames
28856 .endd
28857
28858 If DANE is not usable, whether requested or not, and CA-anchored
28859 verification evaluation is wanted, the above variables should be set appropriately.
28860
28861 Currently the &%dnssec_request_domains%& must be active and &%dnssec_require_domains%& is ignored.
28862
28863 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
28864
28865 There is a new variable &$tls_out_dane$& which will have "yes" if
28866 verification succeeded using DANE and "no" otherwise (only useful
28867 in combination with events; see &<<CHAPevents>>&),
28868 and a new variable &$tls_out_tlsa_usage$& (detailed above).
28869
28870 .cindex DANE reporting
28871 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
28872 to achieve DANE-verified connection, if one was either requested and offered, or
28873 required.  This is intended to support TLS-reporting as defined in
28874 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
28875 The &$event_data$& will be one of the Result Types defined in
28876 Section 4.3 of that document.
28877
28878 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
28879
28880 DANE is specified in published RFCs and decouples certificate authority trust
28881 selection from a "race to the bottom" of "you must trust everything for mail
28882 to get through".  There is an alternative technology called MTA-STS, which
28883 instead publishes MX trust anchor information on an HTTPS website.  At the
28884 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
28885 Exim has no support for MTA-STS as a client, but Exim mail server operators
28886 can choose to publish information describing their TLS configuration using
28887 MTA-STS to let those clients who do use that protocol derive trust
28888 information.
28889
28890 The MTA-STS design requires a certificate from a public Certificate Authority
28891 which is recognized by clients sending to you.
28892 That selection of which CAs are trusted by others is outside your control.
28893
28894 The most interoperable course of action is probably to use
28895 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
28896 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
28897 records for DANE clients (such as Exim and Postfix) and to publish anchor
28898 information for MTA-STS as well.  This is what is done for the &'exim.org'&
28899 domain itself (with caveats around occasionally broken MTA-STS because of
28900 incompatible specification changes prior to reaching RFC status).
28901
28902
28903
28904 . ////////////////////////////////////////////////////////////////////////////
28905 . ////////////////////////////////////////////////////////////////////////////
28906
28907 .chapter "Access control lists" "CHAPACL"
28908 .scindex IIDacl "&ACL;" "description"
28909 .cindex "control of incoming mail"
28910 .cindex "message" "controlling incoming"
28911 .cindex "policy control" "access control lists"
28912 Access Control Lists (ACLs) are defined in a separate section of the runtime
28913 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
28914 name, terminated by a colon. Here is a complete ACL section that contains just
28915 one very small ACL:
28916 .code
28917 begin acl
28918 small_acl:
28919   accept   hosts = one.host.only
28920 .endd
28921 You can have as many lists as you like in the ACL section, and the order in
28922 which they appear does not matter. The lists are self-terminating.
28923
28924 The majority of ACLs are used to control Exim's behaviour when it receives
28925 certain SMTP commands. This applies both to incoming TCP/IP connections, and
28926 when a local process submits a message using SMTP by specifying the &%-bs%&
28927 option. The most common use is for controlling which recipients are accepted
28928 in incoming messages. In addition, you can define an ACL that is used to check
28929 local non-SMTP messages. The default configuration file contains an example of
28930 a realistic ACL for checking RCPT commands. This is discussed in chapter
28931 &<<CHAPdefconfil>>&.
28932
28933
28934 .section "Testing ACLs" "SECID188"
28935 The &%-bh%& command line option provides a way of testing your ACL
28936 configuration locally by running a fake SMTP session with which you interact.
28937
28938
28939 .section "Specifying when ACLs are used" "SECID189"
28940 .cindex "&ACL;" "options for specifying"
28941 In order to cause an ACL to be used, you have to name it in one of the relevant
28942 options in the main part of the configuration. These options are:
28943 .cindex "AUTH" "ACL for"
28944 .cindex "DATA" "ACLs for"
28945 .cindex "ETRN" "ACL for"
28946 .cindex "EXPN" "ACL for"
28947 .cindex "HELO" "ACL for"
28948 .cindex "EHLO" "ACL for"
28949 .cindex "DKIM" "ACL for"
28950 .cindex "MAIL" "ACL for"
28951 .cindex "QUIT, ACL for"
28952 .cindex "RCPT" "ACL for"
28953 .cindex "STARTTLS, ACL for"
28954 .cindex "VRFY" "ACL for"
28955 .cindex "SMTP" "connection, ACL for"
28956 .cindex "non-SMTP messages" "ACLs for"
28957 .cindex "MIME content scanning" "ACL for"
28958 .cindex "PRDR" "ACL for"
28959
28960 .table2 140pt
28961 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
28962 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
28963 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
28964 .irow &%acl_smtp_auth%&        "ACL for AUTH"
28965 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
28966 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
28967 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
28968 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
28969 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
28970 .irow &%acl_smtp_expn%&        "ACL for EXPN"
28971 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
28972 .irow &%acl_smtp_mail%&        "ACL for MAIL"
28973 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
28974 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
28975 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
28976 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
28977 .irow &%acl_smtp_quit%&        "ACL for QUIT"
28978 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
28979 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
28980 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
28981 .endtable
28982
28983 For example, if you set
28984 .code
28985 acl_smtp_rcpt = small_acl
28986 .endd
28987 the little ACL defined above is used whenever Exim receives a RCPT command
28988 in an SMTP dialogue. The majority of policy tests on incoming messages can be
28989 done when RCPT commands arrive. A rejection of RCPT should cause the
28990 sending MTA to give up on the recipient address contained in the RCPT
28991 command, whereas rejection at other times may cause the client MTA to keep on
28992 trying to deliver the message. It is therefore recommended that you do as much
28993 testing as possible at RCPT time.
28994
28995
28996 .section "The non-SMTP ACLs" "SECID190"
28997 .cindex "non-SMTP messages" "ACLs for"
28998 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
28999 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29000 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29001 the state of the SMTP connection such as encryption and authentication) are not
29002 relevant and are forbidden in these ACLs. However, the sender and recipients
29003 are known, so the &%senders%& and &%sender_domains%& conditions and the
29004 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29005 &$authenticated_sender$& are also available. You can specify added header lines
29006 in any of these ACLs.
29007
29008 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29009 non-SMTP message, before any of the message has been read. (This is the
29010 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29011 batched SMTP input, it runs after the DATA command has been reached. The
29012 result of this ACL is ignored; it cannot be used to reject a message. If you
29013 really need to, you could set a value in an ACL variable here and reject based
29014 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29015 controls, and in particular, it can be used to set
29016 .code
29017 control = suppress_local_fixups
29018 .endd
29019 This cannot be used in the other non-SMTP ACLs because by the time they are
29020 run, it is too late.
29021
29022 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29023 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29024
29025 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29026 kind of rejection is treated as permanent, because there is no way of sending a
29027 temporary error for these kinds of message.
29028
29029
29030 .section "The SMTP connect ACL" "SECID191"
29031 .cindex "SMTP" "connection, ACL for"
29032 .oindex &%smtp_banner%&
29033 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29034 session, after the test specified by &%host_reject_connection%& (which is now
29035 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29036 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29037 the message override the banner message that is otherwise specified by the
29038 &%smtp_banner%& option.
29039
29040
29041 .section "The EHLO/HELO ACL" "SECID192"
29042 .cindex "EHLO" "ACL for"
29043 .cindex "HELO" "ACL for"
29044 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29045 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29046 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29047 Note that a client may issue more than one EHLO or HELO command in an SMTP
29048 session, and indeed is required to issue a new EHLO or HELO after successfully
29049 setting up encryption following a STARTTLS command.
29050
29051 Note also that a deny neither forces the client to go away nor means that
29052 mail will be refused on the connection.  Consider checking for
29053 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29054
29055 If the command is accepted by an &%accept%& verb that has a &%message%&
29056 modifier, the message may not contain more than one line (it will be truncated
29057 at the first newline and a panic logged if it does). Such a message cannot
29058 affect the EHLO options that are listed on the second and subsequent lines of
29059 an EHLO response.
29060
29061
29062 .section "The DATA ACLs" "SECID193"
29063 .cindex "DATA" "ACLs for"
29064 Two ACLs are associated with the DATA command, because it is two-stage
29065 command, with two responses being sent to the client.
29066 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29067 is obeyed. This gives you control after all the RCPT commands, but before
29068 the message itself is received. It offers the opportunity to give a negative
29069 response to the DATA command before the data is transmitted. Header lines
29070 added by MAIL or RCPT ACLs are not visible at this time, but any that
29071 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29072
29073 You cannot test the contents of the message, for example, to verify addresses
29074 in the headers, at RCPT time or when the DATA command is received. Such
29075 tests have to appear in the ACL that is run after the message itself has been
29076 received, before the final response to the DATA command is sent. This is
29077 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29078 associated with the DATA command.
29079
29080 .cindex CHUNKING "BDAT command"
29081 .cindex BDAT "SMTP command"
29082 .cindex "RFC 3030" CHUNKING
29083 If CHUNKING was advertised and a BDAT command sequence is received,
29084 the &%acl_smtp_predata%& ACL is not run.
29085 . XXX why not?  It should be possible, for the first BDAT.
29086 The &%acl_smtp_data%& is run after the last BDAT command and all of
29087 the data specified is received.
29088
29089 For both of these ACLs, it is not possible to reject individual recipients. An
29090 error response rejects the entire message. Unfortunately, it is known that some
29091 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29092 before or after the data) correctly &-- they keep the message on their queues
29093 and try again later, but that is their problem, though it does waste some of
29094 your resources.
29095
29096 The &%acl_smtp_data%& ACL is run after
29097 the &%acl_smtp_data_prdr%&,
29098 the &%acl_smtp_dkim%&
29099 and the &%acl_smtp_mime%& ACLs.
29100
29101 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29102 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29103 enabled (which is the default).
29104
29105 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29106 received, and is executed for each DKIM signature found in a message.  If not
29107 otherwise specified, the default action is to accept.
29108
29109 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29110
29111 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29112
29113
29114 .section "The SMTP MIME ACL" "SECID194"
29115 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29116 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29117
29118 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29119
29120
29121 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29122 .cindex "PRDR" "ACL for"
29123 .oindex "&%prdr_enable%&"
29124 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29125 with PRDR support enabled (which is the default).
29126 It becomes active only when the PRDR feature is negotiated between
29127 client and server for a message, and more than one recipient
29128 has been accepted.
29129
29130 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29131 has been received, and is executed once for each recipient of the message
29132 with &$local_part$& and &$domain$& valid.
29133 The test may accept, defer or deny for individual recipients.
29134 The &%acl_smtp_data%& will still be called after this ACL and
29135 can reject the message overall, even if this ACL has accepted it
29136 for some or all recipients.
29137
29138 PRDR may be used to support per-user content filtering.  Without it
29139 one must defer any recipient after the first that has a different
29140 content-filter configuration.  With PRDR, the RCPT-time check
29141 .cindex "PRDR" "variable for"
29142 for this can be disabled when the variable &$prdr_requested$&
29143 is &"yes"&.
29144 Any required difference in behaviour of the main DATA-time
29145 ACL should however depend on the PRDR-time ACL having run, as Exim
29146 will avoid doing so in some situations (e.g. single-recipient mails).
29147
29148 See also the &%prdr_enable%& global option
29149 and the &%hosts_try_prdr%& smtp transport option.
29150
29151 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29152 If the ACL is not defined, processing completes as if
29153 the feature was not requested by the client.
29154
29155 .section "The QUIT ACL" "SECTQUITACL"
29156 .cindex "QUIT, ACL for"
29157 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29158 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29159 does not in fact control any access.
29160 For this reason, it may only accept
29161 or warn as its final result.
29162
29163 This ACL can be used for tasks such as custom logging at the end of an SMTP
29164 session. For example, you can use ACL variables in other ACLs to count
29165 messages, recipients, etc., and log the totals at QUIT time using one or
29166 more &%logwrite%& modifiers on a &%warn%& verb.
29167
29168 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29169 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29170
29171 You do not need to have a final &%accept%&, but if you do, you can use a
29172 &%message%& modifier to specify custom text that is sent as part of the 221
29173 response to QUIT.
29174
29175 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29176 failure (for example, failure to open a log file, or when Exim is bombing out
29177 because it has detected an unrecoverable error), all SMTP commands from the
29178 client are given temporary error responses until QUIT is received or the
29179 connection is closed. In these special cases, the QUIT ACL does not run.
29180
29181
29182 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29183 .vindex &$acl_smtp_notquit$&
29184 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29185 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29186 trouble, such as being unable to write to its log files, this ACL is not run,
29187 because it might try to do things (such as write to log files) that make the
29188 situation even worse.
29189
29190 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29191 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29192 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29193 and &%warn%&.
29194
29195 .vindex &$smtp_notquit_reason$&
29196 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29197 to a string that indicates the reason for the termination of the SMTP
29198 connection. The possible values are:
29199 .table2
29200 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29201 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29202 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29203 .irow &`connection-lost`&          "The SMTP connection has been lost"
29204 .irow &`data-timeout`&             "Timeout while reading message data"
29205 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29206 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29207 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29208 .irow &`synchronization-error`&    "SMTP synchronization error"
29209 .irow &`tls-failed`&               "TLS failed to start"
29210 .endtable
29211 In most cases when an SMTP connection is closed without having received QUIT,
29212 Exim sends an SMTP response message before actually closing the connection.
29213 With the exception of the &`acl-drop`& case, the default message can be
29214 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29215 &%drop%& verb in another ACL, it is the message from the other ACL that is
29216 used.
29217
29218
29219 .section "Finding an ACL to use" "SECID195"
29220 .cindex "&ACL;" "finding which to use"
29221 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29222 you can use different ACLs in different circumstances. For example,
29223 .code
29224 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29225                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29226 .endd
29227 In the default configuration file there are some example settings for
29228 providing an RFC 4409 message &"submission"& service on port 587 and
29229 an RFC 8314 &"submissions"& service on port 465. You can use a string
29230 expansion like this to choose an ACL for MUAs on these ports which is
29231 more appropriate for this purpose than the default ACL on port 25.
29232
29233 The expanded string does not have to be the name of an ACL in the
29234 configuration file; there are other possibilities. Having expanded the
29235 string, Exim searches for an ACL as follows:
29236
29237 .ilist
29238 If the string begins with a slash, Exim uses it as a filename, and reads its
29239 contents as an ACL. The lines are processed in the same way as lines in the
29240 Exim configuration file. In particular, continuation lines are supported, blank
29241 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29242 If the file does not exist or cannot be read, an error occurs (typically
29243 causing a temporary failure of whatever caused the ACL to be run). For example:
29244 .code
29245 acl_smtp_data = /etc/acls/\
29246   ${lookup{$sender_host_address}lsearch\
29247   {/etc/acllist}{$value}{default}}
29248 .endd
29249 This looks up an ACL file to use on the basis of the host's IP address, falling
29250 back to a default if the lookup fails. If an ACL is successfully read from a
29251 file, it is retained in memory for the duration of the Exim process, so that it
29252 can be re-used without having to re-read the file.
29253 .next
29254 If the string does not start with a slash, and does not contain any spaces,
29255 Exim searches the ACL section of the configuration for an ACL whose name
29256 matches the string.
29257 .next
29258 If no named ACL is found, or if the string contains spaces, Exim parses
29259 the string as an inline ACL. This can save typing in cases where you just
29260 want to have something like
29261 .code
29262 acl_smtp_vrfy = accept
29263 .endd
29264 in order to allow free use of the VRFY command. Such a string may contain
29265 newlines; it is processed in the same way as an ACL that is read from a file.
29266 .endlist
29267
29268
29269
29270
29271 .section "ACL return codes" "SECID196"
29272 .cindex "&ACL;" "return codes"
29273 Except for the QUIT ACL, which does not affect the SMTP return code (see
29274 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29275 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29276 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29277 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29278 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29279 This also causes a 4&'xx'& return code.
29280
29281 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29282 &"deny"&, because there is no mechanism for passing temporary errors to the
29283 submitters of non-SMTP messages.
29284
29285
29286 ACLs that are relevant to message reception may also return &"discard"&. This
29287 has the effect of &"accept"&, but causes either the entire message or an
29288 individual recipient address to be discarded. In other words, it is a
29289 blackholing facility. Use it with care.
29290
29291 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29292 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29293 RCPT ACL is to discard just the one recipient address. If there are no
29294 recipients left when the message's data is received, the DATA ACL is not
29295 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29296 remaining recipients. The &"discard"& return is not permitted for the
29297 &%acl_smtp_predata%& ACL.
29298
29299 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29300 is done on the address and the result determines the SMTP response.
29301
29302
29303 .cindex "&[local_scan()]& function" "when all recipients discarded"
29304 The &[local_scan()]& function is always run, even if there are no remaining
29305 recipients; it may create new recipients.
29306
29307
29308
29309 .section "Unset ACL options" "SECID197"
29310 .cindex "&ACL;" "unset options"
29311 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29312 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29313 not defined at all. For any defined ACL, the default action when control
29314 reaches the end of the ACL statements is &"deny"&.
29315
29316 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29317 these two are ACLs that are used only for their side effects. They cannot be
29318 used to accept or reject anything.
29319
29320 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29321 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29322 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29323 when the ACL is not defined is &"accept"&.
29324
29325 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29326 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29327 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29328 messages over an SMTP connection. For an example, see the ACL in the default
29329 configuration file.
29330
29331
29332
29333
29334 .section "Data for message ACLs" "SECID198"
29335 .cindex "&ACL;" "data for message ACL"
29336 .vindex &$domain$&
29337 .vindex &$local_part$&
29338 .vindex &$sender_address$&
29339 .vindex &$sender_host_address$&
29340 .vindex &$smtp_command$&
29341 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29342 that contain information about the host and the message's sender (for example,
29343 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29344 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29345 &$local_part$& are set from the argument address. The entire SMTP command
29346 is available in &$smtp_command$&.
29347
29348 When an ACL for the AUTH parameter of MAIL is running, the variables that
29349 contain information about the host are set, but &$sender_address$& is not yet
29350 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29351 how it is used.
29352
29353 .vindex "&$message_size$&"
29354 The &$message_size$& variable is set to the value of the SIZE parameter on
29355 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29356 that parameter is not given. The value is updated to the true message size by
29357 the time the final DATA ACL is run (after the message data has been
29358 received).
29359
29360 .vindex "&$rcpt_count$&"
29361 .vindex "&$recipients_count$&"
29362 The &$rcpt_count$& variable increases by one for each RCPT command received.
29363 The &$recipients_count$& variable increases by one each time a RCPT command is
29364 accepted, so while an ACL for RCPT is being processed, it contains the number
29365 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29366 &$rcpt_count$& contains the total number of RCPT commands, and
29367 &$recipients_count$& contains the total number of accepted recipients.
29368
29369
29370
29371
29372
29373 .section "Data for non-message ACLs" "SECTdatfornon"
29374 .cindex "&ACL;" "data for non-message ACL"
29375 .vindex &$smtp_command_argument$&
29376 .vindex &$smtp_command$&
29377 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29378 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29379 and the entire SMTP command is available in &$smtp_command$&.
29380 These variables can be tested using a &%condition%& condition. For example,
29381 here is an ACL for use with AUTH, which insists that either the session is
29382 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29383 does not permit authentication methods that use cleartext passwords on
29384 unencrypted connections.
29385 .code
29386 acl_check_auth:
29387   accept encrypted = *
29388   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29389                      {CRAM-MD5}}
29390   deny   message   = TLS encryption or CRAM-MD5 required
29391 .endd
29392 (Another way of applying this restriction is to arrange for the authenticators
29393 that use cleartext passwords not to be advertised when the connection is not
29394 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29395 option to do this.)
29396
29397
29398
29399 .section "Format of an ACL" "SECID199"
29400 .cindex "&ACL;" "format of"
29401 .cindex "&ACL;" "verbs, definition of"
29402 An individual ACL consists of a number of statements. Each statement starts
29403 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29404 Modifiers can change the way the verb operates, define error and log messages,
29405 set variables, insert delays, and vary the processing of accepted messages.
29406
29407 If all the conditions are met, the verb is obeyed. The same condition may be
29408 used (with different arguments) more than once in the same statement. This
29409 provides a means of specifying an &"and"& conjunction between conditions. For
29410 example:
29411 .code
29412 deny  dnslists = list1.example
29413       dnslists = list2.example
29414 .endd
29415 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29416 the conditions and modifiers when it reaches a condition that fails. What
29417 happens then depends on the verb (and in one case, on a special modifier). Not
29418 all the conditions make sense at every testing point. For example, you cannot
29419 test a sender address in the ACL that is run for a VRFY command.
29420
29421
29422 .section "ACL verbs" "SECID200"
29423 The ACL verbs are as follows:
29424
29425 .ilist
29426 .cindex "&%accept%& ACL verb"
29427 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29428 of the conditions are not met, what happens depends on whether &%endpass%&
29429 appears among the conditions (for syntax see below). If the failing condition
29430 is before &%endpass%&, control is passed to the next ACL statement; if it is
29431 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29432 check a RCPT command:
29433 .code
29434 accept domains = +local_domains
29435        endpass
29436        verify = recipient
29437 .endd
29438 If the recipient domain does not match the &%domains%& condition, control
29439 passes to the next statement. If it does match, the recipient is verified, and
29440 the command is accepted if verification succeeds. However, if verification
29441 fails, the ACL yields &"deny"&, because the failing condition is after
29442 &%endpass%&.
29443
29444 The &%endpass%& feature has turned out to be confusing to many people, so its
29445 use is not recommended nowadays. It is always possible to rewrite an ACL so
29446 that &%endpass%& is not needed, and it is no longer used in the default
29447 configuration.
29448
29449 .cindex "&%message%& ACL modifier" "with &%accept%&"
29450 If a &%message%& modifier appears on an &%accept%& statement, its action
29451 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29452 (when an &%accept%& verb either accepts or passes control to the next
29453 statement), &%message%& can be used to vary the message that is sent when an
29454 SMTP command is accepted. For example, in a RCPT ACL you could have:
29455 .display
29456 &`accept  `&<&'some conditions'&>
29457 &`        message = OK, I will allow you through today`&
29458 .endd
29459 You can specify an SMTP response code, optionally followed by an &"extended
29460 response code"& at the start of the message, but the first digit must be the
29461 same as would be sent by default, which is 2 for an &%accept%& verb.
29462
29463 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29464 an error message that is used when access is denied. This behaviour is retained
29465 for backward compatibility, but current &"best practice"& is to avoid the use
29466 of &%endpass%&.
29467
29468
29469 .next
29470 .cindex "&%defer%& ACL verb"
29471 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29472 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29473 &%defer%& is the same as &%deny%&, because there is no way of sending a
29474 temporary error. For a RCPT command, &%defer%& is much the same as using a
29475 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29476 be used in any ACL, and even for a recipient it might be a simpler approach.
29477
29478
29479 .next
29480 .cindex "&%deny%& ACL verb"
29481 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29482 the conditions are not met, control is passed to the next ACL statement. For
29483 example,
29484 .code
29485 deny dnslists = blackholes.mail-abuse.org
29486 .endd
29487 rejects commands from hosts that are on a DNS black list.
29488
29489
29490 .next
29491 .cindex "&%discard%& ACL verb"
29492 &%discard%&: This verb behaves like &%accept%&, except that it returns
29493 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29494 that are concerned with receiving messages. When all the conditions are true,
29495 the sending entity receives a &"success"& response. However, &%discard%& causes
29496 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29497 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29498 message's recipients are discarded. Recipients that are discarded before DATA
29499 do not appear in the log line when the &%received_recipients%& log selector is set.
29500
29501 If the &%log_message%& modifier is set when &%discard%& operates,
29502 its contents are added to the line that is automatically written to the log.
29503 The &%message%& modifier operates exactly as it does for &%accept%&.
29504
29505
29506 .next
29507 .cindex "&%drop%& ACL verb"
29508 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29509 forcibly closed after the 5&'xx'& error message has been sent. For example:
29510 .code
29511 drop   message   = I don't take more than 20 RCPTs
29512        condition = ${if > {$rcpt_count}{20}}
29513 .endd
29514 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29515 The connection is always dropped after sending a 550 response.
29516
29517 .next
29518 .cindex "&%require%& ACL verb"
29519 &%require%&: If all the conditions are met, control is passed to the next ACL
29520 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29521 example, when checking a RCPT command,
29522 .code
29523 require message = Sender did not verify
29524         verify  = sender
29525 .endd
29526 passes control to subsequent statements only if the message's sender can be
29527 verified. Otherwise, it rejects the command. Note the positioning of the
29528 &%message%& modifier, before the &%verify%& condition. The reason for this is
29529 discussed in section &<<SECTcondmodproc>>&.
29530
29531 .next
29532 .cindex "&%warn%& ACL verb"
29533 &%warn%&: If all the conditions are true, a line specified by the
29534 &%log_message%& modifier is written to Exim's main log. Control always passes
29535 to the next ACL statement. If any condition is false, the log line is not
29536 written. If an identical log line is requested several times in the same
29537 message, only one copy is actually written to the log. If you want to force
29538 duplicates to be written, use the &%logwrite%& modifier instead.
29539
29540 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29541 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29542 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29543 first failing condition. There is more about adding header lines in section
29544 &<<SECTaddheadacl>>&.
29545
29546 If any condition on a &%warn%& statement cannot be completed (that is, there is
29547 some sort of defer), the log line specified by &%log_message%& is not written.
29548 This does not include the case of a forced failure from a lookup, which
29549 is considered to be a successful completion. After a defer, no further
29550 conditions or modifiers in the &%warn%& statement are processed. The incident
29551 is logged, and the ACL continues to be processed, from the next statement
29552 onwards.
29553
29554
29555 .vindex "&$acl_verify_message$&"
29556 When one of the &%warn%& conditions is an address verification that fails, the
29557 text of the verification failure message is in &$acl_verify_message$&. If you
29558 want this logged, you must set it up explicitly. For example:
29559 .code
29560 warn   !verify = sender
29561        log_message = sender verify failed: $acl_verify_message
29562 .endd
29563 .endlist
29564
29565 At the end of each ACL there is an implicit unconditional &%deny%&.
29566
29567 As you can see from the examples above, the conditions and modifiers are
29568 written one to a line, with the first one on the same line as the verb, and
29569 subsequent ones on following lines. If you have a very long condition, you can
29570 continue it onto several physical lines by the usual backslash continuation
29571 mechanism. It is conventional to align the conditions vertically.
29572
29573
29574
29575 .section "ACL variables" "SECTaclvariables"
29576 .cindex "&ACL;" "variables"
29577 There are some special variables that can be set during ACL processing. They
29578 can be used to pass information between different ACLs, different invocations
29579 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29580 transports, and filters that are used to deliver a message. The names of these
29581 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29582 an underscore, but the remainder of the name can be any sequence of
29583 alphanumeric characters and underscores that you choose. There is no limit on
29584 the number of ACL variables. The two sets act as follows:
29585 .ilist
29586 The values of those variables whose names begin with &$acl_c$& persist
29587 throughout an SMTP connection. They are never reset. Thus, a value that is set
29588 while receiving one message is still available when receiving the next message
29589 on the same SMTP connection.
29590 .next
29591 The values of those variables whose names begin with &$acl_m$& persist only
29592 while a message is being received. They are reset afterwards. They are also
29593 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29594 .endlist
29595
29596 When a message is accepted, the current values of all the ACL variables are
29597 preserved with the message and are subsequently made available at delivery
29598 time. The ACL variables are set by a modifier called &%set%&. For example:
29599 .code
29600 accept hosts = whatever
29601        set acl_m4 = some value
29602 accept authenticated = *
29603        set acl_c_auth = yes
29604 .endd
29605 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29606 be set. If you want to set a variable without taking any action, you can use a
29607 &%warn%& verb without any other modifiers or conditions.
29608
29609 .oindex &%strict_acl_vars%&
29610 What happens if a syntactically valid but undefined ACL variable is
29611 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29612 false (the default), an empty string is substituted; if it is true, an
29613 error is generated.
29614
29615 Versions of Exim before 4.64 have a limited set of numbered variables, but
29616 their names are compatible, so there is no problem with upgrading.
29617
29618
29619 .section "Condition and modifier processing" "SECTcondmodproc"
29620 .cindex "&ACL;" "conditions; processing"
29621 .cindex "&ACL;" "modifiers; processing"
29622 An exclamation mark preceding a condition negates its result. For example:
29623 .code
29624 deny   domains = *.dom.example
29625       !verify  = recipient
29626 .endd
29627 causes the ACL to return &"deny"& if the recipient domain ends in
29628 &'dom.example'& and the recipient address cannot be verified. Sometimes
29629 negation can be used on the right-hand side of a condition. For example, these
29630 two statements are equivalent:
29631 .code
29632 deny  hosts = !192.168.3.4
29633 deny !hosts =  192.168.3.4
29634 .endd
29635 However, for many conditions (&%verify%& being a good example), only left-hand
29636 side negation of the whole condition is possible.
29637
29638 The arguments of conditions and modifiers are expanded. A forced failure
29639 of an expansion causes a condition to be ignored, that is, it behaves as if the
29640 condition is true. Consider these two statements:
29641 .code
29642 accept  senders = ${lookup{$host_name}lsearch\
29643                   {/some/file}{$value}fail}
29644 accept  senders = ${lookup{$host_name}lsearch\
29645                   {/some/file}{$value}{}}
29646 .endd
29647 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29648 the returned list is searched, but if the lookup fails the behaviour is
29649 different in the two cases. The &%fail%& in the first statement causes the
29650 condition to be ignored, leaving no further conditions. The &%accept%& verb
29651 therefore succeeds. The second statement, however, generates an empty list when
29652 the lookup fails. No sender can match an empty list, so the condition fails,
29653 and therefore the &%accept%& also fails.
29654
29655 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29656 specify actions that are taken as the conditions for a statement are checked;
29657 others specify text for messages that are used when access is denied or a
29658 warning is generated. The &%control%& modifier affects the way an incoming
29659 message is handled.
29660
29661 The positioning of the modifiers in an ACL statement is important, because the
29662 processing of a verb ceases as soon as its outcome is known. Only those
29663 modifiers that have already been encountered will take effect. For example,
29664 consider this use of the &%message%& modifier:
29665 .code
29666 require message = Can't verify sender
29667         verify  = sender
29668         message = Can't verify recipient
29669         verify  = recipient
29670         message = This message cannot be used
29671 .endd
29672 If sender verification fails, Exim knows that the result of the statement is
29673 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29674 so its text is used as the error message. If sender verification succeeds, but
29675 recipient verification fails, the second message is used. If recipient
29676 verification succeeds, the third message becomes &"current"&, but is never used
29677 because there are no more conditions to cause failure.
29678
29679 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29680 modifier that is used, because all the conditions must be true for rejection to
29681 happen. Specifying more than one &%message%& modifier does not make sense, and
29682 the message can even be specified after all the conditions. For example:
29683 .code
29684 deny   hosts = ...
29685       !senders = *@my.domain.example
29686        message = Invalid sender from client host
29687 .endd
29688 The &"deny"& result does not happen until the end of the statement is reached,
29689 by which time Exim has set up the message.
29690
29691
29692
29693 .section "ACL modifiers" "SECTACLmodi"
29694 .cindex "&ACL;" "modifiers; list of"
29695 The ACL modifiers are as follows:
29696
29697 .vlist
29698 .vitem &*add_header*&&~=&~<&'text'&>
29699 This modifier specifies one or more header lines that are to be added to an
29700 incoming message, assuming, of course, that the message is ultimately
29701 accepted. For details, see section &<<SECTaddheadacl>>&.
29702
29703 .vitem &*continue*&&~=&~<&'text'&>
29704 .cindex "&%continue%& ACL modifier"
29705 .cindex "database" "updating in ACL"
29706 This modifier does nothing of itself, and processing of the ACL always
29707 continues with the next condition or modifier. The value of &%continue%& is in
29708 the side effects of expanding its argument. Typically this could be used to
29709 update a database. It is really just a syntactic tidiness, to avoid having to
29710 write rather ugly lines like this:
29711 .display
29712 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29713 .endd
29714 Instead, all you need is
29715 .display
29716 &`continue = `&<&'some expansion'&>
29717 .endd
29718
29719 .vitem &*control*&&~=&~<&'text'&>
29720 .cindex "&%control%& ACL modifier"
29721 This modifier affects the subsequent processing of the SMTP connection or of an
29722 incoming message that is accepted. The effect of the first type of control
29723 lasts for the duration of the connection, whereas the effect of the second type
29724 lasts only until the current message has been received. The message-specific
29725 controls always apply to the whole message, not to individual recipients,
29726 even if the &%control%& modifier appears in a RCPT ACL.
29727
29728 As there are now quite a few controls that can be applied, they are described
29729 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29730 in several different ways. For example:
29731
29732 . ==== As this is a nested list, any displays it contains must be indented
29733 . ==== as otherwise they are too far to the left. That comment applies only
29734 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29735 . ==== way.
29736
29737 .ilist
29738 It can be at the end of an &%accept%& statement:
29739 .code
29740     accept  ...some conditions
29741             control = queue_only
29742 .endd
29743 In this case, the control is applied when this statement yields &"accept"&, in
29744 other words, when the conditions are all true.
29745
29746 .next
29747 It can be in the middle of an &%accept%& statement:
29748 .code
29749     accept  ...some conditions...
29750             control = queue_only
29751             ...some more conditions...
29752 .endd
29753 If the first set of conditions are true, the control is applied, even if the
29754 statement does not accept because one of the second set of conditions is false.
29755 In this case, some subsequent statement must yield &"accept"& for the control
29756 to be relevant.
29757
29758 .next
29759 It can be used with &%warn%& to apply the control, leaving the
29760 decision about accepting or denying to a subsequent verb. For
29761 example:
29762 .code
29763     warn    ...some conditions...
29764             control = freeze
29765     accept  ...
29766 .endd
29767 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29768 &%logwrite%&, so it does not add anything to the message and does not write a
29769 log entry.
29770
29771 .next
29772 If you want to apply a control unconditionally, you can use it with a
29773 &%require%& verb. For example:
29774 .code
29775     require  control = no_multiline_responses
29776 .endd
29777 .endlist
29778
29779 .vitem &*delay*&&~=&~<&'time'&>
29780 .cindex "&%delay%& ACL modifier"
29781 .oindex "&%-bh%&"
29782 This modifier may appear in any ACL except notquit. It causes Exim to wait for
29783 the time interval before proceeding. However, when testing Exim using the
29784 &%-bh%& option, the delay is not actually imposed (an appropriate message is
29785 output instead). The time is given in the usual Exim notation, and the delay
29786 happens as soon as the modifier is processed. In an SMTP session, pending
29787 output is flushed before the delay is imposed.
29788
29789 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
29790 example:
29791 .code
29792 deny    ...some conditions...
29793         delay = 30s
29794 .endd
29795 The delay happens if all the conditions are true, before the statement returns
29796 &"deny"&. Compare this with:
29797 .code
29798 deny    delay = 30s
29799         ...some conditions...
29800 .endd
29801 which waits for 30s before processing the conditions. The &%delay%& modifier
29802 can also be used with &%warn%& and together with &%control%&:
29803 .code
29804 warn    ...some conditions...
29805         delay = 2m
29806         control = freeze
29807 accept  ...
29808 .endd
29809
29810 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
29811 responses to several commands are no longer buffered and sent in one packet (as
29812 they would normally be) because all output is flushed before imposing the
29813 delay. This optimization is disabled so that a number of small delays do not
29814 appear to the client as one large aggregated delay that might provoke an
29815 unwanted timeout. You can, however, disable output flushing for &%delay%& by
29816 using a &%control%& modifier to set &%no_delay_flush%&.
29817
29818
29819 .vitem &*endpass*&
29820 .cindex "&%endpass%& ACL modifier"
29821 This modifier, which has no argument, is recognized only in &%accept%& and
29822 &%discard%& statements. It marks the boundary between the conditions whose
29823 failure causes control to pass to the next statement, and the conditions whose
29824 failure causes the ACL to return &"deny"&. This concept has proved to be
29825 confusing to some people, so the use of &%endpass%& is no longer recommended as
29826 &"best practice"&. See the description of &%accept%& above for more details.
29827
29828
29829 .vitem &*log_message*&&~=&~<&'text'&>
29830 .cindex "&%log_message%& ACL modifier"
29831 This modifier sets up a message that is used as part of the log message if the
29832 ACL denies access or a &%warn%& statement's conditions are true. For example:
29833 .code
29834 require log_message = wrong cipher suite $tls_in_cipher
29835         encrypted   = DES-CBC3-SHA
29836 .endd
29837 &%log_message%& is also used when recipients are discarded by &%discard%&. For
29838 example:
29839 .display
29840 &`discard `&<&'some conditions'&>
29841 &`        log_message = Discarded $local_part@$domain because...`&
29842 .endd
29843 When access is denied, &%log_message%& adds to any underlying error message
29844 that may exist because of a condition failure. For example, while verifying a
29845 recipient address, a &':fail:'& redirection might have already set up a
29846 message.
29847
29848 The message may be defined before the conditions to which it applies, because
29849 the string expansion does not happen until Exim decides that access is to be
29850 denied. This means that any variables that are set by the condition are
29851 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
29852 variables are set after a DNS black list lookup succeeds. If the expansion of
29853 &%log_message%& fails, or if the result is an empty string, the modifier is
29854 ignored.
29855
29856 .vindex "&$acl_verify_message$&"
29857 If you want to use a &%warn%& statement to log the result of an address
29858 verification, you can use &$acl_verify_message$& to include the verification
29859 error message.
29860
29861 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
29862 the start of the logged message. If the same warning log message is requested
29863 more than once while receiving  a single email message, only one copy is
29864 actually logged. If you want to log multiple copies, use &%logwrite%& instead
29865 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
29866 is logged for a successful &%warn%& statement.
29867
29868 If &%log_message%& is not present and there is no underlying error message (for
29869 example, from the failure of address verification), but &%message%& is present,
29870 the &%message%& text is used for logging rejections. However, if any text for
29871 logging contains newlines, only the first line is logged. In the absence of
29872 both &%log_message%& and &%message%&, a default built-in message is used for
29873 logging rejections.
29874
29875
29876 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
29877 .cindex "&%log_reject_target%& ACL modifier"
29878 .cindex "logging in ACL" "specifying which log"
29879 This modifier makes it possible to specify which logs are used for messages
29880 about ACL rejections. Its argument is a colon-separated list of words that can
29881 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
29882 may be empty, in which case a rejection is not logged at all. For example, this
29883 ACL fragment writes no logging information when access is denied:
29884 .display
29885 &`deny `&<&'some conditions'&>
29886 &`     log_reject_target =`&
29887 .endd
29888 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
29889 permanent and temporary rejections. Its effect lasts for the rest of the
29890 current ACL.
29891
29892
29893 .vitem &*logwrite*&&~=&~<&'text'&>
29894 .cindex "&%logwrite%& ACL modifier"
29895 .cindex "logging in ACL" "immediate"
29896 This modifier writes a message to a log file as soon as it is encountered when
29897 processing an ACL. (Compare &%log_message%&, which, except in the case of
29898 &%warn%& and &%discard%&, is used only if the ACL statement denies
29899 access.) The &%logwrite%& modifier can be used to log special incidents in
29900 ACLs. For example:
29901 .display
29902 &`accept `&<&'some special conditions'&>
29903 &`       control  = freeze`&
29904 &`       logwrite = froze message because ...`&
29905 .endd
29906 By default, the message is written to the main log. However, it may begin
29907 with a colon, followed by a comma-separated list of log names, and then
29908 another colon, to specify exactly which logs are to be written. For
29909 example:
29910 .code
29911 logwrite = :main,reject: text for main and reject logs
29912 logwrite = :panic: text for panic log only
29913 .endd
29914
29915
29916 .vitem &*message*&&~=&~<&'text'&>
29917 .cindex "&%message%& ACL modifier"
29918 This modifier sets up a text string that is expanded and used as a response
29919 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
29920 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
29921 there is some complication if &%endpass%& is involved; see the description of
29922 &%accept%& for details.)
29923
29924 The expansion of the message happens at the time Exim decides that the ACL is
29925 to end, not at the time it processes &%message%&. If the expansion fails, or
29926 generates an empty string, the modifier is ignored. Here is an example where
29927 &%message%& must be specified first, because the ACL ends with a rejection if
29928 the &%hosts%& condition fails:
29929 .code
29930 require  message = Host not recognized
29931          hosts = 10.0.0.0/8
29932 .endd
29933 (Once a condition has failed, no further conditions or modifiers are
29934 processed.)
29935
29936 .cindex "SMTP" "error codes"
29937 .oindex "&%smtp_banner%&
29938 For ACLs that are triggered by SMTP commands, the message is returned as part
29939 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
29940 is meaningful only for SMTP, as no message is returned when a non-SMTP message
29941 is accepted. In the case of the connect ACL, accepting with a message modifier
29942 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
29943 accept message may not contain more than one line (otherwise it will be
29944 truncated at the first newline and a panic logged), and it cannot affect the
29945 EHLO options.
29946
29947 When SMTP is involved, the message may begin with an overriding response code,
29948 consisting of three digits optionally followed by an &"extended response code"&
29949 of the form &'n.n.n'&, each code being followed by a space. For example:
29950 .code
29951 deny  message = 599 1.2.3 Host not welcome
29952       hosts = 192.168.34.0/24
29953 .endd
29954 The first digit of the supplied response code must be the same as would be sent
29955 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
29956 access, but for the predata ACL, note that the default success code is 354, not
29957 2&'xx'&.
29958
29959 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
29960 the message modifier cannot override the 221 response code.
29961
29962 The text in a &%message%& modifier is literal; any quotes are taken as
29963 literals, but because the string is expanded, backslash escapes are processed
29964 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
29965 response.
29966
29967 .vindex "&$acl_verify_message$&"
29968 For ACLs that are called by an &%acl =%& ACL condition, the message is
29969 stored in &$acl_verify_message$&, from which the calling ACL may use it.
29970
29971 If &%message%& is used on a statement that verifies an address, the message
29972 specified overrides any message that is generated by the verification process.
29973 However, the original message is available in the variable
29974 &$acl_verify_message$&, so you can incorporate it into your message if you
29975 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
29976 routers to be passed back as part of the SMTP response, you should either not
29977 use a &%message%& modifier, or make use of &$acl_verify_message$&.
29978
29979 For compatibility with previous releases of Exim, a &%message%& modifier that
29980 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
29981 modifier, but this usage is now deprecated. However, &%message%& acts only when
29982 all the conditions are true, wherever it appears in an ACL command, whereas
29983 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
29984 &%warn%& in an ACL that is not concerned with receiving a message, it has no
29985 effect.
29986
29987
29988 .vitem &*queue*&&~=&~<&'text'&>
29989 .cindex "&%queue%& ACL modifier"
29990 .cindex "named queues" "selecting in ACL"
29991 This modifier specifies the use of a named queue for spool files
29992 for the message.
29993 It can only be used before the message is received (i.e. not in
29994 the DATA ACL).
29995 This could be used, for example, for known high-volume burst sources
29996 of traffic, or for quarantine of messages.
29997 Separate queue-runner processes will be needed for named queues.
29998 If the text after expansion is empty, the default queue is used.
29999
30000
30001 .vitem &*remove_header*&&~=&~<&'text'&>
30002 This modifier specifies one or more header names in a colon-separated list
30003  that are to be removed from an incoming message, assuming, of course, that
30004 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30005
30006
30007 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30008 .cindex "&%set%& ACL modifier"
30009 This modifier puts a value into one of the ACL variables (see section
30010 &<<SECTaclvariables>>&).
30011
30012
30013 .vitem &*udpsend*&&~=&~<&'parameters'&>
30014 .cindex "UDP communications"
30015 This modifier sends a UDP packet, for purposes such as statistics
30016 collection or behaviour monitoring. The parameters are expanded, and
30017 the result of the expansion must be a colon-separated list consisting
30018 of a destination server, port number, and the packet contents. The
30019 server can be specified as a host name or IPv4 or IPv6 address. The
30020 separator can be changed with the usual angle bracket syntax. For
30021 example, you might want to collect information on which hosts connect
30022 when:
30023 .code
30024 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30025              $tod_zulu $sender_host_address
30026 .endd
30027 .endlist
30028
30029
30030
30031
30032 .section "Use of the control modifier" "SECTcontrols"
30033 .cindex "&%control%& ACL modifier"
30034 The &%control%& modifier supports the following settings:
30035
30036 .vlist
30037 .vitem &*control&~=&~allow_auth_unadvertised*&
30038 This modifier allows a client host to use the SMTP AUTH command even when it
30039 has not been advertised in response to EHLO. Furthermore, because there are
30040 apparently some really broken clients that do this, Exim will accept AUTH after
30041 HELO (rather than EHLO) when this control is set. It should be used only if you
30042 really need it, and you should limit its use to those broken clients that do
30043 not work without it. For example:
30044 .code
30045 warn hosts   = 192.168.34.25
30046      control = allow_auth_unadvertised
30047 .endd
30048 Normally, when an Exim server receives an AUTH command, it checks the name of
30049 the authentication mechanism that is given in the command to ensure that it
30050 matches an advertised mechanism. When this control is set, the check that a
30051 mechanism has been advertised is bypassed. Any configured mechanism can be used
30052 by the client. This control is permitted only in the connection and HELO ACLs.
30053
30054
30055 .vitem &*control&~=&~caseful_local_part*& &&&
30056        &*control&~=&~caselower_local_part*&
30057 .cindex "&ACL;" "case of local part in"
30058 .cindex "case of local parts"
30059 .vindex "&$local_part$&"
30060 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30061 (that is, during RCPT processing). By default, the contents of &$local_part$&
30062 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30063 any uppercase letters in the original local part are restored in &$local_part$&
30064 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30065 is encountered.
30066
30067 These controls affect only the current recipient. Moreover, they apply only to
30068 local part handling that takes place directly in the ACL (for example, as a key
30069 in lookups). If a test to verify the recipient is obeyed, the case-related
30070 handling of the local part during the verification is controlled by the router
30071 configuration (see the &%caseful_local_part%& generic router option).
30072
30073 This facility could be used, for example, to add a spam score to local parts
30074 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30075 spam score:
30076 .code
30077 warn  control = caseful_local_part
30078       set acl_m4 = ${eval:\
30079                      $acl_m4 + \
30080                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30081                     }
30082       control = caselower_local_part
30083 .endd
30084 Notice that we put back the lower cased version afterwards, assuming that
30085 is what is wanted for subsequent tests.
30086
30087
30088 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30089 .cindex "&ACL;" "cutthrough routing"
30090 .cindex "cutthrough" "requesting"
30091 This option requests delivery be attempted while the item is being received.
30092
30093 The option is usable in the RCPT ACL.
30094 If enabled for a message received via smtp and routed to an smtp transport,
30095 and only one transport, interface, destination host and port combination
30096 is used for all recipients of the message,
30097 then the delivery connection is made while the receiving connection is open
30098 and data is copied from one to the other.
30099
30100 An attempt to set this option for any recipient but the first
30101 for a mail will be quietly ignored.
30102 If a recipient-verify callout
30103 (with use_sender)
30104 connection is subsequently
30105 requested in the same ACL it is held open and used for
30106 any subsequent recipients and the data,
30107 otherwise one is made after the initial RCPT ACL completes.
30108
30109 Note that routers are used in verify mode,
30110 and cannot depend on content of received headers.
30111 Note also that headers cannot be
30112 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30113 Headers may be modified by routers (subject to the above) and transports.
30114 The &'Received-By:'& header is generated as soon as the body reception starts,
30115 rather than the traditional time after the full message is received;
30116 this will affect the timestamp.
30117
30118 All the usual ACLs are called; if one results in the message being
30119 rejected, all effort spent in delivery (including the costs on
30120 the ultimate destination) will be wasted.
30121 Note that in the case of data-time ACLs this includes the entire
30122 message body.
30123
30124 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30125 of outgoing messages is done, because it sends data to the ultimate destination
30126 before the entire message has been received from the source.
30127 It is not supported for messages received with the SMTP PRDR
30128 or CHUNKING
30129 options in use.
30130
30131 Should the ultimate destination system positively accept or reject the mail,
30132 a corresponding indication is given to the source system and nothing is queued.
30133 If the item is successfully delivered in cutthrough mode
30134 the delivery log lines are tagged with ">>" rather than "=>" and appear
30135 before the acceptance "<=" line.
30136
30137 If there is a temporary error the item is queued for later delivery in the
30138 usual fashion.
30139 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30140 to the control; the default value is &"spool"& and the alternate value
30141 &"pass"& copies an SMTP defer response from the target back to the initiator
30142 and does not queue the message.
30143 Note that this is independent of any recipient verify conditions in the ACL.
30144
30145 Delivery in this mode avoids the generation of a bounce mail to a
30146 (possibly faked)
30147 sender when the destination system is doing content-scan based rejection.
30148
30149
30150 .vitem &*control&~=&~debug/*&<&'options'&>
30151 .cindex "&ACL;" "enabling debug logging"
30152 .cindex "debugging" "enabling from an ACL"
30153 This control turns on debug logging, almost as though Exim had been invoked
30154 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30155 by default called &'debuglog'&.
30156 The filename can be adjusted with the &'tag'& option, which
30157 may access any variables already defined.  The logging may be adjusted with
30158 the &'opts'& option, which takes the same values as the &`-d`& command-line
30159 option.
30160 Logging started this way may be stopped, and the file removed,
30161 with the &'kill'& option.
30162 Some examples (which depend on variables that don't exist in all
30163 contexts):
30164 .code
30165       control = debug
30166       control = debug/tag=.$sender_host_address
30167       control = debug/opts=+expand+acl
30168       control = debug/tag=.$message_exim_id/opts=+expand
30169       control = debug/kill
30170 .endd
30171
30172
30173 .vitem &*control&~=&~dkim_disable_verify*&
30174 .cindex "disable DKIM verify"
30175 .cindex "DKIM" "disable verify"
30176 This control turns off DKIM verification processing entirely.  For details on
30177 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30178
30179
30180 .vitem &*control&~=&~dscp/*&<&'value'&>
30181 .cindex "&ACL;" "setting DSCP value"
30182 .cindex "DSCP" "inbound"
30183 This option causes the DSCP value associated with the socket for the inbound
30184 connection to be adjusted to a given value, given as one of a number of fixed
30185 strings or to numeric value.
30186 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30187 Common values include &`throughput`&, &`mincost`&, and on newer systems
30188 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30189
30190 The outbound packets from Exim will be marked with this value in the header
30191 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30192 that these values will have any effect, not be stripped by networking
30193 equipment, or do much of anything without cooperation with your Network
30194 Engineer and those of all network operators between the source and destination.
30195
30196
30197 .vitem &*control&~=&~enforce_sync*& &&&
30198        &*control&~=&~no_enforce_sync*&
30199 .cindex "SMTP" "synchronization checking"
30200 .cindex "synchronization checking in SMTP"
30201 These controls make it possible to be selective about when SMTP synchronization
30202 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30203 state of the switch (it is true by default). See the description of this option
30204 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30205
30206 The effect of these two controls lasts for the remainder of the SMTP
30207 connection. They can appear in any ACL except the one for the non-SMTP
30208 messages. The most straightforward place to put them is in the ACL defined by
30209 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30210 before the first synchronization check. The expected use is to turn off the
30211 synchronization checks for badly-behaved hosts that you nevertheless need to
30212 work with.
30213
30214
30215 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30216 .cindex "fake defer"
30217 .cindex "defer, fake"
30218 This control works in exactly the same way as &%fakereject%& (described below)
30219 except that it causes an SMTP 450 response after the message data instead of a
30220 550 response. You must take care when using &%fakedefer%& because it causes the
30221 messages to be duplicated when the sender retries. Therefore, you should not
30222 use &%fakedefer%& if the message is to be delivered normally.
30223
30224 .vitem &*control&~=&~fakereject/*&<&'message'&>
30225 .cindex "fake rejection"
30226 .cindex "rejection, fake"
30227 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30228 words, only when an SMTP message is being received. If Exim accepts the
30229 message, instead the final 250 response, a 550 rejection message is sent.
30230 However, Exim proceeds to deliver the message as normal. The control applies
30231 only to the current message, not to any subsequent ones that may be received in
30232 the same SMTP connection.
30233
30234 The text for the 550 response is taken from the &%control%& modifier. If no
30235 message is supplied, the following is used:
30236 .code
30237 550-Your message has been rejected but is being
30238 550-kept for evaluation.
30239 550-If it was a legitimate message, it may still be
30240 550 delivered to the target recipient(s).
30241 .endd
30242 This facility should be used with extreme caution.
30243
30244 .vitem &*control&~=&~freeze*&
30245 .cindex "frozen messages" "forcing in ACL"
30246 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30247 other words, only when a message is being received. If the message is accepted,
30248 it is placed on Exim's queue and frozen. The control applies only to the
30249 current message, not to any subsequent ones that may be received in the same
30250 SMTP connection.
30251
30252 This modifier can optionally be followed by &`/no_tell`&. If the global option
30253 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30254 is told about the freezing), provided all the &*control=freeze*& modifiers that
30255 are obeyed for the current message have the &`/no_tell`& option.
30256
30257 .vitem &*control&~=&~no_delay_flush*&
30258 .cindex "SMTP" "output flushing, disabling for delay"
30259 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30260 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30261 use. This control, as long as it is encountered before the &%delay%& modifier,
30262 disables such output flushing.
30263
30264 .vitem &*control&~=&~no_callout_flush*&
30265 .cindex "SMTP" "output flushing, disabling for callout"
30266 Exim normally flushes SMTP output before performing a callout in an ACL, to
30267 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30268 use. This control, as long as it is encountered before the &%verify%& condition
30269 that causes the callout, disables such output flushing.
30270
30271 .vitem &*control&~=&~no_mbox_unspool*&
30272 This control is available when Exim is compiled with the content scanning
30273 extension. Content scanning may require a copy of the current message, or parts
30274 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30275 or spam scanner. Normally, such copies are deleted when they are no longer
30276 needed. If this control is set, the copies are not deleted. The control applies
30277 only to the current message, not to any subsequent ones that may be received in
30278 the same SMTP connection. It is provided for debugging purposes and is unlikely
30279 to be useful in production.
30280
30281 .vitem &*control&~=&~no_multiline_responses*&
30282 .cindex "multiline responses, suppressing"
30283 This control is permitted for any ACL except the one for non-SMTP messages.
30284 It seems that there are broken clients in use that cannot handle multiline
30285 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30286
30287 If this control is set, multiline SMTP responses from ACL rejections are
30288 suppressed. One way of doing this would have been to put out these responses as
30289 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30290 (&"use multiline responses for more"& it says &-- ha!), and some of the
30291 responses might get close to that. So this facility, which is after all only a
30292 sop to broken clients, is implemented by doing two very easy things:
30293
30294 .ilist
30295 Extra information that is normally output as part of a rejection caused by
30296 sender verification failure is omitted. Only the final line (typically &"sender
30297 verification failed"&) is sent.
30298 .next
30299 If a &%message%& modifier supplies a multiline response, only the first
30300 line is output.
30301 .endlist
30302
30303 The setting of the switch can, of course, be made conditional on the
30304 calling host. Its effect lasts until the end of the SMTP connection.
30305
30306 .vitem &*control&~=&~no_pipelining*&
30307 .cindex "PIPELINING" "suppressing advertising"
30308 This control turns off the advertising of the PIPELINING extension to SMTP in
30309 the current session. To be useful, it must be obeyed before Exim sends its
30310 response to an EHLO command. Therefore, it should normally appear in an ACL
30311 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30312 &%pipelining_advertise_hosts%&.
30313
30314 .vitem &*control&~=&~queue_only*&
30315 .oindex "&%queue_only%&"
30316 .cindex "queueing incoming messages"
30317 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30318 other words, only when a message is being received. If the message is accepted,
30319 it is placed on Exim's queue and left there for delivery by a subsequent queue
30320 runner. No immediate delivery process is started. In other words, it has the
30321 effect as the &%queue_only%& global option. However, the control applies only
30322 to the current message, not to any subsequent ones that may be received in the
30323 same SMTP connection.
30324
30325 .vitem &*control&~=&~submission/*&<&'options'&>
30326 .cindex "message" "submission"
30327 .cindex "submission mode"
30328 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30329 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30330 the current message is a submission from a local MUA. In this case, Exim
30331 operates in &"submission mode"&, and applies certain fixups to the message if
30332 necessary. For example, it adds a &'Date:'& header line if one is not present.
30333 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30334 late (the message has already been created).
30335
30336 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30337 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30338 submission mode; the available options for this control are described there.
30339 The control applies only to the current message, not to any subsequent ones
30340 that may be received in the same SMTP connection.
30341
30342 .vitem &*control&~=&~suppress_local_fixups*&
30343 .cindex "submission fixups, suppressing"
30344 This control applies to locally submitted (non TCP/IP) messages, and is the
30345 complement of &`control = submission`&. It disables the fixups that are
30346 normally applied to locally-submitted messages. Specifically:
30347
30348 .ilist
30349 Any &'Sender:'& header line is left alone (in this respect, it is a
30350 dynamic version of &%local_sender_retain%&).
30351 .next
30352 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30353 .next
30354 There is no check that &'From:'& corresponds to the actual sender.
30355 .endlist ilist
30356
30357 This control may be useful when a remotely-originated message is accepted,
30358 passed to some scanning program, and then re-submitted for delivery. It can be
30359 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30360 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30361 data is read.
30362
30363 &*Note:*& This control applies only to the current message, not to any others
30364 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30365
30366 .vitem &*control&~=&~utf8_downconvert*&
30367 This control enables conversion of UTF-8 in message addresses
30368 to a-label form.
30369 For details see section &<<SECTi18nMTA>>&.
30370 .endlist vlist
30371
30372
30373 .section "Summary of message fixup control" "SECTsummesfix"
30374 All four possibilities for message fixups can be specified:
30375
30376 .ilist
30377 Locally submitted, fixups applied: the default.
30378 .next
30379 Locally submitted, no fixups applied: use
30380 &`control = suppress_local_fixups`&.
30381 .next
30382 Remotely submitted, no fixups applied: the default.
30383 .next
30384 Remotely submitted, fixups applied: use &`control = submission`&.
30385 .endlist
30386
30387
30388
30389 .section "Adding header lines in ACLs" "SECTaddheadacl"
30390 .cindex "header lines" "adding in an ACL"
30391 .cindex "header lines" "position of added lines"
30392 .cindex "&%add_header%& ACL modifier"
30393 The &%add_header%& modifier can be used to add one or more extra header lines
30394 to an incoming message, as in this example:
30395 .code
30396 warn dnslists = sbl.spamhaus.org : \
30397                 dialup.mail-abuse.org
30398      add_header = X-blacklisted-at: $dnslist_domain
30399 .endd
30400 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30401 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30402 receiving a message). The message must ultimately be accepted for
30403 &%add_header%& to have any significant effect. You can use &%add_header%& with
30404 any ACL verb, including &%deny%& (though this is potentially useful only in a
30405 RCPT ACL).
30406
30407 Headers will not be added to the message if the modifier is used in
30408 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30409
30410 Leading and trailing newlines are removed from
30411 the data for the &%add_header%& modifier; if it then
30412 contains one or more newlines that
30413 are not followed by a space or a tab, it is assumed to contain multiple header
30414 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30415 front of any line that is not a valid header line.
30416
30417 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30418 They are added to the message before processing the DATA and MIME ACLs.
30419 However, if an identical header line is requested more than once, only one copy
30420 is actually added to the message. Further header lines may be accumulated
30421 during the DATA and MIME ACLs, after which they are added to the message, again
30422 with duplicates suppressed. Thus, it is possible to add two identical header
30423 lines to an SMTP message, but only if one is added before DATA and one after.
30424 In the case of non-SMTP messages, new headers are accumulated during the
30425 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30426 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30427 are included in the entry that is written to the reject log.
30428
30429 .cindex "header lines" "added; visibility of"
30430 Header lines are not visible in string expansions
30431 of message headers
30432 until they are added to the
30433 message. It follows that header lines defined in the MAIL, RCPT, and predata
30434 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30435 header lines that are added by the DATA or MIME ACLs are not visible in those
30436 ACLs. Because of this restriction, you cannot use header lines as a way of
30437 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30438 this, you can use ACL variables, as described in section
30439 &<<SECTaclvariables>>&.
30440
30441 The list of headers yet to be added is given by the &%$headers_added%& variable.
30442
30443 The &%add_header%& modifier acts immediately as it is encountered during the
30444 processing of an ACL. Notice the difference between these two cases:
30445 .display
30446 &`accept add_header = ADDED: some text`&
30447 &`       `&<&'some condition'&>
30448
30449 &`accept `&<&'some condition'&>
30450 &`       add_header = ADDED: some text`&
30451 .endd
30452 In the first case, the header line is always added, whether or not the
30453 condition is true. In the second case, the header line is added only if the
30454 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30455 ACL statement. All those that are encountered before a condition fails are
30456 honoured.
30457
30458 .cindex "&%warn%& ACL verb"
30459 For compatibility with previous versions of Exim, a &%message%& modifier for a
30460 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30461 effect only if all the conditions are true, even if it appears before some of
30462 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30463 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30464 are present on a &%warn%& verb, both are processed according to their
30465 specifications.
30466
30467 By default, new header lines are added to a message at the end of the existing
30468 header lines. However, you can specify that any particular header line should
30469 be added right at the start (before all the &'Received:'& lines), immediately
30470 after the first block of &'Received:'& lines, or immediately before any line
30471 that is not a &'Received:'& or &'Resent-something:'& header.
30472
30473 This is done by specifying &":at_start:"&, &":after_received:"&, or
30474 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30475 header line, respectively. (Header text cannot start with a colon, as there has
30476 to be a header name first.) For example:
30477 .code
30478 warn add_header = \
30479        :after_received:X-My-Header: something or other...
30480 .endd
30481 If more than one header line is supplied in a single &%add_header%& modifier,
30482 each one is treated independently and can therefore be placed differently. If
30483 you add more than one line at the start, or after the Received: block, they end
30484 up in reverse order.
30485
30486 &*Warning*&: This facility currently applies only to header lines that are
30487 added in an ACL. It does NOT work for header lines that are added in a
30488 system filter or in a router or transport.
30489
30490
30491
30492 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30493 .cindex "header lines" "removing in an ACL"
30494 .cindex "header lines" "position of removed lines"
30495 .cindex "&%remove_header%& ACL modifier"
30496 The &%remove_header%& modifier can be used to remove one or more header lines
30497 from an incoming message, as in this example:
30498 .code
30499 warn   message        = Remove internal headers
30500        remove_header  = x-route-mail1 : x-route-mail2
30501 .endd
30502 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30503 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30504 receiving a message). The message must ultimately be accepted for
30505 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30506 with any ACL verb, including &%deny%&, though this is really not useful for
30507 any verb that doesn't result in a delivered message.
30508
30509 Headers will not be removed from the message if the modifier is used in
30510 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30511
30512 More than one header can be removed at the same time by using a colon separated
30513 list of header names. The header matching is case insensitive. Wildcards are
30514 not permitted, nor is list expansion performed, so you cannot use hostlists to
30515 create a list of headers, however both connection and message variable expansion
30516 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30517 .code
30518 warn   hosts           = +internal_hosts
30519        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30520 warn   message         = Remove internal headers
30521        remove_header   = $acl_c_ihdrs
30522 .endd
30523 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30524 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30525 If multiple header lines match, all are removed.
30526 There is no harm in attempting to remove the same header twice nor in removing
30527 a non-existent header. Further header lines to be removed may be accumulated
30528 during the DATA and MIME ACLs, after which they are removed from the message,
30529 if present. In the case of non-SMTP messages, headers to be removed are
30530 accumulated during the non-SMTP ACLs, and are removed from the message after
30531 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30532 ACL, there really is no effect because there is no logging of what headers
30533 would have been removed.
30534
30535 .cindex "header lines" "removed; visibility of"
30536 Header lines are not visible in string expansions until the DATA phase when it
30537 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30538 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30539 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30540 this restriction, you cannot use header lines as a way of controlling data
30541 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30542 you should instead use ACL variables, as described in section
30543 &<<SECTaclvariables>>&.
30544
30545 The &%remove_header%& modifier acts immediately as it is encountered during the
30546 processing of an ACL. Notice the difference between these two cases:
30547 .display
30548 &`accept remove_header = X-Internal`&
30549 &`       `&<&'some condition'&>
30550
30551 &`accept `&<&'some condition'&>
30552 &`       remove_header = X-Internal`&
30553 .endd
30554 In the first case, the header line is always removed, whether or not the
30555 condition is true. In the second case, the header line is removed only if the
30556 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30557 same ACL statement. All those that are encountered before a condition fails
30558 are honoured.
30559
30560 &*Warning*&: This facility currently applies only to header lines that are
30561 present during ACL processing. It does NOT remove header lines that are added
30562 in a system filter or in a router or transport.
30563
30564
30565
30566
30567 .section "ACL conditions" "SECTaclconditions"
30568 .cindex "&ACL;" "conditions; list of"
30569 Some of the conditions listed in this section are available only when Exim is
30570 compiled with the content-scanning extension. They are included here briefly
30571 for completeness. More detailed descriptions can be found in the discussion on
30572 content scanning in chapter &<<CHAPexiscan>>&.
30573
30574 Not all conditions are relevant in all circumstances. For example, testing
30575 senders and recipients does not make sense in an ACL that is being run as the
30576 result of the arrival of an ETRN command, and checks on message headers can be
30577 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30578 can use the same condition (with different parameters) more than once in the
30579 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30580 The conditions are as follows:
30581
30582
30583 .vlist
30584 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30585 .cindex "&ACL;" "nested"
30586 .cindex "&ACL;" "indirect"
30587 .cindex "&ACL;" "arguments"
30588 .cindex "&%acl%& ACL condition"
30589 The possible values of the argument are the same as for the
30590 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30591 &"accept"& the condition is true; if it returns &"deny"& the condition is
30592 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30593 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30594 condition false. This means that further processing of the &%warn%& verb
30595 ceases, but processing of the ACL continues.
30596
30597 If the argument is a named ACL, up to nine space-separated optional values
30598 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30599 and $acl_narg is set to the count of values.
30600 Previous values of these variables are restored after the call returns.
30601 The name and values are expanded separately.
30602 Note that spaces in complex expansions which are used as arguments
30603 will act as argument separators.
30604
30605 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30606 the connection is dropped. If it returns &"discard"&, the verb must be
30607 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30608 conditions are tested.
30609
30610 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30611 loops. This condition allows you to use different ACLs in different
30612 circumstances. For example, different ACLs can be used to handle RCPT commands
30613 for different local users or different local domains.
30614
30615 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30616 .cindex "&%authenticated%& ACL condition"
30617 .cindex "authentication" "ACL checking"
30618 .cindex "&ACL;" "testing for authentication"
30619 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30620 the name of the authenticator is tested against the list. To test for
30621 authentication by any authenticator, you can set
30622 .code
30623 authenticated = *
30624 .endd
30625
30626 .vitem &*condition&~=&~*&<&'string'&>
30627 .cindex "&%condition%& ACL condition"
30628 .cindex "customizing" "ACL condition"
30629 .cindex "&ACL;" "customized test"
30630 .cindex "&ACL;" "testing, customized"
30631 This feature allows you to make up custom conditions. If the result of
30632 expanding the string is an empty string, the number zero, or one of the strings
30633 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30634 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30635 any other value, some error is assumed to have occurred, and the ACL returns
30636 &"defer"&. However, if the expansion is forced to fail, the condition is
30637 ignored. The effect is to treat it as true, whether it is positive or
30638 negative.
30639
30640 .vitem &*decode&~=&~*&<&'location'&>
30641 .cindex "&%decode%& ACL condition"
30642 This condition is available only when Exim is compiled with the
30643 content-scanning extension, and it is allowed only in the ACL defined by
30644 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30645 If all goes well, the condition is true. It is false only if there are
30646 problems such as a syntax error or a memory shortage. For more details, see
30647 chapter &<<CHAPexiscan>>&.
30648
30649 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30650 .cindex "&%dnslists%& ACL condition"
30651 .cindex "DNS list" "in ACL"
30652 .cindex "black list (DNS)"
30653 .cindex "&ACL;" "testing a DNS list"
30654 This condition checks for entries in DNS black lists. These are also known as
30655 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30656 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30657 different variants of this condition to describe briefly here. See sections
30658 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30659
30660 .vitem &*domains&~=&~*&<&'domain&~list'&>
30661 .cindex "&%domains%& ACL condition"
30662 .cindex "domain" "ACL checking"
30663 .cindex "&ACL;" "testing a recipient domain"
30664 .vindex "&$domain_data$&"
30665 This condition is relevant only after a RCPT command. It checks that the domain
30666 of the recipient address is in the domain list. If percent-hack processing is
30667 enabled, it is done before this test is done. If the check succeeds with a
30668 lookup, the result of the lookup is placed in &$domain_data$& until the next
30669 &%domains%& test.
30670
30671 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30672 use &%domains%& in a DATA ACL.
30673
30674
30675 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30676 .cindex "&%encrypted%& ACL condition"
30677 .cindex "encryption" "checking in an ACL"
30678 .cindex "&ACL;" "testing for encryption"
30679 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30680 name of the cipher suite in use is tested against the list. To test for
30681 encryption without testing for any specific cipher suite(s), set
30682 .code
30683 encrypted = *
30684 .endd
30685
30686
30687 .vitem &*hosts&~=&~*&<&'host&~list'&>
30688 .cindex "&%hosts%& ACL condition"
30689 .cindex "host" "ACL checking"
30690 .cindex "&ACL;" "testing the client host"
30691 This condition tests that the calling host matches the host list. If you have
30692 name lookups or wildcarded host names and IP addresses in the same host list,
30693 you should normally put the IP addresses first. For example, you could have:
30694 .code
30695 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30696 .endd
30697 The lookup in this example uses the host name for its key. This is implied by
30698 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30699 and it wouldn't matter which way round you had these two items.)
30700
30701 The reason for the problem with host names lies in the left-to-right way that
30702 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30703 but when it reaches an item that requires a host name, it fails if it cannot
30704 find a host name to compare with the pattern. If the above list is given in the
30705 opposite order, the &%accept%& statement fails for a host whose name cannot be
30706 found, even if its IP address is 10.9.8.7.
30707
30708 If you really do want to do the name check first, and still recognize the IP
30709 address even if the name lookup fails, you can rewrite the ACL like this:
30710 .code
30711 accept hosts = dbm;/etc/friendly/hosts
30712 accept hosts = 10.9.8.7
30713 .endd
30714 The default action on failing to find the host name is to assume that the host
30715 is not in the list, so the first &%accept%& statement fails. The second
30716 statement can then check the IP address.
30717
30718 .vindex "&$host_data$&"
30719 If a &%hosts%& condition is satisfied by means of a lookup, the result
30720 of the lookup is made available in the &$host_data$& variable. This
30721 allows you, for example, to set up a statement like this:
30722 .code
30723 deny  hosts = net-lsearch;/some/file
30724 message = $host_data
30725 .endd
30726 which gives a custom error message for each denied host.
30727
30728 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30729 .cindex "&%local_parts%& ACL condition"
30730 .cindex "local part" "ACL checking"
30731 .cindex "&ACL;" "testing a local part"
30732 .vindex "&$local_part_data$&"
30733 This condition is relevant only after a RCPT command. It checks that the local
30734 part of the recipient address is in the list. If percent-hack processing is
30735 enabled, it is done before this test. If the check succeeds with a lookup, the
30736 result of the lookup is placed in &$local_part_data$&, which remains set until
30737 the next &%local_parts%& test.
30738
30739 .vitem &*malware&~=&~*&<&'option'&>
30740 .cindex "&%malware%& ACL condition"
30741 .cindex "&ACL;" "virus scanning"
30742 .cindex "&ACL;" "scanning for viruses"
30743 This condition is available only when Exim is compiled with the
30744 content-scanning extension. It causes the incoming message to be scanned for
30745 viruses. For details, see chapter &<<CHAPexiscan>>&.
30746
30747 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30748 .cindex "&%mime_regex%& ACL condition"
30749 .cindex "&ACL;" "testing by regex matching"
30750 This condition is available only when Exim is compiled with the
30751 content-scanning extension, and it is allowed only in the ACL defined by
30752 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30753 with any of the regular expressions. For details, see chapter
30754 &<<CHAPexiscan>>&.
30755
30756 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30757 .cindex "rate limiting"
30758 This condition can be used to limit the rate at which a user or host submits
30759 messages. Details are given in section &<<SECTratelimiting>>&.
30760
30761 .vitem &*recipients&~=&~*&<&'address&~list'&>
30762 .cindex "&%recipients%& ACL condition"
30763 .cindex "recipient" "ACL checking"
30764 .cindex "&ACL;" "testing a recipient"
30765 This condition is relevant only after a RCPT command. It checks the entire
30766 recipient address against a list of recipients.
30767
30768 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30769 .cindex "&%regex%& ACL condition"
30770 .cindex "&ACL;" "testing by regex matching"
30771 This condition is available only when Exim is compiled with the
30772 content-scanning extension, and is available only in the DATA, MIME, and
30773 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30774 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30775
30776 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
30777 .cindex "&%sender_domains%& ACL condition"
30778 .cindex "sender" "ACL checking"
30779 .cindex "&ACL;" "testing a sender domain"
30780 .vindex "&$domain$&"
30781 .vindex "&$sender_address_domain$&"
30782 This condition tests the domain of the sender of the message against the given
30783 domain list. &*Note*&: The domain of the sender address is in
30784 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
30785 of this condition. This is an exception to the general rule for testing domain
30786 lists. It is done this way so that, if this condition is used in an ACL for a
30787 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
30788 influence the sender checking.
30789
30790 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30791 relaying, because sender addresses are easily, and commonly, forged.
30792
30793 .vitem &*senders&~=&~*&<&'address&~list'&>
30794 .cindex "&%senders%& ACL condition"
30795 .cindex "sender" "ACL checking"
30796 .cindex "&ACL;" "testing a sender"
30797 This condition tests the sender of the message against the given list. To test
30798 for a bounce message, which has an empty sender, set
30799 .code
30800 senders = :
30801 .endd
30802 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30803 relaying, because sender addresses are easily, and commonly, forged.
30804
30805 .vitem &*spam&~=&~*&<&'username'&>
30806 .cindex "&%spam%& ACL condition"
30807 .cindex "&ACL;" "scanning for spam"
30808 This condition is available only when Exim is compiled with the
30809 content-scanning extension. It causes the incoming message to be scanned by
30810 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
30811
30812 .vitem &*verify&~=&~certificate*&
30813 .cindex "&%verify%& ACL condition"
30814 .cindex "TLS" "client certificate verification"
30815 .cindex "certificate" "verification of client"
30816 .cindex "&ACL;" "certificate verification"
30817 .cindex "&ACL;" "testing a TLS certificate"
30818 This condition is true in an SMTP session if the session is encrypted, and a
30819 certificate was received from the client, and the certificate was verified. The
30820 server requests a certificate only if the client matches &%tls_verify_hosts%&
30821 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
30822
30823 .vitem &*verify&~=&~csa*&
30824 .cindex "CSA verification"
30825 This condition checks whether the sending host (the client) is authorized to
30826 send email. Details of how this works are given in section
30827 &<<SECTverifyCSA>>&.
30828
30829 .vitem &*verify&~=&~header_names_ascii*&
30830 .cindex "&%verify%& ACL condition"
30831 .cindex "&ACL;" "verifying header names only ASCII"
30832 .cindex "header lines" "verifying header names only ASCII"
30833 .cindex "verifying" "header names only ASCII"
30834 This condition is relevant only in an ACL that is run after a message has been
30835 received, that is, in an ACL specified by &%acl_smtp_data%& or
30836 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
30837 there are no non-ASCII characters, also excluding control characters.  The
30838 allowable characters are decimal ASCII values 33 through 126.
30839
30840 Exim itself will handle headers with non-ASCII characters, but it can cause
30841 problems for downstream applications, so this option will allow their
30842 detection and rejection in the DATA ACL's.
30843
30844 .vitem &*verify&~=&~header_sender/*&<&'options'&>
30845 .cindex "&%verify%& ACL condition"
30846 .cindex "&ACL;" "verifying sender in the header"
30847 .cindex "header lines" "verifying the sender in"
30848 .cindex "sender" "verifying in header"
30849 .cindex "verifying" "sender in header"
30850 This condition is relevant only in an ACL that is run after a message has been
30851 received, that is, in an ACL specified by &%acl_smtp_data%& or
30852 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
30853 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
30854 is loosely thought of as a &"sender"& address (hence the name of the test).
30855 However, an address that appears in one of these headers need not be an address
30856 that accepts bounce messages; only sender addresses in envelopes are required
30857 to accept bounces. Therefore, if you use the callout option on this check, you
30858 might want to arrange for a non-empty address in the MAIL command.
30859
30860 Details of address verification and the options are given later, starting at
30861 section &<<SECTaddressverification>>& (callouts are described in section
30862 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
30863 condition to restrict it to bounce messages only:
30864 .code
30865 deny    senders = :
30866         message = A valid sender header is required for bounces
30867        !verify  = header_sender
30868 .endd
30869
30870 .vitem &*verify&~=&~header_syntax*&
30871 .cindex "&%verify%& ACL condition"
30872 .cindex "&ACL;" "verifying header syntax"
30873 .cindex "header lines" "verifying syntax"
30874 .cindex "verifying" "header syntax"
30875 This condition is relevant only in an ACL that is run after a message has been
30876 received, that is, in an ACL specified by &%acl_smtp_data%& or
30877 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
30878 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
30879 and &'Bcc:'&), returning true if there are no problems.
30880 Unqualified addresses (local parts without domains) are
30881 permitted only in locally generated messages and from hosts that match
30882 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
30883 appropriate.
30884
30885 Note that this condition is a syntax check only. However, a common spamming
30886 ploy used to be to send syntactically invalid headers such as
30887 .code
30888 To: @
30889 .endd
30890 and this condition can be used to reject such messages, though they are not as
30891 common as they used to be.
30892
30893 .vitem &*verify&~=&~helo*&
30894 .cindex "&%verify%& ACL condition"
30895 .cindex "&ACL;" "verifying HELO/EHLO"
30896 .cindex "HELO" "verifying"
30897 .cindex "EHLO" "verifying"
30898 .cindex "verifying" "EHLO"
30899 .cindex "verifying" "HELO"
30900 This condition is true if a HELO or EHLO command has been received from the
30901 client host, and its contents have been verified. If there has been no previous
30902 attempt to verify the HELO/EHLO contents, it is carried out when this
30903 condition is encountered. See the description of the &%helo_verify_hosts%& and
30904 &%helo_try_verify_hosts%& options for details of how to request verification
30905 independently of this condition.
30906
30907 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
30908 option), this condition is always true.
30909
30910
30911 .vitem &*verify&~=&~not_blind/*&<&'options'&>
30912 .cindex "verifying" "not blind"
30913 .cindex "bcc recipients, verifying none"
30914 This condition checks that there are no blind (bcc) recipients in the message.
30915 Every envelope recipient must appear either in a &'To:'& header line or in a
30916 &'Cc:'& header line for this condition to be true. Local parts are checked
30917 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
30918 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
30919 used only in a DATA or non-SMTP ACL.
30920
30921 .new
30922 There is one possible option, &`case_insensitive`&.  If this is present then
30923 local parts are checked case-insensitively.
30924 .wen
30925
30926 There are, of course, many legitimate messages that make use of blind (bcc)
30927 recipients. This check should not be used on its own for blocking messages.
30928
30929
30930 .vitem &*verify&~=&~recipient/*&<&'options'&>
30931 .cindex "&%verify%& ACL condition"
30932 .cindex "&ACL;" "verifying recipient"
30933 .cindex "recipient" "verifying"
30934 .cindex "verifying" "recipient"
30935 .vindex "&$address_data$&"
30936 This condition is relevant only after a RCPT command. It verifies the current
30937 recipient. Details of address verification are given later, starting at section
30938 &<<SECTaddressverification>>&. After a recipient has been verified, the value
30939 of &$address_data$& is the last value that was set while routing the address.
30940 This applies even if the verification fails. When an address that is being
30941 verified is redirected to a single address, verification continues with the new
30942 address, and in that case, the subsequent value of &$address_data$& is the
30943 value for the child address.
30944
30945 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
30946 .cindex "&%verify%& ACL condition"
30947 .cindex "&ACL;" "verifying host reverse lookup"
30948 .cindex "host" "verifying reverse lookup"
30949 This condition ensures that a verified host name has been looked up from the IP
30950 address of the client host. (This may have happened already if the host name
30951 was needed for checking a host list, or if the host matched &%host_lookup%&.)
30952 Verification ensures that the host name obtained from a reverse DNS lookup, or
30953 one of its aliases, does, when it is itself looked up in the DNS, yield the
30954 original IP address.
30955
30956 There is one possible option, &`defer_ok`&.  If this is present and a
30957 DNS operation returns a temporary error, the verify condition succeeds.
30958
30959 If this condition is used for a locally generated message (that is, when there
30960 is no client host involved), it always succeeds.
30961
30962 .vitem &*verify&~=&~sender/*&<&'options'&>
30963 .cindex "&%verify%& ACL condition"
30964 .cindex "&ACL;" "verifying sender"
30965 .cindex "sender" "verifying"
30966 .cindex "verifying" "sender"
30967 This condition is relevant only after a MAIL or RCPT command, or after a
30968 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
30969 the message's sender is empty (that is, this is a bounce message), the
30970 condition is true. Otherwise, the sender address is verified.
30971
30972 .vindex "&$address_data$&"
30973 .vindex "&$sender_address_data$&"
30974 If there is data in the &$address_data$& variable at the end of routing, its
30975 value is placed in &$sender_address_data$& at the end of verification. This
30976 value can be used in subsequent conditions and modifiers in the same ACL
30977 statement. It does not persist after the end of the current statement. If you
30978 want to preserve the value for longer, you can save it in an ACL variable.
30979
30980 Details of verification are given later, starting at section
30981 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
30982 to avoid doing it more than once per message.
30983
30984 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
30985 .cindex "&%verify%& ACL condition"
30986 This is a variation of the previous option, in which a modified address is
30987 verified as a sender.
30988
30989 Note that '/' is legal in local-parts; if the address may have such
30990 (eg. is generated from the received message)
30991 they must be protected from the options parsing by doubling:
30992 .code
30993 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
30994 .endd
30995 .endlist
30996
30997
30998
30999 .section "Using DNS lists" "SECTmorednslists"
31000 .cindex "DNS list" "in ACL"
31001 .cindex "black list (DNS)"
31002 .cindex "&ACL;" "testing a DNS list"
31003 In its simplest form, the &%dnslists%& condition tests whether the calling host
31004 is on at least one of a number of DNS lists by looking up the inverted IP
31005 address in one or more DNS domains. (Note that DNS list domains are not mail
31006 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31007 special options instead.) For example, if the calling host's IP
31008 address is 192.168.62.43, and the ACL statement is
31009 .code
31010 deny dnslists = blackholes.mail-abuse.org : \
31011                 dialups.mail-abuse.org
31012 .endd
31013 the following records are looked up:
31014 .code
31015 43.62.168.192.blackholes.mail-abuse.org
31016 43.62.168.192.dialups.mail-abuse.org
31017 .endd
31018 As soon as Exim finds an existing DNS record, processing of the list stops.
31019 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31020 to test that a host is on more than one list (an &"and"& conjunction), you can
31021 use two separate conditions:
31022 .code
31023 deny dnslists = blackholes.mail-abuse.org
31024      dnslists = dialups.mail-abuse.org
31025 .endd
31026 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31027 behaves as if the host does not match the list item, that is, as if the DNS
31028 record does not exist. If there are further items in the DNS list, they are
31029 processed.
31030
31031 This is usually the required action when &%dnslists%& is used with &%deny%&
31032 (which is the most common usage), because it prevents a DNS failure from
31033 blocking mail. However, you can change this behaviour by putting one of the
31034 following special items in the list:
31035 .display
31036 &`+include_unknown `&   behave as if the item is on the list
31037 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31038 &`+defer_unknown   `&   give a temporary error
31039 .endd
31040 .cindex "&`+include_unknown`&"
31041 .cindex "&`+exclude_unknown`&"
31042 .cindex "&`+defer_unknown`&"
31043 Each of these applies to any subsequent items on the list. For example:
31044 .code
31045 deny dnslists = +defer_unknown : foo.bar.example
31046 .endd
31047 Testing the list of domains stops as soon as a match is found. If you want to
31048 warn for one list and block for another, you can use two different statements:
31049 .code
31050 deny  dnslists = blackholes.mail-abuse.org
31051 warn  message  = X-Warn: sending host is on dialups list
31052       dnslists = dialups.mail-abuse.org
31053 .endd
31054 .cindex caching "of dns lookup"
31055 .cindex DNS TTL
31056 DNS list lookups are cached by Exim for the duration of the SMTP session
31057 (but limited by the DNS return TTL value),
31058 so a lookup based on the IP address is done at most once for any incoming
31059 connection (assuming long-enough TTL).
31060 Exim does not share information between multiple incoming
31061 connections (but your local name server cache should be active).
31062
31063 There are a number of DNS lists to choose from, some commercial, some free,
31064 or free for small deployments.  An overview can be found at
31065 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31066
31067
31068
31069 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31070 .cindex "DNS list" "keyed by explicit IP address"
31071 By default, the IP address that is used in a DNS list lookup is the IP address
31072 of the calling host. However, you can specify another IP address by listing it
31073 after the domain name, introduced by a slash. For example:
31074 .code
31075 deny dnslists = black.list.tld/192.168.1.2
31076 .endd
31077 This feature is not very helpful with explicit IP addresses; it is intended for
31078 use with IP addresses that are looked up, for example, the IP addresses of the
31079 MX hosts or nameservers of an email sender address. For an example, see section
31080 &<<SECTmulkeyfor>>& below.
31081
31082
31083
31084
31085 .section "DNS lists keyed on domain names" "SECID202"
31086 .cindex "DNS list" "keyed by domain name"
31087 There are some lists that are keyed on domain names rather than inverted IP
31088 addresses (see, e.g., the &'domain based zones'& link at
31089 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31090 with these lists. You can change the name that is looked up in a DNS list by
31091 listing it after the domain name, introduced by a slash. For example,
31092 .code
31093 deny  message  = Sender's domain is listed at $dnslist_domain
31094       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31095 .endd
31096 This particular example is useful only in ACLs that are obeyed after the
31097 RCPT or DATA commands, when a sender address is available. If (for
31098 example) the message's sender is &'user@tld.example'& the name that is looked
31099 up by this example is
31100 .code
31101 tld.example.dsn.rfc-ignorant.org
31102 .endd
31103 A single &%dnslists%& condition can contain entries for both names and IP
31104 addresses. For example:
31105 .code
31106 deny dnslists = sbl.spamhaus.org : \
31107                 dsn.rfc-ignorant.org/$sender_address_domain
31108 .endd
31109 The first item checks the sending host's IP address; the second checks a domain
31110 name. The whole condition is true if either of the DNS lookups succeeds.
31111
31112
31113
31114
31115 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31116 .cindex "DNS list" "multiple keys for"
31117 The syntax described above for looking up explicitly-defined values (either
31118 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31119 name for the DNS list, what follows the slash can in fact be a list of items.
31120 As with all lists in Exim, the default separator is a colon. However, because
31121 this is a sublist within the list of DNS blacklist domains, it is necessary
31122 either to double the separators like this:
31123 .code
31124 dnslists = black.list.tld/name.1::name.2
31125 .endd
31126 or to change the separator character, like this:
31127 .code
31128 dnslists = black.list.tld/<;name.1;name.2
31129 .endd
31130 If an item in the list is an IP address, it is inverted before the DNS
31131 blacklist domain is appended. If it is not an IP address, no inversion
31132 occurs. Consider this condition:
31133 .code
31134 dnslists = black.list.tld/<;192.168.1.2;a.domain
31135 .endd
31136 The DNS lookups that occur are:
31137 .code
31138 2.1.168.192.black.list.tld
31139 a.domain.black.list.tld
31140 .endd
31141 Once a DNS record has been found (that matches a specific IP return
31142 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31143 are done. If there is a temporary DNS error, the rest of the sublist of domains
31144 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31145 only if no other DNS lookup in this sublist succeeds. In other words, a
31146 successful lookup for any of the items in the sublist overrides a temporary
31147 error for a previous item.
31148
31149 The ability to supply a list of items after the slash is in some sense just a
31150 syntactic convenience. These two examples have the same effect:
31151 .code
31152 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31153 dnslists = black.list.tld/a.domain::b.domain
31154 .endd
31155 However, when the data for the list is obtained from a lookup, the second form
31156 is usually much more convenient. Consider this example:
31157 .code
31158 deny message  = The mail servers for the domain \
31159                 $sender_address_domain \
31160                 are listed at $dnslist_domain ($dnslist_value); \
31161                 see $dnslist_text.
31162      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31163                                    ${lookup dnsdb {>|mxh=\
31164                                    $sender_address_domain} }} }
31165 .endd
31166 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31167 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31168 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31169 of expanding the condition might be something like this:
31170 .code
31171 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31172 .endd
31173 Thus, this example checks whether or not the IP addresses of the sender
31174 domain's mail servers are on the Spamhaus black list.
31175
31176 The key that was used for a successful DNS list lookup is put into the variable
31177 &$dnslist_matched$& (see section &<<SECID204>>&).
31178
31179
31180
31181
31182 .section "Data returned by DNS lists" "SECID203"
31183 .cindex "DNS list" "data returned from"
31184 DNS lists are constructed using address records in the DNS. The original RBL
31185 just used the address 127.0.0.1 on the right hand side of each record, but the
31186 RBL+ list and some other lists use a number of values with different meanings.
31187 The values used on the RBL+ list are:
31188 .display
31189 127.1.0.1  RBL
31190 127.1.0.2  DUL
31191 127.1.0.3  DUL and RBL
31192 127.1.0.4  RSS
31193 127.1.0.5  RSS and RBL
31194 127.1.0.6  RSS and DUL
31195 127.1.0.7  RSS and DUL and RBL
31196 .endd
31197 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31198 different values. Some DNS lists may return more than one address record;
31199 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31200
31201
31202 .section "Variables set from DNS lists" "SECID204"
31203 .cindex "expansion" "variables, set from DNS list"
31204 .cindex "DNS list" "variables set from"
31205 .vindex "&$dnslist_domain$&"
31206 .vindex "&$dnslist_matched$&"
31207 .vindex "&$dnslist_text$&"
31208 .vindex "&$dnslist_value$&"
31209 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31210 the name of the overall domain that matched (for example,
31211 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31212 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31213 the DNS record. When the key is an IP address, it is not reversed in
31214 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31215 cases, for example:
31216 .code
31217 deny dnslists = spamhaus.example
31218 .endd
31219 the key is also available in another variable (in this case,
31220 &$sender_host_address$&). In more complicated cases, however, this is not true.
31221 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31222 might generate a dnslists lookup like this:
31223 .code
31224 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31225 .endd
31226 If this condition succeeds, the value in &$dnslist_matched$& might be
31227 &`192.168.6.7`& (for example).
31228
31229 If more than one address record is returned by the DNS lookup, all the IP
31230 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31231 The variable &$dnslist_text$& contains the contents of any associated TXT
31232 record. For lists such as RBL+ the TXT record for a merged entry is often not
31233 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31234 information.
31235
31236 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31237 &-- although these appear before the condition in the ACL, they are not
31238 expanded until after it has failed. For example:
31239 .code
31240 deny    hosts = !+local_networks
31241         message = $sender_host_address is listed \
31242                   at $dnslist_domain
31243         dnslists = rbl-plus.mail-abuse.example
31244 .endd
31245
31246
31247
31248 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31249 .cindex "DNS list" "matching specific returned data"
31250 You can add an equals sign and an IP address after a &%dnslists%& domain name
31251 in order to restrict its action to DNS records with a matching right hand side.
31252 For example,
31253 .code
31254 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31255 .endd
31256 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31257 any address record is considered to be a match. For the moment, we assume
31258 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31259 describes how multiple records are handled.
31260
31261 More than one IP address may be given for checking, using a comma as a
31262 separator. These are alternatives &-- if any one of them matches, the
31263 &%dnslists%& condition is true. For example:
31264 .code
31265 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31266 .endd
31267 If you want to specify a constraining address list and also specify names or IP
31268 addresses to be looked up, the constraining address list must be specified
31269 first. For example:
31270 .code
31271 deny dnslists = dsn.rfc-ignorant.org\
31272                 =127.0.0.2/$sender_address_domain
31273 .endd
31274
31275 If the character &`&&`& is used instead of &`=`&, the comparison for each
31276 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31277 In other words, the listed addresses are used as bit masks. The comparison is
31278 true if all the bits in the mask are present in the address that is being
31279 tested. For example:
31280 .code
31281 dnslists = a.b.c&0.0.0.3
31282 .endd
31283 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31284 want to test whether one bit or another bit is present (as opposed to both
31285 being present), you must use multiple values. For example:
31286 .code
31287 dnslists = a.b.c&0.0.0.1,0.0.0.2
31288 .endd
31289 matches if the final component of the address is an odd number or two times
31290 an odd number.
31291
31292
31293
31294 .section "Negated DNS matching conditions" "SECID205"
31295 You can supply a negative list of IP addresses as part of a &%dnslists%&
31296 condition. Whereas
31297 .code
31298 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31299 .endd
31300 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31301 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31302 .code
31303 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31304 .endd
31305 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31306 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31307 words, the result of the test is inverted if an exclamation mark appears before
31308 the &`=`& (or the &`&&`&) sign.
31309
31310 &*Note*&: This kind of negation is not the same as negation in a domain,
31311 host, or address list (which is why the syntax is different).
31312
31313 If you are using just one list, the negation syntax does not gain you much. The
31314 previous example is precisely equivalent to
31315 .code
31316 deny  dnslists = a.b.c
31317      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31318 .endd
31319 However, if you are using multiple lists, the negation syntax is clearer.
31320 Consider this example:
31321 .code
31322 deny  dnslists = sbl.spamhaus.org : \
31323                  list.dsbl.org : \
31324                  dnsbl.njabl.org!=127.0.0.3 : \
31325                  relays.ordb.org
31326 .endd
31327 Using only positive lists, this would have to be:
31328 .code
31329 deny  dnslists = sbl.spamhaus.org : \
31330                  list.dsbl.org
31331 deny  dnslists = dnsbl.njabl.org
31332      !dnslists = dnsbl.njabl.org=127.0.0.3
31333 deny  dnslists = relays.ordb.org
31334 .endd
31335 which is less clear, and harder to maintain.
31336
31337
31338
31339
31340 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31341 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31342 thereby providing more than one IP address. When an item in a &%dnslists%& list
31343 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31344 the match to specific results from the DNS lookup, there are two ways in which
31345 the checking can be handled. For example, consider the condition:
31346 .code
31347 dnslists = a.b.c=127.0.0.1
31348 .endd
31349 What happens if the DNS lookup for the incoming IP address yields both
31350 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31351 condition true because at least one given value was found, or is it false
31352 because at least one of the found values was not listed? And how does this
31353 affect negated conditions? Both possibilities are provided for with the help of
31354 additional separators &`==`& and &`=&&`&.
31355
31356 .ilist
31357 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31358 IP addresses matches one of the listed addresses. For the example above, the
31359 condition is true because 127.0.0.1 matches.
31360 .next
31361 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31362 looked up IP addresses matches one of the listed addresses. If the condition is
31363 changed to:
31364 .code
31365 dnslists = a.b.c==127.0.0.1
31366 .endd
31367 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31368 false because 127.0.0.2 is not listed. You would need to have:
31369 .code
31370 dnslists = a.b.c==127.0.0.1,127.0.0.2
31371 .endd
31372 for the condition to be true.
31373 .endlist
31374
31375 When &`!`& is used to negate IP address matching, it inverts the result, giving
31376 the precise opposite of the behaviour above. Thus:
31377 .ilist
31378 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31379 addresses matches one of the listed addresses. Consider:
31380 .code
31381 dnslists = a.b.c!&0.0.0.1
31382 .endd
31383 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31384 false because 127.0.0.1 matches.
31385 .next
31386 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31387 looked up IP address that does not match. Consider:
31388 .code
31389 dnslists = a.b.c!=&0.0.0.1
31390 .endd
31391 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31392 true, because 127.0.0.2 does not match. You would need to have:
31393 .code
31394 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31395 .endd
31396 for the condition to be false.
31397 .endlist
31398 When the DNS lookup yields only a single IP address, there is no difference
31399 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31400
31401
31402
31403
31404 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31405 .cindex "DNS list" "information from merged"
31406 When the facility for restricting the matching IP values in a DNS list is used,
31407 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31408 the true reason for rejection. This happens when lists are merged and the IP
31409 address in the A record is used to distinguish them; unfortunately there is
31410 only one TXT record. One way round this is not to use merged lists, but that
31411 can be inefficient because it requires multiple DNS lookups where one would do
31412 in the vast majority of cases when the host of interest is not on any of the
31413 lists.
31414
31415 A less inefficient way of solving this problem is available. If
31416 two domain names, comma-separated, are given, the second is used first to
31417 do an initial check, making use of any IP value restrictions that are set.
31418 If there is a match, the first domain is used, without any IP value
31419 restrictions, to get the TXT record. As a byproduct of this, there is also
31420 a check that the IP being tested is indeed on the first list. The first
31421 domain is the one that is put in &$dnslist_domain$&. For example:
31422 .code
31423 deny message  = \
31424          rejected because $sender_host_address is blacklisted \
31425          at $dnslist_domain\n$dnslist_text
31426        dnslists = \
31427          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31428          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31429 .endd
31430 For the first blacklist item, this starts by doing a lookup in
31431 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31432 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31433 value, and as long as something is found, it looks for the corresponding TXT
31434 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31435 The second blacklist item is processed similarly.
31436
31437 If you are interested in more than one merged list, the same list must be
31438 given several times, but because the results of the DNS lookups are cached,
31439 the DNS calls themselves are not repeated. For example:
31440 .code
31441 deny dnslists = \
31442          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31443          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31444          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31445          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31446 .endd
31447 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31448 values matches (or if no record is found), this is the only lookup that is
31449 done. Only if there is a match is one of the more specific lists consulted.
31450
31451
31452
31453 .section "DNS lists and IPv6" "SECTmorednslistslast"
31454 .cindex "IPv6" "DNS black lists"
31455 .cindex "DNS list" "IPv6 usage"
31456 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31457 nibble by nibble. For example, if the calling host's IP address is
31458 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31459 .code
31460 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31461   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31462 .endd
31463 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31464 lists contain wildcard records, intended for IPv4, that interact badly with
31465 IPv6. For example, the DNS entry
31466 .code
31467 *.3.some.list.example.    A    127.0.0.1
31468 .endd
31469 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31470 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31471
31472 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31473 &%condition%& condition, as in this example:
31474 .code
31475 deny   condition = ${if isip4{$sender_host_address}}
31476        dnslists  = some.list.example
31477 .endd
31478
31479 If an explicit key is being used for a DNS lookup and it may be an IPv6
31480 address you should specify alternate list separators for both the outer
31481 (DNS list name) list and inner (lookup keys) list:
31482 .code
31483        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31484 .endd
31485
31486 .section "Rate limiting incoming messages" "SECTratelimiting"
31487 .cindex "rate limiting" "client sending"
31488 .cindex "limiting client sending rates"
31489 .oindex "&%smtp_ratelimit_*%&"
31490 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31491 which clients can send email. This is more powerful than the
31492 &%smtp_ratelimit_*%& options, because those options control the rate of
31493 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31494 works across all connections (concurrent and sequential) from the same client
31495 host. The syntax of the &%ratelimit%& condition is:
31496 .display
31497 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31498 .endd
31499 If the average client sending rate is less than &'m'& messages per time
31500 period &'p'& then the condition is false; otherwise it is true.
31501
31502 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31503 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31504 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31505 of &'p'&.
31506
31507 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31508 time interval, for example, &`8h`& for eight hours. A larger time constant
31509 means that it takes Exim longer to forget a client's past behaviour. The
31510 parameter &'m'& is the maximum number of messages that a client is permitted to
31511 send in each time interval. It also specifies the number of messages permitted
31512 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31513 constant, you can allow a client to send more messages in a burst without
31514 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31515 both small, messages must be sent at an even rate.
31516
31517 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31518 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31519 when deploying the &%ratelimit%& ACL condition. The script prints usage
31520 instructions when it is run with no arguments.
31521
31522 The key is used to look up the data for calculating the client's average
31523 sending rate. This data is stored in Exim's spool directory, alongside the
31524 retry and other hints databases. The default key is &$sender_host_address$&,
31525 which means Exim computes the sending rate of each client host IP address.
31526 By changing the key you can change how Exim identifies clients for the purpose
31527 of ratelimiting. For example, to limit the sending rate of each authenticated
31528 user, independent of the computer they are sending from, set the key to
31529 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31530 example, &$authenticated_id$& is only meaningful if the client has
31531 authenticated (which you can check with the &%authenticated%& ACL condition).
31532
31533 The lookup key does not have to identify clients: If you want to limit the
31534 rate at which a recipient receives messages, you can use the key
31535 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31536 ACL.
31537
31538 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31539 specifies what Exim measures the rate of, for example, messages or recipients
31540 or bytes. You can adjust the measurement using the &%unique=%& and/or
31541 &%count=%& options. You can also control when Exim updates the recorded rate
31542 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31543 separated by a slash, like the other parameters. They may appear in any order.
31544
31545 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31546 any options that alter the meaning of the stored data. The limit &'m'& is not
31547 stored, so you can alter the configured maximum rate and Exim will still
31548 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31549 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31550 behaviour. The lookup key is not affected by changes to the update mode and
31551 the &%count=%& option.
31552
31553
31554 .section "Ratelimit options for what is being measured" "ratoptmea"
31555 .cindex "rate limiting" "per_* options"
31556 The &%per_conn%& option limits the client's connection rate. It is not
31557 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31558 &%acl_not_smtp_start%& ACLs.
31559
31560 The &%per_mail%& option limits the client's rate of sending messages. This is
31561 the default if none of the &%per_*%& options is specified. It can be used in
31562 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31563 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31564
31565 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31566 the same ACLs as the &%per_mail%& option, though it is best to use this option
31567 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31568 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31569 in its MAIL command, which may be inaccurate or completely missing. You can
31570 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31571 in kilobytes, megabytes, or gigabytes, respectively.
31572
31573 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31574 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31575 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31576 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31577 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31578 in either case the rate limiting engine will see a message with many
31579 recipients as a large high-speed burst.
31580
31581 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31582 number of different recipients that the client has sent messages to in the
31583 last time period. That is, if the client repeatedly sends messages to the same
31584 recipient, its measured rate is not increased. This option can only be used in
31585 &%acl_smtp_rcpt%&.
31586
31587 The &%per_cmd%& option causes Exim to recompute the rate every time the
31588 condition is processed. This can be used to limit the rate of any SMTP
31589 command. If it is used in multiple ACLs it can limit the aggregate rate of
31590 multiple different commands.
31591
31592 The &%count=%& option can be used to alter how much Exim adds to the client's
31593 measured rate. For example, the &%per_byte%& option is equivalent to
31594 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31595 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31596 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31597
31598 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31599
31600
31601 .section "Ratelimit update modes" "ratoptupd"
31602 .cindex "rate limiting" "reading data without updating"
31603 You can specify one of three options with the &%ratelimit%& condition to
31604 control when its database is updated. This section describes the &%readonly%&
31605 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31606
31607 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31608 previously-computed rate to check against the limit.
31609
31610 For example, you can test the client's sending rate and deny it access (when
31611 it is too fast) in the connect ACL. If the client passes this check then it
31612 can go on to send a message, in which case its recorded rate will be updated
31613 in the MAIL ACL. Subsequent connections from the same client will check this
31614 new rate.
31615 .code
31616 acl_check_connect:
31617  deny ratelimit = 100 / 5m / readonly
31618     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31619                   (max $sender_rate_limit)
31620 # ...
31621 acl_check_mail:
31622  warn ratelimit = 100 / 5m / strict
31623     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31624                   (max $sender_rate_limit)
31625 .endd
31626
31627 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31628 processing a message then it may increase the client's measured rate more than
31629 it should. For example, this will happen if you check the &%per_rcpt%& option
31630 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31631 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31632 multiple update problems by using the &%readonly%& option on later ratelimit
31633 checks.
31634
31635 The &%per_*%& options described above do not make sense in some ACLs. If you
31636 use a &%per_*%& option in an ACL where it is not normally permitted then the
31637 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31638 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31639 next section) so you must specify the &%readonly%& option explicitly.
31640
31641
31642 .section "Ratelimit options for handling fast clients" "ratoptfast"
31643 .cindex "rate limiting" "strict and leaky modes"
31644 If a client's average rate is greater than the maximum, the rate limiting
31645 engine can react in two possible ways, depending on the presence of the
31646 &%strict%& or &%leaky%& update modes. This is independent of the other
31647 counter-measures (such as rejecting the message) that may be specified by the
31648 rest of the ACL.
31649
31650 The &%leaky%& (default) option means that the client's recorded rate is not
31651 updated if it is above the limit. The effect of this is that Exim measures the
31652 client's average rate of successfully sent email,
31653 up to the given limit.
31654 This is appropriate if the countermeasure when the condition is true
31655 consists of refusing the message, and
31656 is generally the better choice if you have clients that retry automatically.
31657 If the action when true is anything more complex then this option is
31658 likely not what is wanted.
31659
31660 The &%strict%& option means that the client's recorded rate is always
31661 updated. The effect of this is that Exim measures the client's average rate
31662 of attempts to send email, which can be much higher than the maximum it is
31663 actually allowed. If the client is over the limit it may be subjected to
31664 counter-measures by the ACL. It must slow down and allow sufficient time to
31665 pass that its computed rate falls below the maximum before it can send email
31666 again. The time (the number of smoothing periods) it must wait and not
31667 attempt to send mail can be calculated with this formula:
31668 .code
31669         ln(peakrate/maxrate)
31670 .endd
31671
31672
31673 .section "Limiting the rate of different events" "ratoptuniq"
31674 .cindex "rate limiting" "counting unique events"
31675 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31676 rate of different events. For example, the &%per_addr%& option uses this
31677 mechanism to count the number of different recipients that the client has
31678 sent messages to in the last time period; it is equivalent to
31679 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31680 measure the rate that a client uses different sender addresses with the
31681 options &`per_mail/unique=$sender_address`&.
31682
31683 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31684 has seen for that key. The whole set is thrown away when it is older than the
31685 rate smoothing period &'p'&, so each different event is counted at most once
31686 per period. In the &%leaky%& update mode, an event that causes the client to
31687 go over the limit is not added to the set, in the same way that the client's
31688 recorded rate is not updated in the same situation.
31689
31690 When you combine the &%unique=%& and &%readonly%& options, the specific
31691 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31692 rate.
31693
31694 The &%unique=%& mechanism needs more space in the ratelimit database than the
31695 other &%ratelimit%& options in order to store the event set. The number of
31696 unique values is potentially as large as the rate limit, so the extra space
31697 required increases with larger limits.
31698
31699 The uniqueification is not perfect: there is a small probability that Exim
31700 will think a new event has happened before. If the sender's rate is less than
31701 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31702 the measured rate can go above the limit, in which case Exim may under-count
31703 events by a significant margin. Fortunately, if the rate is high enough (2.7
31704 times the limit) that the false positive rate goes above 9%, then Exim will
31705 throw away the over-full event set before the measured rate falls below the
31706 limit. Therefore the only harm should be that exceptionally high sending rates
31707 are logged incorrectly; any countermeasures you configure will be as effective
31708 as intended.
31709
31710
31711 .section "Using rate limiting" "useratlim"
31712 Exim's other ACL facilities are used to define what counter-measures are taken
31713 when the rate limit is exceeded. This might be anything from logging a warning
31714 (for example, while measuring existing sending rates in order to define
31715 policy), through time delays to slow down fast senders, up to rejecting the
31716 message. For example:
31717 .code
31718 # Log all senders' rates
31719 warn ratelimit = 0 / 1h / strict
31720      log_message = Sender rate $sender_rate / $sender_rate_period
31721
31722 # Slow down fast senders; note the need to truncate $sender_rate
31723 # at the decimal point.
31724 warn ratelimit = 100 / 1h / per_rcpt / strict
31725      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31726                    $sender_rate_limit }s
31727
31728 # Keep authenticated users under control
31729 deny authenticated = *
31730      ratelimit = 100 / 1d / strict / $authenticated_id
31731
31732 # System-wide rate limit
31733 defer message = Sorry, too busy. Try again later.
31734      ratelimit = 10 / 1s / $primary_hostname
31735
31736 # Restrict incoming rate from each host, with a default
31737 # set using a macro and special cases looked up in a table.
31738 defer message = Sender rate exceeds $sender_rate_limit \
31739                messages per $sender_rate_period
31740      ratelimit = ${lookup {$sender_host_address} \
31741                    cdb {DB/ratelimits.cdb} \
31742                    {$value} {RATELIMIT} }
31743 .endd
31744 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31745 especially with the &%per_rcpt%& option, you may suffer from a performance
31746 bottleneck caused by locking on the ratelimit hints database. Apart from
31747 making your ACLs less complicated, you can reduce the problem by using a
31748 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31749 this means that Exim will lose its hints data after a reboot (including retry
31750 hints, the callout cache, and ratelimit data).
31751
31752
31753
31754 .section "Address verification" "SECTaddressverification"
31755 .cindex "verifying address" "options for"
31756 .cindex "policy control" "address verification"
31757 Several of the &%verify%& conditions described in section
31758 &<<SECTaclconditions>>& cause addresses to be verified. Section
31759 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31760 The verification conditions can be followed by options that modify the
31761 verification process. The options are separated from the keyword and from each
31762 other by slashes, and some of them contain parameters. For example:
31763 .code
31764 verify = sender/callout
31765 verify = recipient/defer_ok/callout=10s,defer_ok
31766 .endd
31767 The first stage of address verification, which always happens, is to run the
31768 address through the routers, in &"verify mode"&. Routers can detect the
31769 difference between verification and routing for delivery, and their actions can
31770 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31771 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31772 The available options are as follows:
31773
31774 .ilist
31775 If the &%callout%& option is specified, successful routing to one or more
31776 remote hosts is followed by a &"callout"& to those hosts as an additional
31777 check. Callouts and their sub-options are discussed in the next section.
31778 .next
31779 If there is a defer error while doing verification routing, the ACL
31780 normally returns &"defer"&. However, if you include &%defer_ok%& in the
31781 options, the condition is forced to be true instead. Note that this is a main
31782 verification option as well as a suboption for callouts.
31783 .next
31784 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
31785 discusses the reporting of sender address verification failures.
31786 .next
31787 The &%success_on_redirect%& option causes verification always to succeed
31788 immediately after a successful redirection. By default, if a redirection
31789 generates just one address, that address is also verified. See further
31790 discussion in section &<<SECTredirwhilveri>>&.
31791 .endlist
31792
31793 .cindex "verifying address" "differentiating failures"
31794 .vindex "&$recipient_verify_failure$&"
31795 .vindex "&$sender_verify_failure$&"
31796 .vindex "&$acl_verify_message$&"
31797 After an address verification failure, &$acl_verify_message$& contains the
31798 error message that is associated with the failure. It can be preserved by
31799 coding like this:
31800 .code
31801 warn  !verify = sender
31802        set acl_m0 = $acl_verify_message
31803 .endd
31804 If you are writing your own custom rejection message or log message when
31805 denying access, you can use this variable to include information about the
31806 verification failure.
31807
31808 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
31809 appropriate) contains one of the following words:
31810
31811 .ilist
31812 &%qualify%&: The address was unqualified (no domain), and the message
31813 was neither local nor came from an exempted host.
31814 .next
31815 &%route%&: Routing failed.
31816 .next
31817 &%mail%&: Routing succeeded, and a callout was attempted; rejection
31818 occurred at or before the MAIL command (that is, on initial
31819 connection, HELO, or MAIL).
31820 .next
31821 &%recipient%&: The RCPT command in a callout was rejected.
31822 .next
31823 &%postmaster%&: The postmaster check in a callout was rejected.
31824 .endlist
31825
31826 The main use of these variables is expected to be to distinguish between
31827 rejections of MAIL and rejections of RCPT in callouts.
31828
31829 The above variables may also be set after a &*successful*&
31830 address verification to:
31831
31832 .ilist
31833 &%random%&: A random local-part callout succeeded
31834 .endlist
31835
31836
31837
31838
31839 .section "Callout verification" "SECTcallver"
31840 .cindex "verifying address" "by callout"
31841 .cindex "callout" "verification"
31842 .cindex "SMTP" "callout verification"
31843 For non-local addresses, routing verifies the domain, but is unable to do any
31844 checking of the local part. There are situations where some means of verifying
31845 the local part is desirable. One way this can be done is to make an SMTP
31846 &'callback'& to a delivery host for the sender address or a &'callforward'& to
31847 a subsequent host for a recipient address, to see if the host accepts the
31848 address. We use the term &'callout'& to cover both cases. Note that for a
31849 sender address, the callback is not to the client host that is trying to
31850 deliver the message, but to one of the hosts that accepts incoming mail for the
31851 sender's domain.
31852
31853 Exim does not do callouts by default. If you want them to happen, you must
31854 request them by setting appropriate options on the &%verify%& condition, as
31855 described below. This facility should be used with care, because it can add a
31856 lot of resource usage to the cost of verifying an address. However, Exim does
31857 cache the results of callouts, which helps to reduce the cost. Details of
31858 caching are in section &<<SECTcallvercache>>&.
31859
31860 Recipient callouts are usually used only between hosts that are controlled by
31861 the same administration. For example, a corporate gateway host could use
31862 callouts to check for valid recipients on an internal mailserver. A successful
31863 callout does not guarantee that a real delivery to the address would succeed;
31864 on the other hand, a failing callout does guarantee that a delivery would fail.
31865
31866 If the &%callout%& option is present on a condition that verifies an address, a
31867 second stage of verification occurs if the address is successfully routed to
31868 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
31869 &(manualroute)& router, where the router specifies the hosts. However, if a
31870 router that does not set up hosts routes to an &(smtp)& transport with a
31871 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
31872 &%hosts_override%& set, its hosts are always used, whether or not the router
31873 supplies a host list.
31874 Callouts are only supported on &(smtp)& transports.
31875
31876 The port that is used is taken from the transport, if it is specified and is a
31877 remote transport. (For routers that do verification only, no transport need be
31878 specified.) Otherwise, the default SMTP port is used. If a remote transport
31879 specifies an outgoing interface, this is used; otherwise the interface is not
31880 specified. Likewise, the text that is used for the HELO command is taken from
31881 the transport's &%helo_data%& option; if there is no transport, the value of
31882 &$smtp_active_hostname$& is used.
31883
31884 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
31885 test whether a bounce message could be delivered to the sender address. The
31886 following SMTP commands are sent:
31887 .display
31888 &`HELO `&<&'local host name'&>
31889 &`MAIL FROM:<>`&
31890 &`RCPT TO:`&<&'the address to be tested'&>
31891 &`QUIT`&
31892 .endd
31893 LHLO is used instead of HELO if the transport's &%protocol%& option is
31894 set to &"lmtp"&.
31895
31896 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
31897 settings.
31898
31899 A recipient callout check is similar. By default, it also uses an empty address
31900 for the sender. This default is chosen because most hosts do not make use of
31901 the sender address when verifying a recipient. Using the same address means
31902 that a single cache entry can be used for each recipient. Some sites, however,
31903 do make use of the sender address when verifying. These are catered for by the
31904 &%use_sender%& and &%use_postmaster%& options, described in the next section.
31905
31906 If the response to the RCPT command is a 2&'xx'& code, the verification
31907 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
31908 Exim tries the next host, if any. If there is a problem with all the remote
31909 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
31910 &%callout%& option is given, in which case the condition is forced to succeed.
31911
31912 .cindex "SMTP" "output flushing, disabling for callout"
31913 A callout may take a little time. For this reason, Exim normally flushes SMTP
31914 output before performing a callout in an ACL, to avoid unexpected timeouts in
31915 clients when the SMTP PIPELINING extension is in use. The flushing can be
31916 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
31917
31918
31919
31920
31921 .section "Additional parameters for callouts" "CALLaddparcall"
31922 .cindex "callout" "additional parameters for"
31923 The &%callout%& option can be followed by an equals sign and a number of
31924 optional parameters, separated by commas. For example:
31925 .code
31926 verify = recipient/callout=10s,defer_ok
31927 .endd
31928 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
31929 separate verify options, is retained for backwards compatibility, but is now
31930 deprecated. The additional parameters for &%callout%& are as follows:
31931
31932
31933 .vlist
31934 .vitem <&'a&~time&~interval'&>
31935 .cindex "callout" "timeout, specifying"
31936 This specifies the timeout that applies for the callout attempt to each host.
31937 For example:
31938 .code
31939 verify = sender/callout=5s
31940 .endd
31941 The default is 30 seconds. The timeout is used for each response from the
31942 remote host. It is also used for the initial connection, unless overridden by
31943 the &%connect%& parameter.
31944
31945
31946 .vitem &*connect&~=&~*&<&'time&~interval'&>
31947 .cindex "callout" "connection timeout, specifying"
31948 This parameter makes it possible to set a different (usually smaller) timeout
31949 for making the SMTP connection. For example:
31950 .code
31951 verify = sender/callout=5s,connect=1s
31952 .endd
31953 If not specified, this timeout defaults to the general timeout value.
31954
31955 .vitem &*defer_ok*&
31956 .cindex "callout" "defer, action on"
31957 When this parameter is present, failure to contact any host, or any other kind
31958 of temporary error, is treated as success by the ACL. However, the cache is not
31959 updated in this circumstance.
31960
31961 .vitem &*fullpostmaster*&
31962 .cindex "callout" "full postmaster check"
31963 This operates like the &%postmaster%& option (see below), but if the check for
31964 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
31965 accordance with the specification in RFC 2821. The RFC states that the
31966 unqualified address &'postmaster'& should be accepted.
31967
31968
31969 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
31970 .cindex "callout" "sender when verifying header"
31971 When verifying addresses in header lines using the &%header_sender%&
31972 verification option, Exim behaves by default as if the addresses are envelope
31973 sender addresses from a message. Callout verification therefore tests to see
31974 whether a bounce message could be delivered, by using an empty address in the
31975 MAIL command. However, it is arguable that these addresses might never be used
31976 as envelope senders, and could therefore justifiably reject bounce messages
31977 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
31978 address to use in the MAIL command. For example:
31979 .code
31980 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
31981 .endd
31982 This parameter is available only for the &%header_sender%& verification option.
31983
31984
31985 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
31986 .cindex "callout" "overall timeout, specifying"
31987 This parameter sets an overall timeout for performing a callout verification.
31988 For example:
31989 .code
31990 verify = sender/callout=5s,maxwait=30s
31991 .endd
31992 This timeout defaults to four times the callout timeout for individual SMTP
31993 commands. The overall timeout applies when there is more than one host that can
31994 be tried. The timeout is checked before trying the next host. This prevents
31995 very long delays if there are a large number of hosts and all are timing out
31996 (for example, when network connections are timing out).
31997
31998
31999 .vitem &*no_cache*&
32000 .cindex "callout" "cache, suppressing"
32001 .cindex "caching callout, suppressing"
32002 When this parameter is given, the callout cache is neither read nor updated.
32003
32004 .vitem &*postmaster*&
32005 .cindex "callout" "postmaster; checking"
32006 When this parameter is set, a successful callout check is followed by a similar
32007 check for the local part &'postmaster'& at the same domain. If this address is
32008 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32009 the postmaster check is recorded in a cache record; if it is a failure, this is
32010 used to fail subsequent callouts for the domain without a connection being
32011 made, until the cache record expires.
32012
32013 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32014 The postmaster check uses an empty sender in the MAIL command by default.
32015 You can use this parameter to do a postmaster check using a different address.
32016 For example:
32017 .code
32018 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32019 .endd
32020 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32021 one overrides. The &%postmaster%& parameter is equivalent to this example:
32022 .code
32023 require  verify = sender/callout=postmaster_mailfrom=
32024 .endd
32025 &*Warning*&: The caching arrangements for postmaster checking do not take
32026 account of the sender address. It is assumed that either the empty address or
32027 a fixed non-empty address will be used. All that Exim remembers is that the
32028 postmaster check for the domain succeeded or failed.
32029
32030
32031 .vitem &*random*&
32032 .cindex "callout" "&""random""& check"
32033 When this parameter is set, before doing the normal callout check, Exim does a
32034 check for a &"random"& local part at the same domain. The local part is not
32035 really random &-- it is defined by the expansion of the option
32036 &%callout_random_local_part%&, which defaults to
32037 .code
32038 $primary_hostname-$tod_epoch-testing
32039 .endd
32040 The idea here is to try to determine whether the remote host accepts all local
32041 parts without checking. If it does, there is no point in doing callouts for
32042 specific local parts. If the &"random"& check succeeds, the result is saved in
32043 a cache record, and used to force the current and subsequent callout checks to
32044 succeed without a connection being made, until the cache record expires.
32045
32046 .vitem &*use_postmaster*&
32047 .cindex "callout" "sender for recipient check"
32048 This parameter applies to recipient callouts only. For example:
32049 .code
32050 deny  !verify = recipient/callout=use_postmaster
32051 .endd
32052 .vindex "&$qualify_domain$&"
32053 It causes a non-empty postmaster address to be used in the MAIL command when
32054 performing the callout for the recipient, and also for a &"random"& check if
32055 that is configured. The local part of the address is &`postmaster`& and the
32056 domain is the contents of &$qualify_domain$&.
32057
32058 .vitem &*use_sender*&
32059 This option applies to recipient callouts only. For example:
32060 .code
32061 require  verify = recipient/callout=use_sender
32062 .endd
32063 It causes the message's actual sender address to be used in the MAIL
32064 command when performing the callout, instead of an empty address. There is no
32065 need to use this option unless you know that the called hosts make use of the
32066 sender when checking recipients. If used indiscriminately, it reduces the
32067 usefulness of callout caching.
32068
32069 .vitem &*hold*&
32070 This option applies to recipient callouts only. For example:
32071 .code
32072 require  verify = recipient/callout=use_sender,hold
32073 .endd
32074 It causes the connection to be held open and used for any further recipients
32075 and for eventual delivery (should that be done quickly).
32076 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32077 when that is used for the connections.
32078 The advantage is only gained if there are no callout cache hits
32079 (which could be enforced by the no_cache option),
32080 if the use_sender option is used,
32081 if neither the random nor the use_postmaster option is used,
32082 and if no other callouts intervene.
32083 .endlist
32084
32085 If you use any of the parameters that set a non-empty sender for the MAIL
32086 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32087 &%use_sender%&), you should think about possible loops. Recipient checking is
32088 usually done between two hosts that are under the same management, and the host
32089 that receives the callouts is not normally configured to do callouts itself.
32090 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32091 these circumstances.
32092
32093 However, if you use a non-empty sender address for a callout to an arbitrary
32094 host, there is the likelihood that the remote host will itself initiate a
32095 callout check back to your host. As it is checking what appears to be a message
32096 sender, it is likely to use an empty address in MAIL, thus avoiding a
32097 callout loop. However, to be on the safe side it would be best to set up your
32098 own ACLs so that they do not do sender verification checks when the recipient
32099 is the address you use for header sender or postmaster callout checking.
32100
32101 Another issue to think about when using non-empty senders for callouts is
32102 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32103 by the sender/recipient combination; thus, for any given recipient, many more
32104 actual callouts are performed than when an empty sender or postmaster is used.
32105
32106
32107
32108
32109 .section "Callout caching" "SECTcallvercache"
32110 .cindex "hints database" "callout cache"
32111 .cindex "callout" "cache, description of"
32112 .cindex "caching" "callout"
32113 Exim caches the results of callouts in order to reduce the amount of resources
32114 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32115 option. A hints database called &"callout"& is used for the cache. Two
32116 different record types are used: one records the result of a callout check for
32117 a specific address, and the other records information that applies to the
32118 entire domain (for example, that it accepts the local part &'postmaster'&).
32119
32120 When an original callout fails, a detailed SMTP error message is given about
32121 the failure. However, for subsequent failures use the cache data, this message
32122 is not available.
32123
32124 The expiry times for negative and positive address cache records are
32125 independent, and can be set by the global options &%callout_negative_expire%&
32126 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32127
32128 If a host gives a negative response to an SMTP connection, or rejects any
32129 commands up to and including
32130 .code
32131 MAIL FROM:<>
32132 .endd
32133 (but not including the MAIL command with a non-empty address),
32134 any callout attempt is bound to fail. Exim remembers such failures in a
32135 domain cache record, which it uses to fail callouts for the domain without
32136 making new connections, until the domain record times out. There are two
32137 separate expiry times for domain cache records:
32138 &%callout_domain_negative_expire%& (default 3h) and
32139 &%callout_domain_positive_expire%& (default 7d).
32140
32141 Domain records expire when the negative expiry time is reached if callouts
32142 cannot be made for the domain, or if the postmaster check failed.
32143 Otherwise, they expire when the positive expiry time is reached. This
32144 ensures that, for example, a host that stops accepting &"random"& local parts
32145 will eventually be noticed.
32146
32147 The callout caching mechanism is based on the domain of the address that is
32148 being tested. If the domain routes to several hosts, it is assumed that their
32149 behaviour will be the same.
32150
32151
32152
32153 .section "Sender address verification reporting" "SECTsenaddver"
32154 .cindex "verifying" "suppressing error details"
32155 See section &<<SECTaddressverification>>& for a general discussion of
32156 verification. When sender verification fails in an ACL, the details of the
32157 failure are given as additional output lines before the 550 response to the
32158 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32159 you might see:
32160 .code
32161 MAIL FROM:<xyz@abc.example>
32162 250 OK
32163 RCPT TO:<pqr@def.example>
32164 550-Verification failed for <xyz@abc.example>
32165 550-Called:   192.168.34.43
32166 550-Sent:     RCPT TO:<xyz@abc.example>
32167 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32168 550 Sender verification failed
32169 .endd
32170 If more than one RCPT command fails in the same way, the details are given
32171 only for the first of them. However, some administrators do not want to send
32172 out this much information. You can suppress the details by adding
32173 &`/no_details`& to the ACL statement that requests sender verification. For
32174 example:
32175 .code
32176 verify = sender/no_details
32177 .endd
32178
32179 .section "Redirection while verifying" "SECTredirwhilveri"
32180 .cindex "verifying" "redirection while"
32181 .cindex "address redirection" "while verifying"
32182 A dilemma arises when a local address is redirected by aliasing or forwarding
32183 during verification: should the generated addresses themselves be verified,
32184 or should the successful expansion of the original address be enough to verify
32185 it? By default, Exim takes the following pragmatic approach:
32186
32187 .ilist
32188 When an incoming address is redirected to just one child address, verification
32189 continues with the child address, and if that fails to verify, the original
32190 verification also fails.
32191 .next
32192 When an incoming address is redirected to more than one child address,
32193 verification does not continue. A success result is returned.
32194 .endlist
32195
32196 This seems the most reasonable behaviour for the common use of aliasing as a
32197 way of redirecting different local parts to the same mailbox. It means, for
32198 example, that a pair of alias entries of the form
32199 .code
32200 A.Wol:   aw123
32201 aw123:   :fail: Gone away, no forwarding address
32202 .endd
32203 work as expected, with both local parts causing verification failure. When a
32204 redirection generates more than one address, the behaviour is more like a
32205 mailing list, where the existence of the alias itself is sufficient for
32206 verification to succeed.
32207
32208 It is possible, however, to change the default behaviour so that all successful
32209 redirections count as successful verifications, however many new addresses are
32210 generated. This is specified by the &%success_on_redirect%& verification
32211 option. For example:
32212 .code
32213 require verify = recipient/success_on_redirect/callout=10s
32214 .endd
32215 In this example, verification succeeds if a router generates a new address, and
32216 the callout does not occur, because no address was routed to a remote host.
32217
32218 When verification is being tested via the &%-bv%& option, the treatment of
32219 redirections is as just described, unless the &%-v%& or any debugging option is
32220 also specified. In that case, full verification is done for every generated
32221 address and a report is output for each of them.
32222
32223
32224
32225 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32226 .cindex "CSA" "verifying"
32227 Client SMTP Authorization is a system that allows a site to advertise
32228 which machines are and are not permitted to send email. This is done by placing
32229 special SRV records in the DNS; these are looked up using the client's HELO
32230 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32231 Authorization checks in Exim are performed by the ACL condition:
32232 .code
32233 verify = csa
32234 .endd
32235 This fails if the client is not authorized. If there is a DNS problem, or if no
32236 valid CSA SRV record is found, or if the client is authorized, the condition
32237 succeeds. These three cases can be distinguished using the expansion variable
32238 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32239 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32240 be likely to cause problems for legitimate email.
32241
32242 The error messages produced by the CSA code include slightly more
32243 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32244 looking up the CSA SRV record, or problems looking up the CSA target
32245 address record. There are four reasons for &$csa_status$& being &"fail"&:
32246
32247 .ilist
32248 The client's host name is explicitly not authorized.
32249 .next
32250 The client's IP address does not match any of the CSA target IP addresses.
32251 .next
32252 The client's host name is authorized but it has no valid target IP addresses
32253 (for example, the target's addresses are IPv6 and the client is using IPv4).
32254 .next
32255 The client's host name has no CSA SRV record but a parent domain has asserted
32256 that all subdomains must be explicitly authorized.
32257 .endlist
32258
32259 The &%csa%& verification condition can take an argument which is the domain to
32260 use for the DNS query. The default is:
32261 .code
32262 verify = csa/$sender_helo_name
32263 .endd
32264 This implementation includes an extension to CSA. If the query domain
32265 is an address literal such as [192.0.2.95], or if it is a bare IP
32266 address, Exim searches for CSA SRV records in the reverse DNS as if
32267 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32268 meaningful to say:
32269 .code
32270 verify = csa/$sender_host_address
32271 .endd
32272 In fact, this is the check that Exim performs if the client does not say HELO.
32273 This extension can be turned off by setting the main configuration option
32274 &%dns_csa_use_reverse%& to be false.
32275
32276 If a CSA SRV record is not found for the domain itself, a search
32277 is performed through its parent domains for a record which might be
32278 making assertions about subdomains. The maximum depth of this search is limited
32279 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32280 default. Exim does not look for CSA SRV records in a top level domain, so the
32281 default settings handle HELO domains as long as seven
32282 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32283 of legitimate HELO domains.
32284
32285 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32286 direct SRV lookups, this is not sufficient because of the extra parent domain
32287 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32288 addresses into lookups in the reverse DNS space. The result of a successful
32289 lookup such as:
32290 .code
32291 ${lookup dnsdb {csa=$sender_helo_name}}
32292 .endd
32293 has two space-separated fields: an authorization code and a target host name.
32294 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32295 authorization required but absent, or &"?"& for unknown.
32296
32297
32298
32299
32300 .section "Bounce address tag validation" "SECTverifyPRVS"
32301 .cindex "BATV, verifying"
32302 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32303 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32304 Genuine incoming bounce messages should therefore always be addressed to
32305 recipients that have a valid tag. This scheme is a way of detecting unwanted
32306 bounce messages caused by sender address forgeries (often called &"collateral
32307 spam"&), because the recipients of such messages do not include valid tags.
32308
32309 There are two expansion items to help with the implementation of the BATV
32310 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32311 the original envelope sender address by using a simple key to add a hash of the
32312 address and some time-based randomizing information. The &%prvs%& expansion
32313 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32314 The syntax of these expansion items is described in section
32315 &<<SECTexpansionitems>>&.
32316 The validity period on signed addresses is seven days.
32317
32318 As an example, suppose the secret per-address keys are stored in an MySQL
32319 database. A query to look up the key for an address could be defined as a macro
32320 like this:
32321 .code
32322 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32323                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32324                 }{$value}}
32325 .endd
32326 Suppose also that the senders who make use of BATV are defined by an address
32327 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32328 use this:
32329 .code
32330 # Bounces: drop unsigned addresses for BATV senders
32331 deny message = This address does not send an unsigned reverse path
32332      senders = :
32333      recipients = +batv_senders
32334
32335 # Bounces: In case of prvs-signed address, check signature.
32336 deny message = Invalid reverse path signature.
32337      senders = :
32338      condition  = ${prvscheck {$local_part@$domain}\
32339                   {PRVSCHECK_SQL}{1}}
32340      !condition = $prvscheck_result
32341 .endd
32342 The first statement rejects recipients for bounce messages that are addressed
32343 to plain BATV sender addresses, because it is known that BATV senders do not
32344 send out messages with plain sender addresses. The second statement rejects
32345 recipients that are prvs-signed, but with invalid signatures (either because
32346 the key is wrong, or the signature has timed out).
32347
32348 A non-prvs-signed address is not rejected by the second statement, because the
32349 &%prvscheck%& expansion yields an empty string if its first argument is not a
32350 prvs-signed address, thus causing the &%condition%& condition to be false. If
32351 the first argument is a syntactically valid prvs-signed address, the yield is
32352 the third string (in this case &"1"&), whether or not the cryptographic and
32353 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32354 of the checks (empty for failure, &"1"& for success).
32355
32356 There is one more issue you must consider when implementing prvs-signing:
32357 you have to ensure that the routers accept prvs-signed addresses and
32358 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32359 router to remove the signature with a configuration along these lines:
32360 .code
32361 batv_redirect:
32362   driver = redirect
32363   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32364 .endd
32365 This works because, if the third argument of &%prvscheck%& is empty, the result
32366 of the expansion of a prvs-signed address is the decoded value of the original
32367 address. This router should probably be the first of your routers that handles
32368 local addresses.
32369
32370 To create BATV-signed addresses in the first place, a transport of this form
32371 can be used:
32372 .code
32373 external_smtp_batv:
32374   driver = smtp
32375   return_path = ${prvs {$return_path} \
32376                        {${lookup mysql{SELECT \
32377                        secret FROM batv_prvs WHERE \
32378                        sender='${quote_mysql:$sender_address}'} \
32379                        {$value}fail}}}
32380 .endd
32381 If no key can be found for the existing return path, no signing takes place.
32382
32383
32384
32385 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32386 .cindex "&ACL;" "relay control"
32387 .cindex "relaying" "control by ACL"
32388 .cindex "policy control" "relay control"
32389 An MTA is said to &'relay'& a message if it receives it from some host and
32390 delivers it directly to another host as a result of a remote address contained
32391 within it. Redirecting a local address via an alias or forward file and then
32392 passing the message on to another host is not relaying,
32393 .cindex "&""percent hack""&"
32394 but a redirection as a result of the &"percent hack"& is.
32395
32396 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32397 A host which is acting as a gateway or an MX backup is concerned with incoming
32398 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32399 a host which is acting as a smart host for a number of clients is concerned
32400 with outgoing relaying from those clients to the Internet at large. Often the
32401 same host is fulfilling both functions,
32402 . ///
32403 . as illustrated in the diagram below,
32404 . ///
32405 but in principle these two kinds of relaying are entirely independent. What is
32406 not wanted is the transmission of mail from arbitrary remote hosts through your
32407 system to arbitrary domains.
32408
32409
32410 You can implement relay control by means of suitable statements in the ACL that
32411 runs for each RCPT command. For convenience, it is often easiest to use
32412 Exim's named list facility to define the domains and hosts involved. For
32413 example, suppose you want to do the following:
32414
32415 .ilist
32416 Deliver a number of domains to mailboxes on the local host (or process them
32417 locally in some other way). Let's say these are &'my.dom1.example'& and
32418 &'my.dom2.example'&.
32419 .next
32420 Relay mail for a number of other domains for which you are the secondary MX.
32421 These might be &'friend1.example'& and &'friend2.example'&.
32422 .next
32423 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32424 Suppose your LAN is 192.168.45.0/24.
32425 .endlist
32426
32427
32428 In the main part of the configuration, you put the following definitions:
32429 .code
32430 domainlist local_domains    = my.dom1.example : my.dom2.example
32431 domainlist relay_to_domains = friend1.example : friend2.example
32432 hostlist   relay_from_hosts = 192.168.45.0/24
32433 .endd
32434 Now you can use these definitions in the ACL that is run for every RCPT
32435 command:
32436 .code
32437 acl_check_rcpt:
32438   accept domains = +local_domains : +relay_to_domains
32439   accept hosts   = +relay_from_hosts
32440 .endd
32441 The first statement accepts any RCPT command that contains an address in
32442 the local or relay domains. For any other domain, control passes to the second
32443 statement, which accepts the command only if it comes from one of the relay
32444 hosts. In practice, you will probably want to make your ACL more sophisticated
32445 than this, for example, by including sender and recipient verification. The
32446 default configuration includes a more comprehensive example, which is described
32447 in chapter &<<CHAPdefconfil>>&.
32448
32449
32450
32451 .section "Checking a relay configuration" "SECTcheralcon"
32452 .cindex "relaying" "checking control of"
32453 You can check the relay characteristics of your configuration in the same way
32454 that you can test any ACL behaviour for an incoming SMTP connection, by using
32455 the &%-bh%& option to run a fake SMTP session with which you interact.
32456 .ecindex IIDacl
32457
32458
32459
32460 . ////////////////////////////////////////////////////////////////////////////
32461 . ////////////////////////////////////////////////////////////////////////////
32462
32463 .chapter "Content scanning at ACL time" "CHAPexiscan"
32464 .scindex IIDcosca "content scanning" "at ACL time"
32465 The extension of Exim to include content scanning at ACL time, formerly known
32466 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32467 was integrated into the main source for Exim release 4.50, and Tom continues to
32468 maintain it. Most of the wording of this chapter is taken from Tom's
32469 specification.
32470
32471 It is also possible to scan the content of messages at other times. The
32472 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32473 scanning after all the ACLs have run. A transport filter can be used to scan
32474 messages at delivery time (see the &%transport_filter%& option, described in
32475 chapter &<<CHAPtransportgeneric>>&).
32476
32477 If you want to include the ACL-time content-scanning features when you compile
32478 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32479 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32480
32481 .ilist
32482 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32483 for all MIME parts for SMTP and non-SMTP messages, respectively.
32484 .next
32485 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32486 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32487 run at the end of message reception (the &%acl_smtp_data%& ACL).
32488 .next
32489 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32490 of messages, or parts of messages, for debugging purposes.
32491 .next
32492 Additional expansion variables that are set in the new ACL and by the new
32493 conditions.
32494 .next
32495 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32496 .endlist
32497
32498 Content-scanning is continually evolving, and new features are still being
32499 added. While such features are still unstable and liable to incompatible
32500 changes, they are made available in Exim by setting options whose names begin
32501 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32502 this manual. You can find out about them by reading the file called
32503 &_doc/experimental.txt_&.
32504
32505 All the content-scanning facilities work on a MBOX copy of the message that is
32506 temporarily created in a file called:
32507 .display
32508 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32509 .endd
32510 The &_.eml_& extension is a friendly hint to virus scanners that they can
32511 expect an MBOX-like structure inside that file. The file is created when the
32512 first content scanning facility is called. Subsequent calls to content
32513 scanning conditions open the same file again. The directory is recursively
32514 removed when the &%acl_smtp_data%& ACL has finished running, unless
32515 .code
32516 control = no_mbox_unspool
32517 .endd
32518 has been encountered. When the MIME ACL decodes files, they are put into the
32519 same directory by default.
32520
32521
32522
32523 .section "Scanning for viruses" "SECTscanvirus"
32524 .cindex "virus scanning"
32525 .cindex "content scanning" "for viruses"
32526 .cindex "content scanning" "the &%malware%& condition"
32527 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32528 It supports a &"generic"& interface to scanners called via the shell, and
32529 specialized interfaces for &"daemon"& type virus scanners, which are resident
32530 in memory and thus are much faster.
32531
32532 A timeout of 2 minutes is applied to a scanner call (by default);
32533 if it expires then a defer action is taken.
32534
32535 .oindex "&%av_scanner%&"
32536 You can set the &%av_scanner%& option in the main part of the configuration
32537 to specify which scanner to use, together with any additional options that
32538 are needed. The basic syntax is as follows:
32539 .display
32540 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32541 .endd
32542 If you do not set &%av_scanner%&, it defaults to
32543 .code
32544 av_scanner = sophie:/var/run/sophie
32545 .endd
32546 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32547 before use.
32548 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32549 The following scanner types are supported in this release,
32550 though individual ones can be included or not at build time:
32551
32552 .vlist
32553 .vitem &%avast%&
32554 .cindex "virus scanners" "avast"
32555 This is the scanner daemon of Avast. It has been tested with Avast Core
32556 Security (currently at version 2.2.0).
32557 You can get a trial version at &url(https://www.avast.com) or for Linux
32558 at &url(https://www.avast.com/linux-server-antivirus).
32559 This scanner type takes one option,
32560 which can be either a full path to a UNIX socket,
32561 or host and port specifiers separated by white space.
32562 The host may be a name or an IP address; the port is either a
32563 single number or a pair of numbers with a dash between.
32564 A list of options may follow. These options are interpreted on the
32565 Exim's side of the malware scanner, or are given on separate lines to
32566 the daemon as options before the main scan command.
32567
32568 .cindex &`pass_unscanned`& "avast"
32569 If &`pass_unscanned`&
32570 is set, any files the Avast scanner can't scan (e.g.
32571 decompression bombs, or invalid archives) are considered clean. Use with
32572 care.
32573
32574 For example:
32575 .code
32576 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32577 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32578 av_scanner = avast:192.168.2.22 5036
32579 .endd
32580 If you omit the argument, the default path
32581 &_/var/run/avast/scan.sock_&
32582 is used.
32583 If you use a remote host,
32584 you need to make Exim's spool directory available to it,
32585 as the scanner is passed a file path, not file contents.
32586 For information about available commands and their options you may use
32587 .code
32588 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32589     FLAGS
32590     SENSITIVITY
32591     PACK
32592 .endd
32593
32594 If the scanner returns a temporary failure (e.g. license issues, or
32595 permission problems), the message is deferred and a paniclog entry is
32596 written.  The usual &`defer_ok`& option is available.
32597
32598 .vitem &%aveserver%&
32599 .cindex "virus scanners" "Kaspersky"
32600 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32601 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32602 which is the path to the daemon's UNIX socket. The default is shown in this
32603 example:
32604 .code
32605 av_scanner = aveserver:/var/run/aveserver
32606 .endd
32607
32608
32609 .vitem &%clamd%&
32610 .cindex "virus scanners" "clamd"
32611 This daemon-type scanner is GPL and free. You can get it at
32612 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32613 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32614 in the MIME ACL. This is no longer believed to be necessary.
32615
32616 The options are a list of server specifiers, which may be
32617 a UNIX socket specification,
32618 a TCP socket specification,
32619 or a (global) option.
32620
32621 A socket specification consists of a space-separated list.
32622 For a Unix socket the first element is a full path for the socket,
32623 for a TCP socket the first element is the IP address
32624 and the second a port number,
32625 Any further elements are per-server (non-global) options.
32626 These per-server options are supported:
32627 .code
32628 retry=<timespec>        Retry on connect fail
32629 .endd
32630
32631 The &`retry`& option specifies a time after which a single retry for
32632 a failed connect is made.  The default is to not retry.
32633
32634 If a Unix socket file is specified, only one server is supported.
32635
32636 Examples:
32637 .code
32638 av_scanner = clamd:/opt/clamd/socket
32639 av_scanner = clamd:192.0.2.3 1234
32640 av_scanner = clamd:192.0.2.3 1234:local
32641 av_scanner = clamd:192.0.2.3 1234 retry=10s
32642 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32643 .endd
32644 If the value of av_scanner points to a UNIX socket file or contains the
32645 &`local`&
32646 option, then the ClamAV interface will pass a filename containing the data
32647 to be scanned, which should normally result in less I/O happening and be
32648 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32649 Exim does not assume that there is a common filesystem with the remote host.
32650
32651 The final example shows that multiple TCP targets can be specified.  Exim will
32652 randomly use one for each incoming email (i.e. it load balances them).  Note
32653 that only TCP targets may be used if specifying a list of scanners; a UNIX
32654 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32655 unavailable, Exim will try the remaining one(s) until it finds one that works.
32656 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32657 not keep track of scanner state between multiple messages, and the scanner
32658 selection is random, so the message will get logged in the mainlog for each
32659 email that the down scanner gets chosen first (message wrapped to be readable):
32660 .code
32661 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32662    clamd: connection to localhost, port 3310 failed
32663    (Connection refused)
32664 .endd
32665
32666 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32667 contributing the code for this scanner.
32668
32669 .vitem &%cmdline%&
32670 .cindex "virus scanners" "command line interface"
32671 This is the keyword for the generic command line scanner interface. It can be
32672 used to attach virus scanners that are invoked from the shell. This scanner
32673 type takes 3 mandatory options:
32674
32675 .olist
32676 The full path and name of the scanner binary, with all command line options,
32677 and a placeholder (&`%s`&) for the directory to scan.
32678
32679 .next
32680 A regular expression to match against the STDOUT and STDERR output of the
32681 virus scanner. If the expression matches, a virus was found. You must make
32682 absolutely sure that this expression matches on &"virus found"&. This is called
32683 the &"trigger"& expression.
32684
32685 .next
32686 Another regular expression, containing exactly one pair of parentheses, to
32687 match the name of the virus found in the scanners output. This is called the
32688 &"name"& expression.
32689 .endlist olist
32690
32691 For example, Sophos Sweep reports a virus on a line like this:
32692 .code
32693 Virus 'W32/Magistr-B' found in file ./those.bat
32694 .endd
32695 For the trigger expression, we can match the phrase &"found in file"&. For the
32696 name expression, we want to extract the W32/Magistr-B string, so we can match
32697 for the single quotes left and right of it. Altogether, this makes the
32698 configuration setting:
32699 .code
32700 av_scanner = cmdline:\
32701              /path/to/sweep -ss -all -rec -archive %s:\
32702              found in file:'(.+)'
32703 .endd
32704 .vitem &%drweb%&
32705 .cindex "virus scanners" "DrWeb"
32706 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32707 takes one option,
32708 either a full path to a UNIX socket,
32709 or host and port specifiers separated by white space.
32710 The host may be a name or an IP address; the port is either a
32711 single number or a pair of numbers with a dash between.
32712 For example:
32713 .code
32714 av_scanner = drweb:/var/run/drwebd.sock
32715 av_scanner = drweb:192.168.2.20 31337
32716 .endd
32717 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32718 is used. Thanks to Alex Miller for contributing the code for this scanner.
32719
32720 .vitem &%f-protd%&
32721 .cindex "virus scanners" "f-protd"
32722 The f-protd scanner is accessed via HTTP over TCP.
32723 One argument is taken, being a space-separated hostname and port number
32724 (or port-range).
32725 For example:
32726 .code
32727 av_scanner = f-protd:localhost 10200-10204
32728 .endd
32729 If you omit the argument, the default values shown above are used.
32730
32731 .vitem &%f-prot6d%&
32732 .cindex "virus scanners" "f-prot6d"
32733 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32734 One argument is taken, being a space-separated hostname and port number.
32735 For example:
32736 .code
32737 av_scanner = f-prot6d:localhost 10200
32738 .endd
32739 If you omit the argument, the default values show above are used.
32740
32741 .vitem &%fsecure%&
32742 .cindex "virus scanners" "F-Secure"
32743 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32744 argument which is the path to a UNIX socket. For example:
32745 .code
32746 av_scanner = fsecure:/path/to/.fsav
32747 .endd
32748 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32749 Thelmen for contributing the code for this scanner.
32750
32751 .vitem &%kavdaemon%&
32752 .cindex "virus scanners" "Kaspersky"
32753 This is the scanner daemon of Kaspersky Version 4. This version of the
32754 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32755 scanner type takes one option, which is the path to the daemon's UNIX socket.
32756 For example:
32757 .code
32758 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32759 .endd
32760 The default path is &_/var/run/AvpCtl_&.
32761
32762 .vitem &%mksd%&
32763 .cindex "virus scanners" "mksd"
32764 This was a daemon type scanner that is aimed mainly at Polish users,
32765 though some documentation was available in English.
32766 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
32767 and this appears to be a candidate for removal from Exim, unless
32768 we are informed of other virus scanners which use the same protocol
32769 to integrate.
32770 The only option for this scanner type is
32771 the maximum number of processes used simultaneously to scan the attachments,
32772 provided that mksd has
32773 been run with at least the same number of child processes. For example:
32774 .code
32775 av_scanner = mksd:2
32776 .endd
32777 You can safely omit this option (the default value is 1).
32778
32779 .vitem &%sock%&
32780 .cindex "virus scanners" "simple socket-connected"
32781 This is a general-purpose way of talking to simple scanner daemons
32782 running on the local machine.
32783 There are four options:
32784 an address (which may be an IP address and port, or the path of a Unix socket),
32785 a commandline to send (may include a single %s which will be replaced with
32786 the path to the mail file to be scanned),
32787 an RE to trigger on from the returned data,
32788 and an RE to extract malware_name from the returned data.
32789 For example:
32790 .code
32791 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
32792 .endd
32793 Note that surrounding whitespace is stripped from each option, meaning
32794 there is no way to specify a trailing newline.
32795 The socket specifier and both regular-expressions are required.
32796 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
32797 specify an empty element to get this.
32798
32799 .vitem &%sophie%&
32800 .cindex "virus scanners" "Sophos and Sophie"
32801 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
32802 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
32803 for this scanner type is the path to the UNIX socket that Sophie uses for
32804 client communication. For example:
32805 .code
32806 av_scanner = sophie:/tmp/sophie
32807 .endd
32808 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
32809 the option.
32810 .endlist
32811
32812 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
32813 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
32814 ACL.
32815
32816 The &%av_scanner%& option is expanded each time &%malware%& is called. This
32817 makes it possible to use different scanners. See further below for an example.
32818 The &%malware%& condition caches its results, so when you use it multiple times
32819 for the same message, the actual scanning process is only carried out once.
32820 However, using expandable items in &%av_scanner%& disables this caching, in
32821 which case each use of the &%malware%& condition causes a new scan of the
32822 message.
32823
32824 The &%malware%& condition takes a right-hand argument that is expanded before
32825 use and taken as a list, slash-separated by default.
32826 The first element can then be one of
32827
32828 .ilist
32829 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
32830 The condition succeeds if a virus was found, and fail otherwise. This is the
32831 recommended usage.
32832 .next
32833 &"false"& or &"0"& or an empty string, in which case no scanning is done and
32834 the condition fails immediately.
32835 .next
32836 A regular expression, in which case the message is scanned for viruses. The
32837 condition succeeds if a virus is found and its name matches the regular
32838 expression. This allows you to take special actions on certain types of virus.
32839 Note that &"/"& characters in the RE must be doubled due to the list-processing,
32840 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
32841 .endlist
32842
32843 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
32844 messages even if there is a problem with the virus scanner.
32845 Otherwise, such a problem causes the ACL to defer.
32846
32847 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
32848 specify a non-default timeout.  The default is two minutes.
32849 For example:
32850 .code
32851 malware = * / defer_ok / tmo=10s
32852 .endd
32853 A timeout causes the ACL to defer.
32854
32855 .vindex "&$callout_address$&"
32856 When a connection is made to the scanner the expansion variable &$callout_address$&
32857 is set to record the actual address used.
32858
32859 .vindex "&$malware_name$&"
32860 When a virus is found, the condition sets up an expansion variable called
32861 &$malware_name$& that contains the name of the virus. You can use it in a
32862 &%message%& modifier that specifies the error returned to the sender, and/or in
32863 logging data.
32864
32865 Beware the interaction of Exim's &%message_size_limit%& with any size limits
32866 imposed by your anti-virus scanner.
32867
32868 Here is a very simple scanning example:
32869 .code
32870 deny message = This message contains malware ($malware_name)
32871      malware = *
32872 .endd
32873 The next example accepts messages when there is a problem with the scanner:
32874 .code
32875 deny message = This message contains malware ($malware_name)
32876      malware = */defer_ok
32877 .endd
32878 The next example shows how to use an ACL variable to scan with both sophie and
32879 aveserver. It assumes you have set:
32880 .code
32881 av_scanner = $acl_m0
32882 .endd
32883 in the main Exim configuration.
32884 .code
32885 deny message = This message contains malware ($malware_name)
32886      set acl_m0 = sophie
32887      malware = *
32888
32889 deny message = This message contains malware ($malware_name)
32890      set acl_m0 = aveserver
32891      malware = *
32892 .endd
32893
32894
32895 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
32896 .cindex "content scanning" "for spam"
32897 .cindex "spam scanning"
32898 .cindex "SpamAssassin"
32899 .cindex "Rspamd"
32900 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
32901 score and a report for the message.
32902 Support is also provided for Rspamd.
32903
32904 For more information about installation and configuration of SpamAssassin or
32905 Rspamd refer to their respective websites at
32906 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
32907
32908 SpamAssassin can be installed with CPAN by running:
32909 .code
32910 perl -MCPAN -e 'install Mail::SpamAssassin'
32911 .endd
32912 SpamAssassin has its own set of configuration files. Please review its
32913 documentation to see how you can tweak it. The default installation should work
32914 nicely, however.
32915
32916 .oindex "&%spamd_address%&"
32917 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
32918 intend to use an instance running on the local host you do not need to set
32919 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
32920 you must set the &%spamd_address%& option in the global part of the Exim
32921 configuration as follows (example):
32922 .code
32923 spamd_address = 192.168.99.45 783
32924 .endd
32925 The SpamAssassin protocol relies on a TCP half-close from the client.
32926 If your SpamAssassin client side is running a Linux system with an
32927 iptables firewall, consider setting
32928 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
32929 timeout, Exim uses when waiting for a response from the SpamAssassin
32930 server (currently defaulting to 120s).  With a lower value the Linux
32931 connection tracking may consider your half-closed connection as dead too
32932 soon.
32933
32934
32935 To use Rspamd (which by default listens on all local addresses
32936 on TCP port 11333)
32937 you should add &%variant=rspamd%& after the address/port pair, for example:
32938 .code
32939 spamd_address = 127.0.0.1 11333 variant=rspamd
32940 .endd
32941
32942 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
32943 sockets. If you want to us these, supply &%spamd_address%& with an absolute
32944 filename instead of an address/port pair:
32945 .code
32946 spamd_address = /var/run/spamd_socket
32947 .endd
32948 You can have multiple &%spamd%& servers to improve scalability. These can
32949 reside on other hardware reachable over the network. To specify multiple
32950 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
32951 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
32952 .code
32953 spamd_address = 192.168.2.10 783 : \
32954                 192.168.2.11 783 : \
32955                 192.168.2.12 783
32956 .endd
32957 Up to 32 &%spamd%& servers are supported.
32958 When a server fails to respond to the connection attempt, all other
32959 servers are tried until one succeeds. If no server responds, the &%spam%&
32960 condition defers.
32961
32962 Unix and TCP socket specifications may be mixed in any order.
32963 Each element of the list is a list itself, space-separated by default
32964 and changeable in the usual way (&<<SECTlistsepchange>>&);
32965 take care to not double the separator.
32966
32967 For TCP socket specifications a host name or IP (v4 or v6, but
32968 subject to list-separator quoting rules) address can be used,
32969 and the port can be one or a dash-separated pair.
32970 In the latter case, the range is tried in strict order.
32971
32972 Elements after the first for Unix sockets, or second for TCP socket,
32973 are options.
32974 The supported options are:
32975 .code
32976 pri=<priority>      Selection priority
32977 weight=<value>      Selection bias
32978 time=<start>-<end>  Use only between these times of day
32979 retry=<timespec>    Retry on connect fail
32980 tmo=<timespec>      Connection time limit
32981 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
32982 .endd
32983
32984 The &`pri`& option specifies a priority for the server within the list,
32985 higher values being tried first.
32986 The default priority is 1.
32987
32988 The &`weight`& option specifies a selection bias.
32989 Within a priority set
32990 servers are queried in a random fashion, weighted by this value.
32991 The default value for selection bias is 1.
32992
32993 Time specifications for the &`time`& option are <hour>.<minute>.<second>
32994 in the local time zone; each element being one or more digits.
32995 Either the seconds or both minutes and seconds, plus the leading &`.`&
32996 characters, may be omitted and will be taken as zero.
32997
32998 Timeout specifications for the &`retry`& and &`tmo`& options
32999 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33000
33001 The &`tmo`& option specifies an overall timeout for communication.
33002 The default value is two minutes.
33003
33004 The &`retry`& option specifies a time after which a single retry for
33005 a failed connect is made.
33006 The default is to not retry.
33007
33008 The &%spamd_address%& variable is expanded before use if it starts with
33009 a dollar sign. In this case, the expansion may return a string that is
33010 used as the list so that multiple spamd servers can be the result of an
33011 expansion.
33012
33013 .vindex "&$callout_address$&"
33014 When a connection is made to the server the expansion variable &$callout_address$&
33015 is set to record the actual address used.
33016
33017 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33018 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33019 .code
33020 deny message = This message was classified as SPAM
33021      spam = joe
33022 .endd
33023 The right-hand side of the &%spam%& condition specifies a name. This is
33024 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33025 to scan using a specific profile, but rather use the SpamAssassin system-wide
33026 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33027 Rspamd does not use this setting. However, you must put something on the
33028 right-hand side.
33029
33030 The name allows you to use per-domain or per-user antispam profiles in
33031 principle, but this is not straightforward in practice, because a message may
33032 have multiple recipients, not necessarily all in the same domain. Because the
33033 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33034 read the contents of the message, the variables &$local_part$& and &$domain$&
33035 are not set.
33036 Careful enforcement of single-recipient messages
33037 (e.g. by responding with defer in the recipient ACL for all recipients
33038 after the first),
33039 or the use of PRDR,
33040 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33041 are needed to use this feature.
33042
33043 The right-hand side of the &%spam%& condition is expanded before being used, so
33044 you can put lookups or conditions there. When the right-hand side evaluates to
33045 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33046
33047
33048 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33049 large ones may cause significant performance degradation. As most spam messages
33050 are quite small, it is recommended that you do not scan the big ones. For
33051 example:
33052 .code
33053 deny message = This message was classified as SPAM
33054      condition = ${if < {$message_size}{10K}}
33055      spam = nobody
33056 .endd
33057
33058 The &%spam%& condition returns true if the threshold specified in the user's
33059 SpamAssassin profile has been matched or exceeded. If you want to use the
33060 &%spam%& condition for its side effects (see the variables below), you can make
33061 it always return &"true"& by appending &`:true`& to the username.
33062
33063 .cindex "spam scanning" "returned variables"
33064 When the &%spam%& condition is run, it sets up a number of expansion
33065 variables.
33066 Except for &$spam_report$&,
33067 these variables are saved with the received message so are
33068 available for use at delivery time.
33069
33070 .vlist
33071 .vitem &$spam_score$&
33072 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33073 for inclusion in log or reject messages.
33074
33075 .vitem &$spam_score_int$&
33076 The spam score of the message, multiplied by ten, as an integer value. For
33077 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33078 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33079 The integer value is useful for numeric comparisons in conditions.
33080
33081 .vitem &$spam_bar$&
33082 A string consisting of a number of &"+"& or &"-"& characters, representing the
33083 integer part of the spam score value. A spam score of 4.4 would have a
33084 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33085 headers, since MUAs can match on such strings. The maximum length of the
33086 spam bar is 50 characters.
33087
33088 .vitem &$spam_report$&
33089 A multiline text table, containing the full SpamAssassin report for the
33090 message. Useful for inclusion in headers or reject messages.
33091 This variable is only usable in a DATA-time ACL.
33092 Beware that SpamAssassin may return non-ASCII characters, especially
33093 when running in country-specific locales, which are not legal
33094 unencoded in headers.
33095
33096 .vitem &$spam_action$&
33097 For SpamAssassin either 'reject' or 'no action' depending on the
33098 spam score versus threshold.
33099 For Rspamd, the recommended action.
33100
33101 .endlist
33102
33103 The &%spam%& condition caches its results unless expansion in
33104 spamd_address was used. If you call it again with the same user name, it
33105 does not scan again, but rather returns the same values as before.
33106
33107 The &%spam%& condition returns DEFER if there is any error while running
33108 the message through SpamAssassin or if the expansion of spamd_address
33109 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33110 statement block), append &`/defer_ok`& to the right-hand side of the
33111 spam condition, like this:
33112 .code
33113 deny message = This message was classified as SPAM
33114      spam    = joe/defer_ok
33115 .endd
33116 This causes messages to be accepted even if there is a problem with &%spamd%&.
33117
33118 Here is a longer, commented example of the use of the &%spam%&
33119 condition:
33120 .code
33121 # put headers in all messages (no matter if spam or not)
33122 warn  spam = nobody:true
33123       add_header = X-Spam-Score: $spam_score ($spam_bar)
33124       add_header = X-Spam-Report: $spam_report
33125
33126 # add second subject line with *SPAM* marker when message
33127 # is over threshold
33128 warn  spam = nobody
33129       add_header = Subject: *SPAM* $h_Subject:
33130
33131 # reject spam at high scores (> 12)
33132 deny  message = This message scored $spam_score spam points.
33133       spam = nobody:true
33134       condition = ${if >{$spam_score_int}{120}{1}{0}}
33135 .endd
33136
33137
33138
33139 .section "Scanning MIME parts" "SECTscanmimepart"
33140 .cindex "content scanning" "MIME parts"
33141 .cindex "MIME content scanning"
33142 .oindex "&%acl_smtp_mime%&"
33143 .oindex "&%acl_not_smtp_mime%&"
33144 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33145 each MIME part of an SMTP message, including multipart types, in the sequence
33146 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33147 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33148 options may both refer to the same ACL if you want the same processing in both
33149 cases.
33150
33151 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33152 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33153 the case of a non-SMTP message. However, a MIME ACL is called only if the
33154 message contains a &'Content-Type:'& header line. When a call to a MIME
33155 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33156 result code is sent to the client. In the case of an SMTP message, the
33157 &%acl_smtp_data%& ACL is not called when this happens.
33158
33159 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33160 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33161 condition to match against the raw MIME part. You can also use the
33162 &%mime_regex%& condition to match against the decoded MIME part (see section
33163 &<<SECTscanregex>>&).
33164
33165 At the start of a MIME ACL, a number of variables are set from the header
33166 information for the relevant MIME part. These are described below. The contents
33167 of the MIME part are not by default decoded into a disk file except for MIME
33168 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33169 part into a disk file, you can use the &%decode%& condition. The general
33170 syntax is:
33171 .display
33172 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33173 .endd
33174 The right hand side is expanded before use. After expansion,
33175 the value can be:
33176
33177 .olist
33178 &"0"& or &"false"&, in which case no decoding is done.
33179 .next
33180 The string &"default"&. In that case, the file is put in the temporary
33181 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33182 a sequential filename consisting of the message id and a sequence number. The
33183 full path and name is available in &$mime_decoded_filename$& after decoding.
33184 .next
33185 A full path name starting with a slash. If the full name is an existing
33186 directory, it is used as a replacement for the default directory. The filename
33187 is then sequentially assigned. If the path does not exist, it is used as
33188 the full path and filename.
33189 .next
33190 If the string does not start with a slash, it is used as the
33191 filename, and the default path is then used.
33192 .endlist
33193 The &%decode%& condition normally succeeds. It is only false for syntax
33194 errors or unusual circumstances such as memory shortages. You can easily decode
33195 a file with its original, proposed filename using
33196 .code
33197 decode = $mime_filename
33198 .endd
33199 However, you should keep in mind that &$mime_filename$& might contain
33200 anything. If you place files outside of the default path, they are not
33201 automatically unlinked.
33202
33203 For RFC822 attachments (these are messages attached to messages, with a
33204 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33205 as for the primary message, only that the &$mime_is_rfc822$& expansion
33206 variable is set (see below). Attached messages are always decoded to disk
33207 before being checked, and the files are unlinked once the check is done.
33208
33209 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33210 used to match regular expressions against raw and decoded MIME parts,
33211 respectively. They are described in section &<<SECTscanregex>>&.
33212
33213 .cindex "MIME content scanning" "returned variables"
33214 The following list describes all expansion variables that are
33215 available in the MIME ACL:
33216
33217 .vlist
33218 .vitem &$mime_boundary$&
33219 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33220 have a boundary string, which is stored in this variable. If the current part
33221 has no boundary parameter in the &'Content-Type:'& header, this variable
33222 contains the empty string.
33223
33224 .vitem &$mime_charset$&
33225 This variable contains the character set identifier, if one was found in the
33226 &'Content-Type:'& header. Examples for charset identifiers are:
33227 .code
33228 us-ascii
33229 gb2312 (Chinese)
33230 iso-8859-1
33231 .endd
33232 Please note that this value is not normalized, so you should do matches
33233 case-insensitively.
33234
33235 .vitem &$mime_content_description$&
33236 This variable contains the normalized content of the &'Content-Description:'&
33237 header. It can contain a human-readable description of the parts content. Some
33238 implementations repeat the filename for attachments here, but they are usually
33239 only used for display purposes.
33240
33241 .vitem &$mime_content_disposition$&
33242 This variable contains the normalized content of the &'Content-Disposition:'&
33243 header. You can expect strings like &"attachment"& or &"inline"& here.
33244
33245 .vitem &$mime_content_id$&
33246 This variable contains the normalized content of the &'Content-ID:'& header.
33247 This is a unique ID that can be used to reference a part from another part.
33248
33249 .vitem &$mime_content_size$&
33250 This variable is set only after the &%decode%& modifier (see above) has been
33251 successfully run. It contains the size of the decoded part in kilobytes. The
33252 size is always rounded up to full kilobytes, so only a completely empty part
33253 has a &$mime_content_size$& of zero.
33254
33255 .vitem &$mime_content_transfer_encoding$&
33256 This variable contains the normalized content of the
33257 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33258 type. Typical values are &"base64"& and &"quoted-printable"&.
33259
33260 .vitem &$mime_content_type$&
33261 If the MIME part has a &'Content-Type:'& header, this variable contains its
33262 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33263 are some examples of popular MIME types, as they may appear in this variable:
33264 .code
33265 text/plain
33266 text/html
33267 application/octet-stream
33268 image/jpeg
33269 audio/midi
33270 .endd
33271 If the MIME part has no &'Content-Type:'& header, this variable contains the
33272 empty string.
33273
33274 .vitem &$mime_decoded_filename$&
33275 This variable is set only after the &%decode%& modifier (see above) has been
33276 successfully run. It contains the full path and filename of the file
33277 containing the decoded data.
33278 .endlist
33279
33280 .cindex "RFC 2047"
33281 .vlist
33282 .vitem &$mime_filename$&
33283 This is perhaps the most important of the MIME variables. It contains a
33284 proposed filename for an attachment, if one was found in either the
33285 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33286 RFC2047
33287 or RFC2231
33288 decoded, but no additional sanity checks are done.
33289  If no filename was
33290 found, this variable contains the empty string.
33291
33292 .vitem &$mime_is_coverletter$&
33293 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33294 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33295 content in the cover letter, while not restricting attachments at all.
33296
33297 The variable contains 1 (true) for a MIME part believed to be part of the
33298 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33299 follows:
33300
33301 .olist
33302 The outermost MIME part of a message is always a cover letter.
33303
33304 .next
33305 If a multipart/alternative or multipart/related MIME part is a cover letter,
33306 so are all MIME subparts within that multipart.
33307
33308 .next
33309 If any other multipart is a cover letter, the first subpart is a cover letter,
33310 and the rest are attachments.
33311
33312 .next
33313 All parts contained within an attachment multipart are attachments.
33314 .endlist olist
33315
33316 As an example, the following will ban &"HTML mail"& (including that sent with
33317 alternative plain text), while allowing HTML files to be attached. HTML
33318 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33319 .code
33320 deny message = HTML mail is not accepted here
33321 !condition = $mime_is_rfc822
33322 condition = $mime_is_coverletter
33323 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33324 .endd
33325 .vitem &$mime_is_multipart$&
33326 This variable has the value 1 (true) when the current part has the main type
33327 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33328 Since multipart entities only serve as containers for other parts, you may not
33329 want to carry out specific actions on them.
33330
33331 .vitem &$mime_is_rfc822$&
33332 This variable has the value 1 (true) if the current part is not a part of the
33333 checked message itself, but part of an attached message. Attached message
33334 decoding is fully recursive.
33335
33336 .vitem &$mime_part_count$&
33337 This variable is a counter that is raised for each processed MIME part. It
33338 starts at zero for the very first part (which is usually a multipart). The
33339 counter is per-message, so it is reset when processing RFC822 attachments (see
33340 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33341 complete, so you can use it in the DATA ACL to determine the number of MIME
33342 parts of a message. For non-MIME messages, this variable contains the value -1.
33343 .endlist
33344
33345
33346
33347 .section "Scanning with regular expressions" "SECTscanregex"
33348 .cindex "content scanning" "with regular expressions"
33349 .cindex "regular expressions" "content scanning with"
33350 You can specify your own custom regular expression matches on the full body of
33351 the message, or on individual MIME parts.
33352
33353 The &%regex%& condition takes one or more regular expressions as arguments and
33354 matches them against the full message (when called in the DATA ACL) or a raw
33355 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33356 linewise, with a maximum line length of 32K characters. That means you cannot
33357 have multiline matches with the &%regex%& condition.
33358
33359 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33360 to 32K of decoded content (the whole content at once, not linewise). If the
33361 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33362 is decoded automatically when &%mime_regex%& is executed (using default path
33363 and filename values). If the decoded data is larger than  32K, only the first
33364 32K characters are checked.
33365
33366 The regular expressions are passed as a colon-separated list. To include a
33367 literal colon, you must double it. Since the whole right-hand side string is
33368 expanded before being used, you must also escape dollar signs and backslashes
33369 with more backslashes, or use the &`\N`& facility to disable expansion.
33370 Here is a simple example that contains two regular expressions:
33371 .code
33372 deny message = contains blacklisted regex ($regex_match_string)
33373      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33374 .endd
33375 The conditions returns true if any one of the regular expressions matches. The
33376 &$regex_match_string$& expansion variable is then set up and contains the
33377 matching regular expression.
33378 The expansion variables &$regex1$& &$regex2$& etc
33379 are set to any substrings captured by the regular expression.
33380
33381 &*Warning*&: With large messages, these conditions can be fairly
33382 CPU-intensive.
33383
33384 .ecindex IIDcosca
33385
33386
33387
33388
33389 . ////////////////////////////////////////////////////////////////////////////
33390 . ////////////////////////////////////////////////////////////////////////////
33391
33392 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33393          "Local scan function"
33394 .scindex IIDlosca "&[local_scan()]& function" "description of"
33395 .cindex "customizing" "input scan using C function"
33396 .cindex "policy control" "by local scan function"
33397 In these days of email worms, viruses, and ever-increasing spam, some sites
33398 want to apply a lot of checking to messages before accepting them.
33399
33400 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33401 passing messages to external virus and spam scanning software. You can also do
33402 a certain amount in Exim itself through string expansions and the &%condition%&
33403 condition in the ACL that runs after the SMTP DATA command or the ACL for
33404 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33405
33406 To allow for further customization to a site's own requirements, there is the
33407 possibility of linking Exim with a private message scanning function, written
33408 in C. If you want to run code that is written in something other than C, you
33409 can of course use a little C stub to call it.
33410
33411 The local scan function is run once for every incoming message, at the point
33412 when Exim is just about to accept the message.
33413 It can therefore be used to control non-SMTP messages from local processes as
33414 well as messages arriving via SMTP.
33415
33416 Exim applies a timeout to calls of the local scan function, and there is an
33417 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33418 Zero means &"no timeout"&.
33419 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33420 before calling the local scan function, so that the most common types of crash
33421 are caught. If the timeout is exceeded or one of those signals is caught, the
33422 incoming message is rejected with a temporary error if it is an SMTP message.
33423 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33424 code. The incident is logged on the main and reject logs.
33425
33426
33427
33428 .section "Building Exim to use a local scan function" "SECID207"
33429 .cindex "&[local_scan()]& function" "building Exim to use"
33430 To make use of the local scan function feature, you must tell Exim where your
33431 function is before building Exim, by setting
33432 both HAVE_LOCAL_SCAN and
33433 LOCAL_SCAN_SOURCE in your
33434 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33435 directory, so you might set
33436 .code
33437 HAVE_LOCAL_SCAN=yes
33438 LOCAL_SCAN_SOURCE=Local/local_scan.c
33439 .endd
33440 for example. The function must be called &[local_scan()]&. It is called by
33441 Exim after it has received a message, when the success return code is about to
33442 be sent. This is after all the ACLs have been run. The return code from your
33443 function controls whether the message is actually accepted or not. There is a
33444 commented template function (that just accepts the message) in the file
33445 _src/local_scan.c_.
33446
33447 If you want to make use of Exim's runtime configuration file to set options
33448 for your &[local_scan()]& function, you must also set
33449 .code
33450 LOCAL_SCAN_HAS_OPTIONS=yes
33451 .endd
33452 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33453
33454
33455
33456
33457 .section "API for local_scan()" "SECTapiforloc"
33458 .cindex "&[local_scan()]& function" "API description"
33459 .cindex &%dlfunc%& "API description"
33460 You must include this line near the start of your code:
33461 .code
33462 #include "local_scan.h"
33463 .endd
33464 This header file defines a number of variables and other values, and the
33465 prototype for the function itself. Exim is coded to use unsigned char values
33466 almost exclusively, and one of the things this header defines is a shorthand
33467 for &`unsigned char`& called &`uschar`&.
33468 It also contains the following macro definitions, to simplify casting character
33469 strings and pointers to character strings:
33470 .code
33471 #define CS   (char *)
33472 #define CCS  (const char *)
33473 #define CSS  (char **)
33474 #define US   (unsigned char *)
33475 #define CUS  (const unsigned char *)
33476 #define USS  (unsigned char **)
33477 .endd
33478 The function prototype for &[local_scan()]& is:
33479 .code
33480 extern int local_scan(int fd, uschar **return_text);
33481 .endd
33482 The arguments are as follows:
33483
33484 .ilist
33485 &%fd%& is a file descriptor for the file that contains the body of the message
33486 (the -D file). The file is open for reading and writing, but updating it is not
33487 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33488
33489 The descriptor is positioned at character 19 of the file, which is the first
33490 character of the body itself, because the first 19 characters are the message
33491 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33492 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33493 case this changes in some future version.
33494 .next
33495 &%return_text%& is an address which you can use to return a pointer to a text
33496 string at the end of the function. The value it points to on entry is NULL.
33497 .endlist
33498
33499 The function must return an &%int%& value which is one of the following macros:
33500
33501 .vlist
33502 .vitem &`LOCAL_SCAN_ACCEPT`&
33503 .vindex "&$local_scan_data$&"
33504 The message is accepted. If you pass back a string of text, it is saved with
33505 the message, and made available in the variable &$local_scan_data$&. No
33506 newlines are permitted (if there are any, they are turned into spaces) and the
33507 maximum length of text is 1000 characters.
33508
33509 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33510 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33511 queued without immediate delivery, and is frozen.
33512
33513 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33514 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33515 queued without immediate delivery.
33516
33517 .vitem &`LOCAL_SCAN_REJECT`&
33518 The message is rejected; the returned text is used as an error message which is
33519 passed back to the sender and which is also logged. Newlines are permitted &--
33520 they cause a multiline response for SMTP rejections, but are converted to
33521 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33522 used.
33523
33524 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33525 The message is temporarily rejected; the returned text is used as an error
33526 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33527 problem"& is used.
33528
33529 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33530 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33531 message is not written to the reject log. It has the effect of unsetting the
33532 &%rejected_header%& log selector for just this rejection. If
33533 &%rejected_header%& is already unset (see the discussion of the
33534 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33535 same as LOCAL_SCAN_REJECT.
33536
33537 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33538 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33539 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33540 .endlist
33541
33542 If the message is not being received by interactive SMTP, rejections are
33543 reported by writing to &%stderr%& or by sending an email, as configured by the
33544 &%-oe%& command line options.
33545
33546
33547
33548 .section "Configuration options for local_scan()" "SECTconoptloc"
33549 .cindex "&[local_scan()]& function" "configuration options"
33550 It is possible to have option settings in the main configuration file
33551 that set values in static variables in the &[local_scan()]& module. If you
33552 want to do this, you must have the line
33553 .code
33554 LOCAL_SCAN_HAS_OPTIONS=yes
33555 .endd
33556 in your &_Local/Makefile_& when you build Exim. (This line is in
33557 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33558 file, you must define static variables to hold the option values, and a table
33559 to define them.
33560
33561 The table must be a vector called &%local_scan_options%&, of type
33562 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33563 and a pointer to the variable that holds the value. The entries must appear in
33564 alphabetical order. Following &%local_scan_options%& you must also define a
33565 variable called &%local_scan_options_count%& that contains the number of
33566 entries in the table. Here is a short example, showing two kinds of option:
33567 .code
33568 static int my_integer_option = 42;
33569 static uschar *my_string_option = US"a default string";
33570
33571 optionlist local_scan_options[] = {
33572   { "my_integer", opt_int,       &my_integer_option },
33573   { "my_string",  opt_stringptr, &my_string_option }
33574 };
33575
33576 int local_scan_options_count =
33577   sizeof(local_scan_options)/sizeof(optionlist);
33578 .endd
33579 The values of the variables can now be changed from Exim's runtime
33580 configuration file by including a local scan section as in this example:
33581 .code
33582 begin local_scan
33583 my_integer = 99
33584 my_string = some string of text...
33585 .endd
33586 The available types of option data are as follows:
33587
33588 .vlist
33589 .vitem &*opt_bool*&
33590 This specifies a boolean (true/false) option. The address should point to a
33591 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33592 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33593 whether such a variable has been set at all, you can initialize it to
33594 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33595 values.)
33596
33597 .vitem &*opt_fixed*&
33598 This specifies a fixed point number, such as is used for load averages.
33599 The address should point to a variable of type &`int`&. The value is stored
33600 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33601
33602 .vitem &*opt_int*&
33603 This specifies an integer; the address should point to a variable of type
33604 &`int`&. The value may be specified in any of the integer formats accepted by
33605 Exim.
33606
33607 .vitem &*opt_mkint*&
33608 This is the same as &%opt_int%&, except that when such a value is output in a
33609 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33610 printed with the suffix K or M.
33611
33612 .vitem &*opt_octint*&
33613 This also specifies an integer, but the value is always interpreted as an
33614 octal integer, whether or not it starts with the digit zero, and it is
33615 always output in octal.
33616
33617 .vitem &*opt_stringptr*&
33618 This specifies a string value; the address must be a pointer to a
33619 variable that points to a string (for example, of type &`uschar *`&).
33620
33621 .vitem &*opt_time*&
33622 This specifies a time interval value. The address must point to a variable of
33623 type &`int`&. The value that is placed there is a number of seconds.
33624 .endlist
33625
33626 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33627 out the values of all the &[local_scan()]& options.
33628
33629
33630
33631 .section "Available Exim variables" "SECID208"
33632 .cindex "&[local_scan()]& function" "available Exim variables"
33633 The header &_local_scan.h_& gives you access to a number of C variables. These
33634 are the only ones that are guaranteed to be maintained from release to release.
33635 Note, however, that you can obtain the value of any Exim expansion variable,
33636 including &$recipients$&, by calling &'expand_string()'&. The exported
33637 C variables are as follows:
33638
33639 .vlist
33640 .vitem &*int&~body_linecount*&
33641 This variable contains the number of lines in the message's body.
33642 It is not valid if the &%spool_files_wireformat%& option is used.
33643
33644 .vitem &*int&~body_zerocount*&
33645 This variable contains the number of binary zero bytes in the message's body.
33646 It is not valid if the &%spool_files_wireformat%& option is used.
33647
33648 .vitem &*unsigned&~int&~debug_selector*&
33649 This variable is set to zero when no debugging is taking place. Otherwise, it
33650 is a bitmap of debugging selectors. Two bits are identified for use in
33651 &[local_scan()]&; they are defined as macros:
33652
33653 .ilist
33654 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33655 testing option that is not privileged &-- any caller may set it. All the
33656 other selector bits can be set only by admin users.
33657
33658 .next
33659 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33660 by the &`+local_scan`& debug selector. It is not included in the default set
33661 of debugging bits.
33662 .endlist ilist
33663
33664 Thus, to write to the debugging output only when &`+local_scan`& has been
33665 selected, you should use code like this:
33666 .code
33667 if ((debug_selector & D_local_scan) != 0)
33668   debug_printf("xxx", ...);
33669 .endd
33670 .vitem &*uschar&~*expand_string_message*&
33671 After a failing call to &'expand_string()'& (returned value NULL), the
33672 variable &%expand_string_message%& contains the error message, zero-terminated.
33673
33674 .vitem &*header_line&~*header_list*&
33675 A pointer to a chain of header lines. The &%header_line%& structure is
33676 discussed below.
33677
33678 .vitem &*header_line&~*header_last*&
33679 A pointer to the last of the header lines.
33680
33681 .vitem &*uschar&~*headers_charset*&
33682 The value of the &%headers_charset%& configuration option.
33683
33684 .vitem &*BOOL&~host_checking*&
33685 This variable is TRUE during a host checking session that is initiated by the
33686 &%-bh%& command line option.
33687
33688 .vitem &*uschar&~*interface_address*&
33689 The IP address of the interface that received the message, as a string. This
33690 is NULL for locally submitted messages.
33691
33692 .vitem &*int&~interface_port*&
33693 The port on which this message was received. When testing with the &%-bh%&
33694 command line option, the value of this variable is -1 unless a port has been
33695 specified via the &%-oMi%& option.
33696
33697 .vitem &*uschar&~*message_id*&
33698 This variable contains Exim's message id for the incoming message (the value of
33699 &$message_exim_id$&) as a zero-terminated string.
33700
33701 .vitem &*uschar&~*received_protocol*&
33702 The name of the protocol by which the message was received.
33703
33704 .vitem &*int&~recipients_count*&
33705 The number of accepted recipients.
33706
33707 .vitem &*recipient_item&~*recipients_list*&
33708 .cindex "recipient" "adding in local scan"
33709 .cindex "recipient" "removing in local scan"
33710 The list of accepted recipients, held in a vector of length
33711 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33712 can add additional recipients by calling &'receive_add_recipient()'& (see
33713 below). You can delete recipients by removing them from the vector and
33714 adjusting the value in &%recipients_count%&. In particular, by setting
33715 &%recipients_count%& to zero you remove all recipients. If you then return the
33716 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33717 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33718 and then call &'receive_add_recipient()'& as often as needed.
33719
33720 .vitem &*uschar&~*sender_address*&
33721 The envelope sender address. For bounce messages this is the empty string.
33722
33723 .vitem &*uschar&~*sender_host_address*&
33724 The IP address of the sending host, as a string. This is NULL for
33725 locally-submitted messages.
33726
33727 .vitem &*uschar&~*sender_host_authenticated*&
33728 The name of the authentication mechanism that was used, or NULL if the message
33729 was not received over an authenticated SMTP connection.
33730
33731 .vitem &*uschar&~*sender_host_name*&
33732 The name of the sending host, if known.
33733
33734 .vitem &*int&~sender_host_port*&
33735 The port on the sending host.
33736
33737 .vitem &*BOOL&~smtp_input*&
33738 This variable is TRUE for all SMTP input, including BSMTP.
33739
33740 .vitem &*BOOL&~smtp_batched_input*&
33741 This variable is TRUE for BSMTP input.
33742
33743 .vitem &*int&~store_pool*&
33744 The contents of this variable control which pool of memory is used for new
33745 requests. See section &<<SECTmemhanloc>>& for details.
33746 .endlist
33747
33748
33749 .section "Structure of header lines" "SECID209"
33750 The &%header_line%& structure contains the members listed below.
33751 You can add additional header lines by calling the &'header_add()'& function
33752 (see below). You can cause header lines to be ignored (deleted) by setting
33753 their type to *.
33754
33755
33756 .vlist
33757 .vitem &*struct&~header_line&~*next*&
33758 A pointer to the next header line, or NULL for the last line.
33759
33760 .vitem &*int&~type*&
33761 A code identifying certain headers that Exim recognizes. The codes are printing
33762 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33763 Notice in particular that any header line whose type is * is not transmitted
33764 with the message. This flagging is used for header lines that have been
33765 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33766 lines.) Effectively, * means &"deleted"&.
33767
33768 .vitem &*int&~slen*&
33769 The number of characters in the header line, including the terminating and any
33770 internal newlines.
33771
33772 .vitem &*uschar&~*text*&
33773 A pointer to the text of the header. It always ends with a newline, followed by
33774 a zero byte. Internal newlines are preserved.
33775 .endlist
33776
33777
33778
33779 .section "Structure of recipient items" "SECID210"
33780 The &%recipient_item%& structure contains these members:
33781
33782 .vlist
33783 .vitem &*uschar&~*address*&
33784 This is a pointer to the recipient address as it was received.
33785
33786 .vitem &*int&~pno*&
33787 This is used in later Exim processing when top level addresses are created by
33788 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
33789 and must always contain -1 at this stage.
33790
33791 .vitem &*uschar&~*errors_to*&
33792 If this value is not NULL, bounce messages caused by failing to deliver to the
33793 recipient are sent to the address it contains. In other words, it overrides the
33794 envelope sender for this one recipient. (Compare the &%errors_to%& generic
33795 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
33796 an unqualified address, Exim qualifies it using the domain from
33797 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
33798 is NULL for all recipients.
33799 .endlist
33800
33801
33802
33803 .section "Available Exim functions" "SECID211"
33804 .cindex "&[local_scan()]& function" "available Exim functions"
33805 The header &_local_scan.h_& gives you access to a number of Exim functions.
33806 These are the only ones that are guaranteed to be maintained from release to
33807 release:
33808
33809 .vlist
33810 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
33811        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
33812
33813 This function creates a child process that runs the command specified by
33814 &%argv%&. The environment for the process is specified by &%envp%&, which can
33815 be NULL if no environment variables are to be passed. A new umask is supplied
33816 for the process in &%newumask%&.
33817
33818 Pipes to the standard input and output of the new process are set up
33819 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
33820 standard error is cloned to the standard output. If there are any file
33821 descriptors &"in the way"& in the new process, they are closed. If the final
33822 argument is TRUE, the new process is made into a process group leader.
33823
33824 The function returns the pid of the new process, or -1 if things go wrong.
33825
33826 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
33827 This function waits for a child process to terminate, or for a timeout (in
33828 seconds) to expire. A timeout value of zero means wait as long as it takes. The
33829 return value is as follows:
33830
33831 .ilist
33832 >= 0
33833
33834 The process terminated by a normal exit and the value is the process
33835 ending status.
33836
33837 .next
33838 < 0 and > &--256
33839
33840 The process was terminated by a signal and the value is the negation of the
33841 signal number.
33842
33843 .next
33844 &--256
33845
33846 The process timed out.
33847 .next
33848 &--257
33849
33850 The was some other error in wait(); &%errno%& is still set.
33851 .endlist
33852
33853 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
33854 This function provide you with a means of submitting a new message to
33855 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
33856 want, but this packages it all up for you.) The function creates a pipe,
33857 forks a subprocess that is running
33858 .code
33859 exim -t -oem -oi -f <>
33860 .endd
33861 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
33862 that is connected to the standard input. The yield of the function is the PID
33863 of the subprocess. You can then write a message to the file descriptor, with
33864 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
33865
33866 When you have finished, call &'child_close()'& to wait for the process to
33867 finish and to collect its ending status. A timeout value of zero is usually
33868 fine in this circumstance. Unless you have made a mistake with the recipient
33869 addresses, you should get a return code of zero.
33870
33871
33872 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
33873        *sender_authentication)*&
33874 This function is a more sophisticated version of &'child_open()'&. The command
33875 that it runs is:
33876 .display
33877 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
33878 .endd
33879 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
33880
33881
33882 .vitem &*void&~debug_printf(char&~*,&~...)*&
33883 This is Exim's debugging function, with arguments as for &'(printf()'&. The
33884 output is written to the standard error stream. If no debugging is selected,
33885 calls to &'debug_printf()'& have no effect. Normally, you should make calls
33886 conditional on the &`local_scan`& debug selector by coding like this:
33887 .code
33888 if ((debug_selector & D_local_scan) != 0)
33889   debug_printf("xxx", ...);
33890 .endd
33891
33892 .vitem &*uschar&~*expand_string(uschar&~*string)*&
33893 This is an interface to Exim's string expansion code. The return value is the
33894 expanded string, or NULL if there was an expansion failure.
33895 The C variable &%expand_string_message%& contains an error message after an
33896 expansion failure. If expansion does not change the string, the return value is
33897 the pointer to the input string. Otherwise, the return value points to a new
33898 block of memory that was obtained by a call to &'store_get()'&. See section
33899 &<<SECTmemhanloc>>& below for a discussion of memory handling.
33900
33901 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
33902 This function allows you to an add additional header line at the end of the
33903 existing ones. The first argument is the type, and should normally be a space
33904 character. The second argument is a format string and any number of
33905 substitution arguments as for &[sprintf()]&. You may include internal newlines
33906 if you want, and you must ensure that the string ends with a newline.
33907
33908 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
33909         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
33910 This function adds a new header line at a specified point in the header
33911 chain. The header itself is specified as for &'header_add()'&.
33912
33913 If &%name%& is NULL, the new header is added at the end of the chain if
33914 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
33915 NULL, the header lines are searched for the first non-deleted header that
33916 matches the name. If one is found, the new header is added before it if
33917 &%after%& is false. If &%after%& is true, the new header is added after the
33918 found header and any adjacent subsequent ones with the same name (even if
33919 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
33920 option controls where the header is added. If it is true, addition is at the
33921 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
33922 headers, or at the top if there are no &'Received:'& headers, you could use
33923 .code
33924 header_add_at_position(TRUE, US"Received", TRUE,
33925   ' ', "X-xxx: ...");
33926 .endd
33927 Normally, there is always at least one non-deleted &'Received:'& header, but
33928 there may not be if &%received_header_text%& expands to an empty string.
33929
33930
33931 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
33932 This function removes header lines. If &%occurrence%& is zero or negative, all
33933 occurrences of the header are removed. If occurrence is greater than zero, that
33934 particular instance of the header is removed. If no header(s) can be found that
33935 match the specification, the function does nothing.
33936
33937
33938 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
33939         int&~length,&~BOOL&~notdel)*&"
33940 This function tests whether the given header has the given name. It is not just
33941 a string comparison, because white space is permitted between the name and the
33942 colon. If the &%notdel%& argument is true, a false return is forced for all
33943 &"deleted"& headers; otherwise they are not treated specially. For example:
33944 .code
33945 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
33946 .endd
33947 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
33948 .cindex "base64 encoding" "functions for &[local_scan()]& use"
33949 This function base64-encodes a string, which is passed by address and length.
33950 The text may contain bytes of any value, including zero. The result is passed
33951 back in dynamic memory that is obtained by calling &'store_get()'&. It is
33952 zero-terminated.
33953
33954 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
33955 This function decodes a base64-encoded string. Its arguments are a
33956 zero-terminated base64-encoded string and the address of a variable that is set
33957 to point to the result, which is in dynamic memory. The length of the decoded
33958 string is the yield of the function. If the input is invalid base64 data, the
33959 yield is -1. A zero byte is added to the end of the output string to make it
33960 easy to interpret as a C string (assuming it contains no zeros of its own). The
33961 added zero byte is not included in the returned count.
33962
33963 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
33964 This function checks for a match in a domain list. Domains are always
33965 matched caselessly. The return value is one of the following:
33966 .display
33967 &`OK     `& match succeeded
33968 &`FAIL   `& match failed
33969 &`DEFER  `& match deferred
33970 .endd
33971 DEFER is usually caused by some kind of lookup defer, such as the
33972 inability to contact a database.
33973
33974 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
33975         BOOL&~caseless)*&"
33976 This function checks for a match in a local part list. The third argument
33977 controls case-sensitivity. The return values are as for
33978 &'lss_match_domain()'&.
33979
33980 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
33981         BOOL&~caseless)*&"
33982 This function checks for a match in an address list. The third argument
33983 controls the case-sensitivity of the local part match. The domain is always
33984 matched caselessly. The return values are as for &'lss_match_domain()'&.
33985
33986 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
33987         uschar&~*list)*&"
33988 This function checks for a match in a host list. The most common usage is
33989 expected to be
33990 .code
33991 lss_match_host(sender_host_name, sender_host_address, ...)
33992 .endd
33993 .vindex "&$sender_host_address$&"
33994 An empty address field matches an empty item in the host list. If the host name
33995 is NULL, the name corresponding to &$sender_host_address$& is automatically
33996 looked up if a host name is required to match an item in the list. The return
33997 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
33998 returns ERROR in the case when it had to look up a host name, but the lookup
33999 failed.
34000
34001 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34002         *format,&~...)*&"
34003 This function writes to Exim's log files. The first argument should be zero (it
34004 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34005 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34006 them. It specifies to which log or logs the message is written. The remaining
34007 arguments are a format and relevant insertion arguments. The string should not
34008 contain any newlines, not even at the end.
34009
34010
34011 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34012 This function adds an additional recipient to the message. The first argument
34013 is the recipient address. If it is unqualified (has no domain), it is qualified
34014 with the &%qualify_recipient%& domain. The second argument must always be -1.
34015
34016 This function does not allow you to specify a private &%errors_to%& address (as
34017 described with the structure of &%recipient_item%& above), because it pre-dates
34018 the addition of that field to the structure. However, it is easy to add such a
34019 value afterwards. For example:
34020 .code
34021  receive_add_recipient(US"monitor@mydom.example", -1);
34022  recipients_list[recipients_count-1].errors_to =
34023    US"postmaster@mydom.example";
34024 .endd
34025
34026 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34027 This is a convenience function to remove a named recipient from the list of
34028 recipients. It returns true if a recipient was removed, and false if no
34029 matching recipient could be found. The argument must be a complete email
34030 address.
34031 .endlist
34032
34033
34034 .cindex "RFC 2047"
34035 .vlist
34036 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34037   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34038 This function decodes strings that are encoded according to RFC 2047. Typically
34039 these are the contents of header lines. First, each &"encoded word"& is decoded
34040 from the Q or B encoding into a byte-string. Then, if provided with the name of
34041 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34042 made  to translate the result to the named character set. If this fails, the
34043 binary string is returned with an error message.
34044
34045 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34046 maximum MIME word length is enforced. The third argument is the target
34047 encoding, or NULL if no translation is wanted.
34048
34049 .cindex "binary zero" "in RFC 2047 decoding"
34050 .cindex "RFC 2047" "binary zero in"
34051 If a binary zero is encountered in the decoded string, it is replaced by the
34052 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34053 not be 0 because header lines are handled as zero-terminated strings.
34054
34055 The function returns the result of processing the string, zero-terminated; if
34056 &%lenptr%& is not NULL, the length of the result is set in the variable to
34057 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34058
34059 If an error is encountered, the function returns NULL and uses the &%error%&
34060 argument to return an error message. The variable pointed to by &%error%& is
34061 set to NULL if there is no error; it may be set non-NULL even when the function
34062 returns a non-NULL value if decoding was successful, but there was a problem
34063 with translation.
34064
34065
34066 .vitem &*int&~smtp_fflush(void)*&
34067 This function is used in conjunction with &'smtp_printf()'&, as described
34068 below.
34069
34070 .vitem &*void&~smtp_printf(char&~*,&~...)*&
34071 The arguments of this function are like &[printf()]&; it writes to the SMTP
34072 output stream. You should use this function only when there is an SMTP output
34073 stream, that is, when the incoming message is being received via interactive
34074 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34075 is FALSE. If you want to test for an incoming message from another host (as
34076 opposed to a local process that used the &%-bs%& command line option), you can
34077 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34078 is involved.
34079
34080 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34081 output function, so it can be used for all forms of SMTP connection.
34082
34083 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34084 must start with an appropriate response code: 550 if you are going to return
34085 LOCAL_SCAN_REJECT, 451 if you are going to return
34086 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34087 initial lines of a multi-line response, the code must be followed by a hyphen
34088 to indicate that the line is not the final response line. You must also ensure
34089 that the lines you write terminate with CRLF. For example:
34090 .code
34091 smtp_printf("550-this is some extra info\r\n");
34092 return LOCAL_SCAN_REJECT;
34093 .endd
34094 Note that you can also create multi-line responses by including newlines in
34095 the data returned via the &%return_text%& argument. The added value of using
34096 &'smtp_printf()'& is that, for instance, you could introduce delays between
34097 multiple output lines.
34098
34099 The &'smtp_printf()'& function does not return any error indication, because it
34100 does not automatically flush pending output, and therefore does not test
34101 the state of the stream. (In the main code of Exim, flushing and error
34102 detection is done when Exim is ready for the next SMTP input command.) If
34103 you want to flush the output and check for an error (for example, the
34104 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34105 arguments. It flushes the output stream, and returns a non-zero value if there
34106 is an error.
34107
34108 .vitem &*void&~*store_get(int)*&
34109 This function accesses Exim's internal store (memory) manager. It gets a new
34110 chunk of memory whose size is given by the argument. Exim bombs out if it ever
34111 runs out of memory. See the next section for a discussion of memory handling.
34112
34113 .vitem &*void&~*store_get_perm(int)*&
34114 This function is like &'store_get()'&, but it always gets memory from the
34115 permanent pool. See the next section for a discussion of memory handling.
34116
34117 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34118 See below.
34119
34120 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34121 See below.
34122
34123 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34124 These three functions create strings using Exim's dynamic memory facilities.
34125 The first makes a copy of an entire string. The second copies up to a maximum
34126 number of characters, indicated by the second argument. The third uses a format
34127 and insertion arguments to create a new string. In each case, the result is a
34128 pointer to a new string in the current memory pool. See the next section for
34129 more discussion.
34130 .endlist
34131
34132
34133
34134 .section "More about Exim's memory handling" "SECTmemhanloc"
34135 .cindex "&[local_scan()]& function" "memory handling"
34136 No function is provided for freeing memory, because that is never needed.
34137 The dynamic memory that Exim uses when receiving a message is automatically
34138 recycled if another message is received by the same process (this applies only
34139 to incoming SMTP connections &-- other input methods can supply only one
34140 message at a time). After receiving the last message, a reception process
34141 terminates.
34142
34143 Because it is recycled, the normal dynamic memory cannot be used for holding
34144 data that must be preserved over a number of incoming messages on the same SMTP
34145 connection. However, Exim in fact uses two pools of dynamic memory; the second
34146 one is not recycled, and can be used for this purpose.
34147
34148 If you want to allocate memory that remains available for subsequent messages
34149 in the same SMTP connection, you should set
34150 .code
34151 store_pool = POOL_PERM
34152 .endd
34153 before calling the function that does the allocation. There is no need to
34154 restore the value if you do not need to; however, if you do want to revert to
34155 the normal pool, you can either restore the previous value of &%store_pool%& or
34156 set it explicitly to POOL_MAIN.
34157
34158 The pool setting applies to all functions that get dynamic memory, including
34159 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34160 There is also a convenience function called &'store_get_perm()'& that gets a
34161 block of memory from the permanent pool while preserving the value of
34162 &%store_pool%&.
34163 .ecindex IIDlosca
34164
34165
34166
34167
34168 . ////////////////////////////////////////////////////////////////////////////
34169 . ////////////////////////////////////////////////////////////////////////////
34170
34171 .chapter "System-wide message filtering" "CHAPsystemfilter"
34172 .scindex IIDsysfil1 "filter" "system filter"
34173 .scindex IIDsysfil2 "filtering all mail"
34174 .scindex IIDsysfil3 "system filter"
34175 The previous chapters (on ACLs and the local scan function) describe checks
34176 that can be applied to messages before they are accepted by a host. There is
34177 also a mechanism for checking messages once they have been received, but before
34178 they are delivered. This is called the &'system filter'&.
34179
34180 The system filter operates in a similar manner to users' filter files, but it
34181 is run just once per message (however many recipients the message has).
34182 It should not normally be used as a substitute for routing, because &%deliver%&
34183 commands in a system router provide new envelope recipient addresses.
34184 The system filter must be an Exim filter. It cannot be a Sieve filter.
34185
34186 The system filter is run at the start of a delivery attempt, before any routing
34187 is done. If a message fails to be completely delivered at the first attempt,
34188 the system filter is run again at the start of every retry.
34189 If you want your filter to do something only once per message, you can make use
34190 of the &%first_delivery%& condition in an &%if%& command in the filter to
34191 prevent it happening on retries.
34192
34193 .vindex "&$domain$&"
34194 .vindex "&$local_part$&"
34195 &*Warning*&: Because the system filter runs just once, variables that are
34196 specific to individual recipient addresses, such as &$local_part$& and
34197 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34198 you want to run a centrally-specified filter for each recipient address
34199 independently, you can do so by setting up a suitable &(redirect)& router, as
34200 described in section &<<SECTperaddfil>>& below.
34201
34202
34203 .section "Specifying a system filter" "SECID212"
34204 .cindex "uid (user id)" "system filter"
34205 .cindex "gid (group id)" "system filter"
34206 The name of the file that contains the system filter must be specified by
34207 setting &%system_filter%&. If you want the filter to run under a uid and gid
34208 other than root, you must also set &%system_filter_user%& and
34209 &%system_filter_group%& as appropriate. For example:
34210 .code
34211 system_filter = /etc/mail/exim.filter
34212 system_filter_user = exim
34213 .endd
34214 If a system filter generates any deliveries directly to files or pipes (via the
34215 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34216 specified by setting &%system_filter_file_transport%& and
34217 &%system_filter_pipe_transport%&, respectively. Similarly,
34218 &%system_filter_reply_transport%& must be set to handle any messages generated
34219 by the &%reply%& command.
34220
34221
34222 .section "Testing a system filter" "SECID213"
34223 You can run simple tests of a system filter in the same way as for a user
34224 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34225 are permitted only in system filters are recognized.
34226
34227 If you want to test the combined effect of a system filter and a user filter,
34228 you can use both &%-bF%& and &%-bf%& on the same command line.
34229
34230
34231
34232 .section "Contents of a system filter" "SECID214"
34233 The language used to specify system filters is the same as for users' filter
34234 files. It is described in the separate end-user document &'Exim's interface to
34235 mail filtering'&. However, there are some additional features that are
34236 available only in system filters; these are described in subsequent sections.
34237 If they are encountered in a user's filter file or when testing with &%-bf%&,
34238 they cause errors.
34239
34240 .cindex "frozen messages" "manual thaw; testing in filter"
34241 There are two special conditions which, though available in users' filter
34242 files, are designed for use in system filters. The condition &%first_delivery%&
34243 is true only for the first attempt at delivering a message, and
34244 &%manually_thawed%& is true only if the message has been frozen, and
34245 subsequently thawed by an admin user. An explicit forced delivery counts as a
34246 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34247
34248 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34249 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34250 succeed, it will not be tried again.
34251 If you want Exim to retry an unseen delivery until it succeeds, you should
34252 arrange to set it up every time the filter runs.
34253
34254 When a system filter finishes running, the values of the variables &$n0$& &--
34255 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34256 users' filter files. Thus a system filter can, for example, set up &"scores"&
34257 to which users' filter files can refer.
34258
34259
34260
34261 .section "Additional variable for system filters" "SECID215"
34262 .vindex "&$recipients$&"
34263 The expansion variable &$recipients$&, containing a list of all the recipients
34264 of the message (separated by commas and white space), is available in system
34265 filters. It is not available in users' filters for privacy reasons.
34266
34267
34268
34269 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34270 .cindex "freezing messages"
34271 .cindex "message" "freezing"
34272 .cindex "message" "forced failure"
34273 .cindex "&%fail%&" "in system filter"
34274 .cindex "&%freeze%& in system filter"
34275 .cindex "&%defer%& in system filter"
34276 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34277 always available in system filters, but are not normally enabled in users'
34278 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34279 for the &(redirect)& router.) These commands can optionally be followed by the
34280 word &%text%& and a string containing an error message, for example:
34281 .code
34282 fail text "this message looks like spam to me"
34283 .endd
34284 The keyword &%text%& is optional if the next character is a double quote.
34285
34286 The &%defer%& command defers delivery of the original recipients of the
34287 message. The &%fail%& command causes all the original recipients to be failed,
34288 and a bounce message to be created. The &%freeze%& command suspends all
34289 delivery attempts for the original recipients. In all cases, any new deliveries
34290 that are specified by the filter are attempted as normal after the filter has
34291 run.
34292
34293 The &%freeze%& command is ignored if the message has been manually unfrozen and
34294 not manually frozen since. This means that automatic freezing by a system
34295 filter can be used as a way of checking out suspicious messages. If a message
34296 is found to be all right, manually unfreezing it allows it to be delivered.
34297
34298 .cindex "log" "&%fail%& command log line"
34299 .cindex "&%fail%&" "log line; reducing"
34300 The text given with a fail command is used as part of the bounce message as
34301 well as being written to the log. If the message is quite long, this can fill
34302 up a lot of log space when such failures are common. To reduce the size of the
34303 log message, Exim interprets the text in a special way if it starts with the
34304 two characters &`<<`& and contains &`>>`& later. The text between these two
34305 strings is written to the log, and the rest of the text is used in the bounce
34306 message. For example:
34307 .code
34308 fail "<<filter test 1>>Your message is rejected \
34309      because it contains attachments that we are \
34310      not prepared to receive."
34311 .endd
34312
34313 .cindex "loop" "caused by &%fail%&"
34314 Take great care with the &%fail%& command when basing the decision to fail on
34315 the contents of the message, because the bounce message will of course include
34316 the contents of the original message and will therefore trigger the &%fail%&
34317 command again (causing a mail loop) unless steps are taken to prevent this.
34318 Testing the &%error_message%& condition is one way to prevent this. You could
34319 use, for example
34320 .code
34321 if $message_body contains "this is spam" and not error_message
34322 then fail text "spam is not wanted here" endif
34323 .endd
34324 though of course that might let through unwanted bounce messages. The
34325 alternative is clever checking of the body and/or headers to detect bounces
34326 generated by the filter.
34327
34328 The interpretation of a system filter file ceases after a
34329 &%defer%&,
34330 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34331 set up earlier in the filter file are honoured, so you can use a sequence such
34332 as
34333 .code
34334 mail ...
34335 freeze
34336 .endd
34337 to send a specified message when the system filter is freezing (or deferring or
34338 failing) a message. The normal deliveries for the message do not, of course,
34339 take place.
34340
34341
34342
34343 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34344 .cindex "header lines" "adding; in system filter"
34345 .cindex "header lines" "removing; in system filter"
34346 .cindex "filter" "header lines; adding/removing"
34347 Two filter commands that are available only in system filters are:
34348 .code
34349 headers add <string>
34350 headers remove <string>
34351 .endd
34352 The argument for the &%headers add%& is a string that is expanded and then
34353 added to the end of the message's headers. It is the responsibility of the
34354 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34355 space is ignored, and if the string is otherwise empty, or if the expansion is
34356 forced to fail, the command has no effect.
34357
34358 You can use &"\n"& within the string, followed by white space, to specify
34359 continued header lines. More than one header may be added in one command by
34360 including &"\n"& within the string without any following white space. For
34361 example:
34362 .code
34363 headers add "X-header-1: ....\n  \
34364              continuation of X-header-1 ...\n\
34365              X-header-2: ...."
34366 .endd
34367 Note that the header line continuation white space after the first newline must
34368 be placed before the backslash that continues the input string, because white
34369 space after input continuations is ignored.
34370
34371 The argument for &%headers remove%& is a colon-separated list of header names.
34372 This command applies only to those headers that are stored with the message;
34373 those that are added at delivery time (such as &'Envelope-To:'& and
34374 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34375 header with the same name, they are all removed.
34376
34377 The &%headers%& command in a system filter makes an immediate change to the set
34378 of header lines that was received with the message (with possible additions
34379 from ACL processing). Subsequent commands in the system filter operate on the
34380 modified set, which also forms the basis for subsequent message delivery.
34381 Unless further modified during routing or transporting, this set of headers is
34382 used for all recipients of the message.
34383
34384 During routing and transporting, the variables that refer to the contents of
34385 header lines refer only to those lines that are in this set. Thus, header lines
34386 that are added by a system filter are visible to users' filter files and to all
34387 routers and transports. This contrasts with the manipulation of header lines by
34388 routers and transports, which is not immediate, but which instead is saved up
34389 until the message is actually being written (see section
34390 &<<SECTheadersaddrem>>&).
34391
34392 If the message is not delivered at the first attempt, header lines that were
34393 added by the system filter are stored with the message, and so are still
34394 present at the next delivery attempt. Header lines that were removed are still
34395 present, but marked &"deleted"& so that they are not transported with the
34396 message. For this reason, it is usual to make the &%headers%& command
34397 conditional on &%first_delivery%& so that the set of header lines is not
34398 modified more than once.
34399
34400 Because header modification in a system filter acts immediately, you have to
34401 use an indirect approach if you want to modify the contents of a header line.
34402 For example:
34403 .code
34404 headers add "Old-Subject: $h_subject:"
34405 headers remove "Subject"
34406 headers add "Subject: new subject (was: $h_old-subject:)"
34407 headers remove "Old-Subject"
34408 .endd
34409
34410
34411
34412 .section "Setting an errors address in a system filter" "SECID217"
34413 .cindex "envelope sender"
34414 In a system filter, if a &%deliver%& command is followed by
34415 .code
34416 errors_to <some address>
34417 .endd
34418 in order to change the envelope sender (and hence the error reporting) for that
34419 delivery, any address may be specified. (In a user filter, only the current
34420 user's address can be set.) For example, if some mail is being monitored, you
34421 might use
34422 .code
34423 unseen deliver monitor@spying.example errors_to root@local.example
34424 .endd
34425 to take a copy which would not be sent back to the normal error reporting
34426 address if its delivery failed.
34427
34428
34429
34430 .section "Per-address filtering" "SECTperaddfil"
34431 .vindex "&$domain$&"
34432 .vindex "&$local_part$&"
34433 In contrast to the system filter, which is run just once per message for each
34434 delivery attempt, it is also possible to set up a system-wide filtering
34435 operation that runs once for each recipient address. In this case, variables
34436 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34437 filter file could be made dependent on them. This is an example of a router
34438 which implements such a filter:
34439 .code
34440 central_filter:
34441   check_local_user
34442   driver = redirect
34443   domains = +local_domains
34444   file = /central/filters/$local_part
34445   no_verify
34446   allow_filter
34447   allow_freeze
34448 .endd
34449 The filter is run in a separate process under its own uid. Therefore, either
34450 &%check_local_user%& must be set (as above), in which case the filter is run as
34451 the local user, or the &%user%& option must be used to specify which user to
34452 use. If both are set, &%user%& overrides.
34453
34454 Care should be taken to ensure that none of the commands in the filter file
34455 specify a significant delivery if the message is to go on to be delivered to
34456 its intended recipient. The router will not then claim to have dealt with the
34457 address, so it will be passed on to subsequent routers to be delivered in the
34458 normal way.
34459 .ecindex IIDsysfil1
34460 .ecindex IIDsysfil2
34461 .ecindex IIDsysfil3
34462
34463
34464
34465
34466
34467
34468 . ////////////////////////////////////////////////////////////////////////////
34469 . ////////////////////////////////////////////////////////////////////////////
34470
34471 .chapter "Message processing" "CHAPmsgproc"
34472 .scindex IIDmesproc "message" "general processing"
34473 Exim performs various transformations on the sender and recipient addresses of
34474 all messages that it handles, and also on the messages' header lines. Some of
34475 these are optional and configurable, while others always take place. All of
34476 this processing, except rewriting as a result of routing, and the addition or
34477 removal of header lines while delivering, happens when a message is received,
34478 before it is placed on Exim's queue.
34479
34480 Some of the automatic processing takes place by default only for
34481 &"locally-originated"& messages. This adjective is used to describe messages
34482 that are not received over TCP/IP, but instead are passed to an Exim process on
34483 its standard input. This includes the interactive &"local SMTP"& case that is
34484 set up by the &%-bs%& command line option.
34485
34486 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34487 or ::1) are not considered to be locally-originated. Exim does not treat the
34488 loopback interface specially in any way.
34489
34490 If you want the loopback interface to be treated specially, you must ensure
34491 that there are appropriate entries in your ACLs.
34492
34493
34494
34495
34496 .section "Submission mode for non-local messages" "SECTsubmodnon"
34497 .cindex "message" "submission"
34498 .cindex "submission mode"
34499 Processing that happens automatically for locally-originated messages (unless
34500 &%suppress_local_fixups%& is set) can also be requested for messages that are
34501 received over TCP/IP. The term &"submission mode"& is used to describe this
34502 state. Submission mode is set by the modifier
34503 .code
34504 control = submission
34505 .endd
34506 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34507 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34508 a local submission, and is normally used when the source of the message is
34509 known to be an MUA running on a client host (as opposed to an MTA). For
34510 example, to set submission mode for messages originating on the IPv4 loopback
34511 interface, you could include the following in the MAIL ACL:
34512 .code
34513 warn  hosts = 127.0.0.1
34514       control = submission
34515 .endd
34516 .cindex "&%sender_retain%& submission option"
34517 There are some options that can be used when setting submission mode. A slash
34518 is used to separate options. For example:
34519 .code
34520 control = submission/sender_retain
34521 .endd
34522 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34523 true and &%local_from_check%& false for the current incoming message. The first
34524 of these allows an existing &'Sender:'& header in the message to remain, and
34525 the second suppresses the check to ensure that &'From:'& matches the
34526 authenticated sender. With this setting, Exim still fixes up messages by adding
34527 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34528 attempt to check sender authenticity in header lines.
34529
34530 When &%sender_retain%& is not set, a submission mode setting may specify a
34531 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34532 example:
34533 .code
34534 control = submission/domain=some.domain
34535 .endd
34536 The domain may be empty. How this value is used is described in sections
34537 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34538 that allows you to specify the user's full name for inclusion in a created
34539 &'Sender:'& or &'From:'& header line. For example:
34540 .code
34541 accept authenticated = *
34542        control = submission/domain=wonderland.example/\
34543                             name=${lookup {$authenticated_id} \
34544                                    lsearch {/etc/exim/namelist}}
34545 .endd
34546 Because the name may contain any characters, including slashes, the &%name%&
34547 option must be given last. The remainder of the string is used as the name. For
34548 the example above, if &_/etc/exim/namelist_& contains:
34549 .code
34550 bigegg:  Humpty Dumpty
34551 .endd
34552 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34553 line would be:
34554 .code
34555 Sender: Humpty Dumpty <bigegg@wonderland.example>
34556 .endd
34557 .cindex "return path" "in submission mode"
34558 By default, submission mode forces the return path to the same address as is
34559 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34560 specified, the return path is also left unchanged.
34561
34562 &*Note*&: The changes caused by submission mode take effect after the predata
34563 ACL. This means that any sender checks performed before the fix-ups use the
34564 untrusted sender address specified by the user, not the trusted sender address
34565 specified by submission mode. Although this might be slightly unexpected, it
34566 does mean that you can configure ACL checks to spot that a user is trying to
34567 spoof another's address.
34568
34569 .section "Line endings" "SECTlineendings"
34570 .cindex "line endings"
34571 .cindex "carriage return"
34572 .cindex "linefeed"
34573 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34574 linefeed) is the line ending for messages transmitted over the Internet using
34575 SMTP over TCP/IP. However, within individual operating systems, different
34576 conventions are used. For example, Unix-like systems use just LF, but others
34577 use CRLF or just CR.
34578
34579 Exim was designed for Unix-like systems, and internally, it stores messages
34580 using the system's convention of a single LF as a line terminator. When
34581 receiving a message, all line endings are translated to this standard format.
34582 Originally, it was thought that programs that passed messages directly to an
34583 MTA within an operating system would use that system's convention. Experience
34584 has shown that this is not the case; for example, there are Unix applications
34585 that use CRLF in this circumstance. For this reason, and for compatibility with
34586 other MTAs, the way Exim handles line endings for all messages is now as
34587 follows:
34588
34589 .ilist
34590 LF not preceded by CR is treated as a line ending.
34591 .next
34592 CR is treated as a line ending; if it is immediately followed by LF, the LF
34593 is ignored.
34594 .next
34595 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34596 nor a local message in the state where a line containing only a dot is a
34597 terminator.
34598 .next
34599 If a bare CR is encountered within a header line, an extra space is added after
34600 the line terminator so as not to end the header line. The reasoning behind this
34601 is that bare CRs in header lines are most likely either to be mistakes, or
34602 people trying to play silly games.
34603 .next
34604 If the first header line received in a message ends with CRLF, a subsequent
34605 bare LF in a header line is treated in the same way as a bare CR in a header
34606 line.
34607 .endlist
34608
34609
34610
34611
34612
34613 .section "Unqualified addresses" "SECID218"
34614 .cindex "unqualified addresses"
34615 .cindex "address" "qualification"
34616 By default, Exim expects every envelope address it receives from an external
34617 host to be fully qualified. Unqualified addresses cause negative responses to
34618 SMTP commands. However, because SMTP is used as a means of transporting
34619 messages from MUAs running on personal workstations, there is sometimes a
34620 requirement to accept unqualified addresses from specific hosts or IP networks.
34621
34622 Exim has two options that separately control which hosts may send unqualified
34623 sender or recipient addresses in SMTP commands, namely
34624 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34625 cases, if an unqualified address is accepted, it is qualified by adding the
34626 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34627
34628 .oindex "&%qualify_domain%&"
34629 .oindex "&%qualify_recipient%&"
34630 Unqualified addresses in header lines are automatically qualified for messages
34631 that are locally originated, unless the &%-bnq%& option is given on the command
34632 line. For messages received over SMTP, unqualified addresses in header lines
34633 are qualified only if unqualified addresses are permitted in SMTP commands. In
34634 other words, such qualification is also controlled by
34635 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34636
34637
34638
34639
34640 .section "The UUCP From line" "SECID219"
34641 .cindex "&""From""& line"
34642 .cindex "UUCP" "&""From""& line"
34643 .cindex "sender" "address"
34644 .oindex "&%uucp_from_pattern%&"
34645 .oindex "&%uucp_from_sender%&"
34646 .cindex "envelope sender"
34647 .cindex "Sendmail compatibility" "&""From""& line"
34648 Messages that have come from UUCP (and some other applications) often begin
34649 with a line containing the envelope sender and a timestamp, following the word
34650 &"From"&. Examples of two common formats are:
34651 .code
34652 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34653 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34654 .endd
34655 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34656 Exim recognizes such lines at the start of messages that are submitted to it
34657 via the command line (that is, on the standard input). It does not recognize
34658 such lines in incoming SMTP messages, unless the sending host matches
34659 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34660 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34661 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34662 default value matches the two common cases shown above and puts the address
34663 that follows &"From"& into &$1$&.
34664
34665 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34666 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34667 a trusted user, the message's sender address is constructed by expanding the
34668 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34669 then parsed as an RFC 2822 address. If there is no domain, the local part is
34670 qualified with &%qualify_domain%& unless it is the empty string. However, if
34671 the command line &%-f%& option is used, it overrides the &"From"& line.
34672
34673 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34674 sender address is not changed. This is also the case for incoming SMTP messages
34675 that are permitted to contain &"From"& lines.
34676
34677 Only one &"From"& line is recognized. If there is more than one, the second is
34678 treated as a data line that starts the body of the message, as it is not valid
34679 as a header line. This also happens if a &"From"& line is present in an
34680 incoming SMTP message from a source that is not permitted to send them.
34681
34682
34683
34684 .section "Resent- header lines" "SECID220"
34685 .cindex "&%Resent-%& header lines"
34686 .cindex "header lines" "Resent-"
34687 RFC 2822 makes provision for sets of header lines starting with the string
34688 &`Resent-`& to be added to a message when it is resent by the original
34689 recipient to somebody else. These headers are &'Resent-Date:'&,
34690 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34691 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34692
34693 .blockquote
34694 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34695 processing of replies or other such automatic actions on messages.'&
34696 .endblockquote
34697
34698 This leaves things a bit vague as far as other processing actions such as
34699 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34700 follows:
34701
34702 .ilist
34703 A &'Resent-From:'& line that just contains the login id of the submitting user
34704 is automatically rewritten in the same way as &'From:'& (see below).
34705 .next
34706 If there's a rewriting rule for a particular header line, it is also applied to
34707 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34708 &'From:'& also rewrites &'Resent-From:'&.
34709 .next
34710 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34711 also removed.
34712 .next
34713 For a locally-submitted message,
34714 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34715 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34716 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34717 included in log lines in this case.
34718 .next
34719 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34720 &%Resent-%& header lines are present.
34721 .endlist
34722
34723
34724
34725
34726 .section "The Auto-Submitted: header line" "SECID221"
34727 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34728 includes the header line:
34729 .code
34730 Auto-Submitted: auto-replied
34731 .endd
34732
34733 .section "The Bcc: header line" "SECID222"
34734 .cindex "&'Bcc:'& header line"
34735 If Exim is called with the &%-t%& option, to take recipient addresses from a
34736 message's header, it removes any &'Bcc:'& header line that may exist (after
34737 extracting its addresses). If &%-t%& is not present on the command line, any
34738 existing &'Bcc:'& is not removed.
34739
34740
34741 .section "The Date: header line" "SECID223"
34742 .cindex "&'Date:'& header line"
34743 .cindex "header lines" "Date:"
34744 If a locally-generated or submission-mode message has no &'Date:'& header line,
34745 Exim adds one, using the current date and time, unless the
34746 &%suppress_local_fixups%& control has been specified.
34747
34748 .section "The Delivery-date: header line" "SECID224"
34749 .cindex "&'Delivery-date:'& header line"
34750 .oindex "&%delivery_date_remove%&"
34751 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34752 set. Exim can be configured to add them to the final delivery of messages. (See
34753 the generic &%delivery_date_add%& transport option.) They should not be present
34754 in messages in transit. If the &%delivery_date_remove%& configuration option is
34755 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34756 messages.
34757
34758
34759 .section "The Envelope-to: header line" "SECID225"
34760 .cindex "&'Envelope-to:'& header line"
34761 .cindex "header lines" "Envelope-to:"
34762 .oindex "&%envelope_to_remove%&"
34763 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34764 Exim can be configured to add them to the final delivery of messages. (See the
34765 generic &%envelope_to_add%& transport option.) They should not be present in
34766 messages in transit. If the &%envelope_to_remove%& configuration option is set
34767 (the default), Exim removes &'Envelope-to:'& header lines from incoming
34768 messages.
34769
34770
34771 .section "The From: header line" "SECTthefrohea"
34772 .cindex "&'From:'& header line"
34773 .cindex "header lines" "From:"
34774 .cindex "Sendmail compatibility" "&""From""& line"
34775 .cindex "message" "submission"
34776 .cindex "submission mode"
34777 If a submission-mode message does not contain a &'From:'& header line, Exim
34778 adds one if either of the following conditions is true:
34779
34780 .ilist
34781 The envelope sender address is not empty (that is, this is not a bounce
34782 message). The added header line copies the envelope sender address.
34783 .next
34784 .vindex "&$authenticated_id$&"
34785 The SMTP session is authenticated and &$authenticated_id$& is not empty.
34786 .olist
34787 .vindex "&$qualify_domain$&"
34788 If no domain is specified by the submission control, the local part is
34789 &$authenticated_id$& and the domain is &$qualify_domain$&.
34790 .next
34791 If a non-empty domain is specified by the submission control, the local
34792 part is &$authenticated_id$&, and the domain is the specified domain.
34793 .next
34794 If an empty domain is specified by the submission control,
34795 &$authenticated_id$& is assumed to be the complete address.
34796 .endlist
34797 .endlist
34798
34799 A non-empty envelope sender takes precedence.
34800
34801 If a locally-generated incoming message does not contain a &'From:'& header
34802 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
34803 containing the sender's address. The calling user's login name and full name
34804 are used to construct the address, as described in section &<<SECTconstr>>&.
34805 They are obtained from the password data by calling &[getpwuid()]& (but see the
34806 &%unknown_login%& configuration option). The address is qualified with
34807 &%qualify_domain%&.
34808
34809 For compatibility with Sendmail, if an incoming, non-SMTP message has a
34810 &'From:'& header line containing just the unqualified login name of the calling
34811 user, this is replaced by an address containing the user's login name and full
34812 name as described in section &<<SECTconstr>>&.
34813
34814
34815 .section "The Message-ID: header line" "SECID226"
34816 .cindex "&'Message-ID:'& header line"
34817 .cindex "header lines" "Message-ID:"
34818 .cindex "message" "submission"
34819 .oindex "&%message_id_header_text%&"
34820 If a locally-generated or submission-mode incoming message does not contain a
34821 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
34822 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
34823 to the message. If there are any &'Resent-:'& headers in the message, it
34824 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
34825 message id, preceded by the letter E to ensure it starts with a letter, and
34826 followed by @ and the primary host name. Additional information can be included
34827 in this header line by setting the &%message_id_header_text%& and/or
34828 &%message_id_header_domain%& options.
34829
34830
34831 .section "The Received: header line" "SECID227"
34832 .cindex "&'Received:'& header line"
34833 .cindex "header lines" "Received:"
34834 A &'Received:'& header line is added at the start of every message. The
34835 contents are defined by the &%received_header_text%& configuration option, and
34836 Exim automatically adds a semicolon and a timestamp to the configured string.
34837
34838 The &'Received:'& header is generated as soon as the message's header lines
34839 have been received. At this stage, the timestamp in the &'Received:'& header
34840 line is the time that the message started to be received. This is the value
34841 that is seen by the DATA ACL and by the &[local_scan()]& function.
34842
34843 Once a message is accepted, the timestamp in the &'Received:'& header line is
34844 changed to the time of acceptance, which is (apart from a small delay while the
34845 -H spool file is written) the earliest time at which delivery could start.
34846
34847
34848 .section "The References: header line" "SECID228"
34849 .cindex "&'References:'& header line"
34850 .cindex "header lines" "References:"
34851 Messages created by the &(autoreply)& transport include a &'References:'&
34852 header line. This is constructed according to the rules that are described in
34853 section 3.64 of RFC 2822 (which states that replies should contain such a
34854 header line), and section 3.14 of RFC 3834 (which states that automatic
34855 responses are not different in this respect). However, because some mail
34856 processing software does not cope well with very long header lines, no more
34857 than 12 message IDs are copied from the &'References:'& header line in the
34858 incoming message. If there are more than 12, the first one and then the final
34859 11 are copied, before adding the message ID of the incoming message.
34860
34861
34862
34863 .section "The Return-path: header line" "SECID229"
34864 .cindex "&'Return-path:'& header line"
34865 .cindex "header lines" "Return-path:"
34866 .oindex "&%return_path_remove%&"
34867 &'Return-path:'& header lines are defined as something an MTA may insert when
34868 it does the final delivery of messages. (See the generic &%return_path_add%&
34869 transport option.) Therefore, they should not be present in messages in
34870 transit. If the &%return_path_remove%& configuration option is set (the
34871 default), Exim removes &'Return-path:'& header lines from incoming messages.
34872
34873
34874
34875 .section "The Sender: header line" "SECTthesenhea"
34876 .cindex "&'Sender:'& header line"
34877 .cindex "message" "submission"
34878 .cindex "header lines" "Sender:"
34879 For a locally-originated message from an untrusted user, Exim may remove an
34880 existing &'Sender:'& header line, and it may add a new one. You can modify
34881 these actions by setting the &%local_sender_retain%& option true, the
34882 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
34883 control setting.
34884
34885 When a local message is received from an untrusted user and
34886 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
34887 control has not been set, a check is made to see if the address given in the
34888 &'From:'& header line is the correct (local) sender of the message. The address
34889 that is expected has the login name as the local part and the value of
34890 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
34891 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
34892 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
34893 line is added to the message.
34894
34895 If you set &%local_from_check%& false, this checking does not occur. However,
34896 the removal of an existing &'Sender:'& line still happens, unless you also set
34897 &%local_sender_retain%& to be true. It is not possible to set both of these
34898 options true at the same time.
34899
34900 .cindex "submission mode"
34901 By default, no processing of &'Sender:'& header lines is done for messages
34902 received over TCP/IP or for messages submitted by trusted users. However, when
34903 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
34904 not specified on the submission control, the following processing takes place:
34905
34906 .vindex "&$authenticated_id$&"
34907 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
34908 authenticated, and &$authenticated_id$& is not empty, a sender address is
34909 created as follows:
34910
34911 .ilist
34912 .vindex "&$qualify_domain$&"
34913 If no domain is specified by the submission control, the local part is
34914 &$authenticated_id$& and the domain is &$qualify_domain$&.
34915 .next
34916 If a non-empty domain is specified by the submission control, the local part
34917 is &$authenticated_id$&, and the domain is the specified domain.
34918 .next
34919 If an empty domain is specified by the submission control,
34920 &$authenticated_id$& is assumed to be the complete address.
34921 .endlist
34922
34923 This address is compared with the address in the &'From:'& header line. If they
34924 are different, a &'Sender:'& header line containing the created address is
34925 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
34926 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
34927
34928 .cindex "return path" "created from &'Sender:'&"
34929 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
34930 the message (the envelope sender address) is changed to be the same address,
34931 except in the case of submission mode when &%sender_retain%& is specified.
34932
34933
34934
34935 .section "Adding and removing header lines in routers and transports" &&&
34936          "SECTheadersaddrem"
34937 .cindex "header lines" "adding; in router or transport"
34938 .cindex "header lines" "removing; in router or transport"
34939 When a message is delivered, the addition and removal of header lines can be
34940 specified in a system filter, or on any of the routers and transports that
34941 process the message. Section &<<SECTaddremheasys>>& contains details about
34942 modifying headers in a system filter. Header lines can also be added in an ACL
34943 as a message is received (see section &<<SECTaddheadacl>>&).
34944
34945 In contrast to what happens in a system filter, header modifications that are
34946 specified on routers and transports apply only to the particular recipient
34947 addresses that are being processed by those routers and transports. These
34948 changes do not actually take place until a copy of the message is being
34949 transported. Therefore, they do not affect the basic set of header lines, and
34950 they do not affect the values of the variables that refer to header lines.
34951
34952 &*Note*&: In particular, this means that any expansions in the configuration of
34953 the transport cannot refer to the modified header lines, because such
34954 expansions all occur before the message is actually transported.
34955
34956 For both routers and transports, the argument of a &%headers_add%&
34957 option must be in the form of one or more RFC 2822 header lines, separated by
34958 newlines (coded as &"\n"&). For example:
34959 .code
34960 headers_add = X-added-header: added by $primary_hostname\n\
34961               X-added-second: another added header line
34962 .endd
34963 Exim does not check the syntax of these added header lines.
34964
34965 Multiple &%headers_add%& options for a single router or transport can be
34966 specified; the values will append to a single list of header lines.
34967 Each header-line is separately expanded.
34968
34969 The argument of a &%headers_remove%& option must consist of a colon-separated
34970 list of header names. This is confusing, because header names themselves are
34971 often terminated by colons. In this case, the colons are the list separators,
34972 not part of the names. For example:
34973 .code
34974 headers_remove = return-receipt-to:acknowledge-to
34975 .endd
34976
34977 Multiple &%headers_remove%& options for a single router or transport can be
34978 specified; the arguments will append to a single header-names list.
34979 Each item is separately expanded.
34980 Note that colons in complex expansions which are used to
34981 form all or part of a &%headers_remove%& list
34982 will act as list separators.
34983
34984 When &%headers_add%& or &%headers_remove%& is specified on a router,
34985 items are expanded at routing time,
34986 and then associated with all addresses that are
34987 accepted by that router, and also with any new addresses that it generates. If
34988 an address passes through several routers as a result of aliasing or
34989 forwarding, the changes are cumulative.
34990
34991 .oindex "&%unseen%&"
34992 However, this does not apply to multiple routers that result from the use of
34993 the &%unseen%& option. Any header modifications that were specified by the
34994 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
34995
34996 Addresses that end up with different &%headers_add%& or &%headers_remove%&
34997 settings cannot be delivered together in a batch, so a transport is always
34998 dealing with a set of addresses that have the same header-processing
34999 requirements.
35000
35001 The transport starts by writing the original set of header lines that arrived
35002 with the message, possibly modified by the system filter. As it writes out
35003 these lines, it consults the list of header names that were attached to the
35004 recipient address(es) by &%headers_remove%& options in routers, and it also
35005 consults the transport's own &%headers_remove%& option. Header lines whose
35006 names are on either of these lists are not written out. If there are multiple
35007 instances of any listed header, they are all skipped.
35008
35009 After the remaining original header lines have been written, new header
35010 lines that were specified by routers' &%headers_add%& options are written, in
35011 the order in which they were attached to the address. These are followed by any
35012 header lines specified by the transport's &%headers_add%& option.
35013
35014 This way of handling header line modifications in routers and transports has
35015 the following consequences:
35016
35017 .ilist
35018 The original set of header lines, possibly modified by the system filter,
35019 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35020 to it, at all times.
35021 .next
35022 Header lines that are added by a router's
35023 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35024 expansion syntax in subsequent routers or the transport.
35025 .next
35026 Conversely, header lines that are specified for removal by &%headers_remove%&
35027 in a router remain visible to subsequent routers and the transport.
35028 .next
35029 Headers added to an address by &%headers_add%& in a router cannot be removed by
35030 a later router or by a transport.
35031 .next
35032 An added header can refer to the contents of an original header that is to be
35033 removed, even it has the same name as the added header. For example:
35034 .code
35035 headers_remove = subject
35036 headers_add = Subject: new subject (was: $h_subject:)
35037 .endd
35038 .endlist
35039
35040 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35041 for a &(redirect)& router that has the &%one_time%& option set.
35042
35043
35044
35045
35046
35047 .section "Constructed addresses" "SECTconstr"
35048 .cindex "address" "constructed"
35049 .cindex "constructed address"
35050 When Exim constructs a sender address for a locally-generated message, it uses
35051 the form
35052 .display
35053 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35054 .endd
35055 For example:
35056 .code
35057 Zaphod Beeblebrox <zaphod@end.univ.example>
35058 .endd
35059 The user name is obtained from the &%-F%& command line option if set, or
35060 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35061 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35062 ampersand character, this is replaced by the login name with the first letter
35063 upper cased, as is conventional in a number of operating systems. See the
35064 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35065 The &%unknown_username%& option can be used to specify user names in cases when
35066 there is no password file entry.
35067
35068 .cindex "RFC 2047"
35069 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35070 parts of it if necessary. In addition, if it contains any non-printing
35071 characters, it is encoded as described in RFC 2047, which defines a way of
35072 including non-ASCII characters in header lines. The value of the
35073 &%headers_charset%& option specifies the name of the encoding that is used (the
35074 characters are assumed to be in this encoding). The setting of
35075 &%print_topbitchars%& controls whether characters with the top bit set (that
35076 is, with codes greater than 127) count as printing characters or not.
35077
35078
35079
35080 .section "Case of local parts" "SECID230"
35081 .cindex "case of local parts"
35082 .cindex "local part" "case of"
35083 RFC 2822 states that the case of letters in the local parts of addresses cannot
35084 be assumed to be non-significant. Exim preserves the case of local parts of
35085 addresses, but by default it uses a lower-cased form when it is routing,
35086 because on most Unix systems, usernames are in lower case and case-insensitive
35087 routing is required. However, any particular router can be made to use the
35088 original case for local parts by setting the &%caseful_local_part%& generic
35089 router option.
35090
35091 .cindex "mixed-case login names"
35092 If you must have mixed-case user names on your system, the best way to proceed,
35093 assuming you want case-independent handling of incoming email, is to set up
35094 your first router to convert incoming local parts in your domains to the
35095 correct case by means of a file lookup. For example:
35096 .code
35097 correct_case:
35098   driver = redirect
35099   domains = +local_domains
35100   data = ${lookup{$local_part}cdb\
35101               {/etc/usercased.cdb}{$value}fail}\
35102               @$domain
35103 .endd
35104 For this router, the local part is forced to lower case by the default action
35105 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35106 up a new local part in the correct case. If you then set &%caseful_local_part%&
35107 on any subsequent routers which process your domains, they will operate on
35108 local parts with the correct case in a case-sensitive manner.
35109
35110
35111
35112 .section "Dots in local parts" "SECID231"
35113 .cindex "dot" "in local part"
35114 .cindex "local part" "dots in"
35115 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35116 part may not begin or end with a dot, nor have two consecutive dots in the
35117 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35118 empty components for compatibility.
35119
35120
35121
35122 .section "Rewriting addresses" "SECID232"
35123 .cindex "rewriting" "addresses"
35124 Rewriting of sender and recipient addresses, and addresses in headers, can
35125 happen automatically, or as the result of configuration options, as described
35126 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35127 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35128
35129 Automatic rewriting includes qualification, as mentioned above. The other case
35130 in which it can happen is when an incomplete non-local domain is given. The
35131 routing process may cause this to be expanded into the full domain name. For
35132 example, a header such as
35133 .code
35134 To: hare@teaparty
35135 .endd
35136 might get rewritten as
35137 .code
35138 To: hare@teaparty.wonderland.fict.example
35139 .endd
35140 Rewriting as a result of routing is the one kind of message processing that
35141 does not happen at input time, as it cannot be done until the address has
35142 been routed.
35143
35144 Strictly, one should not do &'any'& deliveries of a message until all its
35145 addresses have been routed, in case any of the headers get changed as a
35146 result of routing. However, doing this in practice would hold up many
35147 deliveries for unreasonable amounts of time, just because one address could not
35148 immediately be routed. Exim therefore does not delay other deliveries when
35149 routing of one or more addresses is deferred.
35150 .ecindex IIDmesproc
35151
35152
35153
35154 . ////////////////////////////////////////////////////////////////////////////
35155 . ////////////////////////////////////////////////////////////////////////////
35156
35157 .chapter "SMTP processing" "CHAPSMTP"
35158 .scindex IIDsmtpproc1 "SMTP" "processing details"
35159 .scindex IIDsmtpproc2 "LMTP" "processing details"
35160 Exim supports a number of different ways of using the SMTP protocol, and its
35161 LMTP variant, which is an interactive protocol for transferring messages into a
35162 closed mail store application. This chapter contains details of how SMTP is
35163 processed. For incoming mail, the following are available:
35164
35165 .ilist
35166 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35167 .next
35168 SMTP over the standard input and output (the &%-bs%& option);
35169 .next
35170 Batched SMTP on the standard input (the &%-bS%& option).
35171 .endlist
35172
35173 For mail delivery, the following are available:
35174
35175 .ilist
35176 SMTP over TCP/IP (the &(smtp)& transport);
35177 .next
35178 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35179 &"lmtp"&);
35180 .next
35181 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35182 transport);
35183 .next
35184 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35185 the &%use_bsmtp%& option set).
35186 .endlist
35187
35188 &'Batched SMTP'& is the name for a process in which batches of messages are
35189 stored in or read from files (or pipes), in a format in which SMTP commands are
35190 used to contain the envelope information.
35191
35192
35193
35194 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35195 .cindex "SMTP" "outgoing over TCP/IP"
35196 .cindex "outgoing SMTP over TCP/IP"
35197 .cindex "LMTP" "over TCP/IP"
35198 .cindex "outgoing LMTP over TCP/IP"
35199 .cindex "EHLO"
35200 .cindex "HELO"
35201 .cindex "SIZE option on MAIL command"
35202 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35203 The &%protocol%& option selects which protocol is to be used, but the actual
35204 processing is the same in both cases.
35205
35206 If, in response to its EHLO command, Exim is told that the SIZE
35207 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35208 command. The value of <&'n'&> is the message size plus the value of the
35209 &%size_addition%& option (default 1024) to allow for additions to the message
35210 such as per-transport header lines, or changes made in a
35211 .cindex "transport" "filter"
35212 .cindex "filter" "transport filter"
35213 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35214 suppressed.
35215
35216 If the remote server advertises support for PIPELINING, Exim uses the
35217 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35218 required for the transaction.
35219
35220 If the remote server advertises support for the STARTTLS command, and Exim
35221 was built to support TLS encryption, it tries to start a TLS session unless the
35222 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35223 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35224 is called for verification.
35225
35226 If the remote server advertises support for the AUTH command, Exim scans
35227 the authenticators configuration for any suitable client settings, as described
35228 in chapter &<<CHAPSMTPAUTH>>&.
35229
35230 .cindex "carriage return"
35231 .cindex "linefeed"
35232 Responses from the remote host are supposed to be terminated by CR followed by
35233 LF. However, there are known to be hosts that do not send CR characters, so in
35234 order to be able to interwork with such hosts, Exim treats LF on its own as a
35235 line terminator.
35236
35237 If a message contains a number of different addresses, all those with the same
35238 characteristics (for example, the same envelope sender) that resolve to the
35239 same set of hosts, in the same order, are sent in a single SMTP transaction,
35240 even if they are for different domains, unless there are more than the setting
35241 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35242 they are split into groups containing no more than &%max_rcpt%&s addresses
35243 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35244 in parallel sessions. The order of hosts with identical MX values is not
35245 significant when checking whether addresses can be batched in this way.
35246
35247 When the &(smtp)& transport suffers a temporary failure that is not
35248 message-related, Exim updates its transport-specific database, which contains
35249 records indexed by host name that remember which messages are waiting for each
35250 particular host. It also updates the retry database with new retry times.
35251
35252 .cindex "hints database" "retry keys"
35253 Exim's retry hints are based on host name plus IP address, so if one address of
35254 a multi-homed host is broken, it will soon be skipped most of the time.
35255 See the next section for more detail about error handling.
35256
35257 .cindex "SMTP" "passed connection"
35258 .cindex "SMTP" "batching over TCP/IP"
35259 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35260 looks in the hints database for the transport to see if there are any queued
35261 messages waiting for the host to which it is connected. If it finds one, it
35262 creates a new Exim process using the &%-MC%& option (which can only be used by
35263 a process running as root or the Exim user) and passes the TCP/IP socket to it
35264 so that it can deliver another message using the same socket. The new process
35265 does only those deliveries that are routed to the connected host, and may in
35266 turn pass the socket on to a third process, and so on.
35267
35268 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35269 limit the number of messages sent down a single TCP/IP connection.
35270
35271 .cindex "asterisk" "after IP address"
35272 The second and subsequent messages delivered down an existing connection are
35273 identified in the main log by the addition of an asterisk after the closing
35274 square bracket of the IP address.
35275
35276
35277
35278
35279 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35280 .cindex "error" "in outgoing SMTP"
35281 .cindex "SMTP" "errors in outgoing"
35282 .cindex "host" "error"
35283 Three different kinds of error are recognized for outgoing SMTP: host errors,
35284 message errors, and recipient errors.
35285
35286 .vlist
35287 .vitem "&*Host errors*&"
35288 A host error is not associated with a particular message or with a
35289 particular recipient of a message. The host errors are:
35290
35291 .ilist
35292 Connection refused or timed out,
35293 .next
35294 Any error response code on connection,
35295 .next
35296 Any error response code to EHLO or HELO,
35297 .next
35298 Loss of connection at any time, except after &"."&,
35299 .next
35300 I/O errors at any time,
35301 .next
35302 Timeouts during the session, other than in response to MAIL, RCPT or
35303 the &"."& at the end of the data.
35304 .endlist ilist
35305
35306 For a host error, a permanent error response on connection, or in response to
35307 EHLO, causes all addresses routed to the host to be failed. Any other host
35308 error causes all addresses to be deferred, and retry data to be created for the
35309 host. It is not tried again, for any message, until its retry time arrives. If
35310 the current set of addresses are not all delivered in this run (to some
35311 alternative host), the message is added to the list of those waiting for this
35312 host, so if it is still undelivered when a subsequent successful delivery is
35313 made to the host, it will be sent down the same SMTP connection.
35314
35315 .vitem "&*Message errors*&"
35316 .cindex "message" "error"
35317 A message error is associated with a particular message when sent to a
35318 particular host, but not with a particular recipient of the message. The
35319 message errors are:
35320
35321 .ilist
35322 Any error response code to MAIL, DATA, or the &"."& that terminates
35323 the data,
35324 .next
35325 Timeout after MAIL,
35326 .next
35327 Timeout or loss of connection after the &"."& that terminates the data. A
35328 timeout after the DATA command itself is treated as a host error, as is loss of
35329 connection at any other time.
35330 .endlist ilist
35331
35332 For a message error, a permanent error response (5&'xx'&) causes all addresses
35333 to be failed, and a delivery error report to be returned to the sender. A
35334 temporary error response (4&'xx'&), or one of the timeouts, causes all
35335 addresses to be deferred. Retry data is not created for the host, but instead,
35336 a retry record for the combination of host plus message id is created. The
35337 message is not added to the list of those waiting for this host. This ensures
35338 that the failing message will not be sent to this host again until the retry
35339 time arrives. However, other messages that are routed to the host are not
35340 affected, so if it is some property of the message that is causing the error,
35341 it will not stop the delivery of other mail.
35342
35343 If the remote host specified support for the SIZE parameter in its response
35344 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35345 over-large message will cause a message error because the error arrives as a
35346 response to MAIL.
35347
35348 .vitem "&*Recipient errors*&"
35349 .cindex "recipient" "error"
35350 A recipient error is associated with a particular recipient of a message. The
35351 recipient errors are:
35352
35353 .ilist
35354 Any error response to RCPT,
35355 .next
35356 Timeout after RCPT.
35357 .endlist
35358
35359 For a recipient error, a permanent error response (5&'xx'&) causes the
35360 recipient address to be failed, and a bounce message to be returned to the
35361 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35362 address to be deferred, and routing retry data to be created for it. This is
35363 used to delay processing of the address in subsequent queue runs, until its
35364 routing retry time arrives. This applies to all messages, but because it
35365 operates only in queue runs, one attempt will be made to deliver a new message
35366 to the failing address before the delay starts to operate. This ensures that,
35367 if the failure is really related to the message rather than the recipient
35368 (&"message too big for this recipient"& is a possible example), other messages
35369 have a chance of getting delivered. If a delivery to the address does succeed,
35370 the retry information gets cleared, so all stuck messages get tried again, and
35371 the retry clock is reset.
35372
35373 The message is not added to the list of those waiting for this host. Use of the
35374 host for other messages is unaffected, and except in the case of a timeout,
35375 other recipients are processed independently, and may be successfully delivered
35376 in the current SMTP session. After a timeout it is of course impossible to
35377 proceed with the session, so all addresses get deferred. However, those other
35378 than the one that failed do not suffer any subsequent retry delays. Therefore,
35379 if one recipient is causing trouble, the others have a chance of getting
35380 through when a subsequent delivery attempt occurs before the failing
35381 recipient's retry time.
35382 .endlist
35383
35384 In all cases, if there are other hosts (or IP addresses) available for the
35385 current set of addresses (for example, from multiple MX records), they are
35386 tried in this run for any undelivered addresses, subject of course to their
35387 own retry data. In other words, recipient error retry data does not take effect
35388 until the next delivery attempt.
35389
35390 Some hosts have been observed to give temporary error responses to every
35391 MAIL command at certain times (&"insufficient space"& has been seen). It
35392 would be nice if such circumstances could be recognized, and defer data for the
35393 host itself created, but this is not possible within the current Exim design.
35394 What actually happens is that retry data for every (host, message) combination
35395 is created.
35396
35397 The reason that timeouts after MAIL and RCPT are treated specially is that
35398 these can sometimes arise as a result of the remote host's verification
35399 procedures. Exim makes this assumption, and treats them as if a temporary error
35400 response had been received. A timeout after &"."& is treated specially because
35401 it is known that some broken implementations fail to recognize the end of the
35402 message if the last character of the last line is a binary zero. Thus, it is
35403 helpful to treat this case as a message error.
35404
35405 Timeouts at other times are treated as host errors, assuming a problem with the
35406 host, or the connection to it. If a timeout after MAIL, RCPT,
35407 or &"."& is really a connection problem, the assumption is that at the next try
35408 the timeout is likely to occur at some other point in the dialogue, causing it
35409 then to be treated as a host error.
35410
35411 There is experimental evidence that some MTAs drop the connection after the
35412 terminating &"."& if they do not like the contents of the message for some
35413 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35414 should be given. That is why Exim treats this case as a message rather than a
35415 host error, in order not to delay other messages to the same host.
35416
35417
35418
35419
35420 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35421 .cindex "SMTP" "incoming over TCP/IP"
35422 .cindex "incoming SMTP over TCP/IP"
35423 .cindex "inetd"
35424 .cindex "daemon"
35425 Incoming SMTP messages can be accepted in one of two ways: by running a
35426 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35427 &_/etc/inetd.conf_& should be like this:
35428 .code
35429 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35430 .endd
35431 Exim distinguishes between this case and the case of a locally running user
35432 agent using the &%-bs%& option by checking whether or not the standard input is
35433 a socket. When it is, either the port must be privileged (less than 1024), or
35434 the caller must be root or the Exim user. If any other user passes a socket
35435 with an unprivileged port number, Exim prints a message on the standard error
35436 stream and exits with an error code.
35437
35438 By default, Exim does not make a log entry when a remote host connects or
35439 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35440 unexpected. It can be made to write such log entries by setting the
35441 &%smtp_connection%& log selector.
35442
35443 .cindex "carriage return"
35444 .cindex "linefeed"
35445 Commands from the remote host are supposed to be terminated by CR followed by
35446 LF. However, there are known to be hosts that do not send CR characters. In
35447 order to be able to interwork with such hosts, Exim treats LF on its own as a
35448 line terminator.
35449 Furthermore, because common code is used for receiving messages from all
35450 sources, a CR on its own is also interpreted as a line terminator. However, the
35451 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35452
35453 .cindex "EHLO" "invalid data"
35454 .cindex "HELO" "invalid data"
35455 One area that sometimes gives rise to problems concerns the EHLO or
35456 HELO commands. Some clients send syntactically invalid versions of these
35457 commands, which Exim rejects by default. (This is nothing to do with verifying
35458 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35459 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35460 match the broken hosts that send invalid commands.
35461
35462 .cindex "SIZE option on MAIL command"
35463 .cindex "MAIL" "SIZE option"
35464 The amount of disk space available is checked whenever SIZE is received on
35465 a MAIL command, independently of whether &%message_size_limit%& or
35466 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35467 false. A temporary error is given if there is not enough space. If
35468 &%check_spool_space%& is set, the check is for that amount of space plus the
35469 value given with SIZE, that is, it checks that the addition of the incoming
35470 message will not reduce the space below the threshold.
35471
35472 When a message is successfully received, Exim includes the local message id in
35473 its response to the final &"."& that terminates the data. If the remote host
35474 logs this text it can help with tracing what has happened to a message.
35475
35476 The Exim daemon can limit the number of simultaneous incoming connections it is
35477 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35478 number of simultaneous incoming connections from a single remote host (see the
35479 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35480 rejected using the SMTP temporary error code 421.
35481
35482 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35483 subprocess has finished, as this can get lost at busy times. Instead, it looks
35484 for completed subprocesses every time it wakes up. Provided there are other
35485 things happening (new incoming calls, starts of queue runs), completed
35486 processes will be noticed and tidied away. On very quiet systems you may
35487 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35488 it will be noticed when the daemon next wakes up.
35489
35490 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35491 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35492 high system load &-- for details see the &%smtp_accept_reserve%&,
35493 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35494 applies in both the daemon and &'inetd'& cases.
35495
35496 Exim normally starts a delivery process for each message received, though this
35497 can be varied by means of the &%-odq%& command line option and the
35498 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35499 number of simultaneously running delivery processes started in this way from
35500 SMTP input can be limited by the &%smtp_accept_queue%& and
35501 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35502 subsequently received messages are just put on the input queue without starting
35503 a delivery process.
35504
35505 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35506 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35507 started up from the &'inetd'& daemon, because in that case each connection is
35508 handled by an entirely independent Exim process. Control by load average is,
35509 however, available with &'inetd'&.
35510
35511 Exim can be configured to verify addresses in incoming SMTP commands as they
35512 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35513 to rewrite addresses at this time &-- before any syntax checking is done. See
35514 section &<<SECTrewriteS>>&.
35515
35516 Exim can also be configured to limit the rate at which a client host submits
35517 MAIL and RCPT commands in a single SMTP session. See the
35518 &%smtp_ratelimit_hosts%& option.
35519
35520
35521
35522 .section "Unrecognized SMTP commands" "SECID234"
35523 .cindex "SMTP" "unrecognized commands"
35524 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35525 commands during a single SMTP connection, it drops the connection after sending
35526 the error response to the last command. The default value for
35527 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35528 abuse that subvert web servers into making connections to SMTP ports; in these
35529 circumstances, a number of non-SMTP lines are sent first.
35530
35531
35532 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35533 .cindex "SMTP" "syntax errors"
35534 .cindex "SMTP" "protocol errors"
35535 A syntax error is detected if an SMTP command is recognized, but there is
35536 something syntactically wrong with its data, for example, a malformed email
35537 address in a RCPT command. Protocol errors include invalid command
35538 sequencing such as RCPT before MAIL. If Exim receives more than
35539 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35540 drops the connection after sending the error response to the last command. The
35541 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35542 broken clients that loop sending bad commands (yes, it has been seen).
35543
35544
35545
35546 .section "Use of non-mail SMTP commands" "SECID236"
35547 .cindex "SMTP" "non-mail commands"
35548 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35549 DATA. Exim counts such commands, and drops the connection if there are too
35550 many of them in a single SMTP session. This action catches some
35551 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35552 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35553 defines what &"too many"& means. Its default value is 10.
35554
35555 When a new message is expected, one occurrence of RSET is not counted. This
35556 allows a client to send one RSET between messages (this is not necessary,
35557 but some clients do it). Exim also allows one uncounted occurrence of HELO
35558 or EHLO, and one occurrence of STARTTLS between messages. After
35559 starting up a TLS session, another EHLO is expected, and so it too is not
35560 counted.
35561
35562 The first occurrence of AUTH in a connection, or immediately following
35563 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35564 RCPT, DATA, and QUIT are counted.
35565
35566 You can control which hosts are subject to the limit set by
35567 &%smtp_accept_max_nonmail%& by setting
35568 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35569 the limit apply to all hosts. This option means that you can exclude any
35570 specific badly-behaved hosts that you have to live with.
35571
35572
35573
35574
35575 .section "The VRFY and EXPN commands" "SECID237"
35576 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35577 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35578 appropriate) in order to decide whether the command should be accepted or not.
35579
35580 .cindex "VRFY" "processing"
35581 When no ACL is defined for VRFY, or if it rejects without
35582 setting an explicit response code, the command is accepted
35583 (with a 252 SMTP response code)
35584 in order to support awkward clients that do a VRFY before every RCPT.
35585 When VRFY is accepted, it runs exactly the same code as when Exim is
35586 called with the &%-bv%& option, and returns 250/451/550
35587 SMTP response codes.
35588
35589 .cindex "EXPN" "processing"
35590 If no ACL for EXPN is defined, the command is rejected.
35591 When EXPN is accepted, a single-level expansion of the address is done.
35592 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35593 than a verification (the &%-bv%& option). If an unqualified local part is given
35594 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35595 of VRFY and EXPN commands are logged on the main and reject logs, and
35596 VRFY verification failures are logged on the main log for consistency with
35597 RCPT failures.
35598
35599
35600
35601 .section "The ETRN command" "SECTETRN"
35602 .cindex "ETRN" "processing"
35603 RFC 1985 describes an SMTP command called ETRN that is designed to
35604 overcome the security problems of the TURN command (which has fallen into
35605 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35606 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35607 should be accepted or not. If no ACL is defined, the command is rejected.
35608
35609 The ETRN command is concerned with &"releasing"& messages that are awaiting
35610 delivery to certain hosts. As Exim does not organize its message queue by host,
35611 the only form of ETRN that is supported by default is the one where the
35612 text starts with the &"#"& prefix, in which case the remainder of the text is
35613 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35614 the &%-R%& option to happen, with the remainder of the ETRN text as its
35615 argument. For example,
35616 .code
35617 ETRN #brigadoon
35618 .endd
35619 runs the command
35620 .code
35621 exim -R brigadoon
35622 .endd
35623 which causes a delivery attempt on all messages with undelivered addresses
35624 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35625 default), Exim prevents the simultaneous execution of more than one queue run
35626 for the same argument string as a result of an ETRN command. This stops
35627 a misbehaving client from starting more than one queue runner at once.
35628
35629 .cindex "hints database" "ETRN serialization"
35630 Exim implements the serialization by means of a hints database in which a
35631 record is written whenever a process is started by ETRN, and deleted when
35632 the process completes. However, Exim does not keep the SMTP session waiting for
35633 the ETRN process to complete. Once ETRN is accepted, the client is sent
35634 a &"success"& return code. Obviously there is scope for hints records to get
35635 left lying around if there is a system or program crash. To guard against this,
35636 Exim ignores any records that are more than six hours old.
35637
35638 .oindex "&%smtp_etrn_command%&"
35639 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35640 used. This specifies a command that is run whenever ETRN is received,
35641 whatever the form of its argument. For
35642 example:
35643 .code
35644 smtp_etrn_command = /etc/etrn_command $domain \
35645                     $sender_host_address
35646 .endd
35647 .vindex "&$domain$&"
35648 The string is split up into arguments which are independently expanded. The
35649 expansion variable &$domain$& is set to the argument of the ETRN command,
35650 and no syntax checking is done on the contents of this argument. Exim does not
35651 wait for the command to complete, so its status code is not checked. Exim runs
35652 under its own uid and gid when receiving incoming SMTP, so it is not possible
35653 for it to change them before running the command.
35654
35655
35656
35657 .section "Incoming local SMTP" "SECID238"
35658 .cindex "SMTP" "local incoming"
35659 Some user agents use SMTP to pass messages to their local MTA using the
35660 standard input and output, as opposed to passing the envelope on the command
35661 line and writing the message to the standard input. This is supported by the
35662 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35663 messages over TCP/IP (including the use of ACLs), except that the envelope
35664 sender given in a MAIL command is ignored unless the caller is trusted. In
35665 an ACL you can detect this form of SMTP input by testing for an empty host
35666 identification. It is common to have this as the first line in the ACL that
35667 runs for RCPT commands:
35668 .code
35669 accept hosts = :
35670 .endd
35671 This accepts SMTP messages from local processes without doing any other tests.
35672
35673
35674
35675 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35676 .cindex "SMTP" "batched outgoing"
35677 .cindex "batched SMTP output"
35678 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35679 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35680 be output in BSMTP format. No SMTP responses are possible for this form of
35681 delivery. All it is doing is using SMTP commands as a way of transmitting the
35682 envelope along with the message.
35683
35684 The message is written to the file or pipe preceded by the SMTP commands
35685 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35686 the message that start with a dot have an extra dot added. The SMTP command
35687 HELO is not normally used. If it is required, the &%message_prefix%& option
35688 can be used to specify it.
35689
35690 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35691 one recipient address at a time by default. However, you can arrange for them
35692 to handle several addresses at once by setting the &%batch_max%& option. When
35693 this is done for BSMTP, messages may contain multiple RCPT commands. See
35694 chapter &<<CHAPbatching>>& for more details.
35695
35696 .vindex "&$host$&"
35697 When one or more addresses are routed to a BSMTP transport by a router that
35698 sets up a host list, the name of the first host on the list is available to the
35699 transport in the variable &$host$&. Here is an example of such a transport and
35700 router:
35701 .code
35702 begin routers
35703 route_append:
35704   driver = manualroute
35705   transport = smtp_appendfile
35706   route_list = domain.example  batch.host.example
35707
35708 begin transports
35709 smtp_appendfile:
35710   driver = appendfile
35711   directory = /var/bsmtp/$host
35712   batch_max = 1000
35713   use_bsmtp
35714   user = exim
35715 .endd
35716 This causes messages addressed to &'domain.example'& to be written in BSMTP
35717 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35718 message (unless there are more than 1000 recipients).
35719
35720
35721
35722 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35723 .cindex "SMTP" "batched incoming"
35724 .cindex "batched SMTP input"
35725 The &%-bS%& command line option causes Exim to accept one or more messages by
35726 reading SMTP on the standard input, but to generate no responses. If the caller
35727 is trusted, the senders in the MAIL commands are believed; otherwise the
35728 sender is always the caller of Exim. Unqualified senders and receivers are not
35729 rejected (there seems little point) but instead just get qualified. HELO
35730 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35731 as NOOP; QUIT quits.
35732
35733 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35734 ACL is run in the same way as for non-SMTP local input.
35735
35736 If an error is detected while reading a message, including a missing &"."& at
35737 the end, Exim gives up immediately. It writes details of the error to the
35738 standard output in a stylized way that the calling program should be able to
35739 make some use of automatically, for example:
35740 .code
35741 554 Unexpected end of file
35742 Transaction started in line 10
35743 Error detected in line 14
35744 .endd
35745 It writes a more verbose version, for human consumption, to the standard error
35746 file, for example:
35747 .code
35748 An error was detected while processing a file of BSMTP input.
35749 The error message was:
35750
35751 501 '>' missing at end of address
35752
35753 The SMTP transaction started in line 10.
35754 The error was detected in line 12.
35755 The SMTP command at fault was:
35756
35757 rcpt to:<malformed@in.com.plete
35758
35759 1 previous message was successfully processed.
35760 The rest of the batch was abandoned.
35761 .endd
35762 The return code from Exim is zero only if there were no errors. It is 1 if some
35763 messages were accepted before an error was detected, and 2 if no messages were
35764 accepted.
35765 .ecindex IIDsmtpproc1
35766 .ecindex IIDsmtpproc2
35767
35768
35769
35770 . ////////////////////////////////////////////////////////////////////////////
35771 . ////////////////////////////////////////////////////////////////////////////
35772
35773 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
35774          "Customizing messages"
35775 When a message fails to be delivered, or remains in the queue for more than a
35776 configured amount of time, Exim sends a message to the original sender, or
35777 to an alternative configured address. The text of these messages is built into
35778 the code of Exim, but it is possible to change it, either by adding a single
35779 string, or by replacing each of the paragraphs by text supplied in a file.
35780
35781 The &'From:'& and &'To:'& header lines are automatically generated; you can
35782 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
35783 option. Exim also adds the line
35784 .code
35785 Auto-Submitted: auto-generated
35786 .endd
35787 to all warning and bounce messages,
35788
35789
35790 .section "Customizing bounce messages" "SECID239"
35791 .cindex "customizing" "bounce message"
35792 .cindex "bounce message" "customizing"
35793 If &%bounce_message_text%& is set, its contents are included in the default
35794 message immediately after &"This message was created automatically by mail
35795 delivery software."& The string is not expanded. It is not used if
35796 &%bounce_message_file%& is set.
35797
35798 When &%bounce_message_file%& is set, it must point to a template file for
35799 constructing error messages. The file consists of a series of text items,
35800 separated by lines consisting of exactly four asterisks. If the file cannot be
35801 opened, default text is used and a message is written to the main and panic
35802 logs. If any text item in the file is empty, default text is used for that
35803 item.
35804
35805 .vindex "&$bounce_recipient$&"
35806 .vindex "&$bounce_return_size_limit$&"
35807 Each item of text that is read from the file is expanded, and there are two
35808 expansion variables which can be of use here: &$bounce_recipient$& is set to
35809 the recipient of an error message while it is being created, and
35810 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
35811 option, rounded to a whole number.
35812
35813 The items must appear in the file in the following order:
35814
35815 .ilist
35816 The first item is included in the headers, and should include at least a
35817 &'Subject:'& header. Exim does not check the syntax of these headers.
35818 .next
35819 The second item forms the start of the error message. After it, Exim lists the
35820 failing addresses with their error messages.
35821 .next
35822 The third item is used to introduce any text from pipe transports that is to be
35823 returned to the sender. It is omitted if there is no such text.
35824 .next
35825 The fourth, fifth and sixth items will be ignored and may be empty.
35826 The fields exist for back-compatibility
35827 .endlist
35828
35829 The default state (&%bounce_message_file%& unset) is equivalent to the
35830 following file, in which the sixth item is empty. The &'Subject:'& and some
35831 other lines have been split in order to fit them on the page:
35832 .code
35833 Subject: Mail delivery failed
35834   ${if eq{$sender_address}{$bounce_recipient}
35835   {: returning message to sender}}
35836 ****
35837 This message was created automatically by mail delivery software.
35838
35839 A message ${if eq{$sender_address}{$bounce_recipient}
35840   {that you sent }{sent by
35841
35842 <$sender_address>
35843
35844 }}could not be delivered to all of its recipients.
35845 This is a permanent error. The following address(es) failed:
35846 ****
35847 The following text was generated during the delivery attempt(s):
35848 ****
35849 ------ This is a copy of the message, including all the headers.
35850   ------
35851 ****
35852 ------ The body of the message is $message_size characters long;
35853   only the first
35854 ------ $bounce_return_size_limit or so are included here.
35855 ****
35856 .endd
35857 .section "Customizing warning messages" "SECTcustwarn"
35858 .cindex "customizing" "warning message"
35859 .cindex "warning of delay" "customizing the message"
35860 The option &%warn_message_file%& can be pointed at a template file for use when
35861 warnings about message delays are created. In this case there are only three
35862 text sections:
35863
35864 .ilist
35865 The first item is included in the headers, and should include at least a
35866 &'Subject:'& header. Exim does not check the syntax of these headers.
35867 .next
35868 The second item forms the start of the warning message. After it, Exim lists
35869 the delayed addresses.
35870 .next
35871 The third item then ends the message.
35872 .endlist
35873
35874 The default state is equivalent to the following file, except that some lines
35875 have been split here, in order to fit them on the page:
35876 .code
35877 Subject: Warning: message $message_exim_id delayed
35878   $warn_message_delay
35879 ****
35880 This message was created automatically by mail delivery software.
35881
35882 A message ${if eq{$sender_address}{$warn_message_recipients}
35883 {that you sent }{sent by
35884
35885 <$sender_address>
35886
35887 }}has not been delivered to all of its recipients after
35888 more than $warn_message_delay in the queue on $primary_hostname.
35889
35890 The message identifier is:     $message_exim_id
35891 The subject of the message is: $h_subject
35892 The date of the message is:    $h_date
35893
35894 The following address(es) have not yet been delivered:
35895 ****
35896 No action is required on your part. Delivery attempts will
35897 continue for some time, and this warning may be repeated at
35898 intervals if the message remains undelivered. Eventually the
35899 mail delivery software will give up, and when that happens,
35900 the message will be returned to you.
35901 .endd
35902 .vindex "&$warn_message_delay$&"
35903 .vindex "&$warn_message_recipients$&"
35904 However, in the default state the subject and date lines are omitted if no
35905 appropriate headers exist. During the expansion of this file,
35906 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
35907 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
35908 of recipients for the warning message. There may be more than one if there are
35909 multiple addresses with different &%errors_to%& settings on the routers that
35910 handled them.
35911
35912
35913
35914
35915 . ////////////////////////////////////////////////////////////////////////////
35916 . ////////////////////////////////////////////////////////////////////////////
35917
35918 .chapter "Some common configuration settings" "CHAPcomconreq"
35919 This chapter discusses some configuration settings that seem to be fairly
35920 common. More examples and discussion can be found in the Exim book.
35921
35922
35923
35924 .section "Sending mail to a smart host" "SECID240"
35925 .cindex "smart host" "example router"
35926 If you want to send all mail for non-local domains to a &"smart host"&, you
35927 should replace the default &(dnslookup)& router with a router which does the
35928 routing explicitly:
35929 .code
35930 send_to_smart_host:
35931   driver = manualroute
35932   route_list = !+local_domains smart.host.name
35933   transport = remote_smtp
35934 .endd
35935 You can use the smart host's IP address instead of the name if you wish.
35936 If you are using Exim only to submit messages to a smart host, and not for
35937 receiving incoming messages, you can arrange for it to do the submission
35938 synchronously by setting the &%mua_wrapper%& option (see chapter
35939 &<<CHAPnonqueueing>>&).
35940
35941
35942
35943
35944 .section "Using Exim to handle mailing lists" "SECTmailinglists"
35945 .cindex "mailing lists"
35946 Exim can be used to run simple mailing lists, but for large and/or complicated
35947 requirements, the use of additional specialized mailing list software such as
35948 Majordomo or Mailman is recommended.
35949
35950 The &(redirect)& router can be used to handle mailing lists where each list
35951 is maintained in a separate file, which can therefore be managed by an
35952 independent manager. The &%domains%& router option can be used to run these
35953 lists in a separate domain from normal mail. For example:
35954 .code
35955 lists:
35956   driver = redirect
35957   domains = lists.example
35958   file = /usr/lists/$local_part
35959   forbid_pipe
35960   forbid_file
35961   errors_to = $local_part-request@lists.example
35962   no_more
35963 .endd
35964 This router is skipped for domains other than &'lists.example'&. For addresses
35965 in that domain, it looks for a file that matches the local part. If there is no
35966 such file, the router declines, but because &%no_more%& is set, no subsequent
35967 routers are tried, and so the whole delivery fails.
35968
35969 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
35970 expanded into a filename or a pipe delivery, which is usually inappropriate in
35971 a mailing list.
35972
35973 .oindex "&%errors_to%&"
35974 The &%errors_to%& option specifies that any delivery errors caused by addresses
35975 taken from a mailing list are to be sent to the given address rather than the
35976 original sender of the message. However, before acting on this, Exim verifies
35977 the error address, and ignores it if verification fails.
35978
35979 For example, using the configuration above, mail sent to
35980 &'dicts@lists.example'& is passed on to those addresses contained in
35981 &_/usr/lists/dicts_&, with error reports directed to
35982 &'dicts-request@lists.example'&, provided that this address can be verified.
35983 There could be a file called &_/usr/lists/dicts-request_& containing
35984 the address(es) of this particular list's manager(s), but other approaches,
35985 such as setting up an earlier router (possibly using the &%local_part_prefix%&
35986 or &%local_part_suffix%& options) to handle addresses of the form
35987 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
35988
35989
35990
35991 .section "Syntax errors in mailing lists" "SECID241"
35992 .cindex "mailing lists" "syntax errors in"
35993 If an entry in redirection data contains a syntax error, Exim normally defers
35994 delivery of the original address. That means that a syntax error in a mailing
35995 list holds up all deliveries to the list. This may not be appropriate when a
35996 list is being maintained automatically from data supplied by users, and the
35997 addresses are not rigorously checked.
35998
35999 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36000 entries that fail to parse, noting the incident in the log. If in addition
36001 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36002 whenever a broken address is skipped. It is usually appropriate to set
36003 &%syntax_errors_to%& to the same address as &%errors_to%&.
36004
36005
36006
36007 .section "Re-expansion of mailing lists" "SECID242"
36008 .cindex "mailing lists" "re-expansion of"
36009 Exim remembers every individual address to which a message has been delivered,
36010 in order to avoid duplication, but it normally stores only the original
36011 recipient addresses with a message. If all the deliveries to a mailing list
36012 cannot be done at the first attempt, the mailing list is re-expanded when the
36013 delivery is next tried. This means that alterations to the list are taken into
36014 account at each delivery attempt, so addresses that have been added to
36015 the list since the message arrived will therefore receive a copy of the
36016 message, even though it pre-dates their subscription.
36017
36018 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36019 on the &(redirect)& router. If this is done, any addresses generated by the
36020 router that fail to deliver at the first attempt are added to the message as
36021 &"top level"& addresses, and the parent address that generated them is marked
36022 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36023 subsequent delivery attempts. The disadvantage of this is that if any of the
36024 failing addresses are incorrect, correcting them in the file has no effect on
36025 pre-existing messages.
36026
36027 The original top-level address is remembered with each of the generated
36028 addresses, and is output in any log messages. However, any intermediate parent
36029 addresses are not recorded. This makes a difference to the log only if the
36030 &%all_parents%& selector is set, but for mailing lists there is normally only
36031 one level of expansion anyway.
36032
36033
36034
36035 .section "Closed mailing lists" "SECID243"
36036 .cindex "mailing lists" "closed"
36037 The examples so far have assumed open mailing lists, to which anybody may
36038 send mail. It is also possible to set up closed lists, where mail is accepted
36039 from specified senders only. This is done by making use of the generic
36040 &%senders%& option to restrict the router that handles the list.
36041
36042 The following example uses the same file as a list of recipients and as a list
36043 of permitted senders. It requires three routers:
36044 .code
36045 lists_request:
36046   driver = redirect
36047   domains = lists.example
36048   local_part_suffix = -request
36049   file = /usr/lists/$local_part$local_part_suffix
36050   no_more
36051
36052 lists_post:
36053   driver = redirect
36054   domains = lists.example
36055   senders = ${if exists {/usr/lists/$local_part}\
36056              {lsearch;/usr/lists/$local_part}{*}}
36057   file = /usr/lists/$local_part
36058   forbid_pipe
36059   forbid_file
36060   errors_to = $local_part-request@lists.example
36061   no_more
36062
36063 lists_closed:
36064   driver = redirect
36065   domains = lists.example
36066   allow_fail
36067   data = :fail: $local_part@lists.example is a closed mailing list
36068 .endd
36069 All three routers have the same &%domains%& setting, so for any other domains,
36070 they are all skipped. The first router runs only if the local part ends in
36071 &%-request%&. It handles messages to the list manager(s) by means of an open
36072 mailing list.
36073
36074 The second router runs only if the &%senders%& precondition is satisfied. It
36075 checks for the existence of a list that corresponds to the local part, and then
36076 checks that the sender is on the list by means of a linear search. It is
36077 necessary to check for the existence of the file before trying to search it,
36078 because otherwise Exim thinks there is a configuration error. If the file does
36079 not exist, the expansion of &%senders%& is *, which matches all senders. This
36080 means that the router runs, but because there is no list, declines, and
36081 &%no_more%& ensures that no further routers are run. The address fails with an
36082 &"unrouteable address"& error.
36083
36084 The third router runs only if the second router is skipped, which happens when
36085 a mailing list exists, but the sender is not on it. This router forcibly fails
36086 the address, giving a suitable error message.
36087
36088
36089
36090
36091 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36092 .cindex "VERP"
36093 .cindex "Variable Envelope Return Paths"
36094 .cindex "envelope sender"
36095 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36096 are a way of helping mailing list administrators discover which subscription
36097 address is the cause of a particular delivery failure. The idea is to encode
36098 the original recipient address in the outgoing envelope sender address, so that
36099 if the message is forwarded by another host and then subsequently bounces, the
36100 original recipient can be extracted from the recipient address of the bounce.
36101
36102 .oindex &%errors_to%&
36103 .oindex &%return_path%&
36104 Envelope sender addresses can be modified by Exim using two different
36105 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36106 list examples), or the &%return_path%& option on a transport. The second of
36107 these is effective only if the message is successfully delivered to another
36108 host; it is not used for errors detected on the local host (see the description
36109 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36110 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36111 .code
36112 verp_smtp:
36113   driver = smtp
36114   max_rcpt = 1
36115   return_path = \
36116     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36117       {$1-request+$local_part=$domain@your.dom.example}fail}
36118 .endd
36119 This has the effect of rewriting the return path (envelope sender) on outgoing
36120 SMTP messages, if the local part of the original return path ends in
36121 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36122 local part and domain of the recipient into the return path. Suppose, for
36123 example, that a message whose return path has been set to
36124 &'somelist-request@your.dom.example'& is sent to
36125 &'subscriber@other.dom.example'&. In the transport, the return path is
36126 rewritten as
36127 .code
36128 somelist-request+subscriber=other.dom.example@your.dom.example
36129 .endd
36130 .vindex "&$local_part$&"
36131 For this to work, you must tell Exim to send multiple copies of messages that
36132 have more than one recipient, so that each copy has just one recipient. This is
36133 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36134 might be sent to several different recipients in the same domain, in which case
36135 &$local_part$& is not available in the transport, because it is not unique.
36136
36137 Unless your host is doing nothing but mailing list deliveries, you should
36138 probably use a separate transport for the VERP deliveries, so as not to use
36139 extra resources in making one-per-recipient copies for other deliveries. This
36140 can easily be done by expanding the &%transport%& option in the router:
36141 .code
36142 dnslookup:
36143   driver = dnslookup
36144   domains = ! +local_domains
36145   transport = \
36146     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36147       {verp_smtp}{remote_smtp}}
36148   no_more
36149 .endd
36150 If you want to change the return path using &%errors_to%& in a router instead
36151 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36152 routers that handle mailing list addresses. This will ensure that all delivery
36153 errors, including those detected on the local host, are sent to the VERP
36154 address.
36155
36156 On a host that does no local deliveries and has no manual routing, only the
36157 &(dnslookup)& router needs to be changed. A special transport is not needed for
36158 SMTP deliveries. Every mailing list recipient has its own return path value,
36159 and so Exim must hand them to the transport one at a time. Here is an example
36160 of a &(dnslookup)& router that implements VERP:
36161 .code
36162 verp_dnslookup:
36163   driver = dnslookup
36164   domains = ! +local_domains
36165   transport = remote_smtp
36166   errors_to = \
36167     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36168      {$1-request+$local_part=$domain@your.dom.example}fail}
36169   no_more
36170 .endd
36171 Before you start sending out messages with VERPed return paths, you must also
36172 configure Exim to accept the bounce messages that come back to those paths.
36173 Typically this is done by setting a &%local_part_suffix%& option for a
36174 router, and using this to route the messages to wherever you want to handle
36175 them.
36176
36177 The overhead incurred in using VERP depends very much on the size of the
36178 message, the number of recipient addresses that resolve to the same remote
36179 host, and the speed of the connection over which the message is being sent. If
36180 a lot of addresses resolve to the same host and the connection is slow, sending
36181 a separate copy of the message for each address may take substantially longer
36182 than sending a single copy with many recipients (for which VERP cannot be
36183 used).
36184
36185
36186
36187
36188
36189
36190 .section "Virtual domains" "SECTvirtualdomains"
36191 .cindex "virtual domains"
36192 .cindex "domain" "virtual"
36193 The phrase &'virtual domain'& is unfortunately used with two rather different
36194 meanings:
36195
36196 .ilist
36197 A domain for which there are no real mailboxes; all valid local parts are
36198 aliases for other email addresses. Common examples are organizational
36199 top-level domains and &"vanity"& domains.
36200 .next
36201 One of a number of independent domains that are all handled by the same host,
36202 with mailboxes on that host, but where the mailbox owners do not necessarily
36203 have login accounts on that host.
36204 .endlist
36205
36206 The first usage is probably more common, and does seem more &"virtual"& than
36207 the second. This kind of domain can be handled in Exim with a straightforward
36208 aliasing router. One approach is to create a separate alias file for each
36209 virtual domain. Exim can test for the existence of the alias file to determine
36210 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36211 to a router of this form:
36212 .code
36213 virtual:
36214   driver = redirect
36215   domains = dsearch;/etc/mail/virtual
36216   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36217   no_more
36218 .endd
36219 The &%domains%& option specifies that the router is to be skipped, unless there
36220 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36221 domain that is being processed. When the router runs, it looks up the local
36222 part in the file to find a new address (or list of addresses). The &%no_more%&
36223 setting ensures that if the lookup fails (leading to &%data%& being an empty
36224 string), Exim gives up on the address without trying any subsequent routers.
36225
36226 This one router can handle all the virtual domains because the alias filenames
36227 follow a fixed pattern. Permissions can be arranged so that appropriate people
36228 can edit the different alias files. A successful aliasing operation results in
36229 a new envelope recipient address, which is then routed from scratch.
36230
36231 The other kind of &"virtual"& domain can also be handled in a straightforward
36232 way. One approach is to create a file for each domain containing a list of
36233 valid local parts, and use it in a router like this:
36234 .code
36235 my_domains:
36236   driver = accept
36237   domains = dsearch;/etc/mail/domains
36238   local_parts = lsearch;/etc/mail/domains/$domain
36239   transport = my_mailboxes
36240 .endd
36241 The address is accepted if there is a file for the domain, and the local part
36242 can be found in the file. The &%domains%& option is used to check for the
36243 file's existence because &%domains%& is tested before the &%local_parts%&
36244 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36245 because that option is tested after &%local_parts%&. The transport is as
36246 follows:
36247 .code
36248 my_mailboxes:
36249   driver = appendfile
36250   file = /var/mail/$domain/$local_part
36251   user = mail
36252 .endd
36253 This uses a directory of mailboxes for each domain. The &%user%& setting is
36254 required, to specify which uid is to be used for writing to the mailboxes.
36255
36256 The configuration shown here is just one example of how you might support this
36257 requirement. There are many other ways this kind of configuration can be set
36258 up, for example, by using a database instead of separate files to hold all the
36259 information about the domains.
36260
36261
36262
36263 .section "Multiple user mailboxes" "SECTmulbox"
36264 .cindex "multiple mailboxes"
36265 .cindex "mailbox" "multiple"
36266 .cindex "local part" "prefix"
36267 .cindex "local part" "suffix"
36268 Heavy email users often want to operate with multiple mailboxes, into which
36269 incoming mail is automatically sorted. A popular way of handling this is to
36270 allow users to use multiple sender addresses, so that replies can easily be
36271 identified. Users are permitted to add prefixes or suffixes to their local
36272 parts for this purpose. The wildcard facility of the generic router options
36273 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36274 example, consider this router:
36275 .code
36276 userforward:
36277   driver = redirect
36278   check_local_user
36279   file = $home/.forward
36280   local_part_suffix = -*
36281   local_part_suffix_optional
36282   allow_filter
36283 .endd
36284 .vindex "&$local_part_suffix$&"
36285 It runs a user's &_.forward_& file for all local parts of the form
36286 &'username-*'&. Within the filter file the user can distinguish different
36287 cases by testing the variable &$local_part_suffix$&. For example:
36288 .code
36289 if $local_part_suffix contains -special then
36290 save /home/$local_part/Mail/special
36291 endif
36292 .endd
36293 If the filter file does not exist, or does not deal with such addresses, they
36294 fall through to subsequent routers, and, assuming no subsequent use of the
36295 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36296 control over which suffixes are valid.
36297
36298 Alternatively, a suffix can be used to trigger the use of a different
36299 &_.forward_& file &-- which is the way a similar facility is implemented in
36300 another MTA:
36301 .code
36302 userforward:
36303   driver = redirect
36304   check_local_user
36305   file = $home/.forward$local_part_suffix
36306   local_part_suffix = -*
36307   local_part_suffix_optional
36308   allow_filter
36309 .endd
36310 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36311 example, &_.forward-special_& is used. Once again, if the appropriate file
36312 does not exist, or does not deal with the address, it is passed on to
36313 subsequent routers, which could, if required, look for an unqualified
36314 &_.forward_& file to use as a default.
36315
36316
36317
36318 .section "Simplified vacation processing" "SECID244"
36319 .cindex "vacation processing"
36320 The traditional way of running the &'vacation'& program is for a user to set up
36321 a pipe command in a &_.forward_& file
36322 (see section &<<SECTspecitredli>>& for syntax details).
36323 This is prone to error by inexperienced users. There are two features of Exim
36324 that can be used to make this process simpler for users:
36325
36326 .ilist
36327 A local part prefix such as &"vacation-"& can be specified on a router which
36328 can cause the message to be delivered directly to the &'vacation'& program, or
36329 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36330 &_.forward_& file are then much simpler. For example:
36331 .code
36332 spqr, vacation-spqr
36333 .endd
36334 .next
36335 The &%require_files%& generic router option can be used to trigger a
36336 vacation delivery by checking for the existence of a certain file in the
36337 user's home directory. The &%unseen%& generic option should also be used, to
36338 ensure that the original delivery also proceeds. In this case, all the user has
36339 to do is to create a file called, say, &_.vacation_&, containing a vacation
36340 message.
36341 .endlist
36342
36343 Another advantage of both these methods is that they both work even when the
36344 use of arbitrary pipes by users is locked out.
36345
36346
36347
36348 .section "Taking copies of mail" "SECID245"
36349 .cindex "message" "copying every"
36350 Some installations have policies that require archive copies of all messages to
36351 be made. A single copy of each message can easily be taken by an appropriate
36352 command in a system filter, which could, for example, use a different file for
36353 each day's messages.
36354
36355 There is also a shadow transport mechanism that can be used to take copies of
36356 messages that are successfully delivered by local transports, one copy per
36357 delivery. This could be used, &'inter alia'&, to implement automatic
36358 notification of delivery by sites that insist on doing such things.
36359
36360
36361
36362 .section "Intermittently connected hosts" "SECID246"
36363 .cindex "intermittently connected hosts"
36364 It has become quite common (because it is cheaper) for hosts to connect to the
36365 Internet periodically rather than remain connected all the time. The normal
36366 arrangement is that mail for such hosts accumulates on a system that is
36367 permanently connected.
36368
36369 Exim was designed for use on permanently connected hosts, and so it is not
36370 particularly well-suited to use in an intermittently connected environment.
36371 Nevertheless there are some features that can be used.
36372
36373
36374 .section "Exim on the upstream server host" "SECID247"
36375 It is tempting to arrange for incoming mail for the intermittently connected
36376 host to remain in Exim's queue until the client connects. However, this
36377 approach does not scale very well. Two different kinds of waiting message are
36378 being mixed up in the same queue &-- those that cannot be delivered because of
36379 some temporary problem, and those that are waiting for their destination host
36380 to connect. This makes it hard to manage the queue, as well as wasting
36381 resources, because each queue runner scans the entire queue.
36382
36383 A better approach is to separate off those messages that are waiting for an
36384 intermittently connected host. This can be done by delivering these messages
36385 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36386 format, from where they are transmitted by other software when their
36387 destination connects. This makes it easy to collect all the mail for one host
36388 in a single directory, and to apply local timeout rules on a per-message basis
36389 if required.
36390
36391 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36392 you are doing this, you should configure Exim with a long retry period for the
36393 intermittent host. For example:
36394 .code
36395 cheshire.wonderland.fict.example    *   F,5d,24h
36396 .endd
36397 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36398 which messages it has queued up for that host. Once the intermittent host comes
36399 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36400 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36401 causes all the queued up messages to be delivered, often down a single SMTP
36402 connection. While the host remains connected, any new messages get delivered
36403 immediately.
36404
36405 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36406 issued with a different IP address each time it connects, Exim's retry
36407 mechanisms on the holding host get confused, because the IP address is normally
36408 used as part of the key string for holding retry information. This can be
36409 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36410 Since this has disadvantages for permanently connected hosts, it is best to
36411 arrange a separate transport for the intermittently connected ones.
36412
36413
36414
36415 .section "Exim on the intermittently connected client host" "SECID248"
36416 The value of &%smtp_accept_queue_per_connection%& should probably be
36417 increased, or even set to zero (that is, disabled) on the intermittently
36418 connected host, so that all incoming messages down a single connection get
36419 delivered immediately.
36420
36421 .cindex "SMTP" "passed connection"
36422 .cindex "SMTP" "multiple deliveries"
36423 .cindex "multiple SMTP deliveries"
36424 Mail waiting to be sent from an intermittently connected host will probably
36425 not have been routed, because without a connection DNS lookups are not
36426 possible. This means that if a normal queue run is done at connection time,
36427 each message is likely to be sent in a separate SMTP session. This can be
36428 avoided by starting the queue run with a command line option beginning with
36429 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36430 first pass, routing is done but no deliveries take place. The second pass is a
36431 normal queue run; since all the messages have been previously routed, those
36432 destined for the same host are likely to get sent as multiple deliveries in a
36433 single SMTP connection.
36434
36435
36436
36437 . ////////////////////////////////////////////////////////////////////////////
36438 . ////////////////////////////////////////////////////////////////////////////
36439
36440 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36441          "Exim as a non-queueing client"
36442 .cindex "client, non-queueing"
36443 .cindex "smart host" "suppressing queueing"
36444 On a personal computer, it is a common requirement for all
36445 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36446 configured to operate that way, for all the popular operating systems.
36447 However, there are some MUAs for Unix-like systems that cannot be so
36448 configured: they submit messages using the command line interface of
36449 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36450 messages this way.
36451
36452 If the personal computer runs continuously, there is no problem, because it can
36453 run a conventional MTA that handles delivery to the smart host, and deal with
36454 any delays via its queueing mechanism. However, if the computer does not run
36455 continuously or runs different operating systems at different times, queueing
36456 email is not desirable.
36457
36458 There is therefore a requirement for something that can provide the
36459 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36460 any queueing or retrying facilities. Furthermore, the delivery to the smart
36461 host should be synchronous, so that if it fails, the sending MUA is immediately
36462 informed. In other words, we want something that extends an MUA that submits
36463 to a local MTA via the command line so that it behaves like one that submits
36464 to a remote smart host using TCP/SMTP.
36465
36466 There are a number of applications (for example, there is one called &'ssmtp'&)
36467 that do this job. However, people have found them to be lacking in various
36468 ways. For instance, you might want to allow aliasing and forwarding to be done
36469 before sending a message to the smart host.
36470
36471 Exim already had the necessary infrastructure for doing this job. Just a few
36472 tweaks were needed to make it behave as required, though it is somewhat of an
36473 overkill to use a fully-featured MTA for this purpose.
36474
36475 .oindex "&%mua_wrapper%&"
36476 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36477 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36478 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36479 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36480 compatible router and transport configuration. Typically there will be just one
36481 router and one transport, sending everything to a smart host.
36482
36483 When run in MUA wrapping mode, the behaviour of Exim changes in the
36484 following ways:
36485
36486 .ilist
36487 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36488 In other words, the only way to submit messages is via the command line.
36489 .next
36490 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36491 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36492 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36493 does not finish until the delivery attempt is complete. If the delivery is
36494 successful, a zero return code is given.
36495 .next
36496 Address redirection is permitted, but the final routing for all addresses must
36497 be to the same remote transport, and to the same list of hosts. Furthermore,
36498 the return address (envelope sender) must be the same for all recipients, as
36499 must any added or deleted header lines. In other words, it must be possible to
36500 deliver the message in a single SMTP transaction, however many recipients there
36501 are.
36502 .next
36503 If these conditions are not met, or if routing any address results in a
36504 failure or defer status, or if Exim is unable to deliver all the recipients
36505 successfully to one of the smart hosts, delivery of the entire message fails.
36506 .next
36507 Because no queueing is allowed, all failures are treated as permanent; there
36508 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36509 smart host. Furthermore, because only a single yes/no response can be given to
36510 the caller, it is not possible to deliver to some recipients and not others. If
36511 there is an error (temporary or permanent) for any recipient, all are failed.
36512 .next
36513 If more than one smart host is listed, Exim will try another host after a
36514 connection failure or a timeout, in the normal way. However, if this kind of
36515 failure happens for all the hosts, the delivery fails.
36516 .next
36517 When delivery fails, an error message is written to the standard error stream
36518 (as well as to Exim's log), and Exim exits to the caller with a return code
36519 value 1. The message is expunged from Exim's spool files. No bounce messages
36520 are ever generated.
36521 .next
36522 No retry data is maintained, and any retry rules are ignored.
36523 .next
36524 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36525 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36526 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36527 .endlist
36528
36529 The overall effect is that Exim makes a single synchronous attempt to deliver
36530 the message, failing if there is any kind of problem. Because no local
36531 deliveries are done and no daemon can be run, Exim does not need root
36532 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36533 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36534 the advantages and disadvantages of running without root privilege.
36535
36536
36537
36538
36539 . ////////////////////////////////////////////////////////////////////////////
36540 . ////////////////////////////////////////////////////////////////////////////
36541
36542 .chapter "Log files" "CHAPlog"
36543 .scindex IIDloggen "log" "general description"
36544 .cindex "log" "types of"
36545 Exim writes three different logs, referred to as the main log, the reject log,
36546 and the panic log:
36547
36548 .ilist
36549 .cindex "main log"
36550 The main log records the arrival of each message and each delivery in a single
36551 line in each case. The format is as compact as possible, in an attempt to keep
36552 down the size of log files. Two-character flag sequences make it easy to pick
36553 out these lines. A number of other events are recorded in the main log. Some of
36554 them are optional, in which case the &%log_selector%& option controls whether
36555 they are included or not. A Perl script called &'eximstats'&, which does simple
36556 analysis of main log files, is provided in the Exim distribution (see section
36557 &<<SECTmailstat>>&).
36558 .next
36559 .cindex "reject log"
36560 The reject log records information from messages that are rejected as a result
36561 of a configuration option (that is, for policy reasons).
36562 The first line of each rejection is a copy of the line that is also written to
36563 the main log. Then, if the message's header has been read at the time the log
36564 is written, its contents are written to this log. Only the original header
36565 lines are available; header lines added by ACLs are not logged. You can use the
36566 reject log to check that your policy controls are working correctly; on a busy
36567 host this may be easier than scanning the main log for rejection messages. You
36568 can suppress the writing of the reject log by setting &%write_rejectlog%&
36569 false.
36570 .next
36571 .cindex "panic log"
36572 .cindex "system log"
36573 When certain serious errors occur, Exim writes entries to its panic log. If the
36574 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36575 are usually written to the main log as well, but can get lost amid the mass of
36576 other entries. The panic log should be empty under normal circumstances. It is
36577 therefore a good idea to check it (or to have a &'cron'& script check it)
36578 regularly, in order to become aware of any problems. When Exim cannot open its
36579 panic log, it tries as a last resort to write to the system log (syslog). This
36580 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36581 message itself is written at priority LOG_CRIT.
36582 .endlist
36583
36584 Every log line starts with a timestamp, in the format shown in the following
36585 example. Note that many of the examples shown in this chapter are line-wrapped.
36586 In the log file, this would be all on one line:
36587 .code
36588 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36589   by QUIT
36590 .endd
36591 By default, the timestamps are in the local timezone. There are two
36592 ways of changing this:
36593
36594 .ilist
36595 You can set the &%timezone%& option to a different time zone; in particular, if
36596 you set
36597 .code
36598 timezone = UTC
36599 .endd
36600 the timestamps will be in UTC (aka GMT).
36601 .next
36602 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36603 example:
36604 .code
36605 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36606 .endd
36607 .endlist
36608
36609 .cindex "log" "process ids in"
36610 .cindex "pid (process id)" "in log lines"
36611 Exim does not include its process id in log lines by default, but you can
36612 request that it does so by specifying the &`pid`& log selector (see section
36613 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36614 brackets, immediately after the time and date.
36615
36616
36617
36618
36619 .section "Where the logs are written" "SECTwhelogwri"
36620 .cindex "log" "destination"
36621 .cindex "log" "to file"
36622 .cindex "log" "to syslog"
36623 .cindex "syslog"
36624 The logs may be written to local files, or to syslog, or both. However, it
36625 should be noted that many syslog implementations use UDP as a transport, and
36626 are therefore unreliable in the sense that messages are not guaranteed to
36627 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36628 It has also been reported that on large log files (tens of megabytes) you may
36629 need to tweak syslog to prevent it syncing the file with each write &-- on
36630 Linux this has been seen to make syslog take 90% plus of CPU time.
36631
36632 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36633 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
36634 configuration. This latter string is expanded, so it can contain, for example,
36635 references to the host name:
36636 .code
36637 log_file_path = /var/log/$primary_hostname/exim_%slog
36638 .endd
36639 It is generally advisable, however, to set the string in &_Local/Makefile_&
36640 rather than at runtime, because then the setting is available right from the
36641 start of Exim's execution. Otherwise, if there's something it wants to log
36642 before it has read the configuration file (for example, an error in the
36643 configuration file) it will not use the path you want, and may not be able to
36644 log at all.
36645
36646 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36647 list, currently limited to at most two items. This is one option where the
36648 facility for changing a list separator may not be used. The list must always be
36649 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36650 otherwise the item must either be an absolute path, containing &`%s`& at the
36651 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36652 implying the use of a default path.
36653
36654 When Exim encounters an empty item in the list, it searches the list defined by
36655 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36656 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36657 mean &"use the path specified at build time"&. It no such item exists, log
36658 files are written in the &_log_& subdirectory of the spool directory. This is
36659 equivalent to the setting:
36660 .code
36661 log_file_path = $spool_directory/log/%slog
36662 .endd
36663 If you do not specify anything at build time or runtime,
36664 or if you unset the option at runtime (i.e. &`log_file_path = `&),
36665 that is where the logs are written.
36666
36667 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
36668 are in use &-- see section &<<SECTdatlogfil>>& below.
36669
36670 Here are some examples of possible settings:
36671 .display
36672 &`LOG_FILE_PATH=syslog                    `& syslog only
36673 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36674 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36675 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36676 .endd
36677 If there are more than two paths in the list, the first is used and a panic
36678 error is logged.
36679
36680
36681
36682 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36683 .cindex "log" "cycling local files"
36684 .cindex "cycling logs"
36685 .cindex "&'exicyclog'&"
36686 .cindex "log" "local files; writing to"
36687 Some operating systems provide centralized and standardized methods for cycling
36688 log files. For those that do not, a utility script called &'exicyclog'& is
36689 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36690 main and reject logs each time it is called. The maximum number of old logs to
36691 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36692
36693 An Exim delivery process opens the main log when it first needs to write to it,
36694 and it keeps the file open in case subsequent entries are required &-- for
36695 example, if a number of different deliveries are being done for the same
36696 message. However, remote SMTP deliveries can take a long time, and this means
36697 that the file may be kept open long after it is renamed if &'exicyclog'& or
36698 something similar is being used to rename log files on a regular basis. To
36699 ensure that a switch of log files is noticed as soon as possible, Exim calls
36700 &[stat()]& on the main log's name before reusing an open file, and if the file
36701 does not exist, or its inode has changed, the old file is closed and Exim
36702 tries to open the main log from scratch. Thus, an old log file may remain open
36703 for quite some time, but no Exim processes should write to it once it has been
36704 renamed.
36705
36706
36707
36708 .section "Datestamped log files" "SECTdatlogfil"
36709 .cindex "log" "datestamped files"
36710 Instead of cycling the main and reject log files by renaming them
36711 periodically, some sites like to use files whose names contain a datestamp,
36712 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36713 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36714 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36715 point where the datestamp is required. For example:
36716 .code
36717 log_file_path = /var/spool/exim/log/%slog-%D
36718 log_file_path = /var/log/exim-%s-%D.log
36719 log_file_path = /var/spool/exim/log/%D-%slog
36720 log_file_path = /var/log/exim/%s.%M
36721 .endd
36722 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36723 examples of names generated by the above examples:
36724 .code
36725 /var/spool/exim/log/mainlog-20021225
36726 /var/log/exim-reject-20021225.log
36727 /var/spool/exim/log/20021225-mainlog
36728 /var/log/exim/main.200212
36729 .endd
36730 When this form of log file is specified, Exim automatically switches to new
36731 files at midnight. It does not make any attempt to compress old logs; you
36732 will need to write your own script if you require this. You should not
36733 run &'exicyclog'& with this form of logging.
36734
36735 The location of the panic log is also determined by &%log_file_path%&, but it
36736 is not datestamped, because rotation of the panic log does not make sense.
36737 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36738 the string. In addition, if it immediately follows a slash, a following
36739 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36740 character is removed. Thus, the four examples above would give these panic
36741 log names:
36742 .code
36743 /var/spool/exim/log/paniclog
36744 /var/log/exim-panic.log
36745 /var/spool/exim/log/paniclog
36746 /var/log/exim/panic
36747 .endd
36748
36749
36750 .section "Logging to syslog" "SECID249"
36751 .cindex "log" "syslog; writing to"
36752 The use of syslog does not change what Exim logs or the format of its messages,
36753 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36754 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36755 that, the same strings are written to syslog as to log files. The syslog
36756 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36757 by default, but you can change these by setting the &%syslog_facility%& and
36758 &%syslog_processname%& options, respectively. If Exim was compiled with
36759 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36760 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36761 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36762 the time and host name to each line.
36763 The three log streams are mapped onto syslog priorities as follows:
36764
36765 .ilist
36766 &'mainlog'& is mapped to LOG_INFO
36767 .next
36768 &'rejectlog'& is mapped to LOG_NOTICE
36769 .next
36770 &'paniclog'& is mapped to LOG_ALERT
36771 .endlist
36772
36773 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
36774 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
36775 these are routed by syslog to the same place. You can suppress this duplication
36776 by setting &%syslog_duplication%& false.
36777
36778 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
36779 entries contain multiple lines when headers are included. To cope with both
36780 these cases, entries written to syslog are split into separate &[syslog()]&
36781 calls at each internal newline, and also after a maximum of
36782 870 data characters. (This allows for a total syslog line length of 1024, when
36783 additions such as timestamps are added.) If you are running a syslog
36784 replacement that can handle lines longer than the 1024 characters allowed by
36785 RFC 3164, you should set
36786 .code
36787 SYSLOG_LONG_LINES=yes
36788 .endd
36789 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
36790 lines, but it still splits at internal newlines in &'reject'& log entries.
36791
36792 To make it easy to re-assemble split lines later, each component of a split
36793 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
36794 where <&'n'&> is the component number and <&'m'&> is the total number of
36795 components in the entry. The / delimiter is used when the line was split
36796 because it was too long; if it was split because of an internal newline, the \
36797 delimiter is used. For example, supposing the length limit to be 50 instead of
36798 870, the following would be the result of a typical rejection message to
36799 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
36800 name, and pid as added by syslog:
36801 .code
36802 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
36803 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
36804 [3/5]  when scanning for sender: missing or malformed lo
36805 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
36806 [5/5] mple>)
36807 .endd
36808 The same error might cause the following lines to be written to &"rejectlog"&
36809 (LOG_NOTICE):
36810 .code
36811 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
36812 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
36813 [3/18] er when scanning for sender: missing or malformed
36814 [4/18]  local part in "<>" (envelope sender is <ph10@cam
36815 [5\18] .example>)
36816 [6\18] Recipients: ph10@some.domain.cam.example
36817 [7\18] P Received: from [127.0.0.1] (ident=ph10)
36818 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
36819 [9\18]        id 16RdAL-0006pc-00
36820 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
36821 [11\18] 09:43 +0100
36822 [12\18] F From: <>
36823 [13\18]   Subject: this is a test header
36824 [18\18]   X-something: this is another header
36825 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
36826 [16\18] le>
36827 [17\18] B Bcc:
36828 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
36829 .endd
36830 Log lines that are neither too long nor contain newlines are written to syslog
36831 without modification.
36832
36833 If only syslog is being used, the Exim monitor is unable to provide a log tail
36834 display, unless syslog is routing &'mainlog'& to a file on the local host and
36835 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
36836 where it is.
36837
36838
36839
36840 .section "Log line flags" "SECID250"
36841 One line is written to the main log for each message received, and for each
36842 successful, unsuccessful, and delayed delivery. These lines can readily be
36843 picked out by the distinctive two-character flags that immediately follow the
36844 timestamp. The flags are:
36845 .display
36846 &`<=`&     message arrival
36847 &`(=`&     message fakereject
36848 &`=>`&     normal message delivery
36849 &`->`&     additional address in same delivery
36850 &`>>`&     cutthrough message delivery
36851 &`*>`&     delivery suppressed by &%-N%&
36852 &`**`&     delivery failed; address bounced
36853 &`==`&     delivery deferred; temporary problem
36854 .endd
36855
36856
36857 .section "Logging message reception" "SECID251"
36858 .cindex "log" "reception line"
36859 The format of the single-line entry in the main log that is written for every
36860 message received is shown in the basic example below, which is split over
36861 several lines in order to fit it on the page:
36862 .code
36863 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
36864   H=mailer.fict.example [192.168.123.123] U=exim
36865   P=smtp S=5678 id=<incoming message id>
36866 .endd
36867 The address immediately following &"<="& is the envelope sender address. A
36868 bounce message is shown with the sender address &"<>"&, and if it is locally
36869 generated, this is followed by an item of the form
36870 .code
36871 R=<message id>
36872 .endd
36873 which is a reference to the message that caused the bounce to be sent.
36874
36875 .cindex "HELO"
36876 .cindex "EHLO"
36877 For messages from other hosts, the H and U fields identify the remote host and
36878 record the RFC 1413 identity of the user that sent the message, if one was
36879 received. The number given in square brackets is the IP address of the sending
36880 host. If there is a single, unparenthesized  host name in the H field, as
36881 above, it has been verified to correspond to the IP address (see the
36882 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
36883 by the remote host in the SMTP HELO or EHLO command, and has not been
36884 verified. If verification yields a different name to that given for HELO or
36885 EHLO, the verified name appears first, followed by the HELO or EHLO
36886 name in parentheses.
36887
36888 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
36889 without brackets, in the HELO or EHLO command, leading to entries in
36890 the log containing text like these examples:
36891 .code
36892 H=(10.21.32.43) [192.168.8.34]
36893 H=([10.21.32.43]) [192.168.8.34]
36894 .endd
36895 This can be confusing. Only the final address in square brackets can be relied
36896 on.
36897
36898 For locally generated messages (that is, messages not received over TCP/IP),
36899 the H field is omitted, and the U field contains the login name of the caller
36900 of Exim.
36901
36902 .cindex "authentication" "logging"
36903 .cindex "AUTH" "logging"
36904 For all messages, the P field specifies the protocol used to receive the
36905 message. This is the value that is stored in &$received_protocol$&. In the case
36906 of incoming SMTP messages, the value indicates whether or not any SMTP
36907 extensions (ESMTP), encryption, or authentication were used. If the SMTP
36908 session was encrypted, there is an additional X field that records the cipher
36909 suite that was used.
36910
36911 .cindex log protocol
36912 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
36913 hosts that have authenticated themselves using the SMTP AUTH command. The first
36914 value is used when the SMTP connection was encrypted (&"secure"&). In this case
36915 there is an additional item A= followed by the name of the authenticator that
36916 was used. If an authenticated identification was set up by the authenticator's
36917 &%server_set_id%& option, this is logged too, separated by a colon from the
36918 authenticator name.
36919
36920 .cindex "size" "of message"
36921 The id field records the existing message id, if present. The size of the
36922 received message is given by the S field. When the message is delivered,
36923 headers may be removed or added, so that the size of delivered copies of the
36924 message may not correspond with this value (and indeed may be different to each
36925 other).
36926
36927 The &%log_selector%& option can be used to request the logging of additional
36928 data when a message is received. See section &<<SECTlogselector>>& below.
36929
36930
36931
36932 .section "Logging deliveries" "SECID252"
36933 .cindex "log" "delivery line"
36934 The format of the single-line entry in the main log that is written for every
36935 delivery is shown in one of the examples below, for local and remote
36936 deliveries, respectively. Each example has been split into multiple lines in order
36937 to fit it on the page:
36938 .code
36939 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
36940   <marv@hitch.fict.example> R=localuser T=local_delivery
36941 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
36942   monk@holistic.fict.example R=dnslookup T=remote_smtp
36943   H=holistic.fict.example [192.168.234.234]
36944 .endd
36945 For ordinary local deliveries, the original address is given in angle brackets
36946 after the final delivery address, which might be a pipe or a file. If
36947 intermediate address(es) exist between the original and the final address, the
36948 last of these is given in parentheses after the final address. The R and T
36949 fields record the router and transport that were used to process the address.
36950
36951 If SMTP AUTH was used for the delivery there is an additional item A=
36952 followed by the name of the authenticator that was used.
36953 If an authenticated identification was set up by the authenticator's &%client_set_id%&
36954 option, this is logged too, separated by a colon from the authenticator name.
36955
36956 If a shadow transport was run after a successful local delivery, the log line
36957 for the successful delivery has an item added on the end, of the form
36958 .display
36959 &`ST=<`&&'shadow transport name'&&`>`&
36960 .endd
36961 If the shadow transport did not succeed, the error message is put in
36962 parentheses afterwards.
36963
36964 .cindex "asterisk" "after IP address"
36965 When more than one address is included in a single delivery (for example, two
36966 SMTP RCPT commands in one transaction) the second and subsequent addresses are
36967 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
36968 down a single SMTP connection, an asterisk follows the IP address in the log
36969 lines for the second and subsequent messages.
36970 When two or more messages are delivered down a single TLS connection, the
36971 DNS and some TLS-related information logged for the first message delivered
36972 will not be present in the log lines for the second and subsequent messages.
36973 TLS cipher information is still available.
36974
36975 .cindex "delivery" "cutthrough; logging"
36976 .cindex "cutthrough" "logging"
36977 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
36978 line precedes the reception line, since cutthrough waits for a possible
36979 rejection from the destination in case it can reject the sourced item.
36980
36981 The generation of a reply message by a filter file gets logged as a
36982 &"delivery"& to the addressee, preceded by &">"&.
36983
36984 The &%log_selector%& option can be used to request the logging of additional
36985 data when a message is delivered. See section &<<SECTlogselector>>& below.
36986
36987
36988 .section "Discarded deliveries" "SECID253"
36989 .cindex "discarded messages"
36990 .cindex "message" "discarded"
36991 .cindex "delivery" "discarded; logging"
36992 When a message is discarded as a result of the command &"seen finish"& being
36993 obeyed in a filter file which generates no deliveries, a log entry of the form
36994 .code
36995 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
36996   <low.club@bridge.example> R=userforward
36997 .endd
36998 is written, to record why no deliveries are logged. When a message is discarded
36999 because it is aliased to &":blackhole:"& the log line is like this:
37000 .code
37001 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37002   <hole@nowhere.example> R=blackhole_router
37003 .endd
37004
37005
37006 .section "Deferred deliveries" "SECID254"
37007 When a delivery is deferred, a line of the following form is logged:
37008 .code
37009 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37010   R=dnslookup T=smtp defer (146): Connection refused
37011 .endd
37012 In the case of remote deliveries, the error is the one that was given for the
37013 last IP address that was tried. Details of individual SMTP failures are also
37014 written to the log, so the above line would be preceded by something like
37015 .code
37016 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37017   mail1.endrest.example [192.168.239.239]: Connection refused
37018 .endd
37019 When a deferred address is skipped because its retry time has not been reached,
37020 a message is written to the log, but this can be suppressed by setting an
37021 appropriate value in &%log_selector%&.
37022
37023
37024
37025 .section "Delivery failures" "SECID255"
37026 .cindex "delivery" "failure; logging"
37027 If a delivery fails because an address cannot be routed, a line of the
37028 following form is logged:
37029 .code
37030 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37031   <jim@trek99.example>: unknown mail domain
37032 .endd
37033 If a delivery fails at transport time, the router and transport are shown, and
37034 the response from the remote host is included, as in this example:
37035 .code
37036 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37037   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37038   after pipelined RCPT TO:<ace400@pb.example>: host
37039   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37040   <ace400@pb.example>...Addressee unknown
37041 .endd
37042 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37043 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37044 disabling PIPELINING. The log lines for all forms of delivery failure are
37045 flagged with &`**`&.
37046
37047
37048
37049 .section "Fake deliveries" "SECID256"
37050 .cindex "delivery" "fake; logging"
37051 If a delivery does not actually take place because the &%-N%& option has been
37052 used to suppress it, a normal delivery line is written to the log, except that
37053 &"=>"& is replaced by &"*>"&.
37054
37055
37056
37057 .section "Completion" "SECID257"
37058 A line of the form
37059 .code
37060 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37061 .endd
37062 is written to the main log when a message is about to be removed from the spool
37063 at the end of its processing.
37064
37065
37066
37067
37068 .section "Summary of Fields in Log Lines" "SECID258"
37069 .cindex "log" "summary of fields"
37070 A summary of the field identifiers that are used in log lines is shown in
37071 the following table:
37072 .display
37073 &`A   `&        authenticator name (and optional id and sender)
37074 &`C   `&        SMTP confirmation on delivery
37075 &`    `&        command list for &"no mail in SMTP session"&
37076 &`CV  `&        certificate verification status
37077 &`D   `&        duration of &"no mail in SMTP session"&
37078 &`DKIM`&        domain verified in incoming message
37079 &`DN  `&        distinguished name from peer certificate
37080 &`DS  `&        DNSSEC secured lookups
37081 &`DT  `&        on &`=>`& lines: time taken for a delivery
37082 &`F   `&        sender address (on delivery lines)
37083 &`H   `&        host name and IP address
37084 &`I   `&        local interface used
37085 &`id  `&        message id (from header) for incoming message
37086 &`K   `&        CHUNKING extension used
37087 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37088 &`M8S `&        8BITMIME status for incoming message
37089 &`P   `&        on &`<=`& lines: protocol used
37090 &`    `&        on &`=>`& and &`**`& lines: return path
37091 &`PRDR`&        PRDR extension used
37092 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37093 &`Q   `&        alternate queue name
37094 &`QT  `&        on &`=>`& lines: time spent on queue so far
37095 &`    `&        on &"Completed"& lines: time spent on queue
37096 &`R   `&        on &`<=`& lines: reference for local bounce
37097 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37098 &`RT  `&        on &`<=`& lines: time taken for reception
37099 &`S   `&        size of message in bytes
37100 &`SNI `&        server name indication from TLS client hello
37101 &`ST  `&        shadow transport name
37102 &`T   `&        on &`<=`& lines: message subject (topic)
37103 &`TFO `&        connection took advantage of TCP Fast Open
37104 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37105 &`U   `&        local user or RFC 1413 identity
37106 &`X   `&        TLS cipher suite
37107 .endd
37108
37109
37110 .section "Other log entries" "SECID259"
37111 Various other types of log entry are written from time to time. Most should be
37112 self-explanatory. Among the more common are:
37113
37114 .ilist
37115 .cindex "retry" "time not reached"
37116 &'retry time not reached'&&~&~An address previously suffered a temporary error
37117 during routing or local delivery, and the time to retry has not yet arrived.
37118 This message is not written to an individual message log file unless it happens
37119 during the first delivery attempt.
37120 .next
37121 &'retry time not reached for any host'&&~&~An address previously suffered
37122 temporary errors during remote delivery, and the retry time has not yet arrived
37123 for any of the hosts to which it is routed.
37124 .next
37125 .cindex "spool directory" "file locked"
37126 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37127 some other Exim process is already working on the message. This can be quite
37128 common if queue running processes are started at frequent intervals. The
37129 &'exiwhat'& utility script can be used to find out what Exim processes are
37130 doing.
37131 .next
37132 .cindex "error" "ignored"
37133 &'error ignored'&&~&~There are several circumstances that give rise to this
37134 message:
37135 .olist
37136 Exim failed to deliver a bounce message whose age was greater than
37137 &%ignore_bounce_errors_after%&. The bounce was discarded.
37138 .next
37139 A filter file set up a delivery using the &"noerror"& option, and the delivery
37140 failed. The delivery was discarded.
37141 .next
37142 A delivery set up by a router configured with
37143 . ==== As this is a nested list, any displays it contains must be indented
37144 . ==== as otherwise they are too far to the left.
37145 .code
37146     errors_to = <>
37147 .endd
37148 failed. The delivery was discarded.
37149 .endlist olist
37150 .next
37151 .cindex DKIM "log line"
37152 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37153 logging and the message has a DKIM signature header.
37154 .endlist ilist
37155
37156
37157
37158
37159
37160 .section "Reducing or increasing what is logged" "SECTlogselector"
37161 .cindex "log" "selectors"
37162 By setting the &%log_selector%& global option, you can disable some of Exim's
37163 default logging, or you can request additional logging. The value of
37164 &%log_selector%& is made up of names preceded by plus or minus characters. For
37165 example:
37166 .code
37167 log_selector = +arguments -retry_defer
37168 .endd
37169 The list of optional log items is in the following table, with the default
37170 selection marked by asterisks:
37171 .display
37172 &` 8bitmime                   `&  received 8BITMIME status
37173 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37174 &` address_rewrite            `&  address rewriting
37175 &` all_parents                `&  all parents in => lines
37176 &` arguments                  `&  command line arguments
37177 &`*connection_reject          `&  connection rejections
37178 &`*delay_delivery             `&  immediate delivery delayed
37179 &` deliver_time               `&  time taken to perform delivery
37180 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37181 &`*dkim                       `&  DKIM verified domain on <= lines
37182 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37183 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37184 &` dnssec                     `&  DNSSEC secured lookups
37185 &`*etrn                       `&  ETRN commands
37186 &`*host_lookup_failed         `&  as it says
37187 &` ident_timeout              `&  timeout for ident connection
37188 &` incoming_interface         `&  local interface on <= and => lines
37189 &` incoming_port              `&  remote port on <= lines
37190 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37191 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37192 &`*msg_id                     `&  on <= lines, Message-ID: header value
37193 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37194 &` outgoing_interface         `&  local interface on => lines
37195 &` outgoing_port              `&  add remote port to => lines
37196 &`*queue_run                  `&  start and end queue runs
37197 &` queue_time                 `&  time on queue for one recipient
37198 &` queue_time_overall         `&  time on queue for whole message
37199 &` pid                        `&  Exim process id
37200 &` pipelining                 `&  PIPELINING use, on <= and => lines
37201 &` proxy                      `&  proxy address on <= and => lines
37202 &` receive_time               `&  time taken to receive message
37203 &` received_recipients        `&  recipients on <= lines
37204 &` received_sender            `&  sender on <= lines
37205 &`*rejected_header            `&  header contents on reject log
37206 &`*retry_defer                `&  &"retry time not reached"&
37207 &` return_path_on_delivery    `&  put return path on => and ** lines
37208 &` sender_on_delivery         `&  add sender to => lines
37209 &`*sender_verify_fail         `&  sender verification failures
37210 &`*size_reject                `&  rejection because too big
37211 &`*skip_delivery              `&  delivery skipped in a queue run
37212 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37213 &` smtp_connection            `&  incoming SMTP connections
37214 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37215 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37216 &` smtp_no_mail               `&  session with no MAIL commands
37217 &` smtp_protocol_error        `&  SMTP protocol errors
37218 &` smtp_syntax_error          `&  SMTP syntax errors
37219 &` subject                    `&  contents of &'Subject:'& on <= lines
37220 &`*tls_certificate_verified   `&  certificate verification status
37221 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37222 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37223 &` tls_sni                    `&  TLS SNI on <= lines
37224 &` unknown_in_list            `&  DNS lookup failed in list match
37225
37226 &` all                        `&  all of the above
37227 .endd
37228 See also the &%slow_lookup_log%& main configuration option,
37229 section &<<SECID99>>&
37230
37231 More details on each of these items follows:
37232
37233 .ilist
37234 .cindex "8BITMIME"
37235 .cindex "log" "8BITMIME"
37236 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37237 which may help in tracking down interoperability issues with ancient MTAs
37238 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37239 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37240 &`7BIT`& and &`8BITMIME`& respectively.
37241 .next
37242 .cindex "&%warn%& ACL verb" "log when skipping"
37243 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37244 its conditions cannot be evaluated, a log line to this effect is written if
37245 this log selector is set.
37246 .next
37247 .cindex "log" "rewriting"
37248 .cindex "rewriting" "logging"
37249 &%address_rewrite%&: This applies both to global rewrites and per-transport
37250 rewrites, but not to rewrites in filters run as an unprivileged user (because
37251 such users cannot access the log).
37252 .next
37253 .cindex "log" "full parentage"
37254 &%all_parents%&: Normally only the original and final addresses are logged on
37255 delivery lines; with this selector, intermediate parents are given in
37256 parentheses between them.
37257 .next
37258 .cindex "log" "Exim arguments"
37259 .cindex "Exim arguments, logging"
37260 &%arguments%&: This causes Exim to write the arguments with which it was called
37261 to the main log, preceded by the current working directory. This is a debugging
37262 feature, added to make it easier to find out how certain MUAs call
37263 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37264 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37265 that are empty or that contain white space are quoted. Non-printing characters
37266 are shown as escape sequences. This facility cannot log unrecognized arguments,
37267 because the arguments are checked before the configuration file is read. The
37268 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37269 between the caller and Exim.
37270 .next
37271 .cindex "log" "connection rejections"
37272 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37273 connection is rejected, for whatever reason.
37274 .next
37275 .cindex "log" "delayed delivery"
37276 .cindex "delayed delivery, logging"
37277 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37278 started for an incoming message because the load is too high or too many
37279 messages were received on one connection. Logging does not occur if no delivery
37280 process is started because &%queue_only%& is set or &%-odq%& was used.
37281 .next
37282 .cindex "log" "delivery duration"
37283 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37284 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37285 If millisecond logging is enabled, short times will be shown with greater
37286 precision, eg. &`DT=0.304s`&.
37287 .next
37288 .cindex "log" "message size on delivery"
37289 .cindex "size" "of message"
37290 &%delivery_size%&: For each delivery, the size of message delivered is added to
37291 the &"=>"& line, tagged with S=.
37292 .next
37293 .cindex log "DKIM verification"
37294 .cindex DKIM "verification logging"
37295 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37296 verifies successfully a tag of DKIM is added, with one of the verified domains.
37297 .next
37298 .cindex log "DKIM verification"
37299 .cindex DKIM "verification logging"
37300 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37301 .next
37302 .cindex "log" "dnslist defer"
37303 .cindex "DNS list" "logging defer"
37304 .cindex "black list (DNS)"
37305 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37306 DNS black list suffers a temporary error.
37307 .next
37308 .cindex log dnssec
37309 .cindex dnssec logging
37310 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37311 dns lookups gave secure results a tag of DS is added.
37312 For acceptance this covers the reverse and forward lookups for host name verification.
37313 It does not cover helo-name verification.
37314 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37315 .next
37316 .cindex "log" "ETRN commands"
37317 .cindex "ETRN" "logging"
37318 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37319 is run to determine whether or not it is actually accepted. An invalid ETRN
37320 command, or one received within a message transaction is not logged by this
37321 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37322 .next
37323 .cindex "log" "host lookup failure"
37324 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37325 any addresses, or when a lookup of an IP address fails to find a host name, a
37326 log line is written. This logging does not apply to direct DNS lookups when
37327 routing email addresses, but it does apply to &"byname"& lookups.
37328 .next
37329 .cindex "log" "ident timeout"
37330 .cindex "RFC 1413" "logging timeout"
37331 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37332 client's ident port times out.
37333 .next
37334 .cindex "log" "incoming interface"
37335 .cindex "log" "local interface"
37336 .cindex "log" "local address and port"
37337 .cindex "TCP/IP" "logging local address and port"
37338 .cindex "interface" "logging"
37339 &%incoming_interface%&: The interface on which a message was received is added
37340 to the &"<="& line as an IP address in square brackets, tagged by I= and
37341 followed by a colon and the port number. The local interface and port are also
37342 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37343 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37344 The latter can be disabled by turning off the &%outgoing_interface%& option.
37345 .next
37346 .cindex log "incoming proxy address"
37347 .cindex proxy "logging proxy address"
37348 .cindex "TCP/IP" "logging proxy address"
37349 &%proxy%&: The internal (closest to the system running Exim) IP address
37350 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37351 on a proxied connection
37352 or the &"=>"& line for a message delivered on a proxied connection.
37353 See &<<SECTproxyInbound>>& for more information.
37354 .next
37355 .cindex "log" "incoming remote port"
37356 .cindex "port" "logging remote"
37357 .cindex "TCP/IP" "logging incoming remote port"
37358 .vindex "&$sender_fullhost$&"
37359 .vindex "&$sender_rcvhost$&"
37360 &%incoming_port%&: The remote port number from which a message was received is
37361 added to log entries and &'Received:'& header lines, following the IP address
37362 in square brackets, and separated from it by a colon. This is implemented by
37363 changing the value that is put in the &$sender_fullhost$& and
37364 &$sender_rcvhost$& variables. Recording the remote port number has become more
37365 important with the widening use of NAT (see RFC 2505).
37366 .next
37367 .cindex "log" "dropped connection"
37368 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37369 connection is unexpectedly dropped.
37370 .next
37371 .cindex "log" "millisecond timestamps"
37372 .cindex millisecond logging
37373 .cindex timestamps "millisecond, in logs"
37374 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37375 appended to the seconds value.
37376 .next
37377 .new
37378 .cindex "log" "message id"
37379 &%msg_id%&: The value of the Message-ID: header.
37380 .next
37381 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37382 This will be either because the message is a bounce, or was submitted locally
37383 (submission mode) without one.
37384 The field identifier will have an asterix appended: &"id*="&.
37385 .wen
37386 .next
37387 .cindex "log" "outgoing interface"
37388 .cindex "log" "local interface"
37389 .cindex "log" "local address and port"
37390 .cindex "TCP/IP" "logging local address and port"
37391 .cindex "interface" "logging"
37392 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37393 interface on which a message was sent is added to delivery lines as an I= tag
37394 followed by IP address in square brackets. You can disable this by turning
37395 off the &%outgoing_interface%& option.
37396 .next
37397 .cindex "log" "outgoing remote port"
37398 .cindex "port" "logging outgoing remote"
37399 .cindex "TCP/IP" "logging outgoing remote port"
37400 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37401 containing => tags) following the IP address.
37402 The local port is also added if &%incoming_interface%& and
37403 &%outgoing_interface%& are both enabled.
37404 This option is not included in the default setting, because for most ordinary
37405 configurations, the remote port number is always 25 (the SMTP port), and the
37406 local port is a random ephemeral port.
37407 .next
37408 .cindex "log" "process ids in"
37409 .cindex "pid (process id)" "in log lines"
37410 &%pid%&: The current process id is added to every log line, in square brackets,
37411 immediately after the time and date.
37412 .next
37413 .cindex log pipelining
37414 .cindex pipelining "logging outgoing"
37415 &%pipelining%&: A field is added to delivery and accept
37416 log lines when the ESMTP PIPELINING extension was used.
37417 The field is a single "L".
37418
37419 On accept lines, where PIPELINING was offered but not used by the client,
37420 the field has a minus appended.
37421
37422 .new
37423 .cindex "pipelining" "early connection"
37424 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37425 accept "L" fields have a period appended if the feature was
37426 offered but not used, or an asterisk appended if used.
37427 Delivery "L" fields have an asterisk appended if used.
37428 .wen
37429
37430 .next
37431 .cindex "log" "queue run"
37432 .cindex "queue runner" "logging"
37433 &%queue_run%&: The start and end of every queue run are logged.
37434 .next
37435 .cindex "log" "queue time"
37436 &%queue_time%&: The amount of time the message has been in the queue on the
37437 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37438 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37439 includes reception time as well as the delivery time for the current address.
37440 This means that it may be longer than the difference between the arrival and
37441 delivery log line times, because the arrival log line is not written until the
37442 message has been successfully received.
37443 If millisecond logging is enabled, short times will be shown with greater
37444 precision, eg. &`QT=1.578s`&.
37445 .next
37446 &%queue_time_overall%&: The amount of time the message has been in the queue on
37447 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37448 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37449 message, so it includes reception time as well as the total delivery time.
37450 .next
37451 .cindex "log" "receive duration"
37452 &%receive_time%&: For each message, the amount of real time it has taken to
37453 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37454 If millisecond logging is enabled, short times will be shown with greater
37455 precision, eg. &`RT=0.204s`&.
37456 .next
37457 .cindex "log" "recipients"
37458 &%received_recipients%&: The recipients of a message are listed in the main log
37459 as soon as the message is received. The list appears at the end of the log line
37460 that is written when a message is received, preceded by the word &"for"&. The
37461 addresses are listed after they have been qualified, but before any rewriting
37462 has taken place.
37463 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37464 in the list.
37465 .next
37466 .cindex "log" "sender reception"
37467 &%received_sender%&: The unrewritten original sender of a message is added to
37468 the end of the log line that records the message's arrival, after the word
37469 &"from"& (before the recipients if &%received_recipients%& is also set).
37470 .next
37471 .cindex "log" "header lines for rejection"
37472 &%rejected_header%&: If a message's header has been received at the time a
37473 rejection is written to the reject log, the complete header is added to the
37474 log. Header logging can be turned off individually for messages that are
37475 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37476 .next
37477 .cindex "log" "retry defer"
37478 &%retry_defer%&: A log line is written if a delivery is deferred because a
37479 retry time has not yet been reached. However, this &"retry time not reached"&
37480 message is always omitted from individual message logs after the first delivery
37481 attempt.
37482 .next
37483 .cindex "log" "return path"
37484 &%return_path_on_delivery%&: The return path that is being transmitted with
37485 the message is included in delivery and bounce lines, using the tag P=.
37486 This is omitted if no delivery actually happens, for example, if routing fails,
37487 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37488 .next
37489 .cindex "log" "sender on delivery"
37490 &%sender_on_delivery%&: The message's sender address is added to every delivery
37491 and bounce line, tagged by F= (for &"from"&).
37492 This is the original sender that was received with the message; it is not
37493 necessarily the same as the outgoing return path.
37494 .next
37495 .cindex "log" "sender verify failure"
37496 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37497 gives details of a sender verification failure is not written. Log lines for
37498 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37499 detail is lost.
37500 .next
37501 .cindex "log" "size rejection"
37502 &%size_reject%&: A log line is written whenever a message is rejected because
37503 it is too big.
37504 .next
37505 .cindex "log" "frozen messages; skipped"
37506 .cindex "frozen messages" "logging skipping"
37507 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37508 queue run because it is frozen or because another process is already delivering
37509 it.
37510 .cindex "&""spool file is locked""&"
37511 The message that is written is &"spool file is locked"&.
37512 .next
37513 .cindex "log" "smtp confirmation"
37514 .cindex "SMTP" "logging confirmation"
37515 .cindex "LMTP" "logging confirmation"
37516 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37517 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37518 A number of MTAs (including Exim) return an identifying string in this
37519 response.
37520 .next
37521 .cindex "log" "SMTP connections"
37522 .cindex "SMTP" "logging connections"
37523 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37524 established or closed, unless the connection is from a host that matches
37525 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37526 only when the closure is unexpected.) This applies to connections from local
37527 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37528 dropped in the middle of a message, a log line is always written, whether or
37529 not this selector is set, but otherwise nothing is written at the start and end
37530 of connections unless this selector is enabled.
37531
37532 For TCP/IP connections to an Exim daemon, the current number of connections is
37533 included in the log message for each new connection, but note that the count is
37534 reset if the daemon is restarted.
37535 Also, because connections are closed (and the closure is logged) in
37536 subprocesses, the count may not include connections that have been closed but
37537 whose termination the daemon has not yet noticed. Thus, while it is possible to
37538 match up the opening and closing of connections in the log, the value of the
37539 logged counts may not be entirely accurate.
37540 .next
37541 .cindex "log" "SMTP transaction; incomplete"
37542 .cindex "SMTP" "logging incomplete transactions"
37543 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37544 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37545 and the message sender plus any accepted recipients are included in the log
37546 line. This can provide evidence of dictionary attacks.
37547 .next
37548 .cindex "log" "non-MAIL SMTP sessions"
37549 .cindex "MAIL" "logging session without"
37550 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37551 connection terminates without having issued a MAIL command. This includes both
37552 the case when the connection is dropped, and the case when QUIT is used. It
37553 does not include cases where the connection is rejected right at the start (by
37554 an ACL, or because there are too many connections, or whatever). These cases
37555 already have their own log lines.
37556
37557 The log line that is written contains the identity of the client in the usual
37558 way, followed by D= and a time, which records the duration of the connection.
37559 If the connection was authenticated, this fact is logged exactly as it is for
37560 an incoming message, with an A= item. If the connection was encrypted, CV=,
37561 DN=, and X= items may appear as they do for an incoming message, controlled by
37562 the same logging options.
37563
37564 Finally, if any SMTP commands were issued during the connection, a C= item
37565 is added to the line, listing the commands that were used. For example,
37566 .code
37567 C=EHLO,QUIT
37568 .endd
37569 shows that the client issued QUIT straight after EHLO. If there were fewer
37570 than 20 commands, they are all listed. If there were more than 20 commands,
37571 the last 20 are listed, preceded by &"..."&. However, with the default
37572 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37573 have been aborted before 20 non-mail commands are processed.
37574 .next
37575 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37576 colon-separated, is appended to the A= item for a message arrival or delivery
37577 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37578 was accepted or used.
37579 .next
37580 .cindex "log" "SMTP protocol error"
37581 .cindex "SMTP" "logging protocol error"
37582 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37583 encountered. Exim does not have perfect detection of all protocol errors
37584 because of transmission delays and the use of pipelining. If PIPELINING has
37585 been advertised to a client, an Exim server assumes that the client will use
37586 it, and therefore it does not count &"expected"& errors (for example, RCPT
37587 received after rejecting MAIL) as protocol errors.
37588 .next
37589 .cindex "SMTP" "logging syntax errors"
37590 .cindex "SMTP" "syntax errors; logging"
37591 .cindex "SMTP" "unknown command; logging"
37592 .cindex "log" "unknown SMTP command"
37593 .cindex "log" "SMTP syntax error"
37594 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37595 encountered. An unrecognized command is treated as a syntax error. For an
37596 external connection, the host identity is given; for an internal connection
37597 using &%-bs%& the sender identification (normally the calling user) is given.
37598 .next
37599 .cindex "log" "subject"
37600 .cindex "subject, logging"
37601 &%subject%&: The subject of the message is added to the arrival log line,
37602 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37603 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37604 specifies whether characters with values greater than 127 should be logged
37605 unchanged, or whether they should be rendered as escape sequences.
37606 .next
37607 .cindex "log" "certificate verification"
37608 .cindex log DANE
37609 .cindex DANE logging
37610 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37611 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37612 verified
37613 using a CA trust anchor,
37614 &`CA=dane`& if using a DNS trust anchor,
37615 and &`CV=no`& if not.
37616 .next
37617 .cindex "log" "TLS cipher"
37618 .cindex "TLS" "logging cipher"
37619 &%tls_cipher%&: When a message is sent or received over an encrypted
37620 connection, the cipher suite used is added to the log line, preceded by X=.
37621 .next
37622 .cindex "log" "TLS peer DN"
37623 .cindex "TLS" "logging peer DN"
37624 &%tls_peerdn%&: When a message is sent or received over an encrypted
37625 connection, and a certificate is supplied by the remote host, the peer DN is
37626 added to the log line, preceded by DN=.
37627 .next
37628 .cindex "log" "TLS SNI"
37629 .cindex "TLS" "logging SNI"
37630 &%tls_sni%&: When a message is received over an encrypted connection, and
37631 the remote host provided the Server Name Indication extension, the SNI is
37632 added to the log line, preceded by SNI=.
37633 .next
37634 .cindex "log" "DNS failure in list"
37635 &%unknown_in_list%&: This setting causes a log entry to be written when the
37636 result of a list match is failure because a DNS lookup failed.
37637 .endlist
37638
37639
37640 .section "Message log" "SECID260"
37641 .cindex "message" "log file for"
37642 .cindex "log" "message log; description of"
37643 .cindex "&_msglog_& directory"
37644 .oindex "&%preserve_message_logs%&"
37645 In addition to the general log files, Exim writes a log file for each message
37646 that it handles. The names of these per-message logs are the message ids, and
37647 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37648 message log contains copies of the log lines that apply to the message. This
37649 makes it easier to inspect the status of an individual message without having
37650 to search the main log. A message log is deleted when processing of the message
37651 is complete, unless &%preserve_message_logs%& is set, but this should be used
37652 only with great care because they can fill up your disk very quickly.
37653
37654 On a heavily loaded system, it may be desirable to disable the use of
37655 per-message logs, in order to reduce disk I/O. This can be done by setting the
37656 &%message_logs%& option false.
37657 .ecindex IIDloggen
37658
37659
37660
37661
37662 . ////////////////////////////////////////////////////////////////////////////
37663 . ////////////////////////////////////////////////////////////////////////////
37664
37665 .chapter "Exim utilities" "CHAPutils"
37666 .scindex IIDutils "utilities"
37667 A number of utility scripts and programs are supplied with Exim and are
37668 described in this chapter. There is also the Exim Monitor, which is covered in
37669 the next chapter. The utilities described here are:
37670
37671 .itable none 0 0 3  7* left  15* left  40* left
37672 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37673   "list what Exim processes are doing"
37674 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37675 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37676 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37677 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37678                                                 various criteria"
37679 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37680 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37681   "extract statistics from the log"
37682 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37683   "check address acceptance from given IP"
37684 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37685 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37686 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37687 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37688 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37689 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37690 .endtable
37691
37692 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37693 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37694 &url(https://duncanthrax.net/exilog/) for details.
37695
37696
37697
37698
37699 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37700 .cindex "&'exiwhat'&"
37701 .cindex "process, querying"
37702 .cindex "SIGUSR1"
37703 On operating systems that can restart a system call after receiving a signal
37704 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37705 a line describing what it is doing to the file &_exim-process.info_& in the
37706 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37707 processes it can find, having first emptied the file. It then waits for one
37708 second to allow the Exim processes to react before displaying the results. In
37709 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37710 send the signal to the Exim processes, so it is normally run as root.
37711
37712 &*Warning*&: This is not an efficient process. It is intended for occasional
37713 use by system administrators. It is not sensible, for example, to set up a
37714 script that sends SIGUSR1 signals to Exim processes at short intervals.
37715
37716
37717 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37718 varies in different operating systems. Not only are different options used,
37719 but the format of the output is different. For this reason, there are some
37720 system configuration options that configure exactly how &'exiwhat'& works. If
37721 it doesn't seem to be working for you, check the following compile-time
37722 options:
37723 .display
37724 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37725 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37726 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37727 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37728 .endd
37729 An example of typical output from &'exiwhat'& is
37730 .code
37731 164 daemon: -q1h, listening on port 25
37732 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37733 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37734   [10.19.42.42] (editor@ref.example)
37735 10592 handling incoming call from [192.168.243.242]
37736 10628 accepting a local non-SMTP message
37737 .endd
37738 The first number in the output line is the process number. The third line has
37739 been split here, in order to fit it on the page.
37740
37741
37742
37743 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37744 .cindex "&'exiqgrep'&"
37745 .cindex "queue" "grepping"
37746 This utility is a Perl script contributed by Matt Hubbard. It runs
37747 .code
37748 exim -bpu
37749 .endd
37750 or (in case &*-a*& switch is specified)
37751 .code
37752 exim -bp
37753 .endd
37754 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37755 contain alternate exim configuration the queue management might be using.
37756
37757 to obtain a queue listing, and then greps the output to select messages
37758 that match given criteria. The following selection options are available:
37759
37760 .vlist
37761 .vitem &*-f*&&~<&'regex'&>
37762 Match the sender address using a case-insensitive search. The field that is
37763 tested is enclosed in angle brackets, so you can test for bounce messages with
37764 .code
37765 exiqgrep -f '^<>$'
37766 .endd
37767 .vitem &*-r*&&~<&'regex'&>
37768 Match a recipient address using a case-insensitive search. The field that is
37769 tested is not enclosed in angle brackets.
37770
37771 .vitem &*-s*&&~<&'regex'&>
37772 Match against the size field.
37773
37774 .vitem &*-y*&&~<&'seconds'&>
37775 Match messages that are younger than the given time.
37776
37777 .vitem &*-o*&&~<&'seconds'&>
37778 Match messages that are older than the given time.
37779
37780 .vitem &*-z*&
37781 Match only frozen messages.
37782
37783 .vitem &*-x*&
37784 Match only non-frozen messages.
37785
37786 .new
37787 .vitem &*-G*&&~<&'queuename'&>
37788 Match only messages in the given queue.  Without this, the default queue is searched.
37789 .wen
37790 .endlist
37791
37792 The following options control the format of the output:
37793
37794 .vlist
37795 .vitem &*-c*&
37796 Display only the count of matching messages.
37797
37798 .vitem &*-l*&
37799 Long format &-- display the full message information as output by Exim. This is
37800 the default.
37801
37802 .vitem &*-i*&
37803 Display message ids only.
37804
37805 .vitem &*-b*&
37806 Brief format &-- one line per message.
37807
37808 .vitem &*-R*&
37809 Display messages in reverse order.
37810
37811 .vitem &*-a*&
37812 Include delivered recipients in queue listing.
37813 .endlist
37814
37815 There is one more option, &%-h%&, which outputs a list of options.
37816
37817
37818
37819 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
37820 .cindex "&'exiqsumm'&"
37821 .cindex "queue" "summary"
37822 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
37823 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
37824 running a command such as
37825 .code
37826 exim -bp | exiqsumm
37827 .endd
37828 The output consists of one line for each domain that has messages waiting for
37829 it, as in the following example:
37830 .code
37831 3   2322   74m   66m  msn.com.example
37832 .endd
37833 Each line lists the number of pending deliveries for a domain, their total
37834 volume, and the length of time that the oldest and the newest messages have
37835 been waiting. Note that the number of pending deliveries is greater than the
37836 number of messages when messages have more than one recipient.
37837
37838 A summary line is output at the end. By default the output is sorted on the
37839 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
37840 the output to be sorted by oldest message and by count of messages,
37841 respectively. There are also three options that split the messages for each
37842 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
37843 separates frozen messages, and &%-s%& separates messages according to their
37844 sender.
37845
37846 The output of &'exim -bp'& contains the original addresses in the message, so
37847 this also applies to the output from &'exiqsumm'&. No domains from addresses
37848 generated by aliasing or forwarding are included (unless the &%one_time%&
37849 option of the &(redirect)& router has been used to convert them into &"top
37850 level"& addresses).
37851
37852
37853
37854
37855 .section "Extracting specific information from the log (exigrep)" &&&
37856          "SECTextspeinf"
37857 .cindex "&'exigrep'&"
37858 .cindex "log" "extracts; grepping for"
37859 The &'exigrep'& utility is a Perl script that searches one or more main log
37860 files for entries that match a given pattern. When it finds a match, it
37861 extracts all the log entries for the relevant message, not just those that
37862 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
37863 given message, or all mail for a given user, or for a given host, for example.
37864 The input files can be in Exim log format or syslog format.
37865 If a matching log line is not associated with a specific message, it is
37866 included in &'exigrep'&'s output without any additional lines. The usage is:
37867 .display
37868 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
37869 .endd
37870 If no log filenames are given on the command line, the standard input is read.
37871
37872 The &%-t%& argument specifies a number of seconds. It adds an additional
37873 condition for message selection. Messages that are complete are shown only if
37874 they spent more than <&'n'&> seconds in the queue.
37875
37876 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
37877 makes it case-sensitive. This may give a performance improvement when searching
37878 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
37879 option; with &%-I%& they do not. In both cases it is possible to change the
37880 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
37881
37882 The &%-l%& option means &"literal"&, that is, treat all characters in the
37883 pattern as standing for themselves. Otherwise the pattern must be a Perl
37884 regular expression.
37885
37886 The &%-v%& option inverts the matching condition. That is, a line is selected
37887 if it does &'not'& match the pattern.
37888
37889 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
37890 that are generated as a result/response to a message that &'exigrep'& matched
37891 normally.
37892
37893 Example of &%-M%&:
37894 user_a sends a message to user_b, which generates a bounce back to user_b. If
37895 &'exigrep'& is used to search for &"user_a"&, only the first message will be
37896 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
37897 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
37898 when searching for &"user_a"& will show both messages since the bounce is
37899 &"related"& to or a &"result"& of the first message that was found by the
37900 search term.
37901
37902 If the location of a &'zcat'& command is known from the definition of
37903 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
37904 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
37905 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
37906 autodetection of some well known compression extensions.
37907
37908
37909 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
37910 .cindex "&'exipick'&"
37911 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
37912 lists messages from the queue according to a variety of criteria. For details
37913 of &'exipick'&'s facilities, run &'exipick'& with
37914 the &%--help%& option.
37915
37916
37917 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
37918 .cindex "log" "cycling local files"
37919 .cindex "cycling logs"
37920 .cindex "&'exicyclog'&"
37921 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
37922 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
37923 you are using log files with datestamps in their names (see section
37924 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
37925 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
37926 There are two command line options for &'exicyclog'&:
37927 .ilist
37928 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
37929 default that is set when Exim is built. The default default is 10.
37930 .next
37931 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
37932 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
37933 overriding the script's default, which is to find the setting from Exim's
37934 configuration.
37935 .endlist
37936
37937 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
37938 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
37939 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
37940 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
37941 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
37942 logs are handled similarly.
37943
37944 If the limit is greater than 99, the script uses 3-digit numbers such as
37945 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
37946 to one that is greater, or &'vice versa'&, you will have to fix the names of
37947 any existing log files.
37948
37949 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
37950 the end are deleted. All files with numbers greater than 01 are compressed,
37951 using a compression command which is configured by the COMPRESS_COMMAND
37952 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
37953 root &%crontab%& entry of the form
37954 .code
37955 1 0 * * * su exim -c /usr/exim/bin/exicyclog
37956 .endd
37957 assuming you have used the name &"exim"& for the Exim user. You can run
37958 &'exicyclog'& as root if you wish, but there is no need.
37959
37960
37961
37962 .section "Mail statistics (eximstats)" "SECTmailstat"
37963 .cindex "statistics"
37964 .cindex "&'eximstats'&"
37965 A Perl script called &'eximstats'& is provided for extracting statistical
37966 information from log files. The output is either plain text, or HTML.
37967 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
37968 . --- 404 error and everything else points to that.
37969
37970 The &'eximstats'& script has been hacked about quite a bit over time. The
37971 latest version is the result of some extensive revision by Steve Campbell. A
37972 lot of information is given by default, but there are options for suppressing
37973 various parts of it. Following any options, the arguments to the script are a
37974 list of files, which should be main log files. For example:
37975 .code
37976 eximstats -nr /var/spool/exim/log/mainlog.01
37977 .endd
37978 By default, &'eximstats'& extracts information about the number and volume of
37979 messages received from or delivered to various hosts. The information is sorted
37980 both by message count and by volume, and the top fifty hosts in each category
37981 are listed on the standard output. Similar information, based on email
37982 addresses or domains instead of hosts can be requested by means of various
37983 options. For messages delivered and received locally, similar statistics are
37984 also produced per user.
37985
37986 The output also includes total counts and statistics about delivery errors, and
37987 histograms showing the number of messages received and deliveries made in each
37988 hour of the day. A delivery with more than one address in its envelope (for
37989 example, an SMTP transaction with more than one RCPT command) is counted
37990 as a single delivery by &'eximstats'&.
37991
37992 Though normally more deliveries than receipts are reported (as messages may
37993 have multiple recipients), it is possible for &'eximstats'& to report more
37994 messages received than delivered, even though the queue is empty at the start
37995 and end of the period in question. If an incoming message contains no valid
37996 recipients, no deliveries are recorded for it. A bounce message is handled as
37997 an entirely separate message.
37998
37999 &'eximstats'& always outputs a grand total summary giving the volume and number
38000 of messages received and deliveries made, and the number of hosts involved in
38001 each case. It also outputs the number of messages that were delayed (that is,
38002 not completely delivered at the first attempt), and the number that had at
38003 least one address that failed.
38004
38005 The remainder of the output is in sections that can be independently disabled
38006 or modified by various options. It consists of a summary of deliveries by
38007 transport, histograms of messages received and delivered per time interval
38008 (default per hour), information about the time messages spent in the queue,
38009 a list of relayed messages, lists of the top fifty sending hosts, local
38010 senders, destination hosts, and destination local users by count and by volume,
38011 and a list of delivery errors that occurred.
38012
38013 The relay information lists messages that were actually relayed, that is, they
38014 came from a remote host and were directly delivered to some other remote host,
38015 without being processed (for example, for aliasing or forwarding) locally.
38016
38017 There are quite a few options for &'eximstats'& to control exactly what it
38018 outputs. These are documented in the Perl script itself, and can be extracted
38019 by running the command &(perldoc)& on the script. For example:
38020 .code
38021 perldoc /usr/exim/bin/eximstats
38022 .endd
38023
38024 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38025 .cindex "&'exim_checkaccess'&"
38026 .cindex "policy control" "checking access"
38027 .cindex "checking access"
38028 The &%-bh%& command line argument allows you to run a fake SMTP session with
38029 debugging output, in order to check what Exim is doing when it is applying
38030 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38031 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38032 sometimes you just want to answer the question &"Does this address have
38033 access?"& without bothering with any further details.
38034
38035 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38036 two arguments, an IP address and an email address:
38037 .code
38038 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38039 .endd
38040 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38041 given email address would be accepted in a RCPT command in a TCP/IP
38042 connection from the host with the given IP address. The output of the utility
38043 is either the word &"accepted"&, or the SMTP error response, for example:
38044 .code
38045 Rejected:
38046 550 Relay not permitted
38047 .endd
38048 When running this test, the utility uses &`<>`& as the envelope sender address
38049 for the MAIL command, but you can change this by providing additional
38050 options. These are passed directly to the Exim command. For example, to specify
38051 that the test is to be run with the sender address &'himself@there.example'&
38052 you can use:
38053 .code
38054 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38055                  -f himself@there.example
38056 .endd
38057 Note that these additional Exim command line items must be given after the two
38058 mandatory arguments.
38059
38060 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38061 while running its checks. You can run checks that include callouts by using
38062 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38063
38064
38065
38066 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38067 .cindex "DBM" "building dbm files"
38068 .cindex "building DBM files"
38069 .cindex "&'exim_dbmbuild'&"
38070 .cindex "lower casing"
38071 .cindex "binary zero" "in lookup key"
38072 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38073 the format used by the &(lsearch)& lookup (see section
38074 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38075 names as keys and the remainder of the information as data. The lower-casing
38076 can be prevented by calling the program with the &%-nolc%& option.
38077
38078 A terminating zero is included as part of the key string. This is expected by
38079 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38080 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38081 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38082 files.
38083
38084 The program requires two arguments: the name of the input file (which can be a
38085 single hyphen to indicate the standard input), and the name of the output file.
38086 It creates the output under a temporary name, and then renames it if all went
38087 well.
38088
38089 .cindex "USE_DB"
38090 If the native DB interface is in use (USE_DB is set in a compile-time
38091 configuration file &-- this is common in free versions of Unix) the two
38092 filenames must be different, because in this mode the Berkeley DB functions
38093 create a single output file using exactly the name given. For example,
38094 .code
38095 exim_dbmbuild /etc/aliases /etc/aliases.db
38096 .endd
38097 reads the system alias file and creates a DBM version of it in
38098 &_/etc/aliases.db_&.
38099
38100 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38101 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38102 environment, the suffixes are added to the second argument of
38103 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38104 when the Berkeley functions are used in compatibility mode (though this is not
38105 recommended), because in that case it adds a &_.db_& suffix to the filename.
38106
38107 If a duplicate key is encountered, the program outputs a warning, and when it
38108 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38109 option is used. By default, only the first of a set of duplicates is used &--
38110 this makes it compatible with &(lsearch)& lookups. There is an option
38111 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38112 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38113 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38114 return code is 2.
38115
38116
38117
38118
38119 .section "Finding individual retry times (exinext)" "SECTfinindret"
38120 .cindex "retry" "times"
38121 .cindex "&'exinext'&"
38122 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38123 fish specific information out of the retry database. Given a mail domain (or a
38124 complete address), it looks up the hosts for that domain, and outputs any retry
38125 information for the hosts or for the domain. At present, the retry information
38126 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38127 output. For example:
38128 .code
38129 $ exinext piglet@milne.fict.example
38130 kanga.milne.example:192.168.8.1 error 146: Connection refused
38131   first failed: 21-Feb-1996 14:57:34
38132   last tried:   21-Feb-1996 14:57:34
38133   next try at:  21-Feb-1996 15:02:34
38134 roo.milne.example:192.168.8.3 error 146: Connection refused
38135   first failed: 20-Jan-1996 13:12:08
38136   last tried:   21-Feb-1996 11:42:03
38137   next try at:  21-Feb-1996 19:42:03
38138   past final cutoff time
38139 .endd
38140 You can also give &'exinext'& a local part, without a domain, and it
38141 will give any retry information for that local part in your default domain.
38142 A message id can be used to obtain retry information pertaining to a specific
38143 message. This exists only when an attempt to deliver a message to a remote host
38144 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38145 &'exinext'& is not particularly efficient, but then it is not expected to be
38146 run very often.
38147
38148 The &'exinext'& utility calls Exim to find out information such as the location
38149 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38150 passed on to the &'exim'& commands. The first specifies an alternate Exim
38151 configuration file, and the second sets macros for use within the configuration
38152 file. These features are mainly to help in testing, but might also be useful in
38153 environments where more than one configuration file is in use.
38154
38155
38156
38157 .section "Hints database maintenance" "SECThindatmai"
38158 .cindex "hints database" "maintenance"
38159 .cindex "maintaining Exim's hints database"
38160 Three utility programs are provided for maintaining the DBM files that Exim
38161 uses to contain its delivery hint information. Each program requires two
38162 arguments. The first specifies the name of Exim's spool directory, and the
38163 second is the name of the database it is to operate on. These are as follows:
38164
38165 .ilist
38166 &'retry'&: the database of retry information
38167 .next
38168 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38169 for remote hosts
38170 .next
38171 &'callout'&: the callout cache
38172 .next
38173 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38174 .next
38175 &'misc'&: other hints data
38176 .endlist
38177
38178 The &'misc'& database is used for
38179
38180 .ilist
38181 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38182 .next
38183 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38184 &(smtp)& transport)
38185 .next
38186 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38187 in a transport)
38188 .endlist
38189
38190
38191
38192 .section "exim_dumpdb" "SECID261"
38193 .cindex "&'exim_dumpdb'&"
38194 The entire contents of a database are written to the standard output by the
38195 &'exim_dumpdb'& program, which has no options or arguments other than the
38196 spool and database names. For example, to dump the retry database:
38197 .code
38198 exim_dumpdb /var/spool/exim retry
38199 .endd
38200 Two lines of output are produced for each entry:
38201 .code
38202 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38203 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38204 .endd
38205 The first item on the first line is the key of the record. It starts with one
38206 of the letters R, or T, depending on whether it refers to a routing or
38207 transport retry. For a local delivery, the next part is the local address; for
38208 a remote delivery it is the name of the remote host, followed by its failing IP
38209 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38210 transport). If the remote port is not the standard one (port 25), it is added
38211 to the IP address. Then there follows an error code, an additional error code,
38212 and a textual description of the error.
38213
38214 The three times on the second line are the time of first failure, the time of
38215 the last delivery attempt, and the computed time for the next attempt. The line
38216 ends with an asterisk if the cutoff time for the last retry rule has been
38217 exceeded.
38218
38219 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38220 consists of a host name followed by a list of ids for messages that are or were
38221 waiting to be delivered to that host. If there are a very large number for any
38222 one host, continuation records, with a sequence number added to the host name,
38223 may be seen. The data in these records is often out of date, because a message
38224 may be routed to several alternative hosts, and Exim makes no effort to keep
38225 cross-references.
38226
38227
38228
38229 .section "exim_tidydb" "SECID262"
38230 .cindex "&'exim_tidydb'&"
38231 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38232 database. If run with no options, it removes all records that are more than 30
38233 days old. The age is calculated from the date and time that the record was last
38234 updated. Note that, in the case of the retry database, it is &'not'& the time
38235 since the first delivery failure. Information about a host that has been down
38236 for more than 30 days will remain in the database, provided that the record is
38237 updated sufficiently often.
38238
38239 The cutoff date can be altered by means of the &%-t%& option, which must be
38240 followed by a time. For example, to remove all records older than a week from
38241 the retry database:
38242 .code
38243 exim_tidydb -t 7d /var/spool/exim retry
38244 .endd
38245 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38246 message ids. In the former these appear as data in records keyed by host &--
38247 they were messages that were waiting for that host &-- and in the latter they
38248 are the keys for retry information for messages that have suffered certain
38249 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38250 message ids in database records are those of messages that are still on the
38251 queue. Message ids for messages that no longer exist are removed from
38252 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38253 For the &'retry'& database, records whose keys are non-existent message ids are
38254 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38255 whenever it removes information from the database.
38256
38257 Certain records are automatically removed by Exim when they are no longer
38258 needed, but others are not. For example, if all the MX hosts for a domain are
38259 down, a retry record is created for each one. If the primary MX host comes back
38260 first, its record is removed when Exim successfully delivers to it, but the
38261 records for the others remain because Exim has not tried to use those hosts.
38262
38263 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38264 hints databases. You should do this at a quiet time of day, because it requires
38265 a database to be locked (and therefore inaccessible to Exim) while it does its
38266 work. Removing records from a DBM file does not normally make the file smaller,
38267 but all the common DBM libraries are able to re-use the space that is released.
38268 After an initial phase of increasing in size, the databases normally reach a
38269 point at which they no longer get any bigger, as long as they are regularly
38270 tidied.
38271
38272 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38273 databases is likely to keep on increasing.
38274
38275
38276
38277
38278 .section "exim_fixdb" "SECID263"
38279 .cindex "&'exim_fixdb'&"
38280 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38281 Its main use is for testing Exim, but it might also be occasionally useful for
38282 getting round problems in a live system. It has no options, and its interface
38283 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38284 key of a database record can then be entered, and the data for that record is
38285 displayed.
38286
38287 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38288 except the &'retry'& database, that is the only operation that can be carried
38289 out. For the &'retry'& database, each field is output preceded by a number, and
38290 data for individual fields can be changed by typing the field number followed
38291 by new data, for example:
38292 .code
38293 > 4 951102:1000
38294 .endd
38295 resets the time of the next delivery attempt. Time values are given as a
38296 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38297 used as optional separators.
38298
38299
38300
38301
38302 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38303 .cindex "mailbox" "maintenance"
38304 .cindex "&'exim_lock'&"
38305 .cindex "locking mailboxes"
38306 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38307 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38308 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38309 a user agent while investigating a problem. The utility requires the name of
38310 the file as its first argument. If the locking is successful, the second
38311 argument is run as a command (using C's &[system()]& function); if there is no
38312 second argument, the value of the SHELL environment variable is used; if this
38313 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38314 is unlocked and the utility ends. The following options are available:
38315
38316 .vlist
38317 .vitem &%-fcntl%&
38318 Use &[fcntl()]& locking on the open mailbox.
38319
38320 .vitem &%-flock%&
38321 Use &[flock()]& locking on the open mailbox, provided the operating system
38322 supports it.
38323
38324 .vitem &%-interval%&
38325 This must be followed by a number, which is a number of seconds; it sets the
38326 interval to sleep between retries (default 3).
38327
38328 .vitem &%-lockfile%&
38329 Create a lock file before opening the mailbox.
38330
38331 .vitem &%-mbx%&
38332 Lock the mailbox using MBX rules.
38333
38334 .vitem &%-q%&
38335 Suppress verification output.
38336
38337 .vitem &%-retries%&
38338 This must be followed by a number; it sets the number of times to try to get
38339 the lock (default 10).
38340
38341 .vitem &%-restore_time%&
38342 This option causes &%exim_lock%& to restore the modified and read times to the
38343 locked file before exiting. This allows you to access a locked mailbox (for
38344 example, to take a backup copy) without disturbing the times that the user
38345 subsequently sees.
38346
38347 .vitem &%-timeout%&
38348 This must be followed by a number, which is a number of seconds; it sets a
38349 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38350 default), a non-blocking call is used.
38351
38352 .vitem &%-v%&
38353 Generate verbose output.
38354 .endlist
38355
38356 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38357 default is to create a lock file and also to use &[fcntl()]& locking on the
38358 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38359 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38360 requires that the directory containing the file be writeable. Locking by lock
38361 file does not last forever; Exim assumes that a lock file is expired if it is
38362 more than 30 minutes old.
38363
38364 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38365 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38366 to be taken out on the open mailbox, and an exclusive lock on the file
38367 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38368 number of the mailbox file. When the locking is released, if an exclusive lock
38369 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38370
38371 The default output contains verification of the locking that takes place. The
38372 &%-v%& option causes some additional information to be given. The &%-q%& option
38373 suppresses all output except error messages.
38374
38375 A command such as
38376 .code
38377 exim_lock /var/spool/mail/spqr
38378 .endd
38379 runs an interactive shell while the file is locked, whereas
38380 .display
38381 &`exim_lock -q /var/spool/mail/spqr <<End`&
38382 <&'some commands'&>
38383 &`End`&
38384 .endd
38385 runs a specific non-interactive sequence of commands while the file is locked,
38386 suppressing all verification output. A single command can be run by a command
38387 such as
38388 .code
38389 exim_lock -q /var/spool/mail/spqr \
38390   "cp /var/spool/mail/spqr /some/where"
38391 .endd
38392 Note that if a command is supplied, it must be entirely contained within the
38393 second argument &-- hence the quotes.
38394 .ecindex IIDutils
38395
38396
38397 . ////////////////////////////////////////////////////////////////////////////
38398 . ////////////////////////////////////////////////////////////////////////////
38399
38400 .chapter "The Exim monitor" "CHAPeximon"
38401 .scindex IIDeximon "Exim monitor" "description"
38402 .cindex "X-windows"
38403 .cindex "&'eximon'&"
38404 .cindex "Local/eximon.conf"
38405 .cindex "&_exim_monitor/EDITME_&"
38406 The Exim monitor is an application which displays in an X window information
38407 about the state of Exim's queue and what Exim is doing. An admin user can
38408 perform certain operations on messages from this GUI interface; however all
38409 such facilities are also available from the command line, and indeed, the
38410 monitor itself makes use of the command line to perform any actions requested.
38411
38412
38413
38414 .section "Running the monitor" "SECID264"
38415 The monitor is started by running the script called &'eximon'&. This is a shell
38416 script that sets up a number of environment variables, and then runs the
38417 binary called &_eximon.bin_&. The default appearance of the monitor window can
38418 be changed by editing the &_Local/eximon.conf_& file created by editing
38419 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38420 parameters are for.
38421
38422 The parameters that get built into the &'eximon'& script can be overridden for
38423 a particular invocation by setting up environment variables of the same names,
38424 preceded by &`EXIMON_`&. For example, a shell command such as
38425 .code
38426 EXIMON_LOG_DEPTH=400 eximon
38427 .endd
38428 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38429 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38430 overrides the Exim log file configuration. This makes it possible to have
38431 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38432 syslog messages are routed to a file on the local host.
38433
38434 X resources can be used to change the appearance of the window in the normal
38435 way. For example, a resource setting of the form
38436 .code
38437 Eximon*background: gray94
38438 .endd
38439 changes the colour of the background to light grey rather than white. The
38440 stripcharts are drawn with both the data lines and the reference lines in
38441 black. This means that the reference lines are not visible when on top of the
38442 data. However, their colour can be changed by setting a resource called
38443 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38444 For example, if your X server is running Unix, you could set up lighter
38445 reference lines in the stripcharts by obeying
38446 .code
38447 xrdb -merge <<End
38448 Eximon*highlight: gray
38449 End
38450 .endd
38451 .cindex "admin user"
38452 In order to see the contents of messages in the queue, and to operate on them,
38453 &'eximon'& must either be run as root or by an admin user.
38454
38455 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38456 contain X11 resource parameters interpreted by the X11 library.  In addition,
38457 if the first parameter starts with the string "gdb" then it is removed and the
38458 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38459 versioned variants of gdb can be invoked).
38460
38461 The monitor's window is divided into three parts. The first contains one or
38462 more stripcharts and two action buttons, the second contains a &"tail"& of the
38463 main log file, and the third is a display of the queue of messages awaiting
38464 delivery, with two more action buttons. The following sections describe these
38465 different parts of the display.
38466
38467
38468
38469
38470 .section "The stripcharts" "SECID265"
38471 .cindex "stripchart"
38472 The first stripchart is always a count of messages in the queue. Its name can
38473 be configured by setting QUEUE_STRIPCHART_NAME in the
38474 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38475 configuration script by regular expression matches on log file entries, making
38476 it possible to display, for example, counts of messages delivered to certain
38477 hosts or using certain transports. The supplied defaults display counts of
38478 received and delivered messages, and of local and SMTP deliveries. The default
38479 period between stripchart updates is one minute; this can be adjusted by a
38480 parameter in the &_Local/eximon.conf_& file.
38481
38482 The stripchart displays rescale themselves automatically as the value they are
38483 displaying changes. There are always 10 horizontal lines in each chart; the
38484 title string indicates the value of each division when it is greater than one.
38485 For example, &"x2"& means that each division represents a value of 2.
38486
38487 It is also possible to have a stripchart which shows the percentage fullness of
38488 a particular disk partition, which is useful when local deliveries are confined
38489 to a single partition.
38490
38491 .cindex "&%statvfs%& function"
38492 This relies on the availability of the &[statvfs()]& function or equivalent in
38493 the operating system. Most, but not all versions of Unix that support Exim have
38494 this. For this particular stripchart, the top of the chart always represents
38495 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38496 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38497 &_Local/eximon.conf_& file.
38498
38499
38500
38501
38502 .section "Main action buttons" "SECID266"
38503 .cindex "size" "of monitor window"
38504 .cindex "Exim monitor" "window size"
38505 .cindex "window size"
38506 Below the stripcharts there is an action button for quitting the monitor. Next
38507 to this is another button marked &"Size"&. They are placed here so that
38508 shrinking the window to its default minimum size leaves just the queue count
38509 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38510 the window to expand to its maximum size, unless it is already at the maximum,
38511 in which case it is reduced to its minimum.
38512
38513 When expanding to the maximum, if the window cannot be fully seen where it
38514 currently is, it is moved back to where it was the last time it was at full
38515 size. When it is expanding from its minimum size, the old position is
38516 remembered, and next time it is reduced to the minimum it is moved back there.
38517
38518 The idea is that you can keep a reduced window just showing one or two
38519 stripcharts at a convenient place on your screen, easily expand it to show
38520 the full window when required, and just as easily put it back to what it was.
38521 The idea is copied from what the &'twm'& window manager does for its
38522 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38523 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38524
38525 Normally, the monitor starts up with the window at its full size, but it can be
38526 built so that it starts up with the window at its smallest size, by setting
38527 START_SMALL=yes in &_Local/eximon.conf_&.
38528
38529
38530
38531 .section "The log display" "SECID267"
38532 .cindex "log" "tail of; in monitor"
38533 The second section of the window is an area in which a display of the tail of
38534 the main log is maintained.
38535 To save space on the screen, the timestamp on each log line is shortened by
38536 removing the date and, if &%log_timezone%& is set, the timezone.
38537 The log tail is not available when the only destination for logging data is
38538 syslog, unless the syslog lines are routed to a local file whose name is passed
38539 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38540
38541 The log sub-window has a scroll bar at its lefthand side which can be used to
38542 move back to look at earlier text, and the up and down arrow keys also have a
38543 scrolling effect. The amount of log that is kept depends on the setting of
38544 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38545 to use. When this is full, the earlier 50% of data is discarded &-- this is
38546 much more efficient than throwing it away line by line. The sub-window also has
38547 a horizontal scroll bar for accessing the ends of long log lines. This is the
38548 only means of horizontal scrolling; the right and left arrow keys are not
38549 available. Text can be cut from this part of the window using the mouse in the
38550 normal way. The size of this subwindow is controlled by parameters in the
38551 configuration file &_Local/eximon.conf_&.
38552
38553 Searches of the text in the log window can be carried out by means of the ^R
38554 and ^S keystrokes, which default to a reverse and a forward search,
38555 respectively. The search covers only the text that is displayed in the window.
38556 It cannot go further back up the log.
38557
38558 The point from which the search starts is indicated by a caret marker. This is
38559 normally at the end of the text in the window, but can be positioned explicitly
38560 by pointing and clicking with the left mouse button, and is moved automatically
38561 by a successful search. If new text arrives in the window when it is scrolled
38562 back, the caret remains where it is, but if the window is not scrolled back,
38563 the caret is moved to the end of the new text.
38564
38565 Pressing ^R or ^S pops up a window into which the search text can be typed.
38566 There are buttons for selecting forward or reverse searching, for carrying out
38567 the search, and for cancelling. If the &"Search"& button is pressed, the search
38568 happens and the window remains so that further searches can be done. If the
38569 &"Return"& key is pressed, a single search is done and the window is closed. If
38570 ^C is typed the search is cancelled.
38571
38572 The searching facility is implemented using the facilities of the Athena text
38573 widget. By default this pops up a window containing both &"search"& and
38574 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38575 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38576 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38577 provided version of &%TextPop%& when the remaining parts of the text widget
38578 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38579 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38580 on these systems, at the expense of having unwanted items in the search popup
38581 window.
38582
38583
38584
38585 .section "The queue display" "SECID268"
38586 .cindex "queue" "display in monitor"
38587 The bottom section of the monitor window contains a list of all messages that
38588 are in the queue, which includes those currently being received or delivered,
38589 as well as those awaiting delivery. The size of this subwindow is controlled by
38590 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38591 at which it is updated is controlled by another parameter in the same file &--
38592 the default is 5 minutes, since queue scans can be quite expensive. However,
38593 there is an &"Update"& action button just above the display which can be used
38594 to force an update of the queue display at any time.
38595
38596 When a host is down for some time, a lot of pending mail can build up for it,
38597 and this can make it hard to deal with other messages in the queue. To help
38598 with this situation there is a button next to &"Update"& called &"Hide"&. If
38599 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38600 type anything in here and press &"Return"&, the text is added to a chain of
38601 such texts, and if every undelivered address in a message matches at least one
38602 of the texts, the message is not displayed.
38603
38604 If there is an address that does not match any of the texts, all the addresses
38605 are displayed as normal. The matching happens on the ends of addresses so, for
38606 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38607 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38608 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38609 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38610 a hide request is automatically cancelled after one hour.
38611
38612 While the dialogue box is displayed, you can't press any buttons or do anything
38613 else to the monitor window. For this reason, if you want to cut text from the
38614 queue display to use in the dialogue box, you have to do the cutting before
38615 pressing the &"Hide"& button.
38616
38617 The queue display contains, for each unhidden queued message, the length of
38618 time it has been in the queue, the size of the message, the message id, the
38619 message sender, and the first undelivered recipient, all on one line. If it is
38620 a bounce message, the sender is shown as &"<>"&. If there is more than one
38621 recipient to which the message has not yet been delivered, subsequent ones are
38622 listed on additional lines, up to a maximum configured number, following which
38623 an ellipsis is displayed. Recipients that have already received the message are
38624 not shown.
38625
38626 .cindex "frozen messages" "display"
38627 If a message is frozen, an asterisk is displayed at the left-hand side.
38628
38629 The queue display has a vertical scroll bar, and can also be scrolled by means
38630 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38631 The text searching facilities, as described above for the log window, are also
38632 available, but the caret is always moved to the end of the text when the queue
38633 display is updated.
38634
38635
38636
38637 .section "The queue menu" "SECID269"
38638 .cindex "queue" "menu in monitor"
38639 If the &%shift%& key is held down and the left button is clicked when the mouse
38640 pointer is over the text for any message, an action menu pops up, and the first
38641 line of the queue display for the message is highlighted. This does not affect
38642 any selected text.
38643
38644 If you want to use some other event for popping up the menu, you can set the
38645 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38646 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38647 value set in this parameter is a standard X event description. For example, to
38648 run eximon using &%ctrl%& rather than &%shift%& you could use
38649 .code
38650 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38651 .endd
38652 The title of the menu is the message id, and it contains entries which act as
38653 follows:
38654
38655 .ilist
38656 &'message log'&: The contents of the message log for the message are displayed
38657 in a new text window.
38658 .next
38659 &'headers'&: Information from the spool file that contains the envelope
38660 information and headers is displayed in a new text window. See chapter
38661 &<<CHAPspool>>& for a description of the format of spool files.
38662 .next
38663 &'body'&: The contents of the spool file containing the body of the message are
38664 displayed in a new text window. There is a default limit of 20,000 bytes to the
38665 amount of data displayed. This can be changed by setting the BODY_MAX
38666 option at compile time, or the EXIMON_BODY_MAX option at runtime.
38667 .next
38668 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38669 delivery of the message. This causes an automatic thaw if the message is
38670 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38671 a new text window. The delivery is run in a separate process, to avoid holding
38672 up the monitor while the delivery proceeds.
38673 .next
38674 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38675 that the message be frozen.
38676 .next
38677 .cindex "thawing messages"
38678 .cindex "unfreezing messages"
38679 .cindex "frozen messages" "thawing"
38680 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38681 that the message be thawed.
38682 .next
38683 .cindex "delivery" "forcing failure"
38684 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38685 that Exim gives up trying to deliver the message. A bounce message is generated
38686 for any remaining undelivered addresses.
38687 .next
38688 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38689 that the message be deleted from the system without generating a bounce
38690 message.
38691 .next
38692 &'add recipient'&: A dialog box is displayed into which a recipient address can
38693 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38694 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38695 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38696 causes a call to Exim to be made using the &%-Mar%& option to request that an
38697 additional recipient be added to the message, unless the entry box is empty, in
38698 which case no action is taken.
38699 .next
38700 &'mark delivered'&: A dialog box is displayed into which a recipient address
38701 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38702 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38703 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38704 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38705 recipient address as already delivered, unless the entry box is empty, in which
38706 case no action is taken.
38707 .next
38708 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38709 mark all recipient addresses as already delivered.
38710 .next
38711 &'edit sender'&: A dialog box is displayed initialized with the current
38712 sender's address. Pressing RETURN causes a call to Exim to be made using the
38713 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38714 in which case no action is taken. If you want to set an empty sender (as in
38715 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38716 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38717 the address is qualified with that domain.
38718 .endlist
38719
38720 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38721 other cases when a call to Exim is made, if there is any output from Exim (in
38722 particular, if the command fails) a window containing the command and the
38723 output is displayed. Otherwise, the results of the action are normally apparent
38724 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38725 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38726 if no output is generated.
38727
38728 The queue display is automatically updated for actions such as freezing and
38729 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38730 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38731 force an update of the display after one of these actions.
38732
38733 In any text window that is displayed as result of a menu action, the normal
38734 cut-and-paste facility is available, and searching can be carried out using ^R
38735 and ^S, as described above for the log tail window.
38736 .ecindex IIDeximon
38737
38738
38739
38740
38741
38742 . ////////////////////////////////////////////////////////////////////////////
38743 . ////////////////////////////////////////////////////////////////////////////
38744
38745 .chapter "Security considerations" "CHAPsecurity"
38746 .scindex IIDsecurcon "security" "discussion of"
38747 This chapter discusses a number of issues concerned with security, some of
38748 which are also covered in other parts of this manual.
38749
38750 For reasons that this author does not understand, some people have promoted
38751 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38752 existence of this chapter in the documentation. However, the intent of the
38753 chapter is simply to describe the way Exim works in relation to certain
38754 security concerns, not to make any specific claims about the effectiveness of
38755 its security as compared with other MTAs.
38756
38757 What follows is a description of the way Exim is supposed to be. Best efforts
38758 have been made to try to ensure that the code agrees with the theory, but an
38759 absence of bugs can never be guaranteed. Any that are reported will get fixed
38760 as soon as possible.
38761
38762
38763 .section "Building a more &""hardened""& Exim" "SECID286"
38764 .cindex "security" "build-time features"
38765 There are a number of build-time options that can be set in &_Local/Makefile_&
38766 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
38767 Exim administrator who does not have the root password, or by someone who has
38768 penetrated the Exim (but not the root) account. These options are as follows:
38769
38770 .ilist
38771 ALT_CONFIG_PREFIX can be set to a string that is required to match the
38772 start of any filenames used with the &%-C%& option. When it is set, these
38773 filenames are also not allowed to contain the sequence &"/../"&. (However, if
38774 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
38775 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
38776 default setting for &%ALT_CONFIG_PREFIX%&.
38777
38778 If the permitted configuration files are confined to a directory to
38779 which only root has access, this guards against someone who has broken
38780 into the Exim account from running a privileged Exim with an arbitrary
38781 configuration file, and using it to break into other accounts.
38782 .next
38783
38784 If a non-trusted configuration file (i.e. not the default configuration file
38785 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
38786 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
38787 the next item), then root privilege is retained only if the caller of Exim is
38788 root. This locks out the possibility of testing a configuration using &%-C%&
38789 right through message reception and delivery, even if the caller is root. The
38790 reception works, but by that time, Exim is running as the Exim user, so when
38791 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
38792 privilege to be lost. However, root can test reception and delivery using two
38793 separate commands.
38794
38795 .next
38796 The WHITELIST_D_MACROS build option declares some macros to be safe to override
38797 with &%-D%& if the real uid is one of root, the Exim run-time user or the
38798 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
38799 requiring the run-time value supplied to &%-D%& to match a regex that errs on
38800 the restrictive side.  Requiring build-time selection of safe macros is onerous
38801 but this option is intended solely as a transition mechanism to permit
38802 previously-working configurations to continue to work after release 4.73.
38803 .next
38804 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
38805 is disabled.
38806 .next
38807 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
38808 never to be used for any deliveries. This is like the &%never_users%& runtime
38809 option, but it cannot be overridden; the runtime option adds additional users
38810 to the list. The default setting is &"root"&; this prevents a non-root user who
38811 is permitted to modify the runtime file from using Exim as a way to get root.
38812 .endlist
38813
38814
38815
38816 .section "Root privilege" "SECID270"
38817 .cindex "setuid"
38818 .cindex "root privilege"
38819 The Exim binary is normally setuid to root, which means that it gains root
38820 privilege (runs as root) when it starts execution. In some special cases (for
38821 example, when the daemon is not in use and there are no local deliveries), it
38822 may be possible to run Exim setuid to some user other than root. This is
38823 discussed in the next section. However, in most installations, root privilege
38824 is required for two things:
38825
38826 .ilist
38827 To set up a socket connected to the standard SMTP port (25) when initialising
38828 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
38829 not required.
38830 .next
38831 To be able to change uid and gid in order to read users' &_.forward_& files and
38832 perform local deliveries as the receiving user or as specified in the
38833 configuration.
38834 .endlist
38835
38836 It is not necessary to be root to do any of the other things Exim does, such as
38837 receiving messages and delivering them externally over SMTP, and it is
38838 obviously more secure if Exim does not run as root except when necessary.
38839 For this reason, a user and group for Exim to use must be defined in
38840 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
38841 group"&. Their values can be changed by the runtime configuration, though this
38842 is not recommended. Often a user called &'exim'& is used, but some sites use
38843 &'mail'& or another user name altogether.
38844
38845 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
38846 abdication; the process cannot regain root afterwards. Prior to release 4.00,
38847 &[seteuid()]& was used in some circumstances, but this is no longer the case.
38848
38849 After a new Exim process has interpreted its command line options, it changes
38850 uid and gid in the following cases:
38851
38852 .ilist
38853 .oindex "&%-C%&"
38854 .oindex "&%-D%&"
38855 If the &%-C%& option is used to specify an alternate configuration file, or if
38856 the &%-D%& option is used to define macro values for the configuration, and the
38857 calling process is not running as root, the uid and gid are changed to those of
38858 the calling process.
38859 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
38860 option may not be used at all.
38861 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
38862 can be supplied if the calling process is running as root, the Exim run-time
38863 user or CONFIGURE_OWNER, if defined.
38864 .next
38865 .oindex "&%-be%&"
38866 .oindex "&%-bf%&"
38867 .oindex "&%-bF%&"
38868 If the expansion test option (&%-be%&) or one of the filter testing options
38869 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
38870 calling process.
38871 .next
38872 If the process is not a daemon process or a queue runner process or a delivery
38873 process or a process for testing address routing (started with &%-bt%&), the
38874 uid and gid are changed to the Exim user and group. This means that Exim always
38875 runs under its own uid and gid when receiving messages. This also applies when
38876 testing address verification
38877 .oindex "&%-bv%&"
38878 .oindex "&%-bh%&"
38879 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
38880 option).
38881 .next
38882 For a daemon, queue runner, delivery, or address testing process, the uid
38883 remains as root at this stage, but the gid is changed to the Exim group.
38884 .endlist
38885
38886 The processes that initially retain root privilege behave as follows:
38887
38888 .ilist
38889 A daemon process changes the gid to the Exim group and the uid to the Exim
38890 user after setting up one or more listening sockets. The &[initgroups()]&
38891 function is called, so that if the Exim user is in any additional groups, they
38892 will be used during message reception.
38893 .next
38894 A queue runner process retains root privilege throughout its execution. Its
38895 job is to fork a controlled sequence of delivery processes.
38896 .next
38897 A delivery process retains root privilege throughout most of its execution,
38898 but any actual deliveries (that is, the transports themselves) are run in
38899 subprocesses which always change to a non-root uid and gid. For local
38900 deliveries this is typically the uid and gid of the owner of the mailbox; for
38901 remote deliveries, the Exim uid and gid are used. Once all the delivery
38902 subprocesses have been run, a delivery process changes to the Exim uid and gid
38903 while doing post-delivery tidying up such as updating the retry database and
38904 generating bounce and warning messages.
38905
38906 While the recipient addresses in a message are being routed, the delivery
38907 process runs as root. However, if a user's filter file has to be processed,
38908 this is done in a subprocess that runs under the individual user's uid and
38909 gid. A system filter is run as root unless &%system_filter_user%& is set.
38910 .next
38911 A process that is testing addresses (the &%-bt%& option) runs as root so that
38912 the routing is done in the same environment as a message delivery.
38913 .endlist
38914
38915
38916
38917
38918 .section "Running Exim without privilege" "SECTrunexiwitpri"
38919 .cindex "privilege, running without"
38920 .cindex "unprivileged running"
38921 .cindex "root privilege" "running without"
38922 Some installations like to run Exim in an unprivileged state for more of its
38923 operation, for added security. Support for this mode of operation is provided
38924 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
38925 gid are changed to the Exim user and group at the start of a delivery process
38926 (and also queue runner and address testing processes). This means that address
38927 routing is no longer run as root, and the deliveries themselves cannot change
38928 to any other uid.
38929
38930 .cindex SIGHUP
38931 .cindex "daemon" "restarting"
38932 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
38933 that the daemon can still be started in the usual way, and it can respond
38934 correctly to SIGHUP because the re-invocation regains root privilege.
38935
38936 An alternative approach is to make Exim setuid to the Exim user and also setgid
38937 to the Exim group. If you do this, the daemon must be started from a root
38938 process. (Calling Exim from a root process makes it behave in the way it does
38939 when it is setuid root.) However, the daemon cannot restart itself after a
38940 SIGHUP signal because it cannot regain privilege.
38941
38942 It is still useful to set &%deliver_drop_privilege%& in this case, because it
38943 stops Exim from trying to re-invoke itself to do a delivery after a message has
38944 been received. Such a re-invocation is a waste of resources because it has no
38945 effect.
38946
38947 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
38948 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
38949 to the Exim user seems a clean approach, but there is one complication:
38950
38951 In this style of operation, Exim is running with the real uid and gid set to
38952 those of the calling process, and the effective uid/gid set to Exim's values.
38953 Ideally, any association with the calling process' uid/gid should be dropped,
38954 that is, the real uid/gid should be reset to the effective values so as to
38955 discard any privileges that the caller may have. While some operating systems
38956 have a function that permits this action for a non-root effective uid, quite a
38957 number of them do not. Because of this lack of standardization, Exim does not
38958 address this problem at this time.
38959
38960 For this reason, the recommended approach for &"mostly unprivileged"& running
38961 is to keep the Exim binary setuid to root, and to set
38962 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
38963 be used in the most straightforward way.
38964
38965 If you configure Exim not to run delivery processes as root, there are a
38966 number of restrictions on what you can do:
38967
38968 .ilist
38969 You can deliver only as the Exim user/group. You should  explicitly use the
38970 &%user%& and &%group%& options to override routers or local transports that
38971 normally deliver as the recipient. This makes sure that configurations that
38972 work in this mode function the same way in normal mode. Any implicit or
38973 explicit specification of another user causes an error.
38974 .next
38975 Use of &_.forward_& files is severely restricted, such that it is usually
38976 not worthwhile to include them in the configuration.
38977 .next
38978 Users who wish to use &_.forward_& would have to make their home directory and
38979 the file itself accessible to the Exim user. Pipe and append-to-file entries,
38980 and their equivalents in Exim filters, cannot be used. While they could be
38981 enabled in the Exim user's name, that would be insecure and not very useful.
38982 .next
38983 Unless the local user mailboxes are all owned by the Exim user (possible in
38984 some POP3 or IMAP-only environments):
38985
38986 .olist
38987 They must be owned by the Exim group and be writeable by that group. This
38988 implies you must set &%mode%& in the appendfile configuration, as well as the
38989 mode of the mailbox files themselves.
38990 .next
38991 You must set &%no_check_owner%&, since most or all of the files will not be
38992 owned by the Exim user.
38993 .next
38994 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
38995 on a newly created mailbox when unprivileged. This also implies that new
38996 mailboxes need to be created manually.
38997 .endlist olist
38998 .endlist ilist
38999
39000
39001 These restrictions severely restrict what can be done in local deliveries.
39002 However, there are no restrictions on remote deliveries. If you are running a
39003 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39004 gives more security at essentially no cost.
39005
39006 If you are using the &%mua_wrapper%& facility (see chapter
39007 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39008
39009
39010
39011
39012 .section "Delivering to local files" "SECID271"
39013 Full details of the checks applied by &(appendfile)& before it writes to a file
39014 are given in chapter &<<CHAPappendfile>>&.
39015
39016
39017
39018 .section "Running local commands" "SECTsecconslocalcmds"
39019 .cindex "security" "local commands"
39020 .cindex "security" "command injection attacks"
39021 There are a number of ways in which an administrator can configure Exim to run
39022 commands based upon received, untrustworthy, data. Further, in some
39023 configurations a user who can control a &_.forward_& file can also arrange to
39024 run commands. Configuration to check includes, but is not limited to:
39025
39026 .ilist
39027 Use of &%use_shell%& in the pipe transport: various forms of shell command
39028 injection may be possible with this option present. It is dangerous and should
39029 be used only with considerable caution. Consider constraints which whitelist
39030 allowed characters in a variable which is to be used in a pipe transport that
39031 has &%use_shell%& enabled.
39032 .next
39033 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39034 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39035 &_.forward_& files in a redirect router. If Exim is running on a central mail
39036 hub to which ordinary users do not have shell access, but home directories are
39037 NFS mounted (for instance) then administrators should review the list of these
39038 forbid options available, and should bear in mind that the options that may
39039 need forbidding can change as new features are added between releases.
39040 .next
39041 The &%${run...}%& expansion item does not use a shell by default, but
39042 administrators can configure use of &_/bin/sh_& as part of the command.
39043 Such invocations should be viewed with prejudicial suspicion.
39044 .next
39045 Administrators who use embedded Perl are advised to explore how Perl's
39046 taint checking might apply to their usage.
39047 .next
39048 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39049 administrators are well advised to view its use with suspicion, in case (for
39050 instance) it allows a local-part to contain embedded Exim directives.
39051 .next
39052 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39053 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39054 each can reference arbitrary lists and files, rather than just being a list
39055 of opaque strings.
39056 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39057 real-world security vulnerabilities caused by its use with untrustworthy data
39058 injected in, for SQL injection attacks.
39059 Consider the use of the &%inlisti%& expansion condition instead.
39060 .endlist
39061
39062
39063
39064
39065 .section "Trust in configuration data" "SECTsecconfdata"
39066 .cindex "security" "data sources"
39067 .cindex "security" "regular expressions"
39068 .cindex "regular expressions" "security"
39069 .cindex "PCRE" "security"
39070 If configuration data for Exim can come from untrustworthy sources, there
39071 are some issues to be aware of:
39072
39073 .ilist
39074 Use of &%${expand...}%& may provide a path for shell injection attacks.
39075 .next
39076 Letting untrusted data provide a regular expression is unwise.
39077 .next
39078 Using &%${match...}%& to apply a fixed regular expression against untrusted
39079 data may result in pathological behaviour within PCRE.  Be aware of what
39080 "backtracking" means and consider options for being more strict with a regular
39081 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39082 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39083 possessive quantifiers or just not using regular expressions against untrusted
39084 data.
39085 .next
39086 It can be important to correctly use &%${quote:...}%&,
39087 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39088 items to ensure that data is correctly constructed.
39089 .next
39090 Some lookups might return multiple results, even though normal usage is only
39091 expected to yield one result.
39092 .endlist
39093
39094
39095
39096
39097 .section "IPv4 source routing" "SECID272"
39098 .cindex "source routing" "in IP packets"
39099 .cindex "IP source routing"
39100 Many operating systems suppress IP source-routed packets in the kernel, but
39101 some cannot be made to do this, so Exim does its own check. It logs incoming
39102 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39103 IPv6. No special checking is currently done.
39104
39105
39106
39107 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39108 Support for these SMTP commands is disabled by default. If required, they can
39109 be enabled by defining suitable ACLs.
39110
39111
39112
39113
39114 .section "Privileged users" "SECID274"
39115 .cindex "trusted users"
39116 .cindex "admin user"
39117 .cindex "privileged user"
39118 .cindex "user" "trusted"
39119 .cindex "user" "admin"
39120 Exim recognizes two sets of users with special privileges. Trusted users are
39121 able to submit new messages to Exim locally, but supply their own sender
39122 addresses and information about a sending host. For other users submitting
39123 local messages, Exim sets up the sender address from the uid, and doesn't
39124 permit a remote host to be specified.
39125
39126 .oindex "&%-f%&"
39127 However, an untrusted user is permitted to use the &%-f%& command line option
39128 in the special form &%-f <>%& to indicate that a delivery failure for the
39129 message should not cause an error report. This affects the message's envelope,
39130 but it does not affect the &'Sender:'& header. Untrusted users may also be
39131 permitted to use specific forms of address with the &%-f%& option by setting
39132 the &%untrusted_set_sender%& option.
39133
39134 Trusted users are used to run processes that receive mail messages from some
39135 other mail domain and pass them on to Exim for delivery either locally, or over
39136 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39137 as any user listed in the &%trusted_users%& configuration option, or under any
39138 group listed in the &%trusted_groups%& option.
39139
39140 Admin users are permitted to do things to the messages on Exim's queue. They
39141 can freeze or thaw messages, cause them to be returned to their senders, remove
39142 them entirely, or modify them in various ways. In addition, admin users can run
39143 the Exim monitor and see all the information it is capable of providing, which
39144 includes the contents of files on the spool.
39145
39146 .oindex "&%-M%&"
39147 .oindex "&%-q%&"
39148 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39149 delivery of messages on its queue is restricted to admin users. This
39150 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39151 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39152 queue is also restricted to admin users. This restriction can be relaxed by
39153 setting &%no_queue_list_requires_admin%&.
39154
39155 Exim recognizes an admin user if the calling process is running as root or as
39156 the Exim user or if any of the groups associated with the calling process is
39157 the Exim group. It is not necessary actually to be running under the Exim
39158 group. However, if admin users who are not root or the Exim user are to access
39159 the contents of files on the spool via the Exim monitor (which runs
39160 unprivileged), Exim must be built to allow group read access to its spool
39161 files.
39162
39163 By default, regular users are trusted to perform basic testing and
39164 introspection commands, as themselves.  This setting can be tightened by
39165 setting the &%commandline_checks_require_admin%& option.
39166 This affects most of the checking options,
39167 such as &%-be%& and anything else &%-b*%&.
39168
39169
39170 .section "Spool files" "SECID275"
39171 .cindex "spool directory" "files"
39172 Exim's spool directory and everything it contains is owned by the Exim user and
39173 set to the Exim group. The mode for spool files is defined in the
39174 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39175 any user who is a member of the Exim group can access these files.
39176
39177
39178
39179 .section "Use of argv[0]" "SECID276"
39180 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39181 of specific strings, Exim assumes certain options. For example, calling Exim
39182 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39183 to calling it with the option &%-bS%&. There are no security implications in
39184 this.
39185
39186
39187
39188 .section "Use of %f formatting" "SECID277"
39189 The only use made of &"%f"& by Exim is in formatting load average values. These
39190 are actually stored in integer variables as 1000 times the load average.
39191 Consequently, their range is limited and so therefore is the length of the
39192 converted output.
39193
39194
39195
39196 .section "Embedded Exim path" "SECID278"
39197 Exim uses its own path name, which is embedded in the code, only when it needs
39198 to re-exec in order to regain root privilege. Therefore, it is not root when it
39199 does so. If some bug allowed the path to get overwritten, it would lead to an
39200 arbitrary program's being run as exim, not as root.
39201
39202
39203
39204 .section "Dynamic module directory" "SECTdynmoddir"
39205 Any dynamically loadable modules must be installed into the directory
39206 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39207 loading it.
39208
39209
39210 .section "Use of sprintf()" "SECID279"
39211 .cindex "&[sprintf()]&"
39212 A large number of occurrences of &"sprintf"& in the code are actually calls to
39213 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39214 The intermediate formatting is done into a large fixed buffer by a function
39215 that runs through the format string itself, and checks the length of each
39216 conversion before performing it, thus preventing buffer overruns.
39217
39218 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39219 the output buffer is known to be sufficiently long to contain the converted
39220 string.
39221
39222
39223
39224 .section "Use of debug_printf() and log_write()" "SECID280"
39225 Arbitrary strings are passed to both these functions, but they do their
39226 formatting by calling the function &'string_vformat()'&, which runs through
39227 the format string itself, and checks the length of each conversion.
39228
39229
39230
39231 .section "Use of strcat() and strcpy()" "SECID281"
39232 These are used only in cases where the output buffer is known to be large
39233 enough to hold the result.
39234 .ecindex IIDsecurcon
39235
39236
39237
39238
39239 . ////////////////////////////////////////////////////////////////////////////
39240 . ////////////////////////////////////////////////////////////////////////////
39241
39242 .chapter "Format of spool files" "CHAPspool"
39243 .scindex IIDforspo1 "format" "spool files"
39244 .scindex IIDforspo2 "spool directory" "format of files"
39245 .scindex IIDforspo3 "spool files" "format of"
39246 .cindex "spool files" "editing"
39247 A message on Exim's queue consists of two files, whose names are the message id
39248 followed by -D and -H, respectively. The data portion of the message is kept in
39249 the -D file on its own. The message's envelope, status, and headers are all
39250 kept in the -H file, whose format is described in this chapter. Each of these
39251 two files contains the final component of its own name as its first line. This
39252 is insurance against disk crashes where the directory is lost but the files
39253 themselves are recoverable.
39254
39255 The file formats may be changed, or new formats added, at any release.
39256 Spool files are not intended as an interface to other programs
39257 and should not be used as such.
39258
39259 Some people are tempted into editing -D files in order to modify messages. You
39260 need to be extremely careful if you do this; it is not recommended and you are
39261 on your own if you do it. Here are some of the pitfalls:
39262
39263 .ilist
39264 You must ensure that Exim does not try to deliver the message while you are
39265 fiddling with it. The safest way is to take out a write lock on the -D file,
39266 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39267 place, the lock will be retained. If you write a new file and rename it, the
39268 lock will be lost at the instant of rename.
39269 .next
39270 .vindex "&$body_linecount$&"
39271 If you change the number of lines in the file, the value of
39272 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39273 cause incomplete transmission of messages or undeliverable messages.
39274 .next
39275 If the message is in MIME format, you must take care not to break it.
39276 .next
39277 If the message is cryptographically signed, any change will invalidate the
39278 signature.
39279 .endlist
39280 All in all, modifying -D files is fraught with danger.
39281
39282 Files whose names end with -J may also be seen in the &_input_& directory (or
39283 its subdirectories when &%split_spool_directory%& is set). These are journal
39284 files, used to record addresses to which the message has been delivered during
39285 the course of a delivery attempt. If there are still undelivered recipients at
39286 the end, the -H file is updated, and the -J file is deleted. If, however, there
39287 is some kind of crash (for example, a power outage) before this happens, the -J
39288 file remains in existence. When Exim next processes the message, it notices the
39289 -J file and uses it to update the -H file before starting the next delivery
39290 attempt.
39291
39292 Files whose names end with -K or .eml may also be seen in the spool.
39293 These are temporaries used for DKIM or malware processing, when that is used.
39294 They should be tidied up by normal operations; any old ones are probably
39295 relics of crashes and can be removed.
39296
39297 .section "Format of the -H file" "SECID282"
39298 .cindex "uid (user id)" "in spool file"
39299 .cindex "gid (group id)" "in spool file"
39300 The second line of the -H file contains the login name for the uid of the
39301 process that called Exim to read the message, followed by the numerical uid and
39302 gid. For a locally generated message, this is normally the user who sent the
39303 message. For a message received over TCP/IP via the daemon, it is
39304 normally the Exim user.
39305
39306 The third line of the file contains the address of the message's sender as
39307 transmitted in the envelope, contained in angle brackets. The sender address is
39308 empty for bounce messages. For incoming SMTP mail, the sender address is given
39309 in the MAIL command. For locally generated mail, the sender address is
39310 created by Exim from the login name of the current user and the configured
39311 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39312 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39313 &"<>"& or an address that matches &%untrusted_set_senders%&.
39314
39315 The fourth line contains two numbers. The first is the time that the message
39316 was received, in the conventional Unix form &-- the number of seconds since the
39317 start of the epoch. The second number is a count of the number of messages
39318 warning of delayed delivery that have been sent to the sender.
39319
39320 There follow a number of lines starting with a hyphen. These can appear in any
39321 order, and are omitted when not relevant:
39322
39323 .vlist
39324 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39325 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39326 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39327 recognized, to provide backward compatibility. In the old format, a line of
39328 this form is present for every ACL variable that is not empty. The number
39329 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39330 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39331 the data string for the variable. The string itself starts at the beginning of
39332 the next line, and is followed by a newline character. It may contain internal
39333 newlines.
39334
39335 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39336 A line of this form is present for every ACL connection variable that is
39337 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39338 The length is the length of the data string for the variable. The string itself
39339 starts at the beginning of the next line, and is followed by a newline
39340 character. It may contain internal newlines.
39341
39342 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39343 A line of this form is present for every ACL message variable that is defined.
39344 Note that there is a space between &%-aclm%& and the rest of the name. The
39345 length is the length of the data string for the variable. The string itself
39346 starts at the beginning of the next line, and is followed by a newline
39347 character. It may contain internal newlines.
39348
39349 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39350 This is present if, when the message was received over SMTP, the value of
39351 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39352
39353 .vitem &%-allow_unqualified_recipient%&
39354 This is present if unqualified recipient addresses are permitted in header
39355 lines (to stop such addresses from being qualified if rewriting occurs at
39356 transport time). Local messages that were input using &%-bnq%& and remote
39357 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39358
39359 .vitem &%-allow_unqualified_sender%&
39360 This is present if unqualified sender addresses are permitted in header lines
39361 (to stop such addresses from being qualified if rewriting occurs at transport
39362 time). Local messages that were input using &%-bnq%& and remote messages from
39363 hosts that match &%sender_unqualified_hosts%& set this flag.
39364
39365 .vitem "&%-auth_id%&&~<&'text'&>"
39366 The id information for a message received on an authenticated SMTP connection
39367 &-- the value of the &$authenticated_id$& variable.
39368
39369 .vitem "&%-auth_sender%&&~<&'address'&>"
39370 The address of an authenticated sender &-- the value of the
39371 &$authenticated_sender$& variable.
39372
39373 .vitem "&%-body_linecount%&&~<&'number'&>"
39374 This records the number of lines in the body of the message, and is
39375 present unless &%-spool_file_wireformat%& is.
39376
39377 .vitem "&%-body_zerocount%&&~<&'number'&>"
39378 This records the number of binary zero bytes in the body of the message, and is
39379 present if the number is greater than zero.
39380
39381 .vitem &%-deliver_firsttime%&
39382 This is written when a new message is first added to the spool. When the spool
39383 file is updated after a deferral, it is omitted.
39384
39385 .vitem "&%-frozen%&&~<&'time'&>"
39386 .cindex "frozen messages" "spool data"
39387 The message is frozen, and the freezing happened at <&'time'&>.
39388
39389 .vitem "&%-helo_name%&&~<&'text'&>"
39390 This records the host name as specified by a remote host in a HELO or EHLO
39391 command.
39392
39393 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39394 This records the IP address of the host from which the message was received and
39395 the remote port number that was used. It is omitted for locally generated
39396 messages.
39397
39398 .vitem "&%-host_auth%&&~<&'text'&>"
39399 If the message was received on an authenticated SMTP connection, this records
39400 the name of the authenticator &-- the value of the
39401 &$sender_host_authenticated$& variable.
39402
39403 .vitem &%-host_lookup_failed%&
39404 This is present if an attempt to look up the sending host's name from its IP
39405 address failed. It corresponds to the &$host_lookup_failed$& variable.
39406
39407 .vitem "&%-host_name%&&~<&'text'&>"
39408 .cindex "reverse DNS lookup"
39409 .cindex "DNS" "reverse lookup"
39410 This records the name of the remote host from which the message was received,
39411 if the host name was looked up from the IP address when the message was being
39412 received. It is not present if no reverse lookup was done.
39413
39414 .vitem "&%-ident%&&~<&'text'&>"
39415 For locally submitted messages, this records the login of the originating user,
39416 unless it was a trusted user and the &%-oMt%& option was used to specify an
39417 ident value. For messages received over TCP/IP, this records the ident string
39418 supplied by the remote host, if any.
39419
39420 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39421 This records the IP address of the local interface and the port number through
39422 which a message was received from a remote host. It is omitted for locally
39423 generated messages.
39424
39425 .vitem &%-local%&
39426 The message is from a local sender.
39427
39428 .vitem &%-localerror%&
39429 The message is a locally-generated bounce message.
39430
39431 .vitem "&%-local_scan%&&~<&'string'&>"
39432 This records the data string that was returned by the &[local_scan()]& function
39433 when the message was received &-- the value of the &$local_scan_data$&
39434 variable. It is omitted if no data was returned.
39435
39436 .vitem &%-manual_thaw%&
39437 The message was frozen but has been thawed manually, that is, by an explicit
39438 Exim command rather than via the auto-thaw process.
39439
39440 .vitem &%-N%&
39441 A testing delivery process was started using the &%-N%& option to suppress any
39442 actual deliveries, but delivery was deferred. At any further delivery attempts,
39443 &%-N%& is assumed.
39444
39445 .vitem &%-received_protocol%&
39446 This records the value of the &$received_protocol$& variable, which contains
39447 the name of the protocol by which the message was received.
39448
39449 .vitem &%-sender_set_untrusted%&
39450 The envelope sender of this message was set by an untrusted local caller (used
39451 to ensure that the caller is displayed in queue listings).
39452
39453 .vitem "&%-spam_score_int%&&~<&'number'&>"
39454 If a message was scanned by SpamAssassin, this is present. It records the value
39455 of &$spam_score_int$&.
39456
39457 .vitem &%-spool_file_wireformat%&
39458 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39459 rather than Unix-format.
39460 The line-ending is CRLF rather than newline.
39461 There is still, however, no leading-dot-stuffing.
39462
39463 .vitem &%-tls_certificate_verified%&
39464 A TLS certificate was received from the client that sent this message, and the
39465 certificate was verified by the server.
39466
39467 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39468 When the message was received over an encrypted connection, this records the
39469 name of the cipher suite that was used.
39470
39471 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39472 When the message was received over an encrypted connection, and a certificate
39473 was received from the client, this records the Distinguished Name from that
39474 certificate.
39475 .endlist
39476
39477 Following the options there is a list of those addresses to which the message
39478 is not to be delivered. This set of addresses is initialized from the command
39479 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39480 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39481 the address is added to this set. The addresses are kept internally as a
39482 balanced binary tree, and it is a representation of that tree which is written
39483 to the spool file. If an address is expanded via an alias or forward file, the
39484 original address is added to the tree when deliveries to all its child
39485 addresses are complete.
39486
39487 If the tree is empty, there is a single line in the spool file containing just
39488 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39489 Y or N, followed by an address. The address is the value for the node of the
39490 tree, and the letters indicate whether the node has a left branch and/or a
39491 right branch attached to it, respectively. If branches exist, they immediately
39492 follow. Here is an example of a three-node tree:
39493 .code
39494 YY darcy@austen.fict.example
39495 NN alice@wonderland.fict.example
39496 NN editor@thesaurus.ref.example
39497 .endd
39498 After the non-recipients tree, there is a list of the message's recipients.
39499 This is a simple list, preceded by a count. It includes all the original
39500 recipients of the message, including those to whom the message has already been
39501 delivered. In the simplest case, the list contains one address per line. For
39502 example:
39503 .code
39504 4
39505 editor@thesaurus.ref.example
39506 darcy@austen.fict.example
39507 rdo@foundation
39508 alice@wonderland.fict.example
39509 .endd
39510 However, when a child address has been added to the top-level addresses as a
39511 result of the use of the &%one_time%& option on a &(redirect)& router, each
39512 line is of the following form:
39513 .display
39514 <&'top-level address'&> <&'errors_to address'&> &&&
39515   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39516 .endd
39517 The 01 flag bit indicates the presence of the three other fields that follow
39518 the top-level address. Other bits may be used in future to support additional
39519 fields. The <&'parent number'&> is the offset in the recipients list of the
39520 original parent of the &"one time"& address. The first two fields are the
39521 envelope sender that is associated with this address and its length. If the
39522 length is zero, there is no special envelope sender (there are then two space
39523 characters in the line). A non-empty field can arise from a &(redirect)& router
39524 that has an &%errors_to%& setting.
39525
39526
39527 A blank line separates the envelope and status information from the headers
39528 which follow. A header may occupy several lines of the file, and to save effort
39529 when reading it in, each header is preceded by a number and an identifying
39530 character. The number is the number of characters in the header, including any
39531 embedded newlines and the terminating newline. The character is one of the
39532 following:
39533
39534 .table2 50pt
39535 .row <&'blank'&>         "header in which Exim has no special interest"
39536 .row &`B`&               "&'Bcc:'& header"
39537 .row &`C`&               "&'Cc:'& header"
39538 .row &`F`&               "&'From:'& header"
39539 .row &`I`&               "&'Message-id:'& header"
39540 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39541 .row &`R`&               "&'Reply-To:'& header"
39542 .row &`S`&               "&'Sender:'& header"
39543 .row &`T`&               "&'To:'& header"
39544 .row &`*`&               "replaced or deleted header"
39545 .endtable
39546
39547 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39548 purposes. They are not transmitted when the message is delivered. Here is a
39549 typical set of headers:
39550 .code
39551 111P Received: by hobbit.fict.example with local (Exim 4.00)
39552 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39553 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39554 038* X-rewrote-sender: bb@hobbit.fict.example
39555 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39556 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39557 099* To: alice@wonderland.fict.example, rdo@foundation,
39558 darcy@austen.fict.example, editor@thesaurus.ref.example
39559 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39560 darcy@austen.fict.example, editor@thesaurus.ref.example
39561 038  Date: Fri, 11 May 2001 10:28:59 +0100
39562 .endd
39563 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39564 &'To:'& header have been rewritten, the last one because routing expanded the
39565 unqualified domain &'foundation'&.
39566 .ecindex IIDforspo1
39567 .ecindex IIDforspo2
39568 .ecindex IIDforspo3
39569
39570 .section "Format of the -D file" "SECID282a"
39571 The data file is traditionally in Unix-standard format: lines are ended with
39572 an ASCII newline character.
39573 However, when the &%spool_wireformat%& main option is used some -D files
39574 can have an alternate format.
39575 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39576 The -D file lines (not including the first name-component line) are
39577 suitable for direct copying to the wire when transmitting using the
39578 ESMTP CHUNKING option, meaning lower processing overhead.
39579 Lines are terminated with an ASCII CRLF pair.
39580 There is no dot-stuffing (and no dot-termination).
39581
39582 . ////////////////////////////////////////////////////////////////////////////
39583 . ////////////////////////////////////////////////////////////////////////////
39584
39585 .chapter "DKIM and SPF" "CHAPdkim" &&&
39586          "DKIM and SPF Support"
39587 .cindex "DKIM"
39588
39589 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39590
39591 DKIM is a mechanism by which messages sent by some entity can be provably
39592 linked to a domain which that entity controls.  It permits reputation to
39593 be tracked on a per-domain basis, rather than merely upon source IP address.
39594 DKIM is documented in RFC 6376.
39595
39596 As DKIM relies on the message being unchanged in transit, messages handled
39597 by a mailing-list (which traditionally adds to the message) will not match
39598 any original DKIM signature.
39599
39600 DKIM support is compiled into Exim by default if TLS support is present.
39601 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39602
39603 Exim's DKIM implementation allows for
39604 .olist
39605 Signing outgoing messages: This function is implemented in the SMTP transport.
39606 It can co-exist with all other Exim features
39607 (including transport filters)
39608 except cutthrough delivery.
39609 .next
39610 Verifying signatures in incoming messages: This is implemented by an additional
39611 ACL (acl_smtp_dkim), which can be called several times per message, with
39612 different signature contexts.
39613 .endlist
39614
39615 In typical Exim style, the verification implementation does not include any
39616 default "policy". Instead it enables you to build your own policy using
39617 Exim's standard controls.
39618
39619 Please note that verification of DKIM signatures in incoming mail is turned
39620 on by default for logging (in the <= line) purposes.
39621
39622 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39623 When set, for each signature in incoming email,
39624 exim will log a line displaying the most important signature details, and the
39625 signature status. Here is an example (with line-breaks added for clarity):
39626 .code
39627 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39628     d=facebookmail.com s=q1-2009b
39629     c=relaxed/relaxed a=rsa-sha1
39630     i=@facebookmail.com t=1252484542 [verification succeeded]
39631 .endd
39632
39633 You might want to turn off DKIM verification processing entirely for internal
39634 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39635 control modifier. This should typically be done in the RCPT ACL, at points
39636 where you accept mail from relay sources (internal hosts or authenticated
39637 senders).
39638
39639
39640 .section "Signing outgoing messages" "SECDKIMSIGN"
39641 .cindex "DKIM" "signing"
39642
39643 For signing to be usable you must have published a DKIM record in DNS.
39644 Note that RFC 8301 (which does not cover EC keys) says:
39645 .code
39646 rsa-sha1 MUST NOT be used for signing or verifying.
39647
39648 Signers MUST use RSA keys of at least 1024 bits for all keys.
39649 Signers SHOULD use RSA keys of at least 2048 bits.
39650 .endd
39651
39652 Note also that the key content (the 'p=' field)
39653 in the DNS record is different between RSA and EC keys;
39654 for the former it is the base64 of the ASN.1 for the RSA public key
39655 (equivalent to the private-key .pem with the header/trailer stripped)
39656 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39657
39658 Signing is enabled by setting private options on the SMTP transport.
39659 These options take (expandable) strings as arguments.
39660
39661 .option dkim_domain smtp string list&!! unset
39662 The domain(s) you want to sign with.
39663 After expansion, this can be a list.
39664 Each element in turn,
39665 .new
39666 lowercased,
39667 .wen
39668 is put into the &%$dkim_domain%& expansion variable
39669 while expanding the remaining signing options.
39670 If it is empty after expansion, DKIM signing is not done,
39671 and no error will result even if &%dkim_strict%& is set.
39672
39673 .option dkim_selector smtp string list&!! unset
39674 This sets the key selector string.
39675 After expansion, which can use &$dkim_domain$&, this can be a list.
39676 Each element in turn is put in the expansion
39677 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39678 option along with &%$dkim_domain%&.
39679 If the option is empty after expansion, DKIM signing is not done for this domain,
39680 and no error will result even if &%dkim_strict%& is set.
39681
39682 .option dkim_private_key smtp string&!! unset
39683 This sets the private key to use.
39684 You can use the &%$dkim_domain%& and
39685 &%$dkim_selector%& expansion variables to determine the private key to use.
39686 The result can either
39687 .ilist
39688 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39689 .next
39690 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39691 be a valid Ed25519 private key (same format as above)
39692 .next
39693 start with a slash, in which case it is treated as a file that contains
39694 the private key
39695 .next
39696 be "0", "false" or the empty string, in which case the message will not
39697 be signed. This case will not result in an error, even if &%dkim_strict%&
39698 is set.
39699 .endlist
39700
39701 To generate keys under OpenSSL:
39702 .code
39703 openssl genrsa -out dkim_rsa.private 2048
39704 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39705 .endd
39706 Take the base-64 lines from the output of the second command, concatenated,
39707 for the DNS TXT record.
39708 See section 3.6 of RFC6376 for the record specification.
39709
39710 Under GnuTLS:
39711 .code
39712 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39713 certtool --load-privkey=dkim_rsa.private --pubkey-info
39714 .endd
39715
39716 Note that RFC 8301 says:
39717 .code
39718 Signers MUST use RSA keys of at least 1024 bits for all keys.
39719 Signers SHOULD use RSA keys of at least 2048 bits.
39720 .endd
39721
39722 .new
39723 EC keys for DKIM are defined by RFC 8463.
39724 .wen
39725 They are considerably smaller than RSA keys for equivalent protection.
39726 As they are a recent development, users should consider dual-signing
39727 (by setting a list of selectors, and an expansion for this option)
39728 for some transition period.
39729 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39730 for EC keys.
39731
39732 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39733 .code
39734 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39735 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39736 .endd
39737
39738 To produce the required public key value for a DNS record:
39739 .code
39740 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39741 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39742 .endd
39743
39744 .new
39745 Exim also supports an alternate format
39746 of Ed25519 keys in DNS which was a candidate during development
39747 of the standard, but not adopted.
39748 A future release will probably drop that support.
39749 .wen
39750
39751 .option dkim_hash smtp string&!! sha256
39752 Can be set to any one of the supported hash methods, which are:
39753 .ilist
39754 &`sha1`& &-- should not be used, is old and insecure
39755 .next
39756 &`sha256`& &-- the default
39757 .next
39758 &`sha512`& &-- possibly more secure but less well supported
39759 .endlist
39760
39761 Note that RFC 8301 says:
39762 .code
39763 rsa-sha1 MUST NOT be used for signing or verifying.
39764 .endd
39765
39766 .option dkim_identity smtp string&!! unset
39767 If set after expansion, the value is used to set an "i=" tag in
39768 the signing header.  The DKIM standards restrict the permissible
39769 syntax of this optional tag to a mail address, with possibly-empty
39770 local part, an @, and a domain identical to or subdomain of the "d="
39771 tag value.  Note that Exim does not check the value.
39772
39773 .option dkim_canon smtp string&!! unset
39774 This option sets the canonicalization method used when signing a message.
39775 The DKIM RFC currently supports two methods: "simple" and "relaxed".
39776 The option defaults to "relaxed" when unset. Note: the current implementation
39777 only supports signing with the same canonicalization method for both headers and body.
39778
39779 .option dkim_strict smtp string&!! unset
39780 This  option  defines  how  Exim  behaves  when  signing a message that
39781 should be signed fails for some reason.  When the expansion evaluates to
39782 either "1" or "true", Exim will defer. Otherwise Exim will send the message
39783 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
39784 variables here.
39785
39786 .option dkim_sign_headers smtp string&!! "see below"
39787 If set, this option must expand to a colon-separated
39788 list of header names.
39789 Headers with these names, or the absence or such a header, will be included
39790 in the message signature.
39791 When unspecified, the header names listed in RFC4871 will be used,
39792 whether or not each header is present in the message.
39793 The default list is available for the expansion in the macro
39794 "_DKIM_SIGN_HEADERS".
39795
39796 If a name is repeated, multiple headers by that name (or the absence thereof)
39797 will be signed.  The textually later headers in the headers part of the
39798 message are signed first, if there are multiples.
39799
39800 A name can be prefixed with either an '=' or a '+' character.
39801 If an '=' prefix is used, all headers that are present with this name
39802 will be signed.
39803 If a '+' prefix if used, all headers that are present with this name
39804 will be signed, and one signature added for a missing header with the
39805 name will be appended.
39806
39807 .option dkim_timestamps smtp integer&!! unset
39808 This option controls the inclusion of timestamp information in the signature.
39809 If not set, no such information will be included.
39810 Otherwise, must be an unsigned number giving an offset in seconds from the current time
39811 for the expiry tag
39812 (eg. 1209600 for two weeks);
39813 both creation (t=) and expiry (x=) tags will be included.
39814
39815 RFC 6376 lists these tags as RECOMMENDED.
39816
39817
39818 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
39819 .cindex "DKIM" "verification"
39820
39821 Verification of DKIM signatures in SMTP incoming email is done for all
39822 messages for which an ACL control &%dkim_disable_verify%& has not been set.
39823 .cindex authentication "expansion item"
39824 Performing verification sets up information used by the
39825 &$authresults$& expansion item.
39826
39827 The results of that verification are then made available to the
39828 &%acl_smtp_dkim%& ACL, which can examine and modify them.
39829 By default, this ACL is called once for each
39830 syntactically(!) correct signature in the incoming message.
39831 A missing ACL definition defaults to accept.
39832 If any ACL call does not accept, the message is not accepted.
39833 If a cutthrough delivery was in progress for the message, that is
39834 summarily dropped (having wasted the transmission effort).
39835
39836 To evaluate the verification result in the ACL
39837 a large number of expansion variables
39838 containing the signature status and its details are set up during the
39839 runtime of the ACL.
39840
39841 Calling the ACL only for existing signatures is not sufficient to build
39842 more advanced policies. For that reason, the global option
39843 &%dkim_verify_signers%&, and a global expansion variable
39844 &%$dkim_signers%& exist.
39845
39846 The global option &%dkim_verify_signers%& can be set to a colon-separated
39847 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
39848 called. It is expanded when the message has been received. At this point,
39849 the expansion variable &%$dkim_signers%& already contains a colon-separated
39850 list of signer domains and identities for the message. When
39851 &%dkim_verify_signers%& is not specified in the main configuration,
39852 it defaults as:
39853 .code
39854 dkim_verify_signers = $dkim_signers
39855 .endd
39856 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
39857 DKIM signature in the message. Current DKIM verifiers may want to explicitly
39858 call the ACL for known domains or identities. This would be achieved as follows:
39859 .code
39860 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
39861 .endd
39862 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
39863 and "ebay.com", plus all domains and identities that have signatures in the message.
39864 You can also be more creative in constructing your policy. For example:
39865 .code
39866 dkim_verify_signers = $sender_address_domain:$dkim_signers
39867 .endd
39868
39869 If a domain or identity is listed several times in the (expanded) value of
39870 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
39871
39872 .new
39873 Note that if the option is set using untrustworthy data
39874 (such as the From: header)
39875 care should be taken to force lowercase for domains
39876 and for the domain part if identities.
39877 The default setting can be regarded as trustworthy in this respect.
39878 .wen
39879
39880 If multiple signatures match a domain (or identity), the ACL is called once
39881 for each matching signature.
39882
39883
39884 Inside the &%acl_smtp_dkim%&, the following expansion variables are
39885 available (from most to least important):
39886
39887
39888 .vlist
39889 .vitem &%$dkim_cur_signer%&
39890 The signer that is being evaluated in this ACL run. This can be a domain or
39891 an identity. This is one of the list items from the expanded main option
39892 &%dkim_verify_signers%& (see above).
39893
39894 .vitem &%$dkim_verify_status%&
39895 Within the DKIM ACL,
39896 a string describing the general status of the signature. One of
39897 .ilist
39898 &%none%&: There is no signature in the message for the current domain or
39899 identity (as reflected by &%$dkim_cur_signer%&).
39900 .next
39901 &%invalid%&: The signature could not be verified due to a processing error.
39902 More detail is available in &%$dkim_verify_reason%&.
39903 .next
39904 &%fail%&: Verification of the signature failed.  More detail is
39905 available in &%$dkim_verify_reason%&.
39906 .next
39907 &%pass%&: The signature passed verification. It is valid.
39908 .endlist
39909
39910 This variable can be overwritten using an ACL 'set' modifier.
39911 This might, for instance, be done to enforce a policy restriction on
39912 hash-method or key-size:
39913 .code
39914   warn condition       = ${if eq {$dkim_verify_status}{pass}}
39915        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
39916        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
39917                                   {< {$dkim_key_length}{1024}}}}
39918        logwrite        = NOTE: forcing DKIM verify fail (was pass)
39919        set dkim_verify_status = fail
39920        set dkim_verify_reason = hash too weak or key too short
39921 .endd
39922
39923 So long as a DKIM ACL is defined (it need do no more than accept),
39924 after all the DKIM ACL runs have completed, the value becomes a
39925 colon-separated list of the values after each run.
39926 This is maintained for the mime, prdr and data ACLs.
39927
39928 .vitem &%$dkim_verify_reason%&
39929 A string giving a little bit more detail when &%$dkim_verify_status%& is either
39930 "fail" or "invalid". One of
39931 .ilist
39932 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
39933 key for the domain could not be retrieved. This may be a temporary problem.
39934 .next
39935 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
39936 record for the domain is syntactically invalid.
39937 .next
39938 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
39939 body hash does not match the one specified in the signature header. This
39940 means that the message body was modified in transit.
39941 .next
39942 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
39943 could not be verified. This may mean that headers were modified,
39944 re-written or otherwise changed in a way which is incompatible with
39945 DKIM verification. It may of course also mean that the signature is forged.
39946 .endlist
39947
39948 This variable can be overwritten, with any value, using an ACL 'set' modifier.
39949
39950 .vitem &%$dkim_domain%&
39951 The signing domain. IMPORTANT: This variable is only populated if there is
39952 an actual signature in the message for the current domain or identity (as
39953 reflected by &%$dkim_cur_signer%&).
39954
39955 .vitem &%$dkim_identity%&
39956 The signing identity, if present. IMPORTANT: This variable is only populated
39957 if there is an actual signature in the message for the current domain or
39958 identity (as reflected by &%$dkim_cur_signer%&).
39959
39960 .vitem &%$dkim_selector%&
39961 The key record selector string.
39962
39963 .vitem &%$dkim_algo%&
39964 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
39965 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39966 may also be 'ed25519-sha256'.
39967 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39968 for EC keys.
39969
39970 Note that RFC 8301 says:
39971 .code
39972 rsa-sha1 MUST NOT be used for signing or verifying.
39973
39974 DKIM signatures identified as having been signed with historic
39975 algorithms (currently, rsa-sha1) have permanently failed evaluation
39976 .endd
39977
39978 To enforce this you must have a DKIM ACL which checks this variable
39979 and overwrites the &$dkim_verify_status$& variable as discussed above.
39980
39981 .vitem &%$dkim_canon_body%&
39982 The body canonicalization method. One of 'relaxed' or 'simple'.
39983
39984 .vitem &%$dkim_canon_headers%&
39985 The header canonicalization method. One of 'relaxed' or 'simple'.
39986
39987 .vitem &%$dkim_copiedheaders%&
39988 A transcript of headers and their values which are included in the signature
39989 (copied from the 'z=' tag of the signature).
39990 Note that RFC6376 requires that verification fail if the From: header is
39991 not included in the signature.  Exim does not enforce this; sites wishing
39992 strict enforcement should code the check explicitly.
39993
39994 .vitem &%$dkim_bodylength%&
39995 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
39996 limit was set by the signer, "9999999999999" is returned. This makes sure
39997 that this variable always expands to an integer value.
39998 &*Note:*& The presence of the signature tag specifying a signing body length
39999 is one possible route to spoofing of valid DKIM signatures.
40000 A paranoid implementation might wish to regard signature where this variable
40001 shows less than the "no limit" return as being invalid.
40002
40003 .vitem &%$dkim_created%&
40004 UNIX timestamp reflecting the date and time when the signature was created.
40005 When this was not specified by the signer, "0" is returned.
40006
40007 .vitem &%$dkim_expires%&
40008 UNIX timestamp reflecting the date and time when the signer wants the
40009 signature to be treated as "expired". When this was not specified by the
40010 signer, "9999999999999" is returned. This makes it possible to do useful
40011 integer size comparisons against this value.
40012 Note that Exim does not check this value.
40013
40014 .vitem &%$dkim_headernames%&
40015 A colon-separated list of names of headers included in the signature.
40016
40017 .vitem &%$dkim_key_testing%&
40018 "1" if the key record has the "testing" flag set, "0" if not.
40019
40020 .vitem &%$dkim_key_nosubdomains%&
40021 "1" if the key record forbids subdomaining, "0" otherwise.
40022
40023 .vitem &%$dkim_key_srvtype%&
40024 Service type (tag s=) from the key record. Defaults to "*" if not specified
40025 in the key record.
40026
40027 .vitem &%$dkim_key_granularity%&
40028 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40029 in the key record.
40030
40031 .vitem &%$dkim_key_notes%&
40032 Notes from the key record (tag n=).
40033
40034 .vitem &%$dkim_key_length%&
40035 Number of bits in the key.
40036
40037 Note that RFC 8301 says:
40038 .code
40039 Verifiers MUST NOT consider signatures using RSA keys of
40040 less than 1024 bits as valid signatures.
40041 .endd
40042
40043 To enforce this you must have a DKIM ACL which checks this variable
40044 and overwrites the &$dkim_verify_status$& variable as discussed above.
40045 As EC keys are much smaller, the check should only do this for RSA keys.
40046
40047 .endlist
40048
40049 In addition, two ACL conditions are provided:
40050
40051 .vlist
40052 .vitem &%dkim_signers%&
40053 ACL condition that checks a colon-separated list of domains or identities
40054 for a match against the domain or identity that the ACL is currently verifying
40055 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40056 verb to a group of domains or identities. For example:
40057
40058 .code
40059 # Warn when Mail purportedly from GMail has no gmail signature
40060 warn log_message = GMail sender without gmail.com DKIM signature
40061      sender_domains = gmail.com
40062      dkim_signers = gmail.com
40063      dkim_status = none
40064 .endd
40065
40066 Note that the above does not check for a total lack of DKIM signing;
40067 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40068
40069 .vitem &%dkim_status%&
40070 ACL condition that checks a colon-separated list of possible DKIM verification
40071 results against the actual result of verification. This is typically used
40072 to restrict an ACL verb to a list of verification outcomes, for example:
40073
40074 .code
40075 deny message = Mail from Paypal with invalid/missing signature
40076      sender_domains = paypal.com:paypal.de
40077      dkim_signers = paypal.com:paypal.de
40078      dkim_status = none:invalid:fail
40079 .endd
40080
40081 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40082 see the documentation of the &%$dkim_verify_status%& expansion variable above
40083 for more information of what they mean.
40084 .endlist
40085
40086
40087
40088
40089 .section "SPF (Sender Policy Framework)" SECSPF
40090 .cindex SPF verification
40091
40092 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40093 messages with its domain in the envelope from, documented by RFC 7208.
40094 For more information on SPF see &url(http://www.openspf.org).
40095 . --- 2018-09-07: still not https
40096
40097 Messages sent by a system not authorised will fail checking of such assertions.
40098 This includes retransmissions done by traditional forwarders.
40099
40100 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40101 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40102 &url(https://www.libspf2.org/).
40103 There is no Exim involvement in the transmission of messages;
40104 publishing certain DNS records is all that is required.
40105
40106 For verification, an ACL condition and an expansion lookup are provided.
40107 .cindex authentication "expansion item"
40108 Performing verification sets up information used by the
40109 &$authresults$& expansion item.
40110
40111
40112 .cindex SPF "ACL condition"
40113 .cindex ACL "spf condition"
40114 The ACL condition "spf" can be used at or after the MAIL ACL.
40115 It takes as an argument a list of strings giving the outcome of the SPF check,
40116 and will succeed for any matching outcome.
40117 Valid strings are:
40118 .vlist
40119 .vitem &%pass%&
40120 The SPF check passed, the sending host is positively verified by SPF.
40121
40122 .vitem &%fail%&
40123 The SPF check failed, the sending host is NOT allowed to send mail for the
40124 domain in the envelope-from address.
40125
40126 .vitem &%softfail%&
40127 The SPF check failed, but the queried domain can't absolutely confirm that this
40128 is a forgery.
40129
40130 .vitem &%none%&
40131 The queried domain does not publish SPF records.
40132
40133 .vitem &%neutral%&
40134 The SPF check returned a "neutral" state.  This means the queried domain has
40135 published a SPF record, but wants to allow outside servers to send mail under
40136 its domain as well.  This should be treated like "none".
40137
40138 .vitem &%permerror%&
40139 This indicates a syntax error in the SPF record of the queried domain.
40140 You may deny messages when this occurs.
40141
40142 .vitem &%temperror%&
40143 This indicates a temporary error during all processing, including Exim's
40144 SPF processing.  You may defer messages when this occurs.
40145 .endlist
40146
40147 You can prefix each string with an exclamation mark to  invert
40148 its meaning,  for example  "!fail" will  match all  results but
40149 "fail".  The  string  list is  evaluated  left-to-right,  in a
40150 short-circuit fashion.
40151
40152 Example:
40153 .code
40154 deny spf = fail
40155      message = $sender_host_address is not allowed to send mail from \
40156                ${if def:sender_address_domain \
40157                     {$sender_address_domain}{$sender_helo_name}}.  \
40158                Please see http://www.openspf.org/Why?scope=\
40159                ${if def:sender_address_domain {mfrom}{helo}};\
40160                identity=${if def:sender_address_domain \
40161                              {$sender_address}{$sender_helo_name}};\
40162                ip=$sender_host_address
40163 .endd
40164
40165 When the spf condition has run, it sets up several expansion
40166 variables:
40167
40168 .cindex SPF "verification variables"
40169 .vlist
40170 .vitem &$spf_header_comment$&
40171 .vindex &$spf_header_comment$&
40172   This contains a human-readable string describing the outcome
40173   of the SPF check. You can add it to a custom header or use
40174   it for logging purposes.
40175
40176 .vitem &$spf_received$&
40177 .vindex &$spf_received$&
40178   This contains a complete Received-SPF: header that can be
40179   added to the message. Please note that according to the SPF
40180   draft, this header must be added at the top of the header
40181   list. Please see section 10 on how you can do this.
40182
40183   Note: in case of "Best-guess" (see below), the convention is
40184   to put this string in a header called X-SPF-Guess: instead.
40185
40186 .vitem &$spf_result$&
40187 .vindex &$spf_result$&
40188   This contains the outcome of the SPF check in string form,
40189   one of pass, fail, softfail, none, neutral, permerror or
40190   temperror.
40191
40192 .vitem &$spf_result_guessed$&
40193 .vindex &$spf_result_guessed$&
40194   This boolean is true only if a best-guess operation was used
40195   and required in order to obtain a result.
40196
40197 .vitem &$spf_smtp_comment$&
40198 .vindex &$spf_smtp_comment$&
40199   This contains a string that can be used in a SMTP response
40200   to the calling party. Useful for "fail".
40201 .endlist
40202
40203
40204 .cindex SPF "ACL condition"
40205 .cindex ACL "spf_guess condition"
40206 .cindex SPF "best guess"
40207 In addition to SPF, you can also perform checks for so-called
40208 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40209 SPF, but it is supported by the same framework that enables SPF
40210 capability.
40211 Refer to &url(http://www.openspf.org/FAQ/Best_guess_record)
40212 for a description of what it means.
40213 . --- 2018-09-07: still not https:
40214
40215 To access this feature, simply use the spf_guess condition in place
40216 of the spf one.  For example:
40217
40218 .code
40219 deny spf_guess = fail
40220      message = $sender_host_address doesn't look trustworthy to me
40221 .endd
40222
40223 In case you decide to reject messages based on this check, you
40224 should note that although it uses the same framework, "Best-guess"
40225 is not SPF, and therefore you should not mention SPF at all in your
40226 reject message.
40227
40228 When the spf_guess condition has run, it sets up the same expansion
40229 variables as when spf condition is run, described above.
40230
40231 Additionally, since Best-guess is not standardized, you may redefine
40232 what "Best-guess" means to you by redefining the main configuration
40233 &%spf_guess%& option.
40234 For example, the following:
40235
40236 .code
40237 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40238 .endd
40239
40240 would relax host matching rules to a broader network range.
40241
40242
40243 .cindex SPF "lookup expansion"
40244 .cindex lookup spf
40245 A lookup expansion is also available. It takes an email
40246 address as the key and an IP address as the database:
40247
40248 .code
40249   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40250 .endd
40251
40252 The lookup will return the same result strings as can appear in
40253 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40254 Currently, only IPv4 addresses are supported.
40255
40256
40257
40258
40259 . ////////////////////////////////////////////////////////////////////////////
40260 . ////////////////////////////////////////////////////////////////////////////
40261
40262 .chapter "Proxies" "CHAPproxies" &&&
40263          "Proxy support"
40264 .cindex "proxy support"
40265 .cindex "proxy" "access via"
40266
40267 A proxy is an intermediate system through which communication is passed.
40268 Proxies may provide a security, availability or load-distribution function.
40269
40270
40271 .section "Inbound proxies" SECTproxyInbound
40272 .cindex proxy inbound
40273 .cindex proxy "server side"
40274 .cindex proxy "Proxy protocol"
40275 .cindex "Proxy protocol" proxy
40276
40277 Exim has support for receiving inbound SMTP connections via a proxy
40278 that uses &"Proxy Protocol"& to speak to it.
40279 To include this support, include &"SUPPORT_PROXY=yes"&
40280 in Local/Makefile.
40281
40282 It was built on the HAProxy specification, found at
40283 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40284
40285 The purpose of this facility is so that an application load balancer,
40286 such as HAProxy, can sit in front of several Exim servers
40287 to distribute load.
40288 Exim uses the local protocol communication with the proxy to obtain
40289 the remote SMTP system IP address and port information.
40290 There is no logging if a host passes or
40291 fails Proxy Protocol negotiation, but it can easily be determined and
40292 recorded in an ACL (example is below).
40293
40294 Use of a proxy is enabled by setting the &%hosts_proxy%&
40295 main configuration option to a hostlist; connections from these
40296 hosts will use Proxy Protocol.
40297 Exim supports both version 1 and version 2 of the Proxy Protocol and
40298 automatically determines which version is in use.
40299
40300 The Proxy Protocol header is the first data received on a TCP connection
40301 and is inserted before any TLS-on-connect handshake from the client; Exim
40302 negotiates TLS between Exim-as-server and the remote client, not between
40303 Exim and the proxy server.
40304
40305 The following expansion variables are usable
40306 (&"internal"& and &"external"& here refer to the interfaces
40307 of the proxy):
40308 .display
40309 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40310 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40311 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40312 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40313 &'proxy_session            '& boolean: SMTP connection via proxy
40314 .endd
40315 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40316 there was a protocol error.
40317 The variables &$sender_host_address$& and &$sender_host_port$&
40318 will have values for the actual client system, not the proxy.
40319
40320 Since the real connections are all coming from the proxy, and the
40321 per host connection tracking is done before Proxy Protocol is
40322 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
40323 handle all of the parallel volume you expect per inbound proxy.
40324 With the option set so high, you lose the ability
40325 to protect your server from many connections from one IP.
40326 In order to prevent your server from overload, you
40327 need to add a per connection ratelimit to your connect ACL.
40328 A possible solution is:
40329 .display
40330   # Set max number of connections per host
40331   LIMIT   = 5
40332   # Or do some kind of IP lookup in a flat file or database
40333   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40334
40335   defer   message        = Too many connections from this IP right now
40336           ratelimit      = LIMIT / 5s / per_conn / strict
40337 .endd
40338
40339
40340
40341 .section "Outbound proxies" SECTproxySOCKS
40342 .cindex proxy outbound
40343 .cindex proxy "client side"
40344 .cindex proxy SOCKS
40345 .cindex SOCKS proxy
40346 Exim has support for sending outbound SMTP via a proxy
40347 using a protocol called SOCKS5 (defined by RFC1928).
40348 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40349 Local/Makefile.
40350
40351 Use of a proxy is enabled by setting the &%socks_proxy%& option
40352 on an smtp transport.
40353 The option value is expanded and should then be a list
40354 (colon-separated by default) of proxy specifiers.
40355 Each proxy specifier is a list
40356 (space-separated by default) where the initial element
40357 is an IP address and any subsequent elements are options.
40358
40359 Options are a string <name>=<value>.
40360 The list of options is in the following table:
40361 .display
40362 &'auth   '& authentication method
40363 &'name   '& authentication username
40364 &'pass   '& authentication password
40365 &'port   '& tcp port
40366 &'tmo    '& connection timeout
40367 &'pri    '& priority
40368 &'weight '& selection bias
40369 .endd
40370
40371 More details on each of these options follows:
40372
40373 .ilist
40374 .cindex authentication "to proxy"
40375 .cindex proxy authentication
40376 &%auth%&: Either &"none"& (default) or &"name"&.
40377 Using &"name"& selects username/password authentication per RFC 1929
40378 for access to the proxy.
40379 Default is &"none"&.
40380 .next
40381 &%name%&: sets the username for the &"name"& authentication method.
40382 Default is empty.
40383 .next
40384 &%pass%&: sets the password for the &"name"& authentication method.
40385 Default is empty.
40386 .next
40387 &%port%&: the TCP port number to use for the connection to the proxy.
40388 Default is 1080.
40389 .next
40390 &%tmo%&: sets a connection timeout in seconds for this proxy.
40391 Default is 5.
40392 .next
40393 &%pri%&: specifies a priority for the proxy within the list,
40394 higher values being tried first.
40395 The default priority is 1.
40396 .next
40397 &%weight%&: specifies a selection bias.
40398 Within a priority set servers are queried in a random fashion,
40399 weighted by this value.
40400 The default value for selection bias is 1.
40401 .endlist
40402
40403 Proxies from the list are tried according to their priority
40404 and weight settings until one responds.  The timeout for the
40405 overall connection applies to the set of proxied attempts.
40406
40407 .section Logging SECTproxyLog
40408 To log the (local) IP of a proxy in the incoming or delivery logline,
40409 add &"+proxy"& to the &%log_selector%& option.
40410 This will add a component tagged with &"PRX="& to the line.
40411
40412 . ////////////////////////////////////////////////////////////////////////////
40413 . ////////////////////////////////////////////////////////////////////////////
40414
40415 .chapter "Internationalisation" "CHAPi18n" &&&
40416          "Internationalisation""
40417 .cindex internationalisation "email address"
40418 .cindex EAI
40419 .cindex i18n
40420 .cindex utf8 "mail name handling"
40421
40422 Exim has support for Internationalised mail names.
40423 To include this it must be built with SUPPORT_I18N and the libidn library.
40424 Standards supported are RFCs 2060, 5890, 6530 and 6533.
40425
40426 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
40427 instead of it) then IDNA2008 is supported; this adds an extra library
40428 requirement, upon libidn2.
40429
40430 .section "MTA operations" SECTi18nMTA
40431 .cindex SMTPUTF8 "ESMTP option"
40432 The main configuration option &%smtputf8_advertise_hosts%& specifies
40433 a host list.  If this matches the sending host and
40434 accept_8bitmime is true (the default) then the ESMTP option
40435 SMTPUTF8 will be advertised.
40436
40437 If the sender specifies the SMTPUTF8 option on a MAIL command
40438 international handling for the message is enabled and
40439 the expansion variable &$message_smtputf8$& will have value TRUE.
40440
40441 The option &%allow_utf8_domains%& is set to true for this
40442 message. All DNS lookups are converted to a-label form
40443 whatever the setting of &%allow_utf8_domains%&
40444 when Exim is built with SUPPORT_I18N.
40445
40446 Both localparts and domain are maintained as the original
40447 UTF-8 form internally; any comparison or regular-expression use will
40448 require appropriate care.  Filenames created, eg. by
40449 the appendfile transport, will have UTF-8 names.
40450
40451 HELO names sent by the smtp transport will have any UTF-8
40452 components expanded to a-label form,
40453 and any certificate name checks will be done using the a-label
40454 form of the name.
40455
40456 .cindex log protocol
40457 .cindex SMTPUTF8 logging
40458 .cindex i18n logging
40459 Log lines and Received-by: header lines will acquire a "utf8"
40460 prefix on the protocol element, eg. utf8esmtp.
40461
40462 The following expansion operators can be used:
40463 .code
40464 ${utf8_domain_to_alabel:str}
40465 ${utf8_domain_from_alabel:str}
40466 ${utf8_localpart_to_alabel:str}
40467 ${utf8_localpart_from_alabel:str}
40468 .endd
40469
40470 .cindex utf8 "address downconversion"
40471 .cindex i18n "utf8 address downconversion"
40472 The RCPT ACL
40473 may use the following modifier:
40474 .display
40475 control = utf8_downconvert
40476 control = utf8_downconvert/<value>
40477 .endd
40478 This sets a flag requiring that addresses are converted to
40479 a-label form before smtp delivery, for use in a
40480 Message Submission Agent context.
40481 If a value is appended it may be:
40482 .display
40483 &`1  `& (default) mandatory downconversion
40484 &`0  `& no downconversion
40485 &`-1 `& if SMTPUTF8 not supported by destination host
40486 .endd
40487
40488 If mua_wrapper is set, the utf8_downconvert control
40489 is initially set to -1.
40490
40491 The smtp transport has an option &%utf8_downconvert%&.
40492 If set it must expand to one of the three values described above,
40493 and it overrides any previously set value.
40494
40495
40496 There is no explicit support for VRFY and EXPN.
40497 Configurations supporting these should inspect
40498 &$smtp_command_argument$& for an SMTPUTF8 argument.
40499
40500 There is no support for LMTP on Unix sockets.
40501 Using the "lmtp" protocol option on an smtp transport,
40502 for LMTP over TCP, should work as expected.
40503
40504 There is no support for DSN unitext handling,
40505 and no provision for converting logging from or to UTF-8.
40506
40507
40508
40509 .section "MDA operations" SECTi18nMDA
40510 To aid in constructing names suitable for IMAP folders
40511 the following expansion operator can be used:
40512 .code
40513 ${imapfolder {<string>} {<sep>} {<specials>}}
40514 .endd
40515
40516 The string is converted from the charset specified by
40517 the "headers charset" command (in a filter file)
40518 or &%headers_charset%& main configuration option (otherwise),
40519 to the
40520 modified UTF-7 encoding specified by RFC 2060,
40521 with the following exception: All occurrences of <sep>
40522 (which has to be a single character)
40523 are replaced with periods ("."), and all periods and slashes that are not
40524 <sep> and are not in the <specials> string are BASE64 encoded.
40525
40526 The third argument can be omitted, defaulting to an empty string.
40527 The second argument can be omitted, defaulting to "/".
40528
40529 This is the encoding used by Courier for Maildir names on disk, and followed
40530 by many other IMAP servers.
40531
40532 Examples:
40533 .display
40534 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
40535 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
40536 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
40537 .endd
40538
40539 Note that the source charset setting is vital, and also that characters
40540 must be representable in UTF-16.
40541
40542
40543 . ////////////////////////////////////////////////////////////////////////////
40544 . ////////////////////////////////////////////////////////////////////////////
40545
40546 .chapter "Events" "CHAPevents" &&&
40547          "Events"
40548 .cindex events
40549
40550 The events mechanism in Exim can be used to intercept processing at a number
40551 of points.  It was originally invented to give a way to do customised logging
40552 actions (for example, to a database) but can also be used to modify some
40553 processing actions.
40554
40555 Most installations will never need to use Events.
40556 The support can be left out of a build by defining DISABLE_EVENT=yes
40557 in &_Local/Makefile_&.
40558
40559 There are two major classes of events: main and transport.
40560 The main configuration option &%event_action%& controls reception events;
40561 a transport option &%event_action%& controls delivery events.
40562
40563 Both options are a string which is expanded when the event fires.
40564 An example might look like:
40565 .cindex logging custom
40566 .code
40567 event_action = ${if eq {msg:delivery}{$event_name} \
40568 {${lookup pgsql {SELECT * FROM record_Delivery( \
40569     '${quote_pgsql:$sender_address_domain}',\
40570     '${quote_pgsql:${lc:$sender_address_local_part}}', \
40571     '${quote_pgsql:$domain}', \
40572     '${quote_pgsql:${lc:$local_part}}', \
40573     '${quote_pgsql:$host_address}', \
40574     '${quote_pgsql:${lc:$host}}', \
40575     '${quote_pgsql:$message_exim_id}')}} \
40576 } {}}
40577 .endd
40578
40579 Events have names which correspond to the point in process at which they fire.
40580 The name is placed in the variable &$event_name$& and the event action
40581 expansion must check this, as it will be called for every possible event type.
40582
40583 The current list of events is:
40584 .display
40585 &`dane:fail              after    transport  `& per connection
40586 &`msg:complete           after    main       `& per message
40587 &`msg:delivery           after    transport  `& per recipient
40588 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
40589 &`msg:rcpt:defer         after    transport  `& per recipient
40590 &`msg:host:defer         after    transport  `& per attempt
40591 &`msg:fail:delivery      after    transport  `& per recipient
40592 &`msg:fail:internal      after    main       `& per recipient
40593 &`tcp:connect            before   transport  `& per connection
40594 &`tcp:close              after    transport  `& per connection
40595 &`tls:cert               before   both       `& per certificate in verification chain
40596 &`smtp:connect           after    transport  `& per connection
40597 .endd
40598 New event types may be added in future.
40599
40600 The event name is a colon-separated list, defining the type of
40601 event in a tree of possibilities.  It may be used as a list
40602 or just matched on as a whole.  There will be no spaces in the name.
40603
40604 The second column in the table above describes whether the event fires
40605 before or after the action is associates with.  Those which fire before
40606 can be used to affect that action (more on this below).
40607
40608 The third column in the table above says what section of the configuration
40609 should define the event action.
40610
40611 An additional variable, &$event_data$&, is filled with information varying
40612 with the event type:
40613 .display
40614 &`dane:fail            `& failure reason
40615 &`msg:delivery         `& smtp confirmation message
40616 &`msg:fail:internal    `& failure reason
40617 &`msg:fail:delivery    `& smtp error message
40618 &`msg:rcpt:host:defer  `& error string
40619 &`msg:rcpt:defer       `& error string
40620 &`msg:host:defer       `& error string
40621 &`tls:cert             `& verification chain depth
40622 &`smtp:connect         `& smtp banner
40623 .endd
40624
40625 The :defer events populate one extra variable: &$event_defer_errno$&.
40626
40627 For complex operations an ACL expansion can be used in &%event_action%&
40628 however due to the multiple contexts that Exim operates in during
40629 the course of its processing:
40630 .ilist
40631 variables set in transport events will not be visible outside that
40632 transport call
40633 .next
40634 acl_m variables in a server context are lost on a new connection,
40635 and after smtp helo/ehlo/mail/starttls/rset commands
40636 .endlist
40637 Using an ACL expansion with the logwrite modifier can be
40638 a useful way of writing to the main log.
40639
40640 The expansion of the event_action option should normally
40641 return an empty string.  Should it return anything else the
40642 following will be forced:
40643 .display
40644 &`tcp:connect      `&  do not connect
40645 &`tls:cert         `&  refuse verification
40646 &`smtp:connect     `&  close connection
40647 .endd
40648 All other message types ignore the result string, and
40649 no other use is made of it.
40650
40651 For a tcp:connect event, if the connection is being made to a proxy
40652 then the address and port variables will be that of the proxy and not
40653 the target system.
40654
40655 For tls:cert events, if GnuTLS is in use this will trigger only per
40656 chain element received on the connection.
40657 For OpenSSL it will trigger for every chain element including those
40658 loaded locally.
40659
40660 . ////////////////////////////////////////////////////////////////////////////
40661 . ////////////////////////////////////////////////////////////////////////////
40662
40663 .chapter "Adding new drivers or lookup types" "CHID13" &&&
40664          "Adding drivers or lookups"
40665 .cindex "adding drivers"
40666 .cindex "new drivers, adding"
40667 .cindex "drivers" "adding new"
40668 The following actions have to be taken in order to add a new router, transport,
40669 authenticator, or lookup type to Exim:
40670
40671 .olist
40672 Choose a name for the driver or lookup type that does not conflict with any
40673 existing name; I will use &"newdriver"& in what follows.
40674 .next
40675 Add to &_src/EDITME_& the line:
40676 .display
40677 <&'type'&>&`_NEWDRIVER=yes`&
40678 .endd
40679 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
40680 code is not to be included in the binary by default, comment this line out. You
40681 should also add any relevant comments about the driver or lookup type.
40682 .next
40683 Add to &_src/config.h.defaults_& the line:
40684 .code
40685 #define <type>_NEWDRIVER
40686 .endd
40687 .next
40688 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
40689 and create a table entry as is done for all the other drivers and lookup types.
40690 .next
40691 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
40692 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
40693 Add your &`NEWDRIVER`& to that list.
40694 As long as the dynamic module would be named &_newdriver.so_&, you can use the
40695 simple form that most lookups have.
40696 .next
40697 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
40698 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
40699 driver or lookup type and add it to the definition of OBJ.
40700 .next
40701 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
40702 definition of OBJ_MACRO.  Add a set of line to do the compile also.
40703 .next
40704 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
40705 &_src_&.
40706 .next
40707 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
40708 as for other drivers and lookups.
40709 .endlist
40710
40711 Then all you need to do is write the code! A good way to start is to make a
40712 proforma by copying an existing module of the same type, globally changing all
40713 occurrences of the name, and cutting out most of the code. Note that any
40714 options you create must be listed in alphabetical order, because the tables are
40715 searched using a binary chop procedure.
40716
40717 There is a &_README_& file in each of the sub-directories of &_src_& describing
40718 the interface that is expected.
40719
40720
40721
40722
40723 . ////////////////////////////////////////////////////////////////////////////
40724 . ////////////////////////////////////////////////////////////////////////////
40725
40726 . /////////////////////////////////////////////////////////////////////////////
40727 . These lines are processing instructions for the Simple DocBook Processor that
40728 . Philip Hazel has developed as a less cumbersome way of making PostScript and
40729 . PDFs than using xmlto and fop. They will be ignored by all other XML
40730 . processors.
40731 . /////////////////////////////////////////////////////////////////////////////
40732
40733 .literal xml
40734 <?sdop
40735   format="newpage"
40736   foot_right_recto="&chaptertitle;"
40737   foot_right_verso="&chaptertitle;"
40738 ?>
40739 .literal off
40740
40741 .makeindex "Options index"   "option"
40742 .makeindex "Variables index" "variable"
40743 .makeindex "Concept index"   "concept"
40744
40745
40746 . /////////////////////////////////////////////////////////////////////////////
40747 . /////////////////////////////////////////////////////////////////////////////