e3684ba308ed8060b4192bd6ccf36ba878a02fe5
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.94"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2020
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part_prefix_v$&"
1403 .vindex "&$local_part$&"
1404 .vindex "&$local_part_suffix$&"
1405 .vindex "&$local_part_suffix_v$&"
1406 .cindex affix "router precondition"
1407 If the &%local_parts%& option is set, the local part of the address must be in
1408 the set of local parts that it defines. If &%local_part_prefix%& or
1409 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1410 part before this check. If you want to do precondition tests on local parts
1411 that include affixes, you can do so by using a &%condition%& option (see below)
1412 that uses the variables &$local_part$&, &$local_part_prefix$&,
1413 &$local_part_prefix_v$&, &$local_part_suffix$&
1414 and &$local_part_suffix_v$& as necessary.
1415 .next
1416 .vindex "&$local_user_uid$&"
1417 .vindex "&$local_user_gid$&"
1418 .vindex "&$home$&"
1419 If the &%check_local_user%& option is set, the local part must be the name of
1420 an account on the local host. If this check succeeds, the uid and gid of the
1421 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1422 user's home directory is placed in &$home$&; these values can be used in the
1423 remaining preconditions.
1424 .next
1425 If the &%router_home_directory%& option is set, it is expanded at this point,
1426 because it overrides the value of &$home$&. If this expansion were left till
1427 later, the value of &$home$& as set by &%check_local_user%& would be used in
1428 subsequent tests. Having two different values of &$home$& in the same router
1429 could lead to confusion.
1430 .next
1431 If the &%senders%& option is set, the envelope sender address must be in the
1432 set of addresses that it defines.
1433 .next
1434 If the &%require_files%& option is set, the existence or non-existence of
1435 specified files is tested.
1436 .next
1437 .cindex "customizing" "precondition"
1438 If the &%condition%& option is set, it is evaluated and tested. This option
1439 uses an expanded string to allow you to set up your own custom preconditions.
1440 Expanded strings are described in chapter &<<CHAPexpand>>&.
1441 .endlist
1442
1443
1444 Note that &%require_files%& comes near the end of the list, so you cannot use
1445 it to check for the existence of a file in which to lookup up a domain, local
1446 part, or sender. However, as these options are all expanded, you can use the
1447 &%exists%& expansion condition to make such tests within each condition. The
1448 &%require_files%& option is intended for checking files that the router may be
1449 going to use internally, or which are needed by a specific transport (for
1450 example, &_.procmailrc_&).
1451
1452
1453
1454 .section "Delivery in detail" "SECID18"
1455 .cindex "delivery" "in detail"
1456 When a message is to be delivered, the sequence of events is as follows:
1457
1458 .ilist
1459 If a system-wide filter file is specified, the message is passed to it. The
1460 filter may add recipients to the message, replace the recipients, discard the
1461 message, cause a new message to be generated, or cause the message delivery to
1462 fail. The format of the system filter file is the same as for Exim user filter
1463 files, described in the separate document entitled &'Exim's interfaces to mail
1464 filtering'&.
1465 .cindex "Sieve filter" "not available for system filter"
1466 (&*Note*&: Sieve cannot be used for system filter files.)
1467
1468 Some additional features are available in system filters &-- see chapter
1469 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1470 filter only once per delivery attempt, however many recipients it has. However,
1471 if there are several delivery attempts because one or more addresses could not
1472 be immediately delivered, the system filter is run each time. The filter
1473 condition &%first_delivery%& can be used to detect the first run of the system
1474 filter.
1475 .next
1476 Each recipient address is offered to each configured router, in turn, subject to
1477 its preconditions, until one is able to handle it. If no router can handle the
1478 address, that is, if they all decline, the address is failed. Because routers
1479 can be targeted at particular domains, several locally handled domains can be
1480 processed entirely independently of each other.
1481 .next
1482 .cindex "routing" "loops in"
1483 .cindex "loop" "while routing"
1484 A router that accepts an address may assign it to a local or a remote
1485 transport. However, the transport is not run at this time. Instead, the address
1486 is placed on a list for the particular transport, which will be run later.
1487 Alternatively, the router may generate one or more new addresses (typically
1488 from alias, forward, or filter files). New addresses are fed back into this
1489 process from the top, but in order to avoid loops, a router ignores any address
1490 which has an identically-named ancestor that was processed by itself.
1491 .next
1492 When all the routing has been done, addresses that have been successfully
1493 handled are passed to their assigned transports. When local transports are
1494 doing real local deliveries, they handle only one address at a time, but if a
1495 local transport is being used as a pseudo-remote transport (for example, to
1496 collect batched SMTP messages for transmission by some other means) multiple
1497 addresses can be handled. Remote transports can always handle more than one
1498 address at a time, but can be configured not to do so, or to restrict multiple
1499 addresses to the same domain.
1500 .next
1501 Each local delivery to a file or a pipe runs in a separate process under a
1502 non-privileged uid, and these deliveries are run one at a time. Remote
1503 deliveries also run in separate processes, normally under a uid that is private
1504 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1505 run in parallel. The maximum number of simultaneous remote deliveries for any
1506 one message is set by the &%remote_max_parallel%& option.
1507 The order in which deliveries are done is not defined, except that all local
1508 deliveries happen before any remote deliveries.
1509 .next
1510 .cindex "queue runner"
1511 When it encounters a local delivery during a queue run, Exim checks its retry
1512 database to see if there has been a previous temporary delivery failure for the
1513 address before running the local transport. If there was a previous failure,
1514 Exim does not attempt a new delivery until the retry time for the address is
1515 reached. However, this happens only for delivery attempts that are part of a
1516 queue run. Local deliveries are always attempted when delivery immediately
1517 follows message reception, even if retry times are set for them. This makes for
1518 better behaviour if one particular message is causing problems (for example,
1519 causing quota overflow, or provoking an error in a filter file).
1520 .next
1521 .cindex "delivery" "retry in remote transports"
1522 Remote transports do their own retry handling, since an address may be
1523 deliverable to one of a number of hosts, each of which may have a different
1524 retry time. If there have been previous temporary failures and no host has
1525 reached its retry time, no delivery is attempted, whether in a queue run or
1526 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1527 .next
1528 If there were any permanent errors, a bounce message is returned to an
1529 appropriate address (the sender in the common case), with details of the error
1530 for each failing address. Exim can be configured to send copies of bounce
1531 messages to other addresses.
1532 .next
1533 .cindex "delivery" "deferral"
1534 If one or more addresses suffered a temporary failure, the message is left on
1535 the queue, to be tried again later. Delivery of these addresses is said to be
1536 &'deferred'&.
1537 .next
1538 When all the recipient addresses have either been delivered or bounced,
1539 handling of the message is complete. The spool files and message log are
1540 deleted, though the message log can optionally be preserved if required.
1541 .endlist
1542
1543
1544
1545
1546 .section "Retry mechanism" "SECID19"
1547 .cindex "delivery" "retry mechanism"
1548 .cindex "retry" "description of mechanism"
1549 .cindex "queue runner"
1550 Exim's mechanism for retrying messages that fail to get delivered at the first
1551 attempt is the queue runner process. You must either run an Exim daemon that
1552 uses the &%-q%& option with a time interval to start queue runners at regular
1553 intervals or use some other means (such as &'cron'&) to start them. If you do
1554 not arrange for queue runners to be run, messages that fail temporarily at the
1555 first attempt will remain in your queue forever. A queue runner process works
1556 its way through the queue, one message at a time, trying each delivery that has
1557 passed its retry time.
1558 You can run several queue runners at once.
1559
1560 Exim uses a set of configured rules to determine when next to retry the failing
1561 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1562 should give up trying to deliver to the address, at which point it generates a
1563 bounce message. If no retry rules are set for a particular host, address, and
1564 error combination, no retries are attempted, and temporary errors are treated
1565 as permanent.
1566
1567
1568
1569 .section "Temporary delivery failure" "SECID20"
1570 .cindex "delivery" "temporary failure"
1571 There are many reasons why a message may not be immediately deliverable to a
1572 particular address. Failure to connect to a remote machine (because it, or the
1573 connection to it, is down) is one of the most common. Temporary failures may be
1574 detected during routing as well as during the transport stage of delivery.
1575 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1576 is on a file system where the user is over quota. Exim can be configured to
1577 impose its own quotas on local mailboxes; where system quotas are set they will
1578 also apply.
1579
1580 If a host is unreachable for a period of time, a number of messages may be
1581 waiting for it by the time it recovers, and sending them in a single SMTP
1582 connection is clearly beneficial. Whenever a delivery to a remote host is
1583 deferred,
1584 .cindex "hints database" "deferred deliveries"
1585 Exim makes a note in its hints database, and whenever a successful
1586 SMTP delivery has happened, it looks to see if any other messages are waiting
1587 for the same host. If any are found, they are sent over the same SMTP
1588 connection, subject to a configuration limit as to the maximum number in any
1589 one connection.
1590
1591
1592
1593 .section "Permanent delivery failure" "SECID21"
1594 .cindex "delivery" "permanent failure"
1595 .cindex "bounce message" "when generated"
1596 When a message cannot be delivered to some or all of its intended recipients, a
1597 bounce message is generated. Temporary delivery failures turn into permanent
1598 errors when their timeout expires. All the addresses that fail in a given
1599 delivery attempt are listed in a single message. If the original message has
1600 many recipients, it is possible for some addresses to fail in one delivery
1601 attempt and others to fail subsequently, giving rise to more than one bounce
1602 message. The wording of bounce messages can be customized by the administrator.
1603 See chapter &<<CHAPemsgcust>>& for details.
1604
1605 .cindex "&'X-Failed-Recipients:'& header line"
1606 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1607 failed addresses, for the benefit of programs that try to analyse such messages
1608 automatically.
1609
1610 .cindex "bounce message" "recipient of"
1611 A bounce message is normally sent to the sender of the original message, as
1612 obtained from the message's envelope. For incoming SMTP messages, this is the
1613 address given in the MAIL command. However, when an address is expanded via a
1614 forward or alias file, an alternative address can be specified for delivery
1615 failures of the generated addresses. For a mailing list expansion (see section
1616 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1617 of the list.
1618
1619
1620
1621 .section "Failures to deliver bounce messages" "SECID22"
1622 .cindex "bounce message" "failure to deliver"
1623 If a bounce message (either locally generated or received from a remote host)
1624 itself suffers a permanent delivery failure, the message is left in the queue,
1625 but it is frozen, awaiting the attention of an administrator. There are options
1626 that can be used to make Exim discard such failed messages, or to keep them
1627 for only a short time (see &%timeout_frozen_after%& and
1628 &%ignore_bounce_errors_after%&).
1629
1630
1631
1632
1633
1634 . ////////////////////////////////////////////////////////////////////////////
1635 . ////////////////////////////////////////////////////////////////////////////
1636
1637 .chapter "Building and installing Exim" "CHID3"
1638 .scindex IIDbuex "building Exim"
1639
1640 .section "Unpacking" "SECID23"
1641 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1642 creates a directory with the name of the current release (for example,
1643 &_exim-&version()_&) into which the following files are placed:
1644
1645 .table2 140pt
1646 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1647 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1648   documented"
1649 .irow &_LICENCE_&         "the GNU General Public Licence"
1650 .irow &_Makefile_&        "top-level make file"
1651 .irow &_NOTICE_&          "conditions for the use of Exim"
1652 .irow &_README_&          "list of files, directories and simple build &&&
1653   instructions"
1654 .endtable
1655
1656 Other files whose names begin with &_README_& may also be present. The
1657 following subdirectories are created:
1658
1659 .table2 140pt
1660 .irow &_Local_&           "an empty directory for local configuration files"
1661 .irow &_OS_&              "OS-specific files"
1662 .irow &_doc_&             "documentation files"
1663 .irow &_exim_monitor_&    "source files for the Exim monitor"
1664 .irow &_scripts_&         "scripts used in the build process"
1665 .irow &_src_&             "remaining source files"
1666 .irow &_util_&            "independent utilities"
1667 .endtable
1668
1669 The main utility programs are contained in the &_src_& directory and are built
1670 with the Exim binary. The &_util_& directory contains a few optional scripts
1671 that may be useful to some sites.
1672
1673
1674 .section "Multiple machine architectures and operating systems" "SECID24"
1675 .cindex "building Exim" "multiple OS/architectures"
1676 The building process for Exim is arranged to make it easy to build binaries for
1677 a number of different architectures and operating systems from the same set of
1678 source files. Compilation does not take place in the &_src_& directory.
1679 Instead, a &'build directory'& is created for each architecture and operating
1680 system.
1681 .cindex "symbolic link" "to build directory"
1682 Symbolic links to the sources are installed in this directory, which is where
1683 the actual building takes place. In most cases, Exim can discover the machine
1684 architecture and operating system for itself, but the defaults can be
1685 overridden if necessary.
1686 .cindex compiler requirements
1687 .cindex compiler version
1688 A C99-capable compiler will be required for the build.
1689
1690
1691 .section "PCRE library" "SECTpcre"
1692 .cindex "PCRE library"
1693 Exim no longer has an embedded PCRE library as the vast majority of
1694 modern systems include PCRE as a system library, although you may need to
1695 install the PCRE package or the PCRE development package for your operating
1696 system. If your system has a normal PCRE installation the Exim build
1697 process will need no further configuration. If the library or the
1698 headers are in an unusual location you will need to either set the PCRE_LIBS
1699 and INCLUDE directives appropriately,
1700 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1701 If your operating system has no
1702 PCRE support then you will need to obtain and build the current PCRE
1703 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1704 More information on PCRE is available at &url(https://www.pcre.org/).
1705
1706 .section "DBM libraries" "SECTdb"
1707 .cindex "DBM libraries" "discussion of"
1708 .cindex "hints database" "DBM files used for"
1709 Even if you do not use any DBM files in your configuration, Exim still needs a
1710 DBM library in order to operate, because it uses indexed files for its hints
1711 databases. Unfortunately, there are a number of DBM libraries in existence, and
1712 different operating systems often have different ones installed.
1713
1714 .cindex "Solaris" "DBM library for"
1715 .cindex "IRIX, DBM library for"
1716 .cindex "BSD, DBM library for"
1717 .cindex "Linux, DBM library for"
1718 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1719 Linux distribution, the DBM configuration should happen automatically, and you
1720 may be able to ignore this section. Otherwise, you may have to learn more than
1721 you would like about DBM libraries from what follows.
1722
1723 .cindex "&'ndbm'& DBM library"
1724 Licensed versions of Unix normally contain a library of DBM functions operating
1725 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1726 versions of Unix seem to vary in what they contain as standard. In particular,
1727 some early versions of Linux have no default DBM library, and different
1728 distributors have chosen to bundle different libraries with their packaged
1729 versions. However, the more recent releases seem to have standardized on the
1730 Berkeley DB library.
1731
1732 Different DBM libraries have different conventions for naming the files they
1733 use. When a program opens a file called &_dbmfile_&, there are several
1734 possibilities:
1735
1736 .olist
1737 A traditional &'ndbm'& implementation, such as that supplied as part of
1738 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1739 .next
1740 .cindex "&'gdbm'& DBM library"
1741 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1742 compatibility interface it makes two different hard links to it with names
1743 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1744 filename is used unmodified.
1745 .next
1746 .cindex "Berkeley DB library"
1747 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1748 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1749 programmer exactly the same as the traditional &'ndbm'& implementation.
1750 .next
1751 If the Berkeley package is used in its native mode, it operates on a single
1752 file called &_dbmfile_&; the programmer's interface is somewhat different to
1753 the traditional &'ndbm'& interface.
1754 .next
1755 To complicate things further, there are several very different versions of the
1756 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1757 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1758 Maintenance of some of the earlier releases has ceased. All versions of
1759 Berkeley DB could be obtained from
1760 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1761 page with far newer versions listed.
1762 It is probably wise to plan to move your storage configurations away from
1763 Berkeley DB format, as today there are smaller and simpler alternatives more
1764 suited to Exim's usage model.
1765 .next
1766 .cindex "&'tdb'& DBM library"
1767 Yet another DBM library, called &'tdb'&, is available from
1768 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1769 operates on a single file.
1770 .endlist
1771
1772 .cindex "USE_DB"
1773 .cindex "DBM libraries" "configuration for building"
1774 Exim and its utilities can be compiled to use any of these interfaces. In order
1775 to use any version of the Berkeley DB package in native mode, you must set
1776 USE_DB in an appropriate configuration file (typically
1777 &_Local/Makefile_&). For example:
1778 .code
1779 USE_DB=yes
1780 .endd
1781 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1782 error is diagnosed if you set more than one of these.
1783
1784 At the lowest level, the build-time configuration sets none of these options,
1785 thereby assuming an interface of type (1). However, some operating system
1786 configuration files (for example, those for the BSD operating systems and
1787 Linux) assume type (4) by setting USE_DB as their default, and the
1788 configuration files for Cygwin set USE_GDBM. Anything you set in
1789 &_Local/Makefile_&, however, overrides these system defaults.
1790
1791 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1792 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1793 in one of these lines:
1794 .code
1795 DBMLIB = -ldb
1796 DBMLIB = -ltdb
1797 .endd
1798 Settings like that will work if the DBM library is installed in the standard
1799 place. Sometimes it is not, and the library's header file may also not be in
1800 the default path. You may need to set INCLUDE to specify where the header
1801 file is, and to specify the path to the library more fully in DBMLIB, as in
1802 this example:
1803 .code
1804 INCLUDE=-I/usr/local/include/db-4.1
1805 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1806 .endd
1807 There is further detailed discussion about the various DBM libraries in the
1808 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1809
1810
1811
1812 .section "Pre-building configuration" "SECID25"
1813 .cindex "building Exim" "pre-building configuration"
1814 .cindex "configuration for building Exim"
1815 .cindex "&_Local/Makefile_&"
1816 .cindex "&_src/EDITME_&"
1817 Before building Exim, a local configuration file that specifies options
1818 independent of any operating system has to be created with the name
1819 &_Local/Makefile_&. A template for this file is supplied as the file
1820 &_src/EDITME_&, and it contains full descriptions of all the option settings
1821 therein. These descriptions are therefore not repeated here. If you are
1822 building Exim for the first time, the simplest thing to do is to copy
1823 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1824
1825 There are three settings that you must supply, because Exim will not build
1826 without them. They are the location of the runtime configuration file
1827 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1828 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1829 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1830 a colon-separated list of filenames; Exim uses the first of them that exists.
1831
1832 There are a few other parameters that can be specified either at build time or
1833 at runtime, to enable the same binary to be used on a number of different
1834 machines. However, if the locations of Exim's spool directory and log file
1835 directory (if not within the spool directory) are fixed, it is recommended that
1836 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1837 detected early in Exim's execution (such as a malformed configuration file) can
1838 be logged.
1839
1840 .cindex "content scanning" "specifying at build time"
1841 Exim's interfaces for calling virus and spam scanning software directly from
1842 access control lists are not compiled by default. If you want to include these
1843 facilities, you need to set
1844 .code
1845 WITH_CONTENT_SCAN=yes
1846 .endd
1847 in your &_Local/Makefile_&. For details of the facilities themselves, see
1848 chapter &<<CHAPexiscan>>&.
1849
1850
1851 .cindex "&_Local/eximon.conf_&"
1852 .cindex "&_exim_monitor/EDITME_&"
1853 If you are going to build the Exim monitor, a similar configuration process is
1854 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1855 your installation and saved under the name &_Local/eximon.conf_&. If you are
1856 happy with the default settings described in &_exim_monitor/EDITME_&,
1857 &_Local/eximon.conf_& can be empty, but it must exist.
1858
1859 This is all the configuration that is needed in straightforward cases for known
1860 operating systems. However, the building process is set up so that it is easy
1861 to override options that are set by default or by operating-system-specific
1862 configuration files, for example, to change the C compiler, which
1863 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1864 do this.
1865
1866
1867
1868 .section "Support for iconv()" "SECID26"
1869 .cindex "&[iconv()]& support"
1870 .cindex "RFC 2047"
1871 The contents of header lines in messages may be encoded according to the rules
1872 described RFC 2047. This makes it possible to transmit characters that are not
1873 in the ASCII character set, and to label them as being in a particular
1874 character set. When Exim is inspecting header lines by means of the &%$h_%&
1875 mechanism, it decodes them, and translates them into a specified character set
1876 (default is set at build time). The translation is possible only if the operating system
1877 supports the &[iconv()]& function.
1878
1879 However, some of the operating systems that supply &[iconv()]& do not support
1880 very many conversions. The GNU &%libiconv%& library (available from
1881 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1882 systems to remedy this deficiency, as well as on systems that do not supply
1883 &[iconv()]& at all. After installing &%libiconv%&, you should add
1884 .code
1885 HAVE_ICONV=yes
1886 .endd
1887 to your &_Local/Makefile_& and rebuild Exim.
1888
1889
1890
1891 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1892 .cindex "TLS" "including support for TLS"
1893 .cindex "encryption" "including support for"
1894 .cindex "OpenSSL" "building Exim with"
1895 .cindex "GnuTLS" "building Exim with"
1896 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1897 command as per RFC 2487. It can also support clients that expect to
1898 start a TLS session immediately on connection to a non-standard port (see the
1899 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1900 line option).
1901
1902 If you want to build Exim with TLS support, you must first install either the
1903 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1904 implementing SSL.
1905
1906 If you do not want TLS support you should set
1907 .code
1908 DISABLE_TLS=yes
1909 .endd
1910 in &_Local/Makefile_&.
1911
1912 If OpenSSL is installed, you should set
1913 .code
1914 USE_OPENSL=yes
1915 TLS_LIBS=-lssl -lcrypto
1916 .endd
1917 in &_Local/Makefile_&. You may also need to specify the locations of the
1918 OpenSSL library and include files. For example:
1919 .code
1920 USE_OPENSSL=yes
1921 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1922 TLS_INCLUDE=-I/usr/local/openssl/include/
1923 .endd
1924 .cindex "pkg-config" "OpenSSL"
1925 If you have &'pkg-config'& available, then instead you can just use:
1926 .code
1927 USE_OPENSSL=yes
1928 USE_OPENSSL_PC=openssl
1929 .endd
1930 .cindex "USE_GNUTLS"
1931 If GnuTLS is installed, you should set
1932 .code
1933 USE_GNUTLS=yes
1934 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1935 .endd
1936 in &_Local/Makefile_&, and again you may need to specify the locations of the
1937 library and include files. For example:
1938 .code
1939 USE_GNUTLS=yes
1940 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1941 TLS_INCLUDE=-I/usr/gnu/include
1942 .endd
1943 .cindex "pkg-config" "GnuTLS"
1944 If you have &'pkg-config'& available, then instead you can just use:
1945 .code
1946 USE_GNUTLS=yes
1947 USE_GNUTLS_PC=gnutls
1948 .endd
1949
1950 You do not need to set TLS_INCLUDE if the relevant directory is already
1951 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1952 given in chapter &<<CHAPTLS>>&.
1953
1954
1955
1956
1957 .section "Use of tcpwrappers" "SECID27"
1958
1959 .cindex "tcpwrappers, building Exim to support"
1960 .cindex "USE_TCP_WRAPPERS"
1961 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1962 .cindex "tcp_wrappers_daemon_name"
1963 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1964 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1965 alternative to Exim's own checking facilities for installations that are
1966 already making use of &'tcpwrappers'& for other purposes. To do this, you
1967 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1968 &_tcpd.h_& to be available at compile time, and also ensure that the library
1969 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1970 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1971 you might have
1972 .code
1973 USE_TCP_WRAPPERS=yes
1974 CFLAGS=-O -I/usr/local/include
1975 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1976 .endd
1977 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1978 files is &"exim"&. For example, the line
1979 .code
1980 exim : LOCAL  192.168.1.  .friendly.domain.example
1981 .endd
1982 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1983 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1984 All other connections are denied. The daemon name used by &'tcpwrappers'&
1985 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1986 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1987 configure file. Consult the &'tcpwrappers'& documentation for
1988 further details.
1989
1990
1991 .section "Including support for IPv6" "SECID28"
1992 .cindex "IPv6" "including support for"
1993 Exim contains code for use on systems that have IPv6 support. Setting
1994 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1995 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1996 where the IPv6 support is not fully integrated into the normal include and
1997 library files.
1998
1999 Two different types of DNS record for handling IPv6 addresses have been
2000 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2001 currently seen as the mainstream. Another record type called A6 was proposed
2002 as better than AAAA because it had more flexibility. However, it was felt to be
2003 over-complex, and its status was reduced to &"experimental"&.
2004 Exim used to
2005 have a compile option for including A6 record support but this has now been
2006 withdrawn.
2007
2008
2009
2010 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2011 .cindex "lookup modules"
2012 .cindex "dynamic modules"
2013 .cindex ".so building"
2014 On some platforms, Exim supports not compiling all lookup types directly into
2015 the main binary, instead putting some into external modules which can be loaded
2016 on demand.
2017 This permits packagers to build Exim with support for lookups with extensive
2018 library dependencies without requiring all users to install all of those
2019 dependencies.
2020 Most, but not all, lookup types can be built this way.
2021
2022 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2023 installed; Exim will only load modules from that directory, as a security
2024 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2025 for your OS; see &_OS/Makefile-Linux_& for an example.
2026 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2027 see &_src/EDITME_& for details.
2028
2029 Then, for each module to be loaded dynamically, define the relevant
2030 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2031 For example, this will build in lsearch but load sqlite and mysql support
2032 on demand:
2033 .code
2034 LOOKUP_LSEARCH=yes
2035 LOOKUP_SQLITE=2
2036 LOOKUP_MYSQL=2
2037 .endd
2038
2039
2040 .section "The building process" "SECID29"
2041 .cindex "build directory"
2042 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2043 created, run &'make'& at the top level. It determines the architecture and
2044 operating system types, and creates a build directory if one does not exist.
2045 For example, on a Sun system running Solaris 8, the directory
2046 &_build-SunOS5-5.8-sparc_& is created.
2047 .cindex "symbolic link" "to source files"
2048 Symbolic links to relevant source files are installed in the build directory.
2049
2050 If this is the first time &'make'& has been run, it calls a script that builds
2051 a make file inside the build directory, using the configuration files from the
2052 &_Local_& directory. The new make file is then passed to another instance of
2053 &'make'&. This does the real work, building a number of utility scripts, and
2054 then compiling and linking the binaries for the Exim monitor (if configured), a
2055 number of utility programs, and finally Exim itself. The command &`make
2056 makefile`& can be used to force a rebuild of the make file in the build
2057 directory, should this ever be necessary.
2058
2059 If you have problems building Exim, check for any comments there may be in the
2060 &_README_& file concerning your operating system, and also take a look at the
2061 FAQ, where some common problems are covered.
2062
2063
2064
2065 .section 'Output from &"make"&' "SECID283"
2066 The output produced by the &'make'& process for compile lines is often very
2067 unreadable, because these lines can be very long. For this reason, the normal
2068 output is suppressed by default, and instead output similar to that which
2069 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2070 each module that is being compiled or linked. However, it is still possible to
2071 get the full output, by calling &'make'& like this:
2072 .code
2073 FULLECHO='' make -e
2074 .endd
2075 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2076 command reflection in &'make'&. When you ask for the full output, it is
2077 given in addition to the short output.
2078
2079
2080
2081 .section "Overriding build-time options for Exim" "SECToverride"
2082 .cindex "build-time options, overriding"
2083 The main make file that is created at the beginning of the building process
2084 consists of the concatenation of a number of files which set configuration
2085 values, followed by a fixed set of &'make'& instructions. If a value is set
2086 more than once, the last setting overrides any previous ones. This provides a
2087 convenient way of overriding defaults. The files that are concatenated are, in
2088 order:
2089 .display
2090 &_OS/Makefile-Default_&
2091 &_OS/Makefile-_&<&'ostype'&>
2092 &_Local/Makefile_&
2093 &_Local/Makefile-_&<&'ostype'&>
2094 &_Local/Makefile-_&<&'archtype'&>
2095 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2096 &_OS/Makefile-Base_&
2097 .endd
2098 .cindex "&_Local/Makefile_&"
2099 .cindex "building Exim" "operating system type"
2100 .cindex "building Exim" "architecture type"
2101 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2102 architecture type. &_Local/Makefile_& is required to exist, and the building
2103 process fails if it is absent. The other three &_Local_& files are optional,
2104 and are often not needed.
2105
2106 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2107 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2108 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2109 values are used, thereby providing a means of forcing particular settings.
2110 Otherwise, the scripts try to get values from the &%uname%& command. If this
2111 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2112 of &'ad hoc'& transformations are then applied, to produce the standard names
2113 that Exim expects. You can run these scripts directly from the shell in order
2114 to find out what values are being used on your system.
2115
2116
2117 &_OS/Makefile-Default_& contains comments about the variables that are set
2118 therein. Some (but not all) are mentioned below. If there is something that
2119 needs changing, review the contents of this file and the contents of the make
2120 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2121 default values are.
2122
2123
2124 .cindex "building Exim" "overriding default settings"
2125 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2126 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2127 need to change the original files. Instead, you should make the changes by
2128 putting the new values in an appropriate &_Local_& file. For example,
2129 .cindex "Tru64-Unix build-time settings"
2130 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2131 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2132 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2133 called with the option &%-std1%&, to make it recognize some of the features of
2134 Standard C that Exim uses. (Most other compilers recognize Standard C by
2135 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2136 containing the lines
2137 .code
2138 CC=cc
2139 CFLAGS=-std1
2140 .endd
2141 If you are compiling for just one operating system, it may be easier to put
2142 these lines directly into &_Local/Makefile_&.
2143
2144 Keeping all your local configuration settings separate from the distributed
2145 files makes it easy to transfer them to new versions of Exim simply by copying
2146 the contents of the &_Local_& directory.
2147
2148
2149 .cindex "NIS lookup type" "including support for"
2150 .cindex "NIS+ lookup type" "including support for"
2151 .cindex "LDAP" "including support for"
2152 .cindex "lookup" "inclusion in binary"
2153 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2154 lookup, but not all systems have these components installed, so the default is
2155 not to include the relevant code in the binary. All the different kinds of file
2156 and database lookup that Exim supports are implemented as separate code modules
2157 which are included only if the relevant compile-time options are set. In the
2158 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2159 .code
2160 LOOKUP_LDAP=yes
2161 LOOKUP_NIS=yes
2162 LOOKUP_NISPLUS=yes
2163 .endd
2164 and similar settings apply to the other lookup types. They are all listed in
2165 &_src/EDITME_&. In many cases the relevant include files and interface
2166 libraries need to be installed before compiling Exim.
2167 .cindex "cdb" "including support for"
2168 However, there are some optional lookup types (such as cdb) for which
2169 the code is entirely contained within Exim, and no external include
2170 files or libraries are required. When a lookup type is not included in the
2171 binary, attempts to configure Exim to use it cause runtime configuration
2172 errors.
2173
2174 .cindex "pkg-config" "lookups"
2175 .cindex "pkg-config" "authenticators"
2176 Many systems now use a tool called &'pkg-config'& to encapsulate information
2177 about how to compile against a library; Exim has some initial support for
2178 being able to use pkg-config for lookups and authenticators.  For any given
2179 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2180 variable with the &`_PC`& suffix in the name and assign as the value the
2181 name of the package to be queried.  The results of querying via the
2182 &'pkg-config'& command will be added to the appropriate Makefile variables
2183 with &`+=`& directives, so your version of &'make'& will need to support that
2184 syntax.  For instance:
2185 .code
2186 LOOKUP_SQLITE=yes
2187 LOOKUP_SQLITE_PC=sqlite3
2188 AUTH_GSASL=yes
2189 AUTH_GSASL_PC=libgsasl
2190 AUTH_HEIMDAL_GSSAPI=yes
2191 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2192 .endd
2193
2194 .cindex "Perl" "including support for"
2195 Exim can be linked with an embedded Perl interpreter, allowing Perl
2196 subroutines to be called during string expansion. To enable this facility,
2197 .code
2198 EXIM_PERL=perl.o
2199 .endd
2200 must be defined in &_Local/Makefile_&. Details of this facility are given in
2201 chapter &<<CHAPperl>>&.
2202
2203 .cindex "X11 libraries, location of"
2204 The location of the X11 libraries is something that varies a lot between
2205 operating systems, and there may be different versions of X11 to cope
2206 with. Exim itself makes no use of X11, but if you are compiling the Exim
2207 monitor, the X11 libraries must be available.
2208 The following three variables are set in &_OS/Makefile-Default_&:
2209 .code
2210 X11=/usr/X11R6
2211 XINCLUDE=-I$(X11)/include
2212 XLFLAGS=-L$(X11)/lib
2213 .endd
2214 These are overridden in some of the operating-system configuration files. For
2215 example, in &_OS/Makefile-SunOS5_& there is
2216 .code
2217 X11=/usr/openwin
2218 XINCLUDE=-I$(X11)/include
2219 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2220 .endd
2221 If you need to override the default setting for your operating system, place a
2222 definition of all three of these variables into your
2223 &_Local/Makefile-<ostype>_& file.
2224
2225 .cindex "EXTRALIBS"
2226 If you need to add any extra libraries to the link steps, these can be put in a
2227 variable called EXTRALIBS, which appears in all the link commands, but by
2228 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2229 command for linking the main Exim binary, and not for any associated utilities.
2230
2231 .cindex "DBM libraries" "configuration for building"
2232 There is also DBMLIB, which appears in the link commands for binaries that
2233 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2234 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2235 binary, and which can be used, for example, to include additional X11
2236 libraries.
2237
2238 .cindex "configuration file" "editing"
2239 The make file copes with rebuilding Exim correctly if any of the configuration
2240 files are edited. However, if an optional configuration file is deleted, it is
2241 necessary to touch the associated non-optional file (that is,
2242 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2243
2244
2245 .section "OS-specific header files" "SECID30"
2246 .cindex "&_os.h_&"
2247 .cindex "building Exim" "OS-specific C header files"
2248 The &_OS_& directory contains a number of files with names of the form
2249 &_os.h-<ostype>_&. These are system-specific C header files that should not
2250 normally need to be changed. There is a list of macro settings that are
2251 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2252 are porting Exim to a new operating system.
2253
2254
2255
2256 .section "Overriding build-time options for the monitor" "SECID31"
2257 .cindex "building Eximon"
2258 A similar process is used for overriding things when building the Exim monitor,
2259 where the files that are involved are
2260 .display
2261 &_OS/eximon.conf-Default_&
2262 &_OS/eximon.conf-_&<&'ostype'&>
2263 &_Local/eximon.conf_&
2264 &_Local/eximon.conf-_&<&'ostype'&>
2265 &_Local/eximon.conf-_&<&'archtype'&>
2266 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2267 .endd
2268 .cindex "&_Local/eximon.conf_&"
2269 As with Exim itself, the final three files need not exist, and in this case the
2270 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2271 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2272 variables of the same name, preceded by EXIMON_. For example, setting
2273 EXIMON_LOG_DEPTH in the environment overrides the value of
2274 LOG_DEPTH at runtime.
2275 .ecindex IIDbuex
2276
2277
2278 .section "Installing Exim binaries and scripts" "SECID32"
2279 .cindex "installing Exim"
2280 .cindex "BIN_DIRECTORY"
2281 The command &`make install`& runs the &(exim_install)& script with no
2282 arguments. The script copies binaries and utility scripts into the directory
2283 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2284 .cindex "setuid" "installing Exim with"
2285 The install script copies files only if they are newer than the files they are
2286 going to replace. The Exim binary is required to be owned by root and have the
2287 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2288 install`& as root so that it can set up the Exim binary in this way. However, in
2289 some special situations (for example, if a host is doing no local deliveries)
2290 it may be possible to run Exim without making the binary setuid root (see
2291 chapter &<<CHAPsecurity>>& for details).
2292
2293 .cindex "CONFIGURE_FILE"
2294 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2295 in &_Local/Makefile_&. If this names a single file, and the file does not
2296 exist, the default configuration file &_src/configure.default_& is copied there
2297 by the installation script. If a runtime configuration file already exists, it
2298 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2299 alternative files, no default is installed.
2300
2301 .cindex "system aliases file"
2302 .cindex "&_/etc/aliases_&"
2303 One change is made to the default configuration file when it is installed: the
2304 default configuration contains a router that references a system aliases file.
2305 The path to this file is set to the value specified by
2306 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2307 If the system aliases file does not exist, the installation script creates it,
2308 and outputs a comment to the user.
2309
2310 The created file contains no aliases, but it does contain comments about the
2311 aliases a site should normally have. Mail aliases have traditionally been
2312 kept in &_/etc/aliases_&. However, some operating systems are now using
2313 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2314 Exim's configuration if necessary.
2315
2316 The default configuration uses the local host's name as the only local domain,
2317 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2318 running as the local user. System aliases and &_.forward_& files in users' home
2319 directories are supported, but no NIS or NIS+ support is configured. Domains
2320 other than the name of the local host are routed using the DNS, with delivery
2321 over SMTP.
2322
2323 It is possible to install Exim for special purposes (such as building a binary
2324 distribution) in a private part of the file system. You can do this by a
2325 command such as
2326 .code
2327 make DESTDIR=/some/directory/ install
2328 .endd
2329 This has the effect of pre-pending the specified directory to all the file
2330 paths, except the name of the system aliases file that appears in the default
2331 configuration. (If a default alias file is created, its name &'is'& modified.)
2332 For backwards compatibility, ROOT is used if DESTDIR is not set,
2333 but this usage is deprecated.
2334
2335 .cindex "installing Exim" "what is not installed"
2336 Running &'make install'& does not copy the Exim 4 conversion script
2337 &'convert4r4'&. You will probably run this only once if you are
2338 upgrading from Exim 3. None of the documentation files in the &_doc_&
2339 directory are copied, except for the info files when you have set
2340 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2341
2342 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2343 to their names. The Exim binary itself, however, is handled differently. It is
2344 installed under a name that includes the version number and the compile number,
2345 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2346 called &_exim_& to point to the binary. If you are updating a previous version
2347 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2348 from the directory (as seen by other processes).
2349
2350 .cindex "installing Exim" "testing the script"
2351 If you want to see what the &'make install'& will do before running it for
2352 real, you can pass the &%-n%& option to the installation script by this
2353 command:
2354 .code
2355 make INSTALL_ARG=-n install
2356 .endd
2357 The contents of the variable INSTALL_ARG are passed to the installation
2358 script. You do not need to be root to run this test. Alternatively, you can run
2359 the installation script directly, but this must be from within the build
2360 directory. For example, from the top-level Exim directory you could use this
2361 command:
2362 .code
2363 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2364 .endd
2365 .cindex "installing Exim" "install script options"
2366 There are two other options that can be supplied to the installation script.
2367
2368 .ilist
2369 &%-no_chown%& bypasses the call to change the owner of the installed binary
2370 to root, and the call to make it a setuid binary.
2371 .next
2372 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2373 installed binary.
2374 .endlist
2375
2376 INSTALL_ARG can be used to pass these options to the script. For example:
2377 .code
2378 make INSTALL_ARG=-no_symlink install
2379 .endd
2380 The installation script can also be given arguments specifying which files are
2381 to be copied. For example, to install just the Exim binary, and nothing else,
2382 without creating the symbolic link, you could use:
2383 .code
2384 make INSTALL_ARG='-no_symlink exim' install
2385 .endd
2386
2387
2388
2389 .section "Installing info documentation" "SECTinsinfdoc"
2390 .cindex "installing Exim" "&'info'& documentation"
2391 Not all systems use the GNU &'info'& system for documentation, and for this
2392 reason, the Texinfo source of Exim's documentation is not included in the main
2393 distribution. Instead it is available separately from the FTP site (see section
2394 &<<SECTavail>>&).
2395
2396 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2397 source of the documentation is found in the source tree, running &`make
2398 install`& automatically builds the info files and installs them.
2399
2400
2401
2402 .section "Setting up the spool directory" "SECID33"
2403 .cindex "spool directory" "creating"
2404 When it starts up, Exim tries to create its spool directory if it does not
2405 exist. The Exim uid and gid are used for the owner and group of the spool
2406 directory. Sub-directories are automatically created in the spool directory as
2407 necessary.
2408
2409
2410
2411
2412 .section "Testing" "SECID34"
2413 .cindex "testing" "installation"
2414 Having installed Exim, you can check that the runtime configuration file is
2415 syntactically valid by running the following command, which assumes that the
2416 Exim binary directory is within your PATH environment variable:
2417 .code
2418 exim -bV
2419 .endd
2420 If there are any errors in the configuration file, Exim outputs error messages.
2421 Otherwise it outputs the version number and build date,
2422 the DBM library that is being used, and information about which drivers and
2423 other optional code modules are included in the binary.
2424 Some simple routing tests can be done by using the address testing option. For
2425 example,
2426 .display
2427 &`exim -bt`& <&'local username'&>
2428 .endd
2429 should verify that it recognizes a local mailbox, and
2430 .display
2431 &`exim -bt`& <&'remote address'&>
2432 .endd
2433 a remote one. Then try getting it to deliver mail, both locally and remotely.
2434 This can be done by passing messages directly to Exim, without going through a
2435 user agent. For example:
2436 .code
2437 exim -v postmaster@your.domain.example
2438 From: user@your.domain.example
2439 To: postmaster@your.domain.example
2440 Subject: Testing Exim
2441
2442 This is a test message.
2443 ^D
2444 .endd
2445 The &%-v%& option causes Exim to output some verification of what it is doing.
2446 In this case you should see copies of three log lines, one for the message's
2447 arrival, one for its delivery, and one containing &"Completed"&.
2448
2449 .cindex "delivery" "problems with"
2450 If you encounter problems, look at Exim's log files (&'mainlog'& and
2451 &'paniclog'&) to see if there is any relevant information there. Another source
2452 of information is running Exim with debugging turned on, by specifying the
2453 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2454 with debugging turned on by a command of the form
2455 .display
2456 &`exim -d -M`& <&'exim-message-id'&>
2457 .endd
2458 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2459 produces rather a lot of output, but you can cut this down to specific areas.
2460 For example, if you use &%-d-all+route%& only the debugging information
2461 relevant to routing is included. (See the &%-d%& option in chapter
2462 &<<CHAPcommandline>>& for more details.)
2463
2464 .cindex '&"sticky"& bit'
2465 .cindex "lock files"
2466 One specific problem that has shown up on some sites is the inability to do
2467 local deliveries into a shared mailbox directory, because it does not have the
2468 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2469 writing to a mailbox file, and if it cannot create the lock file, the delivery
2470 is deferred. You can get round this either by setting the &"sticky bit"& on the
2471 directory, or by setting a specific group for local deliveries and allowing
2472 that group to create files in the directory (see the comments above the
2473 &(local_delivery)& transport in the default configuration file). Another
2474 approach is to configure Exim not to use lock files, but just to rely on
2475 &[fcntl()]& locking instead. However, you should do this only if all user
2476 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2477 see chapter &<<CHAPappendfile>>&.
2478
2479 One thing that cannot be tested on a system that is already running an MTA is
2480 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2481 &%-oX%& option can be used to run an Exim daemon that listens on some other
2482 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2483 &'exim_checkaccess'& utility can be used to check out policy controls on
2484 incoming SMTP mail.
2485
2486 Testing a new version on a system that is already running Exim can most easily
2487 be done by building a binary with a different CONFIGURE_FILE setting. From
2488 within the runtime configuration, all other file and directory names
2489 that Exim uses can be altered, in order to keep it entirely clear of the
2490 production version.
2491
2492
2493 .section "Replacing another MTA with Exim" "SECID35"
2494 .cindex "replacing another MTA"
2495 Building and installing Exim for the first time does not of itself put it in
2496 general use. The name by which the system's MTA is called by mail user agents
2497 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2498 operating system), and it is necessary to make this name point to the &'exim'&
2499 binary in order to get the user agents to pass messages to Exim. This is
2500 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2501 or &_/usr/lib/sendmail_&
2502 .cindex "symbolic link" "to &'exim'& binary"
2503 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2504 privilege and executable status from the old MTA. It is then necessary to stop
2505 and restart the mailer daemon, if one is running.
2506
2507 .cindex "FreeBSD, MTA indirection"
2508 .cindex "&_/etc/mail/mailer.conf_&"
2509 Some operating systems have introduced alternative ways of switching MTAs. For
2510 example, if you are running FreeBSD, you need to edit the file
2511 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2512 described. A typical example of the contents of this file for running Exim is
2513 as follows:
2514 .code
2515 sendmail            /usr/exim/bin/exim
2516 send-mail           /usr/exim/bin/exim
2517 mailq               /usr/exim/bin/exim -bp
2518 newaliases          /usr/bin/true
2519 .endd
2520 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2521 your Exim installation is &"live"&. Check it by sending a message from your
2522 favourite user agent.
2523
2524 You should consider what to tell your users about the change of MTA. Exim may
2525 have different capabilities to what was previously running, and there are
2526 various operational differences such as the text of messages produced by
2527 command line options and in bounce messages. If you allow your users to make
2528 use of Exim's filtering capabilities, you should make the document entitled
2529 &'Exim's interface to mail filtering'& available to them.
2530
2531
2532
2533 .section "Upgrading Exim" "SECID36"
2534 .cindex "upgrading Exim"
2535 If you are already running Exim on your host, building and installing a new
2536 version automatically makes it available to MUAs, or any other programs that
2537 call the MTA directly. However, if you are running an Exim daemon, you do need
2538 .cindex restart "on HUP signal"
2539 .cindex signal "HUP, to restart"
2540 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2541 new binary. You do not need to stop processing mail in order to install a new
2542 version of Exim. The install script does not modify an existing runtime
2543 configuration file.
2544
2545
2546
2547
2548 .section "Stopping the Exim daemon on Solaris" "SECID37"
2549 .cindex "Solaris" "stopping Exim on"
2550 The standard command for stopping the mailer daemon on Solaris is
2551 .code
2552 /etc/init.d/sendmail stop
2553 .endd
2554 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2555 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2556 for the text &"sendmail"&; this is not present because the actual program name
2557 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2558 solution is to replace the line that finds the process id with something like
2559 .code
2560 pid=`cat /var/spool/exim/exim-daemon.pid`
2561 .endd
2562 to obtain the daemon's pid directly from the file that Exim saves it in.
2563
2564 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2565 still be received from local processes, and if automatic delivery is configured
2566 (the normal case), deliveries will still occur.
2567
2568
2569
2570
2571 . ////////////////////////////////////////////////////////////////////////////
2572 . ////////////////////////////////////////////////////////////////////////////
2573
2574 .chapter "The Exim command line" "CHAPcommandline"
2575 .scindex IIDclo1 "command line" "options"
2576 .scindex IIDclo2 "options" "command line"
2577 Exim's command line takes the standard Unix form of a sequence of options,
2578 each starting with a hyphen character, followed by a number of arguments. The
2579 options are compatible with the main options of Sendmail, and there are also
2580 some additional options, some of which are compatible with Smail 3. Certain
2581 combinations of options do not make sense, and provoke an error if used.
2582 The form of the arguments depends on which options are set.
2583
2584
2585 .section "Setting options by program name" "SECID38"
2586 .cindex "&'mailq'&"
2587 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2588 were present before any other options.
2589 The &%-bp%& option requests a listing of the contents of the mail queue on the
2590 standard output.
2591 This feature is for compatibility with some systems that contain a command of
2592 that name in one of the standard libraries, symbolically linked to
2593 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2594
2595 .cindex "&'rsmtp'&"
2596 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2597 were present before any other options, for compatibility with Smail. The
2598 &%-bS%& option is used for reading in a number of messages in batched SMTP
2599 format.
2600
2601 .cindex "&'rmail'&"
2602 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2603 &%-oee%& options were present before any other options, for compatibility with
2604 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2605
2606 .cindex "&'runq'&"
2607 .cindex "queue runner"
2608 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2609 were present before any other options, for compatibility with Smail. The &%-q%&
2610 option causes a single queue runner process to be started.
2611
2612 .cindex "&'newaliases'&"
2613 .cindex "alias file" "building"
2614 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2615 If Exim is called under the name &'newaliases'& it behaves as if the option
2616 &%-bi%& were present before any other options, for compatibility with Sendmail.
2617 This option is used for rebuilding Sendmail's alias file. Exim does not have
2618 the concept of a single alias file, but can be configured to run a given
2619 command if called with the &%-bi%& option.
2620
2621
2622 .section "Trusted and admin users" "SECTtrustedadmin"
2623 Some Exim options are available only to &'trusted users'& and others are
2624 available only to &'admin users'&. In the description below, the phrases &"Exim
2625 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2626 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2627 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2628
2629 .ilist
2630 .cindex "trusted users" "definition of"
2631 .cindex "user" "trusted definition of"
2632 The trusted users are root, the Exim user, any user listed in the
2633 &%trusted_users%& configuration option, and any user whose current group or any
2634 supplementary group is one of those listed in the &%trusted_groups%&
2635 configuration option. Note that the Exim group is not automatically trusted.
2636
2637 .cindex '&"From"& line'
2638 .cindex "envelope from"
2639 .cindex "envelope sender"
2640 Trusted users are always permitted to use the &%-f%& option or a leading
2641 &"From&~"& line to specify the envelope sender of a message that is passed to
2642 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2643 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2644 users to set envelope senders.
2645
2646 .cindex "&'From:'& header line"
2647 .cindex "&'Sender:'& header line"
2648 .cindex "header lines" "From:"
2649 .cindex "header lines" "Sender:"
2650 For a trusted user, there is never any check on the contents of the &'From:'&
2651 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2652 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2653
2654 Trusted users may also specify a host name, host address, interface address,
2655 protocol name, ident value, and authentication data when submitting a message
2656 locally. Thus, they are able to insert messages into Exim's queue locally that
2657 have the characteristics of messages received from a remote host. Untrusted
2658 users may in some circumstances use &%-f%&, but can never set the other values
2659 that are available to trusted users.
2660 .next
2661 .cindex "user" "admin definition of"
2662 .cindex "admin user" "definition of"
2663 The admin users are root, the Exim user, and any user that is a member of the
2664 Exim group or of any group listed in the &%admin_groups%& configuration option.
2665 The current group does not have to be one of these groups.
2666
2667 Admin users are permitted to list the queue, and to carry out certain
2668 operations on messages, for example, to force delivery failures. It is also
2669 necessary to be an admin user in order to see the full information provided by
2670 the Exim monitor, and full debugging output.
2671
2672 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2673 Exim to attempt delivery of messages on its queue is restricted to admin users.
2674 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2675 option false (that is, specifying &%no_prod_requires_admin%&).
2676
2677 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2678 is restricted to admin users unless &%queue_list_requires_admin%& is set
2679 false.
2680 .endlist
2681
2682
2683 &*Warning*&: If you configure your system so that admin users are able to
2684 edit Exim's configuration file, you are giving those users an easy way of
2685 getting root. There is further discussion of this issue at the start of chapter
2686 &<<CHAPconf>>&.
2687
2688
2689
2690
2691 .section "Command line options" "SECID39"
2692 Exim's command line options are described in alphabetical order below. If none
2693 of the options that specifies a specific action (such as starting the daemon or
2694 a queue runner, or testing an address, or receiving a message in a specific
2695 format, or listing the queue) are present, and there is at least one argument
2696 on the command line, &%-bm%& (accept a local message on the standard input,
2697 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2698 outputs a brief message about itself and exits.
2699
2700 . ////////////////////////////////////////////////////////////////////////////
2701 . Insert a stylized XML comment here, to identify the start of the command line
2702 . options. This is for the benefit of the Perl script that automatically
2703 . creates a man page for the options.
2704 . ////////////////////////////////////////////////////////////////////////////
2705
2706 .literal xml
2707 <!-- === Start of command line options === -->
2708 .literal off
2709
2710
2711 .vlist
2712 .vitem &%--%&
2713 .oindex "--"
2714 .cindex "options" "command line; terminating"
2715 This is a pseudo-option whose only purpose is to terminate the options and
2716 therefore to cause subsequent command line items to be treated as arguments
2717 rather than options, even if they begin with hyphens.
2718
2719 .vitem &%--help%&
2720 .oindex "&%--help%&"
2721 This option causes Exim to output a few sentences stating what it is.
2722 The same output is generated if the Exim binary is called with no options and
2723 no arguments.
2724
2725 .vitem &%--version%&
2726 .oindex "&%--version%&"
2727 This option is an alias for &%-bV%& and causes version information to be
2728 displayed.
2729
2730 .vitem &%-Ac%& &&&
2731        &%-Am%&
2732 .oindex "&%-Ac%&"
2733 .oindex "&%-Am%&"
2734 These options are used by Sendmail for selecting configuration files and are
2735 ignored by Exim.
2736
2737 .vitem &%-B%&<&'type'&>
2738 .oindex "&%-B%&"
2739 .cindex "8-bit characters"
2740 .cindex "Sendmail compatibility" "8-bit characters"
2741 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2742 clean; it ignores this option.
2743
2744 .vitem &%-bd%&
2745 .oindex "&%-bd%&"
2746 .cindex "daemon"
2747 .cindex "SMTP" "listener"
2748 .cindex "queue runner"
2749 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2750 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2751 that the daemon should also initiate periodic queue runs.
2752
2753 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2754 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2755 disconnect from the controlling terminal. When running this way, it can be
2756 stopped by pressing ctrl-C.
2757
2758 By default, Exim listens for incoming connections to the standard SMTP port on
2759 all the host's running interfaces. However, it is possible to listen on other
2760 ports, on multiple ports, and only on specific interfaces. Chapter
2761 &<<CHAPinterfaces>>& contains a description of the options that control this.
2762
2763 When a listening daemon
2764 .cindex "daemon" "process id (pid)"
2765 .cindex "pid (process id)" "of daemon"
2766 is started without the use of &%-oX%& (that is, without overriding the normal
2767 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2768 in Exim's spool directory. This location can be overridden by setting
2769 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2770 running as root.
2771
2772 When &%-oX%& is used on the command line to start a listening daemon, the
2773 process id is not written to the normal pid file path. However, &%-oP%& can be
2774 used to specify a path on the command line if a pid file is required.
2775
2776 The SIGHUP signal
2777 .cindex "SIGHUP"
2778 .cindex restart "on HUP signal"
2779 .cindex signal "HUP, to restart"
2780 .cindex "daemon" "restarting"
2781 .cindex signal "to reload configuration"
2782 .cindex daemon "reload configuration"
2783 .cindex reload configuration
2784 can be used to cause the daemon to re-execute itself. This should be done
2785 whenever Exim's configuration file, or any file that is incorporated into it by
2786 means of the &%.include%& facility, is changed, and also whenever a new version
2787 of Exim is installed. It is not necessary to do this when other files that are
2788 referenced from the configuration (for example, alias files) are changed,
2789 because these are reread each time they are used.
2790
2791 .vitem &%-bdf%&
2792 .oindex "&%-bdf%&"
2793 This option has the same effect as &%-bd%& except that it never disconnects
2794 from the controlling terminal, even when no debugging is specified.
2795
2796 .vitem &%-be%&
2797 .oindex "&%-be%&"
2798 .cindex "testing" "string expansion"
2799 .cindex "expansion" "testing"
2800 Run Exim in expansion testing mode. Exim discards its root privilege, to
2801 prevent ordinary users from using this mode to read otherwise inaccessible
2802 files. If no arguments are given, Exim runs interactively, prompting for lines
2803 of data. Otherwise, it processes each argument in turn.
2804
2805 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2806 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2807 used without command line arguments. If successful, it uses the &[readline()]&
2808 function, which provides extensive line-editing facilities, for reading the
2809 test data. A line history is supported.
2810
2811 Long expansion expressions can be split over several lines by using backslash
2812 continuations. As in Exim's runtime configuration, white space at the start of
2813 continuation lines is ignored. Each argument or data line is passed through the
2814 string expansion mechanism, and the result is output. Variable values from the
2815 configuration file (for example, &$qualify_domain$&) are available, but no
2816 message-specific values (such as &$message_exim_id$&) are set, because no message
2817 is being processed (but see &%-bem%& and &%-Mset%&).
2818
2819 &*Note*&: If you use this mechanism to test lookups, and you change the data
2820 files or databases you are using, you must exit and restart Exim before trying
2821 the same lookup again. Otherwise, because each Exim process caches the results
2822 of lookups, you will just get the same result as before.
2823
2824 Macro processing is done on lines before string-expansion: new macros can be
2825 defined and macros will be expanded.
2826 Because macros in the config file are often used for secrets, those are only
2827 available to admin users.
2828
2829 .vitem &%-bem%&&~<&'filename'&>
2830 .oindex "&%-bem%&"
2831 .cindex "testing" "string expansion"
2832 .cindex "expansion" "testing"
2833 This option operates like &%-be%& except that it must be followed by the name
2834 of a file. For example:
2835 .code
2836 exim -bem /tmp/testmessage
2837 .endd
2838 The file is read as a message (as if receiving a locally-submitted non-SMTP
2839 message) before any of the test expansions are done. Thus, message-specific
2840 variables such as &$message_size$& and &$header_from:$& are available. However,
2841 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2842 recipients are read from the headers in the normal way, and are shown in the
2843 &$recipients$& variable. Note that recipients cannot be given on the command
2844 line, because further arguments are taken as strings to expand (just like
2845 &%-be%&).
2846
2847 .vitem &%-bF%&&~<&'filename'&>
2848 .oindex "&%-bF%&"
2849 .cindex "system filter" "testing"
2850 .cindex "testing" "system filter"
2851 This option is the same as &%-bf%& except that it assumes that the filter being
2852 tested is a system filter. The additional commands that are available only in
2853 system filters are recognized.
2854
2855 .vitem &%-bf%&&~<&'filename'&>
2856 .oindex "&%-bf%&"
2857 .cindex "filter" "testing"
2858 .cindex "testing" "filter file"
2859 .cindex "forward file" "testing"
2860 .cindex "testing" "forward file"
2861 .cindex "Sieve filter" "testing"
2862 This option runs Exim in user filter testing mode; the file is the filter file
2863 to be tested, and a test message must be supplied on the standard input. If
2864 there are no message-dependent tests in the filter, an empty file can be
2865 supplied.
2866
2867 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2868 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2869 filter and a user filter in the same run. For example:
2870 .code
2871 exim -bF /system/filter -bf /user/filter </test/message
2872 .endd
2873 This is helpful when the system filter adds header lines or sets filter
2874 variables that are used by the user filter.
2875
2876 If the test filter file does not begin with one of the special lines
2877 .code
2878 # Exim filter
2879 # Sieve filter
2880 .endd
2881 it is taken to be a normal &_.forward_& file, and is tested for validity under
2882 that interpretation. See sections &<<SECTitenonfilred>>& to
2883 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2884 redirection lists.
2885
2886 The result of an Exim command that uses &%-bf%&, provided no errors are
2887 detected, is a list of the actions that Exim would try to take if presented
2888 with the message for real. More details of filter testing are given in the
2889 separate document entitled &'Exim's interfaces to mail filtering'&.
2890
2891 When testing a filter file,
2892 .cindex "&""From""& line"
2893 .cindex "envelope from"
2894 .cindex "envelope sender"
2895 .oindex "&%-f%&" "for filter testing"
2896 the envelope sender can be set by the &%-f%& option,
2897 or by a &"From&~"& line at the start of the test message. Various parameters
2898 that would normally be taken from the envelope recipient address of the message
2899 can be set by means of additional command line options (see the next four
2900 options).
2901
2902 .vitem &%-bfd%&&~<&'domain'&>
2903 .oindex "&%-bfd%&"
2904 .vindex "&$qualify_domain$&"
2905 This sets the domain of the recipient address when a filter file is being
2906 tested by means of the &%-bf%& option. The default is the value of
2907 &$qualify_domain$&.
2908
2909 .vitem &%-bfl%&&~<&'local&~part'&>
2910 .oindex "&%-bfl%&"
2911 This sets the local part of the recipient address when a filter file is being
2912 tested by means of the &%-bf%& option. The default is the username of the
2913 process that calls Exim. A local part should be specified with any prefix or
2914 suffix stripped, because that is how it appears to the filter when a message is
2915 actually being delivered.
2916
2917 .vitem &%-bfp%&&~<&'prefix'&>
2918 .oindex "&%-bfp%&"
2919 .cindex affix "filter testing"
2920 This sets the prefix of the local part of the recipient address when a filter
2921 file is being tested by means of the &%-bf%& option. The default is an empty
2922 prefix.
2923
2924 .vitem &%-bfs%&&~<&'suffix'&>
2925 .oindex "&%-bfs%&"
2926 .cindex affix "filter testing"
2927 This sets the suffix of the local part of the recipient address when a filter
2928 file is being tested by means of the &%-bf%& option. The default is an empty
2929 suffix.
2930
2931 .vitem &%-bh%&&~<&'IP&~address'&>
2932 .oindex "&%-bh%&"
2933 .cindex "testing" "incoming SMTP"
2934 .cindex "SMTP" "testing incoming"
2935 .cindex "testing" "relay control"
2936 .cindex "relaying" "testing configuration"
2937 .cindex "policy control" "testing"
2938 .cindex "debugging" "&%-bh%& option"
2939 This option runs a fake SMTP session as if from the given IP address, using the
2940 standard input and output. The IP address may include a port number at the end,
2941 after a full stop. For example:
2942 .code
2943 exim -bh 10.9.8.7.1234
2944 exim -bh fe80::a00:20ff:fe86:a061.5678
2945 .endd
2946 When an IPv6 address is given, it is converted into canonical form. In the case
2947 of the second example above, the value of &$sender_host_address$& after
2948 conversion to the canonical form is
2949 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2950
2951 Comments as to what is going on are written to the standard error file. These
2952 include lines beginning with &"LOG"& for anything that would have been logged.
2953 This facility is provided for testing configuration options for incoming
2954 messages, to make sure they implement the required policy. For example, you can
2955 test your relay controls using &%-bh%&.
2956
2957 &*Warning 1*&:
2958 .cindex "RFC 1413"
2959 You can test features of the configuration that rely on ident (RFC 1413)
2960 information by using the &%-oMt%& option. However, Exim cannot actually perform
2961 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2962 connection.
2963
2964 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2965 are also skipped when testing using &%-bh%&. If you want these callouts to
2966 occur, use &%-bhc%& instead.
2967
2968 Messages supplied during the testing session are discarded, and nothing is
2969 written to any of the real log files. There may be pauses when DNS (and other)
2970 lookups are taking place, and of course these may time out. The &%-oMi%& option
2971 can be used to specify a specific IP interface and port if this is important,
2972 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2973 session were authenticated.
2974
2975 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2976 output just states whether a given recipient address from a given host is
2977 acceptable or not. See section &<<SECTcheckaccess>>&.
2978
2979 Features such as authentication and encryption, where the client input is not
2980 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2981 specialized SMTP test program such as
2982 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2983
2984 .vitem &%-bhc%&&~<&'IP&~address'&>
2985 .oindex "&%-bhc%&"
2986 This option operates in the same way as &%-bh%&, except that address
2987 verification callouts are performed if required. This includes consulting and
2988 updating the callout cache database.
2989
2990 .vitem &%-bi%&
2991 .oindex "&%-bi%&"
2992 .cindex "alias file" "building"
2993 .cindex "building alias file"
2994 .cindex "Sendmail compatibility" "&%-bi%& option"
2995 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2996 Exim does not have the concept of a single alias file, and so it cannot mimic
2997 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2998 tend to appear in various scripts such as NIS make files, so the option must be
2999 recognized.
3000
3001 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3002 configuration option is run, under the uid and gid of the caller of Exim. If
3003 the &%-oA%& option is used, its value is passed to the command as an argument.
3004 The command set by &%bi_command%& may not contain arguments. The command can
3005 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3006 if this is required. If the &%bi_command%& option is not set, calling Exim with
3007 &%-bi%& is a no-op.
3008
3009 . // Keep :help first, then the rest in alphabetical order
3010 .vitem &%-bI:help%&
3011 .oindex "&%-bI:help%&"
3012 .cindex "querying exim information"
3013 We shall provide various options starting &`-bI:`& for querying Exim for
3014 information.  The output of many of these will be intended for machine
3015 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3016 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3017 options shall cause Exim to exit after producing the requested output.
3018
3019 .vitem &%-bI:dscp%&
3020 .oindex "&%-bI:dscp%&"
3021 .cindex "DSCP" "values"
3022 This option causes Exim to emit an alphabetically sorted list of all
3023 recognised DSCP names.
3024
3025 .vitem &%-bI:sieve%&
3026 .oindex "&%-bI:sieve%&"
3027 .cindex "Sieve filter" "capabilities"
3028 This option causes Exim to emit an alphabetically sorted list of all supported
3029 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3030 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3031 &`SIEVE`& capability response line.  As the precise list may depend upon
3032 compile-time build options, which this option will adapt to, this is the only
3033 way to guarantee a correct response.
3034
3035 .vitem &%-bm%&
3036 .oindex "&%-bm%&"
3037 .cindex "local message reception"
3038 This option runs an Exim receiving process that accepts an incoming,
3039 locally-generated message on the standard input. The recipients are given as the
3040 command arguments (except when &%-t%& is also present &-- see below). Each
3041 argument can be a comma-separated list of RFC 2822 addresses. This is the
3042 default option for selecting the overall action of an Exim call; it is assumed
3043 if no other conflicting option is present.
3044
3045 If any addresses in the message are unqualified (have no domain), they are
3046 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3047 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3048 suppressing this for special cases.
3049
3050 Policy checks on the contents of local messages can be enforced by means of
3051 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3052
3053 .cindex "return code" "for &%-bm%&"
3054 The return code is zero if the message is successfully accepted. Otherwise, the
3055 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3056
3057 The format
3058 .cindex "message" "format"
3059 .cindex "format" "message"
3060 .cindex "&""From""& line"
3061 .cindex "UUCP" "&""From""& line"
3062 .cindex "Sendmail compatibility" "&""From""& line"
3063 of the message must be as defined in RFC 2822, except that, for
3064 compatibility with Sendmail and Smail, a line in one of the forms
3065 .code
3066 From sender Fri Jan  5 12:55 GMT 1997
3067 From sender Fri, 5 Jan 97 12:55:01
3068 .endd
3069 (with the weekday optional, and possibly with additional text after the date)
3070 is permitted to appear at the start of the message. There appears to be no
3071 authoritative specification of the format of this line. Exim recognizes it by
3072 matching against the regular expression defined by the &%uucp_from_pattern%&
3073 option, which can be changed if necessary.
3074
3075 .oindex "&%-f%&" "overriding &""From""& line"
3076 The specified sender is treated as if it were given as the argument to the
3077 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3078 preference to the address taken from the message. The caller of Exim must be a
3079 trusted user for the sender of a message to be set in this way.
3080
3081 .vitem &%-bmalware%&&~<&'filename'&>
3082 .oindex "&%-bmalware%&"
3083 .cindex "testing", "malware"
3084 .cindex "malware scan test"
3085 This debugging option causes Exim to scan the given file or directory
3086 (depending on the used scanner interface),
3087 using the malware scanning framework.  The option of &%av_scanner%& influences
3088 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3089 the expansion should have defaults which apply to this invocation.  ACLs are
3090 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3091 will never be populated and &%-bmalware%& will fail.
3092
3093 Exim will have changed working directory before resolving the filename, so
3094 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3095 user when it tries to open the file, rather than as the invoking user.
3096 This option requires admin privileges.
3097
3098 The &%-bmalware%& option will not be extended to be more generally useful,
3099 there are better tools for file-scanning.  This option exists to help
3100 administrators verify their Exim and AV scanner configuration.
3101
3102 .vitem &%-bnq%&
3103 .oindex "&%-bnq%&"
3104 .cindex "address qualification, suppressing"
3105 By default, Exim automatically qualifies unqualified addresses (those
3106 without domains) that appear in messages that are submitted locally (that
3107 is, not over TCP/IP). This qualification applies both to addresses in
3108 envelopes, and addresses in header lines. Sender addresses are qualified using
3109 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3110 defaults to the value of &%qualify_domain%&).
3111
3112 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3113 being used to re-submit messages that originally came from remote hosts after
3114 content scanning, you probably do not want to qualify unqualified addresses in
3115 header lines. (Such lines will be present only if you have not enabled a header
3116 syntax check in the appropriate ACL.)
3117
3118 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3119 messages that originate on the local host. When this is used, unqualified
3120 addresses in the envelope provoke errors (causing message rejection) and
3121 unqualified addresses in header lines are left alone.
3122
3123
3124 .vitem &%-bP%&
3125 .oindex "&%-bP%&"
3126 .cindex "configuration options" "extracting"
3127 .cindex "options" "configuration &-- extracting"
3128 If this option is given with no arguments, it causes the values of all Exim's
3129 main configuration options to be written to the standard output. The values
3130 of one or more specific options can be requested by giving their names as
3131 arguments, for example:
3132 .code
3133 exim -bP qualify_domain hold_domains
3134 .endd
3135 .cindex "hiding configuration option values"
3136 .cindex "configuration options" "hiding value of"
3137 .cindex "options" "hiding value of"
3138 However, any option setting that is preceded by the word &"hide"& in the
3139 configuration file is not shown in full, except to an admin user. For other
3140 users, the output is as in this example:
3141 .code
3142 mysql_servers = <value not displayable>
3143 .endd
3144 If &%config%& is given as an argument, the config is
3145 output, as it was parsed, any include file resolved, any comment removed.
3146
3147 If &%config_file%& is given as an argument, the name of the runtime
3148 configuration file is output. (&%configure_file%& works too, for
3149 backward compatibility.)
3150 If a list of configuration files was supplied, the value that is output here
3151 is the name of the file that was actually used.
3152
3153 .cindex "options" "hiding name of"
3154 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3155 name will not be output.
3156
3157 .cindex "daemon" "process id (pid)"
3158 .cindex "pid (process id)" "of daemon"
3159 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3160 directories where log files and daemon pid files are written are output,
3161 respectively. If these values are unset, log files are written in a
3162 sub-directory of the spool directory called &%log%&, and the pid file is
3163 written directly into the spool directory.
3164
3165 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3166 .code
3167 exim -bP +local_domains
3168 .endd
3169 it searches for a matching named list of any type (domain, host, address, or
3170 local part) and outputs what it finds.
3171
3172 .cindex "options" "router &-- extracting"
3173 .cindex "options" "transport &-- extracting"
3174 .cindex "options" "authenticator &-- extracting"
3175 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3176 followed by the name of an appropriate driver instance, the option settings for
3177 that driver are output. For example:
3178 .code
3179 exim -bP transport local_delivery
3180 .endd
3181 The generic driver options are output first, followed by the driver's private
3182 options. A list of the names of drivers of a particular type can be obtained by
3183 using one of the words &%router_list%&, &%transport_list%&, or
3184 &%authenticator_list%&, and a complete list of all drivers with their option
3185 settings can be obtained by using &%routers%&, &%transports%&, or
3186 &%authenticators%&.
3187
3188 .cindex "environment"
3189 If &%environment%& is given as an argument, the set of environment
3190 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3191 variables.
3192
3193 .cindex "options" "macro &-- extracting"
3194 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3195 are available, similarly to the drivers.  Because macros are sometimes used
3196 for storing passwords, this option is restricted.
3197 The output format is one item per line.
3198 For the "-bP macro <name>" form, if no such macro is found
3199 the exit status will be nonzero.
3200
3201 .vitem &%-bp%&
3202 .oindex "&%-bp%&"
3203 .cindex "queue" "listing messages in"
3204 .cindex "listing" "messages in the queue"
3205 This option requests a listing of the contents of the mail queue on the
3206 standard output. If the &%-bp%& option is followed by a list of message ids,
3207 just those messages are listed. By default, this option can be used only by an
3208 admin user. However, the &%queue_list_requires_admin%& option can be set false
3209 to allow any user to see the queue.
3210
3211 Each message in the queue is displayed as in the following example:
3212 .code
3213 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3214           red.king@looking-glass.fict.example
3215           <other addresses>
3216 .endd
3217 .cindex "message" "size in queue listing"
3218 .cindex "size" "of message"
3219 The first line contains the length of time the message has been in the queue
3220 (in this case 25 minutes), the size of the message (2.9K), the unique local
3221 identifier for the message, and the message sender, as contained in the
3222 envelope. For bounce messages, the sender address is empty, and appears as
3223 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3224 the default sender address, the user's login name is shown in parentheses
3225 before the sender address.
3226
3227 .cindex "frozen messages" "in queue listing"
3228 If the message is frozen (attempts to deliver it are suspended) then the text
3229 &"*** frozen ***"& is displayed at the end of this line.
3230
3231 The recipients of the message (taken from the envelope, not the headers) are
3232 displayed on subsequent lines. Those addresses to which the message has already
3233 been delivered are marked with the letter D. If an original address gets
3234 expanded into several addresses via an alias or forward file, the original is
3235 displayed with a D only when deliveries for all of its child addresses are
3236 complete.
3237
3238
3239 .vitem &%-bpa%&
3240 .oindex "&%-bpa%&"
3241 This option operates like &%-bp%&, but in addition it shows delivered addresses
3242 that were generated from the original top level address(es) in each message by
3243 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3244 of just &"D"&.
3245
3246
3247 .vitem &%-bpc%&
3248 .oindex "&%-bpc%&"
3249 .cindex "queue" "count of messages on"
3250 This option counts the number of messages in the queue, and writes the total
3251 to the standard output. It is restricted to admin users, unless
3252 &%queue_list_requires_admin%& is set false.
3253
3254
3255 .vitem &%-bpr%&
3256 .oindex "&%-bpr%&"
3257 This option operates like &%-bp%&, but the output is not sorted into
3258 chronological order of message arrival. This can speed it up when there are
3259 lots of messages in the queue, and is particularly useful if the output is
3260 going to be post-processed in a way that doesn't need the sorting.
3261
3262 .vitem &%-bpra%&
3263 .oindex "&%-bpra%&"
3264 This option is a combination of &%-bpr%& and &%-bpa%&.
3265
3266 .vitem &%-bpru%&
3267 .oindex "&%-bpru%&"
3268 This option is a combination of &%-bpr%& and &%-bpu%&.
3269
3270
3271 .vitem &%-bpu%&
3272 .oindex "&%-bpu%&"
3273 This option operates like &%-bp%& but shows only undelivered top-level
3274 addresses for each message displayed. Addresses generated by aliasing or
3275 forwarding are not shown, unless the message was deferred after processing by a
3276 router with the &%one_time%& option set.
3277
3278
3279 .vitem &%-brt%&
3280 .oindex "&%-brt%&"
3281 .cindex "testing" "retry configuration"
3282 .cindex "retry" "configuration testing"
3283 This option is for testing retry rules, and it must be followed by up to three
3284 arguments. It causes Exim to look for a retry rule that matches the values
3285 and to write it to the standard output. For example:
3286 .code
3287 exim -brt bach.comp.mus.example
3288 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3289 .endd
3290 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3291 argument, which is required, can be a complete address in the form
3292 &'local_part@domain'&, or it can be just a domain name. If the second argument
3293 contains a dot, it is interpreted as an optional second domain name; if no
3294 retry rule is found for the first argument, the second is tried. This ties in
3295 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3296 rule is found that matches the host, one that matches the mail domain is
3297 sought. Finally, an argument that is the name of a specific delivery error, as
3298 used in setting up retry rules, can be given. For example:
3299 .code
3300 exim -brt haydn.comp.mus.example quota_3d
3301 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3302 .endd
3303
3304 .vitem &%-brw%&
3305 .oindex "&%-brw%&"
3306 .cindex "testing" "rewriting"
3307 .cindex "rewriting" "testing"
3308 This option is for testing address rewriting rules, and it must be followed by
3309 a single argument, consisting of either a local part without a domain, or a
3310 complete address with a fully qualified domain. Exim outputs how this address
3311 would be rewritten for each possible place it might appear. See chapter
3312 &<<CHAPrewrite>>& for further details.
3313
3314 .vitem &%-bS%&
3315 .oindex "&%-bS%&"
3316 .cindex "SMTP" "batched incoming"
3317 .cindex "batched SMTP input"
3318 This option is used for batched SMTP input, which is an alternative interface
3319 for non-interactive local message submission. A number of messages can be
3320 submitted in a single run. However, despite its name, this is not really SMTP
3321 input. Exim reads each message's envelope from SMTP commands on the standard
3322 input, but generates no responses. If the caller is trusted, or
3323 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3324 believed; otherwise the sender is always the caller of Exim.
3325
3326 The message itself is read from the standard input, in SMTP format (leading
3327 dots doubled), terminated by a line containing just a single dot. An error is
3328 provoked if the terminating dot is missing. A further message may then follow.
3329
3330 As for other local message submissions, the contents of incoming batch SMTP
3331 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3332 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3333 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3334
3335 Some other SMTP commands are recognized in the input. HELO and EHLO act
3336 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3337 QUIT quits, ignoring the rest of the standard input.
3338
3339 .cindex "return code" "for &%-bS%&"
3340 If any error is encountered, reports are written to the standard output and
3341 error streams, and Exim gives up immediately. The return code is 0 if no error
3342 was detected; it is 1 if one or more messages were accepted before the error
3343 was detected; otherwise it is 2.
3344
3345 More details of input using batched SMTP are given in section
3346 &<<SECTincomingbatchedSMTP>>&.
3347
3348 .vitem &%-bs%&
3349 .oindex "&%-bs%&"
3350 .cindex "SMTP" "local input"
3351 .cindex "local SMTP input"
3352 This option causes Exim to accept one or more messages by reading SMTP commands
3353 on the standard input, and producing SMTP replies on the standard output. SMTP
3354 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3355 Some user agents use this interface as a way of passing locally-generated
3356 messages to the MTA.
3357
3358 In
3359 .cindex "sender" "source of"
3360 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3361 set, the senders of messages are taken from the SMTP MAIL commands.
3362 Otherwise the content of these commands is ignored and the sender is set up as
3363 the calling user. Unqualified addresses are automatically qualified using
3364 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3365 &%-bnq%& option is used.
3366
3367 .cindex "inetd"
3368 The
3369 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3370 using a listening daemon. Exim can distinguish the two cases by checking
3371 whether the standard input is a TCP/IP socket. When Exim is called from
3372 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3373 above concerning senders and qualification do not apply. In this situation,
3374 Exim behaves in exactly the same way as it does when receiving a message via
3375 the listening daemon.
3376
3377 .vitem &%-bt%&
3378 .oindex "&%-bt%&"
3379 .cindex "testing" "addresses"
3380 .cindex "address" "testing"
3381 This option runs Exim in address testing mode, in which each argument is taken
3382 as a recipient address to be tested for deliverability. The results are
3383 written to the standard output. If a test fails, and the caller is not an admin
3384 user, no details of the failure are output, because these might contain
3385 sensitive information such as usernames and passwords for database lookups.
3386
3387 If no arguments are given, Exim runs in an interactive manner, prompting with a
3388 right angle bracket for addresses to be tested.
3389
3390 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3391 &[readline()]& function, because it is running as &'root'& and there are
3392 security issues.
3393
3394 Each address is handled as if it were the recipient address of a message
3395 (compare the &%-bv%& option). It is passed to the routers and the result is
3396 written to the standard output. However, any router that has
3397 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3398 genuine routing tests if your first router passes everything to a scanner
3399 program.
3400
3401 .cindex "return code" "for &%-bt%&"
3402 The return code is 2 if any address failed outright; it is 1 if no address
3403 failed outright but at least one could not be resolved for some reason. Return
3404 code 0 is given only when all addresses succeed.
3405
3406 .cindex "duplicate addresses"
3407 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3408 addresses after routing is complete, so that only one delivery takes place.
3409 This does not happen when testing with &%-bt%&; the full results of routing are
3410 always shown.
3411
3412 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3413 routers in the configuration makes any tests on the sender address of a
3414 message,
3415 .oindex "&%-f%&" "for address testing"
3416 you can use the &%-f%& option to set an appropriate sender when running
3417 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3418 default qualifying domain. However, if you have set up (for example) routers
3419 whose behaviour depends on the contents of an incoming message, you cannot test
3420 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3421 doing such tests.
3422
3423 .vitem &%-bV%&
3424 .oindex "&%-bV%&"
3425 .cindex "version number of Exim"
3426 This option causes Exim to write the current version number, compilation
3427 number, and compilation date of the &'exim'& binary to the standard output.
3428 It also lists the DBM library that is being used, the optional modules (such as
3429 specific lookup types), the drivers that are included in the binary, and the
3430 name of the runtime configuration file that is in use.
3431
3432 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3433 configuration file. However, this is a static check only. It cannot check
3434 values that are to be expanded. For example, although a misspelt ACL verb is
3435 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3436 alone to discover (for example) all the typos in the configuration; some
3437 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3438 dynamic testing facilities.
3439
3440 .vitem &%-bv%&
3441 .oindex "&%-bv%&"
3442 .cindex "verifying address" "using &%-bv%&"
3443 .cindex "address" "verification"
3444 This option runs Exim in address verification mode, in which each argument is
3445 taken as a recipient address to be verified by the routers. (This does
3446 not involve any verification callouts). During normal operation, verification
3447 happens mostly as a consequence processing a &%verify%& condition in an ACL
3448 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3449 including callouts, see the &%-bh%& and &%-bhc%& options.
3450
3451 If verification fails, and the caller is not an admin user, no details of the
3452 failure are output, because these might contain sensitive information such as
3453 usernames and passwords for database lookups.
3454
3455 If no arguments are given, Exim runs in an interactive manner, prompting with a
3456 right angle bracket for addresses to be verified.
3457
3458 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3459 &[readline()]& function, because it is running as &'exim'& and there are
3460 security issues.
3461
3462 Verification differs from address testing (the &%-bt%& option) in that routers
3463 that have &%no_verify%& set are skipped, and if the address is accepted by a
3464 router that has &%fail_verify%& set, verification fails. The address is
3465 verified as a recipient if &%-bv%& is used; to test verification for a sender
3466 address, &%-bvs%& should be used.
3467
3468 If the &%-v%& option is not set, the output consists of a single line for each
3469 address, stating whether it was verified or not, and giving a reason in the
3470 latter case. Without &%-v%&, generating more than one address by redirection
3471 causes verification to end successfully, without considering the generated
3472 addresses. However, if just one address is generated, processing continues,
3473 and the generated address must verify successfully for the overall verification
3474 to succeed.
3475
3476 When &%-v%& is set, more details are given of how the address has been handled,
3477 and in the case of address redirection, all the generated addresses are also
3478 considered. Verification may succeed for some and fail for others.
3479
3480 The
3481 .cindex "return code" "for &%-bv%&"
3482 return code is 2 if any address failed outright; it is 1 if no address
3483 failed outright but at least one could not be resolved for some reason. Return
3484 code 0 is given only when all addresses succeed.
3485
3486 If any of the routers in the configuration makes any tests on the sender
3487 address of a message, you should use the &%-f%& option to set an appropriate
3488 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3489 calling user at the default qualifying domain.
3490
3491 .vitem &%-bvs%&
3492 .oindex "&%-bvs%&"
3493 This option acts like &%-bv%&, but verifies the address as a sender rather
3494 than a recipient address. This affects any rewriting and qualification that
3495 might happen.
3496
3497 .vitem &%-bw%&
3498 .oindex "&%-bw%&"
3499 .cindex "daemon"
3500 .cindex "inetd"
3501 .cindex "inetd" "wait mode"
3502 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3503 similarly to the &%-bd%& option.  All port specifications on the command-line
3504 and in the configuration file are ignored.  Queue-running may not be specified.
3505
3506 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3507 listening for connections.  This permits the system to start up and have
3508 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3509 each port only when the first connection is received.
3510
3511 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3512 which the daemon will exit, which should cause inetd to listen once more.
3513
3514 .vitem &%-C%&&~<&'filelist'&>
3515 .oindex "&%-C%&"
3516 .cindex "configuration file" "alternate"
3517 .cindex "CONFIGURE_FILE"
3518 .cindex "alternate configuration file"
3519 This option causes Exim to find the runtime configuration file from the given
3520 list instead of from the list specified by the CONFIGURE_FILE
3521 compile-time setting. Usually, the list will consist of just a single filename,
3522 but it can be a colon-separated list of names. In this case, the first
3523 file that exists is used. Failure to open an existing file stops Exim from
3524 proceeding any further along the list, and an error is generated.
3525
3526 When this option is used by a caller other than root, and the list is different
3527 from the compiled-in list, Exim gives up its root privilege immediately, and
3528 runs with the real and effective uid and gid set to those of the caller.
3529 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3530 file contains a list of full pathnames, one per line, for configuration files
3531 which are trusted. Root privilege is retained for any configuration file so
3532 listed, as long as the caller is the Exim user (or the user specified in the
3533 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3534 not writeable by inappropriate users or groups.
3535
3536 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3537 configuration using &%-C%& right through message reception and delivery,
3538 even if the caller is root. The reception works, but by that time, Exim is
3539 running as the Exim user, so when it re-executes to regain privilege for the
3540 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3541 test reception and delivery using two separate commands (one to put a message
3542 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3543
3544 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3545 prefix string with which any file named in a &%-C%& command line option
3546 must start. In addition, the filename must not contain the sequence &`/../`&.
3547 However, if the value of the &%-C%& option is identical to the value of
3548 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3549 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3550 unset, any filename can be used with &%-C%&.
3551
3552 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3553 to a directory to which only root has access. This prevents someone who has
3554 broken into the Exim account from running a privileged Exim with an arbitrary
3555 configuration file.
3556
3557 The &%-C%& facility is useful for ensuring that configuration files are
3558 syntactically correct, but cannot be used for test deliveries, unless the
3559 caller is privileged, or unless it is an exotic configuration that does not
3560 require privilege. No check is made on the owner or group of the files
3561 specified by this option.
3562
3563
3564 .vitem &%-D%&<&'macro'&>=<&'value'&>
3565 .oindex "&%-D%&"
3566 .cindex "macro" "setting on command line"
3567 This option can be used to override macro definitions in the configuration file
3568 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3569 unprivileged caller, it causes Exim to give up its root privilege.
3570 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3571 completely disabled, and its use causes an immediate error exit.
3572
3573 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3574 colon-separated list of macros which are considered safe and, if &%-D%& only
3575 supplies macros from this list, and the values are acceptable, then Exim will
3576 not give up root privilege if the caller is root, the Exim run-time user, or
3577 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3578 to be removed in the future.  Acceptable values for the macros satisfy the
3579 regexp: &`^[A-Za-z0-9_/.-]*$`&
3580
3581 The entire option (including equals sign if present) must all be within one
3582 command line item. &%-D%& can be used to set the value of a macro to the empty
3583 string, in which case the equals sign is optional. These two commands are
3584 synonymous:
3585 .code
3586 exim -DABC  ...
3587 exim -DABC= ...
3588 .endd
3589 To include spaces in a macro definition item, quotes must be used. If you use
3590 quotes, spaces are permitted around the macro name and the equals sign. For
3591 example:
3592 .code
3593 exim '-D ABC = something' ...
3594 .endd
3595 &%-D%& may be repeated up to 10 times on a command line.
3596 Only macro names up to 22 letters long can be set.
3597
3598
3599 .vitem &%-d%&<&'debug&~options'&>
3600 .oindex "&%-d%&"
3601 .cindex "debugging" "list of selectors"
3602 .cindex "debugging" "&%-d%& option"
3603 This option causes debugging information to be written to the standard
3604 error stream. It is restricted to admin users because debugging output may show
3605 database queries that contain password information. Also, the details of users'
3606 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3607 writes an error message to the standard error stream and exits with a non-zero
3608 return code.
3609
3610 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3611 standard debugging data is output. This can be reduced, or increased to include
3612 some more rarely needed information, by directly following &%-d%& with a string
3613 made up of names preceded by plus or minus characters. These add or remove sets
3614 of debugging data, respectively. For example, &%-d+filter%& adds filter
3615 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3616 no spaces are allowed in the debug setting. The available debugging categories
3617 are:
3618 .display
3619 &`acl            `& ACL interpretation
3620 &`auth           `& authenticators
3621 &`deliver        `& general delivery logic
3622 &`dns            `& DNS lookups (see also resolver)
3623 &`dnsbl          `& DNS black list (aka RBL) code
3624 &`exec           `& arguments for &[execv()]& calls
3625 &`expand         `& detailed debugging for string expansions
3626 &`filter         `& filter handling
3627 &`hints_lookup   `& hints data lookups
3628 &`host_lookup    `& all types of name-to-IP address handling
3629 &`ident          `& ident lookup
3630 &`interface      `& lists of local interfaces
3631 &`lists          `& matching things in lists
3632 &`load           `& system load checks
3633 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3634                     &<<CHAPlocalscan>>&)
3635 &`lookup         `& general lookup code and all lookups
3636 &`memory         `& memory handling
3637 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3638 &`pid            `& modifier: add pid to debug output lines
3639 &`process_info   `& setting info for the process log
3640 &`queue_run      `& queue runs
3641 &`receive        `& general message reception logic
3642 &`resolver       `& turn on the DNS resolver's debugging output
3643 &`retry          `& retry handling
3644 &`rewrite        `& address rewriting
3645 &`route          `& address routing
3646 &`timestamp      `& modifier: add timestamp to debug output lines
3647 &`tls            `& TLS logic
3648 &`transport      `& transports
3649 &`uid            `& changes of uid/gid and looking up uid/gid
3650 &`verify         `& address verification logic
3651 &`all            `& almost all of the above (see below), and also &%-v%&
3652 .endd
3653 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3654 for &`-all`&. The reason for this is that &`+all`& is something that people
3655 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3656 is included, an awful lot of output that is very rarely of interest is
3657 generated, so it now has to be explicitly requested. However, &`-all`& does
3658 turn everything off.
3659
3660 .cindex "resolver, debugging output"
3661 .cindex "DNS resolver, debugging output"
3662 The &`resolver`& option produces output only if the DNS resolver was compiled
3663 with DEBUG enabled. This is not the case in some operating systems. Also,
3664 unfortunately, debugging output from the DNS resolver is written to stdout
3665 rather than stderr.
3666
3667 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3668 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3669 However, the &`pid`& selector is forced when debugging is turned on for a
3670 daemon, which then passes it on to any re-executed Exims. Exim also
3671 automatically adds the pid to debug lines when several remote deliveries are
3672 run in parallel.
3673
3674 The &`timestamp`& selector causes the current time to be inserted at the start
3675 of all debug output lines. This can be useful when trying to track down delays
3676 in processing.
3677
3678 .cindex debugging "UTF-8 in"
3679 .cindex UTF-8 "in debug output"
3680 The &`noutf8`& selector disables the use of
3681 UTF-8 line-drawing characters to group related information.
3682 When disabled. ascii-art is used instead.
3683 Using the &`+all`& option does not set this modifier,
3684
3685 If the &%debug_print%& option is set in any driver, it produces output whenever
3686 any debugging is selected, or if &%-v%& is used.
3687
3688 .vitem &%-dd%&<&'debug&~options'&>
3689 .oindex "&%-dd%&"
3690 This option behaves exactly like &%-d%& except when used on a command that
3691 starts a daemon process. In that case, debugging is turned off for the
3692 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3693 behaviour of the daemon without creating as much output as full debugging does.
3694
3695 .vitem &%-dropcr%&
3696 .oindex "&%-dropcr%&"
3697 This is an obsolete option that is now a no-op. It used to affect the way Exim
3698 handled CR and LF characters in incoming messages. What happens now is
3699 described in section &<<SECTlineendings>>&.
3700
3701 .vitem &%-E%&
3702 .oindex "&%-E%&"
3703 .cindex "bounce message" "generating"
3704 This option specifies that an incoming message is a locally-generated delivery
3705 failure report. It is used internally by Exim when handling delivery failures
3706 and is not intended for external use. Its only effect is to stop Exim
3707 generating certain messages to the postmaster, as otherwise message cascades
3708 could occur in some situations. As part of the same option, a message id may
3709 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3710 new message contains the id, following &"R="&, as a cross-reference.
3711
3712 .vitem &%-e%&&'x'&
3713 .oindex "&%-e%&&'x'&"
3714 There are a number of Sendmail options starting with &%-oe%& which seem to be
3715 called by various programs without the leading &%o%& in the option. For
3716 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3717 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3718
3719 .vitem &%-F%&&~<&'string'&>
3720 .oindex "&%-F%&"
3721 .cindex "sender" "name"
3722 .cindex "name" "of sender"
3723 This option sets the sender's full name for use when a locally-generated
3724 message is being accepted. In the absence of this option, the user's &'gecos'&
3725 entry from the password data is used. As users are generally permitted to alter
3726 their &'gecos'& entries, no security considerations are involved. White space
3727 between &%-F%& and the <&'string'&> is optional.
3728
3729 .vitem &%-f%&&~<&'address'&>
3730 .oindex "&%-f%&"
3731 .cindex "sender" "address"
3732 .cindex "address" "sender"
3733 .cindex "trusted users"
3734 .cindex "envelope from"
3735 .cindex "envelope sender"
3736 .cindex "user" "trusted"
3737 This option sets the address of the envelope sender of a locally-generated
3738 message (also known as the return path). The option can normally be used only
3739 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3740 users to use it.
3741
3742 Processes running as root or the Exim user are always trusted. Other
3743 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3744 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3745 of a local message is set to the caller's login name at the default qualify
3746 domain.
3747
3748 There is one exception to the restriction on the use of &%-f%&: an empty sender
3749 can be specified by any user, trusted or not, to create a message that can
3750 never provoke a bounce. An empty sender can be specified either as an empty
3751 string, or as a pair of angle brackets with nothing between them, as in these
3752 examples of shell commands:
3753 .code
3754 exim -f '<>' user@domain
3755 exim -f "" user@domain
3756 .endd
3757 In addition, the use of &%-f%& is not restricted when testing a filter file
3758 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3759 &%-bv%& options.
3760
3761 Allowing untrusted users to change the sender address does not of itself make
3762 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3763 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3764 though this can be overridden by setting &%no_local_from_check%&.
3765
3766 White
3767 .cindex "&""From""& line"
3768 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3769 given as two arguments or one combined argument). The sender of a
3770 locally-generated message can also be set (when permitted) by an initial
3771 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3772 if &%-f%& is also present, it overrides &"From&~"&.
3773
3774 .vitem &%-G%&
3775 .oindex "&%-G%&"
3776 .cindex "submission fixups, suppressing (command-line)"
3777 This option is equivalent to an ACL applying:
3778 .code
3779 control = suppress_local_fixups
3780 .endd
3781 for every message received.  Note that Sendmail will complain about such
3782 bad formatting, where Exim silently just does not fix it up.  This may change
3783 in future.
3784
3785 As this affects audit information, the caller must be a trusted user to use
3786 this option.
3787
3788 .vitem &%-h%&&~<&'number'&>
3789 .oindex "&%-h%&"
3790 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3791 This option is accepted for compatibility with Sendmail, but has no effect. (In
3792 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3793 headers.)
3794
3795 .vitem &%-i%&
3796 .oindex "&%-i%&"
3797 .cindex "Solaris" "&'mail'& command"
3798 .cindex "dot" "in incoming non-SMTP message"
3799 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3800 line by itself should not terminate an incoming, non-SMTP message. I can find
3801 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3802 command in Solaris 2.4 uses it. See also &%-ti%&.
3803
3804 .vitem &%-L%&&~<&'tag'&>
3805 .oindex "&%-L%&"
3806 .cindex "syslog" "process name; set with flag"
3807 This option is equivalent to setting &%syslog_processname%& in the config
3808 file and setting &%log_file_path%& to &`syslog`&.
3809 Its use is restricted to administrators.  The configuration file has to be
3810 read and parsed, to determine access rights, before this is set and takes
3811 effect, so early configuration file errors will not honour this flag.
3812
3813 The tag should not be longer than 32 characters.
3814
3815 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3816 .oindex "&%-M%&"
3817 .cindex "forcing delivery"
3818 .cindex "delivery" "forcing attempt"
3819 .cindex "frozen messages" "forcing delivery"
3820 This option requests Exim to run a delivery attempt on each message in turn. If
3821 any of the messages are frozen, they are automatically thawed before the
3822 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3823 and &%hold_domains%& are ignored.
3824
3825 Retry
3826 .cindex "hints database" "overriding retry hints"
3827 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3828 the normal retry time has not yet been reached. This option requires the caller
3829 to be an admin user. However, there is an option called &%prod_requires_admin%&
3830 which can be set false to relax this restriction (and also the same requirement
3831 for the &%-q%&, &%-R%&, and &%-S%& options).
3832
3833 The deliveries happen synchronously, that is, the original Exim process does
3834 not terminate until all the delivery attempts have finished. No output is
3835 produced unless there is a serious error. If you want to see what is happening,
3836 use the &%-v%& option as well, or inspect Exim's main log.
3837
3838 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3839 .oindex "&%-Mar%&"
3840 .cindex "message" "adding recipients"
3841 .cindex "recipient" "adding"
3842 This option requests Exim to add the addresses to the list of recipients of the
3843 message (&"ar"& for &"add recipients"&). The first argument must be a message
3844 id, and the remaining ones must be email addresses. However, if the message is
3845 active (in the middle of a delivery attempt), it is not altered. This option
3846 can be used only by an admin user.
3847
3848 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3849         &~<&'message&~id'&>"
3850 .oindex "&%-MC%&"
3851 .cindex "SMTP" "passed connection"
3852 .cindex "SMTP" "multiple deliveries"
3853 .cindex "multiple SMTP deliveries"
3854 This option is not intended for use by external callers. It is used internally
3855 by Exim to invoke another instance of itself to deliver a waiting message using
3856 an existing SMTP connection, which is passed as the standard input. Details are
3857 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3858 must be root or the Exim user in order to use it.
3859
3860 .vitem &%-MCA%&
3861 .oindex "&%-MCA%&"
3862 This option is not intended for use by external callers. It is used internally
3863 by Exim in conjunction with the &%-MC%& option. It signifies that the
3864 connection to the remote host has been authenticated.
3865
3866 .vitem &%-MCD%&
3867 .oindex "&%-MCD%&"
3868 This option is not intended for use by external callers. It is used internally
3869 by Exim in conjunction with the &%-MC%& option. It signifies that the
3870 remote host supports the ESMTP &_DSN_& extension.
3871
3872 .vitem &%-MCd%&
3873 .oindex "&%-MCd%&"
3874 This option is not intended for use by external callers. It is used internally
3875 by Exim in conjunction with the &%-d%& option
3876 to pass on an information string on the purpose of the process.
3877
3878 .vitem &%-MCG%&&~<&'queue&~name'&>
3879 .oindex "&%-MCG%&"
3880 This option is not intended for use by external callers. It is used internally
3881 by Exim in conjunction with the &%-MC%& option. It signifies that an
3882 alternate queue is used, named by the following argument.
3883
3884 .vitem &%-MCK%&
3885 .oindex "&%-MCK%&"
3886 This option is not intended for use by external callers. It is used internally
3887 by Exim in conjunction with the &%-MC%& option. It signifies that a
3888 remote host supports the ESMTP &_CHUNKING_& extension.
3889
3890 .vitem &%-MCP%&
3891 .oindex "&%-MCP%&"
3892 This option is not intended for use by external callers. It is used internally
3893 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3894 which Exim is connected supports pipelining.
3895
3896 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3897 .oindex "&%-MCQ%&"
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option when the original delivery was
3900 started by a queue runner. It passes on the process id of the queue runner,
3901 together with the file descriptor number of an open pipe. Closure of the pipe
3902 signals the final completion of the sequence of processes that are passing
3903 messages through the same SMTP connection.
3904
3905 .new
3906 .vitem &%-MCq%&&~<&'recipient&~address'&>&~<&'size'&>
3907 .oindex "&%-MCq%&"
3908 This option is not intended for use by external callers. It is used internally
3909 by Exim to implement quota checking for local users.
3910 .wen
3911
3912 .vitem &%-MCS%&
3913 .oindex "&%-MCS%&"
3914 This option is not intended for use by external callers. It is used internally
3915 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3916 ESMTP SIZE option should be used on messages delivered down the existing
3917 connection.
3918
3919 .vitem &%-MCT%&
3920 .oindex "&%-MCT%&"
3921 This option is not intended for use by external callers. It is used internally
3922 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3923 host to which Exim is connected supports TLS encryption.
3924
3925 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3926 .oindex "&%-MCt%&"
3927 This option is not intended for use by external callers. It is used internally
3928 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3929 connection is being proxied by a parent process for handling TLS encryption.
3930 The arguments give the local address and port being proxied, and the TLS cipher.
3931
3932 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3933 .oindex "&%-Mc%&"
3934 .cindex "hints database" "not overridden by &%-Mc%&"
3935 .cindex "delivery" "manually started &-- not forced"
3936 This option requests Exim to run a delivery attempt on each message, in turn,
3937 but unlike the &%-M%& option, it does check for retry hints, and respects any
3938 that are found. This option is not very useful to external callers. It is
3939 provided mainly for internal use by Exim when it needs to re-invoke itself in
3940 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3941 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3942 respects retry times and other options such as &%hold_domains%& that are
3943 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3944 If you want to run a specific delivery as if in a queue run, you should use
3945 &%-q%& with a message id argument. A distinction between queue run deliveries
3946 and other deliveries is made in one or two places.
3947
3948 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3949 .oindex "&%-Mes%&"
3950 .cindex "message" "changing sender"
3951 .cindex "sender" "changing"
3952 This option requests Exim to change the sender address in the message to the
3953 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3954 &"edit sender"&). There must be exactly two arguments. The first argument must
3955 be a message id, and the second one an email address. However, if the message
3956 is active (in the middle of a delivery attempt), its status is not altered.
3957 This option can be used only by an admin user.
3958
3959 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3960 .oindex "&%-Mf%&"
3961 .cindex "freezing messages"
3962 .cindex "message" "manually freezing"
3963 This option requests Exim to mark each listed message as &"frozen"&. This
3964 prevents any delivery attempts taking place until the message is &"thawed"&,
3965 either manually or as a result of the &%auto_thaw%& configuration option.
3966 However, if any of the messages are active (in the middle of a delivery
3967 attempt), their status is not altered. This option can be used only by an admin
3968 user.
3969
3970 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3971 .oindex "&%-Mg%&"
3972 .cindex "giving up on messages"
3973 .cindex "message" "abandoning delivery attempts"
3974 .cindex "delivery" "abandoning further attempts"
3975 This option requests Exim to give up trying to deliver the listed messages,
3976 including any that are frozen. However, if any of the messages are active,
3977 their status is not altered. For non-bounce messages, a delivery error message
3978 is sent to the sender, containing the text &"cancelled by administrator"&.
3979 Bounce messages are just discarded. This option can be used only by an admin
3980 user.
3981
3982 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3983 .oindex "&%-MG%&"
3984 .cindex queue named
3985 .cindex "named queues" "moving messages"
3986 .cindex "queue" "moving messages"
3987 This option requests that each listed message be moved from its current
3988 queue to the given named queue.
3989 The destination queue name argument is required, but can be an empty
3990 string to define the default queue.
3991 If the messages are not currently located in the default queue,
3992 a &%-qG<name>%& option will be required to define the source queue.
3993
3994 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3995 .oindex "&%-Mmad%&"
3996 .cindex "delivery" "cancelling all"
3997 This option requests Exim to mark all the recipient addresses in the messages
3998 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3999 message is active (in the middle of a delivery attempt), its status is not
4000 altered. This option can be used only by an admin user.
4001
4002 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4003 .oindex "&%-Mmd%&"
4004 .cindex "delivery" "cancelling by address"
4005 .cindex "recipient" "removing"
4006 .cindex "removing recipients"
4007 This option requests Exim to mark the given addresses as already delivered
4008 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4009 the remaining ones must be email addresses. These are matched to recipient
4010 addresses in the message in a case-sensitive manner. If the message is active
4011 (in the middle of a delivery attempt), its status is not altered. This option
4012 can be used only by an admin user.
4013
4014 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4015 .oindex "&%-Mrm%&"
4016 .cindex "removing messages"
4017 .cindex "abandoning mail"
4018 .cindex "message" "manually discarding"
4019 This option requests Exim to remove the given messages from the queue. No
4020 bounce messages are sent; each message is simply forgotten. However, if any of
4021 the messages are active, their status is not altered. This option can be used
4022 only by an admin user or by the user who originally caused the message to be
4023 placed in the queue.
4024
4025 . .new
4026 . .vitem &%-MS%&
4027 . .oindex "&%-MS%&"
4028 . .cindex REQUIRETLS
4029 . This option is used to request REQUIRETLS processing on the message.
4030 . It is used internally by Exim in conjunction with -E when generating
4031 . a bounce message.
4032 . .wen
4033
4034 .vitem &%-Mset%&&~<&'message&~id'&>
4035 .oindex "&%-Mset%&"
4036 .cindex "testing" "string expansion"
4037 .cindex "expansion" "testing"
4038 This option is useful only in conjunction with &%-be%& (that is, when testing
4039 string expansions). Exim loads the given message from its spool before doing
4040 the test expansions, thus setting message-specific variables such as
4041 &$message_size$& and the header variables. The &$recipients$& variable is made
4042 available. This feature is provided to make it easier to test expansions that
4043 make use of these variables. However, this option can be used only by an admin
4044 user. See also &%-bem%&.
4045
4046 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4047 .oindex "&%-Mt%&"
4048 .cindex "thawing messages"
4049 .cindex "unfreezing messages"
4050 .cindex "frozen messages" "thawing"
4051 .cindex "message" "thawing frozen"
4052 This option requests Exim to &"thaw"& any of the listed messages that are
4053 &"frozen"&, so that delivery attempts can resume. However, if any of the
4054 messages are active, their status is not altered. This option can be used only
4055 by an admin user.
4056
4057 .vitem &%-Mvb%&&~<&'message&~id'&>
4058 .oindex "&%-Mvb%&"
4059 .cindex "listing" "message body"
4060 .cindex "message" "listing body of"
4061 This option causes the contents of the message body (-D) spool file to be
4062 written to the standard output. This option can be used only by an admin user.
4063
4064 .vitem &%-Mvc%&&~<&'message&~id'&>
4065 .oindex "&%-Mvc%&"
4066 .cindex "message" "listing in RFC 2822 format"
4067 .cindex "listing" "message in RFC 2822 format"
4068 This option causes a copy of the complete message (header lines plus body) to
4069 be written to the standard output in RFC 2822 format. This option can be used
4070 only by an admin user.
4071
4072 .vitem &%-Mvh%&&~<&'message&~id'&>
4073 .oindex "&%-Mvh%&"
4074 .cindex "listing" "message headers"
4075 .cindex "header lines" "listing"
4076 .cindex "message" "listing header lines"
4077 This option causes the contents of the message headers (-H) spool file to be
4078 written to the standard output. This option can be used only by an admin user.
4079
4080 .vitem &%-Mvl%&&~<&'message&~id'&>
4081 .oindex "&%-Mvl%&"
4082 .cindex "listing" "message log"
4083 .cindex "message" "listing message log"
4084 This option causes the contents of the message log spool file to be written to
4085 the standard output. This option can be used only by an admin user.
4086
4087 .vitem &%-m%&
4088 .oindex "&%-m%&"
4089 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4090 treats it that way too.
4091
4092 .vitem &%-N%&
4093 .oindex "&%-N%&"
4094 .cindex "debugging" "&%-N%& option"
4095 .cindex "debugging" "suppressing delivery"
4096 This is a debugging option that inhibits delivery of a message at the transport
4097 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4098 it just doesn't actually transport the message, but instead behaves as if it
4099 had successfully done so. However, it does not make any updates to the retry
4100 database, and the log entries for deliveries are flagged with &"*>"& rather
4101 than &"=>"&.
4102
4103 Because &%-N%& discards any message to which it applies, only root or the Exim
4104 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4105 words, an ordinary user can use it only when supplying an incoming message to
4106 which it will apply. Although transportation never fails when &%-N%& is set, an
4107 address may be deferred because of a configuration problem on a transport, or a
4108 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4109 the message, and applies to any subsequent delivery attempts that may happen
4110 for that message.
4111
4112 .vitem &%-n%&
4113 .oindex "&%-n%&"
4114 This option is interpreted by Sendmail to mean &"no aliasing"&.
4115 For normal modes of operation, it is ignored by Exim.
4116 When combined with &%-bP%& it makes the output more terse (suppresses
4117 option names, environment values and config pretty printing).
4118
4119 .vitem &%-O%&&~<&'data'&>
4120 .oindex "&%-O%&"
4121 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4122 Exim.
4123
4124 .vitem &%-oA%&&~<&'file&~name'&>
4125 .oindex "&%-oA%&"
4126 .cindex "Sendmail compatibility" "&%-oA%& option"
4127 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4128 alternative alias filename. Exim handles &%-bi%& differently; see the
4129 description above.
4130
4131 .vitem &%-oB%&&~<&'n'&>
4132 .oindex "&%-oB%&"
4133 .cindex "SMTP" "passed connection"
4134 .cindex "SMTP" "multiple deliveries"
4135 .cindex "multiple SMTP deliveries"
4136 This is a debugging option which limits the maximum number of messages that can
4137 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4138 transport. If <&'n'&> is omitted, the limit is set to 1.
4139
4140 .vitem &%-odb%&
4141 .oindex "&%-odb%&"
4142 .cindex "background delivery"
4143 .cindex "delivery" "in the background"
4144 This option applies to all modes in which Exim accepts incoming messages,
4145 including the listening daemon. It requests &"background"& delivery of such
4146 messages, which means that the accepting process automatically starts a
4147 delivery process for each message received, but does not wait for the delivery
4148 processes to finish.
4149
4150 When all the messages have been received, the reception process exits,
4151 leaving the delivery processes to finish in their own time. The standard output
4152 and error streams are closed at the start of each delivery process.
4153 This is the default action if none of the &%-od%& options are present.
4154
4155 If one of the queueing options in the configuration file
4156 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4157 overrides it if &%queue_only_override%& is set true, which is the default
4158 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4159
4160 .vitem &%-odf%&
4161 .oindex "&%-odf%&"
4162 .cindex "foreground delivery"
4163 .cindex "delivery" "in the foreground"
4164 This option requests &"foreground"& (synchronous) delivery when Exim has
4165 accepted a locally-generated message. (For the daemon it is exactly the same as
4166 &%-odb%&.) A delivery process is automatically started to deliver the message,
4167 and Exim waits for it to complete before proceeding.
4168
4169 The original Exim reception process does not finish until the delivery
4170 process for the final message has ended. The standard error stream is left open
4171 during deliveries.
4172
4173 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4174 false and one of the queueing options in the configuration file is in effect.
4175
4176 If there is a temporary delivery error during foreground delivery, the
4177 message is left in the queue for later delivery, and the original reception
4178 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4179 restricted configuration that never queues messages.
4180
4181
4182 .vitem &%-odi%&
4183 .oindex "&%-odi%&"
4184 This option is synonymous with &%-odf%&. It is provided for compatibility with
4185 Sendmail.
4186
4187 .vitem &%-odq%&
4188 .oindex "&%-odq%&"
4189 .cindex "non-immediate delivery"
4190 .cindex "delivery" "suppressing immediate"
4191 .cindex "queueing incoming messages"
4192 This option applies to all modes in which Exim accepts incoming messages,
4193 including the listening daemon. It specifies that the accepting process should
4194 not automatically start a delivery process for each message received. Messages
4195 are placed in the queue, and remain there until a subsequent queue runner
4196 process encounters them. There are several configuration options (such as
4197 &%queue_only%&) that can be used to queue incoming messages under certain
4198 conditions. This option overrides all of them and also &%-odqs%&. It always
4199 forces queueing.
4200
4201 .vitem &%-odqs%&
4202 .oindex "&%-odqs%&"
4203 .cindex "SMTP" "delaying delivery"
4204 .cindex "first pass routing"
4205 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4206 However, like &%-odb%& and &%-odi%&, this option has no effect if
4207 &%queue_only_override%& is false and one of the queueing options in the
4208 configuration file is in effect.
4209
4210 When &%-odqs%& does operate, a delivery process is started for each incoming
4211 message, in the background by default, but in the foreground if &%-odi%& is
4212 also present. The recipient addresses are routed, and local deliveries are done
4213 in the normal way. However, if any SMTP deliveries are required, they are not
4214 done at this time, so the message remains in the queue until a subsequent queue
4215 runner process encounters it. Because routing was done, Exim knows which
4216 messages are waiting for which hosts, and so a number of messages for the same
4217 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4218 configuration option has the same effect for specific domains. See also the
4219 &%-qq%& option.
4220
4221 .vitem &%-oee%&
4222 .oindex "&%-oee%&"
4223 .cindex "error" "reporting"
4224 If an error is detected while a non-SMTP message is being received (for
4225 example, a malformed address), the error is reported to the sender in a mail
4226 message.
4227
4228 .cindex "return code" "for &%-oee%&"
4229 Provided
4230 this error message is successfully sent, the Exim receiving process
4231 exits with a return code of zero. If not, the return code is 2 if the problem
4232 is that the original message has no recipients, or 1 for any other error.
4233 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4234
4235 .vitem &%-oem%&
4236 .oindex "&%-oem%&"
4237 .cindex "error" "reporting"
4238 .cindex "return code" "for &%-oem%&"
4239 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4240 return code, whether or not the error message was successfully sent.
4241 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4242
4243 .vitem &%-oep%&
4244 .oindex "&%-oep%&"
4245 .cindex "error" "reporting"
4246 If an error is detected while a non-SMTP message is being received, the
4247 error is reported by writing a message to the standard error file (stderr).
4248 .cindex "return code" "for &%-oep%&"
4249 The return code is 1 for all errors.
4250
4251 .vitem &%-oeq%&
4252 .oindex "&%-oeq%&"
4253 .cindex "error" "reporting"
4254 This option is supported for compatibility with Sendmail, but has the same
4255 effect as &%-oep%&.
4256
4257 .vitem &%-oew%&
4258 .oindex "&%-oew%&"
4259 .cindex "error" "reporting"
4260 This option is supported for compatibility with Sendmail, but has the same
4261 effect as &%-oem%&.
4262
4263 .vitem &%-oi%&
4264 .oindex "&%-oi%&"
4265 .cindex "dot" "in incoming non-SMTP message"
4266 This option, which has the same effect as &%-i%&, specifies that a dot on a
4267 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4268 single dot does terminate, though Exim does no special processing for other
4269 lines that start with a dot. This option is set by default if Exim is called as
4270 &'rmail'&. See also &%-ti%&.
4271
4272 .vitem &%-oitrue%&
4273 .oindex "&%-oitrue%&"
4274 This option is treated as synonymous with &%-oi%&.
4275
4276 .vitem &%-oMa%&&~<&'host&~address'&>
4277 .oindex "&%-oMa%&"
4278 .cindex "sender" "host address, specifying for local message"
4279 A number of options starting with &%-oM%& can be used to set values associated
4280 with remote hosts on locally-submitted messages (that is, messages not received
4281 over TCP/IP). These options can be used by any caller in conjunction with the
4282 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4283 other circumstances, they are ignored unless the caller is trusted.
4284
4285 The &%-oMa%& option sets the sender host address. This may include a port
4286 number at the end, after a full stop (period). For example:
4287 .code
4288 exim -bs -oMa 10.9.8.7.1234
4289 .endd
4290 An alternative syntax is to enclose the IP address in square brackets,
4291 followed by a colon and the port number:
4292 .code
4293 exim -bs -oMa [10.9.8.7]:1234
4294 .endd
4295 The IP address is placed in the &$sender_host_address$& variable, and the
4296 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4297 are present on the command line, the sender host IP address is taken from
4298 whichever one is last.
4299
4300 .vitem &%-oMaa%&&~<&'name'&>
4301 .oindex "&%-oMaa%&"
4302 .cindex "authentication" "name, specifying for local message"
4303 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4304 option sets the value of &$sender_host_authenticated$& (the authenticator
4305 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4306 This option can be used with &%-bh%& and &%-bs%& to set up an
4307 authenticated SMTP session without actually using the SMTP AUTH command.
4308
4309 .vitem &%-oMai%&&~<&'string'&>
4310 .oindex "&%-oMai%&"
4311 .cindex "authentication" "id, specifying for local message"
4312 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4313 option sets the value of &$authenticated_id$& (the id that was authenticated).
4314 This overrides the default value (the caller's login id, except with &%-bh%&,
4315 where there is no default) for messages from local sources. See chapter
4316 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4317
4318 .vitem &%-oMas%&&~<&'address'&>
4319 .oindex "&%-oMas%&"
4320 .cindex "authentication" "sender, specifying for local message"
4321 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4322 option sets the authenticated sender value in &$authenticated_sender$&. It
4323 overrides the sender address that is created from the caller's login id for
4324 messages from local sources, except when &%-bh%& is used, when there is no
4325 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4326 specified on a MAIL command overrides this value. See chapter
4327 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4328
4329 .vitem &%-oMi%&&~<&'interface&~address'&>
4330 .oindex "&%-oMi%&"
4331 .cindex "interface" "address, specifying for local message"
4332 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4333 option sets the IP interface address value. A port number may be included,
4334 using the same syntax as for &%-oMa%&. The interface address is placed in
4335 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4336
4337 .vitem &%-oMm%&&~<&'message&~reference'&>
4338 .oindex "&%-oMm%&"
4339 .cindex "message reference" "message reference, specifying for local message"
4340 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4341 option sets the message reference, e.g. message-id, and is logged during
4342 delivery. This is useful when some kind of audit trail is required to tie
4343 messages together. The format of the message reference is checked and will
4344 abort if the format is invalid. The option will only be accepted if exim is
4345 running in trusted mode, not as any regular user.
4346
4347 The best example of a message reference is when Exim sends a bounce message.
4348 The message reference is the message-id of the original message for which Exim
4349 is sending the bounce.
4350
4351 .vitem &%-oMr%&&~<&'protocol&~name'&>
4352 .oindex "&%-oMr%&"
4353 .cindex "protocol, specifying for local message"
4354 .vindex "&$received_protocol$&"
4355 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4356 option sets the received protocol value that is stored in
4357 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4358 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4359 SMTP protocol names (see the description of &$received_protocol$& in section
4360 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4361 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4362 be set by &%-oMr%&. Repeated use of this option is not supported.
4363
4364 .vitem &%-oMs%&&~<&'host&~name'&>
4365 .oindex "&%-oMs%&"
4366 .cindex "sender" "host name, specifying for local message"
4367 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4368 option sets the sender host name in &$sender_host_name$&. When this option is
4369 present, Exim does not attempt to look up a host name from an IP address; it
4370 uses the name it is given.
4371
4372 .vitem &%-oMt%&&~<&'ident&~string'&>
4373 .oindex "&%-oMt%&"
4374 .cindex "sender" "ident string, specifying for local message"
4375 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4376 option sets the sender ident value in &$sender_ident$&. The default setting for
4377 local callers is the login id of the calling process, except when &%-bh%& is
4378 used, when there is no default.
4379
4380 .vitem &%-om%&
4381 .oindex "&%-om%&"
4382 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4383 In Sendmail, this option means &"me too"&, indicating that the sender of a
4384 message should receive a copy of the message if the sender appears in an alias
4385 expansion. Exim always does this, so the option does nothing.
4386
4387 .vitem &%-oo%&
4388 .oindex "&%-oo%&"
4389 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4390 This option is ignored. In Sendmail it specifies &"old style headers"&,
4391 whatever that means.
4392
4393 .vitem &%-oP%&&~<&'path'&>
4394 .oindex "&%-oP%&"
4395 .cindex "pid (process id)" "of daemon"
4396 .cindex "daemon" "process id (pid)"
4397 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4398 value. The option specifies the file to which the process id of the daemon is
4399 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4400 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4401 because in those cases, the normal pid file is not used.
4402
4403 .vitem &%-oPX%&
4404 .oindex "&%-oPX%&"
4405 .cindex "pid (process id)" "of daemon"
4406 .cindex "daemon" "process id (pid)"
4407 This option is not intended for general use.
4408 The daemon uses it when terminating due to a SIGTEM, possibly in
4409 combination with &%-oP%&&~<&'path'&>.
4410 It causes the pid file to be removed.
4411
4412 .vitem &%-or%&&~<&'time'&>
4413 .oindex "&%-or%&"
4414 .cindex "timeout" "for non-SMTP input"
4415 This option sets a timeout value for incoming non-SMTP messages. If it is not
4416 set, Exim will wait forever for the standard input. The value can also be set
4417 by the &%receive_timeout%& option. The format used for specifying times is
4418 described in section &<<SECTtimeformat>>&.
4419
4420 .vitem &%-os%&&~<&'time'&>
4421 .oindex "&%-os%&"
4422 .cindex "timeout" "for SMTP input"
4423 .cindex "SMTP" "input timeout"
4424 This option sets a timeout value for incoming SMTP messages. The timeout
4425 applies to each SMTP command and block of data. The value can also be set by
4426 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4427 for specifying times is described in section &<<SECTtimeformat>>&.
4428
4429 .vitem &%-ov%&
4430 .oindex "&%-ov%&"
4431 This option has exactly the same effect as &%-v%&.
4432
4433 .vitem &%-oX%&&~<&'number&~or&~string'&>
4434 .oindex "&%-oX%&"
4435 .cindex "TCP/IP" "setting listening ports"
4436 .cindex "TCP/IP" "setting listening interfaces"
4437 .cindex "port" "receiving TCP/IP"
4438 This option is relevant only when the &%-bd%& (start listening daemon) option
4439 is also given. It controls which ports and interfaces the daemon uses. Details
4440 of the syntax, and how it interacts with configuration file options, are given
4441 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4442 file is written unless &%-oP%& is also present to specify a pid filename.
4443
4444 .vitem &%-pd%&
4445 .oindex "&%-pd%&"
4446 .cindex "Perl" "starting the interpreter"
4447 This option applies when an embedded Perl interpreter is linked with Exim (see
4448 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4449 option, forcing the starting of the interpreter to be delayed until it is
4450 needed.
4451
4452 .vitem &%-ps%&
4453 .oindex "&%-ps%&"
4454 .cindex "Perl" "starting the interpreter"
4455 This option applies when an embedded Perl interpreter is linked with Exim (see
4456 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4457 option, forcing the starting of the interpreter to occur as soon as Exim is
4458 started.
4459
4460 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4461 .oindex "&%-p%&"
4462 For compatibility with Sendmail, this option is equivalent to
4463 .display
4464 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4465 .endd
4466 It sets the incoming protocol and host name (for trusted callers). The
4467 host name and its colon can be omitted when only the protocol is to be set.
4468 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4469 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4470 or &`s`& using this option (but that does not seem a real limitation).
4471 Repeated use of this option is not supported.
4472
4473 .vitem &%-q%&
4474 .oindex "&%-q%&"
4475 .cindex "queue runner" "starting manually"
4476 This option is normally restricted to admin users. However, there is a
4477 configuration option called &%prod_requires_admin%& which can be set false to
4478 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4479 and &%-S%& options).
4480
4481 .cindex "queue runner" "description of operation"
4482 If other commandline options do not specify an action,
4483 the &%-q%& option starts one queue runner process. This scans the queue of
4484 waiting messages, and runs a delivery process for each one in turn. It waits
4485 for each delivery process to finish before starting the next one. A delivery
4486 process may not actually do any deliveries if the retry times for the addresses
4487 have not been reached. Use &%-qf%& (see below) if you want to override this.
4488
4489 If
4490 .cindex "SMTP" "passed connection"
4491 .cindex "SMTP" "multiple deliveries"
4492 .cindex "multiple SMTP deliveries"
4493 the delivery process spawns other processes to deliver other messages down
4494 passed SMTP connections, the queue runner waits for these to finish before
4495 proceeding.
4496
4497 When all the queued messages have been considered, the original queue runner
4498 process terminates. In other words, a single pass is made over the waiting
4499 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4500 this to be repeated periodically.
4501
4502 Exim processes the waiting messages in an unpredictable order. It isn't very
4503 random, but it is likely to be different each time, which is all that matters.
4504 If one particular message screws up a remote MTA, other messages to the same
4505 MTA have a chance of getting through if they get tried first.
4506
4507 It is possible to cause the messages to be processed in lexical message id
4508 order, which is essentially the order in which they arrived, by setting the
4509 &%queue_run_in_order%& option, but this is not recommended for normal use.
4510
4511 .vitem &%-q%&<&'qflags'&>
4512 The &%-q%& option may be followed by one or more flag letters that change its
4513 behaviour. They are all optional, but if more than one is present, they must
4514 appear in the correct order. Each flag is described in a separate item below.
4515
4516 .vitem &%-qq...%&
4517 .oindex "&%-qq%&"
4518 .cindex "queue" "double scanning"
4519 .cindex "queue" "routing"
4520 .cindex "routing" "whole queue before delivery"
4521 .cindex "first pass routing"
4522 .cindex "queue runner" "two phase"
4523 An option starting with &%-qq%& requests a two-stage queue run. In the first
4524 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4525 every domain. Addresses are routed, local deliveries happen, but no remote
4526 transports are run.
4527
4528 Performance will be best if the &%queue_run_in_order%& option is false.
4529 If that is so and the &%queue_fast_ramp%& option is true then
4530 in the first phase of the run,
4531 once a threshold number of messages are routed for a given host,
4532 a delivery process is forked in parallel with the rest of the scan.
4533
4534 .cindex "hints database" "remembering routing"
4535 The hints database that remembers which messages are waiting for specific hosts
4536 is updated, as if delivery to those hosts had been deferred. After this is
4537 complete, a second, normal queue scan happens, with routing and delivery taking
4538 place as normal. Messages that are routed to the same host should mostly be
4539 delivered down a single SMTP
4540 .cindex "SMTP" "passed connection"
4541 .cindex "SMTP" "multiple deliveries"
4542 .cindex "multiple SMTP deliveries"
4543 connection because of the hints that were set up during the first queue scan.
4544 This option may be useful for hosts that are connected to the Internet
4545 intermittently.
4546
4547 .vitem &%-q[q]i...%&
4548 .oindex "&%-qi%&"
4549 .cindex "queue" "initial delivery"
4550 If the &'i'& flag is present, the queue runner runs delivery processes only for
4551 those messages that haven't previously been tried. (&'i'& stands for &"initial
4552 delivery"&.) This can be helpful if you are putting messages in the queue using
4553 &%-odq%& and want a queue runner just to process the new messages.
4554
4555 .vitem &%-q[q][i]f...%&
4556 .oindex "&%-qf%&"
4557 .cindex "queue" "forcing delivery"
4558 .cindex "delivery" "forcing in queue run"
4559 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4560 message, whereas without &'f'& only those non-frozen addresses that have passed
4561 their retry times are tried.
4562
4563 .vitem &%-q[q][i]ff...%&
4564 .oindex "&%-qff%&"
4565 .cindex "frozen messages" "forcing delivery"
4566 If &'ff'& is present, a delivery attempt is forced for every message, whether
4567 frozen or not.
4568
4569 .vitem &%-q[q][i][f[f]]l%&
4570 .oindex "&%-ql%&"
4571 .cindex "queue" "local deliveries only"
4572 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4573 be done. If a message requires any remote deliveries, it remains in the queue
4574 for later delivery.
4575
4576 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4577 .oindex "&%-qG%&"
4578 .cindex queue named
4579 .cindex "named queues"  "deliver from"
4580 .cindex "queue" "delivering specific messages"
4581 If the &'G'& flag and a name is present, the queue runner operates on the
4582 queue with the given name rather than the default queue.
4583 The name should not contain a &'/'& character.
4584 For a periodic queue run (see below)
4585 append to the name a slash and a time value.
4586
4587 If other commandline options specify an action, a &'-qG<name>'& option
4588 will specify a queue to operate on.
4589 For example:
4590 .code
4591 exim -bp -qGquarantine
4592 mailq -qGquarantine
4593 exim -qGoffpeak -Rf @special.domain.example
4594 .endd
4595
4596 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4597 When scanning the queue, Exim can be made to skip over messages whose ids are
4598 lexically less than a given value by following the &%-q%& option with a
4599 starting message id. For example:
4600 .code
4601 exim -q 0t5C6f-0000c8-00
4602 .endd
4603 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4604 second message id is given, messages whose ids are lexically greater than it
4605 are also skipped. If the same id is given twice, for example,
4606 .code
4607 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4608 .endd
4609 just one delivery process is started, for that message. This differs from
4610 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4611 that it counts as a delivery from a queue run. Note that the selection
4612 mechanism does not affect the order in which the messages are scanned. There
4613 are also other ways of selecting specific sets of messages for delivery in a
4614 queue run &-- see &%-R%& and &%-S%&.
4615
4616 .vitem &%-q%&<&'qflags'&><&'time'&>
4617 .cindex "queue runner" "starting periodically"
4618 .cindex "periodic queue running"
4619 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4620 starting a queue runner process at intervals specified by the given time value
4621 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4622 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4623 single daemon process handles both functions. A common way of starting up a
4624 combined daemon at system boot time is to use a command such as
4625 .code
4626 /usr/exim/bin/exim -bd -q30m
4627 .endd
4628 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4629 process every 30 minutes.
4630
4631 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4632 pid file is written unless one is explicitly requested by the &%-oP%& option.
4633
4634 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4635 .oindex "&%-qR%&"
4636 This option is synonymous with &%-R%&. It is provided for Sendmail
4637 compatibility.
4638
4639 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4640 .oindex "&%-qS%&"
4641 This option is synonymous with &%-S%&.
4642
4643 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4644 .oindex "&%-R%&"
4645 .cindex "queue runner" "for specific recipients"
4646 .cindex "delivery" "to given domain"
4647 .cindex "domain" "delivery to"
4648 The <&'rsflags'&> may be empty, in which case the white space before the string
4649 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4650 which are the possible values for <&'rsflags'&>. White space is required if
4651 <&'rsflags'&> is not empty.
4652
4653 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4654 perform a single queue run, except that, when scanning the messages on the
4655 queue, Exim processes only those that have at least one undelivered recipient
4656 address containing the given string, which is checked in a case-independent
4657 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4658 regular expression; otherwise it is a literal string.
4659
4660 If you want to do periodic queue runs for messages with specific recipients,
4661 you can combine &%-R%& with &%-q%& and a time value. For example:
4662 .code
4663 exim -q25m -R @special.domain.example
4664 .endd
4665 This example does a queue run for messages with recipients in the given domain
4666 every 25 minutes. Any additional flags that are specified with &%-q%& are
4667 applied to each queue run.
4668
4669 Once a message is selected for delivery by this mechanism, all its addresses
4670 are processed. For the first selected message, Exim overrides any retry
4671 information and forces a delivery attempt for each undelivered address. This
4672 means that if delivery of any address in the first message is successful, any
4673 existing retry information is deleted, and so delivery attempts for that
4674 address in subsequently selected messages (which are processed without forcing)
4675 will run. However, if delivery of any address does not succeed, the retry
4676 information is updated, and in subsequently selected messages, the failing
4677 address will be skipped.
4678
4679 .cindex "frozen messages" "forcing delivery"
4680 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4681 all selected messages, not just the first; frozen messages are included when
4682 &'ff'& is present.
4683
4684 The &%-R%& option makes it straightforward to initiate delivery of all messages
4685 to a given domain after a host has been down for some time. When the SMTP
4686 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4687 effect is to run Exim with the &%-R%& option, but it can be configured to run
4688 an arbitrary command instead.
4689
4690 .vitem &%-r%&
4691 .oindex "&%-r%&"
4692 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4693
4694 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4695 .oindex "&%-S%&"
4696 .cindex "delivery" "from given sender"
4697 .cindex "queue runner" "for specific senders"
4698 This option acts like &%-R%& except that it checks the string against each
4699 message's sender instead of against the recipients. If &%-R%& is also set, both
4700 conditions must be met for a message to be selected. If either of the options
4701 has &'f'& or &'ff'& in its flags, the associated action is taken.
4702
4703 .vitem &%-Tqt%&&~<&'times'&>
4704 .oindex "&%-Tqt%&"
4705 This is an option that is exclusively for use by the Exim testing suite. It is not
4706 recognized when Exim is run normally. It allows for the setting up of explicit
4707 &"queue times"& so that various warning/retry features can be tested.
4708
4709 .vitem &%-t%&
4710 .oindex "&%-t%&"
4711 .cindex "recipient" "extracting from header lines"
4712 .cindex "&'Bcc:'& header line"
4713 .cindex "&'Cc:'& header line"
4714 .cindex "&'To:'& header line"
4715 When Exim is receiving a locally-generated, non-SMTP message on its standard
4716 input, the &%-t%& option causes the recipients of the message to be obtained
4717 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4718 from the command arguments. The addresses are extracted before any rewriting
4719 takes place and the &'Bcc:'& header line, if present, is then removed.
4720
4721 .cindex "Sendmail compatibility" "&%-t%& option"
4722 If the command has any arguments, they specify addresses to which the message
4723 is &'not'& to be delivered. That is, the argument addresses are removed from
4724 the recipients list obtained from the headers. This is compatible with Smail 3
4725 and in accordance with the documented behaviour of several versions of
4726 Sendmail, as described in man pages on a number of operating systems (e.g.
4727 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4728 argument addresses to those obtained from the headers, and the O'Reilly
4729 Sendmail book documents it that way. Exim can be made to add argument addresses
4730 instead of subtracting them by setting the option
4731 &%extract_addresses_remove_arguments%& false.
4732
4733 .cindex "&%Resent-%& header lines" "with &%-t%&"
4734 If there are any &%Resent-%& header lines in the message, Exim extracts
4735 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4736 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4737 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4738 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4739
4740 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4741 message is resent several times). The RFC also specifies that they should be
4742 added at the front of the message, and separated by &'Received:'& lines. It is
4743 not at all clear how &%-t%& should operate in the present of multiple sets,
4744 nor indeed exactly what constitutes a &"set"&.
4745 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4746 are often added at the end of the header, and if a message is resent more than
4747 once, it is common for the original set of &%Resent-%& headers to be renamed as
4748 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4749
4750 .vitem &%-ti%&
4751 .oindex "&%-ti%&"
4752 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4753 compatibility with Sendmail.
4754
4755 .vitem &%-tls-on-connect%&
4756 .oindex "&%-tls-on-connect%&"
4757 .cindex "TLS" "use without STARTTLS"
4758 .cindex "TLS" "automatic start"
4759 This option is available when Exim is compiled with TLS support. It forces all
4760 incoming SMTP connections to behave as if the incoming port is listed in the
4761 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4762 &<<CHAPTLS>>& for further details.
4763
4764
4765 .vitem &%-U%&
4766 .oindex "&%-U%&"
4767 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4768 Sendmail uses this option for &"initial message submission"&, and its
4769 documentation states that in future releases, it may complain about
4770 syntactically invalid messages rather than fixing them when this flag is not
4771 set. Exim ignores this option.
4772
4773 .vitem &%-v%&
4774 .oindex "&%-v%&"
4775 This option causes Exim to write information to the standard error stream,
4776 describing what it is doing. In particular, it shows the log lines for
4777 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4778 dialogue is shown. Some of the log lines shown may not actually be written to
4779 the log if the setting of &%log_selector%& discards them. Any relevant
4780 selectors are shown with each log line. If none are shown, the logging is
4781 unconditional.
4782
4783 .vitem &%-x%&
4784 .oindex "&%-x%&"
4785 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4786 National Language Support extended characters in the body of the mail item"&).
4787 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4788 this option.
4789
4790 .vitem &%-X%&&~<&'logfile'&>
4791 .oindex "&%-X%&"
4792 This option is interpreted by Sendmail to cause debug information to be sent
4793 to the named file.  It is ignored by Exim.
4794
4795 .vitem &%-z%&&~<&'log-line'&>
4796 .oindex "&%-z%&"
4797 This option writes its argument to Exim's logfile.
4798 Use is restricted to administrators; the intent is for operational notes.
4799 Quotes should be used to maintain a multi-word item as a single argument,
4800 under most shells.
4801 .endlist
4802
4803 .ecindex IIDclo1
4804 .ecindex IIDclo2
4805
4806
4807 . ////////////////////////////////////////////////////////////////////////////
4808 . Insert a stylized DocBook comment here, to identify the end of the command
4809 . line options. This is for the benefit of the Perl script that automatically
4810 . creates a man page for the options.
4811 . ////////////////////////////////////////////////////////////////////////////
4812
4813 .literal xml
4814 <!-- === End of command line options === -->
4815 .literal off
4816
4817
4818
4819
4820
4821 . ////////////////////////////////////////////////////////////////////////////
4822 . ////////////////////////////////////////////////////////////////////////////
4823
4824
4825 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4826          "The runtime configuration file"
4827
4828 .cindex "runtime configuration"
4829 .cindex "configuration file" "general description"
4830 .cindex "CONFIGURE_FILE"
4831 .cindex "configuration file" "errors in"
4832 .cindex "error" "in configuration file"
4833 .cindex "return code" "for bad configuration"
4834 Exim uses a single runtime configuration file that is read whenever an Exim
4835 binary is executed. Note that in normal operation, this happens frequently,
4836 because Exim is designed to operate in a distributed manner, without central
4837 control.
4838
4839 If a syntax error is detected while reading the configuration file, Exim
4840 writes a message on the standard error, and exits with a non-zero return code.
4841 The message is also written to the panic log. &*Note*&: Only simple syntax
4842 errors can be detected at this time. The values of any expanded options are
4843 not checked until the expansion happens, even when the expansion does not
4844 actually alter the string.
4845
4846 The name of the configuration file is compiled into the binary for security
4847 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4848 most configurations, this specifies a single file. However, it is permitted to
4849 give a colon-separated list of filenames, in which case Exim uses the first
4850 existing file in the list.
4851
4852 .cindex "EXIM_USER"
4853 .cindex "EXIM_GROUP"
4854 .cindex "CONFIGURE_OWNER"
4855 .cindex "CONFIGURE_GROUP"
4856 .cindex "configuration file" "ownership"
4857 .cindex "ownership" "configuration file"
4858 The runtime configuration file must be owned by root or by the user that is
4859 specified at compile time by the CONFIGURE_OWNER option (if set). The
4860 configuration file must not be world-writeable, or group-writeable unless its
4861 group is the root group or the one specified at compile time by the
4862 CONFIGURE_GROUP option.
4863
4864 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4865 to root, anybody who is able to edit the runtime configuration file has an
4866 easy way to run commands as root. If you specify a user or group in the
4867 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4868 who are members of that group will trivially be able to obtain root privileges.
4869
4870 Up to Exim version 4.72, the runtime configuration file was also permitted to
4871 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4872 since it offered a simple privilege escalation for any attacker who managed to
4873 compromise the Exim user account.
4874
4875 A default configuration file, which will work correctly in simple situations,
4876 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4877 defines just one filename, the installation process copies the default
4878 configuration to a new file of that name if it did not previously exist. If
4879 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4880 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4881 configuration.
4882
4883
4884
4885 .section "Using a different configuration file" "SECID40"
4886 .cindex "configuration file" "alternate"
4887 A one-off alternate configuration can be specified by the &%-C%& command line
4888 option, which may specify a single file or a list of files. However, when
4889 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4890 unless the argument for &%-C%& is identical to the built-in value from
4891 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4892 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4893 is useful mainly for checking the syntax of configuration files before
4894 installing them. No owner or group checks are done on a configuration file
4895 specified by &%-C%&, if root privilege has been dropped.
4896
4897 Even the Exim user is not trusted to specify an arbitrary configuration file
4898 with the &%-C%& option to be used with root privileges, unless that file is
4899 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4900 testing a configuration using &%-C%& right through message reception and
4901 delivery, even if the caller is root. The reception works, but by that time,
4902 Exim is running as the Exim user, so when it re-execs to regain privilege for
4903 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4904 can test reception and delivery using two separate commands (one to put a
4905 message in the queue, using &%-odq%&, and another to do the delivery, using
4906 &%-M%&).
4907
4908 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4909 prefix string with which any file named in a &%-C%& command line option must
4910 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4911 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4912 filename can be used with &%-C%&.
4913
4914 One-off changes to a configuration can be specified by the &%-D%& command line
4915 option, which defines and overrides values for macros used inside the
4916 configuration file. However, like &%-C%&, the use of this option by a
4917 non-privileged user causes Exim to discard its root privilege.
4918 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4919 completely disabled, and its use causes an immediate error exit.
4920
4921 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4922 to declare certain macro names trusted, such that root privilege will not
4923 necessarily be discarded.
4924 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4925 considered safe and, if &%-D%& only supplies macros from this list, and the
4926 values are acceptable, then Exim will not give up root privilege if the caller
4927 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4928 transition mechanism and is expected to be removed in the future.  Acceptable
4929 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4930
4931 Some sites may wish to use the same Exim binary on different machines that
4932 share a file system, but to use different configuration files on each machine.
4933 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4934 looks for a file whose name is the configuration filename followed by a dot
4935 and the machine's node name, as obtained from the &[uname()]& function. If this
4936 file does not exist, the standard name is tried. This processing occurs for
4937 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4938
4939 In some esoteric situations different versions of Exim may be run under
4940 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4941 help with this. See the comments in &_src/EDITME_& for details.
4942
4943
4944
4945 .section "Configuration file format" "SECTconffilfor"
4946 .cindex "configuration file" "format of"
4947 .cindex "format" "configuration file"
4948 Exim's configuration file is divided into a number of different parts. General
4949 option settings must always appear at the start of the file. The other parts
4950 are all optional, and may appear in any order. Each part other than the first
4951 is introduced by the word &"begin"& followed by at least one literal
4952 space, and the name of the part. The optional parts are:
4953
4954 .ilist
4955 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4956 &<<CHAPACL>>&).
4957 .next
4958 .cindex "AUTH" "configuration"
4959 &'authenticators'&: Configuration settings for the authenticator drivers. These
4960 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4961 .next
4962 &'routers'&: Configuration settings for the router drivers. Routers process
4963 addresses and determine how the message is to be delivered (see chapters
4964 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4965 .next
4966 &'transports'&: Configuration settings for the transport drivers. Transports
4967 define mechanisms for copying messages to destinations (see chapters
4968 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4969 .next
4970 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4971 If there is no retry section, or if it is empty (that is, no retry rules are
4972 defined), Exim will not retry deliveries. In this situation, temporary errors
4973 are treated the same as permanent errors. Retry rules are discussed in chapter
4974 &<<CHAPretry>>&.
4975 .next
4976 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4977 when new addresses are generated during delivery. Rewriting is discussed in
4978 chapter &<<CHAPrewrite>>&.
4979 .next
4980 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4981 want to use this feature, you must set
4982 .code
4983 LOCAL_SCAN_HAS_OPTIONS=yes
4984 .endd
4985 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4986 facility are given in chapter &<<CHAPlocalscan>>&.
4987 .endlist
4988
4989 .cindex "configuration file" "leading white space in"
4990 .cindex "configuration file" "trailing white space in"
4991 .cindex "white space" "in configuration file"
4992 Leading and trailing white space in configuration lines is always ignored.
4993
4994 Blank lines in the file, and lines starting with a # character (ignoring
4995 leading white space) are treated as comments and are ignored. &*Note*&: A
4996 # character other than at the beginning of a line is not treated specially,
4997 and does not introduce a comment.
4998
4999 Any non-comment line can be continued by ending it with a backslash. Note that
5000 the general rule for white space means that trailing white space after the
5001 backslash and leading white space at the start of continuation
5002 lines is ignored. Comment lines beginning with # (but not empty lines) may
5003 appear in the middle of a sequence of continuation lines.
5004
5005 A convenient way to create a configuration file is to start from the
5006 default, which is supplied in &_src/configure.default_&, and add, delete, or
5007 change settings as required.
5008
5009 The ACLs, retry rules, and rewriting rules have their own syntax which is
5010 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5011 respectively. The other parts of the configuration file have some syntactic
5012 items in common, and these are described below, from section &<<SECTcos>>&
5013 onwards. Before that, the inclusion, macro, and conditional facilities are
5014 described.
5015
5016
5017
5018 .section "File inclusions in the configuration file" "SECID41"
5019 .cindex "inclusions in configuration file"
5020 .cindex "configuration file" "including other files"
5021 .cindex "&`.include`& in configuration file"
5022 .cindex "&`.include_if_exists`& in configuration file"
5023 You can include other files inside Exim's runtime configuration file by
5024 using this syntax:
5025 .display
5026 &`.include`& <&'filename'&>
5027 &`.include_if_exists`& <&'filename'&>
5028 .endd
5029 on a line by itself. Double quotes round the filename are optional. If you use
5030 the first form, a configuration error occurs if the file does not exist; the
5031 second form does nothing for non-existent files.
5032 The first form allows a relative name. It is resolved relative to
5033 the directory of the including file. For the second form an absolute filename
5034 is required.
5035
5036 Includes may be nested to any depth, but remember that Exim reads its
5037 configuration file often, so it is a good idea to keep them to a minimum.
5038 If you change the contents of an included file, you must HUP the daemon,
5039 because an included file is read only when the configuration itself is read.
5040
5041 The processing of inclusions happens early, at a physical line level, so, like
5042 comment lines, an inclusion can be used in the middle of an option setting,
5043 for example:
5044 .code
5045 hosts_lookup = a.b.c \
5046                .include /some/file
5047 .endd
5048 Include processing happens after macro processing (see below). Its effect is to
5049 process the lines of the included file as if they occurred inline where the
5050 inclusion appears.
5051
5052
5053
5054 .section "Macros in the configuration file" "SECTmacrodefs"
5055 .cindex "macro" "description of"
5056 .cindex "configuration file" "macros"
5057 If a line in the main part of the configuration (that is, before the first
5058 &"begin"& line) begins with an upper case letter, it is taken as a macro
5059 definition, and must be of the form
5060 .display
5061 <&'name'&> = <&'rest of line'&>
5062 .endd
5063 The name must consist of letters, digits, and underscores, and need not all be
5064 in upper case, though that is recommended. The rest of the line, including any
5065 continuations, is the replacement text, and has leading and trailing white
5066 space removed. Quotes are not removed. The replacement text can never end with
5067 a backslash character, but this doesn't seem to be a serious limitation.
5068
5069 Macros may also be defined between router, transport, authenticator, or ACL
5070 definitions. They may not, however, be defined within an individual driver or
5071 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5072
5073 .section "Macro substitution" "SECID42"
5074 Once a macro is defined, all subsequent lines in the file (and any included
5075 files) are scanned for the macro name; if there are several macros, the line is
5076 scanned for each, in turn, in the order in which the macros are defined. The
5077 replacement text is not re-scanned for the current macro, though it is scanned
5078 for subsequently defined macros. For this reason, a macro name may not contain
5079 the name of a previously defined macro as a substring. You could, for example,
5080 define
5081 .display
5082 &`ABCD_XYZ = `&<&'something'&>
5083 &`ABCD = `&<&'something else'&>
5084 .endd
5085 but putting the definitions in the opposite order would provoke a configuration
5086 error. Macro expansion is applied to individual physical lines from the file,
5087 before checking for line continuation or file inclusion (see above). If a line
5088 consists solely of a macro name, and the expansion of the macro is empty, the
5089 line is ignored. A macro at the start of a line may turn the line into a
5090 comment line or a &`.include`& line.
5091
5092
5093 .section "Redefining macros" "SECID43"
5094 Once defined, the value of a macro can be redefined later in the configuration
5095 (or in an included file). Redefinition is specified by using &'=='& instead of
5096 &'='&. For example:
5097 .code
5098 MAC =  initial value
5099 ...
5100 MAC == updated value
5101 .endd
5102 Redefinition does not alter the order in which the macros are applied to the
5103 subsequent lines of the configuration file. It is still the same order in which
5104 the macros were originally defined. All that changes is the macro's value.
5105 Redefinition makes it possible to accumulate values. For example:
5106 .code
5107 MAC =  initial value
5108 ...
5109 MAC == MAC and something added
5110 .endd
5111 This can be helpful in situations where the configuration file is built
5112 from a number of other files.
5113
5114 .section "Overriding macro values" "SECID44"
5115 The values set for macros in the configuration file can be overridden by the
5116 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5117 used, unless called by root or the Exim user. A definition on the command line
5118 using the &%-D%& option causes all definitions and redefinitions within the
5119 file to be ignored.
5120
5121
5122
5123 .section "Example of macro usage" "SECID45"
5124 As an example of macro usage, consider a configuration where aliases are looked
5125 up in a MySQL database. It helps to keep the file less cluttered if long
5126 strings such as SQL statements are defined separately as macros, for example:
5127 .code
5128 ALIAS_QUERY = select mailbox from user where \
5129               login='${quote_mysql:$local_part}';
5130 .endd
5131 This can then be used in a &(redirect)& router setting like this:
5132 .code
5133 data = ${lookup mysql{ALIAS_QUERY}}
5134 .endd
5135 In earlier versions of Exim macros were sometimes used for domain, host, or
5136 address lists. In Exim 4 these are handled better by named lists &-- see
5137 section &<<SECTnamedlists>>&.
5138
5139
5140 .section "Builtin macros" "SECTbuiltinmacros"
5141 Exim defines some macros depending on facilities available, which may
5142 differ due to build-time definitions and from one release to another.
5143 All of these macros start with an underscore.
5144 They can be used to conditionally include parts of a configuration
5145 (see below).
5146
5147 The following classes of macros are defined:
5148 .display
5149 &` _HAVE_*                    `&  build-time defines
5150 &` _DRIVER_ROUTER_*           `&  router drivers
5151 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5152 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5153 &` _LOG_*                     `&  log_selector values
5154 &` _OPT_MAIN_*                `&  main config options
5155 &` _OPT_ROUTERS_*             `&  generic router options
5156 &` _OPT_TRANSPORTS_*          `&  generic transport options
5157 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5158 &` _OPT_ROUTER_*_*            `&  private router options
5159 &` _OPT_TRANSPORT_*_*         `&  private transport options
5160 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5161 .endd
5162
5163 Use an &"exim -bP macros"& command to get the list of macros.
5164
5165
5166 .section "Conditional skips in the configuration file" "SECID46"
5167 .cindex "configuration file" "conditional skips"
5168 .cindex "&`.ifdef`&"
5169 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5170 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5171 portions of the configuration file. The processing happens whenever the file is
5172 read (that is, when an Exim binary starts to run).
5173
5174 The implementation is very simple. Instances of the first four directives must
5175 be followed by text that includes the names of one or macros. The condition
5176 that is tested is whether or not any macro substitution has taken place in the
5177 line. Thus:
5178 .code
5179 .ifdef AAA
5180 message_size_limit = 50M
5181 .else
5182 message_size_limit = 100M
5183 .endif
5184 .endd
5185 sets a message size limit of 50M if the macro &`AAA`& is defined
5186 (or &`A`& or &`AA`&), and 100M
5187 otherwise. If there is more than one macro named on the line, the condition
5188 is true if any of them are defined. That is, it is an &"or"& condition. To
5189 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5190
5191 Although you can use a macro expansion to generate one of these directives,
5192 it is not very useful, because the condition &"there was a macro substitution
5193 in this line"& will always be true.
5194
5195 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5196 to clarify complicated nestings.
5197
5198
5199
5200 .section "Common option syntax" "SECTcos"
5201 .cindex "common option syntax"
5202 .cindex "syntax of common options"
5203 .cindex "configuration file" "common option syntax"
5204 For the main set of options, driver options, and &[local_scan()]& options,
5205 each setting is on a line by itself, and starts with a name consisting of
5206 lower-case letters and underscores. Many options require a data value, and in
5207 these cases the name must be followed by an equals sign (with optional white
5208 space) and then the value. For example:
5209 .code
5210 qualify_domain = mydomain.example.com
5211 .endd
5212 .cindex "hiding configuration option values"
5213 .cindex "configuration options" "hiding value of"
5214 .cindex "options" "hiding value of"
5215 Some option settings may contain sensitive data, for example, passwords for
5216 accessing databases. To stop non-admin users from using the &%-bP%& command
5217 line option to read these values, you can precede the option settings with the
5218 word &"hide"&. For example:
5219 .code
5220 hide mysql_servers = localhost/users/admin/secret-password
5221 .endd
5222 For non-admin users, such options are displayed like this:
5223 .code
5224 mysql_servers = <value not displayable>
5225 .endd
5226 If &"hide"& is used on a driver option, it hides the value of that option on
5227 all instances of the same driver.
5228
5229 The following sections describe the syntax used for the different data types
5230 that are found in option settings.
5231
5232
5233 .section "Boolean options" "SECID47"
5234 .cindex "format" "boolean"
5235 .cindex "boolean configuration values"
5236 .oindex "&%no_%&&'xxx'&"
5237 .oindex "&%not_%&&'xxx'&"
5238 Options whose type is given as boolean are on/off switches. There are two
5239 different ways of specifying such options: with and without a data value. If
5240 the option name is specified on its own without data, the switch is turned on;
5241 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5242 boolean options may be followed by an equals sign and one of the words
5243 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5244 the following two settings have exactly the same effect:
5245 .code
5246 queue_only
5247 queue_only = true
5248 .endd
5249 The following two lines also have the same (opposite) effect:
5250 .code
5251 no_queue_only
5252 queue_only = false
5253 .endd
5254 You can use whichever syntax you prefer.
5255
5256
5257
5258
5259 .section "Integer values" "SECID48"
5260 .cindex "integer configuration values"
5261 .cindex "format" "integer"
5262 If an option's type is given as &"integer"&, the value can be given in decimal,
5263 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5264 number is assumed. Otherwise, it is treated as an octal number unless it starts
5265 with the characters &"0x"&, in which case the remainder is interpreted as a
5266 hexadecimal number.
5267
5268 If an integer value is followed by the letter K, it is multiplied by 1024; if
5269 it is followed by the letter M, it is multiplied by 1024x1024;
5270 if by the letter G, 1024x1024x1024.
5271 When the values
5272 of integer option settings are output, values which are an exact multiple of
5273 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5274 and M. The printing style is independent of the actual input format that was
5275 used.
5276
5277
5278 .section "Octal integer values" "SECID49"
5279 .cindex "integer format"
5280 .cindex "format" "octal integer"
5281 If an option's type is given as &"octal integer"&, its value is always
5282 interpreted as an octal number, whether or not it starts with the digit zero.
5283 Such options are always output in octal.
5284
5285
5286 .section "Fixed point numbers" "SECID50"
5287 .cindex "fixed point configuration values"
5288 .cindex "format" "fixed point"
5289 If an option's type is given as &"fixed-point"&, its value must be a decimal
5290 integer, optionally followed by a decimal point and up to three further digits.
5291
5292
5293
5294 .section "Time intervals" "SECTtimeformat"
5295 .cindex "time interval" "specifying in configuration"
5296 .cindex "format" "time interval"
5297 A time interval is specified as a sequence of numbers, each followed by one of
5298 the following letters, with no intervening white space:
5299
5300 .table2 30pt
5301 .irow &%s%& seconds
5302 .irow &%m%& minutes
5303 .irow &%h%& hours
5304 .irow &%d%& days
5305 .irow &%w%& weeks
5306 .endtable
5307
5308 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5309 intervals are output in the same format. Exim does not restrict the values; it
5310 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5311
5312
5313
5314 .section "String values" "SECTstrings"
5315 .cindex "string" "format of configuration values"
5316 .cindex "format" "string"
5317 If an option's type is specified as &"string"&, the value can be specified with
5318 or without double-quotes. If it does not start with a double-quote, the value
5319 consists of the remainder of the line plus any continuation lines, starting at
5320 the first character after any leading white space, with trailing white space
5321 removed, and with no interpretation of the characters in the string. Because
5322 Exim removes comment lines (those beginning with #) at an early stage, they can
5323 appear in the middle of a multi-line string. The following two settings are
5324 therefore equivalent:
5325 .code
5326 trusted_users = uucp:mail
5327 trusted_users = uucp:\
5328                 # This comment line is ignored
5329                 mail
5330 .endd
5331 .cindex "string" "quoted"
5332 .cindex "escape characters in quoted strings"
5333 If a string does start with a double-quote, it must end with a closing
5334 double-quote, and any backslash characters other than those used for line
5335 continuation are interpreted as escape characters, as follows:
5336
5337 .table2 100pt
5338 .irow &`\\`&                     "single backslash"
5339 .irow &`\n`&                     "newline"
5340 .irow &`\r`&                     "carriage return"
5341 .irow &`\t`&                     "tab"
5342 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5343 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5344                                    character"
5345 .endtable
5346
5347 If a backslash is followed by some other character, including a double-quote
5348 character, that character replaces the pair.
5349
5350 Quoting is necessary only if you want to make use of the backslash escapes to
5351 insert special characters, or if you need to specify a value with leading or
5352 trailing spaces. These cases are rare, so quoting is almost never needed in
5353 current versions of Exim. In versions of Exim before 3.14, quoting was required
5354 in order to continue lines, so you may come across older configuration files
5355 and examples that apparently quote unnecessarily.
5356
5357
5358 .section "Expanded strings" "SECID51"
5359 .cindex "expansion" "definition of"
5360 Some strings in the configuration file are subjected to &'string expansion'&,
5361 by which means various parts of the string may be changed according to the
5362 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5363 is as just described; in particular, the handling of backslashes in quoted
5364 strings is done as part of the input process, before expansion takes place.
5365 However, backslash is also an escape character for the expander, so any
5366 backslashes that are required for that reason must be doubled if they are
5367 within a quoted configuration string.
5368
5369
5370 .section "User and group names" "SECID52"
5371 .cindex "user name" "format of"
5372 .cindex "format" "user name"
5373 .cindex "groups" "name format"
5374 .cindex "format" "group name"
5375 User and group names are specified as strings, using the syntax described
5376 above, but the strings are interpreted specially. A user or group name must
5377 either consist entirely of digits, or be a name that can be looked up using the
5378 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5379
5380
5381 .section "List construction" "SECTlistconstruct"
5382 .cindex "list" "syntax of in configuration"
5383 .cindex "format" "list item in configuration"
5384 .cindex "string" "list, definition of"
5385 The data for some configuration options is a list of items, with colon as the
5386 default separator. Many of these options are shown with type &"string list"& in
5387 the descriptions later in this document. Others are listed as &"domain list"&,
5388 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5389 are all the same; however, those other than &"string list"& are subject to
5390 particular kinds of interpretation, as described in chapter
5391 &<<CHAPdomhosaddlists>>&.
5392
5393 In all these cases, the entire list is treated as a single string as far as the
5394 input syntax is concerned. The &%trusted_users%& setting in section
5395 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5396 in a list, it must be entered as two colons. Leading and trailing white space
5397 on each item in a list is ignored. This makes it possible to include items that
5398 start with a colon, and in particular, certain forms of IPv6 address. For
5399 example, the list
5400 .code
5401 local_interfaces = 127.0.0.1 : ::::1
5402 .endd
5403 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5404
5405 &*Note*&: Although leading and trailing white space is ignored in individual
5406 list items, it is not ignored when parsing the list. The space after the first
5407 colon in the example above is necessary. If it were not there, the list would
5408 be interpreted as the two items 127.0.0.1:: and 1.
5409
5410 .section "Changing list separators" "SECTlistsepchange"
5411 .cindex "list separator" "changing"
5412 .cindex "IPv6" "addresses in lists"
5413 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5414 introduced to allow the separator character to be changed. If a list begins
5415 with a left angle bracket, followed by any punctuation character, that
5416 character is used instead of colon as the list separator. For example, the list
5417 above can be rewritten to use a semicolon separator like this:
5418 .code
5419 local_interfaces = <; 127.0.0.1 ; ::1
5420 .endd
5421 This facility applies to all lists, with the exception of the list in
5422 &%log_file_path%&. It is recommended that the use of non-colon separators be
5423 confined to circumstances where they really are needed.
5424
5425 .cindex "list separator" "newline as"
5426 .cindex "newline" "as list separator"
5427 It is also possible to use newline and other control characters (those with
5428 code values less than 32, plus DEL) as separators in lists. Such separators
5429 must be provided literally at the time the list is processed. For options that
5430 are string-expanded, you can write the separator using a normal escape
5431 sequence. This will be processed by the expander before the string is
5432 interpreted as a list. For example, if a newline-separated list of domains is
5433 generated by a lookup, you can process it directly by a line such as this:
5434 .code
5435 domains = <\n ${lookup mysql{.....}}
5436 .endd
5437 This avoids having to change the list separator in such data. You are unlikely
5438 to want to use a control character as a separator in an option that is not
5439 expanded, because the value is literal text. However, it can be done by giving
5440 the value in quotes. For example:
5441 .code
5442 local_interfaces = "<\n 127.0.0.1 \n ::1"
5443 .endd
5444 Unlike printing character separators, which can be included in list items by
5445 doubling, it is not possible to include a control character as data when it is
5446 set as the separator. Two such characters in succession are interpreted as
5447 enclosing an empty list item.
5448
5449
5450
5451 .section "Empty items in lists" "SECTempitelis"
5452 .cindex "list" "empty item in"
5453 An empty item at the end of a list is always ignored. In other words, trailing
5454 separator characters are ignored. Thus, the list in
5455 .code
5456 senders = user@domain :
5457 .endd
5458 contains only a single item. If you want to include an empty string as one item
5459 in a list, it must not be the last item. For example, this list contains three
5460 items, the second of which is empty:
5461 .code
5462 senders = user1@domain : : user2@domain
5463 .endd
5464 &*Note*&: There must be white space between the two colons, as otherwise they
5465 are interpreted as representing a single colon data character (and the list
5466 would then contain just one item). If you want to specify a list that contains
5467 just one, empty item, you can do it as in this example:
5468 .code
5469 senders = :
5470 .endd
5471 In this case, the first item is empty, and the second is discarded because it
5472 is at the end of the list.
5473
5474
5475
5476
5477 .section "Format of driver configurations" "SECTfordricon"
5478 .cindex "drivers" "configuration format"
5479 There are separate parts in the configuration for defining routers, transports,
5480 and authenticators. In each part, you are defining a number of driver
5481 instances, each with its own set of options. Each driver instance is defined by
5482 a sequence of lines like this:
5483 .display
5484 <&'instance name'&>:
5485   <&'option'&>
5486   ...
5487   <&'option'&>
5488 .endd
5489 In the following example, the instance name is &(localuser)&, and it is
5490 followed by three options settings:
5491 .code
5492 localuser:
5493   driver = accept
5494   check_local_user
5495   transport = local_delivery
5496 .endd
5497 For each driver instance, you specify which Exim code module it uses &-- by the
5498 setting of the &%driver%& option &-- and (optionally) some configuration
5499 settings. For example, in the case of transports, if you want a transport to
5500 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5501 a local file you would use the &(appendfile)& driver. Each of the drivers is
5502 described in detail in its own separate chapter later in this manual.
5503
5504 You can have several routers, transports, or authenticators that are based on
5505 the same underlying driver (each must have a different instance name).
5506
5507 The order in which routers are defined is important, because addresses are
5508 passed to individual routers one by one, in order. The order in which
5509 transports are defined does not matter at all. The order in which
5510 authenticators are defined is used only when Exim, as a client, is searching
5511 them to find one that matches an authentication mechanism offered by the
5512 server.
5513
5514 .cindex "generic options"
5515 .cindex "options" "generic &-- definition of"
5516 Within a driver instance definition, there are two kinds of option: &'generic'&
5517 and &'private'&. The generic options are those that apply to all drivers of the
5518 same type (that is, all routers, all transports or all authenticators). The
5519 &%driver%& option is a generic option that must appear in every definition.
5520 .cindex "private options"
5521 The private options are special for each driver, and none need appear, because
5522 they all have default values.
5523
5524 The options may appear in any order, except that the &%driver%& option must
5525 precede any private options, since these depend on the particular driver. For
5526 this reason, it is recommended that &%driver%& always be the first option.
5527
5528 Driver instance names, which are used for reference in log entries and
5529 elsewhere, can be any sequence of letters, digits, and underscores (starting
5530 with a letter) and must be unique among drivers of the same type. A router and
5531 a transport (for example) can each have the same name, but no two router
5532 instances can have the same name. The name of a driver instance should not be
5533 confused with the name of the underlying driver module. For example, the
5534 configuration lines:
5535 .code
5536 remote_smtp:
5537   driver = smtp
5538 .endd
5539 create an instance of the &(smtp)& transport driver whose name is
5540 &(remote_smtp)&. The same driver code can be used more than once, with
5541 different instance names and different option settings each time. A second
5542 instance of the &(smtp)& transport, with different options, might be defined
5543 thus:
5544 .code
5545 special_smtp:
5546   driver = smtp
5547   port = 1234
5548   command_timeout = 10s
5549 .endd
5550 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5551 these transport instances from routers, and these names would appear in log
5552 lines.
5553
5554 Comment lines may be present in the middle of driver specifications. The full
5555 list of option settings for any particular driver instance, including all the
5556 defaulted values, can be extracted by making use of the &%-bP%& command line
5557 option.
5558
5559
5560
5561
5562
5563
5564 . ////////////////////////////////////////////////////////////////////////////
5565 . ////////////////////////////////////////////////////////////////////////////
5566
5567 .chapter "The default configuration file" "CHAPdefconfil"
5568 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5569 .cindex "default" "configuration file &""walk through""&"
5570 The default configuration file supplied with Exim as &_src/configure.default_&
5571 is sufficient for a host with simple mail requirements. As an introduction to
5572 the way Exim is configured, this chapter &"walks through"& the default
5573 configuration, giving brief explanations of the settings. Detailed descriptions
5574 of the options are given in subsequent chapters. The default configuration file
5575 itself contains extensive comments about ways you might want to modify the
5576 initial settings. However, note that there are many options that are not
5577 mentioned at all in the default configuration.
5578
5579
5580
5581 .section "Macros" "SECTdefconfmacros"
5582 All macros should be defined before any options.
5583
5584 One macro is specified, but commented out, in the default configuration:
5585 .code
5586 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5587 .endd
5588 If all off-site mail is expected to be delivered to a "smarthost", then set the
5589 hostname here and uncomment the macro.  This will affect which router is used
5590 later on.  If this is left commented out, then Exim will perform direct-to-MX
5591 deliveries using a &(dnslookup)& router.
5592
5593 In addition to macros defined here, Exim includes a number of built-in macros
5594 to enable configuration to be guarded by a binary built with support for a
5595 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5596
5597
5598 .section "Main configuration settings" "SECTdefconfmain"
5599 The main (global) configuration option settings section must always come first
5600 in the file, after the macros.
5601 The first thing you'll see in the file, after some initial comments, is the line
5602 .code
5603 # primary_hostname =
5604 .endd
5605 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5606 to know the official, fully qualified name of your host, and this is where you
5607 can specify it. However, in most cases you do not need to set this option. When
5608 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5609
5610 The first three non-comment configuration lines are as follows:
5611 .code
5612 domainlist local_domains    = @
5613 domainlist relay_to_domains =
5614 hostlist   relay_from_hosts = 127.0.0.1
5615 .endd
5616 These are not, in fact, option settings. They are definitions of two named
5617 domain lists and one named host list. Exim allows you to give names to lists of
5618 domains, hosts, and email addresses, in order to make it easier to manage the
5619 configuration file (see section &<<SECTnamedlists>>&).
5620
5621 The first line defines a domain list called &'local_domains'&; this is used
5622 later in the configuration to identify domains that are to be delivered
5623 on the local host.
5624
5625 .cindex "@ in a domain list"
5626 There is just one item in this list, the string &"@"&. This is a special form
5627 of entry which means &"the name of the local host"&. Thus, if the local host is
5628 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5629 be delivered locally. Because the local host's name is referenced indirectly,
5630 the same configuration file can be used on different hosts.
5631
5632 The second line defines a domain list called &'relay_to_domains'&, but the
5633 list itself is empty. Later in the configuration we will come to the part that
5634 controls mail relaying through the local host; it allows relaying to any
5635 domains in this list. By default, therefore, no relaying on the basis of a mail
5636 domain is permitted.
5637
5638 The third line defines a host list called &'relay_from_hosts'&. This list is
5639 used later in the configuration to permit relaying from any host or IP address
5640 that matches the list. The default contains just the IP address of the IPv4
5641 loopback interface, which means that processes on the local host are able to
5642 submit mail for relaying by sending it over TCP/IP to that interface. No other
5643 hosts are permitted to submit messages for relaying.
5644
5645 Just to be sure there's no misunderstanding: at this point in the configuration
5646 we aren't actually setting up any controls. We are just defining some domains
5647 and hosts that will be used in the controls that are specified later.
5648
5649 The next two configuration lines are genuine option settings:
5650 .code
5651 acl_smtp_rcpt = acl_check_rcpt
5652 acl_smtp_data = acl_check_data
5653 .endd
5654 These options specify &'Access Control Lists'& (ACLs) that are to be used
5655 during an incoming SMTP session for every recipient of a message (every RCPT
5656 command), and after the contents of the message have been received,
5657 respectively. The names of the lists are &'acl_check_rcpt'& and
5658 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5659 section of the configuration. The RCPT ACL controls which recipients are
5660 accepted for an incoming message &-- if a configuration does not provide an ACL
5661 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5662 contents of a message to be checked.
5663
5664 Two commented-out option settings are next:
5665 .code
5666 # av_scanner = clamd:/tmp/clamd
5667 # spamd_address = 127.0.0.1 783
5668 .endd
5669 These are example settings that can be used when Exim is compiled with the
5670 content-scanning extension. The first specifies the interface to the virus
5671 scanner, and the second specifies the interface to SpamAssassin. Further
5672 details are given in chapter &<<CHAPexiscan>>&.
5673
5674 Three more commented-out option settings follow:
5675 .code
5676 # tls_advertise_hosts = *
5677 # tls_certificate = /etc/ssl/exim.crt
5678 # tls_privatekey = /etc/ssl/exim.pem
5679 .endd
5680 These are example settings that can be used when Exim is compiled with
5681 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5682 first one specifies the list of clients that are allowed to use TLS when
5683 connecting to this server; in this case, the wildcard means all clients. The
5684 other options specify where Exim should find its TLS certificate and private
5685 key, which together prove the server's identity to any clients that connect.
5686 More details are given in chapter &<<CHAPTLS>>&.
5687
5688 Another two commented-out option settings follow:
5689 .code
5690 # daemon_smtp_ports = 25 : 465 : 587
5691 # tls_on_connect_ports = 465
5692 .endd
5693 .cindex "port" "465 and 587"
5694 .cindex "port" "for message submission"
5695 .cindex "message" "submission, ports for"
5696 .cindex "submissions protocol"
5697 .cindex "smtps protocol"
5698 .cindex "ssmtp protocol"
5699 .cindex "SMTP" "submissions protocol"
5700 .cindex "SMTP" "ssmtp protocol"
5701 .cindex "SMTP" "smtps protocol"
5702 These options provide better support for roaming users who wish to use this
5703 server for message submission. They are not much use unless you have turned on
5704 TLS (as described in the previous paragraph) and authentication (about which
5705 more in section &<<SECTdefconfauth>>&).
5706 Mail submission from mail clients (MUAs) should be separate from inbound mail
5707 to your domain (MX delivery) for various good reasons (eg, ability to impose
5708 much saner TLS protocol and ciphersuite requirements without unintended
5709 consequences).
5710 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5711 which uses STARTTLS, so this is the &"submission"& port.
5712 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5713 which should be used in preference to 587.
5714 You should also consider deploying SRV records to help clients find
5715 these ports.
5716 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5717
5718 Two more commented-out options settings follow:
5719 .code
5720 # qualify_domain =
5721 # qualify_recipient =
5722 .endd
5723 The first of these specifies a domain that Exim uses when it constructs a
5724 complete email address from a local login name. This is often needed when Exim
5725 receives a message from a local process. If you do not set &%qualify_domain%&,
5726 the value of &%primary_hostname%& is used. If you set both of these options,
5727 you can have different qualification domains for sender and recipient
5728 addresses. If you set only the first one, its value is used in both cases.
5729
5730 .cindex "domain literal" "recognizing format"
5731 The following line must be uncommented if you want Exim to recognize
5732 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5733 (an IP address within square brackets) instead of a named domain.
5734 .code
5735 # allow_domain_literals
5736 .endd
5737 The RFCs still require this form, but many people think that in the modern
5738 Internet it makes little sense to permit mail to be sent to specific hosts by
5739 quoting their IP addresses. This ancient format has been used by people who
5740 try to abuse hosts by using them for unwanted relaying. However, some
5741 people believe there are circumstances (for example, messages addressed to
5742 &'postmaster'&) where domain literals are still useful.
5743
5744 The next configuration line is a kind of trigger guard:
5745 .code
5746 never_users = root
5747 .endd
5748 It specifies that no delivery must ever be run as the root user. The normal
5749 convention is to set up &'root'& as an alias for the system administrator. This
5750 setting is a guard against slips in the configuration.
5751 The list of users specified by &%never_users%& is not, however, the complete
5752 list; the build-time configuration in &_Local/Makefile_& has an option called
5753 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5754 contents of &%never_users%& are added to this list. By default
5755 FIXED_NEVER_USERS also specifies root.
5756
5757 When a remote host connects to Exim in order to send mail, the only information
5758 Exim has about the host's identity is its IP address. The next configuration
5759 line,
5760 .code
5761 host_lookup = *
5762 .endd
5763 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5764 in order to get a host name. This improves the quality of the logging
5765 information, but if you feel it is too expensive, you can remove it entirely,
5766 or restrict the lookup to hosts on &"nearby"& networks.
5767 Note that it is not always possible to find a host name from an IP address,
5768 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5769 unreachable.
5770
5771 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5772 1413 (hence their names):
5773 .code
5774 rfc1413_hosts = *
5775 rfc1413_query_timeout = 0s
5776 .endd
5777 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5778 Few hosts offer RFC1413 service these days; calls have to be
5779 terminated by a timeout and this needlessly delays the startup
5780 of an incoming SMTP connection.
5781 If you have hosts for which you trust RFC1413 and need this
5782 information, you can change this.
5783
5784 This line enables an efficiency SMTP option.  It is negotiated by clients
5785 and not expected to cause problems but can be disabled if needed.
5786 .code
5787 prdr_enable = true
5788 .endd
5789
5790 When Exim receives messages over SMTP connections, it expects all addresses to
5791 be fully qualified with a domain, as required by the SMTP definition. However,
5792 if you are running a server to which simple clients submit messages, you may
5793 find that they send unqualified addresses. The two commented-out options:
5794 .code
5795 # sender_unqualified_hosts =
5796 # recipient_unqualified_hosts =
5797 .endd
5798 show how you can specify hosts that are permitted to send unqualified sender
5799 and recipient addresses, respectively.
5800
5801 The &%log_selector%& option is used to increase the detail of logging
5802 over the default:
5803 .code
5804 log_selector = +smtp_protocol_error +smtp_syntax_error \
5805                +tls_certificate_verified
5806 .endd
5807
5808 The &%percent_hack_domains%& option is also commented out:
5809 .code
5810 # percent_hack_domains =
5811 .endd
5812 It provides a list of domains for which the &"percent hack"& is to operate.
5813 This is an almost obsolete form of explicit email routing. If you do not know
5814 anything about it, you can safely ignore this topic.
5815
5816 The next two settings in the main part of the default configuration are
5817 concerned with messages that have been &"frozen"& on Exim's queue. When a
5818 message is frozen, Exim no longer continues to try to deliver it. Freezing
5819 occurs when a bounce message encounters a permanent failure because the sender
5820 address of the original message that caused the bounce is invalid, so the
5821 bounce cannot be delivered. This is probably the most common case, but there
5822 are also other conditions that cause freezing, and frozen messages are not
5823 always bounce messages.
5824 .code
5825 ignore_bounce_errors_after = 2d
5826 timeout_frozen_after = 7d
5827 .endd
5828 The first of these options specifies that failing bounce messages are to be
5829 discarded after 2 days in the queue. The second specifies that any frozen
5830 message (whether a bounce message or not) is to be timed out (and discarded)
5831 after a week. In this configuration, the first setting ensures that no failing
5832 bounce message ever lasts a week.
5833
5834 Exim queues it's messages in a spool directory. If you expect to have
5835 large queues, you may consider using this option. It splits the spool
5836 directory into subdirectories to avoid file system degradation from
5837 many files in a single directory, resulting in better performance.
5838 Manual manipulation of queued messages becomes more complex (though fortunately
5839 not often needed).
5840 .code
5841 # split_spool_directory = true
5842 .endd
5843
5844 In an ideal world everybody follows the standards. For non-ASCII
5845 messages RFC 2047 is a standard, allowing a maximum line length of 76
5846 characters. Exim adheres that standard and won't process messages which
5847 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5848 In particular, the Exim maintainers have had multiple reports of
5849 problems from Russian administrators of issues until they disable this
5850 check, because of some popular, yet buggy, mail composition software.
5851 .code
5852 # check_rfc2047_length = false
5853 .endd
5854
5855 If you need to be strictly RFC compliant you may wish to disable the
5856 8BITMIME advertisement. Use this, if you exchange mails with systems
5857 that are not 8-bit clean.
5858 .code
5859 # accept_8bitmime = false
5860 .endd
5861
5862 Libraries you use may depend on specific environment settings.  This
5863 imposes a security risk (e.g. PATH). There are two lists:
5864 &%keep_environment%& for the variables to import as they are, and
5865 &%add_environment%& for variables we want to set to a fixed value.
5866 Note that TZ is handled separately, by the $%timezone%$ runtime
5867 option and by the TIMEZONE_DEFAULT buildtime option.
5868 .code
5869 # keep_environment = ^LDAP
5870 # add_environment = PATH=/usr/bin::/bin
5871 .endd
5872
5873
5874 .section "ACL configuration" "SECID54"
5875 .cindex "default" "ACLs"
5876 .cindex "&ACL;" "default configuration"
5877 In the default configuration, the ACL section follows the main configuration.
5878 It starts with the line
5879 .code
5880 begin acl
5881 .endd
5882 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5883 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5884 and &%acl_smtp_data%& above.
5885
5886 .cindex "RCPT" "ACL for"
5887 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5888 RCPT command specifies one of the message's recipients. The ACL statements
5889 are considered in order, until the recipient address is either accepted or
5890 rejected. The RCPT command is then accepted or rejected, according to the
5891 result of the ACL processing.
5892 .code
5893 acl_check_rcpt:
5894 .endd
5895 This line, consisting of a name terminated by a colon, marks the start of the
5896 ACL, and names it.
5897 .code
5898 accept  hosts = :
5899 .endd
5900 This ACL statement accepts the recipient if the sending host matches the list.
5901 But what does that strange list mean? It doesn't actually contain any host
5902 names or IP addresses. The presence of the colon puts an empty item in the
5903 list; Exim matches this only if the incoming message did not come from a remote
5904 host, because in that case, the remote hostname is empty. The colon is
5905 important. Without it, the list itself is empty, and can never match anything.
5906
5907 What this statement is doing is to accept unconditionally all recipients in
5908 messages that are submitted by SMTP from local processes using the standard
5909 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5910 manner.
5911 .code
5912 deny    domains       = +local_domains
5913         local_parts   = ^[.] : ^.*[@%!/|]
5914         message       = Restricted characters in address
5915
5916 deny    domains       = !+local_domains
5917         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5918         message       = Restricted characters in address
5919 .endd
5920 These statements are concerned with local parts that contain any of the
5921 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5922 Although these characters are entirely legal in local parts (in the case of
5923 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5924 in Internet mail addresses.
5925
5926 The first three have in the past been associated with explicitly routed
5927 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5928 option). Addresses containing these characters are regularly tried by spammers
5929 in an attempt to bypass relaying restrictions, and also by open relay testing
5930 programs. Unless you really need them it is safest to reject these characters
5931 at this early stage. This configuration is heavy-handed in rejecting these
5932 characters for all messages it accepts from remote hosts. This is a deliberate
5933 policy of being as safe as possible.
5934
5935 The first rule above is stricter, and is applied to messages that are addressed
5936 to one of the local domains handled by this host. This is implemented by the
5937 first condition, which restricts it to domains that are listed in the
5938 &'local_domains'& domain list. The &"+"& character is used to indicate a
5939 reference to a named list. In this configuration, there is just one domain in
5940 &'local_domains'&, but in general there may be many.
5941
5942 The second condition on the first statement uses two regular expressions to
5943 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5944 or &"|"&. If you have local accounts that include these characters, you will
5945 have to modify this rule.
5946
5947 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5948 allows them because they have been encountered in practice. (Consider the
5949 common convention of local parts constructed as
5950 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5951 the author of Exim, who has no second initial.) However, a local part starting
5952 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5953 filename (for example, for a mailing list). This is also true for local parts
5954 that contain slashes. A pipe symbol can also be troublesome if the local part
5955 is incorporated unthinkingly into a shell command line.
5956
5957 The second rule above applies to all other domains, and is less strict. This
5958 allows your own users to send outgoing messages to sites that use slashes
5959 and vertical bars in their local parts. It blocks local parts that begin
5960 with a dot, slash, or vertical bar, but allows these characters within the
5961 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5962 and &"!"& is blocked, as before. The motivation here is to prevent your users
5963 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5964 .code
5965 accept  local_parts   = postmaster
5966         domains       = +local_domains
5967 .endd
5968 This statement, which has two conditions, accepts an incoming address if the
5969 local part is &'postmaster'& and the domain is one of those listed in the
5970 &'local_domains'& domain list. The &"+"& character is used to indicate a
5971 reference to a named list. In this configuration, there is just one domain in
5972 &'local_domains'&, but in general there may be many.
5973
5974 The presence of this statement means that mail to postmaster is never blocked
5975 by any of the subsequent tests. This can be helpful while sorting out problems
5976 in cases where the subsequent tests are incorrectly denying access.
5977 .code
5978 require verify        = sender
5979 .endd
5980 This statement requires the sender address to be verified before any subsequent
5981 ACL statement can be used. If verification fails, the incoming recipient
5982 address is refused. Verification consists of trying to route the address, to
5983 see if a bounce message could be delivered to it. In the case of remote
5984 addresses, basic verification checks only the domain, but &'callouts'& can be
5985 used for more verification if required. Section &<<SECTaddressverification>>&
5986 discusses the details of address verification.
5987 .code
5988 accept  hosts         = +relay_from_hosts
5989         control       = submission
5990 .endd
5991 This statement accepts the address if the message is coming from one of the
5992 hosts that are defined as being allowed to relay through this host. Recipient
5993 verification is omitted here, because in many cases the clients are dumb MUAs
5994 that do not cope well with SMTP error responses. For the same reason, the
5995 second line specifies &"submission mode"& for messages that are accepted. This
5996 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5997 messages that are deficient in some way, for example, because they lack a
5998 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5999 probably add recipient verification here, and disable submission mode.
6000 .code
6001 accept  authenticated = *
6002         control       = submission
6003 .endd
6004 This statement accepts the address if the client host has authenticated itself.
6005 Submission mode is again specified, on the grounds that such messages are most
6006 likely to come from MUAs. The default configuration does not define any
6007 authenticators, though it does include some nearly complete commented-out
6008 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6009 fact authenticate until you complete the authenticator definitions.
6010 .code
6011 require message = relay not permitted
6012         domains = +local_domains : +relay_to_domains
6013 .endd
6014 This statement rejects the address if its domain is neither a local domain nor
6015 one of the domains for which this host is a relay.
6016 .code
6017 require verify = recipient
6018 .endd
6019 This statement requires the recipient address to be verified; if verification
6020 fails, the address is rejected.
6021 .code
6022 # deny    dnslists    = black.list.example
6023 #         message     = rejected because $sender_host_address \
6024 #                       is in a black list at $dnslist_domain\n\
6025 #                       $dnslist_text
6026 #
6027 # warn    dnslists    = black.list.example
6028 #         add_header  = X-Warning: $sender_host_address is in \
6029 #                       a black list at $dnslist_domain
6030 #         log_message = found in $dnslist_domain
6031 .endd
6032 These commented-out lines are examples of how you could configure Exim to check
6033 sending hosts against a DNS black list. The first statement rejects messages
6034 from blacklisted hosts, whereas the second just inserts a warning header
6035 line.
6036 .code
6037 # require verify = csa
6038 .endd
6039 This commented-out line is an example of how you could turn on client SMTP
6040 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6041 records.
6042 .code
6043 accept
6044 .endd
6045 The final statement in the first ACL unconditionally accepts any recipient
6046 address that has successfully passed all the previous tests.
6047 .code
6048 acl_check_data:
6049 .endd
6050 This line marks the start of the second ACL, and names it. Most of the contents
6051 of this ACL are commented out:
6052 .code
6053 # deny    malware   = *
6054 #         message   = This message contains a virus \
6055 #                     ($malware_name).
6056 .endd
6057 These lines are examples of how to arrange for messages to be scanned for
6058 viruses when Exim has been compiled with the content-scanning extension, and a
6059 suitable virus scanner is installed. If the message is found to contain a
6060 virus, it is rejected with the given custom error message.
6061 .code
6062 # warn    spam      = nobody
6063 #         message   = X-Spam_score: $spam_score\n\
6064 #                     X-Spam_score_int: $spam_score_int\n\
6065 #                     X-Spam_bar: $spam_bar\n\
6066 #                     X-Spam_report: $spam_report
6067 .endd
6068 These lines are an example of how to arrange for messages to be scanned by
6069 SpamAssassin when Exim has been compiled with the content-scanning extension,
6070 and SpamAssassin has been installed. The SpamAssassin check is run with
6071 &`nobody`& as its user parameter, and the results are added to the message as a
6072 series of extra header line. In this case, the message is not rejected,
6073 whatever the spam score.
6074 .code
6075 accept
6076 .endd
6077 This final line in the DATA ACL accepts the message unconditionally.
6078
6079
6080 .section "Router configuration" "SECID55"
6081 .cindex "default" "routers"
6082 .cindex "routers" "default"
6083 The router configuration comes next in the default configuration, introduced
6084 by the line
6085 .code
6086 begin routers
6087 .endd
6088 Routers are the modules in Exim that make decisions about where to send
6089 messages. An address is passed to each router, in turn, until it is either
6090 accepted, or failed. This means that the order in which you define the routers
6091 matters. Each router is fully described in its own chapter later in this
6092 manual. Here we give only brief overviews.
6093 .code
6094 # domain_literal:
6095 #   driver = ipliteral
6096 #   domains = !+local_domains
6097 #   transport = remote_smtp
6098 .endd
6099 .cindex "domain literal" "default router"
6100 This router is commented out because the majority of sites do not want to
6101 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6102 you uncomment this router, you also need to uncomment the setting of
6103 &%allow_domain_literals%& in the main part of the configuration.
6104
6105 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6106 macro has been defined, per
6107 .code
6108 .ifdef ROUTER_SMARTHOST
6109 smarthost:
6110 #...
6111 .else
6112 dnslookup:
6113 #...
6114 .endif
6115 .endd
6116
6117 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6118 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6119 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6120 skip these routers because of the &%domains%& option.
6121
6122 .code
6123 smarthost:
6124   driver = manualroute
6125   domains = ! +local_domains
6126   transport = smarthost_smtp
6127   route_data = ROUTER_SMARTHOST
6128   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6129   no_more
6130 .endd
6131 This router only handles mail which is not to any local domains; this is
6132 specified by the line
6133 .code
6134 domains = ! +local_domains
6135 .endd
6136 The &%domains%& option lists the domains to which this router applies, but the
6137 exclamation mark is a negation sign, so the router is used only for domains
6138 that are not in the domain list called &'local_domains'& (which was defined at
6139 the start of the configuration). The plus sign before &'local_domains'&
6140 indicates that it is referring to a named list. Addresses in other domains are
6141 passed on to the following routers.
6142
6143 The name of the router driver is &(manualroute)& because we are manually
6144 specifying how mail should be routed onwards, instead of using DNS MX.
6145 While the name of this router instance is arbitrary, the &%driver%& option must
6146 be one of the driver modules that is in the Exim binary.
6147
6148 With no pre-conditions other than &%domains%&, all mail for non-local domains
6149 will be handled by this router, and the &%no_more%& setting will ensure that no
6150 other routers will be used for messages matching the pre-conditions.  See
6151 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6152 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6153 and the macro supplies the value; the address is then queued for the
6154 &(smarthost_smtp)& transport.
6155
6156 .code
6157 dnslookup:
6158   driver = dnslookup
6159   domains = ! +local_domains
6160   transport = remote_smtp
6161   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6162   no_more
6163 .endd
6164 The &%domains%& option behaves as per smarthost, above.
6165
6166 The name of the router driver is &(dnslookup)&,
6167 and is specified by the &%driver%& option. Do not be confused by the fact that
6168 the name of this router instance is the same as the name of the driver. The
6169 instance name is arbitrary, but the name set in the &%driver%& option must be
6170 one of the driver modules that is in the Exim binary.
6171
6172 The &(dnslookup)& router routes addresses by looking up their domains in the
6173 DNS in order to obtain a list of hosts to which the address is routed. If the
6174 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6175 specified by the &%transport%& option. If the router does not find the domain
6176 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6177 the address fails and is bounced.
6178
6179 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6180 be entirely ignored. This option is present because a number of cases have been
6181 encountered where MX records in the DNS point to host names
6182 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6183 Completely ignoring these IP addresses causes Exim to fail to route the
6184 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6185 continue to try to deliver the message periodically until the address timed
6186 out.
6187 .code
6188 system_aliases:
6189   driver = redirect
6190   allow_fail
6191   allow_defer
6192   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6193 # user = exim
6194   file_transport = address_file
6195   pipe_transport = address_pipe
6196 .endd
6197 Control reaches this and subsequent routers only for addresses in the local
6198 domains. This router checks to see whether the local part is defined as an
6199 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6200 data that it looks up from that file. If no data is found for the local part,
6201 the value of the &%data%& option is empty, causing the address to be passed to
6202 the next router.
6203
6204 &_/etc/aliases_& is a conventional name for the system aliases file that is
6205 often used. That is why it is referenced by from the default configuration
6206 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6207 &_Local/Makefile_& before building Exim.
6208 .code
6209 userforward:
6210   driver = redirect
6211   check_local_user
6212 # local_part_suffix = +* : -*
6213 # local_part_suffix_optional
6214   file = $home/.forward
6215 # allow_filter
6216   no_verify
6217   no_expn
6218   check_ancestor
6219   file_transport = address_file
6220   pipe_transport = address_pipe
6221   reply_transport = address_reply
6222 .endd
6223 This is the most complicated router in the default configuration. It is another
6224 redirection router, but this time it is looking for forwarding data set up by
6225 individual users. The &%check_local_user%& setting specifies a check that the
6226 local part of the address is the login name of a local user. If it is not, the
6227 router is skipped. The two commented options that follow &%check_local_user%&,
6228 namely:
6229 .code
6230 # local_part_suffix = +* : -*
6231 # local_part_suffix_optional
6232 .endd
6233 .vindex "&$local_part_suffix$&"
6234 show how you can specify the recognition of local part suffixes. If the first
6235 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6236 by any sequence of characters, is removed from the local part and placed in the
6237 variable &$local_part_suffix$&. The second suffix option specifies that the
6238 presence of a suffix in the local part is optional. When a suffix is present,
6239 the check for a local login uses the local part with the suffix removed.
6240
6241 When a local user account is found, the file called &_.forward_& in the user's
6242 home directory is consulted. If it does not exist, or is empty, the router
6243 declines. Otherwise, the contents of &_.forward_& are interpreted as
6244 redirection data (see chapter &<<CHAPredirect>>& for more details).
6245
6246 .cindex "Sieve filter" "enabling in default router"
6247 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6248 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6249 is commented out by default), the contents of the file are interpreted as a set
6250 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6251 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6252 separate document entitled &'Exim's interfaces to mail filtering'&.
6253
6254 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6255 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6256 There are two reasons for doing this:
6257
6258 .olist
6259 Whether or not a local user has a &_.forward_& file is not really relevant when
6260 checking an address for validity; it makes sense not to waste resources doing
6261 unnecessary work.
6262 .next
6263 More importantly, when Exim is verifying addresses or handling an EXPN
6264 command during an SMTP session, it is running as the Exim user, not as root.
6265 The group is the Exim group, and no additional groups are set up.
6266 It may therefore not be possible for Exim to read users' &_.forward_& files at
6267 this time.
6268 .endlist
6269
6270 The setting of &%check_ancestor%& prevents the router from generating a new
6271 address that is the same as any previous address that was redirected. (This
6272 works round a problem concerning a bad interaction between aliasing and
6273 forwarding &-- see section &<<SECTredlocmai>>&).
6274
6275 The final three option settings specify the transports that are to be used when
6276 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6277 auto-reply, respectively. For example, if a &_.forward_& file contains
6278 .code
6279 a.nother@elsewhere.example, /home/spqr/archive
6280 .endd
6281 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6282 transport.
6283 .code
6284 localuser:
6285   driver = accept
6286   check_local_user
6287 # local_part_suffix = +* : -*
6288 # local_part_suffix_optional
6289   transport = local_delivery
6290 .endd
6291 The final router sets up delivery into local mailboxes, provided that the local
6292 part is the name of a local login, by accepting the address and assigning it to
6293 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6294 routers, so the address is bounced. The commented suffix settings fulfil the
6295 same purpose as they do for the &(userforward)& router.
6296
6297
6298 .section "Transport configuration" "SECID56"
6299 .cindex "default" "transports"
6300 .cindex "transports" "default"
6301 Transports define mechanisms for actually delivering messages. They operate
6302 only when referenced from routers, so the order in which they are defined does
6303 not matter. The transports section of the configuration starts with
6304 .code
6305 begin transports
6306 .endd
6307 Two remote transports and four local transports are defined.
6308 .code
6309 remote_smtp:
6310   driver = smtp
6311   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6312 .ifdef _HAVE_PRDR
6313   hosts_try_prdr = *
6314 .endif
6315 .endd
6316 This transport is used for delivering messages over SMTP connections.
6317 The list of remote hosts comes from the router.
6318 The &%message_size_limit%& usage is a hack to avoid sending on messages
6319 with over-long lines.
6320
6321 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6322 negotiated between client and server and not expected to cause problems
6323 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6324 use of the &%hosts_try_prdr%& configuration option.
6325
6326 The other remote transport is used when delivering to a specific smarthost
6327 with whom there must be some kind of existing relationship, instead of the
6328 usual federated system.
6329
6330 .code
6331 smarthost_smtp:
6332   driver = smtp
6333   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6334   multi_domain
6335   #
6336 .ifdef _HAVE_TLS
6337   # Comment out any of these which you have to, then file a Support
6338   # request with your smarthost provider to get things fixed:
6339   hosts_require_tls = *
6340   tls_verify_hosts = *
6341   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6342   # have to comment it out then this will at least log whether you succeed
6343   # or not:
6344   tls_try_verify_hosts = *
6345   #
6346   # The SNI name should match the name which we'll expect to verify;
6347   # many mail systems don't use SNI and this doesn't matter, but if it does,
6348   # we need to send a name which the remote site will recognize.
6349   # This _should_ be the name which the smarthost operators specified as
6350   # the hostname for sending your mail to.
6351   tls_sni = ROUTER_SMARTHOST
6352   #
6353 .ifdef _HAVE_OPENSSL
6354   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6355 .endif
6356 .ifdef _HAVE_GNUTLS
6357   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6358 .endif
6359 .endif
6360 .ifdef _HAVE_PRDR
6361   hosts_try_prdr = *
6362 .endif
6363 .endd
6364 After the same &%message_size_limit%& hack, we then specify that this Transport
6365 can handle messages to multiple domains in one run.  The assumption here is
6366 that you're routing all non-local mail to the same place and that place is
6367 happy to take all messages from you as quickly as possible.
6368 All other options depend upon built-in macros; if Exim was built without TLS support
6369 then no other options are defined.
6370 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6371 and versions using the &%tls_require_ciphers%& option, where the value to be
6372 used depends upon the library providing TLS.
6373 Beyond that, the options adopt the stance that you should have TLS support available
6374 from your smarthost on today's Internet, so we turn on requiring TLS for the
6375 mail to be delivered, and requiring that the certificate be valid, and match
6376 the expected hostname.  The &%tls_sni%& option can be used by service providers
6377 to select an appropriate certificate to present to you and here we re-use the
6378 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6379 You want to specify the hostname which you'll expect to validate for, and that
6380 should not be subject to insecure tampering via DNS results.
6381
6382 For the &%hosts_try_prdr%& option see the previous transport.
6383
6384 All other options are defaulted.
6385 .code
6386 local_delivery:
6387   driver = appendfile
6388   file = /var/mail/$local_part_data
6389   delivery_date_add
6390   envelope_to_add
6391   return_path_add
6392 # group = mail
6393 # mode = 0660
6394 .endd
6395 This &(appendfile)& transport is used for local delivery to user mailboxes in
6396 traditional BSD mailbox format.
6397
6398 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6399 as it is provided by a potential bad actor.
6400 Instead we use &$local_part_data$&,
6401 the result of looking up &$local_part$& in the user database
6402 (done by using &%check_local_user%& in the the router).
6403
6404 By default &(appendfile)& runs under the uid and gid of the
6405 local user, which requires the sticky bit to be set on the &_/var/mail_&
6406 directory. Some systems use the alternative approach of running mail deliveries
6407 under a particular group instead of using the sticky bit. The commented options
6408 show how this can be done.
6409
6410 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6411 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6412 similarly-named options above.
6413 .code
6414 address_pipe:
6415   driver = pipe
6416   return_output
6417 .endd
6418 This transport is used for handling deliveries to pipes that are generated by
6419 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6420 option specifies that any output on stdout or stderr generated by the pipe is to
6421 be returned to the sender.
6422 .code
6423 address_file:
6424   driver = appendfile
6425   delivery_date_add
6426   envelope_to_add
6427   return_path_add
6428 .endd
6429 This transport is used for handling deliveries to files that are generated by
6430 redirection. The name of the file is not specified in this instance of
6431 &(appendfile)&, because it comes from the &(redirect)& router.
6432 .code
6433 address_reply:
6434   driver = autoreply
6435 .endd
6436 This transport is used for handling automatic replies generated by users'
6437 filter files.
6438
6439
6440
6441 .section "Default retry rule" "SECID57"
6442 .cindex "retry" "default rule"
6443 .cindex "default" "retry rule"
6444 The retry section of the configuration file contains rules which affect the way
6445 Exim retries deliveries that cannot be completed at the first attempt. It is
6446 introduced by the line
6447 .code
6448 begin retry
6449 .endd
6450 In the default configuration, there is just one rule, which applies to all
6451 errors:
6452 .code
6453 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6454 .endd
6455 This causes any temporarily failing address to be retried every 15 minutes for
6456 2 hours, then at intervals starting at one hour and increasing by a factor of
6457 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6458 is not delivered after 4 days of temporary failure, it is bounced. The time is
6459 measured from first failure, not from the time the message was received.
6460
6461 If the retry section is removed from the configuration, or is empty (that is,
6462 if no retry rules are defined), Exim will not retry deliveries. This turns
6463 temporary errors into permanent errors.
6464
6465
6466 .section "Rewriting configuration" "SECID58"
6467 The rewriting section of the configuration, introduced by
6468 .code
6469 begin rewrite
6470 .endd
6471 contains rules for rewriting addresses in messages as they arrive. There are no
6472 rewriting rules in the default configuration file.
6473
6474
6475
6476 .section "Authenticators configuration" "SECTdefconfauth"
6477 .cindex "AUTH" "configuration"
6478 The authenticators section of the configuration, introduced by
6479 .code
6480 begin authenticators
6481 .endd
6482 defines mechanisms for the use of the SMTP AUTH command. The default
6483 configuration file contains two commented-out example authenticators
6484 which support plaintext username/password authentication using the
6485 standard PLAIN mechanism and the traditional but non-standard LOGIN
6486 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6487 to support most MUA software.
6488
6489 The example PLAIN authenticator looks like this:
6490 .code
6491 #PLAIN:
6492 #  driver                  = plaintext
6493 #  server_set_id           = $auth2
6494 #  server_prompts          = :
6495 #  server_condition        = Authentication is not yet configured
6496 #  server_advertise_condition = ${if def:tls_in_cipher }
6497 .endd
6498 And the example LOGIN authenticator looks like this:
6499 .code
6500 #LOGIN:
6501 #  driver                  = plaintext
6502 #  server_set_id           = $auth1
6503 #  server_prompts          = <| Username: | Password:
6504 #  server_condition        = Authentication is not yet configured
6505 #  server_advertise_condition = ${if def:tls_in_cipher }
6506 .endd
6507
6508 The &%server_set_id%& option makes Exim remember the authenticated username
6509 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6510 &%server_prompts%& option configures the &(plaintext)& authenticator so
6511 that it implements the details of the specific authentication mechanism,
6512 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6513 when Exim offers authentication to clients; in the examples, this is only
6514 when TLS or SSL has been started, so to enable the authenticators you also
6515 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6516
6517 The &%server_condition%& setting defines how to verify that the username and
6518 password are correct. In the examples it just produces an error message.
6519 To make the authenticators work, you can use a string expansion
6520 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6521
6522 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6523 usercode and password are in different positions.
6524 Chapter &<<CHAPplaintext>>& covers both.
6525
6526 .ecindex IIDconfiwal
6527
6528
6529
6530 . ////////////////////////////////////////////////////////////////////////////
6531 . ////////////////////////////////////////////////////////////////////////////
6532
6533 .chapter "Regular expressions" "CHAPregexp"
6534
6535 .cindex "regular expressions" "library"
6536 .cindex "PCRE"
6537 Exim supports the use of regular expressions in many of its options. It
6538 uses the PCRE regular expression library; this provides regular expression
6539 matching that is compatible with Perl 5. The syntax and semantics of
6540 regular expressions is discussed in
6541 online Perl manpages, in
6542 many Perl reference books, and also in
6543 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6544 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6545 . --- the http: URL here redirects to another page with the ISBN in the URL
6546 . --- where trying to use https: just redirects back to http:, so sticking
6547 . --- to the old URL for now.  2018-09-07.
6548
6549 The documentation for the syntax and semantics of the regular expressions that
6550 are supported by PCRE is included in the PCRE distribution, and no further
6551 description is included here. The PCRE functions are called from Exim using
6552 the default option settings (that is, with no PCRE options set), except that
6553 the PCRE_CASELESS option is set when the matching is required to be
6554 case-insensitive.
6555
6556 In most cases, when a regular expression is required in an Exim configuration,
6557 it has to start with a circumflex, in order to distinguish it from plain text
6558 or an &"ends with"& wildcard. In this example of a configuration setting, the
6559 second item in the colon-separated list is a regular expression.
6560 .code
6561 domains = a.b.c : ^\\d{3} : *.y.z : ...
6562 .endd
6563 The doubling of the backslash is required because of string expansion that
6564 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6565 of this issue, and a way of avoiding the need for doubling backslashes. The
6566 regular expression that is eventually used in this example contains just one
6567 backslash. The circumflex is included in the regular expression, and has the
6568 normal effect of &"anchoring"& it to the start of the string that is being
6569 matched.
6570
6571 There are, however, two cases where a circumflex is not required for the
6572 recognition of a regular expression: these are the &%match%& condition in a
6573 string expansion, and the &%matches%& condition in an Exim filter file. In
6574 these cases, the relevant string is always treated as a regular expression; if
6575 it does not start with a circumflex, the expression is not anchored, and can
6576 match anywhere in the subject string.
6577
6578 In all cases, if you want a regular expression to match at the end of a string,
6579 you must code the $ metacharacter to indicate this. For example:
6580 .code
6581 domains = ^\\d{3}\\.example
6582 .endd
6583 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6584 You need to use:
6585 .code
6586 domains = ^\\d{3}\\.example\$
6587 .endd
6588 if you want &'example'& to be the top-level domain. The backslash before the
6589 $ is needed because string expansion also interprets dollar characters.
6590
6591
6592
6593 . ////////////////////////////////////////////////////////////////////////////
6594 . ////////////////////////////////////////////////////////////////////////////
6595
6596 .chapter "File and database lookups" "CHAPfdlookup"
6597 .scindex IIDfidalo1 "file" "lookups"
6598 .scindex IIDfidalo2 "database" "lookups"
6599 .cindex "lookup" "description of"
6600 Exim can be configured to look up data in files or databases as it processes
6601 messages. Two different kinds of syntax are used:
6602
6603 .olist
6604 A string that is to be expanded may contain explicit lookup requests. These
6605 cause parts of the string to be replaced by data that is obtained from the
6606 lookup. Lookups of this type are conditional expansion items. Different results
6607 can be defined for the cases of lookup success and failure. See chapter
6608 &<<CHAPexpand>>&, where string expansions are described in detail.
6609 The key for the lookup is &*specified*& as part of the string expansion.
6610 .next
6611 Lists of domains, hosts, and email addresses can contain lookup requests as a
6612 way of avoiding excessively long linear lists. In this case, the data that is
6613 returned by the lookup is often (but not always) discarded; whether the lookup
6614 succeeds or fails is what really counts. These kinds of list are described in
6615 chapter &<<CHAPdomhosaddlists>>&.
6616 The key for the lookup is &*implicit*&,
6617 given by the context in which the list is expanded.
6618 .endlist
6619
6620 String expansions, lists, and lookups interact with each other in such a way
6621 that there is no order in which to describe any one of them that does not
6622 involve references to the others. Each of these three chapters makes more sense
6623 if you have read the other two first. If you are reading this for the first
6624 time, be aware that some of it will make a lot more sense after you have read
6625 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6626
6627 .section "Examples of different lookup syntax" "SECID60"
6628 It is easy to confuse the two different kinds of lookup, especially as the
6629 lists that may contain the second kind are always expanded before being
6630 processed as lists. Therefore, they may also contain lookups of the first kind.
6631 Be careful to distinguish between the following two examples:
6632 .code
6633 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6634 domains = lsearch;/some/file
6635 .endd
6636 The first uses a string expansion, the result of which must be a domain list.
6637 No strings have been specified for a successful or a failing lookup; the
6638 defaults in this case are the looked-up data and an empty string, respectively.
6639 The expansion takes place before the string is processed as a list, and the
6640 file that is searched could contain lines like this:
6641 .code
6642 192.168.3.4: domain1:domain2:...
6643 192.168.1.9: domain3:domain4:...
6644 .endd
6645 When the lookup succeeds, the result of the expansion is a list of domains (and
6646 possibly other types of item that are allowed in domain lists).
6647 .cindex "tainted data" "de-tainting"
6648 The result of the expansion is not tainted.
6649
6650 In the second example, the lookup is a single item in a domain list. It causes
6651 Exim to use a lookup to see if the domain that is being processed can be found
6652 in the file.
6653 The file could contains lines like this:
6654 .code
6655 domain1:
6656 domain2:
6657 .endd
6658 Any data that follows the keys is not relevant when checking that the domain
6659 matches the list item.
6660
6661 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6662 Consider a file containing lines like this:
6663 .code
6664 192.168.5.6: lsearch;/another/file
6665 .endd
6666 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6667 first &%domains%& setting above generates the second setting, which therefore
6668 causes a second lookup to occur.
6669
6670 .new
6671 The lookup type may optionally be followed by a comma
6672 and a comma-separated list of options.
6673 Each option is a &"name=value"& pair.
6674 Whether an option is meaningful depands on the lookup type.
6675
6676 All lookups support the option &"cache=no_rd"&.
6677 If this is given then the cache that Exim manages for lookup results
6678 is not checked before diong the lookup.
6679 The result of the lookup is still written to the cache.
6680 .wen
6681
6682 The rest of this chapter describes the different lookup types that are
6683 available. Any of them can be used in any part of the configuration where a
6684 lookup is permitted.
6685
6686
6687 .section "Lookup types" "SECID61"
6688 .cindex "lookup" "types of"
6689 .cindex "single-key lookup" "definition of"
6690 Two different types of data lookup are implemented:
6691
6692 .ilist
6693 The &'single-key'& type requires the specification of a file in which to look,
6694 and a single key to search for. The key must be a non-empty string for the
6695 lookup to succeed. The lookup type determines how the file is searched.
6696 .cindex "tainted data" "single-key lookups"
6697 The file string may not be tainted
6698
6699 .cindex "tainted data" "de-tainting"
6700 All single-key lookups support the option &"ret=key"&.
6701 If this is given and the lookup
6702 (either underlying implementation or cached value)
6703 returns data, the result is replaced with a non-tainted
6704 version of the lookup key.
6705 .cindex "tainted data" "de-tainting"
6706 .next
6707 .cindex "query-style lookup" "definition of"
6708 The &'query-style'& type accepts a generalized database query. No particular
6709 key value is assumed by Exim for query-style lookups. You can use whichever
6710 Exim variables you need to construct the database query.
6711 .endlist
6712
6713 The code for each lookup type is in a separate source file that is included in
6714 the binary of Exim only if the corresponding compile-time option is set. The
6715 default settings in &_src/EDITME_& are:
6716 .code
6717 LOOKUP_DBM=yes
6718 LOOKUP_LSEARCH=yes
6719 .endd
6720 which means that only linear searching and DBM lookups are included by default.
6721 For some types of lookup (e.g. SQL databases), you need to install appropriate
6722 libraries and header files before building Exim.
6723
6724
6725
6726
6727 .section "Single-key lookup types" "SECTsinglekeylookups"
6728 .cindex "lookup" "single-key types"
6729 .cindex "single-key lookup" "list of types"
6730 The following single-key lookup types are implemented:
6731
6732 .ilist
6733 .cindex "cdb" "description of"
6734 .cindex "lookup" "cdb"
6735 .cindex "binary zero" "in lookup key"
6736 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6737 string without a terminating binary zero. The cdb format is designed for
6738 indexed files that are read frequently and never updated, except by total
6739 re-creation. As such, it is particularly suitable for large files containing
6740 aliases or other indexed data referenced by an MTA. Information about cdb and
6741 tools for building the files can be found in several places:
6742 .display
6743 &url(https://cr.yp.to/cdb.html)
6744 &url(https://www.corpit.ru/mjt/tinycdb.html)
6745 &url(https://packages.debian.org/stable/utils/freecdb)
6746 &url(https://github.com/philpennock/cdbtools) (in Go)
6747 .endd
6748 A cdb distribution is not needed in order to build Exim with cdb support,
6749 because the code for reading cdb files is included directly in Exim itself.
6750 However, no means of building or testing cdb files is provided with Exim, so
6751 you need to obtain a cdb distribution in order to do this.
6752 .next
6753 .cindex "DBM" "lookup type"
6754 .cindex "lookup" "dbm"
6755 .cindex "binary zero" "in lookup key"
6756 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6757 DBM file by looking up the record with the given key. A terminating binary
6758 zero is included in the key that is passed to the DBM library. See section
6759 &<<SECTdb>>& for a discussion of DBM libraries.
6760
6761 .cindex "Berkeley DB library" "file format"
6762 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6763 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6764 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6765 the DB_UNKNOWN option. This enables it to handle any of the types of database
6766 that the library supports, and can be useful for accessing DBM files created by
6767 other applications. (For earlier DB versions, DB_HASH is always used.)
6768 .next
6769 .cindex "lookup" "dbmjz"
6770 .cindex "lookup" "dbm &-- embedded NULs"
6771 .cindex "sasldb2"
6772 .cindex "dbmjz lookup type"
6773 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6774 interpreted as an Exim list; the elements of the list are joined together with
6775 ASCII NUL characters to form the lookup key.  An example usage would be to
6776 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6777 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6778 &(cram_md5)& authenticator.
6779 .next
6780 .cindex "lookup" "dbmnz"
6781 .cindex "lookup" "dbm &-- terminating zero"
6782 .cindex "binary zero" "in lookup key"
6783 .cindex "Courier"
6784 .cindex "&_/etc/userdbshadow.dat_&"
6785 .cindex "dbmnz lookup type"
6786 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6787 is not included in the key that is passed to the DBM library. You may need this
6788 if you want to look up data in files that are created by or shared with some
6789 other application that does not use terminating zeros. For example, you need to
6790 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6791 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6792 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6793 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6794 .next
6795 .cindex "lookup" "dsearch"
6796 .cindex "dsearch lookup type"
6797 &(dsearch)&: The given file must be an
6798 absolute
6799 directory path; this is searched for an entry
6800 whose name is the key by calling the &[lstat()]& function.
6801 The key may not
6802 contain any forward slash characters.
6803 If &[lstat()]& succeeds then so does the lookup.
6804 .cindex "tainted data" "dsearch result"
6805 The result is regarded as untainted.
6806
6807 Options for the lookup can be given by appending them after the word "dsearch",
6808 separated by a comma.  Options, if present, are a comma-separated list having
6809 each element starting with a tag name and an equals.
6810
6811 Two options are supported, for the return value and for filtering match
6812 candidates.
6813 The "ret" option requests an alternate result value of
6814 the entire path for the entry. Example:
6815 .code
6816 ${lookup {passwd} dsearch,ret=full {/etc}}
6817 .endd
6818 The default result is just the requested entry.
6819 The "filter" option requests that only directory entries of a given type
6820 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6821 not matching "." or ".."). Example:
6822 .code
6823 ${lookup {passwd} dsearch,filter=file {/etc}}
6824 .endd
6825 The default matching is for any entry type, including directories
6826 and symlinks.
6827
6828 An example of how this
6829 lookup can be used to support virtual domains is given in section
6830 &<<SECTvirtualdomains>>&.
6831 .next
6832 .cindex "lookup" "iplsearch"
6833 .cindex "iplsearch lookup type"
6834 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6835 terminated by a colon or white space or the end of the line. The keys in the
6836 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6837 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6838 being interpreted as a key terminator. For example:
6839 .code
6840 1.2.3.4:           data for 1.2.3.4
6841 192.168.0.0/16:    data for 192.168.0.0/16
6842 "abcd::cdab":      data for abcd::cdab
6843 "abcd:abcd::/32"   data for abcd:abcd::/32
6844 .endd
6845 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6846 file is searched linearly, using the CIDR masks where present, until a matching
6847 key is found. The first key that matches is used; there is no attempt to find a
6848 &"best"& match. Apart from the way the keys are matched, the processing for
6849 &(iplsearch)& is the same as for &(lsearch)&.
6850
6851 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6852 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6853 lookup types support only literal keys.
6854
6855 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6856 the implicit key is the host's IP address rather than its name (see section
6857 &<<SECThoslispatsikey>>&).
6858
6859 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6860 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6861 notation before executing the lookup.)
6862 .next
6863 .cindex lookup json
6864 .cindex json "lookup type"
6865 .cindex JSON expansions
6866 &(json)&: The given file is a text file with a JSON structure.
6867 An element of the structure is extracted, defined by the search key.
6868 The key is a list of subelement selectors
6869 (colon-separated by default but changeable in the usual way)
6870 which are applied in turn to select smaller and smaller portions
6871 of the JSON structure.
6872 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6873 nunbered array element is selected.
6874 Otherwise it must apply to a JSON object; the named element is selected.
6875 The final resulting element can be a simple JSON type or a JSON object
6876 or array; for the latter two a string-representation of the JSON
6877 is returned.
6878 For elements of type string, the returned value is de-quoted.
6879
6880
6881 .new
6882 .next
6883 .cindex LMDB
6884 .cindex lookup lmdb
6885 .cindex database lmdb
6886 &(lmdb)&: The given file is an LMDB database.
6887 LMDB is a memory-mapped key-value store,
6888 with API modeled loosely on that of BerkeleyDB.
6889 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6890 for the feature set and operation modes.
6891
6892 Exim provides read-only access via the LMDB C library.
6893 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6894 or your operating system package repository.
6895 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6896
6897 You will need to separately create the LMDB database file,
6898 possibly using the &"mdb_load"& utility.
6899 .wen
6900
6901
6902 .next
6903 .cindex "linear search"
6904 .cindex "lookup" "lsearch"
6905 .cindex "lsearch lookup type"
6906 .cindex "case sensitivity" "in lsearch lookup"
6907 &(lsearch)&: The given file is a text file that is searched linearly for a
6908 line beginning with the search key, terminated by a colon or white space or the
6909 end of the line. The search is case-insensitive; that is, upper and lower case
6910 letters are treated as the same. The first occurrence of the key that is found
6911 in the file is used.
6912
6913 White space between the key and the colon is permitted. The remainder of the
6914 line, with leading and trailing white space removed, is the data. This can be
6915 continued onto subsequent lines by starting them with any amount of white
6916 space, but only a single space character is included in the data at such a
6917 junction. If the data begins with a colon, the key must be terminated by a
6918 colon, for example:
6919 .code
6920 baduser:  :fail:
6921 .endd
6922 Empty lines and lines beginning with # are ignored, even if they occur in the
6923 middle of an item. This is the traditional textual format of alias files. Note
6924 that the keys in an &(lsearch)& file are literal strings. There is no
6925 wildcarding of any kind.
6926
6927 .cindex "lookup" "lsearch &-- colons in keys"
6928 .cindex "white space" "in lsearch key"
6929 In most &(lsearch)& files, keys are not required to contain colons or #
6930 characters, or white space. However, if you need this feature, it is available.
6931 If a key begins with a doublequote character, it is terminated only by a
6932 matching quote (or end of line), and the normal escaping rules apply to its
6933 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6934 quoted keys (exactly as for unquoted keys). There is no special handling of
6935 quotes for the data part of an &(lsearch)& line.
6936
6937 .next
6938 .cindex "NIS lookup type"
6939 .cindex "lookup" "NIS"
6940 .cindex "binary zero" "in lookup key"
6941 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6942 the given key, without a terminating binary zero. There is a variant called
6943 &(nis0)& which does include the terminating binary zero in the key. This is
6944 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6945 aliases; the full map names must be used.
6946
6947 .next
6948 .cindex "wildlsearch lookup type"
6949 .cindex "lookup" "wildlsearch"
6950 .cindex "nwildlsearch lookup type"
6951 .cindex "lookup" "nwildlsearch"
6952 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6953 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6954 the file may be wildcarded. The difference between these two lookup types is
6955 that for &(wildlsearch)&, each key in the file is string-expanded before being
6956 used, whereas for &(nwildlsearch)&, no expansion takes place.
6957
6958 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6959 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6960 file that are regular expressions can be made case-sensitive by the use of
6961 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6962
6963 . ==== As this is a nested list, any displays it contains must be indented
6964 . ==== as otherwise they are too far to the left.
6965
6966 .olist
6967 The string may begin with an asterisk to mean &"ends with"&. For example:
6968 .code
6969     *.a.b.c       data for anything.a.b.c
6970     *fish         data for anythingfish
6971 .endd
6972 .next
6973 The string may begin with a circumflex to indicate a regular expression. For
6974 example, for &(wildlsearch)&:
6975 .code
6976     ^\N\d+\.a\.b\N    data for <digits>.a.b
6977 .endd
6978 Note the use of &`\N`& to disable expansion of the contents of the regular
6979 expression. If you are using &(nwildlsearch)&, where the keys are not
6980 string-expanded, the equivalent entry is:
6981 .code
6982     ^\d+\.a\.b        data for <digits>.a.b
6983 .endd
6984 The case-insensitive flag is set at the start of compiling the regular
6985 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6986 For example, to make the entire pattern case-sensitive:
6987 .code
6988     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6989 .endd
6990
6991 If the regular expression contains white space or colon characters, you must
6992 either quote it (see &(lsearch)& above), or represent these characters in other
6993 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6994 colon. This may be easier than quoting, because if you quote, you have to
6995 escape all the backslashes inside the quotes.
6996
6997 &*Note*&: It is not possible to capture substrings in a regular expression
6998 match for later use, because the results of all lookups are cached. If a lookup
6999 is repeated, the result is taken from the cache, and no actual pattern matching
7000 takes place. The values of all the numeric variables are unset after a
7001 &((n)wildlsearch)& match.
7002
7003 .next
7004 Although I cannot see it being of much use, the general matching function that
7005 is used to implement &((n)wildlsearch)& means that the string may begin with a
7006 lookup name terminated by a semicolon, and followed by lookup data. For
7007 example:
7008 .code
7009     cdb;/some/file  data for keys that match the file
7010 .endd
7011 The data that is obtained from the nested lookup is discarded.
7012 .endlist olist
7013
7014 Keys that do not match any of these patterns are interpreted literally. The
7015 continuation rules for the data are the same as for &(lsearch)&, and keys may
7016 be followed by optional colons.
7017
7018 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7019 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7020 lookup types support only literal keys.
7021
7022 .next
7023 .cindex "spf lookup type"
7024 .cindex "lookup" "spf"
7025 &(spf)&: If Exim is built with SPF support, manual lookups can be done
7026 (as opposed to the standard ACL condition method).
7027 For details see section &<<SECSPF>>&.
7028 .endlist ilist
7029
7030
7031 .section "Query-style lookup types" "SECTquerystylelookups"
7032 .cindex "lookup" "query-style types"
7033 .cindex "query-style lookup" "list of types"
7034 The supported query-style lookup types are listed below. Further details about
7035 many of them are given in later sections.
7036
7037 .ilist
7038 .cindex "DNS" "as a lookup type"
7039 .cindex "lookup" "DNS"
7040 &(dnsdb)&: This does a DNS search for one or more records whose domain names
7041 are given in the supplied query. The resulting data is the contents of the
7042 records. See section &<<SECTdnsdb>>&.
7043 .next
7044 .cindex "InterBase lookup type"
7045 .cindex "lookup" "InterBase"
7046 &(ibase)&: This does a lookup in an InterBase database.
7047 .next
7048 .cindex "LDAP" "lookup type"
7049 .cindex "lookup" "LDAP"
7050 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7051 returns attributes from a single entry. There is a variant called &(ldapm)&
7052 that permits values from multiple entries to be returned. A third variant
7053 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7054 any attribute values. See section &<<SECTldap>>&.
7055 .next
7056 .cindex "MySQL" "lookup type"
7057 .cindex "lookup" "MySQL"
7058 &(mysql)&: The format of the query is an SQL statement that is passed to a
7059 MySQL database. See section &<<SECTsql>>&.
7060 .next
7061 .cindex "NIS+ lookup type"
7062 .cindex "lookup" "NIS+"
7063 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7064 the field to be returned. See section &<<SECTnisplus>>&.
7065 .next
7066 .cindex "Oracle" "lookup type"
7067 .cindex "lookup" "Oracle"
7068 &(oracle)&: The format of the query is an SQL statement that is passed to an
7069 Oracle database. See section &<<SECTsql>>&.
7070 .next
7071 .cindex "lookup" "passwd"
7072 .cindex "passwd lookup type"
7073 .cindex "&_/etc/passwd_&"
7074 &(passwd)& is a query-style lookup with queries that are just user names. The
7075 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7076 success, the result string is the same as you would get from an &(lsearch)&
7077 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7078 password value. For example:
7079 .code
7080 *:42:42:King Rat:/home/kr:/bin/bash
7081 .endd
7082 .next
7083 .cindex "PostgreSQL lookup type"
7084 .cindex "lookup" "PostgreSQL"
7085 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7086 PostgreSQL database. See section &<<SECTsql>>&.
7087
7088 .next
7089 .cindex "Redis lookup type"
7090 .cindex lookup Redis
7091 &(redis)&: The format of the query is either a simple get or simple set,
7092 passed to a Redis database. See section &<<SECTsql>>&.
7093
7094 .next
7095 .cindex "sqlite lookup type"
7096 .cindex "lookup" "sqlite"
7097 &(sqlite)&: The format of the query is
7098 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7099
7100 .next
7101 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7102 not likely to be useful in normal operation.
7103 .next
7104 .cindex "whoson lookup type"
7105 .cindex "lookup" "whoson"
7106 . --- still http:-only, 2018-09-07
7107 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7108 allows a server to check whether a particular (dynamically allocated) IP
7109 address is currently allocated to a known (trusted) user and, optionally, to
7110 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7111 at one time for &"POP before SMTP"& authentication, but that approach has been
7112 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7113 &"POP before SMTP"& checking using ACL statements such as
7114 .code
7115 require condition = \
7116   ${lookup whoson {$sender_host_address}{yes}{no}}
7117 .endd
7118 The query consists of a single IP address. The value returned is the name of
7119 the authenticated user, which is stored in the variable &$value$&. However, in
7120 this example, the data in &$value$& is not used; the result of the lookup is
7121 one of the fixed strings &"yes"& or &"no"&.
7122 .endlist
7123
7124
7125
7126 .section "Temporary errors in lookups" "SECID63"
7127 .cindex "lookup" "temporary error in"
7128 Lookup functions can return temporary error codes if the lookup cannot be
7129 completed. For example, an SQL or LDAP database might be unavailable. For this
7130 reason, it is not advisable to use a lookup that might do this for critical
7131 options such as a list of local domains.
7132
7133 When a lookup cannot be completed in a router or transport, delivery
7134 of the message (to the relevant address) is deferred, as for any other
7135 temporary error. In other circumstances Exim may assume the lookup has failed,
7136 or may give up altogether.
7137
7138
7139
7140 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7141 .cindex "wildcard lookups"
7142 .cindex "lookup" "default values"
7143 .cindex "lookup" "wildcard"
7144 .cindex "lookup" "* added to type"
7145 .cindex "default" "in single-key lookups"
7146 In this context, a &"default value"& is a value specified by the administrator
7147 that is to be used if a lookup fails.
7148
7149 &*Note:*& This section applies only to single-key lookups. For query-style
7150 lookups, the facilities of the query language must be used. An attempt to
7151 specify a default for a query-style lookup provokes an error.
7152
7153 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7154 and the initial lookup fails, the key &"*"& is looked up in the file to
7155 provide a default value. See also the section on partial matching below.
7156
7157 .cindex "*@ with single-key lookup"
7158 .cindex "lookup" "*@ added to type"
7159 .cindex "alias file" "per-domain default"
7160 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7161 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7162 character, a second lookup is done with everything before the last @ replaced
7163 by *. This makes it possible to provide per-domain defaults in alias files
7164 that include the domains in the keys. If the second lookup fails (or doesn't
7165 take place because there is no @ in the key), &"*"& is looked up.
7166 For example, a &(redirect)& router might contain:
7167 .code
7168 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7169 .endd
7170 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7171 looks up these keys, in this order:
7172 .code
7173 jane@eyre.example
7174 *@eyre.example
7175 *
7176 .endd
7177 The data is taken from whichever key it finds first. &*Note*&: In an
7178 &(lsearch)& file, this does not mean the first of these keys in the file. A
7179 complete scan is done for each key, and only if it is not found at all does
7180 Exim move on to try the next key.
7181
7182
7183
7184 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7185 .cindex "partial matching"
7186 .cindex "wildcard lookups"
7187 .cindex "lookup" "partial matching"
7188 .cindex "lookup" "wildcard"
7189 .cindex "asterisk" "in search type"
7190 The normal operation of a single-key lookup is to search the file for an exact
7191 match with the given key. However, in a number of situations where domains are
7192 being looked up, it is useful to be able to do partial matching. In this case,
7193 information in the file that has a key starting with &"*."& is matched by any
7194 domain that ends with the components that follow the full stop. For example, if
7195 a key in a DBM file is
7196 .code
7197 *.dates.fict.example
7198 .endd
7199 then when partial matching is enabled this is matched by (amongst others)
7200 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7201 by &'dates.fict.example'&, if that does not appear as a separate key in the
7202 file.
7203
7204 &*Note*&: Partial matching is not available for query-style lookups. It is
7205 also not available for any lookup items in address lists (see section
7206 &<<SECTaddresslist>>&).
7207
7208 Partial matching is implemented by doing a series of separate lookups using
7209 keys constructed by modifying the original subject key. This means that it can
7210 be used with any of the single-key lookup types, provided that
7211 partial matching keys
7212 beginning with a special prefix (default &"*."&) are included in the data file.
7213 Keys in the file that do not begin with the prefix are matched only by
7214 unmodified subject keys when partial matching is in use.
7215
7216 Partial matching is requested by adding the string &"partial-"& to the front of
7217 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7218 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7219 is added at the start of the subject key, and it is looked up again. If that
7220 fails, further lookups are tried with dot-separated components removed from the
7221 start of the subject key, one-by-one, and &"*."& added on the front of what
7222 remains.
7223
7224 A minimum number of two non-* components are required. This can be adjusted
7225 by including a number before the hyphen in the search type. For example,
7226 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7227 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7228 subject key is &'2250.dates.fict.example'& then the following keys are looked
7229 up when the minimum number of non-* components is two:
7230 .code
7231 2250.dates.fict.example
7232 *.2250.dates.fict.example
7233 *.dates.fict.example
7234 *.fict.example
7235 .endd
7236 As soon as one key in the sequence is successfully looked up, the lookup
7237 finishes.
7238
7239 .cindex "lookup" "partial matching &-- changing prefix"
7240 .cindex "prefix" "for partial matching"
7241 The use of &"*."& as the partial matching prefix is a default that can be
7242 changed. The motivation for this feature is to allow Exim to operate with file
7243 formats that are used by other MTAs. A different prefix can be supplied in
7244 parentheses instead of the hyphen after &"partial"&. For example:
7245 .code
7246 domains = partial(.)lsearch;/some/file
7247 .endd
7248 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7249 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7250 components is unchanged). The prefix may consist of any punctuation characters
7251 other than a closing parenthesis. It may be empty, for example:
7252 .code
7253 domains = partial1()cdb;/some/file
7254 .endd
7255 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7256 &`a.b.c`&, &`b.c`&, and &`c`&.
7257
7258 If &"partial0"& is specified, what happens at the end (when the lookup with
7259 just one non-wild component has failed, and the original key is shortened right
7260 down to the null string) depends on the prefix:
7261
7262 .ilist
7263 If the prefix has zero length, the whole lookup fails.
7264 .next
7265 If the prefix has length 1, a lookup for just the prefix is done. For
7266 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7267 .next
7268 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7269 remainder is looked up. With the default prefix, therefore, the final lookup is
7270 for &"*"& on its own.
7271 .next
7272 Otherwise, the whole prefix is looked up.
7273 .endlist
7274
7275
7276 If the search type ends in &"*"& or &"*@"& (see section
7277 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7278 this implies happens after all partial lookups have failed. If &"partial0"& is
7279 specified, adding &"*"& to the search type has no effect with the default
7280 prefix, because the &"*"& key is already included in the sequence of partial
7281 lookups. However, there might be a use for lookup types such as
7282 &"partial0(.)lsearch*"&.
7283
7284 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7285 in domain lists and the like. Partial matching works only in terms of
7286 dot-separated components; a key such as &`*fict.example`&
7287 in a database file is useless, because the asterisk in a partial matching
7288 subject key is always followed by a dot.
7289
7290
7291
7292
7293 .section "Lookup caching" "SECID64"
7294 .cindex "lookup" "caching"
7295 .cindex "caching" "lookup data"
7296 Exim caches all lookup results in order to avoid needless repetition of
7297 lookups. However, because (apart from the daemon) Exim operates as a collection
7298 of independent, short-lived processes, this caching applies only within a
7299 single Exim process. There is no inter-process lookup caching facility.
7300
7301 For single-key lookups, Exim keeps the relevant files open in case there is
7302 another lookup that needs them. In some types of configuration this can lead to
7303 many files being kept open for messages with many recipients. To avoid hitting
7304 the operating system limit on the number of simultaneously open files, Exim
7305 closes the least recently used file when it needs to open more files than its
7306 own internal limit, which can be changed via the &%lookup_open_max%& option.
7307
7308 The single-key lookup files are closed and the lookup caches are flushed at
7309 strategic points during delivery &-- for example, after all routing is
7310 complete.
7311
7312
7313
7314
7315 .section "Quoting lookup data" "SECID65"
7316 .cindex "lookup" "quoting"
7317 .cindex "quoting" "in lookups"
7318 When data from an incoming message is included in a query-style lookup, there
7319 is the possibility of special characters in the data messing up the syntax of
7320 the query. For example, a NIS+ query that contains
7321 .code
7322 [name=$local_part]
7323 .endd
7324 will be broken if the local part happens to contain a closing square bracket.
7325 For NIS+, data can be enclosed in double quotes like this:
7326 .code
7327 [name="$local_part"]
7328 .endd
7329 but this still leaves the problem of a double quote in the data. The rule for
7330 NIS+ is that double quotes must be doubled. Other lookup types have different
7331 rules, and to cope with the differing requirements, an expansion operator
7332 of the following form is provided:
7333 .code
7334 ${quote_<lookup-type>:<string>}
7335 .endd
7336 For example, the safest way to write the NIS+ query is
7337 .code
7338 [name="${quote_nisplus:$local_part}"]
7339 .endd
7340 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7341 operator can be used for all lookup types, but has no effect for single-key
7342 lookups, since no quoting is ever needed in their key strings.
7343
7344
7345
7346
7347 .section "More about dnsdb" "SECTdnsdb"
7348 .cindex "dnsdb lookup"
7349 .cindex "lookup" "dnsdb"
7350 .cindex "DNS" "as a lookup type"
7351 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7352 of a record type and a domain name, separated by an equals sign. For example,
7353 an expansion string could contain:
7354 .code
7355 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7356 .endd
7357 If the lookup succeeds, the result is placed in &$value$&, which in this case
7358 is used on its own as the result. If the lookup does not succeed, the
7359 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7360 &<<SECTforexpfai>>& for an explanation of what this means.
7361
7362 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7363 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7364 If no type is given, TXT is assumed.
7365
7366 For any record type, if multiple records are found, the data is returned as a
7367 concatenation, with newline as the default separator. The order, of course,
7368 depends on the DNS resolver. You can specify a different separator character
7369 between multiple records by putting a right angle-bracket followed immediately
7370 by the new separator at the start of the query. For example:
7371 .code
7372 ${lookup dnsdb{>: a=host1.example}}
7373 .endd
7374 It is permitted to specify a space as the separator character. Further
7375 white space is ignored.
7376 For lookup types that return multiple fields per record,
7377 an alternate field separator can be specified using a comma after the main
7378 separator character, followed immediately by the field separator.
7379
7380 .cindex "PTR record" "in &(dnsdb)& lookup"
7381 When the type is PTR,
7382 the data can be an IP address, written as normal; inversion and the addition of
7383 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7384 .code
7385 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7386 .endd
7387 If the data for a PTR record is not a syntactically valid IP address, it is not
7388 altered and nothing is added.
7389
7390 .cindex "MX record" "in &(dnsdb)& lookup"
7391 .cindex "SRV record" "in &(dnsdb)& lookup"
7392 For an MX lookup, both the preference value and the host name are returned for
7393 each record, separated by a space. For an SRV lookup, the priority, weight,
7394 port, and host name are returned for each record, separated by spaces.
7395 The field separator can be modified as above.
7396
7397 .cindex "TXT record" "in &(dnsdb)& lookup"
7398 .cindex "SPF record" "in &(dnsdb)& lookup"
7399 For TXT records with multiple items of data, only the first item is returned,
7400 unless a field separator is specified.
7401 To concatenate items without a separator, use a semicolon instead.
7402 For SPF records the
7403 default behaviour is to concatenate multiple items without using a separator.
7404 .code
7405 ${lookup dnsdb{>\n,: txt=a.b.example}}
7406 ${lookup dnsdb{>\n; txt=a.b.example}}
7407 ${lookup dnsdb{spf=example.org}}
7408 .endd
7409 It is permitted to specify a space as the separator character. Further
7410 white space is ignored.
7411
7412 .cindex "SOA record" "in &(dnsdb)& lookup"
7413 For an SOA lookup, while no result is obtained the lookup is redone with
7414 successively more leading components dropped from the given domain.
7415 Only the primary-nameserver field is returned unless a field separator is
7416 specified.
7417 .code
7418 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7419 .endd
7420
7421 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7422 .cindex "dnsdb modifiers"
7423 .cindex "modifiers" "dnsdb"
7424 .cindex "options" "dnsdb"
7425 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7426 each followed by a comma,
7427 that may appear before the record type.
7428
7429 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7430 temporary DNS error for any of them, the behaviour is controlled by
7431 a defer-option modifier.
7432 The possible keywords are
7433 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7434 With &"strict"& behaviour, any temporary DNS error causes the
7435 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7436 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7437 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7438 error causes the whole lookup to defer only if none of the other lookups
7439 succeed. The default is &"lax"&, so the following lookups are equivalent:
7440 .code
7441 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7442 ${lookup dnsdb{a=one.host.com:two.host.com}}
7443 .endd
7444 Thus, in the default case, as long as at least one of the DNS lookups
7445 yields some data, the lookup succeeds.
7446
7447 .cindex "DNSSEC" "dns lookup"
7448 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7449 The possible keywords are
7450 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7451 With &"strict"& or &"lax"& DNSSEC information is requested
7452 with the lookup.
7453 With &"strict"& a response from the DNS resolver that
7454 is not labelled as authenticated data
7455 is treated as equivalent to a temporary DNS error.
7456 The default is &"lax"&.
7457
7458 See also the &$lookup_dnssec_authenticated$& variable.
7459
7460 .cindex timeout "dns lookup"
7461 .cindex "DNS" timeout
7462 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7463 The form is &"retrans_VAL"& where VAL is an Exim time specification
7464 (e.g. &"5s"&).
7465 The default value is set by the main configuration option &%dns_retrans%&.
7466
7467 Retries for the dnsdb lookup can be controlled by a retry modifier.
7468 The form if &"retry_VAL"& where VAL is an integer.
7469 The default count is set by the main configuration option &%dns_retry%&.
7470
7471 .cindex caching "of dns lookup"
7472 .cindex TTL "of dns lookup"
7473 .cindex DNS TTL
7474 Dnsdb lookup results are cached within a single process (and its children).
7475 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7476 value of the set of returned DNS records.
7477
7478
7479 .section "Pseudo dnsdb record types" "SECID66"
7480 .cindex "MX record" "in &(dnsdb)& lookup"
7481 By default, both the preference value and the host name are returned for
7482 each MX record, separated by a space. If you want only host names, you can use
7483 the pseudo-type MXH:
7484 .code
7485 ${lookup dnsdb{mxh=a.b.example}}
7486 .endd
7487 In this case, the preference values are omitted, and just the host names are
7488 returned.
7489
7490 .cindex "name server for enclosing domain"
7491 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7492 records on the given domain, but if none are found, it removes the first
7493 component of the domain name, and tries again. This process continues until NS
7494 records are found or there are no more components left (or there is a DNS
7495 error). In other words, it may return the name servers for a top-level domain,
7496 but it never returns the root name servers. If there are no NS records for the
7497 top-level domain, the lookup fails. Consider these examples:
7498 .code
7499 ${lookup dnsdb{zns=xxx.quercite.com}}
7500 ${lookup dnsdb{zns=xxx.edu}}
7501 .endd
7502 Assuming that in each case there are no NS records for the full domain name,
7503 the first returns the name servers for &%quercite.com%&, and the second returns
7504 the name servers for &%edu%&.
7505
7506 You should be careful about how you use this lookup because, unless the
7507 top-level domain does not exist, the lookup always returns some host names. The
7508 sort of use to which this might be put is for seeing if the name servers for a
7509 given domain are on a blacklist. You can probably assume that the name servers
7510 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7511 such a list.
7512
7513 .cindex "CSA" "in &(dnsdb)& lookup"
7514 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7515 records according to the CSA rules, which are described in section
7516 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7517 not sufficient because of the extra parent domain search behaviour of CSA. The
7518 result of a successful lookup such as:
7519 .code
7520 ${lookup dnsdb {csa=$sender_helo_name}}
7521 .endd
7522 has two space-separated fields: an authorization code and a target host name.
7523 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7524 authorization required but absent, or &"?"& for unknown.
7525
7526 .cindex "A+" "in &(dnsdb)& lookup"
7527 The pseudo-type A+ performs an AAAA
7528 and then an A lookup.  All results are returned; defer processing
7529 (see below) is handled separately for each lookup.  Example:
7530 .code
7531 ${lookup dnsdb {>; a+=$sender_helo_name}}
7532 .endd
7533
7534
7535 .section "Multiple dnsdb lookups" "SECID67"
7536 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7537 However, you can specify a list of domains or IP addresses in a single
7538 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7539 the default separator, but with the ability to change this. For example:
7540 .code
7541 ${lookup dnsdb{one.domain.com:two.domain.com}}
7542 ${lookup dnsdb{a=one.host.com:two.host.com}}
7543 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7544 .endd
7545 In order to retain backwards compatibility, there is one special case: if
7546 the lookup type is PTR and no change of separator is specified, Exim looks
7547 to see if the rest of the string is precisely one IPv6 address. In this
7548 case, it does not treat it as a list.
7549
7550 The data from each lookup is concatenated, with newline separators by default,
7551 in the same way that multiple DNS records for a single item are handled. A
7552 different separator can be specified, as described above.
7553
7554
7555
7556
7557 .section "More about LDAP" "SECTldap"
7558 .cindex "LDAP" "lookup, more about"
7559 .cindex "lookup" "LDAP"
7560 .cindex "Solaris" "LDAP"
7561 The original LDAP implementation came from the University of Michigan; this has
7562 become &"Open LDAP"&, and there are now two different releases. Another
7563 implementation comes from Netscape, and Solaris 7 and subsequent releases
7564 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7565 the lookup function level, their error handling is different. For this reason
7566 it is necessary to set a compile-time variable when building Exim with LDAP, to
7567 indicate which LDAP library is in use. One of the following should appear in
7568 your &_Local/Makefile_&:
7569 .code
7570 LDAP_LIB_TYPE=UMICHIGAN
7571 LDAP_LIB_TYPE=OPENLDAP1
7572 LDAP_LIB_TYPE=OPENLDAP2
7573 LDAP_LIB_TYPE=NETSCAPE
7574 LDAP_LIB_TYPE=SOLARIS
7575 .endd
7576 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7577 same interface as the University of Michigan version.
7578
7579 There are three LDAP lookup types in Exim. These behave slightly differently in
7580 the way they handle the results of a query:
7581
7582 .ilist
7583 &(ldap)& requires the result to contain just one entry; if there are more, it
7584 gives an error.
7585 .next
7586 &(ldapdn)& also requires the result to contain just one entry, but it is the
7587 Distinguished Name that is returned rather than any attribute values.
7588 .next
7589 &(ldapm)& permits the result to contain more than one entry; the attributes
7590 from all of them are returned.
7591 .endlist
7592
7593
7594 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7595 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7596 the data returned by a successful lookup is described in the next section.
7597 First we explain how LDAP queries are coded.
7598
7599
7600 .section "Format of LDAP queries" "SECTforldaque"
7601 .cindex "LDAP" "query format"
7602 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7603 the configuration of a &(redirect)& router one might have this setting:
7604 .code
7605 data = ${lookup ldap \
7606   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7607   c=UK?mailbox?base?}}
7608 .endd
7609 .cindex "LDAP" "with TLS"
7610 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7611 secure (encrypted) LDAP connections. The second of these ensures that an
7612 encrypted TLS connection is used.
7613
7614 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7615 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7616 See the &%ldap_start_tls%& option.
7617
7618 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7619 controlled. Every part of the TLS configuration can be configured by settings in
7620 &_exim.conf_&. Depending on the version of the client libraries installed on
7621 your system, some of the initialization may have required setting options in
7622 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7623 certificates. This revealed a nuance where the current UID that exim was
7624 running as could affect which config files it read. With Exim 4.83, these
7625 methods become optional, only taking effect if not specifically set in
7626 &_exim.conf_&.
7627
7628
7629 .section "LDAP quoting" "SECID68"
7630 .cindex "LDAP" "quoting"
7631 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7632 and the second because the LDAP query is represented as a URL. Furthermore,
7633 within an LDAP query, two different kinds of quoting are required. For this
7634 reason, there are two different LDAP-specific quoting operators.
7635
7636 The &%quote_ldap%& operator is designed for use on strings that are part of
7637 filter specifications. Conceptually, it first does the following conversions on
7638 the string:
7639 .code
7640 *   =>   \2A
7641 (   =>   \28
7642 )   =>   \29
7643 \   =>   \5C
7644 .endd
7645 in accordance with RFC 2254. The resulting string is then quoted according
7646 to the rules for URLs, that is, all non-alphanumeric characters except
7647 .code
7648 ! $ ' - . _ ( ) * +
7649 .endd
7650 are converted to their hex values, preceded by a percent sign. For example:
7651 .code
7652 ${quote_ldap: a(bc)*, a<yz>; }
7653 .endd
7654 yields
7655 .code
7656 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7657 .endd
7658 Removing the URL quoting, this is (with a leading and a trailing space):
7659 .code
7660 a\28bc\29\2A, a<yz>;
7661 .endd
7662 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7663 base DN specifications in queries. Conceptually, it first converts the string
7664 by inserting a backslash in front of any of the following characters:
7665 .code
7666 , + " \ < > ;
7667 .endd
7668 It also inserts a backslash before any leading spaces or # characters, and
7669 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7670 is then quoted according to the rules for URLs. For example:
7671 .code
7672 ${quote_ldap_dn: a(bc)*, a<yz>; }
7673 .endd
7674 yields
7675 .code
7676 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7677 .endd
7678 Removing the URL quoting, this is (with a trailing space):
7679 .code
7680 \ a(bc)*\, a\<yz\>\;\
7681 .endd
7682 There are some further comments about quoting in the section on LDAP
7683 authentication below.
7684
7685
7686 .section "LDAP connections" "SECID69"
7687 .cindex "LDAP" "connections"
7688 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7689 is in use, via a Unix domain socket. The example given above does not specify
7690 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7691 by starting it with
7692 .code
7693 ldap://<hostname>:<port>/...
7694 .endd
7695 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7696 used. When no server is specified in a query, a list of default servers is
7697 taken from the &%ldap_default_servers%& configuration option. This supplies a
7698 colon-separated list of servers which are tried in turn until one successfully
7699 handles a query, or there is a serious error. Successful handling either
7700 returns the requested data, or indicates that it does not exist. Serious errors
7701 are syntactical, or multiple values when only a single value is expected.
7702 Errors which cause the next server to be tried are connection failures, bind
7703 failures, and timeouts.
7704
7705 For each server name in the list, a port number can be given. The standard way
7706 of specifying a host and port is to use a colon separator (RFC 1738). Because
7707 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7708 doubled. For example
7709 .code
7710 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7711 .endd
7712 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7713 to the LDAP library with no server name, and the library's default (normally
7714 the local host) is used.
7715
7716 If you are using the OpenLDAP library, you can connect to an LDAP server using
7717 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7718 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7719 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7720 not available.
7721
7722 For this type of connection, instead of a host name for the server, a pathname
7723 for the socket is required, and the port number is not relevant. The pathname
7724 can be specified either as an item in &%ldap_default_servers%&, or inline in
7725 the query. In the former case, you can have settings such as
7726 .code
7727 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7728 .endd
7729 When the pathname is given in the query, you have to escape the slashes as
7730 &`%2F`& to fit in with the LDAP URL syntax. For example:
7731 .code
7732 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7733 .endd
7734 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7735 a pathname, it uses the Unix domain socket code, even if the query actually
7736 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7737 socket connection. This behaviour means that you can use a setting of
7738 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7739 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7740 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7741 backup host.
7742
7743 If an explicit &`ldapi`& type is given in a query when a host name is
7744 specified, an error is diagnosed. However, if there are more items in
7745 &%ldap_default_servers%&, they are tried. In other words:
7746
7747 .ilist
7748 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7749 interface.
7750 .next
7751 Using &`ldapi`& with a host name causes an error.
7752 .endlist
7753
7754
7755 Using &`ldapi`& with no host or path in the query, and no setting of
7756 &%ldap_default_servers%&, does whatever the library does by default.
7757
7758
7759
7760 .section "LDAP authentication and control information" "SECID70"
7761 .cindex "LDAP" "authentication"
7762 The LDAP URL syntax provides no way of passing authentication and other control
7763 information to the server. To make this possible, the URL in an LDAP query may
7764 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7765 spaces. If a value contains spaces it must be enclosed in double quotes, and
7766 when double quotes are used, backslash is interpreted in the usual way inside
7767 them. The following names are recognized:
7768 .display
7769 &`DEREFERENCE`&  set the dereferencing parameter
7770 &`NETTIME    `&  set a timeout for a network operation
7771 &`USER       `&  set the DN, for authenticating the LDAP bind
7772 &`PASS       `&  set the password, likewise
7773 &`REFERRALS  `&  set the referrals parameter
7774 &`SERVERS    `&  set alternate server list for this query only
7775 &`SIZE       `&  set the limit for the number of entries returned
7776 &`TIME       `&  set the maximum waiting time for a query
7777 .endd
7778 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7779 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7780 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7781 library from trying to follow referrals issued by the LDAP server.
7782
7783 .cindex LDAP timeout
7784 .cindex timeout "LDAP lookup"
7785 The name CONNECT is an obsolete name for NETTIME, retained for
7786 backwards compatibility. This timeout (specified as a number of seconds) is
7787 enforced from the client end for operations that can be carried out over a
7788 network. Specifically, it applies to network connections and calls to the
7789 &'ldap_result()'& function. If the value is greater than zero, it is used if
7790 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7791 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7792 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7793 Netscape SDK; for OpenLDAP no action is taken.
7794
7795 The TIME parameter (also a number of seconds) is passed to the server to
7796 set a server-side limit on the time taken to complete a search.
7797
7798 The SERVERS parameter allows you to specify an alternate list of ldap servers
7799 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7800 default list of ldap servers, and a single lookup can specify a single ldap
7801 server to use.  But when you need to do a lookup with a list of servers that is
7802 different than the default list (maybe different order, maybe a completely
7803 different set of servers), the SERVERS parameter allows you to specify this
7804 alternate list (colon-separated).
7805
7806 Here is an example of an LDAP query in an Exim lookup that uses some of these
7807 values. This is a single line, folded to fit on the page:
7808 .code
7809 ${lookup ldap
7810   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7811   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7812   {$value}fail}
7813 .endd
7814 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7815 any of the auxiliary data. Exim configuration settings that include lookups
7816 which contain password information should be preceded by &"hide"& to prevent
7817 non-admin users from using the &%-bP%& option to see their values.
7818
7819 The auxiliary data items may be given in any order. The default is no
7820 connection timeout (the system timeout is used), no user or password, no limit
7821 on the number of entries returned, and no time limit on queries.
7822
7823 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7824 removes any URL quoting that it may contain before passing it LDAP. Apparently
7825 some libraries do this for themselves, but some do not. Removing the URL
7826 quoting has two advantages:
7827
7828 .ilist
7829 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7830 DNs as with DNs inside actual queries.
7831 .next
7832 It permits spaces inside USER= DNs.
7833 .endlist
7834
7835 For example, a setting such as
7836 .code
7837 USER=cn=${quote_ldap_dn:$1}
7838 .endd
7839 should work even if &$1$& contains spaces.
7840
7841 Expanded data for the PASS= value should be quoted using the &%quote%&
7842 expansion operator, rather than the LDAP quote operators. The only reason this
7843 field needs quoting is to ensure that it conforms to the Exim syntax, which
7844 does not allow unquoted spaces. For example:
7845 .code
7846 PASS=${quote:$3}
7847 .endd
7848 The LDAP authentication mechanism can be used to check passwords as part of
7849 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7850 &<<CHAPexpand>>&.
7851
7852
7853
7854 .section "Format of data returned by LDAP" "SECID71"
7855 .cindex "LDAP" "returned data formats"
7856 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7857 as a sequence of values, for example
7858 .code
7859 cn=manager,o=University of Cambridge,c=UK
7860 .endd
7861 The &(ldap)& lookup type generates an error if more than one entry matches the
7862 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7863 the result between the data from different entries. It is possible for multiple
7864 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7865 you know that whatever values are returned all came from a single entry in the
7866 directory.
7867
7868 In the common case where you specify a single attribute in your LDAP query, the
7869 result is not quoted, and does not contain the attribute name. If the attribute
7870 has multiple values, they are separated by commas. Any comma that is
7871 part of an attribute's value is doubled.
7872
7873 If you specify multiple attributes, the result contains space-separated, quoted
7874 strings, each preceded by the attribute name and an equals sign. Within the
7875 quotes, the quote character, backslash, and newline are escaped with
7876 backslashes, and commas are used to separate multiple values for the attribute.
7877 Any commas in attribute values are doubled
7878 (permitting treatment of the values as a comma-separated list).
7879 Apart from the escaping, the string within quotes takes the same form as the
7880 output when a single attribute is requested. Specifying no attributes is the
7881 same as specifying all of an entry's attributes.
7882
7883 Here are some examples of the output format. The first line of each pair is an
7884 LDAP query, and the second is the data that is returned. The attribute called
7885 &%attr1%& has two values, one of them with an embedded comma, whereas
7886 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7887 (they have SUP &%attr%& in their schema definitions).
7888
7889 .code
7890 ldap:///o=base?attr1?sub?(uid=fred)
7891 value1.1,value1,,2
7892
7893 ldap:///o=base?attr2?sub?(uid=fred)
7894 value two
7895
7896 ldap:///o=base?attr?sub?(uid=fred)
7897 value1.1,value1,,2,value two
7898
7899 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7900 attr1="value1.1,value1,,2" attr2="value two"
7901
7902 ldap:///o=base??sub?(uid=fred)
7903 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7904 .endd
7905 You can
7906 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7907 results of LDAP lookups.
7908 The &%extract%& operator in string expansions can be used to pick out
7909 individual fields from data that consists of &'key'&=&'value'& pairs.
7910 The &%listextract%& operator should be used to pick out individual values
7911 of attributes, even when only a single value is expected.
7912 The doubling of embedded commas allows you to use the returned data as a
7913 comma separated list (using the "<," syntax for changing the input list separator).
7914
7915
7916
7917
7918 .section "More about NIS+" "SECTnisplus"
7919 .cindex "NIS+ lookup type"
7920 .cindex "lookup" "NIS+"
7921 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7922 and field name. If this is given, the result of a successful query is the
7923 contents of the named field; otherwise the result consists of a concatenation
7924 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7925 values containing spaces are quoted. For example, the query
7926 .code
7927 [name=mg1456],passwd.org_dir
7928 .endd
7929 might return the string
7930 .code
7931 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7932 home=/home/mg1456 shell=/bin/bash shadow=""
7933 .endd
7934 (split over two lines here to fit on the page), whereas
7935 .code
7936 [name=mg1456],passwd.org_dir:gcos
7937 .endd
7938 would just return
7939 .code
7940 Martin Guerre
7941 .endd
7942 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7943 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7944 operator is to double any quote characters within the text.
7945
7946
7947
7948 .section "SQL lookups" "SECTsql"
7949 .cindex "SQL lookup types"
7950 .cindex "MySQL" "lookup type"
7951 .cindex "PostgreSQL lookup type"
7952 .cindex "lookup" "MySQL"
7953 .cindex "lookup" "PostgreSQL"
7954 .cindex "Oracle" "lookup type"
7955 .cindex "lookup" "Oracle"
7956 .cindex "InterBase lookup type"
7957 .cindex "lookup" "InterBase"
7958 .cindex "Redis lookup type"
7959 .cindex lookup Redis
7960 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7961 and SQLite
7962 databases. Queries for these databases contain SQL statements, so an example
7963 might be
7964 .code
7965 ${lookup mysql{select mailbox from users where id='userx'}\
7966   {$value}fail}
7967 .endd
7968 If the result of the query contains more than one field, the data for each
7969 field in the row is returned, preceded by its name, so the result of
7970 .code
7971 ${lookup pgsql{select home,name from users where id='userx'}\
7972   {$value}}
7973 .endd
7974 might be
7975 .code
7976 home=/home/userx name="Mister X"
7977 .endd
7978 Empty values and values containing spaces are double quoted, with embedded
7979 quotes escaped by a backslash. If the result of the query contains just one
7980 field, the value is passed back verbatim, without a field name, for example:
7981 .code
7982 Mister X
7983 .endd
7984 If the result of the query yields more than one row, it is all concatenated,
7985 with a newline between the data for each row.
7986
7987
7988 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7989 .cindex "MySQL" "lookup type"
7990 .cindex "PostgreSQL lookup type"
7991 .cindex "lookup" "MySQL"
7992 .cindex "lookup" "PostgreSQL"
7993 .cindex "Oracle" "lookup type"
7994 .cindex "lookup" "Oracle"
7995 .cindex "InterBase lookup type"
7996 .cindex "lookup" "InterBase"
7997 .cindex "Redis lookup type"
7998 .cindex lookup Redis
7999 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8000 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8001 or &%redis_servers%&
8002 option (as appropriate) must be set to a colon-separated list of server
8003 information.
8004 .oindex &%mysql_servers%&
8005 .oindex &%pgsql_servers%&
8006 .oindex &%oracle_servers%&
8007 .oindex &%ibase_servers%&
8008 .oindex &%redis_servers%&
8009 (For MySQL and PostgreSQL, the global option need not be set if all
8010 queries contain their own server information &-- see section
8011 &<<SECTspeserque>>&.)
8012 For all but Redis
8013 each item in the list is a slash-separated list of four
8014 items: host name, database name, user name, and password. In the case of
8015 Oracle, the host name field is used for the &"service name"&, and the database
8016 name field is not used and should be empty. For example:
8017 .code
8018 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8019 .endd
8020 Because password data is sensitive, you should always precede the setting with
8021 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8022 option. Here is an example where two MySQL servers are listed:
8023 .code
8024 hide mysql_servers = localhost/users/root/secret:\
8025                      otherhost/users/root/othersecret
8026 .endd
8027 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8028 because this is a colon-separated list, the colon has to be doubled. For each
8029 query, these parameter groups are tried in order until a connection is made and
8030 a query is successfully processed. The result of a query may be that no data is
8031 found, but that is still a successful query. In other words, the list of
8032 servers provides a backup facility, not a list of different places to look.
8033
8034 For Redis the global option need not be specified if all queries contain their
8035 own server information &-- see section &<<SECTspeserque>>&.
8036 If specified, the option must be set to a colon-separated list of server
8037 information.
8038 Each item in the list is a slash-separated list of three items:
8039 host, database number, and password.
8040 .olist
8041 The host is required and may be either an IPv4 address and optional
8042 port number (separated by a colon, which needs doubling due to the
8043 higher-level list), or a Unix socket pathname enclosed in parentheses
8044 .next
8045 The database number is optional; if present that number is selected in the backend
8046 .next
8047 The password is optional; if present it is used to authenticate to the backend
8048 .endlist
8049
8050 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8051 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8052 respectively, and the characters single-quote, double-quote, and backslash
8053 itself are escaped with backslashes.
8054
8055 The &%quote_redis%& expansion operator
8056 escapes whitespace and backslash characters with a backslash.
8057
8058 .section "Specifying the server in the query" "SECTspeserque"
8059 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8060 it is possible to specify a list of servers with an individual query. This is
8061 done by appending a comma-separated option to the query type:
8062 .display
8063 &`,servers=`&&'server1:server2:server3:...'&
8064 .endd
8065 Each item in the list may take one of two forms:
8066 .olist
8067 If it contains no slashes it is assumed to be just a host name. The appropriate
8068 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8069 of the same name, and the remaining parameters (database, user, password) are
8070 taken from there.
8071 .next
8072 If it contains any slashes, it is taken as a complete parameter set.
8073 .endlist
8074 The list of servers is used in exactly the same way as the global list.
8075 Once a connection to a server has happened and a query has been
8076 successfully executed, processing of the lookup ceases.
8077
8078 This feature is intended for use in master/slave situations where updates
8079 are occurring and you want to update the master rather than a slave. If the
8080 master is in the list as a backup for reading, you might have a global setting
8081 like this:
8082 .code
8083 mysql_servers = slave1/db/name/pw:\
8084                 slave2/db/name/pw:\
8085                 master/db/name/pw
8086 .endd
8087 In an updating lookup, you could then write:
8088 .code
8089 ${lookup mysql,servers=master {UPDATE ...} }
8090 .endd
8091 That query would then be sent only to the master server. If, on the other hand,
8092 the master is not to be used for reading, and so is not present in the global
8093 option, you can still update it by a query of this form:
8094 .code
8095 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8096 .endd
8097
8098 An older syntax places the servers specification before the query,
8099 semicolon separated:
8100 .code
8101 ${lookup mysql{servers=master; UPDATE ...} }
8102 .endd
8103 The new version avoids potential issues with tainted
8104 arguments in the query, for explicit expansion.
8105 &*Note*&: server specifications in list-style lookups are still problematic.
8106
8107
8108 .section "Special MySQL features" "SECID73"
8109 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8110 causes a connection to the server on the local host by means of a Unix domain
8111 socket. An alternate socket can be specified in parentheses.
8112 An option group name for MySQL option files can be specified in square brackets;
8113 the default value is &"exim"&.
8114 The full syntax of each item in &%mysql_servers%& is:
8115 .display
8116 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8117   <&'database'&>/<&'user'&>/<&'password'&>
8118 .endd
8119 Any of the four sub-parts of the first field can be omitted. For normal use on
8120 the local host it can be left blank or set to just &"localhost"&.
8121
8122 No database need be supplied &-- but if it is absent here, it must be given in
8123 the queries.
8124
8125 If a MySQL query is issued that does not request any data (an insert, update,
8126 or delete command), the result of the lookup is the number of rows affected.
8127
8128 &*Warning*&: This can be misleading. If an update does not actually change
8129 anything (for example, setting a field to the value it already has), the result
8130 is zero because no rows are affected.
8131
8132
8133 .section "Special PostgreSQL features" "SECID74"
8134 PostgreSQL lookups can also use Unix domain socket connections to the database.
8135 This is usually faster and costs less CPU time than a TCP/IP connection.
8136 However it can be used only if the mail server runs on the same machine as the
8137 database server. A configuration line for PostgreSQL via Unix domain sockets
8138 looks like this:
8139 .code
8140 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8141 .endd
8142 In other words, instead of supplying a host name, a path to the socket is
8143 given. The path name is enclosed in parentheses so that its slashes aren't
8144 visually confused with the delimiters for the other server parameters.
8145
8146 If a PostgreSQL query is issued that does not request any data (an insert,
8147 update, or delete command), the result of the lookup is the number of rows
8148 affected.
8149
8150 .section "More about SQLite" "SECTsqlite"
8151 .cindex "lookup" "SQLite"
8152 .cindex "sqlite lookup type"
8153 SQLite is different to the other SQL lookups because a filename is required in
8154 addition to the SQL query. An SQLite database is a single file, and there is no
8155 daemon as in the other SQL databases.
8156
8157 .new
8158 .oindex &%sqlite_dbfile%&
8159 There are two ways of
8160 specifying the file.
8161 The first is is by using the &%sqlite_dbfile%& main option.
8162 The second, which allows separate files for each query,
8163 is to use an option appended, comma-separated, to the &"sqlite"&
8164 lookup type word.  The option is the word &"file"&, then an equals,
8165 then the filename.
8166 The filename in this case cannot contain whitespace or open-brace charachters.
8167 .wen
8168
8169 A deprecated method is available, prefixing the query with the filename
8170 separated by white space.
8171 This means that
8172 .cindex "tainted data" "sqlite file"
8173 the query cannot use any tainted values, as that taints
8174 the entire query including the filename - resulting in a refusal to open
8175 the file.
8176
8177 In all the above cases the filename must be an absolute path.
8178
8179 Here is a lookup expansion example:
8180 .code
8181 sqlite_dbfile = /some/thing/sqlitedb
8182 ...
8183 ${lookup sqlite {select name from aliases where id='userx';}}
8184 .endd
8185 In a list, the syntax is similar. For example:
8186 .code
8187 domainlist relay_to_domains = sqlite;\
8188    select * from relays where ip='$sender_host_address';
8189 .endd
8190 The only character affected by the &%quote_sqlite%& operator is a single
8191 quote, which it doubles.
8192
8193 .cindex timeout SQLite
8194 .cindex sqlite "lookup timeout"
8195 The SQLite library handles multiple simultaneous accesses to the database
8196 internally. Multiple readers are permitted, but only one process can
8197 update at once. Attempts to access the database while it is being updated
8198 are rejected after a timeout period, during which the SQLite library
8199 waits for the lock to be released. In Exim, the default timeout is set
8200 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8201 option.
8202
8203 .section "More about Redis" "SECTredis"
8204 .cindex "lookup" "Redis"
8205 .cindex "redis lookup type"
8206 Redis is a non-SQL database. Commands are simple get and set.
8207 Examples:
8208 .code
8209 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8210 ${lookup redis{get keyname}}
8211 .endd
8212
8213 As of release 4.91, "lightweight" support for Redis Cluster is available.
8214 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8215 of which must be reachable from the running exim instance. If the cluster has
8216 master/slave replication, the list must contain all the master and slave
8217 servers.
8218
8219 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8220 immediately follow the redirection but treats the response as a DEFER, moving on
8221 to the next server in the &%redis_servers%& list until the correct server is
8222 reached.
8223
8224 .ecindex IIDfidalo1
8225 .ecindex IIDfidalo2
8226
8227
8228 . ////////////////////////////////////////////////////////////////////////////
8229 . ////////////////////////////////////////////////////////////////////////////
8230
8231 .chapter "Domain, host, address, and local part lists" &&&
8232          "CHAPdomhosaddlists" &&&
8233          "Domain, host, and address lists"
8234 .scindex IIDdohoadli "lists of domains; hosts; etc."
8235 A number of Exim configuration options contain lists of domains, hosts,
8236 email addresses, or local parts. For example, the &%hold_domains%& option
8237 contains a list of domains whose delivery is currently suspended. These lists
8238 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8239 arguments to expansion conditions such as &%match_domain%&.
8240
8241 Each item in one of these lists is a pattern to be matched against a domain,
8242 host, email address, or local part, respectively. In the sections below, the
8243 different types of pattern for each case are described, but first we cover some
8244 general facilities that apply to all four kinds of list.
8245
8246 Note that other parts of Exim use a &'string list'& which does not
8247 support all the complexity available in
8248 domain, host, address and local part lists.
8249
8250
8251
8252 .section "Expansion of lists" "SECTlistexpand"
8253 .cindex "expansion" "of lists"
8254 Each list is expanded as a single string before it is used.
8255
8256 &'Exception: the router headers_remove option, where list-item
8257 splitting is done before string-expansion.'&
8258
8259 The result of
8260 expansion must be a list, possibly containing empty items, which is split up
8261 into separate items for matching. By default, colon is the separator character,
8262 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8263 &<<SECTempitelis>>& for details of the list syntax; the second of these
8264 discusses the way to specify empty list items.
8265
8266
8267 If the string expansion is forced to fail, Exim behaves as if the item it is
8268 testing (domain, host, address, or local part) is not in the list. Other
8269 expansion failures cause temporary errors.
8270
8271 If an item in a list is a regular expression, backslashes, dollars and possibly
8272 other special characters in the expression must be protected against
8273 misinterpretation by the string expander. The easiest way to do this is to use
8274 the &`\N`& expansion feature to indicate that the contents of the regular
8275 expression should not be expanded. For example, in an ACL you might have:
8276 .code
8277 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8278                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8279 .endd
8280 The first item is a regular expression that is protected from expansion by
8281 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8282 senders based on the receiving domain.
8283
8284
8285
8286
8287 .section "Negated items in lists" "SECID76"
8288 .cindex "list" "negation"
8289 .cindex "negation" "in lists"
8290 Items in a list may be positive or negative. Negative items are indicated by a
8291 leading exclamation mark, which may be followed by optional white space. A list
8292 defines a set of items (domains, etc). When Exim processes one of these lists,
8293 it is trying to find out whether a domain, host, address, or local part
8294 (respectively) is in the set that is defined by the list. It works like this:
8295
8296 The list is scanned from left to right. If a positive item is matched, the
8297 subject that is being checked is in the set; if a negative item is matched, the
8298 subject is not in the set. If the end of the list is reached without the
8299 subject having matched any of the patterns, it is in the set if the last item
8300 was a negative one, but not if it was a positive one. For example, the list in
8301 .code
8302 domainlist relay_to_domains = !a.b.c : *.b.c
8303 .endd
8304 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8305 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8306 list is positive. However, if the setting were
8307 .code
8308 domainlist relay_to_domains = !a.b.c
8309 .endd
8310 then all domains other than &'a.b.c'& would match because the last item in the
8311 list is negative. In other words, a list that ends with a negative item behaves
8312 as if it had an extra item &`:*`& on the end.
8313
8314 Another way of thinking about positive and negative items in lists is to read
8315 the connector as &"or"& after a positive item and as &"and"& after a negative
8316 item.
8317
8318
8319
8320 .section "File names in lists" "SECTfilnamlis"
8321 .cindex "list" "filename in"
8322 If an item in a domain, host, address, or local part list is an absolute
8323 filename (beginning with a slash character), each line of the file is read and
8324 processed as if it were an independent item in the list, except that further
8325 filenames are not allowed,
8326 and no expansion of the data from the file takes place.
8327 Empty lines in the file are ignored, and the file may also contain comment
8328 lines:
8329
8330 .ilist
8331 For domain and host lists, if a # character appears anywhere in a line of the
8332 file, it and all following characters are ignored.
8333 .next
8334 Because local parts may legitimately contain # characters, a comment in an
8335 address list or local part list file is recognized only if # is preceded by
8336 white space or the start of the line. For example:
8337 .code
8338 not#comment@x.y.z   # but this is a comment
8339 .endd
8340 .endlist
8341
8342 Putting a filename in a list has the same effect as inserting each line of the
8343 file as an item in the list (blank lines and comments excepted). However, there
8344 is one important difference: the file is read each time the list is processed,
8345 so if its contents vary over time, Exim's behaviour changes.
8346
8347 If a filename is preceded by an exclamation mark, the sense of any match
8348 within the file is inverted. For example, if
8349 .code
8350 hold_domains = !/etc/nohold-domains
8351 .endd
8352 and the file contains the lines
8353 .code
8354 !a.b.c
8355 *.b.c
8356 .endd
8357 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8358 any domain matching &`*.b.c`& is not.
8359
8360
8361
8362 .section "An lsearch file is not an out-of-line list" "SECID77"
8363 As will be described in the sections that follow, lookups can be used in lists
8364 to provide indexed methods of checking list membership. There has been some
8365 confusion about the way &(lsearch)& lookups work in lists. Because
8366 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8367 sometimes thought that it is allowed to contain wild cards and other kinds of
8368 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8369 always fixed strings, just as for any other single-key lookup type.
8370
8371 If you want to use a file to contain wild-card patterns that form part of a
8372 list, just give the filename on its own, without a search type, as described
8373 in the previous section. You could also use the &(wildlsearch)& or
8374 &(nwildlsearch)&, but there is no advantage in doing this.
8375
8376
8377
8378
8379 .section "Results of list checking" SECTlistresults
8380 The primary result of doing a list check is a truth value.
8381 In some contexts additional information is stored
8382 about the list element that matched:
8383 .vlist
8384 .vitem hosts
8385 A &%hosts%& ACL condition
8386 will store a result in the &$host_data$& variable.
8387 .vitem local_parts
8388 A &%local_parts%& router option or &%local_parts%& ACL condition
8389 will store a result in the &$local_part_data$& variable.
8390 .vitem domains
8391 A &%domains%& router option or &%domains%& ACL condition
8392 .vitem senders
8393 A &%senders%& router option or &%senders%& ACL condition
8394 will store a result in the &$sender_data$& variable.
8395 .vitem recipients
8396 A &%recipients%& ACL condition
8397 will store a result in the &$recipient_data$& variable.
8398 .endlist
8399
8400 The detail of the additional information depends on the
8401 type of match and is given below as the &*value*& information.
8402
8403
8404
8405
8406 .section "Named lists" "SECTnamedlists"
8407 .cindex "named lists"
8408 .cindex "list" "named"
8409 A list of domains, hosts, email addresses, or local parts can be given a name
8410 which is then used to refer to the list elsewhere in the configuration. This is
8411 particularly convenient if the same list is required in several different
8412 places. It also allows lists to be given meaningful names, which can improve
8413 the readability of the configuration. For example, it is conventional to define
8414 a domain list called &'local_domains'& for all the domains that are handled
8415 locally on a host, using a configuration line such as
8416 .code
8417 domainlist local_domains = localhost:my.dom.example
8418 .endd
8419 Named lists are referenced by giving their name preceded by a plus sign, so,
8420 for example, a router that is intended to handle local domains would be
8421 configured with the line
8422 .code
8423 domains = +local_domains
8424 .endd
8425 The first router in a configuration is often one that handles all domains
8426 except the local ones, using a configuration with a negated item like this:
8427 .code
8428 dnslookup:
8429   driver = dnslookup
8430   domains = ! +local_domains
8431   transport = remote_smtp
8432   no_more
8433 .endd
8434 The four kinds of named list are created by configuration lines starting with
8435 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8436 respectively. Then there follows the name that you are defining, followed by an
8437 equals sign and the list itself. For example:
8438 .code
8439 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8440 addresslist bad_senders = cdb;/etc/badsenders
8441 .endd
8442 A named list may refer to other named lists:
8443 .code
8444 domainlist  dom1 = first.example : second.example
8445 domainlist  dom2 = +dom1 : third.example
8446 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8447 .endd
8448 &*Warning*&: If the last item in a referenced list is a negative one, the
8449 effect may not be what you intended, because the negation does not propagate
8450 out to the higher level. For example, consider:
8451 .code
8452 domainlist  dom1 = !a.b
8453 domainlist  dom2 = +dom1 : *.b
8454 .endd
8455 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8456 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8457 means it matches the second list as well. The effect is not the same as
8458 .code
8459 domainlist  dom2 = !a.b : *.b
8460 .endd
8461 where &'x.y'& does not match. It's best to avoid negation altogether in
8462 referenced lists if you can.
8463
8464 .cindex "hiding named list values"
8465 .cindex "named lists" "hiding value of"
8466 Some named list definitions may contain sensitive data, for example, passwords for
8467 accessing databases. To stop non-admin users from using the &%-bP%& command
8468 line option to read these values, you can precede the definition with the
8469 word &"hide"&. For example:
8470 .code
8471 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8472 .endd
8473
8474
8475 Named lists may have a performance advantage. When Exim is routing an
8476 address or checking an incoming message, it caches the result of tests on named
8477 lists. So, if you have a setting such as
8478 .code
8479 domains = +local_domains
8480 .endd
8481 on several of your routers
8482 or in several ACL statements,
8483 the actual test is done only for the first one. However, the caching works only
8484 if there are no expansions within the list itself or any sublists that it
8485 references. In other words, caching happens only for lists that are known to be
8486 the same each time they are referenced.
8487
8488 By default, there may be up to 16 named lists of each type. This limit can be
8489 extended by changing a compile-time variable. The use of domain and host lists
8490 is recommended for concepts such as local domains, relay domains, and relay
8491 hosts. The default configuration is set up like this.
8492
8493
8494
8495 .section "Named lists compared with macros" "SECID78"
8496 .cindex "list" "named compared with macro"
8497 .cindex "macro" "compared with named list"
8498 At first sight, named lists might seem to be no different from macros in the
8499 configuration file. However, macros are just textual substitutions. If you
8500 write
8501 .code
8502 ALIST = host1 : host2
8503 auth_advertise_hosts = !ALIST
8504 .endd
8505 it probably won't do what you want, because that is exactly the same as
8506 .code
8507 auth_advertise_hosts = !host1 : host2
8508 .endd
8509 Notice that the second host name is not negated. However, if you use a host
8510 list, and write
8511 .code
8512 hostlist alist = host1 : host2
8513 auth_advertise_hosts = ! +alist
8514 .endd
8515 the negation applies to the whole list, and so that is equivalent to
8516 .code
8517 auth_advertise_hosts = !host1 : !host2
8518 .endd
8519
8520
8521 .section "Named list caching" "SECID79"
8522 .cindex "list" "caching of named"
8523 .cindex "caching" "named lists"
8524 While processing a message, Exim caches the result of checking a named list if
8525 it is sure that the list is the same each time. In practice, this means that
8526 the cache operates only if the list contains no $ characters, which guarantees
8527 that it will not change when it is expanded. Sometimes, however, you may have
8528 an expanded list that you know will be the same each time within a given
8529 message. For example:
8530 .code
8531 domainlist special_domains = \
8532            ${lookup{$sender_host_address}cdb{/some/file}}
8533 .endd
8534 This provides a list of domains that depends only on the sending host's IP
8535 address. If this domain list is referenced a number of times (for example,
8536 in several ACL lines, or in several routers) the result of the check is not
8537 cached by default, because Exim does not know that it is going to be the
8538 same list each time.
8539
8540 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8541 cache the result anyway. For example:
8542 .code
8543 domainlist_cache special_domains = ${lookup{...
8544 .endd
8545 If you do this, you should be absolutely sure that caching is going to do
8546 the right thing in all cases. When in doubt, leave it out.
8547
8548
8549
8550 .section "Domain lists" "SECTdomainlist"
8551 .cindex "domain list" "patterns for"
8552 .cindex "list" "domain list"
8553 Domain lists contain patterns that are to be matched against a mail domain.
8554 The following types of item may appear in domain lists:
8555
8556 .ilist
8557 .cindex "primary host name"
8558 .cindex "host name" "matched in domain list"
8559 .oindex "&%primary_hostname%&"
8560 .cindex "domain list" "matching primary host name"
8561 .cindex "@ in a domain list"
8562 If a pattern consists of a single @ character, it matches the local host name,
8563 as set by the &%primary_hostname%& option (or defaulted). This makes it
8564 possible to use the same configuration file on several different hosts that
8565 differ only in their names.
8566
8567 The value for a match will be the primary host name.
8568
8569
8570 .next
8571 .cindex "@[] in a domain list"
8572 .cindex "domain list" "matching local IP interfaces"
8573 .cindex "domain literal"
8574 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8575 in square brackets (as in an email address that contains a domain literal), but
8576 only if that IP address is recognized as local for email routing purposes. The
8577 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8578 control which of a host's several IP addresses are treated as local.
8579 In today's Internet, the use of domain literals is controversial;
8580 see the &%allow_domain_literals%& main option.
8581
8582 The value for a match will be the string &`@[]`&.
8583
8584
8585 .next
8586 .cindex "@mx_any"
8587 .cindex "@mx_primary"
8588 .cindex "@mx_secondary"
8589 .cindex "domain list" "matching MX pointers to local host"
8590 If a pattern consists of the string &`@mx_any`& it matches any domain that
8591 has an MX record pointing to the local host or to any host that is listed in
8592 .oindex "&%hosts_treat_as_local%&"
8593 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8594 are similar, except that the first matches only when a primary MX target is the
8595 local host, and the second only when no primary MX target is the local host,
8596 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8597 preference value &-- there may of course be more than one of them.
8598
8599 The MX lookup that takes place when matching a pattern of this type is
8600 performed with the resolver options for widening names turned off. Thus, for
8601 example, a single-component domain will &'not'& be expanded by adding the
8602 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8603 options of the &(dnslookup)& router for a discussion of domain widening.
8604
8605 Sometimes you may want to ignore certain IP addresses when using one of these
8606 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8607 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8608 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8609 on a router). For example:
8610 .code
8611 domains = @mx_any/ignore=127.0.0.1
8612 .endd
8613 This example matches any domain that has an MX record pointing to one of
8614 the local host's IP addresses other than 127.0.0.1.
8615
8616 The list of IP addresses is in fact processed by the same code that processes
8617 host lists, so it may contain CIDR-coded network specifications and it may also
8618 contain negative items.
8619
8620 Because the list of IP addresses is a sublist within a domain list, you have to
8621 be careful about delimiters if there is more than one address. Like any other
8622 list, the default delimiter can be changed. Thus, you might have:
8623 .code
8624 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8625           an.other.domain : ...
8626 .endd
8627 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8628 involved, it is easiest to change the delimiter for the main list as well:
8629 .code
8630 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8631           an.other.domain ? ...
8632 .endd
8633 The value for a match will be the list element string (starting &`@mx_`&).
8634
8635
8636 .next
8637 .cindex "asterisk" "in domain list"
8638 .cindex "domain list" "asterisk in"
8639 .cindex "domain list" "matching &""ends with""&"
8640 If a pattern starts with an asterisk, the remaining characters of the pattern
8641 are compared with the terminating characters of the domain. The use of &"*"& in
8642 domain lists differs from its use in partial matching lookups. In a domain
8643 list, the character following the asterisk need not be a dot, whereas partial
8644 matching works only in terms of dot-separated components. For example, a domain
8645 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8646 &'cipher.key.ex'&.
8647
8648 The value for a match will be the list element string (starting with the asterisk).
8649 Additionally, &$0$& will be set to the matched string
8650 and &$1$& to the variable portion which the asterisk matched.
8651
8652 .next
8653 .cindex "regular expressions" "in domain list"
8654 .cindex "domain list" "matching regular expression"
8655 If a pattern starts with a circumflex character, it is treated as a regular
8656 expression, and matched against the domain using a regular expression matching
8657 function. The circumflex is treated as part of the regular expression.
8658 Email domains are case-independent, so this regular expression match is by
8659 default case-independent, but you can make it case-dependent by starting it
8660 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8661 are given in chapter &<<CHAPregexp>>&.
8662
8663 &*Warning*&: Because domain lists are expanded before being processed, you
8664 must escape any backslash and dollar characters in the regular expression, or
8665 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8666 it is not to be expanded (unless you really do want to build a regular
8667 expression by expansion, of course).
8668
8669 The value for a match will be the list element string (starting with the circumflex).
8670 Additionally, &$0$& will be set to the string matching the regular expression,
8671 and &$1$& (onwards) to any submatches identified by parentheses.
8672
8673
8674
8675 .next
8676 .cindex "lookup" "in domain list"
8677 .cindex "domain list" "matching by lookup"
8678 If a pattern starts with the name of a single-key lookup type followed by a
8679 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8680 must be a filename in a suitable format for the lookup type. For example, for
8681 &"cdb;"& it must be an absolute path:
8682 .code
8683 domains = cdb;/etc/mail/local_domains.cdb
8684 .endd
8685 The appropriate type of lookup is done on the file using the domain name as the
8686 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8687 only in whether or not the key is present in the file. However, when a lookup
8688 is used for the &%domains%& option on a router
8689 or a &%domains%& condition in an ACL statement, the value is preserved in the
8690 &$domain_data$& variable and can be referred to in other router options or
8691 other statements in the same ACL.
8692 .cindex "tainted data" "de-tainting"
8693 The value will be untainted.
8694
8695
8696 .next
8697 Any of the single-key lookup type names may be preceded by
8698 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8699 .code
8700 domains = partial-dbm;/partial/domains
8701 .endd
8702 This causes partial matching logic to be invoked; a description of how this
8703 works is given in section &<<SECTpartiallookup>>&.
8704
8705 .next
8706 .cindex "asterisk" "in lookup type"
8707 Any of the single-key lookup types may be followed by an asterisk. This causes
8708 a default lookup for a key consisting of a single asterisk to be done if the
8709 original lookup fails. This is not a useful feature when using a domain list to
8710 select particular domains (because any domain would match), but it might have
8711 value if the result of the lookup is being used via the &$domain_data$&
8712 expansion variable.
8713
8714 .next
8715 If the pattern starts with the name of a query-style lookup type followed by a
8716 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8717 pattern must be an appropriate query for the lookup type, as described in
8718 chapter &<<CHAPfdlookup>>&. For example:
8719 .code
8720 hold_domains = mysql;select domain from holdlist \
8721   where domain = '${quote_mysql:$domain}';
8722 .endd
8723 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8724 example, it doesn't matter what field you select). Exim is interested only in
8725 whether or not the query succeeds. However, when a lookup is used for the
8726 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8727 variable and can be referred to in other options.
8728 .cindex "tainted data" "de-tainting"
8729 The value will be untainted.
8730
8731 .next
8732 If the pattern starts with the name of a lookup type
8733 of either kind (single-key or query-style) it may be
8734 followed by a comma and options,
8735 The options are lookup-type specific and consist of a comma-separated list.
8736 Each item starts with a tag and and equals "=".
8737
8738 .next
8739 .cindex "domain list" "matching literal domain name"
8740 If none of the above cases apply, a caseless textual comparison is made
8741 between the pattern and the domain.
8742
8743 The value for a match will be the list element string.
8744 .cindex "tainted data" "de-tainting"
8745 Note that this is commonly untainted
8746 (depending on the way the list was created).
8747 This is a useful way of obtaining an untainted equivalent to
8748 the domain, for later operations.
8749 .endlist
8750
8751
8752 Here is an example that uses several different kinds of pattern:
8753 .code
8754 domainlist funny_domains = \
8755   @ : \
8756   lib.unseen.edu : \
8757   *.foundation.fict.example : \
8758   \N^[1-2]\d{3}\.fict\.example$\N : \
8759   partial-dbm;/opt/data/penguin/book : \
8760   nis;domains.byname : \
8761   nisplus;[name=$domain,status=local],domains.org_dir
8762 .endd
8763 There are obvious processing trade-offs among the various matching modes. Using
8764 an asterisk is faster than a regular expression, and listing a few names
8765 explicitly probably is too. The use of a file or database lookup is expensive,
8766 but may be the only option if hundreds of names are required. Because the
8767 patterns are tested in order, it makes sense to put the most commonly matched
8768 patterns earlier.
8769
8770
8771
8772 .section "Host lists" "SECThostlist"
8773 .cindex "host list" "patterns in"
8774 .cindex "list" "host list"
8775 Host lists are used to control what remote hosts are allowed to do. For
8776 example, some hosts may be allowed to use the local host as a relay, and some
8777 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8778 two different ways, by name or by IP address. In a host list, some types of
8779 pattern are matched to a host name, and some are matched to an IP address.
8780 You need to be particularly careful with this when single-key lookups are
8781 involved, to ensure that the right value is being used as the key.
8782
8783
8784 .section "Special host list patterns" "SECID80"
8785 .cindex "empty item in hosts list"
8786 .cindex "host list" "empty string in"
8787 If a host list item is the empty string, it matches only when no remote host is
8788 involved. This is the case when a message is being received from a local
8789 process using SMTP on the standard input, that is, when a TCP/IP connection is
8790 not used.
8791
8792 .cindex "asterisk" "in host list"
8793 The special pattern &"*"& in a host list matches any host or no host. Neither
8794 the IP address nor the name is actually inspected.
8795
8796
8797
8798 .section "Host list patterns that match by IP address" "SECThoslispatip"
8799 .cindex "host list" "matching IP addresses"
8800 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8801 the incoming address actually appears in the IPv6 host as
8802 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8803 list, it is converted into a traditional IPv4 address first. (Not all operating
8804 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8805 concerns.)
8806
8807 The following types of pattern in a host list check the remote host by
8808 inspecting its IP address:
8809
8810 .ilist
8811 If the pattern is a plain domain name (not a regular expression, not starting
8812 with *, not a lookup of any kind), Exim calls the operating system function
8813 to find the associated IP address(es). Exim uses the newer
8814 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8815 This typically causes a forward DNS lookup of the name. The result is compared
8816 with the IP address of the subject host.
8817
8818 If there is a temporary problem (such as a DNS timeout) with the host name
8819 lookup, a temporary error occurs. For example, if the list is being used in an
8820 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8821 temporary SMTP error code. If no IP address can be found for the host name,
8822 what happens is described in section &<<SECTbehipnot>>& below.
8823
8824 .next
8825 .cindex "@ in a host list"
8826 If the pattern is &"@"&, the primary host name is substituted and used as a
8827 domain name, as just described.
8828
8829 .next
8830 If the pattern is an IP address, it is matched against the IP address of the
8831 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8832 IPv6 addresses can be given in colon-separated format, but the colons have to
8833 be doubled so as not to be taken as item separators when the default list
8834 separator is used. IPv6 addresses are recognized even when Exim is compiled
8835 without IPv6 support. This means that if they appear in a host list on an
8836 IPv4-only host, Exim will not treat them as host names. They are just addresses
8837 that can never match a client host.
8838
8839 .next
8840 .cindex "@[] in a host list"
8841 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8842 the local host. For example, if the local host is an IPv4 host with one
8843 interface address 10.45.23.56, these two ACL statements have the same effect:
8844 .code
8845 accept hosts = 127.0.0.1 : 10.45.23.56
8846 accept hosts = @[]
8847 .endd
8848 .next
8849 .cindex "CIDR notation"
8850 If the pattern is an IP address followed by a slash and a mask length (for
8851 example 10.11.42.0/24), it is matched against the IP address of the subject
8852 host under the given mask. This allows, an entire network of hosts to be
8853 included (or excluded) by a single item. The mask uses CIDR notation; it
8854 specifies the number of address bits that must match, starting from the most
8855 significant end of the address.
8856
8857 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8858 of a range of addresses. It is the number of bits in the network portion of the
8859 address. The above example specifies a 24-bit netmask, so it matches all 256
8860 addresses in the 10.11.42.0 network. An item such as
8861 .code
8862 192.168.23.236/31
8863 .endd
8864 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8865 32 for an IPv4 address is the same as no mask at all; just a single address
8866 matches.
8867
8868 Here is another example which shows an IPv4 and an IPv6 network:
8869 .code
8870 recipient_unqualified_hosts = 192.168.0.0/16: \
8871                               3ffe::ffff::836f::::/48
8872 .endd
8873 The doubling of list separator characters applies only when these items
8874 appear inline in a host list. It is not required when indirecting via a file.
8875 For example:
8876 .code
8877 recipient_unqualified_hosts = /opt/exim/unqualnets
8878 .endd
8879 could make use of a file containing
8880 .code
8881 172.16.0.0/12
8882 3ffe:ffff:836f::/48
8883 .endd
8884 to have exactly the same effect as the previous example. When listing IPv6
8885 addresses inline, it is usually more convenient to use the facility for
8886 changing separator characters. This list contains the same two networks:
8887 .code
8888 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8889                                  3ffe:ffff:836f::/48
8890 .endd
8891 The separator is changed to semicolon by the leading &"<;"& at the start of the
8892 list.
8893 .endlist
8894
8895
8896
8897 .section "Host list patterns for single-key lookups by host address" &&&
8898          "SECThoslispatsikey"
8899 .cindex "host list" "lookup of IP address"
8900 When a host is to be identified by a single-key lookup of its complete IP
8901 address, the pattern takes this form:
8902 .display
8903 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8904 .endd
8905 For example:
8906 .code
8907 hosts_lookup = net-cdb;/hosts-by-ip.db
8908 .endd
8909 The text form of the IP address of the subject host is used as the lookup key.
8910 IPv6 addresses are converted to an unabbreviated form, using lower case
8911 letters, with dots as separators because colon is the key terminator in
8912 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8913 quoting the keys, but this is a facility that was added later.] The data
8914 returned by the lookup is not used.
8915
8916 .cindex "IP address" "masking"
8917 .cindex "host list" "masked IP address"
8918 Single-key lookups can also be performed using masked IP addresses, using
8919 patterns of this form:
8920 .display
8921 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8922 .endd
8923 For example:
8924 .code
8925 net24-dbm;/networks.db
8926 .endd
8927 The IP address of the subject host is masked using <&'number'&> as the mask
8928 length. A textual string is constructed from the masked value, followed by the
8929 mask, and this is used as the lookup key. For example, if the host's IP address
8930 is 192.168.34.6, the key that is looked up for the above example is
8931 &"192.168.34.0/24"&.
8932
8933 When an IPv6 address is converted to a string, dots are normally used instead
8934 of colons, so that keys in &(lsearch)& files need not contain colons (which
8935 terminate &(lsearch)& keys). This was implemented some time before the ability
8936 to quote keys was made available in &(lsearch)& files. However, the more
8937 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8938 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8939 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8940 converted using colons and not dots.
8941 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8942 addresses are always used.
8943 The latter are converted to IPv4 addresses, in dotted-quad form.
8944
8945 Ideally, it would be nice to tidy up this anomalous situation by changing to
8946 colons in all cases, given that quoting is now available for &(lsearch)&.
8947 However, this would be an incompatible change that might break some existing
8948 configurations.
8949
8950 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8951 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8952 the former case the key strings include the mask value, whereas in the latter
8953 case the IP address is used on its own.
8954
8955
8956
8957 .section "Host list patterns that match by host name" "SECThoslispatnam"
8958 .cindex "host" "lookup failures"
8959 .cindex "unknown host name"
8960 .cindex "host list" "matching host name"
8961 There are several types of pattern that require Exim to know the name of the
8962 remote host. These are either wildcard patterns or lookups by name. (If a
8963 complete hostname is given without any wildcarding, it is used to find an IP
8964 address to match against, as described in section &<<SECThoslispatip>>&
8965 above.)
8966
8967 If the remote host name is not already known when Exim encounters one of these
8968 patterns, it has to be found from the IP address.
8969 Although many sites on the Internet are conscientious about maintaining reverse
8970 DNS data for their hosts, there are also many that do not do this.
8971 Consequently, a name cannot always be found, and this may lead to unwanted
8972 effects. Take care when configuring host lists with wildcarded name patterns.
8973 Consider what will happen if a name cannot be found.
8974
8975 Because of the problems of determining host names from IP addresses, matching
8976 against host names is not as common as matching against IP addresses.
8977
8978 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8979 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8980 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8981 are done can be changed by setting the &%host_lookup_order%& option. For
8982 security, once Exim has found one or more names, it looks up the IP addresses
8983 for these names and compares them with the IP address that it started with.
8984 Only those names whose IP addresses match are accepted. Any other names are
8985 discarded. If no names are left, Exim behaves as if the host name cannot be
8986 found. In the most common case there is only one name and one IP address.
8987
8988 There are some options that control what happens if a host name cannot be
8989 found. These are described in section &<<SECTbehipnot>>& below.
8990
8991 .cindex "host" "alias for"
8992 .cindex "alias for host"
8993 As a result of aliasing, hosts may have more than one name. When processing any
8994 of the following types of pattern, all the host's names are checked:
8995
8996 .ilist
8997 .cindex "asterisk" "in host list"
8998 If a pattern starts with &"*"& the remainder of the item must match the end of
8999 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9000 &'.b.c'&. This special simple form is provided because this is a very common
9001 requirement. Other kinds of wildcarding require the use of a regular
9002 expression.
9003 .next
9004 .cindex "regular expressions" "in host list"
9005 .cindex "host list" "regular expression in"
9006 If the item starts with &"^"& it is taken to be a regular expression which is
9007 matched against the host name. Host names are case-independent, so this regular
9008 expression match is by default case-independent, but you can make it
9009 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9010 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9011 example,
9012 .code
9013 ^(a|b)\.c\.d$
9014 .endd
9015 is a regular expression that matches either of the two hosts &'a.c.d'& or
9016 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9017 that backslash and dollar characters are not misinterpreted as part of the
9018 string expansion. The simplest way to do this is to use &`\N`& to mark that
9019 part of the string as non-expandable. For example:
9020 .code
9021 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9022 .endd
9023 &*Warning*&: If you want to match a complete host name, you must include the
9024 &`$`& terminating metacharacter in the regular expression, as in the above
9025 example. Without it, a match at the start of the host name is all that is
9026 required.
9027 .endlist
9028
9029
9030
9031
9032 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9033 .cindex "host" "lookup failures, permanent"
9034 While processing a host list, Exim may need to look up an IP address from a
9035 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9036 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9037 behaviour when it fails to find the information it is seeking is the same.
9038
9039 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9040 apply to temporary DNS errors, whose handling is described in the next section.
9041
9042 .cindex "&`+include_unknown`&"
9043 .cindex "&`+ignore_unknown`&"
9044 Exim parses a host list from left to right. If it encounters a permanent
9045 lookup failure in any item in the host list before it has found a match,
9046 Exim treats it as a failure and the default behavior is as if the host
9047 does not match the list. This may not always be what you want to happen.
9048 To change Exim's behaviour, the special items &`+include_unknown`& or
9049 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9050 not recognized in an indirected file).
9051
9052 .ilist
9053 If any item that follows &`+include_unknown`& requires information that
9054 cannot found, Exim behaves as if the host does match the list. For example,
9055 .code
9056 host_reject_connection = +include_unknown:*.enemy.ex
9057 .endd
9058 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9059 any hosts whose name it cannot find.
9060
9061 .next
9062 If any item that follows &`+ignore_unknown`& requires information that cannot
9063 be found, Exim ignores that item and proceeds to the rest of the list. For
9064 example:
9065 .code
9066 accept hosts = +ignore_unknown : friend.example : \
9067                192.168.4.5
9068 .endd
9069 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9070 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9071 name can be found for 192.168.4.5, it is rejected.
9072 .endlist
9073
9074 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9075 list. The effect of each one lasts until the next, or until the end of the
9076 list.
9077
9078 .section "Mixing wildcarded host names and addresses in host lists" &&&
9079          "SECTmixwilhos"
9080 .cindex "host list" "mixing names and addresses in"
9081
9082 This section explains the host/ip processing logic with the same concepts
9083 as the previous section, but specifically addresses what happens when a
9084 wildcarded hostname is one of the items in the hostlist.
9085
9086 .ilist
9087 If you have name lookups or wildcarded host names and
9088 IP addresses in the same host list, you should normally put the IP
9089 addresses first. For example, in an ACL you could have:
9090 .code
9091 accept hosts = 10.9.8.7 : *.friend.example
9092 .endd
9093 The reason you normally would order it this way lies in the
9094 left-to-right way that Exim processes lists.  It can test IP addresses
9095 without doing any DNS lookups, but when it reaches an item that requires
9096 a host name, it fails if it cannot find a host name to compare with the
9097 pattern. If the above list is given in the opposite order, the
9098 &%accept%& statement fails for a host whose name cannot be found, even
9099 if its IP address is 10.9.8.7.
9100
9101 .next
9102 If you really do want to do the name check first, and still recognize the IP
9103 address, you can rewrite the ACL like this:
9104 .code
9105 accept hosts = *.friend.example
9106 accept hosts = 10.9.8.7
9107 .endd
9108 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9109 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9110 &`+ignore_unknown`&, which was discussed in depth in the first example in
9111 this section.
9112 .endlist
9113
9114
9115 .section "Temporary DNS errors when looking up host information" &&&
9116          "SECTtemdnserr"
9117 .cindex "host" "lookup failures, temporary"
9118 .cindex "&`+include_defer`&"
9119 .cindex "&`+ignore_defer`&"
9120 A temporary DNS lookup failure normally causes a defer action (except when
9121 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9122 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9123 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9124 section. These options should be used with care, probably only in non-critical
9125 host lists such as whitelists.
9126
9127
9128
9129 .section "Host list patterns for single-key lookups by host name" &&&
9130          "SECThoslispatnamsk"
9131 .cindex "unknown host name"
9132 .cindex "host list" "matching host name"
9133 If a pattern is of the form
9134 .display
9135 <&'single-key-search-type'&>;<&'search-data'&>
9136 .endd
9137 for example
9138 .code
9139 dbm;/host/accept/list
9140 .endd
9141 a single-key lookup is performed, using the host name as its key. If the
9142 lookup succeeds, the host matches the item. The actual data that is looked up
9143 is not used.
9144
9145 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9146 keys in the file, not IP addresses. If you want to do lookups based on IP
9147 addresses, you must precede the search type with &"net-"& (see section
9148 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9149 two items in the same list, one doing an address lookup and one doing a name
9150 lookup, both using the same file.
9151
9152
9153
9154 .section "Host list patterns for query-style lookups" "SECID81"
9155 If a pattern is of the form
9156 .display
9157 <&'query-style-search-type'&>;<&'query'&>
9158 .endd
9159 the query is obeyed, and if it succeeds, the host matches the item. The actual
9160 data that is looked up is not used. The variables &$sender_host_address$& and
9161 &$sender_host_name$& can be used in the query. For example:
9162 .code
9163 hosts_lookup = pgsql;\
9164   select ip from hostlist where ip='$sender_host_address'
9165 .endd
9166 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9167 can use the &%sg%& expansion item to change this if you need to. If you want to
9168 use masked IP addresses in database queries, you can use the &%mask%& expansion
9169 operator.
9170
9171 If the query contains a reference to &$sender_host_name$&, Exim automatically
9172 looks up the host name if it has not already done so. (See section
9173 &<<SECThoslispatnam>>& for comments on finding host names.)
9174
9175 Historical note: prior to release 4.30, Exim would always attempt to find a
9176 host name before running the query, unless the search type was preceded by
9177 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9178 still recognized for query-style lookups, but its presence or absence has no
9179 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9180 See section &<<SECThoslispatsikey>>&.)
9181
9182
9183
9184
9185
9186 .section "Address lists" "SECTaddresslist"
9187 .cindex "list" "address list"
9188 .cindex "address list" "empty item"
9189 .cindex "address list" "patterns"
9190 Address lists contain patterns that are matched against mail addresses. There
9191 is one special case to be considered: the sender address of a bounce message is
9192 always empty. You can test for this by providing an empty item in an address
9193 list. For example, you can set up a router to process bounce messages by
9194 using this option setting:
9195 .code
9196 senders = :
9197 .endd
9198 The presence of the colon creates an empty item. If you do not provide any
9199 data, the list is empty and matches nothing. The empty sender can also be
9200 detected by a regular expression that matches an empty string,
9201 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9202
9203 Non-empty items in an address list can be straightforward email addresses. For
9204 example:
9205 .code
9206 senders = jbc@askone.example : hs@anacreon.example
9207 .endd
9208 A certain amount of wildcarding is permitted. If a pattern contains an @
9209 character, but is not a regular expression and does not begin with a
9210 semicolon-terminated lookup type (described below), the local part of the
9211 subject address is compared with the local part of the pattern, which may start
9212 with an asterisk. If the local parts match, the domain is checked in exactly
9213 the same way as for a pattern in a domain list. For example, the domain can be
9214 wildcarded, refer to a named list, or be a lookup:
9215 .code
9216 deny senders = *@*.spamming.site:\
9217                *@+hostile_domains:\
9218                bozo@partial-lsearch;/list/of/dodgy/sites:\
9219                *@dbm;/bad/domains.db
9220 .endd
9221 .cindex "local part" "starting with !"
9222 .cindex "address list" "local part starting with !"
9223 If a local part that begins with an exclamation mark is required, it has to be
9224 specified using a regular expression, because otherwise the exclamation mark is
9225 treated as a sign of negation, as is standard in lists.
9226
9227 If a non-empty pattern that is not a regular expression or a lookup does not
9228 contain an @ character, it is matched against the domain part of the subject
9229 address. The only two formats that are recognized this way are a literal
9230 domain, or a domain pattern that starts with *. In both these cases, the effect
9231 is the same as if &`*@`& preceded the pattern. For example:
9232 .code
9233 deny senders = enemy.domain : *.enemy.domain
9234 .endd
9235
9236 The following kinds of more complicated address list pattern can match any
9237 address, including the empty address that is characteristic of bounce message
9238 senders:
9239
9240 .ilist
9241 .cindex "regular expressions" "in address list"
9242 .cindex "address list" "regular expression in"
9243 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9244 done against the complete address, with the pattern as the regular expression.
9245 You must take care that backslash and dollar characters are not misinterpreted
9246 as part of the string expansion. The simplest way to do this is to use &`\N`&
9247 to mark that part of the string as non-expandable. For example:
9248 .code
9249 deny senders = \N^.*this.*@example\.com$\N : \
9250                \N^\d{8}.+@spamhaus.example$\N : ...
9251 .endd
9252 The &`\N`& sequences are removed by the expansion, so these items do indeed
9253 start with &"^"& by the time they are being interpreted as address patterns.
9254
9255 .next
9256 .cindex "address list" "lookup for complete address"
9257 Complete addresses can be looked up by using a pattern that starts with a
9258 lookup type terminated by a semicolon, followed by the data for the lookup. For
9259 example:
9260 .code
9261 deny senders = cdb;/etc/blocked.senders : \
9262   mysql;select address from blocked where \
9263   address='${quote_mysql:$sender_address}'
9264 .endd
9265 Both query-style and single-key lookup types can be used. For a single-key
9266 lookup type, Exim uses the complete address as the key. However, empty keys are
9267 not supported for single-key lookups, so a match against the empty address
9268 always fails. This restriction does not apply to query-style lookups.
9269
9270 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9271 cannot be used, and is ignored if specified, with an entry being written to the
9272 panic log.
9273 .cindex "*@ with single-key lookup"
9274 However, you can configure lookup defaults, as described in section
9275 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9276 default. For example, with this lookup:
9277 .code
9278 accept senders = lsearch*@;/some/file
9279 .endd
9280 the file could contains lines like this:
9281 .code
9282 user1@domain1.example
9283 *@domain2.example
9284 .endd
9285 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9286 that are tried is:
9287 .code
9288 nimrod@jaeger.example
9289 *@jaeger.example
9290 *
9291 .endd
9292 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9293 would mean that every address matches, thus rendering the test useless.
9294
9295 &*Warning 2*&: Do not confuse these two kinds of item:
9296 .code
9297 deny recipients = dbm*@;/some/file
9298 deny recipients = *@dbm;/some/file
9299 .endd
9300 The first does a whole address lookup, with defaulting, as just described,
9301 because it starts with a lookup type. The second matches the local part and
9302 domain independently, as described in a bullet point below.
9303 .endlist
9304
9305
9306 The following kinds of address list pattern can match only non-empty addresses.
9307 If the subject address is empty, a match against any of these pattern types
9308 always fails.
9309
9310
9311 .ilist
9312 .cindex "@@ with single-key lookup"
9313 .cindex "address list" "@@ lookup type"
9314 .cindex "address list" "split local part and domain"
9315 If a pattern starts with &"@@"& followed by a single-key lookup item
9316 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9317 split into a local part and a domain. The domain is looked up in the file. If
9318 it is not found, there is no match. If it is found, the data that is looked up
9319 from the file is treated as a colon-separated list of local part patterns, each
9320 of which is matched against the subject local part in turn.
9321
9322 .cindex "asterisk" "in address list"
9323 The lookup may be a partial one, and/or one involving a search for a default
9324 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9325 patterns that are looked up can be regular expressions or begin with &"*"&, or
9326 even be further lookups. They may also be independently negated. For example,
9327 with
9328 .code
9329 deny senders = @@dbm;/etc/reject-by-domain
9330 .endd
9331 the data from which the DBM file is built could contain lines like
9332 .code
9333 baddomain.com:  !postmaster : *
9334 .endd
9335 to reject all senders except &%postmaster%& from that domain.
9336
9337 .cindex "local part" "starting with !"
9338 If a local part that actually begins with an exclamation mark is required, it
9339 has to be specified using a regular expression. In &(lsearch)& files, an entry
9340 may be split over several lines by indenting the second and subsequent lines,
9341 but the separating colon must still be included at line breaks. White space
9342 surrounding the colons is ignored. For example:
9343 .code
9344 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9345   spammer3 : spammer4
9346 .endd
9347 As in all colon-separated lists in Exim, a colon can be included in an item by
9348 doubling.
9349
9350 If the last item in the list starts with a right angle-bracket, the remainder
9351 of the item is taken as a new key to look up in order to obtain a continuation
9352 list of local parts. The new key can be any sequence of characters. Thus one
9353 might have entries like
9354 .code
9355 aol.com: spammer1 : spammer 2 : >*
9356 xyz.com: spammer3 : >*
9357 *:       ^\d{8}$
9358 .endd
9359 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9360 local parts for all domains, in addition to the specific local parts listed for
9361 each domain. Of course, using this feature costs another lookup each time a
9362 chain is followed, but the effort needed to maintain the data is reduced.
9363
9364 .cindex "loop" "in lookups"
9365 It is possible to construct loops using this facility, and in order to catch
9366 them, the chains may be no more than fifty items long.
9367
9368 .next
9369 The @@<&'lookup'&> style of item can also be used with a query-style
9370 lookup, but in this case, the chaining facility is not available. The lookup
9371 can only return a single list of local parts.
9372 .endlist
9373
9374 &*Warning*&: There is an important difference between the address list items
9375 in these two examples:
9376 .code
9377 senders = +my_list
9378 senders = *@+my_list
9379 .endd
9380 In the first one, &`my_list`& is a named address list, whereas in the second
9381 example it is a named domain list.
9382
9383
9384
9385
9386 .section "Case of letters in address lists" "SECTcasletadd"
9387 .cindex "case of local parts"
9388 .cindex "address list" "case forcing"
9389 .cindex "case forcing in address lists"
9390 Domains in email addresses are always handled caselessly, but for local parts
9391 case may be significant on some systems (see &%caseful_local_part%& for how
9392 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9393 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9394 blocking lists should be done in a case-independent manner. Since most address
9395 lists in Exim are used for this kind of control, Exim attempts to do this by
9396 default.
9397
9398 The domain portion of an address is always lowercased before matching it to an
9399 address list. The local part is lowercased by default, and any string
9400 comparisons that take place are done caselessly. This means that the data in
9401 the address list itself, in files included as plain filenames, and in any file
9402 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9403 keys in files that are looked up by a search type other than &(lsearch)& (which
9404 works caselessly) must be in lower case, because these lookups are not
9405 case-independent.
9406
9407 .cindex "&`+caseful`&"
9408 To allow for the possibility of caseful address list matching, if an item in
9409 an address list is the string &"+caseful"&, the original case of the local
9410 part is restored for any comparisons that follow, and string comparisons are no
9411 longer case-independent. This does not affect the domain, which remains in
9412 lower case. However, although independent matches on the domain alone are still
9413 performed caselessly, regular expressions that match against an entire address
9414 become case-sensitive after &"+caseful"& has been seen.
9415
9416
9417
9418 .section "Local part lists" "SECTlocparlis"
9419 .cindex "list" "local part list"
9420 .cindex "local part" "list"
9421 Case-sensitivity in local part lists is handled in the same way as for address
9422 lists, as just described. The &"+caseful"& item can be used if required. In a
9423 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9424 set false, the subject is lowercased and the matching is initially
9425 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9426 matching in the local part list, but not elsewhere in the router. If
9427 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9428 option is case-sensitive from the start.
9429
9430 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9431 comments are handled in the same way as address lists &-- they are recognized
9432 only if the # is preceded by white space or the start of the line.
9433 Otherwise, local part lists are matched in the same way as domain lists, except
9434 that the special items that refer to the local host (&`@`&, &`@[]`&,
9435 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9436 Refer to section &<<SECTdomainlist>>& for details of the other available item
9437 types.
9438 .ecindex IIDdohoadli
9439
9440
9441
9442
9443 . ////////////////////////////////////////////////////////////////////////////
9444 . ////////////////////////////////////////////////////////////////////////////
9445
9446 .chapter "String expansions" "CHAPexpand"
9447 .scindex IIDstrexp "expansion" "of strings"
9448 Many strings in Exim's runtime configuration are expanded before use. Some of
9449 them are expanded every time they are used; others are expanded only once.
9450
9451 When a string is being expanded it is copied verbatim from left to right except
9452 .cindex expansion "string concatenation"
9453 when a dollar or backslash character is encountered. A dollar specifies the
9454 start of a portion of the string that is interpreted and replaced as described
9455 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9456 escape character, as described in the following section.
9457
9458 Whether a string is expanded depends upon the context.  Usually this is solely
9459 dependent upon the option for which a value is sought; in this documentation,
9460 options for which string expansion is performed are marked with &dagger; after
9461 the data type.  ACL rules always expand strings.  A couple of expansion
9462 conditions do not expand some of the brace-delimited branches, for security
9463 reasons,
9464 .cindex "tainted data" expansion
9465 .cindex "tainted data" definition
9466 .cindex expansion "tainted data"
9467 and expansion of data deriving from the sender (&"tainted data"&)
9468 is not permitted.
9469
9470 .new
9471 Common ways of obtaining untainted equivalents of variables with
9472 tainted values
9473 .cindex "tainted data" "de-tainting"
9474 come down to using the tainted value as a lookup key in a trusted database.
9475 This database could be the filesystem structure,
9476 or the password file,
9477 or accessed via a DBMS.
9478 Specific methods are indexed under &"de-tainting"&.
9479 .wen
9480
9481
9482
9483 .section "Literal text in expanded strings" "SECTlittext"
9484 .cindex "expansion" "including literal text"
9485 An uninterpreted dollar can be included in an expanded string by putting a
9486 backslash in front of it. A backslash can be used to prevent any special
9487 character being treated specially in an expansion, including backslash itself.
9488 If the string appears in quotes in the configuration file, two backslashes are
9489 required because the quotes themselves cause interpretation of backslashes when
9490 the string is read in (see section &<<SECTstrings>>&).
9491
9492 .cindex "expansion" "non-expandable substrings"
9493 A portion of the string can specified as non-expandable by placing it between
9494 two occurrences of &`\N`&. This is particularly useful for protecting regular
9495 expressions, which often contain backslashes and dollar signs. For example:
9496 .code
9497 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9498 .endd
9499 On encountering the first &`\N`&, the expander copies subsequent characters
9500 without interpretation until it reaches the next &`\N`& or the end of the
9501 string.
9502
9503
9504
9505 .section "Character escape sequences in expanded strings" "SECID82"
9506 .cindex "expansion" "escape sequences"
9507 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9508 expanded string is recognized as an escape sequence for the character newline,
9509 carriage return, or tab, respectively. A backslash followed by up to three
9510 octal digits is recognized as an octal encoding for a single character, and a
9511 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9512 encoding.
9513
9514 These escape sequences are also recognized in quoted strings when they are read
9515 in. Their interpretation in expansions as well is useful for unquoted strings,
9516 and for other cases such as looked-up strings that are then expanded.
9517
9518
9519 .section "Testing string expansions" "SECID83"
9520 .cindex "expansion" "testing"
9521 .cindex "testing" "string expansion"
9522 .oindex "&%-be%&"
9523 Many expansions can be tested by calling Exim with the &%-be%& option. This
9524 takes the command arguments, or lines from the standard input if there are no
9525 arguments, runs them through the string expansion code, and writes the results
9526 to the standard output. Variables based on configuration values are set up, but
9527 since no message is being processed, variables such as &$local_part$& have no
9528 value. Nevertheless the &%-be%& option can be useful for checking out file and
9529 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9530 and &%nhash%&.
9531
9532 Exim gives up its root privilege when it is called with the &%-be%& option, and
9533 instead runs under the uid and gid it was called with, to prevent users from
9534 using &%-be%& for reading files to which they do not have access.
9535
9536 .oindex "&%-bem%&"
9537 If you want to test expansions that include variables whose values are taken
9538 from a message, there are two other options that can be used. The &%-bem%&
9539 option is like &%-be%& except that it is followed by a filename. The file is
9540 read as a message before doing the test expansions. For example:
9541 .code
9542 exim -bem /tmp/test.message '$h_subject:'
9543 .endd
9544 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9545 Exim message identifier. For example:
9546 .code
9547 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9548 .endd
9549 This loads the message from Exim's spool before doing the test expansions, and
9550 is therefore restricted to admin users.
9551
9552
9553 .section "Forced expansion failure" "SECTforexpfai"
9554 .cindex "expansion" "forced failure"
9555 A number of expansions that are described in the following section have
9556 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9557 (which are sometimes called &"curly brackets"&). Which of the two strings is
9558 used depends on some condition that is evaluated as part of the expansion. If,
9559 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9560 the entire string expansion fails in a way that can be detected by the code
9561 that requested the expansion. This is called &"forced expansion failure"&, and
9562 its consequences depend on the circumstances. In some cases it is no different
9563 from any other expansion failure, but in others a different action may be
9564 taken. Such variations are mentioned in the documentation of the option that is
9565 being expanded.
9566
9567
9568
9569
9570 .section "Expansion items" "SECTexpansionitems"
9571 The following items are recognized in expanded strings. White space may be used
9572 between sub-items that are keywords or substrings enclosed in braces inside an
9573 outer set of braces, to improve readability. &*Warning*&: Within braces,
9574 white space is significant.
9575
9576 .vlist
9577 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9578 .cindex "expansion" "variables"
9579 Substitute the contents of the named variable, for example:
9580 .code
9581 $local_part
9582 ${domain}
9583 .endd
9584 The second form can be used to separate the name from subsequent alphanumeric
9585 characters. This form (using braces) is available only for variables; it does
9586 &'not'& apply to message headers. The names of the variables are given in
9587 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9588 given, the expansion fails.
9589
9590 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9591 .cindex "expansion" "operators"
9592 The string is first itself expanded, and then the operation specified by
9593 <&'op'&> is applied to it. For example:
9594 .code
9595 ${lc:$local_part}
9596 .endd
9597 The string starts with the first character after the colon, which may be
9598 leading white space. A list of operators is given in section &<<SECTexpop>>&
9599 below. The operator notation is used for simple expansion items that have just
9600 one argument, because it reduces the number of braces and therefore makes the
9601 string easier to understand.
9602
9603 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9604 This item inserts &"basic"& header lines. It is described with the &%header%&
9605 expansion item below.
9606
9607
9608 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9609 .cindex "expansion" "calling an acl"
9610 .cindex "&%acl%&" "call from expansion"
9611 The name and zero to nine argument strings are first expanded separately.  The expanded
9612 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9613 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9614 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9615 and may use the variables; if another acl expansion is used the values
9616 are restored after it returns.  If the ACL sets
9617 a value using a "message =" modifier and returns accept or deny, the value becomes
9618 the result of the expansion.
9619 If no message is set and the ACL returns accept or deny
9620 the expansion result is an empty string.
9621 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9622
9623
9624 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9625 .cindex authentication "results header"
9626 .cindex headers "authentication-results:"
9627 .cindex authentication "expansion item"
9628 This item returns a string suitable for insertion as an
9629 &'Authentication-Results:'&
9630 header line.
9631 The given <&'authserv-id'&> is included in the result; typically this
9632 will be a domain name identifying the system performing the authentications.
9633 Methods that might be present in the result include:
9634 .code
9635 none
9636 iprev
9637 auth
9638 spf
9639 dkim
9640 .endd
9641
9642 Example use (as an ACL modifier):
9643 .code
9644       add_header = :at_start:${authresults {$primary_hostname}}
9645 .endd
9646 This is safe even if no authentication results are available.
9647
9648
9649 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9650        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9651 .cindex "expansion" "extracting certificate fields"
9652 .cindex "&%certextract%&" "certificate fields"
9653 .cindex "certificate" "extracting fields"
9654 The <&'certificate'&> must be a variable of type certificate.
9655 The field name is expanded and used to retrieve the relevant field from
9656 the certificate.  Supported fields are:
9657 .display
9658 &`version        `&
9659 &`serial_number  `&
9660 &`subject        `& RFC4514 DN
9661 &`issuer         `& RFC4514 DN
9662 &`notbefore      `& time
9663 &`notafter       `& time
9664 &`sig_algorithm  `&
9665 &`signature      `&
9666 &`subj_altname   `& tagged list
9667 &`ocsp_uri       `& list
9668 &`crl_uri        `& list
9669 .endd
9670 If the field is found,
9671 <&'string2'&> is expanded, and replaces the whole item;
9672 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9673 variable &$value$& contains the value that has been extracted. Afterwards, it
9674 is restored to any previous value it might have had.
9675
9676 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9677 key is not found. If {<&'string2'&>} is also omitted, the value that was
9678 extracted is used.
9679
9680 Some field names take optional modifiers, appended and separated by commas.
9681
9682 The field selectors marked as "RFC4514" above
9683 output a Distinguished Name string which is
9684 not quite
9685 parseable by Exim as a comma-separated tagged list
9686 (the exceptions being elements containing commas).
9687 RDN elements of a single type may be selected by
9688 a modifier of the type label; if so the expansion
9689 result is a list (newline-separated by default).
9690 The separator may be changed by another modifier of
9691 a right angle-bracket followed immediately by the new separator.
9692 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9693
9694 The field selectors marked as "time" above
9695 take an optional modifier of "int"
9696 for which the result is the number of seconds since epoch.
9697 Otherwise the result is a human-readable string
9698 in the timezone selected by the main "timezone" option.
9699
9700 The field selectors marked as "list" above return a list,
9701 newline-separated by default,
9702 (embedded separator characters in elements are doubled).
9703 The separator may be changed by a modifier of
9704 a right angle-bracket followed immediately by the new separator.
9705
9706 The field selectors marked as "tagged" above
9707 prefix each list element with a type string and an equals sign.
9708 Elements of only one type may be selected by a modifier
9709 which is one of "dns", "uri" or "mail";
9710 if so the element tags are omitted.
9711
9712 If not otherwise noted field values are presented in human-readable form.
9713
9714 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9715        {*&<&'arg'&>&*}...}*&"
9716 .cindex &%dlfunc%&
9717 This expansion dynamically loads and then calls a locally-written C function.
9718 This functionality is available only if Exim is compiled with
9719 .code
9720 EXPAND_DLFUNC=yes
9721 .endd
9722 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9723 object so that it doesn't reload the same object file in the same Exim process
9724 (but of course Exim does start new processes frequently).
9725
9726 There may be from zero to eight arguments to the function.
9727
9728 When compiling
9729 a local function that is to be called in this way,
9730 first &_DLFUNC_IMPL_& should be defined,
9731 and second &_local_scan.h_& should be included.
9732 The Exim variables and functions that are defined by that API
9733 are also available for dynamically loaded functions. The function itself
9734 must have the following type:
9735 .code
9736 int dlfunction(uschar **yield, int argc, uschar *argv[])
9737 .endd
9738 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9739 function should return one of the following values:
9740
9741 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9742 into the expanded string that is being built.
9743
9744 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9745 from &'yield'&, if it is set.
9746
9747 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9748 taken from &'yield'& if it is set.
9749
9750 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9751
9752 When compiling a function that is to be used in this way with gcc,
9753 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9754 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9755
9756
9757 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9758 .cindex "expansion" "extracting value from environment"
9759 .cindex "environment" "values from"
9760 The key is first expanded separately, and leading and trailing white space
9761 removed.
9762 This is then searched for as a name in the environment.
9763 If a variable is found then its value is placed in &$value$&
9764 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9765
9766 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9767 appear, for example:
9768 .code
9769 ${env{USER}{$value} fail }
9770 .endd
9771 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9772 {<&'string1'&>} must be present for &"fail"& to be recognized.
9773
9774 If {<&'string2'&>} is omitted an empty string is substituted on
9775 search failure.
9776 If {<&'string1'&>} is omitted the search result is substituted on
9777 search success.
9778
9779 The environment is adjusted by the &%keep_environment%& and
9780 &%add_environment%& main section options.
9781
9782
9783 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9784        {*&<&'string3'&>&*}}*&"
9785 .cindex "expansion" "extracting substrings by key"
9786 .cindex "&%extract%&" "substrings by key"
9787 The key and <&'string1'&> are first expanded separately. Leading and trailing
9788 white space is removed from the key (but not from any of the strings). The key
9789 must not be empty and must not consist entirely of digits.
9790 The expanded <&'string1'&> must be of the form:
9791 .display
9792 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9793 .endd
9794 .vindex "&$value$&"
9795 where the equals signs and spaces (but not both) are optional. If any of the
9796 values contain white space, they must be enclosed in double quotes, and any
9797 values that are enclosed in double quotes are subject to escape processing as
9798 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9799 for the value that corresponds to the key. The search is case-insensitive. If
9800 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9801 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9802 variable &$value$& contains the value that has been extracted. Afterwards, it
9803 is restored to any previous value it might have had.
9804
9805 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9806 key is not found. If {<&'string2'&>} is also omitted, the value that was
9807 extracted is used. Thus, for example, these two expansions are identical, and
9808 yield &"2001"&:
9809 .code
9810 ${extract{gid}{uid=1984 gid=2001}}
9811 ${extract{gid}{uid=1984 gid=2001}{$value}}
9812 .endd
9813 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9814 appear, for example:
9815 .code
9816 ${extract{Z}{A=... B=...}{$value} fail }
9817 .endd
9818 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9819 {<&'string2'&>} must be present for &"fail"& to be recognized.
9820
9821 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9822        {*&<&'string3'&>&*}}*&" &&&
9823        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9824        {*&<&'string3'&>&*}}*&"
9825 .cindex "expansion" "extracting from JSON object"
9826 .cindex JSON expansions
9827 The key and <&'string1'&> are first expanded separately. Leading and trailing
9828 white space is removed from the key (but not from any of the strings). The key
9829 must not be empty and must not consist entirely of digits.
9830 The expanded <&'string1'&> must be of the form:
9831 .display
9832 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9833 .endd
9834 .vindex "&$value$&"
9835 The braces, commas and colons, and the quoting of the member name are required;
9836 the spaces are optional.
9837 Matching of the key against the member names is done case-sensitively.
9838 For the &"json"& variant,
9839 if a returned value is a JSON string, it retains its leading and
9840 trailing quotes.
9841 For the &"jsons"& variant, which is intended for use with JSON strings, the
9842 leading and trailing quotes are removed from the returned value.
9843 . XXX should be a UTF-8 compare
9844
9845 The results of matching are handled as above.
9846
9847
9848 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9849         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9850 .cindex "expansion" "extracting substrings by number"
9851 .cindex "&%extract%&" "substrings by number"
9852 The <&'number'&> argument must consist entirely of decimal digits,
9853 apart from leading and trailing white space, which is ignored.
9854 This is what distinguishes this form of &%extract%& from the previous kind. It
9855 behaves in the same way, except that, instead of extracting a named field, it
9856 extracts from <&'string1'&> the field whose number is given as the first
9857 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9858 <&'string3'&> as before.
9859
9860 The fields in the string are separated by any one of the characters in the
9861 separator string. These may include space or tab characters.
9862 The first field is numbered one. If the number is negative, the fields are
9863 counted from the end of the string, with the rightmost one numbered -1. If the
9864 number given is zero, the entire string is returned. If the modulus of the
9865 number is greater than the number of fields in the string, the result is the
9866 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9867 provided. For example:
9868 .code
9869 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9870 .endd
9871 yields &"42"&, and
9872 .code
9873 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9874 .endd
9875 yields &"99"&. Two successive separators mean that the field between them is
9876 empty (for example, the fifth field above).
9877
9878
9879 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9880         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9881        "&*${extract jsons{*&<&'number'&>&*}}&&&
9882         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9883 .cindex "expansion" "extracting from JSON array"
9884 .cindex JSON expansions
9885 The <&'number'&> argument must consist entirely of decimal digits,
9886 apart from leading and trailing white space, which is ignored.
9887
9888 Field selection and result handling is as above;
9889 there is no choice of field separator.
9890 For the &"json"& variant,
9891 if a returned value is a JSON string, it retains its leading and
9892 trailing quotes.
9893 For the &"jsons"& variant, which is intended for use with JSON strings, the
9894 leading and trailing quotes are removed from the returned value.
9895
9896
9897 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9898 .cindex "list" "selecting by condition"
9899 .cindex "expansion" "selecting from list by condition"
9900 .vindex "&$item$&"
9901 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9902 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9903 For each item
9904 in this list, its value is place in &$item$&, and then the condition is
9905 evaluated. If the condition is true, &$item$& is added to the output as an
9906 item in a new list; if the condition is false, the item is discarded. The
9907 separator used for the output list is the same as the one used for the
9908 input, but a separator setting is not included in the output. For example:
9909 .code
9910 ${filter{a:b:c}{!eq{$item}{b}}}
9911 .endd
9912 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9913 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9914
9915
9916 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9917 .cindex "hash function" "textual"
9918 .cindex "expansion" "textual hash"
9919 This is a textual hashing function, and was the first to be implemented in
9920 early versions of Exim. In current releases, there are other hashing functions
9921 (numeric, MD5, and SHA-1), which are described below.
9922
9923 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9924 <&'n'&>. If you are using fixed values for these numbers, that is, if
9925 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9926 use the simpler operator notation that avoids some of the braces:
9927 .code
9928 ${hash_<n>_<m>:<string>}
9929 .endd
9930 The second number is optional (in both notations). If <&'n'&> is greater than
9931 or equal to the length of the string, the expansion item returns the string.
9932 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9933 function to the string. The new string consists of characters taken from the
9934 first <&'m'&> characters of the string
9935 .code
9936 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9937 .endd
9938 If <&'m'&> is not present the value 26 is used, so that only lower case
9939 letters appear. For example:
9940 .display
9941 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9942 &`$hash{5}{monty}}           `&   yields  &`monty`&
9943 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9944 .endd
9945
9946 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9947         &*$h_*&<&'header&~name'&>&*:*&" &&&
9948        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9949         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9950        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9951         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9952        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9953         &*$rh_*&<&'header&~name'&>&*:*&"
9954 .cindex "expansion" "header insertion"
9955 .vindex "&$header_$&"
9956 .vindex "&$bheader_$&"
9957 .vindex "&$lheader_$&"
9958 .vindex "&$rheader_$&"
9959 .cindex "header lines" "in expansion strings"
9960 .cindex "header lines" "character sets"
9961 .cindex "header lines" "decoding"
9962 Substitute the contents of the named message header line, for example
9963 .code
9964 $header_reply-to:
9965 .endd
9966 The newline that terminates a header line is not included in the expansion, but
9967 internal newlines (caused by splitting the header line over several physical
9968 lines) may be present.
9969
9970 The difference between the four pairs of expansions is in the way
9971 the data in the header line is interpreted.
9972
9973 .ilist
9974 .cindex "white space" "in header lines"
9975 &%rheader%& gives the original &"raw"& content of the header line, with no
9976 processing at all, and without the removal of leading and trailing white space.
9977
9978 .next
9979 .cindex "list" "of header lines"
9980 &%lheader%& gives a colon-separated list, one element per header when there
9981 are multiple headers with a given name.
9982 Any embedded colon characters within an element are doubled, so normal Exim
9983 list-processing facilities can be used.
9984 The terminating newline of each element is removed; in other respects
9985 the content is &"raw"&.
9986
9987 .next
9988 .cindex "base64 encoding" "in header lines"
9989 &%bheader%& removes leading and trailing white space, and then decodes base64
9990 or quoted-printable MIME &"words"& within the header text, but does no
9991 character set translation. If decoding of what looks superficially like a MIME
9992 &"word"& fails, the raw string is returned. If decoding
9993 .cindex "binary zero" "in header line"
9994 produces a binary zero character, it is replaced by a question mark &-- this is
9995 what Exim does for binary zeros that are actually received in header lines.
9996
9997 .next
9998 &%header%& tries to translate the string as decoded by &%bheader%& to a
9999 standard character set. This is an attempt to produce the same string as would
10000 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10001 returned. Translation is attempted only on operating systems that support the
10002 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10003 a system Makefile or in &_Local/Makefile_&.
10004 .endlist ilist
10005
10006 In a filter file, the target character set for &%header%& can be specified by a
10007 command of the following form:
10008 .code
10009 headers charset "UTF-8"
10010 .endd
10011 This command affects all references to &$h_$& (or &$header_$&) expansions in
10012 subsequently obeyed filter commands. In the absence of this command, the target
10013 character set in a filter is taken from the setting of the &%headers_charset%&
10014 option in the runtime configuration. The value of this option defaults to the
10015 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10016 ISO-8859-1.
10017
10018 Header names follow the syntax of RFC 2822, which states that they may contain
10019 any printing characters except space and colon. Consequently, curly brackets
10020 &'do not'& terminate header names, and should not be used to enclose them as
10021 if they were variables. Attempting to do so causes a syntax error.
10022
10023 Only header lines that are common to all copies of a message are visible to
10024 this mechanism. These are the original header lines that are received with the
10025 message, and any that are added by an ACL statement or by a system
10026 filter. Header lines that are added to a particular copy of a message by a
10027 router or transport are not accessible.
10028
10029 For incoming SMTP messages, no header lines are visible in
10030 ACLs that are obeyed before the data phase completes,
10031 because the header structure is not set up until the message is received.
10032 They are visible in DKIM, PRDR and DATA ACLs.
10033 Header lines that are added in a RCPT ACL (for example)
10034 are saved until the message's incoming header lines are available, at which
10035 point they are added.
10036 When any of the above ACLs ar
10037 running, however, header lines added by earlier ACLs are visible.
10038
10039 Upper case and lower case letters are synonymous in header names. If the
10040 following character is white space, the terminating colon may be omitted, but
10041 this is not recommended, because you may then forget it when it is needed. When
10042 white space terminates the header name, this white space is included in the
10043 expanded string.  If the message does not contain the given header, the
10044 expansion item is replaced by an empty string. (See the &%def%& condition in
10045 section &<<SECTexpcond>>& for a means of testing for the existence of a
10046 header.)
10047
10048 If there is more than one header with the same name, they are all concatenated
10049 to form the substitution string, up to a maximum length of 64K. Unless
10050 &%rheader%& is being used, leading and trailing white space is removed from
10051 each header before concatenation, and a completely empty header is ignored. A
10052 newline character is then inserted between non-empty headers, but there is no
10053 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10054 those headers that contain lists of addresses, a comma is also inserted at the
10055 junctions between headers. This does not happen for the &%rheader%& expansion.
10056
10057 .cindex "tainted data"
10058 When the headers are from an incoming message,
10059 the result of expanding any of these variables is tainted.
10060
10061
10062 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10063 .cindex "expansion" "hmac hashing"
10064 .cindex &%hmac%&
10065 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10066 shared secret and some text into a message authentication code, as specified in
10067 RFC 2104. This differs from &`${md5:secret_text...}`& or
10068 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10069 cryptographic hash, allowing for authentication that is not possible with MD5
10070 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10071 present. For example:
10072 .code
10073 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10074 .endd
10075 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10076 produces:
10077 .code
10078 dd97e3ba5d1a61b5006108f8c8252953
10079 .endd
10080 As an example of how this might be used, you might put in the main part of
10081 an Exim configuration:
10082 .code
10083 SPAMSCAN_SECRET=cohgheeLei2thahw
10084 .endd
10085 In a router or a transport you could then have:
10086 .code
10087 headers_add = \
10088   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10089   ${hmac{md5}{SPAMSCAN_SECRET}\
10090   {${primary_hostname},${message_exim_id},$h_message-id:}}
10091 .endd
10092 Then given a message, you can check where it was scanned by looking at the
10093 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10094 this header line is authentic by recomputing the authentication code from the
10095 host name, message ID and the &'Message-id:'& header line. This can be done
10096 using Exim's &%-be%& option, or by other means, for example, by using the
10097 &'hmac_md5_hex()'& function in Perl.
10098
10099
10100 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10101 .cindex "expansion" "conditional"
10102 .cindex "&%if%&, expansion item"
10103 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10104 item; otherwise <&'string2'&> is used. The available conditions are described
10105 in section &<<SECTexpcond>>& below. For example:
10106 .code
10107 ${if eq {$local_part}{postmaster} {yes}{no} }
10108 .endd
10109 The second string need not be present; if it is not and the condition is not
10110 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10111 be present instead of the second string (without any curly brackets). In this
10112 case, the expansion is forced to fail if the condition is not true (see section
10113 &<<SECTforexpfai>>&).
10114
10115 If both strings are omitted, the result is the string &`true`& if the condition
10116 is true, and the empty string if the condition is false. This makes it less
10117 cumbersome to write custom ACL and router conditions. For example, instead of
10118 .code
10119 condition = ${if >{$acl_m4}{3}{true}{false}}
10120 .endd
10121 you can use
10122 .code
10123 condition = ${if >{$acl_m4}{3}}
10124 .endd
10125
10126
10127
10128 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10129 .cindex expansion "imap folder"
10130 .cindex "&%imapfolder%& expansion item"
10131 This item converts a (possibly multilevel, or with non-ASCII characters)
10132 folder specification to a Maildir name for filesystem use.
10133 For information on internationalisation support see &<<SECTi18nMDA>>&.
10134
10135
10136
10137 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10138 .cindex "expansion" "string truncation"
10139 .cindex "&%length%& expansion item"
10140 The &%length%& item is used to extract the initial portion of a string. Both
10141 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10142 you are using a fixed value for the number, that is, if <&'string1'&> does not
10143 change when expanded, you can use the simpler operator notation that avoids
10144 some of the braces:
10145 .code
10146 ${length_<n>:<string>}
10147 .endd
10148 The result of this item is either the first <&'n'&> bytes or the whole
10149 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10150 &%strlen%&, which gives the length of a string.
10151 All measurement is done in bytes and is not UTF-8 aware.
10152
10153
10154 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10155         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10156 .cindex "expansion" "extracting list elements by number"
10157 .cindex "&%listextract%&" "extract list elements by number"
10158 .cindex "list" "extracting elements by number"
10159 The <&'number'&> argument must consist entirely of decimal digits,
10160 apart from an optional leading minus,
10161 and leading and trailing white space (which is ignored).
10162
10163 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10164 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10165
10166 The first field of the list is numbered one.
10167 If the number is negative, the fields are
10168 counted from the end of the list, with the rightmost one numbered -1.
10169 The numbered element of the list is extracted and placed in &$value$&,
10170 then <&'string2'&> is expanded as the result.
10171
10172 If the modulus of the
10173 number is zero or greater than the number of fields in the string,
10174 the result is the expansion of <&'string3'&>.
10175
10176 For example:
10177 .code
10178 ${listextract{2}{x:42:99}}
10179 .endd
10180 yields &"42"&, and
10181 .code
10182 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10183 .endd
10184 yields &"result: 42"&.
10185
10186 If {<&'string3'&>} is omitted, an empty string is used for string3.
10187 If {<&'string2'&>} is also omitted, the value that was
10188 extracted is used.
10189 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10190
10191
10192 .new
10193 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10194 .cindex quoting "for list"
10195 .cindex list quoting
10196 This item doubles any occurrence of the separator character
10197 in the given string.
10198 An empty string is replaced with a single space.
10199 This converts the string into a safe form for use as a list element,
10200 in a list using the given separator.
10201 .wen
10202
10203
10204 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10205         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10206        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10207         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10208 .cindex "expansion" "lookup in"
10209 .cindex "file" "lookups"
10210 .cindex "lookup" "in expanded string"
10211 The two forms of lookup item specify data lookups in files and databases, as
10212 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10213 lookups, and the second is used for query-style lookups. The <&'key'&>,
10214 <&'file'&>, and <&'query'&> strings are expanded before use.
10215
10216 If there is any white space in a lookup item which is part of a filter command,
10217 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10218 other place where white space is significant, the lookup item must be enclosed
10219 in double quotes. The use of data lookups in users' filter files may be locked
10220 out by the system administrator.
10221
10222 .vindex "&$value$&"
10223 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10224 During its expansion, the variable &$value$& contains the data returned by the
10225 lookup. Afterwards it reverts to the value it had previously (at the outer
10226 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10227 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10228 string on failure. If <&'string2'&> is provided, it can itself be a nested
10229 lookup, thus providing a mechanism for looking up a default value when the
10230 original lookup fails.
10231
10232 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10233 data for the outer lookup while the parameters of the second lookup are
10234 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10235 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10236 appear, and in this case, if the lookup fails, the entire expansion is forced
10237 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10238 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10239 successful lookup, and nothing in the case of failure.
10240
10241 For single-key lookups, the string &"partial"& is permitted to precede the
10242 search type in order to do partial matching, and * or *@ may follow a search
10243 type to request default lookups if the key does not match (see sections
10244 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10245
10246 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10247 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10248 and non-wild parts of the key during the expansion of the replacement text.
10249 They return to their previous values at the end of the lookup item.
10250
10251 This example looks up the postmaster alias in the conventional alias file:
10252 .code
10253 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10254 .endd
10255 This example uses NIS+ to look up the full name of the user corresponding to
10256 the local part of an address, forcing the expansion to fail if it is not found:
10257 .code
10258 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10259   {$value}fail}
10260 .endd
10261
10262
10263 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10264 .cindex "expansion" "list creation"
10265 .vindex "&$item$&"
10266 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10267 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10268 For each item
10269 in this list, its value is place in &$item$&, and then <&'string2'&> is
10270 expanded and added to the output as an item in a new list. The separator used
10271 for the output list is the same as the one used for the input, but a separator
10272 setting is not included in the output. For example:
10273 .code
10274 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10275 .endd
10276 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10277 value of &$item$& is restored to what it was before. See also the &%filter%&
10278 and &%reduce%& expansion items.
10279
10280 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10281 .cindex "expansion" "numeric hash"
10282 .cindex "hash function" "numeric"
10283 The three strings are expanded; the first two must yield numbers. Call them
10284 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10285 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10286 can use the simpler operator notation that avoids some of the braces:
10287 .code
10288 ${nhash_<n>_<m>:<string>}
10289 .endd
10290 The second number is optional (in both notations). If there is only one number,
10291 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10292 processed by a div/mod hash function that returns two numbers, separated by a
10293 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10294 example,
10295 .code
10296 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10297 .endd
10298 returns the string &"6/33"&.
10299
10300
10301
10302 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10303 .cindex "Perl" "use in expanded string"
10304 .cindex "expansion" "calling Perl from"
10305 This item is available only if Exim has been built to include an embedded Perl
10306 interpreter. The subroutine name and the arguments are first separately
10307 expanded, and then the Perl subroutine is called with those arguments. No
10308 additional arguments need be given; the maximum number permitted, including the
10309 name of the subroutine, is nine.
10310
10311 The return value of the subroutine is inserted into the expanded string, unless
10312 the return value is &%undef%&. In that case, the expansion fails in the same
10313 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10314 Whatever you return is evaluated in a scalar context. For example, if you
10315 return the name of a Perl vector, the return value is the size of the vector,
10316 not its contents.
10317
10318 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10319 with the error message that was passed to &%die%&. More details of the embedded
10320 Perl facility are given in chapter &<<CHAPperl>>&.
10321
10322 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10323 out the use of this expansion item in filter files.
10324
10325
10326 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10327 .cindex "&%prvs%& expansion item"
10328 The first argument is a complete email address and the second is secret
10329 keystring. The third argument, specifying a key number, is optional. If absent,
10330 it defaults to 0. The result of the expansion is a prvs-signed email address,
10331 to be typically used with the &%return_path%& option on an &(smtp)& transport
10332 as part of a bounce address tag validation (BATV) scheme. For more discussion
10333 and an example, see section &<<SECTverifyPRVS>>&.
10334
10335 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10336         {*&<&'string'&>&*}}*&"
10337 .cindex "&%prvscheck%& expansion item"
10338 This expansion item is the complement of the &%prvs%& item. It is used for
10339 checking prvs-signed addresses. If the expansion of the first argument does not
10340 yield a syntactically valid prvs-signed address, the whole item expands to the
10341 empty string. When the first argument does expand to a syntactically valid
10342 prvs-signed address, the second argument is expanded, with the prvs-decoded
10343 version of the address and the key number extracted from the address in the
10344 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10345
10346 These two variables can be used in the expansion of the second argument to
10347 retrieve the secret. The validity of the prvs-signed address is then checked
10348 against the secret. The result is stored in the variable &$prvscheck_result$&,
10349 which is empty for failure or &"1"& for success.
10350
10351 The third argument is optional; if it is missing, it defaults to an empty
10352 string. This argument is now expanded. If the result is an empty string, the
10353 result of the expansion is the decoded version of the address. This is the case
10354 whether or not the signature was valid. Otherwise, the result of the expansion
10355 is the expansion of the third argument.
10356
10357 All three variables can be used in the expansion of the third argument.
10358 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10359 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10360
10361 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10362 .cindex "expansion" "inserting an entire file"
10363 .cindex "file" "inserting into expansion"
10364 .cindex "&%readfile%& expansion item"
10365 The filename and end-of-line string are first expanded separately. The file is
10366 then read, and its contents replace the entire item. All newline characters in
10367 the file are replaced by the end-of-line string if it is present. Otherwise,
10368 newlines are left in the string.
10369 String expansion is not applied to the contents of the file. If you want this,
10370 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10371 the string expansion fails.
10372
10373 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10374 locks out the use of this expansion item in filter files.
10375
10376
10377
10378 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10379         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10380 .cindex "expansion" "inserting from a socket"
10381 .cindex "socket, use of in expansion"
10382 .cindex "&%readsocket%& expansion item"
10383 This item inserts data from a Unix domain or TCP socket into the expanded
10384 string. The minimal way of using it uses just two arguments, as in these
10385 examples:
10386 .code
10387 ${readsocket{/socket/name}{request string}}
10388 ${readsocket{inet:some.host:1234}{request string}}
10389 .endd
10390 For a Unix domain socket, the first substring must be the path to the socket.
10391 For an Internet socket, the first substring must contain &`inet:`& followed by
10392 a host name or IP address, followed by a colon and a port, which can be a
10393 number or the name of a TCP port in &_/etc/services_&. An IP address may
10394 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10395 example:
10396 .code
10397 ${readsocket{inet:[::1]:1234}{request string}}
10398 .endd
10399 Only a single host name may be given, but if looking it up yields more than
10400 one IP address, they are each tried in turn until a connection is made. For
10401 both kinds of socket, Exim makes a connection, writes the request string
10402 unless it is an empty string; and no terminating NUL is ever sent)
10403 and reads from the socket until an end-of-file
10404 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10405 extend what can be done. Firstly, you can vary the timeout. For example:
10406 .code
10407 ${readsocket{/socket/name}{request string}{3s}}
10408 .endd
10409
10410 The third argument is a list of options, of which the first element is the timeout
10411 and must be present if any options are given.
10412 Further elements are options of form &'name=value'&.
10413 Example:
10414 .code
10415 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10416 .endd
10417
10418 The following option names are recognised:
10419 .ilist
10420 &*cache*&
10421 Defines if the result data can be cached for use by a later identical
10422 request in the same process.
10423 Values are &"yes"& or &"no"& (the default).
10424 If not, all cached results for this connection specification
10425 will be invalidated.
10426
10427 .next
10428 &*shutdown*&
10429 Defines whether or not a write-shutdown is done on the connection after
10430 sending the request. Values are &"yes"& (the default) or &"no"&
10431 (preferred, eg. by some webservers).
10432
10433 .next
10434 &*tls*&
10435 Controls the use of TLS on the connection.
10436 Values are &"yes"& or &"no"& (the default).
10437 If it is enabled, a shutdown as descripbed above is never done.
10438 .endlist
10439
10440
10441 A fourth argument allows you to change any newlines that are in the data
10442 that is read, in the same way as for &%readfile%& (see above). This example
10443 turns them into spaces:
10444 .code
10445 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10446 .endd
10447 As with all expansions, the substrings are expanded before the processing
10448 happens. Errors in these sub-expansions cause the expansion to fail. In
10449 addition, the following errors can occur:
10450
10451 .ilist
10452 Failure to create a socket file descriptor;
10453 .next
10454 Failure to connect the socket;
10455 .next
10456 Failure to write the request string;
10457 .next
10458 Timeout on reading from the socket.
10459 .endlist
10460
10461 By default, any of these errors causes the expansion to fail. However, if
10462 you supply a fifth substring, it is expanded and used when any of the above
10463 errors occurs. For example:
10464 .code
10465 ${readsocket{/socket/name}{request string}{3s}{\n}\
10466   {socket failure}}
10467 .endd
10468 You can test for the existence of a Unix domain socket by wrapping this
10469 expansion in &`${if exists`&, but there is a race condition between that test
10470 and the actual opening of the socket, so it is safer to use the fifth argument
10471 if you want to be absolutely sure of avoiding an expansion error for a
10472 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10473
10474 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10475 locks out the use of this expansion item in filter files.
10476
10477
10478 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10479 .cindex "expansion" "reducing a list to a scalar"
10480 .cindex "list" "reducing to a scalar"
10481 .vindex "&$value$&"
10482 .vindex "&$item$&"
10483 This operation reduces a list to a single, scalar string. After expansion,
10484 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10485 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10486 Then <&'string2'&> is expanded and
10487 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10488 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10489 them. The result of that expansion is assigned to &$value$& before the next
10490 iteration. When the end of the list is reached, the final value of &$value$& is
10491 added to the expansion output. The &%reduce%& expansion item can be used in a
10492 number of ways. For example, to add up a list of numbers:
10493 .code
10494 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10495 .endd
10496 The result of that expansion would be &`6`&. The maximum of a list of numbers
10497 can be found:
10498 .code
10499 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10500 .endd
10501 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10502 restored to what they were before. See also the &%filter%& and &%map%&
10503 expansion items.
10504
10505 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10506 This item inserts &"raw"& header lines. It is described with the &%header%&
10507 expansion item in section &<<SECTexpansionitems>>& above.
10508
10509 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10510         {*&<&'string2'&>&*}}*&"
10511 .cindex "expansion" "running a command"
10512 .cindex "&%run%& expansion item"
10513 The command and its arguments are first expanded as one string. The string is
10514 split apart into individual arguments by spaces, and then the command is run
10515 in a separate process, but under the same uid and gid.  As in other command
10516 executions from Exim, a shell is not used by default. If the command requires
10517 a shell, you must explicitly code it.
10518
10519 Since the arguments are split by spaces, when there is a variable expansion
10520 which has an empty result, it will cause the situation that the argument will
10521 simply be omitted when the program is actually executed by Exim. If the
10522 script/program requires a specific number of arguments and the expanded
10523 variable could possibly result in this empty expansion, the variable must be
10524 quoted. This is more difficult if the expanded variable itself could result
10525 in a string containing quotes, because it would interfere with the quotes
10526 around the command arguments. A possible guard against this is to wrap the
10527 variable in the &%sg%& operator to change any quote marks to some other
10528 character.
10529
10530 The standard input for the command exists, but is empty. The standard output
10531 and standard error are set to the same file descriptor.
10532 .cindex "return code" "from &%run%& expansion"
10533 .vindex "&$value$&"
10534 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10535 and replaces the entire item; during this expansion, the standard output/error
10536 from the command is in the variable &$value$&. If the command fails,
10537 <&'string2'&>, if present, is expanded and used. Once again, during the
10538 expansion, the standard output/error from the command is in the variable
10539 &$value$&.
10540
10541 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10542 can be the word &"fail"& (not in braces) to force expansion failure if the
10543 command does not succeed. If both strings are omitted, the result is contents
10544 of the standard output/error on success, and nothing on failure.
10545
10546 .vindex "&$run_in_acl$&"
10547 The standard output/error of the command is put in the variable &$value$&.
10548 In this ACL example, the output of a command is logged for the admin to
10549 troubleshoot:
10550 .code
10551 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10552       log_message  = Output of id: $value
10553 .endd
10554 If the command requires shell idioms, such as the > redirect operator, the
10555 shell must be invoked directly, such as with:
10556 .code
10557 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10558 .endd
10559
10560 .vindex "&$runrc$&"
10561 The return code from the command is put in the variable &$runrc$&, and this
10562 remains set afterwards, so in a filter file you can do things like this:
10563 .code
10564 if "${run{x y z}{}}$runrc" is 1 then ...
10565   elif $runrc is 2 then ...
10566   ...
10567 endif
10568 .endd
10569 If execution of the command fails (for example, the command does not exist),
10570 the return code is 127 &-- the same code that shells use for non-existent
10571 commands.
10572
10573 &*Warning*&: In a router or transport, you cannot assume the order in which
10574 option values are expanded, except for those preconditions whose order of
10575 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10576 by the expansion of one option, and use it in another.
10577
10578 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10579 out the use of this expansion item in filter files.
10580
10581
10582 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10583 .cindex "expansion" "string substitution"
10584 .cindex "&%sg%& expansion item"
10585 This item works like Perl's substitution operator (s) with the global (/g)
10586 option; hence its name. However, unlike the Perl equivalent, Exim does not
10587 modify the subject string; instead it returns the modified string for insertion
10588 into the overall expansion. The item takes three arguments: the subject string,
10589 a regular expression, and a substitution string. For example:
10590 .code
10591 ${sg{abcdefabcdef}{abc}{xyz}}
10592 .endd
10593 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10594 if any $, } or \ characters are required in the regular expression or in the
10595 substitution string, they have to be escaped. For example:
10596 .code
10597 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10598 .endd
10599 yields &"defabc"&, and
10600 .code
10601 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10602 .endd
10603 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10604 the regular expression from string expansion.
10605
10606 The regular expression is compiled in 8-bit mode, working against bytes
10607 rather than any Unicode-aware character handling.
10608
10609
10610 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10611 .cindex sorting "a list"
10612 .cindex list sorting
10613 .cindex expansion "list sorting"
10614 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10615 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10616 The <&'comparator'&> argument is interpreted as the operator
10617 of a two-argument expansion condition.
10618 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10619 The comparison should return true when applied to two values
10620 if the first value should sort before the second value.
10621 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10622 the element being placed in &$item$&,
10623 to give values for comparison.
10624
10625 The item result is a sorted list,
10626 with the original list separator,
10627 of the list elements (in full) of the original.
10628
10629 Examples:
10630 .code
10631 ${sort{3:2:1:4}{<}{$item}}
10632 .endd
10633 sorts a list of numbers, and
10634 .code
10635 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10636 .endd
10637 will sort an MX lookup into priority order.
10638
10639
10640
10641 .new
10642 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10643 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10644 .wen
10645
10646
10647
10648 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10649 .cindex "&%substr%& expansion item"
10650 .cindex "substring extraction"
10651 .cindex "expansion" "substring extraction"
10652 The three strings are expanded; the first two must yield numbers. Call them
10653 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10654 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10655 can use the simpler operator notation that avoids some of the braces:
10656 .code
10657 ${substr_<n>_<m>:<string>}
10658 .endd
10659 The second number is optional (in both notations).
10660 If it is absent in the simpler format, the preceding underscore must also be
10661 omitted.
10662
10663 The &%substr%& item can be used to extract more general substrings than
10664 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10665 length required. For example
10666 .code
10667 ${substr{3}{2}{$local_part}}
10668 .endd
10669 If the starting offset is greater than the string length the result is the
10670 null string; if the length plus starting offset is greater than the string
10671 length, the result is the right-hand part of the string, starting from the
10672 given offset. The first byte (character) in the string has offset zero.
10673
10674 The &%substr%& expansion item can take negative offset values to count
10675 from the right-hand end of its operand. The last byte (character) is offset -1,
10676 the second-last is offset -2, and so on. Thus, for example,
10677 .code
10678 ${substr{-5}{2}{1234567}}
10679 .endd
10680 yields &"34"&. If the absolute value of a negative offset is greater than the
10681 length of the string, the substring starts at the beginning of the string, and
10682 the length is reduced by the amount of overshoot. Thus, for example,
10683 .code
10684 ${substr{-5}{2}{12}}
10685 .endd
10686 yields an empty string, but
10687 .code
10688 ${substr{-3}{2}{12}}
10689 .endd
10690 yields &"1"&.
10691
10692 When the second number is omitted from &%substr%&, the remainder of the string
10693 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10694 string preceding the offset point are taken. For example, an offset of -1 and
10695 no length, as in these semantically identical examples:
10696 .code
10697 ${substr_-1:abcde}
10698 ${substr{-1}{abcde}}
10699 .endd
10700 yields all but the last character of the string, that is, &"abcd"&.
10701
10702 All measurement is done in bytes and is not UTF-8 aware.
10703
10704
10705
10706 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10707         {*&<&'replacements'&>&*}}*&"
10708 .cindex "expansion" "character translation"
10709 .cindex "&%tr%& expansion item"
10710 This item does single-character (in bytes) translation on its subject string. The second
10711 argument is a list of characters to be translated in the subject string. Each
10712 matching character is replaced by the corresponding character from the
10713 replacement list. For example
10714 .code
10715 ${tr{abcdea}{ac}{13}}
10716 .endd
10717 yields &`1b3de1`&. If there are duplicates in the second character string, the
10718 last occurrence is used. If the third string is shorter than the second, its
10719 last character is replicated. However, if it is empty, no translation takes
10720 place.
10721
10722 All character handling is done in bytes and is not UTF-8 aware.
10723
10724 .endlist
10725
10726
10727
10728 .section "Expansion operators" "SECTexpop"
10729 .cindex "expansion" "operators"
10730 For expansion items that perform transformations on a single argument string,
10731 the &"operator"& notation is used because it is simpler and uses fewer braces.
10732 The substring is first expanded before the operation is applied to it. The
10733 following operations can be performed:
10734
10735 .vlist
10736 .vitem &*${address:*&<&'string'&>&*}*&
10737 .cindex "expansion" "RFC 2822 address handling"
10738 .cindex "&%address%& expansion item"
10739 The string is interpreted as an RFC 2822 address, as it might appear in a
10740 header line, and the effective address is extracted from it. If the string does
10741 not parse successfully, the result is empty.
10742
10743 The parsing correctly handles SMTPUTF8 Unicode in the string.
10744
10745
10746 .vitem &*${addresses:*&<&'string'&>&*}*&
10747 .cindex "expansion" "RFC 2822 address handling"
10748 .cindex "&%addresses%& expansion item"
10749 The string (after expansion) is interpreted as a list of addresses in RFC
10750 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10751 operative address (&'local-part@domain'&) is extracted from each item, and the
10752 result of the expansion is a colon-separated list, with appropriate
10753 doubling of colons should any happen to be present in the email addresses.
10754 Syntactically invalid RFC2822 address items are omitted from the output.
10755
10756 It is possible to specify a character other than colon for the output
10757 separator by starting the string with > followed by the new separator
10758 character. For example:
10759 .code
10760 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10761 .endd
10762 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10763 first, so if the expanded string starts with >, it may change the output
10764 separator unintentionally. This can be avoided by setting the output
10765 separator explicitly:
10766 .code
10767 ${addresses:>:$h_from:}
10768 .endd
10769
10770 Compare the &%address%& (singular)
10771 expansion item, which extracts the working address from a single RFC2822
10772 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10773 processing lists.
10774
10775 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10776 a strict interpretation of header line formatting.  Exim parses the bare,
10777 unquoted portion of an email address and if it finds a comma, treats it as an
10778 email address separator. For the example header line:
10779 .code
10780 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10781 .endd
10782 The first example below demonstrates that Q-encoded email addresses are parsed
10783 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10784 It does not see the comma because it's still encoded as "=2C".  The second
10785 example below is passed the contents of &`$header_from:`&, meaning it gets
10786 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10787 The third example shows that the presence of a comma is skipped when it is
10788 quoted.  The fourth example shows SMTPUTF8 handling.
10789 .code
10790 # exim -be '${addresses:From: \
10791 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10792 user@example.com
10793 # exim -be '${addresses:From: Last, First <user@example.com>}'
10794 Last:user@example.com
10795 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10796 user@example.com
10797 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10798 フィリップ@example.jp
10799 .endd
10800
10801 .vitem &*${base32:*&<&'digits'&>&*}*&
10802 .cindex "&%base32%& expansion item"
10803 .cindex "expansion" "conversion to base 32"
10804 The string must consist entirely of decimal digits. The number is converted to
10805 base 32 and output as a (empty, for zero) string of characters.
10806 Only lowercase letters are used.
10807
10808 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10809 .cindex "&%base32d%& expansion item"
10810 .cindex "expansion" "conversion to base 32"
10811 The string must consist entirely of base-32 digits.
10812 The number is converted to decimal and output as a string.
10813
10814 .vitem &*${base62:*&<&'digits'&>&*}*&
10815 .cindex "&%base62%& expansion item"
10816 .cindex "expansion" "conversion to base 62"
10817 The string must consist entirely of decimal digits. The number is converted to
10818 base 62 and output as a string of six characters, including leading zeros. In
10819 the few operating environments where Exim uses base 36 instead of base 62 for
10820 its message identifiers (because those systems do not have case-sensitive
10821 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10822 to be absolutely clear: this is &'not'& base64 encoding.
10823
10824 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10825 .cindex "&%base62d%& expansion item"
10826 .cindex "expansion" "conversion to base 62"
10827 The string must consist entirely of base-62 digits, or, in operating
10828 environments where Exim uses base 36 instead of base 62 for its message
10829 identifiers, base-36 digits. The number is converted to decimal and output as a
10830 string.
10831
10832 .vitem &*${base64:*&<&'string'&>&*}*&
10833 .cindex "expansion" "base64 encoding"
10834 .cindex "base64 encoding" "in string expansion"
10835 .cindex "&%base64%& expansion item"
10836 .cindex certificate "base64 of DER"
10837 This operator converts a string into one that is base64 encoded.
10838
10839 If the string is a single variable of type certificate,
10840 returns the base64 encoding of the DER form of the certificate.
10841
10842
10843 .vitem &*${base64d:*&<&'string'&>&*}*&
10844 .cindex "expansion" "base64 decoding"
10845 .cindex "base64 decoding" "in string expansion"
10846 .cindex "&%base64d%& expansion item"
10847 This operator converts a base64-encoded string into the un-coded form.
10848
10849
10850 .vitem &*${domain:*&<&'string'&>&*}*&
10851 .cindex "domain" "extraction"
10852 .cindex "expansion" "domain extraction"
10853 The string is interpreted as an RFC 2822 address and the domain is extracted
10854 from it. If the string does not parse successfully, the result is empty.
10855
10856
10857 .vitem &*${escape:*&<&'string'&>&*}*&
10858 .cindex "expansion" "escaping non-printing characters"
10859 .cindex "&%escape%& expansion item"
10860 If the string contains any non-printing characters, they are converted to
10861 escape sequences starting with a backslash. Whether characters with the most
10862 significant bit set (so-called &"8-bit characters"&) count as printing or not
10863 is controlled by the &%print_topbitchars%& option.
10864
10865 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10866 .cindex "expansion" "escaping 8-bit characters"
10867 .cindex "&%escape8bit%& expansion item"
10868 If the string contains and characters with the most significant bit set,
10869 they are converted to escape sequences starting with a backslash.
10870 Backslashes and DEL characters are also converted.
10871
10872
10873 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10874 .cindex "expansion" "expression evaluation"
10875 .cindex "expansion" "arithmetic expression"
10876 .cindex "&%eval%& expansion item"
10877 These items supports simple arithmetic and bitwise logical operations in
10878 expansion strings. The string (after expansion) must be a conventional
10879 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10880 logical operators, and parentheses. All operations are carried out using
10881 integer arithmetic. The operator priorities are as follows (the same as in the
10882 C programming language):
10883 .table2 70pt 300pt
10884 .irow &'highest:'& "not (~), negate (-)"
10885 .irow ""   "multiply (*), divide (/), remainder (%)"
10886 .irow ""   "plus (+), minus (-)"
10887 .irow ""   "shift-left (<<), shift-right (>>)"
10888 .irow ""   "and (&&)"
10889 .irow ""   "xor (^)"
10890 .irow &'lowest:'&  "or (|)"
10891 .endtable
10892 Binary operators with the same priority are evaluated from left to right. White
10893 space is permitted before or after operators.
10894
10895 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10896 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10897 decimal, even if they start with a leading zero; hexadecimal numbers are not
10898 permitted. This can be useful when processing numbers extracted from dates or
10899 times, which often do have leading zeros.
10900
10901 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10902 or 1024*1024*1024,
10903 respectively. Negative numbers are supported. The result of the computation is
10904 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10905
10906 .display
10907 &`${eval:1+1}            `&  yields 2
10908 &`${eval:1+2*3}          `&  yields 7
10909 &`${eval:(1+2)*3}        `&  yields 9
10910 &`${eval:2+42%5}         `&  yields 4
10911 &`${eval:0xc&amp;5}          `&  yields 4
10912 &`${eval:0xc|5}          `&  yields 13
10913 &`${eval:0xc^5}          `&  yields 9
10914 &`${eval:0xc>>1}         `&  yields 6
10915 &`${eval:0xc<<1}         `&  yields 24
10916 &`${eval:~255&amp;0x1234}    `&  yields 4608
10917 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10918 .endd
10919
10920 As a more realistic example, in an ACL you might have
10921 .code
10922 deny   condition =                    \
10923          ${if and {                   \
10924            {>{$rcpt_count}{10}}       \
10925            {                          \
10926            <                          \
10927              {$recipients_count}      \
10928              {${eval:$rcpt_count/2}}  \
10929            }                          \
10930          }{yes}{no}}
10931        message = Too many bad recipients
10932 .endd
10933 The condition is true if there have been more than 10 RCPT commands and
10934 fewer than half of them have resulted in a valid recipient.
10935
10936
10937 .vitem &*${expand:*&<&'string'&>&*}*&
10938 .cindex "expansion" "re-expansion of substring"
10939 The &%expand%& operator causes a string to be expanded for a second time. For
10940 example,
10941 .code
10942 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10943 .endd
10944 first looks up a string in a file while expanding the operand for &%expand%&,
10945 and then re-expands what it has found.
10946
10947
10948 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10949 .cindex "Unicode"
10950 .cindex "UTF-8" "conversion from"
10951 .cindex "expansion" "UTF-8 conversion"
10952 .cindex "&%from_utf8%& expansion item"
10953 The world is slowly moving towards Unicode, although there are no standards for
10954 email yet. However, other applications (including some databases) are starting
10955 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10956 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10957 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10958 the result is an undefined sequence of bytes.
10959
10960 Unicode code points with values less than 256 are compatible with ASCII and
10961 ISO-8859-1 (also known as Latin-1).
10962 For example, character 169 is the copyright symbol in both cases, though the
10963 way it is encoded is different. In UTF-8, more than one byte is needed for
10964 characters with code values greater than 127, whereas ISO-8859-1 is a
10965 single-byte encoding (but thereby limited to 256 characters). This makes
10966 translation from UTF-8 to ISO-8859-1 straightforward.
10967
10968
10969 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10970 .cindex "hash function" "textual"
10971 .cindex "expansion" "textual hash"
10972 The &%hash%& operator is a simpler interface to the hashing function that can
10973 be used when the two parameters are fixed numbers (as opposed to strings that
10974 change when expanded). The effect is the same as
10975 .code
10976 ${hash{<n>}{<m>}{<string>}}
10977 .endd
10978 See the description of the general &%hash%& item above for details. The
10979 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10980
10981
10982
10983 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10984 .cindex "base64 encoding" "conversion from hex"
10985 .cindex "expansion" "hex to base64"
10986 .cindex "&%hex2b64%& expansion item"
10987 This operator converts a hex string into one that is base64 encoded. This can
10988 be useful for processing the output of the various hashing functions.
10989
10990
10991
10992 .vitem &*${hexquote:*&<&'string'&>&*}*&
10993 .cindex "quoting" "hex-encoded unprintable characters"
10994 .cindex "&%hexquote%& expansion item"
10995 This operator converts non-printable characters in a string into a hex
10996 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10997 as is, and other byte values are converted to &`\xNN`&, for example, a
10998 byte value 127 is converted to &`\x7f`&.
10999
11000
11001 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11002 .cindex "&%ipv6denorm%& expansion item"
11003 .cindex "IP address" normalisation
11004 This expands an IPv6 address to a full eight-element colon-separated set
11005 of hex digits including leading zeroes.
11006 A trailing ipv4-style dotted-decimal set is converted to hex.
11007 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11008
11009 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11010 .cindex "&%ipv6norm%& expansion item"
11011 .cindex "IP address" normalisation
11012 .cindex "IP address" "canonical form"
11013 This converts an IPv6 address to canonical form.
11014 Leading zeroes of groups are omitted, and the longest
11015 set of zero-valued groups is replaced with a double colon.
11016 A trailing ipv4-style dotted-decimal set is converted to hex.
11017 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11018
11019
11020 .vitem &*${lc:*&<&'string'&>&*}*&
11021 .cindex "case forcing in strings"
11022 .cindex "string" "case forcing"
11023 .cindex "lower casing"
11024 .cindex "expansion" "case forcing"
11025 .cindex "&%lc%& expansion item"
11026 This forces the letters in the string into lower-case, for example:
11027 .code
11028 ${lc:$local_part}
11029 .endd
11030 Case is defined per the system C locale.
11031
11032 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11033 .cindex "expansion" "string truncation"
11034 .cindex "&%length%& expansion item"
11035 The &%length%& operator is a simpler interface to the &%length%& function that
11036 can be used when the parameter is a fixed number (as opposed to a string that
11037 changes when expanded). The effect is the same as
11038 .code
11039 ${length{<number>}{<string>}}
11040 .endd
11041 See the description of the general &%length%& item above for details. Note that
11042 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11043 when &%length%& is used as an operator.
11044 All measurement is done in bytes and is not UTF-8 aware.
11045
11046
11047 .vitem &*${listcount:*&<&'string'&>&*}*&
11048 .cindex "expansion" "list item count"
11049 .cindex "list" "item count"
11050 .cindex "list" "count of items"
11051 .cindex "&%listcount%& expansion item"
11052 The string is interpreted as a list and the number of items is returned.
11053
11054
11055 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11056 .cindex "expansion" "named list"
11057 .cindex "&%listnamed%& expansion item"
11058 The name is interpreted as a named list and the content of the list is returned,
11059 expanding any referenced lists, re-quoting as needed for colon-separation.
11060 If the optional type is given it must be one of "a", "d", "h" or "l"
11061 and selects address-, domain-, host- or localpart- lists to search among respectively.
11062 Otherwise all types are searched in an undefined order and the first
11063 matching list is returned.
11064
11065
11066 .vitem &*${local_part:*&<&'string'&>&*}*&
11067 .cindex "expansion" "local part extraction"
11068 .cindex "&%local_part%& expansion item"
11069 The string is interpreted as an RFC 2822 address and the local part is
11070 extracted from it. If the string does not parse successfully, the result is
11071 empty.
11072 The parsing correctly handles SMTPUTF8 Unicode in the string.
11073
11074
11075 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11076 .cindex "masked IP address"
11077 .cindex "IP address" "masking"
11078 .cindex "CIDR notation"
11079 .cindex "expansion" "IP address masking"
11080 .cindex "&%mask%& expansion item"
11081 If the form of the string to be operated on is not an IP address followed by a
11082 slash and an integer (that is, a network address in CIDR notation), the
11083 expansion fails. Otherwise, this operator converts the IP address to binary,
11084 masks off the least significant bits according to the bit count, and converts
11085 the result back to text, with mask appended. For example,
11086 .code
11087 ${mask:10.111.131.206/28}
11088 .endd
11089 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11090 be mostly used for looking up masked addresses in files, the result for an IPv6
11091 address uses dots to separate components instead of colons, because colon
11092 terminates a key string in lsearch files. So, for example,
11093 .code
11094 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11095 .endd
11096 returns the string
11097 .code
11098 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11099 .endd
11100 Letters in IPv6 addresses are always output in lower case.
11101
11102
11103 .vitem &*${md5:*&<&'string'&>&*}*&
11104 .cindex "MD5 hash"
11105 .cindex "expansion" "MD5 hash"
11106 .cindex certificate fingerprint
11107 .cindex "&%md5%& expansion item"
11108 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11109 as a 32-digit hexadecimal number, in which any letters are in lower case.
11110
11111 If the string is a single variable of type certificate,
11112 returns the MD5 hash fingerprint of the certificate.
11113
11114
11115 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11116 .cindex "expansion" "numeric hash"
11117 .cindex "hash function" "numeric"
11118 The &%nhash%& operator is a simpler interface to the numeric hashing function
11119 that can be used when the two parameters are fixed numbers (as opposed to
11120 strings that change when expanded). The effect is the same as
11121 .code
11122 ${nhash{<n>}{<m>}{<string>}}
11123 .endd
11124 See the description of the general &%nhash%& item above for details.
11125
11126
11127 .vitem &*${quote:*&<&'string'&>&*}*&
11128 .cindex "quoting" "in string expansions"
11129 .cindex "expansion" "quoting"
11130 .cindex "&%quote%& expansion item"
11131 The &%quote%& operator puts its argument into double quotes if it
11132 is an empty string or
11133 contains anything other than letters, digits, underscores, dots, and hyphens.
11134 Any occurrences of double quotes and backslashes are escaped with a backslash.
11135 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11136 respectively For example,
11137 .code
11138 ${quote:ab"*"cd}
11139 .endd
11140 becomes
11141 .code
11142 "ab\"*\"cd"
11143 .endd
11144 The place where this is useful is when the argument is a substitution from a
11145 variable or a message header.
11146
11147 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11148 .cindex "&%quote_local_part%& expansion item"
11149 This operator is like &%quote%&, except that it quotes the string only if
11150 required to do so by the rules of RFC 2822 for quoting local parts. For
11151 example, a plus sign would not cause quoting (but it would for &%quote%&).
11152 If you are creating a new email address from the contents of &$local_part$&
11153 (or any other unknown data), you should always use this operator.
11154
11155 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11156 will likely use the quoting form.
11157 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11158
11159
11160 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11161 .cindex "quoting" "lookup-specific"
11162 This operator applies lookup-specific quoting rules to the string. Each
11163 query-style lookup type has its own quoting rules which are described with
11164 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11165 .code
11166 ${quote_ldap:two * two}
11167 .endd
11168 returns
11169 .code
11170 two%20%5C2A%20two
11171 .endd
11172 For single-key lookup types, no quoting is ever necessary and this operator
11173 yields an unchanged string.
11174
11175
11176 .vitem &*${randint:*&<&'n'&>&*}*&
11177 .cindex "random number"
11178 This operator returns a somewhat random number which is less than the
11179 supplied number and is at least 0.  The quality of this randomness depends
11180 on how Exim was built; the values are not suitable for keying material.
11181 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11182 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11183 for versions of GnuTLS with that function.
11184 Otherwise, the implementation may be arc4random(), random() seeded by
11185 srandomdev() or srandom(), or a custom implementation even weaker than
11186 random().
11187
11188
11189 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11190 .cindex "expansion" "IP address"
11191 This operator reverses an IP address; for IPv4 addresses, the result is in
11192 dotted-quad decimal form, while for IPv6 addresses the result is in
11193 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11194 for DNS.  For example,
11195 .code
11196 ${reverse_ip:192.0.2.4}
11197 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11198 .endd
11199 returns
11200 .code
11201 4.2.0.192
11202 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
11203 .endd
11204
11205
11206 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11207 .cindex "expansion" "RFC 2047"
11208 .cindex "RFC 2047" "expansion operator"
11209 .cindex "&%rfc2047%& expansion item"
11210 This operator encodes text according to the rules of RFC 2047. This is an
11211 encoding that is used in header lines to encode non-ASCII characters. It is
11212 assumed that the input string is in the encoding specified by the
11213 &%headers_charset%& option, which gets its default at build time. If the string
11214 contains only characters in the range 33&--126, and no instances of the
11215 characters
11216 .code
11217 ? = ( ) < > @ , ; : \ " . [ ] _
11218 .endd
11219 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11220 string, using as many &"encoded words"& as necessary to encode all the
11221 characters.
11222
11223
11224 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11225 .cindex "expansion" "RFC 2047"
11226 .cindex "RFC 2047" "decoding"
11227 .cindex "&%rfc2047d%& expansion item"
11228 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11229 bytes are replaced by question marks. Characters are converted into the
11230 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11231 not recognized unless &%check_rfc2047_length%& is set false.
11232
11233 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11234 access a header line, RFC 2047 decoding is done automatically. You do not need
11235 to use this operator as well.
11236
11237
11238
11239 .vitem &*${rxquote:*&<&'string'&>&*}*&
11240 .cindex "quoting" "in regular expressions"
11241 .cindex "regular expressions" "quoting"
11242 .cindex "&%rxquote%& expansion item"
11243 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11244 characters in its argument. This is useful when substituting the values of
11245 variables or headers inside regular expressions.
11246
11247
11248 .vitem &*${sha1:*&<&'string'&>&*}*&
11249 .cindex "SHA-1 hash"
11250 .cindex "expansion" "SHA-1 hashing"
11251 .cindex certificate fingerprint
11252 .cindex "&%sha1%& expansion item"
11253 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11254 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11255
11256 If the string is a single variable of type certificate,
11257 returns the SHA-1 hash fingerprint of the certificate.
11258
11259
11260 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11261        &*${sha2:*&<&'string'&>&*}*& &&&
11262        &*${sha2_<n>:*&<&'string'&>&*}*&
11263 .cindex "SHA-256 hash"
11264 .cindex "SHA-2 hash"
11265 .cindex certificate fingerprint
11266 .cindex "expansion" "SHA-256 hashing"
11267 .cindex "&%sha256%& expansion item"
11268 .cindex "&%sha2%& expansion item"
11269 The &%sha256%& operator computes the SHA-256 hash value of the string
11270 and returns
11271 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11272
11273 If the string is a single variable of type certificate,
11274 returns the SHA-256 hash fingerprint of the certificate.
11275
11276 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11277 (except for certificates, which are not supported).
11278 Finally, if an underbar
11279 and a number is appended it specifies the output length, selecting a
11280 member of the SHA-2 family of hash functions.
11281 Values of 256, 384 and 512 are accepted, with 256 being the default.
11282
11283
11284 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11285        &*${sha3_<n>:*&<&'string'&>&*}*&
11286 .cindex "SHA3 hash"
11287 .cindex "expansion" "SHA3 hashing"
11288 .cindex "&%sha3%& expansion item"
11289 The &%sha3%& operator computes the SHA3-256 hash value of the string
11290 and returns
11291 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11292
11293 If a number is appended, separated by an underbar, it specifies
11294 the output length.  Values of 224, 256, 384 and 512 are accepted;
11295 with 256 being the default.
11296
11297 The &%sha3%& expansion item is only supported if Exim has been
11298 compiled with GnuTLS 3.5.0 or later,
11299 or OpenSSL 1.1.1 or later.
11300 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11301
11302
11303 .vitem &*${stat:*&<&'string'&>&*}*&
11304 .cindex "expansion" "statting a file"
11305 .cindex "file" "extracting characteristics"
11306 .cindex "&%stat%& expansion item"
11307 The string, after expansion, must be a file path. A call to the &[stat()]&
11308 function is made for this path. If &[stat()]& fails, an error occurs and the
11309 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11310 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11311 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11312 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11313 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11314 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11315 can extract individual fields using the &%extract%& expansion item.
11316
11317 The use of the &%stat%& expansion in users' filter files can be locked out by
11318 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11319 systems for files larger than 2GB.
11320
11321 .vitem &*${str2b64:*&<&'string'&>&*}*&
11322 .cindex "&%str2b64%& expansion item"
11323 Now deprecated, a synonym for the &%base64%& expansion operator.
11324
11325
11326
11327 .vitem &*${strlen:*&<&'string'&>&*}*&
11328 .cindex "expansion" "string length"
11329 .cindex "string" "length in expansion"
11330 .cindex "&%strlen%& expansion item"
11331 The item is replace by the length of the expanded string, expressed as a
11332 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11333 All measurement is done in bytes and is not UTF-8 aware.
11334
11335
11336 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11337 .cindex "&%substr%& expansion item"
11338 .cindex "substring extraction"
11339 .cindex "expansion" "substring expansion"
11340 The &%substr%& operator is a simpler interface to the &%substr%& function that
11341 can be used when the two parameters are fixed numbers (as opposed to strings
11342 that change when expanded). The effect is the same as
11343 .code
11344 ${substr{<start>}{<length>}{<string>}}
11345 .endd
11346 See the description of the general &%substr%& item above for details. The
11347 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11348 All measurement is done in bytes and is not UTF-8 aware.
11349
11350 .vitem &*${time_eval:*&<&'string'&>&*}*&
11351 .cindex "&%time_eval%& expansion item"
11352 .cindex "time interval" "decoding"
11353 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11354 seconds.
11355
11356 .vitem &*${time_interval:*&<&'string'&>&*}*&
11357 .cindex "&%time_interval%& expansion item"
11358 .cindex "time interval" "formatting"
11359 The argument (after sub-expansion) must be a sequence of decimal digits that
11360 represents an interval of time as a number of seconds. It is converted into a
11361 number of larger units and output in Exim's normal time format, for example,
11362 &`1w3d4h2m6s`&.
11363
11364 .vitem &*${uc:*&<&'string'&>&*}*&
11365 .cindex "case forcing in strings"
11366 .cindex "string" "case forcing"
11367 .cindex "upper casing"
11368 .cindex "expansion" "case forcing"
11369 .cindex "&%uc%& expansion item"
11370 This forces the letters in the string into upper-case.
11371 Case is defined per the system C locale.
11372
11373 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11374 .cindex "correction of invalid utf-8 sequences in strings"
11375 .cindex "utf-8" "utf-8 sequences"
11376 .cindex "incorrect utf-8"
11377 .cindex "expansion" "utf-8 forcing"
11378 .cindex "&%utf8clean%& expansion item"
11379 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11380 In versions of Exim before 4.92, this did not correctly do so for a truncated
11381 final codepoint's encoding, and the character would be silently dropped.
11382 If you must handle detection of this scenario across both sets of Exim behavior,
11383 the complexity will depend upon the task.
11384 For instance, to detect if the first character is multibyte and a 1-byte
11385 extraction can be successfully used as a path component (as is common for
11386 dividing up delivery folders), you might use:
11387 .code
11388 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11389 .endd
11390 (which will false-positive if the first character of the local part is a
11391 literal question mark).
11392
11393 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11394        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11395        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11396        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11397 .cindex expansion UTF-8
11398 .cindex UTF-8 expansion
11399 .cindex EAI
11400 .cindex internationalisation
11401 .cindex "&%utf8_domain_to_alabel%& expansion item"
11402 .cindex "&%utf8_domain_from_alabel%& expansion item"
11403 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11404 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11405 These convert EAI mail name components between UTF-8 and a-label forms.
11406 For information on internationalisation support see &<<SECTi18nMTA>>&.
11407 .endlist
11408
11409
11410
11411
11412
11413
11414 .section "Expansion conditions" "SECTexpcond"
11415 .scindex IIDexpcond "expansion" "conditions"
11416 The following conditions are available for testing by the &%${if%& construct
11417 while expanding strings:
11418
11419 .vlist
11420 .vitem &*!*&<&'condition'&>
11421 .cindex "expansion" "negating a condition"
11422 .cindex "negation" "in expansion condition"
11423 Preceding any condition with an exclamation mark negates the result of the
11424 condition.
11425
11426 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11427 .cindex "numeric comparison"
11428 .cindex "expansion" "numeric comparison"
11429 There are a number of symbolic operators for doing numeric comparisons. They
11430 are:
11431 .display
11432 &`=   `&   equal
11433 &`==  `&   equal
11434 &`>   `&   greater
11435 &`>=  `&   greater or equal
11436 &`<   `&   less
11437 &`<=  `&   less or equal
11438 .endd
11439 For example:
11440 .code
11441 ${if >{$message_size}{10M} ...
11442 .endd
11443 Note that the general negation operator provides for inequality testing. The
11444 two strings must take the form of optionally signed decimal integers,
11445 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11446 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11447 As a special case, the numerical value of an empty string is taken as
11448 zero.
11449
11450 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11451 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11452 10M, not if 10M is larger than &$message_size$&.
11453
11454
11455 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11456         {*&<&'arg2'&>&*}...}*&
11457 .cindex "expansion" "calling an acl"
11458 .cindex "&%acl%&" "expansion condition"
11459 The name and zero to nine argument strings are first expanded separately.  The expanded
11460 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11461 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11462 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11463 and may use the variables; if another acl expansion is used the values
11464 are restored after it returns.  If the ACL sets
11465 a value using a "message =" modifier the variable $value becomes
11466 the result of the expansion, otherwise it is empty.
11467 If the ACL returns accept the condition is true; if deny, false.
11468 If the ACL returns defer the result is a forced-fail.
11469
11470 .vitem &*bool&~{*&<&'string'&>&*}*&
11471 .cindex "expansion" "boolean parsing"
11472 .cindex "&%bool%& expansion condition"
11473 This condition turns a string holding a true or false representation into
11474 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11475 (case-insensitively); also integer numbers map to true if non-zero,
11476 false if zero.
11477 An empty string is treated as false.
11478 Leading and trailing whitespace is ignored;
11479 thus a string consisting only of whitespace is false.
11480 All other string values will result in expansion failure.
11481
11482 When combined with ACL variables, this expansion condition will let you
11483 make decisions in one place and act on those decisions in another place.
11484 For example:
11485 .code
11486 ${if bool{$acl_m_privileged_sender} ...
11487 .endd
11488
11489
11490 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11491 .cindex "expansion" "boolean parsing"
11492 .cindex "&%bool_lax%& expansion condition"
11493 Like &%bool%&, this condition turns a string into a boolean state.  But
11494 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11495 loose definition that the Router &%condition%& option uses.  The empty string
11496 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11497 true.  Leading and trailing whitespace is ignored.
11498
11499 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11500
11501 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11502 .cindex "expansion" "encrypted comparison"
11503 .cindex "encrypted strings, comparing"
11504 .cindex "&%crypteq%& expansion condition"
11505 This condition is included in the Exim binary if it is built to support any
11506 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11507 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11508 included in the binary.
11509
11510 The &%crypteq%& condition has two arguments. The first is encrypted and
11511 compared against the second, which is already encrypted. The second string may
11512 be in the LDAP form for storing encrypted strings, which starts with the
11513 encryption type in curly brackets, followed by the data. If the second string
11514 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11515 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11516 Typically this will be a field from a password file. An example of an encrypted
11517 string in LDAP form is:
11518 .code
11519 {md5}CY9rzUYh03PK3k6DJie09g==
11520 .endd
11521 If such a string appears directly in an expansion, the curly brackets have to
11522 be quoted, because they are part of the expansion syntax. For example:
11523 .code
11524 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11525 .endd
11526 The following encryption types (whose names are matched case-independently) are
11527 supported:
11528
11529 .ilist
11530 .cindex "MD5 hash"
11531 .cindex "base64 encoding" "in encrypted password"
11532 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11533 printable characters to compare with the remainder of the second string. If the
11534 length of the comparison string is 24, Exim assumes that it is base64 encoded
11535 (as in the above example). If the length is 32, Exim assumes that it is a
11536 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11537 comparison fails.
11538
11539 .next
11540 .cindex "SHA-1 hash"
11541 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11542 printable characters to compare with the remainder of the second string. If the
11543 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11544 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11545 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11546
11547 .next
11548 .cindex "&[crypt()]&"
11549 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11550 only the first eight characters of the password. However, in modern operating
11551 systems this is no longer true, and in many cases the entire password is used,
11552 whatever its length.
11553
11554 .next
11555 .cindex "&[crypt16()]&"
11556 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11557 use up to 16 characters of the password in some operating systems. Again, in
11558 modern operating systems, more characters may be used.
11559 .endlist
11560 Exim has its own version of &[crypt16()]&, which is just a double call to
11561 &[crypt()]&. For operating systems that have their own version, setting
11562 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11563 operating system version instead of its own. This option is set by default in
11564 the OS-dependent &_Makefile_& for those operating systems that are known to
11565 support &[crypt16()]&.
11566
11567 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11568 it was not using the same algorithm as some operating systems' versions. It
11569 turns out that as well as &[crypt16()]& there is a function called
11570 &[bigcrypt()]& in some operating systems. This may or may not use the same
11571 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11572
11573 However, since there is now a move away from the traditional &[crypt()]&
11574 functions towards using SHA1 and other algorithms, tidying up this area of
11575 Exim is seen as very low priority.
11576
11577 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11578 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11579 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11580 default is &`{crypt}`&. Whatever the default, you can always use either
11581 function by specifying it explicitly in curly brackets.
11582
11583 .vitem &*def:*&<&'variable&~name'&>
11584 .cindex "expansion" "checking for empty variable"
11585 .cindex "&%def%& expansion condition"
11586 The &%def%& condition must be followed by the name of one of the expansion
11587 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11588 variable does not contain the empty string. For example:
11589 .code
11590 ${if def:sender_ident {from $sender_ident}}
11591 .endd
11592 Note that the variable name is given without a leading &%$%& character. If the
11593 variable does not exist, the expansion fails.
11594
11595 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11596         &~&*def:h_*&<&'header&~name'&>&*:*&"
11597 .cindex "expansion" "checking header line existence"
11598 This condition is true if a message is being processed and the named header
11599 exists in the message. For example,
11600 .code
11601 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11602 .endd
11603 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11604 the header name must be terminated by a colon if white space does not follow.
11605
11606 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11607        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11608 .cindex "string" "comparison"
11609 .cindex "expansion" "string comparison"
11610 .cindex "&%eq%& expansion condition"
11611 .cindex "&%eqi%& expansion condition"
11612 The two substrings are first expanded. The condition is true if the two
11613 resulting strings are identical. For &%eq%& the comparison includes the case of
11614 letters, whereas for &%eqi%& the comparison is case-independent, where
11615 case is defined per the system C locale.
11616
11617 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11618 .cindex "expansion" "file existence test"
11619 .cindex "file" "existence test"
11620 .cindex "&%exists%&, expansion condition"
11621 The substring is first expanded and then interpreted as an absolute path. The
11622 condition is true if the named file (or directory) exists. The existence test
11623 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11624 users' filter files may be locked out by the system administrator.
11625
11626 .vitem &*first_delivery*&
11627 .cindex "delivery" "first"
11628 .cindex "first delivery"
11629 .cindex "expansion" "first delivery test"
11630 .cindex "&%first_delivery%& expansion condition"
11631 This condition, which has no data, is true during a message's first delivery
11632 attempt. It is false during any subsequent delivery attempts.
11633
11634
11635 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11636        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11637 .cindex "list" "iterative conditions"
11638 .cindex "expansion" "&*forall*& condition"
11639 .cindex "expansion" "&*forany*& condition"
11640 .vindex "&$item$&"
11641 These conditions iterate over a list. The first argument is expanded to form
11642 the list. By default, the list separator is a colon, but it can be changed by
11643 the normal method (&<<SECTlistsepchange>>&).
11644 The second argument is interpreted as a condition that is to
11645 be applied to each item in the list in turn. During the interpretation of the
11646 condition, the current list item is placed in a variable called &$item$&.
11647 .ilist
11648 For &*forany*&, interpretation stops if the condition is true for any item, and
11649 the result of the whole condition is true. If the condition is false for all
11650 items in the list, the overall condition is false.
11651 .next
11652 For &*forall*&, interpretation stops if the condition is false for any item,
11653 and the result of the whole condition is false. If the condition is true for
11654 all items in the list, the overall condition is true.
11655 .endlist
11656 Note that negation of &*forany*& means that the condition must be false for all
11657 items for the overall condition to succeed, and negation of &*forall*& means
11658 that the condition must be false for at least one item. In this example, the
11659 list separator is changed to a comma:
11660 .code
11661 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11662 .endd
11663 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11664 being processed, to enable these expansion items to be nested.
11665
11666 To scan a named list, expand it with the &*listnamed*& operator.
11667
11668 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11669        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11670        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11671        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11672 .cindex JSON "iterative conditions"
11673 .cindex JSON expansions
11674 .cindex expansion "&*forall_json*& condition"
11675 .cindex expansion "&*forany_json*& condition"
11676 .cindex expansion "&*forall_jsons*& condition"
11677 .cindex expansion "&*forany_jsons*& condition"
11678 As for the above, except that the first argument must, after expansion,
11679 be a JSON array.
11680 The array separator is not changeable.
11681 For the &"jsons"& variants the elements are expected to be JSON strings
11682 and have their quotes removed before the evaluation of the condition.
11683
11684
11685
11686 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11687        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11688 .cindex "string" "comparison"
11689 .cindex "expansion" "string comparison"
11690 .cindex "&%ge%& expansion condition"
11691 .cindex "&%gei%& expansion condition"
11692 The two substrings are first expanded. The condition is true if the first
11693 string is lexically greater than or equal to the second string. For &%ge%& the
11694 comparison includes the case of letters, whereas for &%gei%& the comparison is
11695 case-independent.
11696 Case and collation order are defined per the system C locale.
11697
11698 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11699        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11700 .cindex "string" "comparison"
11701 .cindex "expansion" "string comparison"
11702 .cindex "&%gt%& expansion condition"
11703 .cindex "&%gti%& expansion condition"
11704 The two substrings are first expanded. The condition is true if the first
11705 string is lexically greater than the second string. For &%gt%& the comparison
11706 includes the case of letters, whereas for &%gti%& the comparison is
11707 case-independent.
11708 Case and collation order are defined per the system C locale.
11709
11710
11711 .new
11712 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11713 SRS decode.  See SECT &<<SECTSRS>>& for details.
11714 .wen
11715
11716
11717 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11718        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11719 .cindex "string" "comparison"
11720 .cindex "list" "iterative conditions"
11721 Both strings are expanded; the second string is treated as a list of simple
11722 strings; if the first string is a member of the second, then the condition
11723 is true.
11724 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11725
11726 These are simpler to use versions of the more powerful &*forany*& condition.
11727 Examples, and the &*forany*& equivalents:
11728 .code
11729 ${if inlist{needle}{foo:needle:bar}}
11730   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11731 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11732   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11733 .endd
11734
11735 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11736        &*isip4&~{*&<&'string'&>&*}*& &&&
11737        &*isip6&~{*&<&'string'&>&*}*&
11738 .cindex "IP address" "testing string format"
11739 .cindex "string" "testing for IP address"
11740 .cindex "&%isip%& expansion condition"
11741 .cindex "&%isip4%& expansion condition"
11742 .cindex "&%isip6%& expansion condition"
11743 The substring is first expanded, and then tested to see if it has the form of
11744 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11745 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11746
11747 For an IPv4 address, the test is for four dot-separated components, each of
11748 which consists of from one to three digits. For an IPv6 address, up to eight
11749 colon-separated components are permitted, each containing from one to four
11750 hexadecimal digits. There may be fewer than eight components if an empty
11751 component (adjacent colons) is present. Only one empty component is permitted.
11752
11753 &*Note*&: The checks used to be just on the form of the address; actual numerical
11754 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11755 check.
11756 This is no longer the case.
11757
11758 The main use of these tests is to distinguish between IP addresses and
11759 host names, or between IPv4 and IPv6 addresses. For example, you could use
11760 .code
11761 ${if isip4{$sender_host_address}...
11762 .endd
11763 to test which IP version an incoming SMTP connection is using.
11764
11765 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11766 .cindex "LDAP" "use for authentication"
11767 .cindex "expansion" "LDAP authentication test"
11768 .cindex "&%ldapauth%& expansion condition"
11769 This condition supports user authentication using LDAP. See section
11770 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11771 queries. For this use, the query must contain a user name and password. The
11772 query itself is not used, and can be empty. The condition is true if the
11773 password is not empty, and the user name and password are accepted by the LDAP
11774 server. An empty password is rejected without calling LDAP because LDAP binds
11775 with an empty password are considered anonymous regardless of the username, and
11776 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11777 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11778 this can be used.
11779
11780
11781 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11782        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11783 .cindex "string" "comparison"
11784 .cindex "expansion" "string comparison"
11785 .cindex "&%le%& expansion condition"
11786 .cindex "&%lei%& expansion condition"
11787 The two substrings are first expanded. The condition is true if the first
11788 string is lexically less than or equal to the second string. For &%le%& the
11789 comparison includes the case of letters, whereas for &%lei%& the comparison is
11790 case-independent.
11791 Case and collation order are defined per the system C locale.
11792
11793 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11794        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11795 .cindex "string" "comparison"
11796 .cindex "expansion" "string comparison"
11797 .cindex "&%lt%& expansion condition"
11798 .cindex "&%lti%& expansion condition"
11799 The two substrings are first expanded. The condition is true if the first
11800 string is lexically less than the second string. For &%lt%& the comparison
11801 includes the case of letters, whereas for &%lti%& the comparison is
11802 case-independent.
11803 Case and collation order are defined per the system C locale.
11804
11805
11806 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11807 .cindex "expansion" "regular expression comparison"
11808 .cindex "regular expressions" "match in expanded string"
11809 .cindex "&%match%& expansion condition"
11810 The two substrings are first expanded. The second is then treated as a regular
11811 expression and applied to the first. Because of the pre-expansion, if the
11812 regular expression contains dollar, or backslash characters, they must be
11813 escaped. Care must also be taken if the regular expression contains braces
11814 (curly brackets). A closing brace must be escaped so that it is not taken as a
11815 premature termination of <&'string2'&>. The easiest approach is to use the
11816 &`\N`& feature to disable expansion of the regular expression.
11817 For example,
11818 .code
11819 ${if match {$local_part}{\N^\d{3}\N} ...
11820 .endd
11821 If the whole expansion string is in double quotes, further escaping of
11822 backslashes is also required.
11823
11824 The condition is true if the regular expression match succeeds.
11825 The regular expression is not required to begin with a circumflex
11826 metacharacter, but if there is no circumflex, the expression is not anchored,
11827 and it may match anywhere in the subject, not just at the start. If you want
11828 the pattern to match at the end of the subject, you must include the &`$`&
11829 metacharacter at an appropriate point.
11830 All character handling is done in bytes and is not UTF-8 aware,
11831 but we might change this in a future Exim release.
11832
11833 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11834 At the start of an &%if%& expansion the values of the numeric variable
11835 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11836 succeeds causes them to be reset to the substrings of that condition and they
11837 will have these values during the expansion of the success string. At the end
11838 of the &%if%& expansion, the previous values are restored. After testing a
11839 combination of conditions using &%or%&, the subsequent values of the numeric
11840 variables are those of the condition that succeeded.
11841
11842 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11843 .cindex "&%match_address%& expansion condition"
11844 See &*match_local_part*&.
11845
11846 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11847 .cindex "&%match_domain%& expansion condition"
11848 See &*match_local_part*&.
11849
11850 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11851 .cindex "&%match_ip%& expansion condition"
11852 This condition matches an IP address to a list of IP address patterns. It must
11853 be followed by two argument strings. The first (after expansion) must be an IP
11854 address or an empty string. The second (not expanded) is a restricted host
11855 list that can match only an IP address, not a host name. For example:
11856 .code
11857 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11858 .endd
11859 The specific types of host list item that are permitted in the list are:
11860
11861 .ilist
11862 An IP address, optionally with a CIDR mask.
11863 .next
11864 A single asterisk, which matches any IP address.
11865 .next
11866 An empty item, which matches only if the IP address is empty. This could be
11867 useful for testing for a locally submitted message or one from specific hosts
11868 in a single test such as
11869 . ==== As this is a nested list, any displays it contains must be indented
11870 . ==== as otherwise they are too far to the left. This comment applies to
11871 . ==== the use of xmlto plus fop. There's no problem when formatting with
11872 . ==== sdop, with or without the extra indent.
11873 .code
11874   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11875 .endd
11876 where the first item in the list is the empty string.
11877 .next
11878 The item @[] matches any of the local host's interface addresses.
11879 .next
11880 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11881 even if &`net-`& is not specified. There is never any attempt to turn the IP
11882 address into a host name. The most common type of linear search for
11883 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11884 masks. For example:
11885 .code
11886   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11887 .endd
11888 It is of course possible to use other kinds of lookup, and in such a case, you
11889 do need to specify the &`net-`& prefix if you want to specify a specific
11890 address mask, for example:
11891 .code
11892   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11893 .endd
11894 However, unless you are combining a &%match_ip%& condition with others, it is
11895 just as easy to use the fact that a lookup is itself a condition, and write:
11896 .code
11897   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11898 .endd
11899 .endlist ilist
11900
11901 Note that <&'string2'&> is not itself subject to string expansion, unless
11902 Exim was built with the EXPAND_LISTMATCH_RHS option.
11903
11904 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11905
11906 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11907 .cindex "domain list" "in expansion condition"
11908 .cindex "address list" "in expansion condition"
11909 .cindex "local part" "list, in expansion condition"
11910 .cindex "&%match_local_part%& expansion condition"
11911 This condition, together with &%match_address%& and &%match_domain%&, make it
11912 possible to test domain, address, and local part lists within expansions. Each
11913 condition requires two arguments: an item and a list to match. A trivial
11914 example is:
11915 .code
11916 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11917 .endd
11918 In each case, the second argument may contain any of the allowable items for a
11919 list of the appropriate type. Also, because the second argument
11920 is a standard form of list, it is possible to refer to a named list.
11921 Thus, you can use conditions like this:
11922 .code
11923 ${if match_domain{$domain}{+local_domains}{...
11924 .endd
11925 .cindex "&`+caseful`&"
11926 For address lists, the matching starts off caselessly, but the &`+caseful`&
11927 item can be used, as in all address lists, to cause subsequent items to
11928 have their local parts matched casefully. Domains are always matched
11929 caselessly.
11930
11931 Note that <&'string2'&> is not itself subject to string expansion, unless
11932 Exim was built with the EXPAND_LISTMATCH_RHS option.
11933
11934 &*Note*&: Host lists are &'not'& supported in this way. This is because
11935 hosts have two identities: a name and an IP address, and it is not clear
11936 how to specify cleanly how such a test would work. However, IP addresses can be
11937 matched using &%match_ip%&.
11938
11939 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11940 .cindex "PAM authentication"
11941 .cindex "AUTH" "with PAM"
11942 .cindex "Solaris" "PAM support"
11943 .cindex "expansion" "PAM authentication test"
11944 .cindex "&%pam%& expansion condition"
11945 &'Pluggable Authentication Modules'&
11946 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11947 available in the latest releases of Solaris and in some GNU/Linux
11948 distributions. The Exim support, which is intended for use in conjunction with
11949 the SMTP AUTH command, is available only if Exim is compiled with
11950 .code
11951 SUPPORT_PAM=yes
11952 .endd
11953 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11954 in some releases of GNU/Linux &%-ldl%& is also needed.
11955
11956 The argument string is first expanded, and the result must be a
11957 colon-separated list of strings. Leading and trailing white space is ignored.
11958 The PAM module is initialized with the service name &"exim"& and the user name
11959 taken from the first item in the colon-separated data string (<&'string1'&>).
11960 The remaining items in the data string are passed over in response to requests
11961 from the authentication function. In the simple case there will only be one
11962 request, for a password, so the data consists of just two strings.
11963
11964 There can be problems if any of the strings are permitted to contain colon
11965 characters. In the usual way, these have to be doubled to avoid being taken as
11966 separators.
11967 The &%listquote%& expansion item can be used for this.
11968 For example, the configuration
11969 of a LOGIN authenticator might contain this setting:
11970 .code
11971 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
11972 .endd
11973 In some operating systems, PAM authentication can be done only from a process
11974 running as root. Since Exim is running as the Exim user when receiving
11975 messages, this means that PAM cannot be used directly in those systems.
11976 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11977
11978
11979 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11980 .cindex "&'pwcheck'& daemon"
11981 .cindex "Cyrus"
11982 .cindex "expansion" "&'pwcheck'& authentication test"
11983 .cindex "&%pwcheck%& expansion condition"
11984 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11985 This is one way of making it possible for passwords to be checked by a process
11986 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11987 deprecated. Its replacement is &'saslauthd'& (see below).
11988
11989 The pwcheck support is not included in Exim by default. You need to specify
11990 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11991 building Exim. For example:
11992 .code
11993 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11994 .endd
11995 You do not need to install the full Cyrus software suite in order to use
11996 the pwcheck daemon. You can compile and install just the daemon alone
11997 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11998 access to the &_/var/pwcheck_& directory.
11999
12000 The &%pwcheck%& condition takes one argument, which must be the user name and
12001 password, separated by a colon. For example, in a LOGIN authenticator
12002 configuration, you might have this:
12003 .code
12004 server_condition = ${if pwcheck{$auth1:$auth2}}
12005 .endd
12006 Again, for a PLAIN authenticator configuration, this would be:
12007 .code
12008 server_condition = ${if pwcheck{$auth2:$auth3}}
12009 .endd
12010 .vitem &*queue_running*&
12011 .cindex "queue runner" "detecting when delivering from"
12012 .cindex "expansion" "queue runner test"
12013 .cindex "&%queue_running%& expansion condition"
12014 This condition, which has no data, is true during delivery attempts that are
12015 initiated by queue runner processes, and false otherwise.
12016
12017
12018 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12019 .cindex "Radius"
12020 .cindex "expansion" "Radius authentication"
12021 .cindex "&%radius%& expansion condition"
12022 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12023 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12024 the Radius client configuration file in order to build Exim with Radius
12025 support.
12026
12027 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12028 library, using the original API. If you are using release 0.4.0 or later of
12029 this library, you need to set
12030 .code
12031 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12032 .endd
12033 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12034 &%libradius%& library that comes with FreeBSD. To do this, set
12035 .code
12036 RADIUS_LIB_TYPE=RADLIB
12037 .endd
12038 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12039 You may also have to supply a suitable setting in EXTRALIBS so that the
12040 Radius library can be found when Exim is linked.
12041
12042 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12043 Radius client library, which calls the Radius server. The condition is true if
12044 the authentication is successful. For example:
12045 .code
12046 server_condition = ${if radius{<arguments>}}
12047 .endd
12048
12049
12050 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12051         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12052 .cindex "&'saslauthd'& daemon"
12053 .cindex "Cyrus"
12054 .cindex "expansion" "&'saslauthd'& authentication test"
12055 .cindex "&%saslauthd%& expansion condition"
12056 This condition supports user authentication using the Cyrus &'saslauthd'&
12057 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12058 Using this daemon is one way of making it possible for passwords to be checked
12059 by a process that is not running as root.
12060
12061 The saslauthd support is not included in Exim by default. You need to specify
12062 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12063 building Exim. For example:
12064 .code
12065 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12066 .endd
12067 You do not need to install the full Cyrus software suite in order to use
12068 the saslauthd daemon. You can compile and install just the daemon alone
12069 from the Cyrus SASL library.
12070
12071 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12072 two are mandatory. For example:
12073 .code
12074 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12075 .endd
12076 The service and the realm are optional (which is why the arguments are enclosed
12077 in their own set of braces). For details of the meaning of the service and
12078 realm, and how to run the daemon, consult the Cyrus documentation.
12079 .endlist vlist
12080
12081
12082
12083 .section "Combining expansion conditions" "SECID84"
12084 .cindex "expansion" "combining conditions"
12085 Several conditions can be tested at once by combining them using the &%and%&
12086 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12087 conditions on their own, and precede their lists of sub-conditions. Each
12088 sub-condition must be enclosed in braces within the overall braces that contain
12089 the list. No repetition of &%if%& is used.
12090
12091
12092 .vlist
12093 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12094 .cindex "&""or""& expansion condition"
12095 .cindex "expansion" "&""or""& of conditions"
12096 The sub-conditions are evaluated from left to right. The condition is true if
12097 any one of the sub-conditions is true.
12098 For example,
12099 .code
12100 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12101 .endd
12102 When a true sub-condition is found, the following ones are parsed but not
12103 evaluated. If there are several &"match"& sub-conditions the values of the
12104 numeric variables afterwards are taken from the first one that succeeds.
12105
12106 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12107 .cindex "&""and""& expansion condition"
12108 .cindex "expansion" "&""and""& of conditions"
12109 The sub-conditions are evaluated from left to right. The condition is true if
12110 all of the sub-conditions are true. If there are several &"match"&
12111 sub-conditions, the values of the numeric variables afterwards are taken from
12112 the last one. When a false sub-condition is found, the following ones are
12113 parsed but not evaluated.
12114 .endlist
12115 .ecindex IIDexpcond
12116
12117
12118
12119
12120 .section "Expansion variables" "SECTexpvar"
12121 .cindex "expansion" "variables, list of"
12122 This section contains an alphabetical list of all the expansion variables. Some
12123 of them are available only when Exim is compiled with specific options such as
12124 support for TLS or the content scanning extension.
12125
12126 .vlist
12127 .vitem "&$0$&, &$1$&, etc"
12128 .cindex "numerical variables (&$1$& &$2$& etc)"
12129 When a &%match%& expansion condition succeeds, these variables contain the
12130 captured substrings identified by the regular expression during subsequent
12131 processing of the success string of the containing &%if%& expansion item.
12132 In the expansion condition case
12133 they do not retain their values afterwards; in fact, their previous
12134 values are restored at the end of processing an &%if%& item. The numerical
12135 variables may also be set externally by some other matching process which
12136 precedes the expansion of the string. For example, the commands available in
12137 Exim filter files include an &%if%& command with its own regular expression
12138 matching condition.
12139
12140 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12141 Within an acl condition, expansion condition or expansion item
12142 any arguments are copied to these variables,
12143 any unused variables being made empty.
12144
12145 .vitem "&$acl_c...$&"
12146 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12147 can be given any name that starts with &$acl_c$& and is at least six characters
12148 long, but the sixth character must be either a digit or an underscore. For
12149 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12150 variables persist throughout the lifetime of an SMTP connection. They can be
12151 used to pass information between ACLs and between different invocations of the
12152 same ACL. When a message is received, the values of these variables are saved
12153 with the message, and can be accessed by filters, routers, and transports
12154 during subsequent delivery.
12155
12156 .vitem "&$acl_m...$&"
12157 These variables are like the &$acl_c...$& variables, except that their values
12158 are reset after a message has been received. Thus, if several messages are
12159 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12160 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12161 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12162 message is received, the values of these variables are saved with the message,
12163 and can be accessed by filters, routers, and transports during subsequent
12164 delivery.
12165
12166 .vitem &$acl_narg$&
12167 Within an acl condition, expansion condition or expansion item
12168 this variable has the number of arguments.
12169
12170 .vitem &$acl_verify_message$&
12171 .vindex "&$acl_verify_message$&"
12172 After an address verification has failed, this variable contains the failure
12173 message. It retains its value for use in subsequent modifiers. The message can
12174 be preserved by coding like this:
12175 .code
12176 warn !verify = sender
12177      set acl_m0 = $acl_verify_message
12178 .endd
12179 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12180 &%log_message%& modifiers, to include information about the verification
12181 failure.
12182
12183 .vitem &$address_data$&
12184 .vindex "&$address_data$&"
12185 This variable is set by means of the &%address_data%& option in routers. The
12186 value then remains with the address while it is processed by subsequent routers
12187 and eventually a transport. If the transport is handling multiple addresses,
12188 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12189 for more details. &*Note*&: The contents of &$address_data$& are visible in
12190 user filter files.
12191
12192 If &$address_data$& is set when the routers are called from an ACL to verify
12193 a recipient address, the final value is still in the variable for subsequent
12194 conditions and modifiers of the ACL statement. If routing the address caused it
12195 to be redirected to just one address, the child address is also routed as part
12196 of the verification, and in this case the final value of &$address_data$& is
12197 from the child's routing.
12198
12199 If &$address_data$& is set when the routers are called from an ACL to verify a
12200 sender address, the final value is also preserved, but this time in
12201 &$sender_address_data$&, to distinguish it from data from a recipient
12202 address.
12203
12204 In both cases (recipient and sender verification), the value does not persist
12205 after the end of the current ACL statement. If you want to preserve
12206 these values for longer, you can save them in ACL variables.
12207
12208 .vitem &$address_file$&
12209 .vindex "&$address_file$&"
12210 When, as a result of aliasing, forwarding, or filtering, a message is directed
12211 to a specific file, this variable holds the name of the file when the transport
12212 is running. At other times, the variable is empty. For example, using the
12213 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12214 .code
12215 /home/r2d2/savemail
12216 .endd
12217 then when the &(address_file)& transport is running, &$address_file$&
12218 contains the text string &`/home/r2d2/savemail`&.
12219 .cindex "Sieve filter" "value of &$address_file$&"
12220 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12221 then up to the transport configuration to generate an appropriate absolute path
12222 to the relevant file.
12223
12224 .vitem &$address_pipe$&
12225 .vindex "&$address_pipe$&"
12226 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12227 this variable holds the pipe command when the transport is running.
12228
12229 .vitem "&$auth1$& &-- &$auth3$&"
12230 .vindex "&$auth1$&, &$auth2$&, etc"
12231 These variables are used in SMTP authenticators (see chapters
12232 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12233
12234 .vitem &$authenticated_id$&
12235 .cindex "authentication" "id"
12236 .vindex "&$authenticated_id$&"
12237 When a server successfully authenticates a client it may be configured to
12238 preserve some of the authentication information in the variable
12239 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12240 user/password authenticator configuration might preserve the user name for use
12241 in the routers. Note that this is not the same information that is saved in
12242 &$sender_host_authenticated$&.
12243
12244 When a message is submitted locally (that is, not over a TCP connection)
12245 the value of &$authenticated_id$& is normally the login name of the calling
12246 process. However, a trusted user can override this by means of the &%-oMai%&
12247 command line option.
12248 This second case also sets up information used by the
12249 &$authresults$& expansion item.
12250
12251 .vitem &$authenticated_fail_id$&
12252 .cindex "authentication" "fail" "id"
12253 .vindex "&$authenticated_fail_id$&"
12254 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12255 will contain the failed authentication id. If more than one authentication
12256 id is attempted, it will contain only the last one. The variable is
12257 available for processing in the ACL's, generally the quit or notquit ACL.
12258 A message to a local recipient could still be accepted without requiring
12259 authentication, which means this variable could also be visible in all of
12260 the ACL's as well.
12261
12262
12263 .vitem &$authenticated_sender$&
12264 .cindex "sender" "authenticated"
12265 .cindex "authentication" "sender"
12266 .cindex "AUTH" "on MAIL command"
12267 .vindex "&$authenticated_sender$&"
12268 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12269 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12270 described in section &<<SECTauthparamail>>&. Unless the data is the string
12271 &"<>"&, it is set as the authenticated sender of the message, and the value is
12272 available during delivery in the &$authenticated_sender$& variable. If the
12273 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12274
12275 .vindex "&$qualify_domain$&"
12276 When a message is submitted locally (that is, not over a TCP connection), the
12277 value of &$authenticated_sender$& is an address constructed from the login
12278 name of the calling process and &$qualify_domain$&, except that a trusted user
12279 can override this by means of the &%-oMas%& command line option.
12280
12281
12282 .vitem &$authentication_failed$&
12283 .cindex "authentication" "failure"
12284 .vindex "&$authentication_failed$&"
12285 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12286 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12287 possible to distinguish between &"did not try to authenticate"&
12288 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12289 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12290 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12291 negative response to an AUTH command, including (for example) an attempt to use
12292 an undefined mechanism.
12293
12294 .vitem &$av_failed$&
12295 .cindex "content scanning" "AV scanner failure"
12296 This variable is available when Exim is compiled with the content-scanning
12297 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12298 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12299 the ACL malware condition.
12300
12301 .vitem &$body_linecount$&
12302 .cindex "message body" "line count"
12303 .cindex "body of message" "line count"
12304 .vindex "&$body_linecount$&"
12305 When a message is being received or delivered, this variable contains the
12306 number of lines in the message's body. See also &$message_linecount$&.
12307
12308 .vitem &$body_zerocount$&
12309 .cindex "message body" "binary zero count"
12310 .cindex "body of message" "binary zero count"
12311 .cindex "binary zero" "in message body"
12312 .vindex "&$body_zerocount$&"
12313 When a message is being received or delivered, this variable contains the
12314 number of binary zero bytes (ASCII NULs) in the message's body.
12315
12316 .vitem &$bounce_recipient$&
12317 .vindex "&$bounce_recipient$&"
12318 This is set to the recipient address of a bounce message while Exim is creating
12319 it. It is useful if a customized bounce message text file is in use (see
12320 chapter &<<CHAPemsgcust>>&).
12321
12322 .vitem &$bounce_return_size_limit$&
12323 .vindex "&$bounce_return_size_limit$&"
12324 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12325 up to a multiple of 1000. It is useful when a customized error message text
12326 file is in use (see chapter &<<CHAPemsgcust>>&).
12327
12328 .vitem &$caller_gid$&
12329 .cindex "gid (group id)" "caller"
12330 .vindex "&$caller_gid$&"
12331 The real group id under which the process that called Exim was running. This is
12332 not the same as the group id of the originator of a message (see
12333 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12334 incarnation normally contains the Exim gid.
12335
12336 .vitem &$caller_uid$&
12337 .cindex "uid (user id)" "caller"
12338 .vindex "&$caller_uid$&"
12339 The real user id under which the process that called Exim was running. This is
12340 not the same as the user id of the originator of a message (see
12341 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12342 incarnation normally contains the Exim uid.
12343
12344 .vitem &$callout_address$&
12345 .vindex "&$callout_address$&"
12346 After a callout for verification, spamd or malware daemon service, the
12347 address that was connected to.
12348
12349 .vitem &$compile_number$&
12350 .vindex "&$compile_number$&"
12351 The building process for Exim keeps a count of the number
12352 of times it has been compiled. This serves to distinguish different
12353 compilations of the same version of Exim.
12354
12355 .vitem &$config_dir$&
12356 .vindex "&$config_dir$&"
12357 The directory name of the main configuration file. That is, the content of
12358 &$config_file$& with the last component stripped. The value does not
12359 contain the trailing slash. If &$config_file$& does not contain a slash,
12360 &$config_dir$& is ".".
12361
12362 .vitem &$config_file$&
12363 .vindex "&$config_file$&"
12364 The name of the main configuration file Exim is using.
12365
12366 .vitem &$dkim_verify_status$&
12367 Results of DKIM verification.
12368 For details see section &<<SECDKIMVFY>>&.
12369
12370 .vitem &$dkim_cur_signer$& &&&
12371        &$dkim_verify_reason$& &&&
12372        &$dkim_domain$& &&&
12373        &$dkim_identity$& &&&
12374        &$dkim_selector$& &&&
12375        &$dkim_algo$& &&&
12376        &$dkim_canon_body$& &&&
12377        &$dkim_canon_headers$& &&&
12378        &$dkim_copiedheaders$& &&&
12379        &$dkim_bodylength$& &&&
12380        &$dkim_created$& &&&
12381        &$dkim_expires$& &&&
12382        &$dkim_headernames$& &&&
12383        &$dkim_key_testing$& &&&
12384        &$dkim_key_nosubdomains$& &&&
12385        &$dkim_key_srvtype$& &&&
12386        &$dkim_key_granularity$& &&&
12387        &$dkim_key_notes$& &&&
12388        &$dkim_key_length$&
12389 These variables are only available within the DKIM ACL.
12390 For details see section &<<SECDKIMVFY>>&.
12391
12392 .vitem &$dkim_signers$&
12393 .vindex &$dkim_signers$&
12394 When a message has been received this variable contains
12395 a colon-separated list of signer domains and identities for the message.
12396 For details see section &<<SECDKIMVFY>>&.
12397
12398 .vitem &$dmarc_domain_policy$& &&&
12399        &$dmarc_status$& &&&
12400        &$dmarc_status_text$& &&&
12401        &$dmarc_used_domains$&
12402 Results of DMARC verification.
12403 For details see section &<<SECDMARC>>&.
12404
12405 .vitem &$dnslist_domain$& &&&
12406        &$dnslist_matched$& &&&
12407        &$dnslist_text$& &&&
12408        &$dnslist_value$&
12409 .vindex "&$dnslist_domain$&"
12410 .vindex "&$dnslist_matched$&"
12411 .vindex "&$dnslist_text$&"
12412 .vindex "&$dnslist_value$&"
12413 .cindex "black list (DNS)"
12414 When a DNS (black) list lookup succeeds, these variables are set to contain
12415 the following data from the lookup: the list's domain name, the key that was
12416 looked up, the contents of any associated TXT record, and the value from the
12417 main A record. See section &<<SECID204>>& for more details.
12418
12419 .vitem &$domain$&
12420 .vindex "&$domain$&"
12421 When an address is being routed, or delivered on its own, this variable
12422 contains the domain. Uppercase letters in the domain are converted into lower
12423 case for &$domain$&.
12424
12425 Global address rewriting happens when a message is received, so the value of
12426 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12427 is set during user filtering, but not during system filtering, because a
12428 message may have many recipients and the system filter is called just once.
12429
12430 When more than one address is being delivered at once (for example, several
12431 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12432 have the same domain. Transports can be restricted to handling only one domain
12433 at a time if the value of &$domain$& is required at transport time &-- this is
12434 the default for local transports. For further details of the environment in
12435 which local transports are run, see chapter &<<CHAPenvironment>>&.
12436
12437 .oindex "&%delay_warning_condition%&"
12438 At the end of a delivery, if all deferred addresses have the same domain, it is
12439 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12440
12441 The &$domain$& variable is also used in some other circumstances:
12442
12443 .ilist
12444 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12445 the recipient address. The domain of the &'sender'& address is in
12446 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12447 normally set during the running of the MAIL ACL. However, if the sender address
12448 is verified with a callout during the MAIL ACL, the sender domain is placed in
12449 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12450 the &(smtp)& transport.
12451
12452 .next
12453 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12454 &$domain$& contains the domain portion of the address that is being rewritten;
12455 it can be used in the expansion of the replacement address, for example, to
12456 rewrite domains by file lookup.
12457
12458 .next
12459 With one important exception, whenever a domain list is being scanned,
12460 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12461 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12462 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12463 that, in a RCPT ACL, the sender domain list can be dependent on the
12464 recipient domain (which is what is in &$domain$& at this time).
12465
12466 .next
12467 .cindex "ETRN" "value of &$domain$&"
12468 .oindex "&%smtp_etrn_command%&"
12469 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12470 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12471 .endlist
12472
12473 .cindex "tainted data"
12474 If the origin of the data is an incoming message,
12475 the result of expanding this variable is tainted.
12476 When in untainted version is needed, one should be obtained from
12477 looking up the value in a local (therefore trusted) database.
12478 Often &$domain_data$& is usable in this role.
12479
12480
12481 .vitem &$domain_data$&
12482 .vindex "&$domain_data$&"
12483 When the &%domains%& option on a router matches a domain by
12484 means of a lookup, the data read by the lookup is available during the running
12485 of the router as &$domain_data$&. In addition, if the driver routes the
12486 address to a transport, the value is available in that transport. If the
12487 transport is handling multiple addresses, the value from the first address is
12488 used.
12489
12490 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12491 domain by means of a lookup. The data read by the lookup is available during
12492 the rest of the ACL statement. In all other situations, this variable expands
12493 to nothing.
12494
12495 .vitem &$exim_gid$&
12496 .vindex "&$exim_gid$&"
12497 This variable contains the numerical value of the Exim group id.
12498
12499 .vitem &$exim_path$&
12500 .vindex "&$exim_path$&"
12501 This variable contains the path to the Exim binary.
12502
12503 .vitem &$exim_uid$&
12504 .vindex "&$exim_uid$&"
12505 This variable contains the numerical value of the Exim user id.
12506
12507 .vitem &$exim_version$&
12508 .vindex "&$exim_version$&"
12509 This variable contains the version string of the Exim build.
12510 The first character is a major version number, currently 4.
12511 Then after a dot, the next group of digits is a minor version number.
12512 There may be other characters following the minor version.
12513 This value may be overridden by the &%exim_version%& main config option.
12514
12515 .vitem &$header_$&<&'name'&>
12516 This is not strictly an expansion variable. It is expansion syntax for
12517 inserting the message header line with the given name. Note that the name must
12518 be terminated by colon or white space, because it may contain a wide variety of
12519 characters. Note also that braces must &'not'& be used.
12520 See the full description in section &<<SECTexpansionitems>>& above.
12521
12522 .vitem &$headers_added$&
12523 .vindex "&$headers_added$&"
12524 Within an ACL this variable contains the headers added so far by
12525 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12526 The headers are a newline-separated list.
12527
12528 .vitem &$home$&
12529 .vindex "&$home$&"
12530 When the &%check_local_user%& option is set for a router, the user's home
12531 directory is placed in &$home$& when the check succeeds. In particular, this
12532 means it is set during the running of users' filter files. A router may also
12533 explicitly set a home directory for use by a transport; this can be overridden
12534 by a setting on the transport itself.
12535
12536 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12537 of the environment variable HOME, which is subject to the
12538 &%keep_environment%& and &%add_environment%& main config options.
12539
12540 .vitem &$host$&
12541 .vindex "&$host$&"
12542 If a router assigns an address to a transport (any transport), and passes a
12543 list of hosts with the address, the value of &$host$& when the transport starts
12544 to run is the name of the first host on the list. Note that this applies both
12545 to local and remote transports.
12546
12547 .cindex "transport" "filter"
12548 .cindex "filter" "transport filter"
12549 For the &(smtp)& transport, if there is more than one host, the value of
12550 &$host$& changes as the transport works its way through the list. In
12551 particular, when the &(smtp)& transport is expanding its options for encryption
12552 using TLS, or for specifying a transport filter (see chapter
12553 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12554 is connected.
12555
12556 When used in the client part of an authenticator configuration (see chapter
12557 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12558 client is connected.
12559
12560
12561 .vitem &$host_address$&
12562 .vindex "&$host_address$&"
12563 This variable is set to the remote host's IP address whenever &$host$& is set
12564 for a remote connection. It is also set to the IP address that is being checked
12565 when the &%ignore_target_hosts%& option is being processed.
12566
12567 .vitem &$host_data$&
12568 .vindex "&$host_data$&"
12569 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12570 result of the lookup is made available in the &$host_data$& variable. This
12571 allows you, for example, to do things like this:
12572 .code
12573 deny  hosts = net-lsearch;/some/file
12574       message = $host_data
12575 .endd
12576 .vitem &$host_lookup_deferred$&
12577 .cindex "host name" "lookup, failure of"
12578 .vindex "&$host_lookup_deferred$&"
12579 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12580 message comes from a remote host and there is an attempt to look up the host's
12581 name from its IP address, and the attempt is not successful, one of these
12582 variables is set to &"1"&.
12583
12584 .ilist
12585 If the lookup receives a definite negative response (for example, a DNS lookup
12586 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12587
12588 .next
12589 If there is any kind of problem during the lookup, such that Exim cannot
12590 tell whether or not the host name is defined (for example, a timeout for a DNS
12591 lookup), &$host_lookup_deferred$& is set to &"1"&.
12592 .endlist ilist
12593
12594 Looking up a host's name from its IP address consists of more than just a
12595 single reverse lookup. Exim checks that a forward lookup of at least one of the
12596 names it receives from a reverse lookup yields the original IP address. If this
12597 is not the case, Exim does not accept the looked up name(s), and
12598 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12599 IP address (for example, the existence of a PTR record in the DNS) is not
12600 sufficient on its own for the success of a host name lookup. If the reverse
12601 lookup succeeds, but there is a lookup problem such as a timeout when checking
12602 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12603 &"1"&. See also &$sender_host_name$&.
12604
12605 .cindex authentication "expansion item"
12606 Performing these checks sets up information used by the
12607 &%authresults%& expansion item.
12608
12609
12610 .vitem &$host_lookup_failed$&
12611 .vindex "&$host_lookup_failed$&"
12612 See &$host_lookup_deferred$&.
12613
12614 .vitem &$host_port$&
12615 .vindex "&$host_port$&"
12616 This variable is set to the remote host's TCP port whenever &$host$& is set
12617 for an outbound connection.
12618
12619 .vitem &$initial_cwd$&
12620 .vindex "&$initial_cwd$&
12621 This variable contains the full path name of the initial working
12622 directory of the current Exim process. This may differ from the current
12623 working directory, as Exim changes this to "/" during early startup, and
12624 to &$spool_directory$& later.
12625
12626 .vitem &$inode$&
12627 .vindex "&$inode$&"
12628 The only time this variable is set is while expanding the &%directory_file%&
12629 option in the &(appendfile)& transport. The variable contains the inode number
12630 of the temporary file which is about to be renamed. It can be used to construct
12631 a unique name for the file.
12632
12633 .vitem &$interface_address$&
12634 .vindex "&$interface_address$&"
12635 This is an obsolete name for &$received_ip_address$&.
12636
12637 .vitem &$interface_port$&
12638 .vindex "&$interface_port$&"
12639 This is an obsolete name for &$received_port$&.
12640
12641 .vitem &$item$&
12642 .vindex "&$item$&"
12643 This variable is used during the expansion of &*forall*& and &*forany*&
12644 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12645 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12646 empty.
12647
12648 .vitem &$ldap_dn$&
12649 .vindex "&$ldap_dn$&"
12650 This variable, which is available only when Exim is compiled with LDAP support,
12651 contains the DN from the last entry in the most recently successful LDAP
12652 lookup.
12653
12654 .vitem &$load_average$&
12655 .vindex "&$load_average$&"
12656 This variable contains the system load average, multiplied by 1000 so that it
12657 is an integer. For example, if the load average is 0.21, the value of the
12658 variable is 210. The value is recomputed every time the variable is referenced.
12659
12660 .vitem &$local_part$&
12661 .vindex "&$local_part$&"
12662 When an address is being routed, or delivered on its own, this
12663 variable contains the local part. When a number of addresses are being
12664 delivered together (for example, multiple RCPT commands in an SMTP
12665 session), &$local_part$& is not set.
12666
12667 Global address rewriting happens when a message is received, so the value of
12668 &$local_part$& during routing and delivery is the value after rewriting.
12669 &$local_part$& is set during user filtering, but not during system filtering,
12670 because a message may have many recipients and the system filter is called just
12671 once.
12672
12673 .cindex "tainted data"
12674 If the origin of the data is an incoming message,
12675 the result of expanding this variable is tainted.
12676
12677 &*Warning*&: the content of this variable is usually provided by a potential
12678 attacker.
12679 Consider carefully the implications of using it unvalidated as a name
12680 for file access.
12681 This presents issues for users' &_.forward_& and filter files.
12682 For traditional full user accounts, use &%check_local_users%& and the
12683 &$local_part_data$& variable rather than this one.
12684 For virtual users, store a suitable pathname component in the database
12685 which is used for account name validation, and use that retrieved value
12686 rather than this variable.
12687 Often &$local_part_data$& is usable in this role.
12688 If needed, use a router &%address_data%& or &%set%& option for
12689 the retrieved data.
12690
12691 When a message is being delivered to a file, pipe, or autoreply transport as a
12692 result of aliasing or forwarding, &$local_part$& is set to the local part of
12693 the parent address, not to the filename or command (see &$address_file$& and
12694 &$address_pipe$&).
12695
12696 When an ACL is running for a RCPT command, &$local_part$& contains the
12697 local part of the recipient address.
12698
12699 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12700 &$local_part$& contains the local part of the address that is being rewritten;
12701 it can be used in the expansion of the replacement address, for example.
12702
12703 In all cases, all quoting is removed from the local part. For example, for both
12704 the addresses
12705 .code
12706 "abc:xyz"@test.example
12707 abc\:xyz@test.example
12708 .endd
12709 the value of &$local_part$& is
12710 .code
12711 abc:xyz
12712 .endd
12713 If you use &$local_part$& to create another address, you should always wrap it
12714 inside a quoting operator. For example, in a &(redirect)& router you could
12715 have:
12716 .code
12717 data = ${quote_local_part:$local_part}@new.domain.example
12718 .endd
12719 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12720 to process local parts in a case-dependent manner in a router, you can set the
12721 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12722
12723 .vitem &$local_part_data$&
12724 .vindex "&$local_part_data$&"
12725 When the &%local_parts%& option on a router matches a local part by means of a
12726 lookup, the data read by the lookup is available during the running of the
12727 router as &$local_part_data$&. In addition, if the driver routes the address
12728 to a transport, the value is available in that transport. If the transport is
12729 handling multiple addresses, the value from the first address is used.
12730
12731 The &%check_local_user%& router option also sets this variable.
12732
12733 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12734 matches a local part by means of a lookup. The data read by the lookup is
12735 available during the rest of the ACL statement. In all other situations, this
12736 variable expands to nothing.
12737
12738 .vindex &$local_part_prefix$& &&&
12739         &$local_part_prefix_v$& &&&
12740         &$local_part_suffix$& &&&
12741         &$local_part_suffix_v$&
12742 .cindex affix variables
12743 If a local part prefix or suffix has been recognized, it is not included in the
12744 value of &$local_part$& during routing and subsequent delivery. The values of
12745 any prefix or suffix are in &$local_part_prefix$& and
12746 &$local_part_suffix$&, respectively.
12747 .cindex "tainted data"
12748 If the specification did not include a wildcard then
12749 the affix variable value is not tainted.
12750
12751 If the affix specification included a wildcard then the portion of
12752 the affix matched by the wildcard is in
12753 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12754 and both the whole and varying values are tainted.
12755
12756 .vitem &$local_scan_data$&
12757 .vindex "&$local_scan_data$&"
12758 This variable contains the text returned by the &[local_scan()]& function when
12759 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12760
12761 .vitem &$local_user_gid$&
12762 .vindex "&$local_user_gid$&"
12763 See &$local_user_uid$&.
12764
12765 .vitem &$local_user_uid$&
12766 .vindex "&$local_user_uid$&"
12767 This variable and &$local_user_gid$& are set to the uid and gid after the
12768 &%check_local_user%& router precondition succeeds. This means that their values
12769 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12770 and &%condition%&), for the &%address_data%& expansion, and for any
12771 router-specific expansions. At all other times, the values in these variables
12772 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12773
12774 .vitem &$localhost_number$&
12775 .vindex "&$localhost_number$&"
12776 This contains the expanded value of the
12777 &%localhost_number%& option. The expansion happens after the main options have
12778 been read.
12779
12780 .vitem &$log_inodes$&
12781 .vindex "&$log_inodes$&"
12782 The number of free inodes in the disk partition where Exim's
12783 log files are being written. The value is recalculated whenever the variable is
12784 referenced. If the relevant file system does not have the concept of inodes,
12785 the value of is -1. See also the &%check_log_inodes%& option.
12786
12787 .vitem &$log_space$&
12788 .vindex "&$log_space$&"
12789 The amount of free space (as a number of kilobytes) in the disk
12790 partition where Exim's log files are being written. The value is recalculated
12791 whenever the variable is referenced. If the operating system does not have the
12792 ability to find the amount of free space (only true for experimental systems),
12793 the space value is -1. See also the &%check_log_space%& option.
12794
12795
12796 .vitem &$lookup_dnssec_authenticated$&
12797 .vindex "&$lookup_dnssec_authenticated$&"
12798 This variable is set after a DNS lookup done by
12799 a dnsdb lookup expansion, dnslookup router or smtp transport.
12800 .cindex "DNS" "DNSSEC"
12801 It will be empty if &(DNSSEC)& was not requested,
12802 &"no"& if the result was not labelled as authenticated data
12803 and &"yes"& if it was.
12804 Results that are labelled as authoritative answer that match
12805 the &%dns_trust_aa%& configuration variable count also
12806 as authenticated data.
12807
12808 .vitem &$mailstore_basename$&
12809 .vindex "&$mailstore_basename$&"
12810 This variable is set only when doing deliveries in &"mailstore"& format in the
12811 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12812 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12813 contains the basename of the files that are being written, that is, the name
12814 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12815 variable is empty.
12816
12817 .vitem &$malware_name$&
12818 .vindex "&$malware_name$&"
12819 This variable is available when Exim is compiled with the
12820 content-scanning extension. It is set to the name of the virus that was found
12821 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12822
12823 .vitem &$max_received_linelength$&
12824 .vindex "&$max_received_linelength$&"
12825 .cindex "maximum" "line length"
12826 .cindex "line length" "maximum"
12827 This variable contains the number of bytes in the longest line that was
12828 received as part of the message, not counting the line termination
12829 character(s).
12830 It is not valid if the &%spool_files_wireformat%& option is used.
12831
12832 .vitem &$message_age$&
12833 .cindex "message" "age of"
12834 .vindex "&$message_age$&"
12835 This variable is set at the start of a delivery attempt to contain the number
12836 of seconds since the message was received. It does not change during a single
12837 delivery attempt.
12838
12839 .vitem &$message_body$&
12840 .cindex "body of message" "expansion variable"
12841 .cindex "message body" "in expansion"
12842 .cindex "binary zero" "in message body"
12843 .vindex "&$message_body$&"
12844 .oindex "&%message_body_visible%&"
12845 This variable contains the initial portion of a message's body while it is
12846 being delivered, and is intended mainly for use in filter files. The maximum
12847 number of characters of the body that are put into the variable is set by the
12848 &%message_body_visible%& configuration option; the default is 500.
12849
12850 .oindex "&%message_body_newlines%&"
12851 By default, newlines are converted into spaces in &$message_body$&, to make it
12852 easier to search for phrases that might be split over a line break. However,
12853 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12854 zeros are always converted into spaces.
12855
12856 .vitem &$message_body_end$&
12857 .cindex "body of message" "expansion variable"
12858 .cindex "message body" "in expansion"
12859 .vindex "&$message_body_end$&"
12860 This variable contains the final portion of a message's
12861 body while it is being delivered. The format and maximum size are as for
12862 &$message_body$&.
12863
12864 .vitem &$message_body_size$&
12865 .cindex "body of message" "size"
12866 .cindex "message body" "size"
12867 .vindex "&$message_body_size$&"
12868 When a message is being delivered, this variable contains the size of the body
12869 in bytes. The count starts from the character after the blank line that
12870 separates the body from the header. Newlines are included in the count. See
12871 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12872
12873 If the spool file is wireformat
12874 (see the &%spool_files_wireformat%& main option)
12875 the CRLF line-terminators are included in the count.
12876
12877 .vitem &$message_exim_id$&
12878 .vindex "&$message_exim_id$&"
12879 When a message is being received or delivered, this variable contains the
12880 unique message id that is generated and used by Exim to identify the message.
12881 An id is not created for a message until after its header has been successfully
12882 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12883 line; it is the local id that Exim assigns to the message, for example:
12884 &`1BXTIK-0001yO-VA`&.
12885
12886 .vitem &$message_headers$&
12887 .vindex &$message_headers$&
12888 This variable contains a concatenation of all the header lines when a message
12889 is being processed, except for lines added by routers or transports. The header
12890 lines are separated by newline characters. Their contents are decoded in the
12891 same way as a header line that is inserted by &%bheader%&.
12892
12893 .vitem &$message_headers_raw$&
12894 .vindex &$message_headers_raw$&
12895 This variable is like &$message_headers$& except that no processing of the
12896 contents of header lines is done.
12897
12898 .vitem &$message_id$&
12899 This is an old name for &$message_exim_id$&. It is now deprecated.
12900
12901 .vitem &$message_linecount$&
12902 .vindex "&$message_linecount$&"
12903 This variable contains the total number of lines in the header and body of the
12904 message. Compare &$body_linecount$&, which is the count for the body only.
12905 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12906 number of lines received. Before delivery happens (that is, before filters,
12907 routers, and transports run) the count is increased to include the
12908 &'Received:'& header line that Exim standardly adds, and also any other header
12909 lines that are added by ACLs. The blank line that separates the message header
12910 from the body is not counted.
12911
12912 As with the special case of &$message_size$&, during the expansion of the
12913 appendfile transport's maildir_tag option in maildir format, the value of
12914 &$message_linecount$& is the precise size of the number of newlines in the
12915 file that has been written (minus one for the blank line between the
12916 header and the body).
12917
12918 Here is an example of the use of this variable in a DATA ACL:
12919 .code
12920 deny condition = \
12921       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12922      message   = Too many lines in message header
12923 .endd
12924 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12925 message has not yet been received.
12926
12927 This variable is not valid if the &%spool_files_wireformat%& option is used.
12928
12929 .vitem &$message_size$&
12930 .cindex "size" "of message"
12931 .cindex "message" "size"
12932 .vindex "&$message_size$&"
12933 When a message is being processed, this variable contains its size in bytes. In
12934 most cases, the size includes those headers that were received with the
12935 message, but not those (such as &'Envelope-to:'&) that are added to individual
12936 deliveries as they are written. However, there is one special case: during the
12937 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12938 doing a delivery in maildir format, the value of &$message_size$& is the
12939 precise size of the file that has been written. See also
12940 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12941
12942 .cindex "RCPT" "value of &$message_size$&"
12943 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12944 contains the size supplied on the MAIL command, or -1 if no size was given. The
12945 value may not, of course, be truthful.
12946
12947 .vitem &$mime_$&&'xxx'&
12948 A number of variables whose names start with &$mime$& are
12949 available when Exim is compiled with the content-scanning extension. For
12950 details, see section &<<SECTscanmimepart>>&.
12951
12952 .vitem "&$n0$& &-- &$n9$&"
12953 These variables are counters that can be incremented by means
12954 of the &%add%& command in filter files.
12955
12956 .vitem &$original_domain$&
12957 .vindex "&$domain$&"
12958 .vindex "&$original_domain$&"
12959 When a top-level address is being processed for delivery, this contains the
12960 same value as &$domain$&. However, if a &"child"& address (for example,
12961 generated by an alias, forward, or filter file) is being processed, this
12962 variable contains the domain of the original address (lower cased). This
12963 differs from &$parent_domain$& only when there is more than one level of
12964 aliasing or forwarding. When more than one address is being delivered in a
12965 single transport run, &$original_domain$& is not set.
12966
12967 If a new address is created by means of a &%deliver%& command in a system
12968 filter, it is set up with an artificial &"parent"& address. This has the local
12969 part &'system-filter'& and the default qualify domain.
12970
12971 .vitem &$original_local_part$&
12972 .vindex "&$local_part$&"
12973 .vindex "&$original_local_part$&"
12974 When a top-level address is being processed for delivery, this contains the
12975 same value as &$local_part$&, unless a prefix or suffix was removed from the
12976 local part, because &$original_local_part$& always contains the full local
12977 part. When a &"child"& address (for example, generated by an alias, forward, or
12978 filter file) is being processed, this variable contains the full local part of
12979 the original address.
12980
12981 If the router that did the redirection processed the local part
12982 case-insensitively, the value in &$original_local_part$& is in lower case.
12983 This variable differs from &$parent_local_part$& only when there is more than
12984 one level of aliasing or forwarding. When more than one address is being
12985 delivered in a single transport run, &$original_local_part$& is not set.
12986
12987 If a new address is created by means of a &%deliver%& command in a system
12988 filter, it is set up with an artificial &"parent"& address. This has the local
12989 part &'system-filter'& and the default qualify domain.
12990
12991 .vitem &$originator_gid$&
12992 .cindex "gid (group id)" "of originating user"
12993 .cindex "sender" "gid"
12994 .vindex "&$caller_gid$&"
12995 .vindex "&$originator_gid$&"
12996 This variable contains the value of &$caller_gid$& that was set when the
12997 message was received. For messages received via the command line, this is the
12998 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12999 normally the gid of the Exim user.
13000
13001 .vitem &$originator_uid$&
13002 .cindex "uid (user id)" "of originating user"
13003 .cindex "sender" "uid"
13004 .vindex "&$caller_uid$&"
13005 .vindex "&$originator_uid$&"
13006 The value of &$caller_uid$& that was set when the message was received. For
13007 messages received via the command line, this is the uid of the sending user.
13008 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13009 user.
13010
13011 .vitem &$parent_domain$&
13012 .vindex "&$parent_domain$&"
13013 This variable is similar to &$original_domain$& (see
13014 above), except that it refers to the immediately preceding parent address.
13015
13016 .vitem &$parent_local_part$&
13017 .vindex "&$parent_local_part$&"
13018 This variable is similar to &$original_local_part$&
13019 (see above), except that it refers to the immediately preceding parent address.
13020
13021 .vitem &$pid$&
13022 .cindex "pid (process id)" "of current process"
13023 .vindex "&$pid$&"
13024 This variable contains the current process id.
13025
13026 .vitem &$pipe_addresses$&
13027 .cindex "filter" "transport filter"
13028 .cindex "transport" "filter"
13029 .vindex "&$pipe_addresses$&"
13030 This is not an expansion variable, but is mentioned here because the string
13031 &`$pipe_addresses`& is handled specially in the command specification for the
13032 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13033 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13034 It cannot be used in general expansion strings, and provokes an &"unknown
13035 variable"& error if encountered.
13036
13037 .vitem &$primary_hostname$&
13038 .vindex "&$primary_hostname$&"
13039 This variable contains the value set by &%primary_hostname%& in the
13040 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13041 a single-component name, Exim calls &[gethostbyname()]& (or
13042 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13043 qualified host name. See also &$smtp_active_hostname$&.
13044
13045
13046 .vitem &$proxy_external_address$& &&&
13047        &$proxy_external_port$& &&&
13048        &$proxy_local_address$& &&&
13049        &$proxy_local_port$& &&&
13050        &$proxy_session$&
13051 These variables are only available when built with Proxy Protocol
13052 or SOCKS5 support.
13053 For details see chapter &<<SECTproxyInbound>>&.
13054
13055 .vitem &$prdr_requested$&
13056 .cindex "PRDR" "variable for"
13057 This variable is set to &"yes"& if PRDR was requested by the client for the
13058 current message, otherwise &"no"&.
13059
13060 .vitem &$prvscheck_address$&
13061 This variable is used in conjunction with the &%prvscheck%& expansion item,
13062 which is described in sections &<<SECTexpansionitems>>& and
13063 &<<SECTverifyPRVS>>&.
13064
13065 .vitem &$prvscheck_keynum$&
13066 This variable is used in conjunction with the &%prvscheck%& expansion item,
13067 which is described in sections &<<SECTexpansionitems>>& and
13068 &<<SECTverifyPRVS>>&.
13069
13070 .vitem &$prvscheck_result$&
13071 This variable is used in conjunction with the &%prvscheck%& expansion item,
13072 which is described in sections &<<SECTexpansionitems>>& and
13073 &<<SECTverifyPRVS>>&.
13074
13075 .vitem &$qualify_domain$&
13076 .vindex "&$qualify_domain$&"
13077 The value set for the &%qualify_domain%& option in the configuration file.
13078
13079 .vitem &$qualify_recipient$&
13080 .vindex "&$qualify_recipient$&"
13081 The value set for the &%qualify_recipient%& option in the configuration file,
13082 or if not set, the value of &$qualify_domain$&.
13083
13084 .vitem &$queue_name$&
13085 .vindex &$queue_name$&
13086 .cindex "named queues" variable
13087 .cindex queues named
13088 The name of the spool queue in use; empty for the default queue.
13089
13090 .vitem &$queue_size$&
13091 .vindex "&$queue_size$&"
13092 .cindex "queue" "size of"
13093 .cindex "spool" "number of messages"
13094 This variable contains the number of messages queued.
13095 It is evaluated on demand, but no more often than once every minute.
13096
13097 .vitem &$r_...$&
13098 .vindex &$r_...$&
13099 .cindex router variables
13100 Values can be placed in these variables by the &%set%& option of a router.
13101 They can be given any name that starts with &$r_$&.
13102 The values persist for the address being handled through subsequent routers
13103 and the eventual transport.
13104
13105 .vitem &$rcpt_count$&
13106 .vindex "&$rcpt_count$&"
13107 When a message is being received by SMTP, this variable contains the number of
13108 RCPT commands received for the current message. If this variable is used in a
13109 RCPT ACL, its value includes the current command.
13110
13111 .vitem &$rcpt_defer_count$&
13112 .vindex "&$rcpt_defer_count$&"
13113 .cindex "4&'xx'& responses" "count of"
13114 When a message is being received by SMTP, this variable contains the number of
13115 RCPT commands in the current message that have previously been rejected with a
13116 temporary (4&'xx'&) response.
13117
13118 .vitem &$rcpt_fail_count$&
13119 .vindex "&$rcpt_fail_count$&"
13120 When a message is being received by SMTP, this variable contains the number of
13121 RCPT commands in the current message that have previously been rejected with a
13122 permanent (5&'xx'&) response.
13123
13124 .vitem &$received_count$&
13125 .vindex "&$received_count$&"
13126 This variable contains the number of &'Received:'& header lines in the message,
13127 including the one added by Exim (so its value is always greater than zero). It
13128 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13129 delivering.
13130
13131 .vitem &$received_for$&
13132 .vindex "&$received_for$&"
13133 If there is only a single recipient address in an incoming message, this
13134 variable contains that address when the &'Received:'& header line is being
13135 built. The value is copied after recipient rewriting has happened, but before
13136 the &[local_scan()]& function is run.
13137
13138 .vitem &$received_ip_address$&
13139 .vindex "&$received_ip_address$&"
13140 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13141 variable is set to the address of the local IP interface, and &$received_port$&
13142 is set to the local port number. (The remote IP address and port are in
13143 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13144 the port value is -1 unless it has been set using the &%-oMi%& command line
13145 option.
13146
13147 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13148 could be used, for example, to make the filename for a TLS certificate depend
13149 on which interface and/or port is being used for the incoming connection. The
13150 values of &$received_ip_address$& and &$received_port$& are saved with any
13151 messages that are received, thus making these variables available at delivery
13152 time.
13153 For outbound connections see &$sending_ip_address$&.
13154
13155 .vitem &$received_port$&
13156 .vindex "&$received_port$&"
13157 See &$received_ip_address$&.
13158
13159 .vitem &$received_protocol$&
13160 .vindex "&$received_protocol$&"
13161 When a message is being processed, this variable contains the name of the
13162 protocol by which it was received. Most of the names used by Exim are defined
13163 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13164 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13165 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13166 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13167 connection and the client was successfully authenticated.
13168
13169 Exim uses the protocol name &"smtps"& for the case when encryption is
13170 automatically set up on connection without the use of STARTTLS (see
13171 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13172 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13173 where the client initially uses EHLO, sets up an encrypted connection using
13174 STARTTLS, and then uses HELO afterwards.
13175
13176 The &%-oMr%& option provides a way of specifying a custom protocol name for
13177 messages that are injected locally by trusted callers. This is commonly used to
13178 identify messages that are being re-injected after some kind of scanning.
13179
13180 .vitem &$received_time$&
13181 .vindex "&$received_time$&"
13182 This variable contains the date and time when the current message was received,
13183 as a number of seconds since the start of the Unix epoch.
13184
13185 .vitem &$recipient_data$&
13186 .vindex "&$recipient_data$&"
13187 This variable is set after an indexing lookup success in an ACL &%recipients%&
13188 condition. It contains the data from the lookup, and the value remains set
13189 until the next &%recipients%& test. Thus, you can do things like this:
13190 .display
13191 &`require recipients  = cdb*@;/some/file`&
13192 &`deny    `&&'some further test involving'& &`$recipient_data`&
13193 .endd
13194 &*Warning*&: This variable is set only when a lookup is used as an indexing
13195 method in the address list, using the semicolon syntax as in the example above.
13196 The variable is not set for a lookup that is used as part of the string
13197 expansion that all such lists undergo before being interpreted.
13198
13199 .vitem &$recipient_verify_failure$&
13200 .vindex "&$recipient_verify_failure$&"
13201 In an ACL, when a recipient verification fails, this variable contains
13202 information about the failure. It is set to one of the following words:
13203
13204 .ilist
13205 &"qualify"&: The address was unqualified (no domain), and the message
13206 was neither local nor came from an exempted host.
13207
13208 .next
13209 &"route"&: Routing failed.
13210
13211 .next
13212 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13213 or before the MAIL command (that is, on initial connection, HELO, or
13214 MAIL).
13215
13216 .next
13217 &"recipient"&: The RCPT command in a callout was rejected.
13218 .next
13219
13220 &"postmaster"&: The postmaster check in a callout was rejected.
13221 .endlist
13222
13223 The main use of this variable is expected to be to distinguish between
13224 rejections of MAIL and rejections of RCPT.
13225
13226 .vitem &$recipients$&
13227 .vindex "&$recipients$&"
13228 This variable contains a list of envelope recipients for a message. A comma and
13229 a space separate the addresses in the replacement text. However, the variable
13230 is not generally available, to prevent exposure of Bcc recipients in
13231 unprivileged users' filter files. You can use &$recipients$& only in these
13232 cases:
13233
13234 .olist
13235 In a system filter file.
13236 .next
13237 In the ACLs associated with the DATA command and with non-SMTP messages, that
13238 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13239 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13240 &%acl_not_smtp_mime%&.
13241 .next
13242 From within a &[local_scan()]& function.
13243 .endlist
13244
13245
13246 .vitem &$recipients_count$&
13247 .vindex "&$recipients_count$&"
13248 When a message is being processed, this variable contains the number of
13249 envelope recipients that came with the message. Duplicates are not excluded
13250 from the count. While a message is being received over SMTP, the number
13251 increases for each accepted recipient. It can be referenced in an ACL.
13252
13253
13254 .vitem &$regex_match_string$&
13255 .vindex "&$regex_match_string$&"
13256 This variable is set to contain the matching regular expression after a
13257 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13258
13259 .vitem "&$regex1$&, &$regex2$&, etc"
13260 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13261 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13262 these variables contain the
13263 captured substrings identified by the regular expression.
13264
13265
13266 .vitem &$reply_address$&
13267 .vindex "&$reply_address$&"
13268 When a message is being processed, this variable contains the contents of the
13269 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13270 contents of the &'From:'& header line. Apart from the removal of leading
13271 white space, the value is not processed in any way. In particular, no RFC 2047
13272 decoding or character code translation takes place.
13273
13274 .vitem &$return_path$&
13275 .vindex "&$return_path$&"
13276 When a message is being delivered, this variable contains the return path &--
13277 the sender field that will be sent as part of the envelope. It is not enclosed
13278 in <> characters. At the start of routing an address, &$return_path$& has the
13279 same value as &$sender_address$&, but if, for example, an incoming message to a
13280 mailing list has been expanded by a router which specifies a different address
13281 for bounce messages, &$return_path$& subsequently contains the new bounce
13282 address, whereas &$sender_address$& always contains the original sender address
13283 that was received with the message. In other words, &$sender_address$& contains
13284 the incoming envelope sender, and &$return_path$& contains the outgoing
13285 envelope sender.
13286
13287 .vitem &$return_size_limit$&
13288 .vindex "&$return_size_limit$&"
13289 This is an obsolete name for &$bounce_return_size_limit$&.
13290
13291 .vitem &$router_name$&
13292 .cindex "router" "name"
13293 .cindex "name" "of router"
13294 .vindex "&$router_name$&"
13295 During the running of a router this variable contains its name.
13296
13297 .vitem &$runrc$&
13298 .cindex "return code" "from &%run%& expansion"
13299 .vindex "&$runrc$&"
13300 This variable contains the return code from a command that is run by the
13301 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13302 assume the order in which option values are expanded, except for those
13303 preconditions whose order of testing is documented. Therefore, you cannot
13304 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13305 another.
13306
13307 .vitem &$self_hostname$&
13308 .oindex "&%self%&" "value of host name"
13309 .vindex "&$self_hostname$&"
13310 When an address is routed to a supposedly remote host that turns out to be the
13311 local host, what happens is controlled by the &%self%& generic router option.
13312 One of its values causes the address to be passed to another router. When this
13313 happens, &$self_hostname$& is set to the name of the local host that the
13314 original router encountered. In other circumstances its contents are null.
13315
13316 .vitem &$sender_address$&
13317 .vindex "&$sender_address$&"
13318 When a message is being processed, this variable contains the sender's address
13319 that was received in the message's envelope. The case of letters in the address
13320 is retained, in both the local part and the domain. For bounce messages, the
13321 value of this variable is the empty string. See also &$return_path$&.
13322
13323 .vitem &$sender_address_data$&
13324 .vindex "&$address_data$&"
13325 .vindex "&$sender_address_data$&"
13326 If &$address_data$& is set when the routers are called from an ACL to verify a
13327 sender address, the final value is preserved in &$sender_address_data$&, to
13328 distinguish it from data from a recipient address. The value does not persist
13329 after the end of the current ACL statement. If you want to preserve it for
13330 longer, you can save it in an ACL variable.
13331
13332 .vitem &$sender_address_domain$&
13333 .vindex "&$sender_address_domain$&"
13334 The domain portion of &$sender_address$&.
13335
13336 .vitem &$sender_address_local_part$&
13337 .vindex "&$sender_address_local_part$&"
13338 The local part portion of &$sender_address$&.
13339
13340 .vitem &$sender_data$&
13341 .vindex "&$sender_data$&"
13342 This variable is set after a lookup success in an ACL &%senders%& condition or
13343 in a router &%senders%& option. It contains the data from the lookup, and the
13344 value remains set until the next &%senders%& test. Thus, you can do things like
13345 this:
13346 .display
13347 &`require senders      = cdb*@;/some/file`&
13348 &`deny    `&&'some further test involving'& &`$sender_data`&
13349 .endd
13350 &*Warning*&: This variable is set only when a lookup is used as an indexing
13351 method in the address list, using the semicolon syntax as in the example above.
13352 The variable is not set for a lookup that is used as part of the string
13353 expansion that all such lists undergo before being interpreted.
13354
13355 .vitem &$sender_fullhost$&
13356 .vindex "&$sender_fullhost$&"
13357 When a message is received from a remote host, this variable contains the host
13358 name and IP address in a single string. It ends with the IP address in square
13359 brackets, followed by a colon and a port number if the logging of ports is
13360 enabled. The format of the rest of the string depends on whether the host
13361 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13362 looking up its IP address. (Looking up the IP address can be forced by the
13363 &%host_lookup%& option, independent of verification.) A plain host name at the
13364 start of the string is a verified host name; if this is not present,
13365 verification either failed or was not requested. A host name in parentheses is
13366 the argument of a HELO or EHLO command. This is omitted if it is identical to
13367 the verified host name or to the host's IP address in square brackets.
13368
13369 .vitem &$sender_helo_dnssec$&
13370 .vindex "&$sender_helo_dnssec$&"
13371 This boolean variable is true if a successful HELO verification was
13372 .cindex "DNS" "DNSSEC"
13373 done using DNS information the resolver library stated was authenticated data.
13374
13375 .vitem &$sender_helo_name$&
13376 .vindex "&$sender_helo_name$&"
13377 When a message is received from a remote host that has issued a HELO or EHLO
13378 command, the argument of that command is placed in this variable. It is also
13379 set if HELO or EHLO is used when a message is received using SMTP locally via
13380 the &%-bs%& or &%-bS%& options.
13381
13382 .vitem &$sender_host_address$&
13383 .vindex "&$sender_host_address$&"
13384 When a message is received from a remote host using SMTP,
13385 this variable contains that
13386 host's IP address. For locally non-SMTP submitted messages, it is empty.
13387
13388 .vitem &$sender_host_authenticated$&
13389 .vindex "&$sender_host_authenticated$&"
13390 This variable contains the name (not the public name) of the authenticator
13391 driver that successfully authenticated the client from which the message was
13392 received. It is empty if there was no successful authentication. See also
13393 &$authenticated_id$&.
13394
13395 .vitem &$sender_host_dnssec$&
13396 .vindex "&$sender_host_dnssec$&"
13397 If an attempt to populate &$sender_host_name$& has been made
13398 (by reference, &%hosts_lookup%& or
13399 otherwise) then this boolean will have been set true if, and only if, the
13400 resolver library states that both
13401 the reverse and forward DNS were authenticated data.  At all
13402 other times, this variable is false.
13403
13404 .cindex "DNS" "DNSSEC"
13405 It is likely that you will need to coerce DNSSEC support on in the resolver
13406 library, by setting:
13407 .code
13408 dns_dnssec_ok = 1
13409 .endd
13410
13411 In addition, on Linux with glibc 2.31 or newer the resolver library will
13412 default to stripping out a successful validation status.
13413 This will break a previously working Exim installation.
13414 Provided that you do trust the resolver (ie, is on localhost) you can tell
13415 glibc to pass through any successful validation with a new option in
13416 &_/etc/resolv.conf_&:
13417 .code
13418 options trust-ad
13419 .endd
13420
13421 Exim does not perform DNSSEC validation itself, instead leaving that to a
13422 validating resolver (e.g. unbound, or bind with suitable configuration).
13423
13424 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13425 mechanism in the list, then this variable will be false.
13426
13427 This requires that your system resolver library support EDNS0 (and that
13428 DNSSEC flags exist in the system headers).  If the resolver silently drops
13429 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13430 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13431
13432
13433 .vitem &$sender_host_name$&
13434 .vindex "&$sender_host_name$&"
13435 When a message is received from a remote host, this variable contains the
13436 host's name as obtained by looking up its IP address. For messages received by
13437 other means, this variable is empty.
13438
13439 .vindex "&$host_lookup_failed$&"
13440 If the host name has not previously been looked up, a reference to
13441 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13442 A looked up name is accepted only if it leads back to the original IP address
13443 via a forward lookup. If either the reverse or the forward lookup fails to find
13444 any data, or if the forward lookup does not yield the original IP address,
13445 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13446
13447 .vindex "&$host_lookup_deferred$&"
13448 However, if either of the lookups cannot be completed (for example, there is a
13449 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13450 &$host_lookup_failed$& remains set to &"0"&.
13451
13452 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13453 host name again if there is a subsequent reference to &$sender_host_name$&
13454 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13455 is set to &"1"&.
13456
13457 Exim does not automatically look up every calling host's name. If you want
13458 maximum efficiency, you should arrange your configuration so that it avoids
13459 these lookups altogether. The lookup happens only if one or more of the
13460 following are true:
13461
13462 .ilist
13463 A string containing &$sender_host_name$& is expanded.
13464 .next
13465 The calling host matches the list in &%host_lookup%&. In the default
13466 configuration, this option is set to *, so it must be changed if lookups are
13467 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13468 .next
13469 Exim needs the host name in order to test an item in a host list. The items
13470 that require this are described in sections &<<SECThoslispatnam>>& and
13471 &<<SECThoslispatnamsk>>&.
13472 .next
13473 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13474 In this case, the host name is required to compare with the name quoted in any
13475 EHLO or HELO commands that the client issues.
13476 .next
13477 The remote host issues a EHLO or HELO command that quotes one of the
13478 domains in &%helo_lookup_domains%&. The default value of this option is
13479 . ==== As this is a nested list, any displays it contains must be indented
13480 . ==== as otherwise they are too far to the left.
13481 .code
13482   helo_lookup_domains = @ : @[]
13483 .endd
13484 which causes a lookup if a remote host (incorrectly) gives the server's name or
13485 IP address in an EHLO or HELO command.
13486 .endlist
13487
13488
13489 .vitem &$sender_host_port$&
13490 .vindex "&$sender_host_port$&"
13491 When a message is received from a remote host, this variable contains the port
13492 number that was used on the remote host.
13493
13494 .vitem &$sender_ident$&
13495 .vindex "&$sender_ident$&"
13496 When a message is received from a remote host, this variable contains the
13497 identification received in response to an RFC 1413 request. When a message has
13498 been received locally, this variable contains the login name of the user that
13499 called Exim.
13500
13501 .vitem &$sender_rate_$&&'xxx'&
13502 A number of variables whose names begin &$sender_rate_$& are set as part of the
13503 &%ratelimit%& ACL condition. Details are given in section
13504 &<<SECTratelimiting>>&.
13505
13506 .vitem &$sender_rcvhost$&
13507 .cindex "DNS" "reverse lookup"
13508 .cindex "reverse DNS lookup"
13509 .vindex "&$sender_rcvhost$&"
13510 This is provided specifically for use in &'Received:'& headers. It starts with
13511 either the verified host name (as obtained from a reverse DNS lookup) or, if
13512 there is no verified host name, the IP address in square brackets. After that
13513 there may be text in parentheses. When the first item is a verified host name,
13514 the first thing in the parentheses is the IP address in square brackets,
13515 followed by a colon and a port number if port logging is enabled. When the
13516 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13517 the parentheses.
13518
13519 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13520 was used and its argument was not identical to the real host name or IP
13521 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13522 all three items are present in the parentheses, a newline and tab are inserted
13523 into the string, to improve the formatting of the &'Received:'& header.
13524
13525 .vitem &$sender_verify_failure$&
13526 .vindex "&$sender_verify_failure$&"
13527 In an ACL, when a sender verification fails, this variable contains information
13528 about the failure. The details are the same as for
13529 &$recipient_verify_failure$&.
13530
13531 .vitem &$sending_ip_address$&
13532 .vindex "&$sending_ip_address$&"
13533 This variable is set whenever an outgoing SMTP connection to another host has
13534 been set up. It contains the IP address of the local interface that is being
13535 used. This is useful if a host that has more than one IP address wants to take
13536 on different personalities depending on which one is being used. For incoming
13537 connections, see &$received_ip_address$&.
13538
13539 .vitem &$sending_port$&
13540 .vindex "&$sending_port$&"
13541 This variable is set whenever an outgoing SMTP connection to another host has
13542 been set up. It contains the local port that is being used. For incoming
13543 connections, see &$received_port$&.
13544
13545 .vitem &$smtp_active_hostname$&
13546 .vindex "&$smtp_active_hostname$&"
13547 During an incoming SMTP session, this variable contains the value of the active
13548 host name, as specified by the &%smtp_active_hostname%& option. The value of
13549 &$smtp_active_hostname$& is saved with any message that is received, so its
13550 value can be consulted during routing and delivery.
13551
13552 .vitem &$smtp_command$&
13553 .vindex "&$smtp_command$&"
13554 During the processing of an incoming SMTP command, this variable contains the
13555 entire command. This makes it possible to distinguish between HELO and EHLO in
13556 the HELO ACL, and also to distinguish between commands such as these:
13557 .code
13558 MAIL FROM:<>
13559 MAIL FROM: <>
13560 .endd
13561 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13562 command, the address in &$smtp_command$& is the original address before any
13563 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13564 the address after SMTP-time rewriting.
13565
13566 .vitem &$smtp_command_argument$&
13567 .cindex "SMTP" "command, argument for"
13568 .vindex "&$smtp_command_argument$&"
13569 While an ACL is running to check an SMTP command, this variable contains the
13570 argument, that is, the text that follows the command name, with leading white
13571 space removed. Following the introduction of &$smtp_command$&, this variable is
13572 somewhat redundant, but is retained for backwards compatibility.
13573
13574 .vitem &$smtp_command_history$&
13575 .cindex SMTP "command history"
13576 .vindex "&$smtp_command_history$&"
13577 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13578 received, in time-order left to right.  Only a limited number of commands
13579 are remembered.
13580
13581 .vitem &$smtp_count_at_connection_start$&
13582 .vindex "&$smtp_count_at_connection_start$&"
13583 This variable is set greater than zero only in processes spawned by the Exim
13584 daemon for handling incoming SMTP connections. The name is deliberately long,
13585 in order to emphasize what the contents are. When the daemon accepts a new
13586 connection, it increments this variable. A copy of the variable is passed to
13587 the child process that handles the connection, but its value is fixed, and
13588 never changes. It is only an approximation of how many incoming connections
13589 there actually are, because many other connections may come and go while a
13590 single connection is being processed. When a child process terminates, the
13591 daemon decrements its copy of the variable.
13592
13593 .vitem "&$sn0$& &-- &$sn9$&"
13594 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13595 that were current at the end of the system filter file. This allows a system
13596 filter file to set values that can be tested in users' filter files. For
13597 example, a system filter could set a value indicating how likely it is that a
13598 message is junk mail.
13599
13600 .vitem &$spam_$&&'xxx'&
13601 A number of variables whose names start with &$spam$& are available when Exim
13602 is compiled with the content-scanning extension. For details, see section
13603 &<<SECTscanspamass>>&.
13604
13605 .vitem &$spf_header_comment$& &&&
13606        &$spf_received$& &&&
13607        &$spf_result$& &&&
13608        &$spf_result_guessed$& &&&
13609        &$spf_smtp_comment$&
13610 These variables are only available if Exim is built with SPF support.
13611 For details see section &<<SECSPF>>&.
13612
13613 .vitem &$spool_directory$&
13614 .vindex "&$spool_directory$&"
13615 The name of Exim's spool directory.
13616
13617 .vitem &$spool_inodes$&
13618 .vindex "&$spool_inodes$&"
13619 The number of free inodes in the disk partition where Exim's spool files are
13620 being written. The value is recalculated whenever the variable is referenced.
13621 If the relevant file system does not have the concept of inodes, the value of
13622 is -1. See also the &%check_spool_inodes%& option.
13623
13624 .vitem &$spool_space$&
13625 .vindex "&$spool_space$&"
13626 The amount of free space (as a number of kilobytes) in the disk partition where
13627 Exim's spool files are being written. The value is recalculated whenever the
13628 variable is referenced. If the operating system does not have the ability to
13629 find the amount of free space (only true for experimental systems), the space
13630 value is -1. For example, to check in an ACL that there is at least 50
13631 megabytes free on the spool, you could write:
13632 .code
13633 condition = ${if > {$spool_space}{50000}}
13634 .endd
13635 See also the &%check_spool_space%& option.
13636
13637
13638 .vitem &$thisaddress$&
13639 .vindex "&$thisaddress$&"
13640 This variable is set only during the processing of the &%foranyaddress%&
13641 command in a filter file. Its use is explained in the description of that
13642 command, which can be found in the separate document entitled &'Exim's
13643 interfaces to mail filtering'&.
13644
13645 .vitem &$tls_in_bits$&
13646 .vindex "&$tls_in_bits$&"
13647 Contains an approximation of the TLS cipher's bit-strength
13648 on the inbound connection; the meaning of
13649 this depends upon the TLS implementation used.
13650 If TLS has not been negotiated, the value will be 0.
13651 The value of this is automatically fed into the Cyrus SASL authenticator
13652 when acting as a server, to specify the "external SSF" (a SASL term).
13653
13654 The deprecated &$tls_bits$& variable refers to the inbound side
13655 except when used in the context of an outbound SMTP delivery, when it refers to
13656 the outbound.
13657
13658 .vitem &$tls_out_bits$&
13659 .vindex "&$tls_out_bits$&"
13660 Contains an approximation of the TLS cipher's bit-strength
13661 on an outbound SMTP connection; the meaning of
13662 this depends upon the TLS implementation used.
13663 If TLS has not been negotiated, the value will be 0.
13664
13665 .vitem &$tls_in_ourcert$&
13666 .vindex "&$tls_in_ourcert$&"
13667 .cindex certificate variables
13668 This variable refers to the certificate presented to the peer of an
13669 inbound connection when the message was received.
13670 It is only useful as the argument of a
13671 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13672 or a &%def%& condition.
13673
13674 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13675 when a list of more than one
13676 file is used for &%tls_certificate%&, this variable is not reliable.
13677 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13678
13679 .vitem &$tls_in_peercert$&
13680 .vindex "&$tls_in_peercert$&"
13681 This variable refers to the certificate presented by the peer of an
13682 inbound connection when the message was received.
13683 It is only useful as the argument of a
13684 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13685 or a &%def%& condition.
13686 If certificate verification fails it may refer to a failing chain element
13687 which is not the leaf.
13688
13689 .vitem &$tls_out_ourcert$&
13690 .vindex "&$tls_out_ourcert$&"
13691 This variable refers to the certificate presented to the peer of an
13692 outbound connection.  It is only useful as the argument of a
13693 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13694 or a &%def%& condition.
13695
13696 .vitem &$tls_out_peercert$&
13697 .vindex "&$tls_out_peercert$&"
13698 This variable refers to the certificate presented by the peer of an
13699 outbound connection.  It is only useful as the argument of a
13700 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13701 or a &%def%& condition.
13702 If certificate verification fails it may refer to a failing chain element
13703 which is not the leaf.
13704
13705 .vitem &$tls_in_certificate_verified$&
13706 .vindex "&$tls_in_certificate_verified$&"
13707 This variable is set to &"1"& if a TLS certificate was verified when the
13708 message was received, and &"0"& otherwise.
13709
13710 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13711 except when used in the context of an outbound SMTP delivery, when it refers to
13712 the outbound.
13713
13714 .vitem &$tls_out_certificate_verified$&
13715 .vindex "&$tls_out_certificate_verified$&"
13716 This variable is set to &"1"& if a TLS certificate was verified when an
13717 outbound SMTP connection was made,
13718 and &"0"& otherwise.
13719
13720 .vitem &$tls_in_cipher$&
13721 .vindex "&$tls_in_cipher$&"
13722 .vindex "&$tls_cipher$&"
13723 When a message is received from a remote host over an encrypted SMTP
13724 connection, this variable is set to the cipher suite that was negotiated, for
13725 example DES-CBC3-SHA. In other circumstances, in particular, for message
13726 received over unencrypted connections, the variable is empty. Testing
13727 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13728 non-encrypted connections during ACL processing.
13729
13730 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13731 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13732 becomes the same as &$tls_out_cipher$&.
13733
13734 .vitem &$tls_in_cipher_std$&
13735 .vindex "&$tls_in_cipher_std$&"
13736 As above, but returning the RFC standard name for the cipher suite.
13737
13738 .vitem &$tls_out_cipher$&
13739 .vindex "&$tls_out_cipher$&"
13740 This variable is
13741 cleared before any outgoing SMTP connection is made,
13742 and then set to the outgoing cipher suite if one is negotiated. See chapter
13743 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13744 details of the &(smtp)& transport.
13745
13746 .vitem &$tls_out_cipher_std$&
13747 .vindex "&$tls_out_cipher_std$&"
13748 As above, but returning the RFC standard name for the cipher suite.
13749
13750 .vitem &$tls_out_dane$&
13751 .vindex &$tls_out_dane$&
13752 DANE active status.  See section &<<SECDANE>>&.
13753
13754 .vitem &$tls_in_ocsp$&
13755 .vindex "&$tls_in_ocsp$&"
13756 When a message is received from a remote client connection
13757 the result of any OCSP request from the client is encoded in this variable:
13758 .code
13759 0 OCSP proof was not requested (default value)
13760 1 No response to request
13761 2 Response not verified
13762 3 Verification failed
13763 4 Verification succeeded
13764 .endd
13765
13766 .vitem &$tls_out_ocsp$&
13767 .vindex "&$tls_out_ocsp$&"
13768 When a message is sent to a remote host connection
13769 the result of any OCSP request made is encoded in this variable.
13770 See &$tls_in_ocsp$& for values.
13771
13772 .vitem &$tls_in_peerdn$&
13773 .vindex "&$tls_in_peerdn$&"
13774 .vindex "&$tls_peerdn$&"
13775 .cindex certificate "extracting fields"
13776 When a message is received from a remote host over an encrypted SMTP
13777 connection, and Exim is configured to request a certificate from the client,
13778 the value of the Distinguished Name of the certificate is made available in the
13779 &$tls_in_peerdn$& during subsequent processing.
13780 If certificate verification fails it may refer to a failing chain element
13781 which is not the leaf.
13782
13783 The deprecated &$tls_peerdn$& variable refers to the inbound side
13784 except when used in the context of an outbound SMTP delivery, when it refers to
13785 the outbound.
13786
13787 .vitem &$tls_out_peerdn$&
13788 .vindex "&$tls_out_peerdn$&"
13789 When a message is being delivered to a remote host over an encrypted SMTP
13790 connection, and Exim is configured to request a certificate from the server,
13791 the value of the Distinguished Name of the certificate is made available in the
13792 &$tls_out_peerdn$& during subsequent processing.
13793 If certificate verification fails it may refer to a failing chain element
13794 which is not the leaf.
13795
13796
13797 .new
13798 .vitem &$tls_in_resumption$& &&&
13799        &$tls_out_resumption$&
13800 .vindex &$tls_in_resumption$&
13801 .vindex &$tls_out_resumption$&
13802 .cindex TLS resumption
13803 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13804 .wen
13805
13806
13807 .vitem &$tls_in_sni$&
13808 .vindex "&$tls_in_sni$&"
13809 .vindex "&$tls_sni$&"
13810 .cindex "TLS" "Server Name Indication"
13811 When a TLS session is being established, if the client sends the Server
13812 Name Indication extension, the value will be placed in this variable.
13813 If the variable appears in &%tls_certificate%& then this option and
13814 some others, described in &<<SECTtlssni>>&,
13815 will be re-expanded early in the TLS session, to permit
13816 a different certificate to be presented (and optionally a different key to be
13817 used) to the client, based upon the value of the SNI extension.
13818
13819 The deprecated &$tls_sni$& variable refers to the inbound side
13820 except when used in the context of an outbound SMTP delivery, when it refers to
13821 the outbound.
13822
13823 .vitem &$tls_out_sni$&
13824 .vindex "&$tls_out_sni$&"
13825 .cindex "TLS" "Server Name Indication"
13826 During outbound
13827 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13828 the transport.
13829
13830 .vitem &$tls_out_tlsa_usage$&
13831 .vindex &$tls_out_tlsa_usage$&
13832 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13833
13834 .vitem &$tls_in_ver$&
13835 .vindex "&$tls_in_ver$&"
13836 When a message is received from a remote host over an encrypted SMTP connection
13837 this variable is set to the protocol version, eg &'TLS1.2'&.
13838
13839 .vitem &$tls_out_ver$&
13840 .vindex "&$tls_out_ver$&"
13841 When a message is being delivered to a remote host over an encrypted SMTP connection
13842 this variable is set to the protocol version.
13843
13844
13845 .vitem &$tod_bsdinbox$&
13846 .vindex "&$tod_bsdinbox$&"
13847 The time of day and the date, in the format required for BSD-style mailbox
13848 files, for example: Thu Oct 17 17:14:09 1995.
13849
13850 .vitem &$tod_epoch$&
13851 .vindex "&$tod_epoch$&"
13852 The time and date as a number of seconds since the start of the Unix epoch.
13853
13854 .vitem &$tod_epoch_l$&
13855 .vindex "&$tod_epoch_l$&"
13856 The time and date as a number of microseconds since the start of the Unix epoch.
13857
13858 .vitem &$tod_full$&
13859 .vindex "&$tod_full$&"
13860 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13861 +0100. The timezone is always given as a numerical offset from UTC, with
13862 positive values used for timezones that are ahead (east) of UTC, and negative
13863 values for those that are behind (west).
13864
13865 .vitem &$tod_log$&
13866 .vindex "&$tod_log$&"
13867 The time and date in the format used for writing Exim's log files, for example:
13868 1995-10-12 15:32:29, but without a timezone.
13869
13870 .vitem &$tod_logfile$&
13871 .vindex "&$tod_logfile$&"
13872 This variable contains the date in the format yyyymmdd. This is the format that
13873 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13874 flag.
13875
13876 .vitem &$tod_zone$&
13877 .vindex "&$tod_zone$&"
13878 This variable contains the numerical value of the local timezone, for example:
13879 -0500.
13880
13881 .vitem &$tod_zulu$&
13882 .vindex "&$tod_zulu$&"
13883 This variable contains the UTC date and time in &"Zulu"& format, as specified
13884 by ISO 8601, for example: 20030221154023Z.
13885
13886 .vitem &$transport_name$&
13887 .cindex "transport" "name"
13888 .cindex "name" "of transport"
13889 .vindex "&$transport_name$&"
13890 During the running of a transport, this variable contains its name.
13891
13892 .vitem &$value$&
13893 .vindex "&$value$&"
13894 This variable contains the result of an expansion lookup, extraction operation,
13895 or external command, as described above. It is also used during a
13896 &*reduce*& expansion.
13897
13898 .vitem &$verify_mode$&
13899 .vindex "&$verify_mode$&"
13900 While a router or transport is being run in verify mode or for cutthrough delivery,
13901 contains "S" for sender-verification or "R" for recipient-verification.
13902 Otherwise, empty.
13903
13904 .vitem &$version_number$&
13905 .vindex "&$version_number$&"
13906 The version number of Exim. Same as &$exim_version$&, may be overridden
13907 by the &%exim_version%& main config option.
13908
13909 .vitem &$warn_message_delay$&
13910 .vindex "&$warn_message_delay$&"
13911 This variable is set only during the creation of a message warning about a
13912 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13913
13914 .vitem &$warn_message_recipients$&
13915 .vindex "&$warn_message_recipients$&"
13916 This variable is set only during the creation of a message warning about a
13917 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13918 .endlist
13919 .ecindex IIDstrexp
13920
13921
13922
13923 . ////////////////////////////////////////////////////////////////////////////
13924 . ////////////////////////////////////////////////////////////////////////////
13925
13926 .chapter "Embedded Perl" "CHAPperl"
13927 .scindex IIDperl "Perl" "calling from Exim"
13928 Exim can be built to include an embedded Perl interpreter. When this is done,
13929 Perl subroutines can be called as part of the string expansion process. To make
13930 use of the Perl support, you need version 5.004 or later of Perl installed on
13931 your system. To include the embedded interpreter in the Exim binary, include
13932 the line
13933 .code
13934 EXIM_PERL = perl.o
13935 .endd
13936 in your &_Local/Makefile_& and then build Exim in the normal way.
13937
13938
13939 .section "Setting up so Perl can be used" "SECID85"
13940 .oindex "&%perl_startup%&"
13941 Access to Perl subroutines is via a global configuration option called
13942 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13943 no &%perl_startup%& option in the Exim configuration file then no Perl
13944 interpreter is started and there is almost no overhead for Exim (since none of
13945 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13946 option then the associated value is taken to be Perl code which is executed in
13947 a newly created Perl interpreter.
13948
13949 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13950 need backslashes before any characters to escape special meanings. The option
13951 should usually be something like
13952 .code
13953 perl_startup = do '/etc/exim.pl'
13954 .endd
13955 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13956 use from Exim. Exim can be configured either to start up a Perl interpreter as
13957 soon as it is entered, or to wait until the first time it is needed. Starting
13958 the interpreter at the beginning ensures that it is done while Exim still has
13959 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13960 fact used in a particular run. Also, note that this does not mean that Exim is
13961 necessarily running as root when Perl is called at a later time. By default,
13962 the interpreter is started only when it is needed, but this can be changed in
13963 two ways:
13964
13965 .ilist
13966 .oindex "&%perl_at_start%&"
13967 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13968 a startup when Exim is entered.
13969 .next
13970 The command line option &%-ps%& also requests a startup when Exim is entered,
13971 overriding the setting of &%perl_at_start%&.
13972 .endlist
13973
13974 There is also a command line option &%-pd%& (for delay) which suppresses the
13975 initial startup, even if &%perl_at_start%& is set.
13976
13977 .ilist
13978 .oindex "&%perl_taintmode%&"
13979 .cindex "Perl" "taintmode"
13980 To provide more security executing Perl code via the embedded Perl
13981 interpreter, the &%perl_taintmode%& option can be set. This enables the
13982 taint mode of the Perl interpreter. You are encouraged to set this
13983 option to a true value. To avoid breaking existing installations, it
13984 defaults to false.
13985
13986
13987 .section "Calling Perl subroutines" "SECID86"
13988 When the configuration file includes a &%perl_startup%& option you can make use
13989 of the string expansion item to call the Perl subroutines that are defined
13990 by the &%perl_startup%& code. The operator is used in any of the following
13991 forms:
13992 .code
13993 ${perl{foo}}
13994 ${perl{foo}{argument}}
13995 ${perl{foo}{argument1}{argument2} ... }
13996 .endd
13997 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13998 arguments may be passed. Passing more than this results in an expansion failure
13999 with an error message of the form
14000 .code
14001 Too many arguments passed to Perl subroutine "foo" (max is 8)
14002 .endd
14003 The return value of the Perl subroutine is evaluated in a scalar context before
14004 it is passed back to Exim to be inserted into the expanded string. If the
14005 return value is &'undef'&, the expansion is forced to fail in the same way as
14006 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14007 by obeying Perl's &%die%& function, the expansion fails with the error message
14008 that was passed to &%die%&.
14009
14010
14011 .section "Calling Exim functions from Perl" "SECID87"
14012 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14013 is available to call back into Exim's string expansion function. For example,
14014 the Perl code
14015 .code
14016 my $lp = Exim::expand_string('$local_part');
14017 .endd
14018 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14019 Note those are single quotes and not double quotes to protect against
14020 &$local_part$& being interpolated as a Perl variable.
14021
14022 If the string expansion is forced to fail by a &"fail"& item, the result of
14023 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14024 expansion string, the Perl call from the original expansion string fails with
14025 an appropriate error message, in the same way as if &%die%& were used.
14026
14027 .cindex "debugging" "from embedded Perl"
14028 .cindex "log" "writing from embedded Perl"
14029 Two other Exim functions are available for use from within Perl code.
14030 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14031 debugging is enabled. If you want a newline at the end, you must supply it.
14032 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14033 timestamp. In this case, you should not supply a terminating newline.
14034
14035
14036 .section "Use of standard output and error by Perl" "SECID88"
14037 .cindex "Perl" "standard output and error"
14038 You should not write to the standard error or output streams from within your
14039 Perl code, as it is not defined how these are set up. In versions of Exim
14040 before 4.50, it is possible for the standard output or error to refer to the
14041 SMTP connection during message reception via the daemon. Writing to this stream
14042 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14043 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14044 avoided, but the output is lost.
14045
14046 .cindex "Perl" "use of &%warn%&"
14047 The Perl &%warn%& statement writes to the standard error stream by default.
14048 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14049 you have no control. When Exim starts up the Perl interpreter, it arranges for
14050 output from the &%warn%& statement to be written to the Exim main log. You can
14051 change this by including appropriate Perl magic somewhere in your Perl code.
14052 For example, to discard &%warn%& output completely, you need this:
14053 .code
14054 $SIG{__WARN__} = sub { };
14055 .endd
14056 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14057 example, the code for the subroutine is empty, so it does nothing, but you can
14058 include any Perl code that you like. The text of the &%warn%& message is passed
14059 as the first subroutine argument.
14060 .ecindex IIDperl
14061
14062
14063 . ////////////////////////////////////////////////////////////////////////////
14064 . ////////////////////////////////////////////////////////////////////////////
14065
14066 .chapter "Starting the daemon and the use of network interfaces" &&&
14067          "CHAPinterfaces" &&&
14068          "Starting the daemon"
14069 .cindex "daemon" "starting"
14070 .cindex "interface" "listening"
14071 .cindex "network interface"
14072 .cindex "interface" "network"
14073 .cindex "IP address" "for listening"
14074 .cindex "daemon" "listening IP addresses"
14075 .cindex "TCP/IP" "setting listening interfaces"
14076 .cindex "TCP/IP" "setting listening ports"
14077 A host that is connected to a TCP/IP network may have one or more physical
14078 hardware network interfaces. Each of these interfaces may be configured as one
14079 or more &"logical"& interfaces, which are the entities that a program actually
14080 works with. Each of these logical interfaces is associated with an IP address.
14081 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14082 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14083 knowledge about the host's interfaces for use in three different circumstances:
14084
14085 .olist
14086 When a listening daemon is started, Exim needs to know which interfaces
14087 and ports to listen on.
14088 .next
14089 When Exim is routing an address, it needs to know which IP addresses
14090 are associated with local interfaces. This is required for the correct
14091 processing of MX lists by removing the local host and others with the
14092 same or higher priority values. Also, Exim needs to detect cases
14093 when an address is routed to an IP address that in fact belongs to the
14094 local host. Unless the &%self%& router option or the &%allow_localhost%&
14095 option of the smtp transport is set (as appropriate), this is treated
14096 as an error situation.
14097 .next
14098 When Exim connects to a remote host, it may need to know which interface to use
14099 for the outgoing connection.
14100 .endlist
14101
14102
14103 Exim's default behaviour is likely to be appropriate in the vast majority
14104 of cases. If your host has only one interface, and you want all its IP
14105 addresses to be treated in the same way, and you are using only the
14106 standard SMTP port, you should not need to take any special action. The
14107 rest of this chapter does not apply to you.
14108
14109 In a more complicated situation you may want to listen only on certain
14110 interfaces, or on different ports, and for this reason there are a number of
14111 options that can be used to influence Exim's behaviour. The rest of this
14112 chapter describes how they operate.
14113
14114 When a message is received over TCP/IP, the interface and port that were
14115 actually used are set in &$received_ip_address$& and &$received_port$&.
14116
14117
14118
14119 .section "Starting a listening daemon" "SECID89"
14120 When a listening daemon is started (by means of the &%-bd%& command line
14121 option), the interfaces and ports on which it listens are controlled by the
14122 following options:
14123
14124 .ilist
14125 &%daemon_smtp_ports%& contains a list of default ports
14126 or service names.
14127 (For backward compatibility, this option can also be specified in the singular.)
14128 .next
14129 &%local_interfaces%& contains list of interface IP addresses on which to
14130 listen. Each item may optionally also specify a port.
14131 .endlist
14132
14133 The default list separator in both cases is a colon, but this can be changed as
14134 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14135 it is usually best to change the separator to avoid having to double all the
14136 colons. For example:
14137 .code
14138 local_interfaces = <; 127.0.0.1 ; \
14139                       192.168.23.65 ; \
14140                       ::1 ; \
14141                       3ffe:ffff:836f::fe86:a061
14142 .endd
14143 There are two different formats for specifying a port along with an IP address
14144 in &%local_interfaces%&:
14145
14146 .olist
14147 The port is added onto the address with a dot separator. For example, to listen
14148 on port 1234 on two different IP addresses:
14149 .code
14150 local_interfaces = <; 192.168.23.65.1234 ; \
14151                       3ffe:ffff:836f::fe86:a061.1234
14152 .endd
14153 .next
14154 The IP address is enclosed in square brackets, and the port is added
14155 with a colon separator, for example:
14156 .code
14157 local_interfaces = <; [192.168.23.65]:1234 ; \
14158                       [3ffe:ffff:836f::fe86:a061]:1234
14159 .endd
14160 .endlist
14161
14162 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14163 default setting contains just one port:
14164 .code
14165 daemon_smtp_ports = smtp
14166 .endd
14167 If more than one port is listed, each interface that does not have its own port
14168 specified listens on all of them. Ports that are listed in
14169 &%daemon_smtp_ports%& can be identified either by name (defined in
14170 &_/etc/services_&) or by number. However, when ports are given with individual
14171 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14172
14173
14174
14175 .section "Special IP listening addresses" "SECID90"
14176 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14177 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14178 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14179 instead of setting up separate listening sockets for each interface. The
14180 default value of &%local_interfaces%& is
14181 .code
14182 local_interfaces = 0.0.0.0
14183 .endd
14184 when Exim is built without IPv6 support; otherwise it is:
14185 .code
14186 local_interfaces = <; ::0 ; 0.0.0.0
14187 .endd
14188 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14189
14190
14191
14192 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14193 The &%-oX%& command line option can be used to override the values of
14194 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14195 instance. Another way of doing this would be to use macros and the &%-D%&
14196 option. However, &%-oX%& can be used by any admin user, whereas modification of
14197 the runtime configuration by &%-D%& is allowed only when the caller is root or
14198 exim.
14199
14200 The value of &%-oX%& is a list of items. The default colon separator can be
14201 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14202 If there are any items that do not
14203 contain dots or colons (that is, are not IP addresses), the value of
14204 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14205 items that do contain dots or colons, the value of &%local_interfaces%& is
14206 replaced by those items. Thus, for example,
14207 .code
14208 -oX 1225
14209 .endd
14210 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14211 whereas
14212 .code
14213 -oX 192.168.34.5.1125
14214 .endd
14215 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14216 (However, since &%local_interfaces%& now contains no items without ports, the
14217 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14218
14219
14220
14221 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14222 .cindex "submissions protocol"
14223 .cindex "ssmtp protocol"
14224 .cindex "smtps protocol"
14225 .cindex "SMTP" "ssmtp protocol"
14226 .cindex "SMTP" "smtps protocol"
14227 Exim supports the use of TLS-on-connect, used by mail clients in the
14228 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14229 For some years, IETF Standards Track documents only blessed the
14230 STARTTLS-based Submission service (port 587) while common practice was to support
14231 the same feature set on port 465, but using TLS-on-connect.
14232 If your installation needs to provide service to mail clients
14233 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14234 the 465 TCP ports.
14235
14236 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14237 service names, connections to those ports must first establish TLS, before
14238 proceeding to the application layer use of the SMTP protocol.
14239
14240 The common use of this option is expected to be
14241 .code
14242 tls_on_connect_ports = 465
14243 .endd
14244 per RFC 8314.
14245 There is also a command line option &%-tls-on-connect%&, which forces all ports
14246 to behave in this way when a daemon is started.
14247
14248 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14249 daemon to listen on those ports. You must still specify them in
14250 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14251 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14252 connections via the daemon.)
14253
14254
14255
14256
14257 .section "IPv6 address scopes" "SECID92"
14258 .cindex "IPv6" "address scopes"
14259 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14260 can, in principle, have the same link-local IPv6 address on different
14261 interfaces. Thus, additional information is needed, over and above the IP
14262 address, to distinguish individual interfaces. A convention of using a
14263 percent sign followed by something (often the interface name) has been
14264 adopted in some cases, leading to addresses like this:
14265 .code
14266 fe80::202:b3ff:fe03:45c1%eth0
14267 .endd
14268 To accommodate this usage, a percent sign followed by an arbitrary string is
14269 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14270 to convert a textual IPv6 address for actual use. This function recognizes the
14271 percent convention in operating systems that support it, and it processes the
14272 address appropriately. Unfortunately, some older libraries have problems with
14273 &[getaddrinfo()]&. If
14274 .code
14275 IPV6_USE_INET_PTON=yes
14276 .endd
14277 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14278 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14279 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14280 function.) Of course, this means that the additional functionality of
14281 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14282
14283 .section "Disabling IPv6" "SECID93"
14284 .cindex "IPv6" "disabling"
14285 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14286 run on a host whose kernel does not support IPv6. The binary will fall back to
14287 using IPv4, but it may waste resources looking up AAAA records, and trying to
14288 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14289 .oindex "&%disable_ipv6%&"
14290 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14291 activities take place. AAAA records are never looked up, and any IPv6 addresses
14292 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14293 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14294 to handle IPv6 literal addresses.
14295
14296 On the other hand, when IPv6 is in use, there may be times when you want to
14297 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14298 option to globally suppress the lookup of AAAA records for specified domains,
14299 and you can use the &%ignore_target_hosts%& generic router option to ignore
14300 IPv6 addresses in an individual router.
14301
14302
14303
14304 .section "Examples of starting a listening daemon" "SECID94"
14305 The default case in an IPv6 environment is
14306 .code
14307 daemon_smtp_ports = smtp
14308 local_interfaces = <; ::0 ; 0.0.0.0
14309 .endd
14310 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14311 Either one or two sockets may be used, depending on the characteristics of
14312 the TCP/IP stack. (This is complicated and messy; for more information,
14313 read the comments in the &_daemon.c_& source file.)
14314
14315 To specify listening on ports 25 and 26 on all interfaces:
14316 .code
14317 daemon_smtp_ports = 25 : 26
14318 .endd
14319 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14320 .code
14321 local_interfaces = <; ::0.25     ; ::0.26 \
14322                       0.0.0.0.25 ; 0.0.0.0.26
14323 .endd
14324 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14325 IPv4 loopback address only:
14326 .code
14327 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14328 .endd
14329 To specify listening on the default port on specific interfaces only:
14330 .code
14331 local_interfaces = 10.0.0.67 : 192.168.34.67
14332 .endd
14333 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14334
14335
14336
14337 .section "Recognizing the local host" "SECTreclocipadd"
14338 The &%local_interfaces%& option is also used when Exim needs to determine
14339 whether or not an IP address refers to the local host. That is, the IP
14340 addresses of all the interfaces on which a daemon is listening are always
14341 treated as local.
14342
14343 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14344 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14345 available interfaces from the operating system, and extracts the relevant
14346 (that is, IPv4 or IPv6) addresses to use for checking.
14347
14348 Some systems set up large numbers of virtual interfaces in order to provide
14349 many virtual web servers. In this situation, you may want to listen for
14350 email on only a few of the available interfaces, but nevertheless treat all
14351 interfaces as local when routing. You can do this by setting
14352 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14353 &"all"& wildcard values. These addresses are recognized as local, but are not
14354 used for listening. Consider this example:
14355 .code
14356 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14357                       192.168.53.235 ; \
14358                       3ffe:2101:12:1:a00:20ff:fe86:a061
14359
14360 extra_local_interfaces = <; ::0 ; 0.0.0.0
14361 .endd
14362 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14363 address, but all available interface addresses are treated as local when
14364 Exim is routing.
14365
14366 In some environments the local host name may be in an MX list, but with an IP
14367 address that is not assigned to any local interface. In other cases it may be
14368 desirable to treat other host names as if they referred to the local host. Both
14369 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14370 This contains host names rather than IP addresses. When a host is referenced
14371 during routing, either via an MX record or directly, it is treated as the local
14372 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14373 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14374
14375
14376
14377 .section "Delivering to a remote host" "SECID95"
14378 Delivery to a remote host is handled by the smtp transport. By default, it
14379 allows the system's TCP/IP functions to choose which interface to use (if
14380 there is more than one) when connecting to a remote host. However, the
14381 &%interface%& option can be set to specify which interface is used. See the
14382 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14383 details.
14384
14385
14386
14387
14388 . ////////////////////////////////////////////////////////////////////////////
14389 . ////////////////////////////////////////////////////////////////////////////
14390
14391 .chapter "Main configuration" "CHAPmainconfig"
14392 .scindex IIDconfima "configuration file" "main section"
14393 .scindex IIDmaiconf "main configuration"
14394 The first part of the runtime configuration file contains three types of item:
14395
14396 .ilist
14397 Macro definitions: These lines start with an upper case letter. See section
14398 &<<SECTmacrodefs>>& for details of macro processing.
14399 .next
14400 Named list definitions: These lines start with one of the words &"domainlist"&,
14401 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14402 section &<<SECTnamedlists>>&.
14403 .next
14404 Main configuration settings: Each setting occupies one line of the file
14405 (with possible continuations). If any setting is preceded by the word
14406 &"hide"&, the &%-bP%& command line option displays its value to admin users
14407 only. See section &<<SECTcos>>& for a description of the syntax of these option
14408 settings.
14409 .endlist
14410
14411 This chapter specifies all the main configuration options, along with their
14412 types and default values. For ease of finding a particular option, they appear
14413 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14414 are now so many options, they are first listed briefly in functional groups, as
14415 an aid to finding the name of the option you are looking for. Some options are
14416 listed in more than one group.
14417
14418 .section "Miscellaneous" "SECID96"
14419 .table2
14420 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14421 .row &%debug_store%&                 "do extra internal checks"
14422 .row &%disable_ipv6%&                "do no IPv6 processing"
14423 .row &%keep_malformed%&              "for broken files &-- should not happen"
14424 .row &%localhost_number%&            "for unique message ids in clusters"
14425 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14426 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14427 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14428 .row &%print_topbitchars%&           "top-bit characters are printing"
14429 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14430 .row &%timezone%&                    "force time zone"
14431 .endtable
14432
14433
14434 .section "Exim parameters" "SECID97"
14435 .table2
14436 .row &%exim_group%&                  "override compiled-in value"
14437 .row &%exim_path%&                   "override compiled-in value"
14438 .row &%exim_user%&                   "override compiled-in value"
14439 .row &%primary_hostname%&            "default from &[uname()]&"
14440 .row &%split_spool_directory%&       "use multiple directories"
14441 .row &%spool_directory%&             "override compiled-in value"
14442 .endtable
14443
14444
14445
14446 .section "Privilege controls" "SECID98"
14447 .table2
14448 .row &%admin_groups%&                "groups that are Exim admin users"
14449 .row &%commandline_checks_require_admin%& "require admin for various checks"
14450 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14451 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14452 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14453 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14454 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14455 .row &%never_users%&                 "do not run deliveries as these"
14456 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14457 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14458 .row &%trusted_groups%&              "groups that are trusted"
14459 .row &%trusted_users%&               "users that are trusted"
14460 .endtable
14461
14462
14463
14464 .section "Logging" "SECID99"
14465 .table2
14466 .row &%event_action%&                "custom logging"
14467 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14468 .row &%log_file_path%&               "override compiled-in value"
14469 .row &%log_selector%&                "set/unset optional logging"
14470 .row &%log_timezone%&                "add timezone to log lines"
14471 .row &%message_logs%&                "create per-message logs"
14472 .row &%preserve_message_logs%&       "after message completion"
14473 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14474 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14475 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14476 .row &%syslog_facility%&             "set syslog &""facility""& field"
14477 .row &%syslog_pid%&                  "pid in syslog lines"
14478 .row &%syslog_processname%&          "set syslog &""ident""& field"
14479 .row &%syslog_timestamp%&            "timestamp syslog lines"
14480 .row &%write_rejectlog%&             "control use of message log"
14481 .endtable
14482
14483
14484
14485 .section "Frozen messages" "SECID100"
14486 .table2
14487 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14488 .row &%freeze_tell%&                 "send message when freezing"
14489 .row &%move_frozen_messages%&        "to another directory"
14490 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14491 .endtable
14492
14493
14494
14495 .section "Data lookups" "SECID101"
14496 .table2
14497 .row &%ibase_servers%&               "InterBase servers"
14498 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14499 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14500 .row &%ldap_cert_file%&              "client cert file for LDAP"
14501 .row &%ldap_cert_key%&               "client key file for LDAP"
14502 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14503 .row &%ldap_default_servers%&        "used if no server in query"
14504 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14505 .row &%ldap_start_tls%&              "require TLS within LDAP"
14506 .row &%ldap_version%&                "set protocol version"
14507 .row &%lookup_open_max%&             "lookup files held open"
14508 .row &%mysql_servers%&               "default MySQL servers"
14509 .row &%oracle_servers%&              "Oracle servers"
14510 .row &%pgsql_servers%&               "default PostgreSQL servers"
14511 .row &%sqlite_lock_timeout%&         "as it says"
14512 .endtable
14513
14514
14515
14516 .section "Message ids" "SECID102"
14517 .table2
14518 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14519 .row &%message_id_header_text%&      "ditto"
14520 .endtable
14521
14522
14523
14524 .section "Embedded Perl Startup" "SECID103"
14525 .table2
14526 .row &%perl_at_start%&               "always start the interpreter"
14527 .row &%perl_startup%&                "code to obey when starting Perl"
14528 .row &%perl_taintmode%&              "enable taint mode in Perl"
14529 .endtable
14530
14531
14532
14533 .section "Daemon" "SECID104"
14534 .table2
14535 .row &%daemon_smtp_ports%&           "default ports"
14536 .row &%daemon_startup_retries%&      "number of times to retry"
14537 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14538 .row &%extra_local_interfaces%&      "not necessarily listened on"
14539 .row &%local_interfaces%&            "on which to listen, with optional ports"
14540 .row &%notifier_socket%&             "override compiled-in value"
14541 .row &%pid_file_path%&               "override compiled-in value"
14542 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14543 .endtable
14544
14545
14546
14547 .section "Resource control" "SECID105"
14548 .table2
14549 .row &%check_log_inodes%&            "before accepting a message"
14550 .row &%check_log_space%&             "before accepting a message"
14551 .row &%check_spool_inodes%&          "before accepting a message"
14552 .row &%check_spool_space%&           "before accepting a message"
14553 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14554 .row &%queue_only_load%&             "queue incoming if load high"
14555 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14556 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14557 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14558 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14559 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14560 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14561 .row &%smtp_accept_max_per_connection%& "messages per connection"
14562 .row &%smtp_accept_max_per_host%&    "connections from one host"
14563 .row &%smtp_accept_queue%&           "queue mail if more connections"
14564 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14565                                            connection"
14566 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14567 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14568 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14569 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14570 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14571 .endtable
14572
14573
14574
14575 .section "Policy controls" "SECID106"
14576 .table2
14577 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14578 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14579 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14580 .row &%acl_smtp_auth%&               "ACL for AUTH"
14581 .row &%acl_smtp_connect%&            "ACL for connection"
14582 .row &%acl_smtp_data%&               "ACL for DATA"
14583 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14584 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14585 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14586 .row &%acl_smtp_expn%&               "ACL for EXPN"
14587 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14588 .row &%acl_smtp_mail%&               "ACL for MAIL"
14589 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14590 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14591 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14592 .row &%acl_smtp_predata%&            "ACL for start of data"
14593 .row &%acl_smtp_quit%&               "ACL for QUIT"
14594 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14595 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14596 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14597 .row &%av_scanner%&                  "specify virus scanner"
14598 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14599                                       words""&"
14600 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14601 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14602 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14603 .row &%header_maxsize%&              "total size of message header"
14604 .row &%header_line_maxsize%&         "individual header line limit"
14605 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14606 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14607 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14608 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14609 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14610 .row &%host_lookup%&                 "host name looked up for these hosts"
14611 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14612 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14613 .row &%host_reject_connection%&      "reject connection from these hosts"
14614 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14615 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14616 .row &%message_size_limit%&          "for all messages"
14617 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14618 .row &%spamd_address%&               "set interface to SpamAssassin"
14619 .row &%strict_acl_vars%&             "object to unset ACL variables"
14620 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14621 .endtable
14622
14623
14624
14625 .section "Callout cache" "SECID107"
14626 .table2
14627 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14628                                          item"
14629 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14630                                          item"
14631 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14632 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14633 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14634 .endtable
14635
14636
14637
14638 .section "TLS" "SECID108"
14639 .table2
14640 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14641 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14642 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14643 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14644 .row &%tls_certificate%&             "location of server certificate"
14645 .row &%tls_crl%&                     "certificate revocation list"
14646 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14647 .row &%tls_dhparam%&                 "DH parameters for server"
14648 .row &%tls_eccurve%&                 "EC curve selection for server"
14649 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14650 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14651 .row &%tls_privatekey%&              "location of server private key"
14652 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14653 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14654 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14655 .row &%tls_verify_certificates%&     "expected client certificates"
14656 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14657 .endtable
14658
14659
14660
14661 .section "Local user handling" "SECID109"
14662 .table2
14663 .row &%finduser_retries%&            "useful in NIS environments"
14664 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14665 .row &%gecos_pattern%&               "ditto"
14666 .row &%max_username_length%&         "for systems that truncate"
14667 .row &%unknown_login%&               "used when no login name found"
14668 .row &%unknown_username%&            "ditto"
14669 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14670 .row &%uucp_from_sender%&            "ditto"
14671 .endtable
14672
14673
14674
14675 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14676 .table2
14677 .row &%header_maxsize%&              "total size of message header"
14678 .row &%header_line_maxsize%&         "individual header line limit"
14679 .row &%message_size_limit%&          "applies to all messages"
14680 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14681 .row &%received_header_text%&        "expanded to make &'Received:'&"
14682 .row &%received_headers_max%&        "for mail loop detection"
14683 .row &%recipients_max%&              "limit per message"
14684 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14685 .endtable
14686
14687
14688
14689
14690 .section "Non-SMTP incoming messages" "SECID111"
14691 .table2
14692 .row &%receive_timeout%&             "for non-SMTP messages"
14693 .endtable
14694
14695
14696
14697
14698
14699 .section "Incoming SMTP messages" "SECID112"
14700 See also the &'Policy controls'& section above.
14701
14702 .table2
14703 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14704 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14705 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14706 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14707 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14708 .row &%dmarc_history_file%&          "DMARC results log"
14709 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14710 .row &%host_lookup%&                 "host name looked up for these hosts"
14711 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14712 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14713 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14714 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14715 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14716 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14717 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14718 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14719 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14720 .row &%smtp_accept_max_per_connection%& "messages per connection"
14721 .row &%smtp_accept_max_per_host%&    "connections from one host"
14722 .row &%smtp_accept_queue%&           "queue mail if more connections"
14723 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14724                                            connection"
14725 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14726 .row &%smtp_active_hostname%&        "host name to use in messages"
14727 .row &%smtp_banner%&                 "text for welcome banner"
14728 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14729 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14730 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14731 .row &%smtp_etrn_command%&           "what to run for ETRN"
14732 .row &%smtp_etrn_serialize%&         "only one at once"
14733 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14734 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14735 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14736 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14737 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14738 .row &%smtp_receive_timeout%&        "per command or data line"
14739 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14740 .row &%smtp_return_error_details%&   "give detail on rejections"
14741 .endtable
14742
14743
14744
14745 .section "SMTP extensions" "SECID113"
14746 .table2
14747 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14748 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14749 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14750 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14751 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14752 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14753 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14754 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14755 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14756 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14757 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14758 .endtable
14759
14760
14761
14762 .section "Processing messages" "SECID114"
14763 .table2
14764 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14765 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14766 .row &%allow_utf8_domains%&          "in addresses"
14767 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14768                                       words""&"
14769 .row &%delivery_date_remove%&        "from incoming messages"
14770 .row &%envelope_to_remove%&          "from incoming messages"
14771 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14772 .row &%headers_charset%&             "default for translations"
14773 .row &%qualify_domain%&              "default for senders"
14774 .row &%qualify_recipient%&           "default for recipients"
14775 .row &%return_path_remove%&          "from incoming messages"
14776 .row &%strip_excess_angle_brackets%& "in addresses"
14777 .row &%strip_trailing_dot%&          "at end of addresses"
14778 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14779 .endtable
14780
14781
14782
14783 .section "System filter" "SECID115"
14784 .table2
14785 .row &%system_filter%&               "locate system filter"
14786 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14787                                             directory"
14788 .row &%system_filter_file_transport%& "transport for delivery to a file"
14789 .row &%system_filter_group%&         "group for filter running"
14790 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14791 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14792 .row &%system_filter_user%&          "user for filter running"
14793 .endtable
14794
14795
14796
14797 .section "Routing and delivery" "SECID116"
14798 .table2
14799 .row &%disable_ipv6%&                "do no IPv6 processing"
14800 .row &%dns_again_means_nonexist%&    "for broken domains"
14801 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14802 .row &%dns_dnssec_ok%&               "parameter for resolver"
14803 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14804 .row &%dns_retrans%&                 "parameter for resolver"
14805 .row &%dns_retry%&                   "parameter for resolver"
14806 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14807 .row &%dns_use_edns0%&               "parameter for resolver"
14808 .row &%hold_domains%&                "hold delivery for these domains"
14809 .row &%local_interfaces%&            "for routing checks"
14810 .row &%queue_domains%&               "no immediate delivery for these"
14811 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14812 .row &%queue_only%&                  "no immediate delivery at all"
14813 .row &%queue_only_file%&             "no immediate delivery if file exists"
14814 .row &%queue_only_load%&             "no immediate delivery if load is high"
14815 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14816 .row &%queue_only_override%&         "allow command line to override"
14817 .row &%queue_run_in_order%&          "order of arrival"
14818 .row &%queue_run_max%&               "of simultaneous queue runners"
14819 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14820 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14821 .row &%remote_sort_domains%&         "order of remote deliveries"
14822 .row &%retry_data_expire%&           "timeout for retry data"
14823 .row &%retry_interval_max%&          "safety net for retry rules"
14824 .endtable
14825
14826
14827
14828 .section "Bounce and warning messages" "SECID117"
14829 .table2
14830 .row &%bounce_message_file%&         "content of bounce"
14831 .row &%bounce_message_text%&         "content of bounce"
14832 .row &%bounce_return_body%&          "include body if returning message"
14833 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14834 .row &%bounce_return_message%&       "include original message in bounce"
14835 .row &%bounce_return_size_limit%&    "limit on returned message"
14836 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14837 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14838 .row &%errors_copy%&                 "copy bounce messages"
14839 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14840 .row &%delay_warning%&               "time schedule"
14841 .row &%delay_warning_condition%&     "condition for warning messages"
14842 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14843 .row &%smtp_return_error_details%&   "give detail on rejections"
14844 .row &%warn_message_file%&           "content of warning message"
14845 .endtable
14846
14847
14848
14849 .section "Alphabetical list of main options" "SECTalomo"
14850 Those options that undergo string expansion before use are marked with
14851 &dagger;.
14852
14853 .option accept_8bitmime main boolean true
14854 .cindex "8BITMIME"
14855 .cindex "8-bit characters"
14856 .cindex "log" "selectors"
14857 .cindex "log" "8BITMIME"
14858 .cindex "ESMTP extensions" 8BITMIME
14859 This option causes Exim to send 8BITMIME in its response to an SMTP
14860 EHLO command, and to accept the BODY= parameter on MAIL commands.
14861 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14862 takes no steps to do anything special with messages received by this route.
14863
14864 Historically Exim kept this option off by default, but the maintainers
14865 feel that in today's Internet, this causes more problems than it solves.
14866 It now defaults to true.
14867 A more detailed analysis of the issues is provided by Dan Bernstein:
14868 .display
14869 &url(https://cr.yp.to/smtp/8bitmime.html)
14870 .endd
14871
14872 To log received 8BITMIME status use
14873 .code
14874 log_selector = +8bitmime
14875 .endd
14876
14877 .option acl_not_smtp main string&!! unset
14878 .cindex "&ACL;" "for non-SMTP messages"
14879 .cindex "non-SMTP messages" "ACLs for"
14880 This option defines the ACL that is run when a non-SMTP message has been
14881 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14882 further details.
14883
14884 .option acl_not_smtp_mime main string&!! unset
14885 This option defines the ACL that is run for individual MIME parts of non-SMTP
14886 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14887 SMTP messages.
14888
14889 .option acl_not_smtp_start main string&!! unset
14890 .cindex "&ACL;" "at start of non-SMTP message"
14891 .cindex "non-SMTP messages" "ACLs for"
14892 This option defines the ACL that is run before Exim starts reading a
14893 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14894
14895 .option acl_smtp_auth main string&!! unset
14896 .cindex "&ACL;" "setting up for SMTP commands"
14897 .cindex "AUTH" "ACL for"
14898 This option defines the ACL that is run when an SMTP AUTH command is
14899 received. See chapter &<<CHAPACL>>& for further details.
14900
14901 .option acl_smtp_connect main string&!! unset
14902 .cindex "&ACL;" "on SMTP connection"
14903 This option defines the ACL that is run when an SMTP connection is received.
14904 See chapter &<<CHAPACL>>& for further details.
14905
14906 .option acl_smtp_data main string&!! unset
14907 .cindex "DATA" "ACL for"
14908 This option defines the ACL that is run after an SMTP DATA command has been
14909 processed and the message itself has been received, but before the final
14910 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14911
14912 .option acl_smtp_data_prdr main string&!! accept
14913 .cindex "PRDR" "ACL for"
14914 .cindex "DATA" "PRDR ACL for"
14915 .cindex "&ACL;" "PRDR-related"
14916 .cindex "&ACL;" "per-user data processing"
14917 This option defines the ACL that,
14918 if the PRDR feature has been negotiated,
14919 is run for each recipient after an SMTP DATA command has been
14920 processed and the message itself has been received, but before the
14921 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14922
14923 .option acl_smtp_dkim main string&!! unset
14924 .cindex DKIM "ACL for"
14925 This option defines the ACL that is run for each DKIM signature
14926 (by default, or as specified in the dkim_verify_signers option)
14927 of a received message.
14928 See section &<<SECDKIMVFY>>& for further details.
14929
14930 .option acl_smtp_etrn main string&!! unset
14931 .cindex "ETRN" "ACL for"
14932 This option defines the ACL that is run when an SMTP ETRN command is
14933 received. See chapter &<<CHAPACL>>& for further details.
14934
14935 .option acl_smtp_expn main string&!! unset
14936 .cindex "EXPN" "ACL for"
14937 This option defines the ACL that is run when an SMTP EXPN command is
14938 received. See chapter &<<CHAPACL>>& for further details.
14939
14940 .option acl_smtp_helo main string&!! unset
14941 .cindex "EHLO" "ACL for"
14942 .cindex "HELO" "ACL for"
14943 This option defines the ACL that is run when an SMTP EHLO or HELO
14944 command is received. See chapter &<<CHAPACL>>& for further details.
14945
14946
14947 .option acl_smtp_mail main string&!! unset
14948 .cindex "MAIL" "ACL for"
14949 This option defines the ACL that is run when an SMTP MAIL command is
14950 received. See chapter &<<CHAPACL>>& for further details.
14951
14952 .option acl_smtp_mailauth main string&!! unset
14953 .cindex "AUTH" "on MAIL command"
14954 This option defines the ACL that is run when there is an AUTH parameter on
14955 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14956 &<<CHAPSMTPAUTH>>& for details of authentication.
14957
14958 .option acl_smtp_mime main string&!! unset
14959 .cindex "MIME content scanning" "ACL for"
14960 This option is available when Exim is built with the content-scanning
14961 extension. It defines the ACL that is run for each MIME part in a message. See
14962 section &<<SECTscanmimepart>>& for details.
14963
14964 .option acl_smtp_notquit main string&!! unset
14965 .cindex "not-QUIT, ACL for"
14966 This option defines the ACL that is run when an SMTP session
14967 ends without a QUIT command being received.
14968 See chapter &<<CHAPACL>>& for further details.
14969
14970 .option acl_smtp_predata main string&!! unset
14971 This option defines the ACL that is run when an SMTP DATA command is
14972 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14973 further details.
14974
14975 .option acl_smtp_quit main string&!! unset
14976 .cindex "QUIT, ACL for"
14977 This option defines the ACL that is run when an SMTP QUIT command is
14978 received. See chapter &<<CHAPACL>>& for further details.
14979
14980 .option acl_smtp_rcpt main string&!! unset
14981 .cindex "RCPT" "ACL for"
14982 This option defines the ACL that is run when an SMTP RCPT command is
14983 received. See chapter &<<CHAPACL>>& for further details.
14984
14985 .option acl_smtp_starttls main string&!! unset
14986 .cindex "STARTTLS, ACL for"
14987 This option defines the ACL that is run when an SMTP STARTTLS command is
14988 received. See chapter &<<CHAPACL>>& for further details.
14989
14990 .option acl_smtp_vrfy main string&!! unset
14991 .cindex "VRFY" "ACL for"
14992 This option defines the ACL that is run when an SMTP VRFY command is
14993 received. See chapter &<<CHAPACL>>& for further details.
14994
14995 .option add_environment main "string list" empty
14996 .cindex "environment" "set values"
14997 This option adds individual environment variables that the
14998 currently linked libraries and programs in child processes may use.
14999 Each list element should be of the form &"name=value"&.
15000
15001 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15002
15003 .option admin_groups main "string list&!!" unset
15004 .cindex "admin user"
15005 This option is expanded just once, at the start of Exim's processing. If the
15006 current group or any of the supplementary groups of an Exim caller is in this
15007 colon-separated list, the caller has admin privileges. If all your system
15008 programmers are in a specific group, for example, you can give them all Exim
15009 admin privileges by putting that group in &%admin_groups%&. However, this does
15010 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15011 To permit this, you have to add individuals to the Exim group.
15012
15013 .option allow_domain_literals main boolean false
15014 .cindex "domain literal"
15015 If this option is set, the RFC 2822 domain literal format is permitted in
15016 email addresses. The option is not set by default, because the domain literal
15017 format is not normally required these days, and few people know about it. It
15018 has, however, been exploited by mail abusers.
15019
15020 Unfortunately, it seems that some DNS black list maintainers are using this
15021 format to report black listing to postmasters. If you want to accept messages
15022 addressed to your hosts by IP address, you need to set
15023 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15024 domains (defined in the named domain list &%local_domains%& in the default
15025 configuration). This &"magic string"& matches the domain literal form of all
15026 the local host's IP addresses.
15027
15028
15029 .option allow_mx_to_ip main boolean false
15030 .cindex "MX record" "pointing to IP address"
15031 It appears that more and more DNS zone administrators are breaking the rules
15032 and putting domain names that look like IP addresses on the right hand side of
15033 MX records. Exim follows the rules and rejects this, giving an error message
15034 that explains the misconfiguration. However, some other MTAs support this
15035 practice, so to avoid &"Why can't Exim do this?"& complaints,
15036 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15037 recommended, except when you have no other choice.
15038
15039 .option allow_utf8_domains main boolean false
15040 .cindex "domain" "UTF-8 characters in"
15041 .cindex "UTF-8" "in domain name"
15042 Lots of discussion is going on about internationalized domain names. One
15043 camp is strongly in favour of just using UTF-8 characters, and it seems
15044 that at least two other MTAs permit this.
15045 This option allows Exim users to experiment if they wish.
15046
15047 If it is set true, Exim's domain parsing function allows valid
15048 UTF-8 multicharacters to appear in domain name components, in addition to
15049 letters, digits, and hyphens.
15050
15051 If Exim is built with internationalization support
15052 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15053 this option can be left as default.
15054 Without that,
15055 if you want to look up such domain names in the DNS, you must also
15056 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15057 suitable setting is:
15058 .code
15059 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15060   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15061 .endd
15062 Alternatively, you can just disable this feature by setting
15063 .code
15064 dns_check_names_pattern =
15065 .endd
15066 That is, set the option to an empty string so that no check is done.
15067
15068
15069 .option auth_advertise_hosts main "host list&!!" *
15070 .cindex "authentication" "advertising"
15071 .cindex "AUTH" "advertising"
15072 .cindex "ESMTP extensions" AUTH
15073 If any server authentication mechanisms are configured, Exim advertises them in
15074 response to an EHLO command only if the calling host matches this list.
15075 Otherwise, Exim does not advertise AUTH.
15076 Exim does not accept AUTH commands from clients to which it has not
15077 advertised the availability of AUTH. The advertising of individual
15078 authentication mechanisms can be controlled by the use of the
15079 &%server_advertise_condition%& generic authenticator option on the individual
15080 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15081
15082 Certain mail clients (for example, Netscape) require the user to provide a name
15083 and password for authentication if AUTH is advertised, even though it may
15084 not be needed (the host may accept messages from hosts on its local LAN without
15085 authentication, for example). The &%auth_advertise_hosts%& option can be used
15086 to make these clients more friendly by excluding them from the set of hosts to
15087 which Exim advertises AUTH.
15088
15089 .cindex "AUTH" "advertising when encrypted"
15090 If you want to advertise the availability of AUTH only when the connection
15091 is encrypted using TLS, you can make use of the fact that the value of this
15092 option is expanded, with a setting like this:
15093 .code
15094 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15095 .endd
15096 .vindex "&$tls_in_cipher$&"
15097 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15098 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15099 expansion is *, which matches all hosts.
15100
15101
15102 .option auto_thaw main time 0s
15103 .cindex "thawing messages"
15104 .cindex "unfreezing messages"
15105 If this option is set to a time greater than zero, a queue runner will try a
15106 new delivery attempt on any frozen message, other than a bounce message, if
15107 this much time has passed since it was frozen. This may result in the message
15108 being re-frozen if nothing has changed since the last attempt. It is a way of
15109 saying &"keep on trying, even though there are big problems"&.
15110
15111 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15112 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15113 thought to be very useful any more, and its use should probably be avoided.
15114
15115
15116 .option av_scanner main string "see below"
15117 This option is available if Exim is built with the content-scanning extension.
15118 It specifies which anti-virus scanner to use. The default value is:
15119 .code
15120 sophie:/var/run/sophie
15121 .endd
15122 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15123 before use. See section &<<SECTscanvirus>>& for further details.
15124
15125
15126 .option bi_command main string unset
15127 .oindex "&%-bi%&"
15128 This option supplies the name of a command that is run when Exim is called with
15129 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15130 just the command name, it is not a complete command line. If an argument is
15131 required, it must come from the &%-oA%& command line option.
15132
15133
15134 .option bounce_message_file main string&!! unset
15135 .cindex "bounce message" "customizing"
15136 .cindex "customizing" "bounce message"
15137 This option defines a template file containing paragraphs of text to be used
15138 for constructing bounce messages.  Details of the file's contents are given in
15139 chapter &<<CHAPemsgcust>>&.
15140 .cindex bounce_message_file "tainted data"
15141 The option is expanded to give the file path, which must be
15142 absolute and untainted.
15143 See also &%warn_message_file%&.
15144
15145
15146 .option bounce_message_text main string unset
15147 When this option is set, its contents are included in the default bounce
15148 message immediately after &"This message was created automatically by mail
15149 delivery software."& It is not used if &%bounce_message_file%& is set.
15150
15151 .option bounce_return_body main boolean true
15152 .cindex "bounce message" "including body"
15153 This option controls whether the body of an incoming message is included in a
15154 bounce message when &%bounce_return_message%& is true. The default setting
15155 causes the entire message, both header and body, to be returned (subject to the
15156 value of &%bounce_return_size_limit%&). If this option is false, only the
15157 message header is included. In the case of a non-SMTP message containing an
15158 error that is detected during reception, only those header lines preceding the
15159 point at which the error was detected are returned.
15160 .cindex "bounce message" "including original"
15161
15162 .option bounce_return_linesize_limit main integer 998
15163 .cindex "size" "of bounce lines, limit"
15164 .cindex "bounce message" "line length limit"
15165 .cindex "limit" "bounce message line length"
15166 This option sets a limit in bytes on the line length of messages
15167 that are returned to senders due to delivery problems,
15168 when &%bounce_return_message%& is true.
15169 The default value corresponds to RFC limits.
15170 If the message being returned has lines longer than this value it is
15171 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15172
15173 The option also applies to bounces returned when an error is detected
15174 during reception of a message.
15175 In this case lines from the original are truncated.
15176
15177 The option does not apply to messages generated by an &(autoreply)& transport.
15178
15179
15180 .option bounce_return_message main boolean true
15181 If this option is set false, none of the original message is included in
15182 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15183 &%bounce_return_body%&.
15184
15185
15186 .option bounce_return_size_limit main integer 100K
15187 .cindex "size" "of bounce, limit"
15188 .cindex "bounce message" "size limit"
15189 .cindex "limit" "bounce message size"
15190 This option sets a limit in bytes on the size of messages that are returned to
15191 senders as part of bounce messages when &%bounce_return_message%& is true. The
15192 limit should be less than the value of the global &%message_size_limit%& and of
15193 any &%message_size_limit%& settings on transports, to allow for the bounce text
15194 that Exim generates. If this option is set to zero there is no limit.
15195
15196 When the body of any message that is to be included in a bounce message is
15197 greater than the limit, it is truncated, and a comment pointing this out is
15198 added at the top. The actual cutoff may be greater than the value given, owing
15199 to the use of buffering for transferring the message in chunks (typically 8K in
15200 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15201 messages.
15202
15203 .option bounce_sender_authentication main string unset
15204 .cindex "bounce message" "sender authentication"
15205 .cindex "authentication" "bounce message"
15206 .cindex "AUTH" "on bounce message"
15207 This option provides an authenticated sender address that is sent with any
15208 bounce messages generated by Exim that are sent over an authenticated SMTP
15209 connection. A typical setting might be:
15210 .code
15211 bounce_sender_authentication = mailer-daemon@my.domain.example
15212 .endd
15213 which would cause bounce messages to be sent using the SMTP command:
15214 .code
15215 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15216 .endd
15217 The value of &%bounce_sender_authentication%& must always be a complete email
15218 address.
15219
15220 .option callout_domain_negative_expire main time 3h
15221 .cindex "caching" "callout timeouts"
15222 .cindex "callout" "caching timeouts"
15223 This option specifies the expiry time for negative callout cache data for a
15224 domain. See section &<<SECTcallver>>& for details of callout verification, and
15225 section &<<SECTcallvercache>>& for details of the caching.
15226
15227
15228 .option callout_domain_positive_expire main time 7d
15229 This option specifies the expiry time for positive callout cache data for a
15230 domain. See section &<<SECTcallver>>& for details of callout verification, and
15231 section &<<SECTcallvercache>>& for details of the caching.
15232
15233
15234 .option callout_negative_expire main time 2h
15235 This option specifies the expiry time for negative callout cache data for an
15236 address. See section &<<SECTcallver>>& for details of callout verification, and
15237 section &<<SECTcallvercache>>& for details of the caching.
15238
15239
15240 .option callout_positive_expire main time 24h
15241 This option specifies the expiry time for positive callout cache data for an
15242 address. See section &<<SECTcallver>>& for details of callout verification, and
15243 section &<<SECTcallvercache>>& for details of the caching.
15244
15245
15246 .option callout_random_local_part main string&!! "see below"
15247 This option defines the &"random"& local part that can be used as part of
15248 callout verification. The default value is
15249 .code
15250 $primary_hostname-$tod_epoch-testing
15251 .endd
15252 See section &<<CALLaddparcall>>& for details of how this value is used.
15253
15254
15255 .option check_log_inodes main integer 100
15256 See &%check_spool_space%& below.
15257
15258
15259 .option check_log_space main integer 10M
15260 See &%check_spool_space%& below.
15261
15262 .oindex "&%check_rfc2047_length%&"
15263 .cindex "RFC 2047" "disabling length check"
15264 .option check_rfc2047_length main boolean true
15265 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15266 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15267 word; strings to be encoded that exceed this length are supposed to use
15268 multiple encoded words. By default, Exim does not recognize encoded words that
15269 exceed the maximum length. However, it seems that some software, in violation
15270 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15271 set false, Exim recognizes encoded words of any length.
15272
15273
15274 .option check_spool_inodes main integer 100
15275 See &%check_spool_space%& below.
15276
15277
15278 .option check_spool_space main integer 10M
15279 .cindex "checking disk space"
15280 .cindex "disk space, checking"
15281 .cindex "spool directory" "checking space"
15282 The four &%check_...%& options allow for checking of disk resources before a
15283 message is accepted.
15284
15285 .vindex "&$log_inodes$&"
15286 .vindex "&$log_space$&"
15287 .vindex "&$spool_inodes$&"
15288 .vindex "&$spool_space$&"
15289 When any of these options are nonzero, they apply to all incoming messages. If you
15290 want to apply different checks to different kinds of message, you can do so by
15291 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15292 &$spool_space$& in an ACL with appropriate additional conditions.
15293
15294
15295 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15296 either value is greater than zero, for example:
15297 .code
15298 check_spool_space = 100M
15299 check_spool_inodes = 100
15300 .endd
15301 The spool partition is the one that contains the directory defined by
15302 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15303 transit.
15304
15305 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15306 files are written if either is greater than zero. These should be set only if
15307 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15308
15309 If there is less space or fewer inodes than requested, Exim refuses to accept
15310 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15311 error response to the MAIL command. If ESMTP is in use and there was a
15312 SIZE parameter on the MAIL command, its value is added to the
15313 &%check_spool_space%& value, and the check is performed even if
15314 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15315
15316 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15317 number of kilobytes (though specified in bytes).
15318 If a non-multiple of 1024 is specified, it is rounded up.
15319
15320 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15321 failure a message is written to stderr and Exim exits with a non-zero code, as
15322 it obviously cannot send an error message of any kind.
15323
15324 There is a slight performance penalty for these checks.
15325 Versions of Exim preceding 4.88 had these disabled by default;
15326 high-rate installations confident they will never run out of resources
15327 may wish to deliberately disable them.
15328
15329 .option chunking_advertise_hosts main "host list&!!" *
15330 .cindex CHUNKING advertisement
15331 .cindex "RFC 3030" "CHUNKING"
15332 .cindex "ESMTP extensions" CHUNKING
15333 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15334 these hosts.
15335 Hosts may use the BDAT command as an alternate to DATA.
15336
15337 .option commandline_checks_require_admin main boolean &`false`&
15338 .cindex "restricting access to features"
15339 This option restricts various basic checking features to require an
15340 administrative user.
15341 This affects most of the &%-b*%& options, such as &%-be%&.
15342
15343 .option debug_store main boolean &`false`&
15344 .cindex debugging "memory corruption"
15345 .cindex memory debugging
15346 This option, when true, enables extra checking in Exim's internal memory
15347 management.  For use when a memory corruption issue is being investigated,
15348 it should normally be left as default.
15349
15350 .option daemon_smtp_ports main string &`smtp`&
15351 .cindex "port" "for daemon"
15352 .cindex "TCP/IP" "setting listening ports"
15353 This option specifies one or more default SMTP ports on which the Exim daemon
15354 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15355 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15356
15357 .option daemon_startup_retries main integer 9
15358 .cindex "daemon startup, retrying"
15359 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15360 the daemon at startup when it cannot immediately bind a listening socket
15361 (typically because the socket is already in use): &%daemon_startup_retries%&
15362 defines the number of retries after the first failure, and
15363 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15364
15365 .option daemon_startup_sleep main time 30s
15366 See &%daemon_startup_retries%&.
15367
15368 .option delay_warning main "time list" 24h
15369 .cindex "warning of delay"
15370 .cindex "delay warning, specifying"
15371 .cindex "queue" "delay warning"
15372 When a message is delayed, Exim sends a warning message to the sender at
15373 intervals specified by this option. The data is a colon-separated list of times
15374 after which to send warning messages. If the value of the option is an empty
15375 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15376 message has been in the queue for longer than the last time, the last interval
15377 between the times is used to compute subsequent warning times. For example,
15378 with
15379 .code
15380 delay_warning = 4h:8h:24h
15381 .endd
15382 the first message is sent after 4 hours, the second after 8 hours, and
15383 the third one after 24 hours. After that, messages are sent every 16 hours,
15384 because that is the interval between the last two times on the list. If you set
15385 just one time, it specifies the repeat interval. For example, with:
15386 .code
15387 delay_warning = 6h
15388 .endd
15389 messages are repeated every six hours. To stop warnings after a given time, set
15390 a very large time at the end of the list. For example:
15391 .code
15392 delay_warning = 2h:12h:99d
15393 .endd
15394 Note that the option is only evaluated at the time a delivery attempt fails,
15395 which depends on retry and queue-runner configuration.
15396 Typically retries will be configured more frequently than warning messages.
15397
15398 .option delay_warning_condition main string&!! "see below"
15399 .vindex "&$domain$&"
15400 The string is expanded at the time a warning message might be sent. If all the
15401 deferred addresses have the same domain, it is set in &$domain$& during the
15402 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15403 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15404 &"false"& (the comparison being done caselessly) then the warning message is
15405 not sent. The default is:
15406 .code
15407 delay_warning_condition = ${if or {\
15408   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15409   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15410   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15411   } {no}{yes}}
15412 .endd
15413 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15414 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15415 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15416 &"auto-replied"& in an &'Auto-Submitted:'& header.
15417
15418 .option deliver_drop_privilege main boolean false
15419 .cindex "unprivileged delivery"
15420 .cindex "delivery" "unprivileged"
15421 If this option is set true, Exim drops its root privilege at the start of a
15422 delivery process, and runs as the Exim user throughout. This severely restricts
15423 the kinds of local delivery that are possible, but is viable in certain types
15424 of configuration. There is a discussion about the use of root privilege in
15425 chapter &<<CHAPsecurity>>&.
15426
15427 .option deliver_queue_load_max main fixed-point unset
15428 .cindex "load average"
15429 .cindex "queue runner" "abandoning"
15430 When this option is set, a queue run is abandoned if the system load average
15431 becomes greater than the value of the option. The option has no effect on
15432 ancient operating systems on which Exim cannot determine the load average.
15433 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15434
15435
15436 .option delivery_date_remove main boolean true
15437 .cindex "&'Delivery-date:'& header line"
15438 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15439 message when it is delivered, in exactly the same way as &'Return-path:'& is
15440 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15441 should not be present in incoming messages, and this option causes them to be
15442 removed at the time the message is received, to avoid any problems that might
15443 occur when a delivered message is subsequently sent on to some other recipient.
15444
15445 .option disable_fsync main boolean false
15446 .cindex "&[fsync()]&, disabling"
15447 This option is available only if Exim was built with the compile-time option
15448 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15449 a runtime configuration generates an &"unknown option"& error. You should not
15450 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15451 really, really, really understand what you are doing. &'No pre-compiled
15452 distributions of Exim should ever make this option available.'&
15453
15454 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15455 updated files' data to be written to disc before continuing. Unexpected events
15456 such as crashes and power outages may cause data to be lost or scrambled.
15457 Here be Dragons. &*Beware.*&
15458
15459
15460 .option disable_ipv6 main boolean false
15461 .cindex "IPv6" "disabling"
15462 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15463 activities take place. AAAA records are never looked up, and any IPv6 addresses
15464 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15465 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15466 to handle IPv6 literal addresses.
15467
15468
15469 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15470 .cindex DKIM "selecting signature algorithms"
15471 This option gives a list of hash types which are acceptable in signatures,
15472 and an order of processing.
15473 Signatures with algorithms not in the list will be ignored.
15474
15475 Acceptable values include:
15476 .code
15477 sha1
15478 sha256
15479 sha512
15480 .endd
15481
15482 Note that the acceptance of sha1 violates RFC 8301.
15483
15484 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15485 This option gives a list of key types which are acceptable in signatures,
15486 and an order of processing.
15487 Signatures with algorithms not in the list will be ignored.
15488
15489
15490 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15491 This option gives a list of key sizes which are acceptable in signatures.
15492 The list is keyed by the algorithm type for the key; the values are in bits.
15493 Signatures with keys smaller than given by this option will fail verification.
15494
15495 The default enforces the RFC 8301 minimum key size for RSA signatures.
15496
15497 .option dkim_verify_minimal main boolean false
15498 If set to true, verification of signatures will terminate after the
15499 first success.
15500
15501 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15502 .cindex DKIM "controlling calls to the ACL"
15503 This option gives a list of DKIM domains for which the DKIM ACL is run.
15504 It is expanded after the message is received; by default it runs
15505 the ACL once for each signature in the message.
15506 See section &<<SECDKIMVFY>>&.
15507
15508
15509 .option dmarc_forensic_sender main string&!! unset
15510 .option dmarc_history_file main string unset
15511 .option dmarc_tld_file main string unset
15512 .cindex DMARC "main section options"
15513 These options control DMARC processing.
15514 See section &<<SECDMARC>>& for details.
15515
15516
15517 .option dns_again_means_nonexist main "domain list&!!" unset
15518 .cindex "DNS" "&""try again""& response; overriding"
15519 DNS lookups give a &"try again"& response for the DNS errors
15520 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15521 keep trying to deliver a message, or to give repeated temporary errors to
15522 incoming mail. Sometimes the effect is caused by a badly set up name server and
15523 may persist for a long time. If a domain which exhibits this problem matches
15524 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15525 This option should be used with care. You can make it apply to reverse lookups
15526 by a setting such as this:
15527 .code
15528 dns_again_means_nonexist = *.in-addr.arpa
15529 .endd
15530 This option applies to all DNS lookups that Exim does. It also applies when the
15531 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15532 since these are most likely to be caused by DNS lookup problems. The
15533 &(dnslookup)& router has some options of its own for controlling what happens
15534 when lookups for MX or SRV records give temporary errors. These more specific
15535 options are applied after this global option.
15536
15537 .option dns_check_names_pattern main string "see below"
15538 .cindex "DNS" "pre-check of name syntax"
15539 When this option is set to a non-empty string, it causes Exim to check domain
15540 names for characters that are not allowed in host names before handing them to
15541 the DNS resolver, because some resolvers give temporary errors for names that
15542 contain unusual characters. If a domain name contains any unwanted characters,
15543 a &"not found"& result is forced, and the resolver is not called. The check is
15544 done by matching the domain name against a regular expression, which is the
15545 value of this option. The default pattern is
15546 .code
15547 dns_check_names_pattern = \
15548   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15549 .endd
15550 which permits only letters, digits, slashes, and hyphens in components, but
15551 they must start and end with a letter or digit. Slashes are not, in fact,
15552 permitted in host names, but they are found in certain NS records (which can be
15553 accessed in Exim by using a &%dnsdb%& lookup). If you set
15554 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15555 empty string.
15556
15557 .option dns_csa_search_limit main integer 5
15558 This option controls the depth of parental searching for CSA SRV records in the
15559 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15560
15561 .option dns_csa_use_reverse main boolean true
15562 This option controls whether or not an IP address, given as a CSA domain, is
15563 reversed and looked up in the reverse DNS, as described in more detail in
15564 section &<<SECTverifyCSA>>&.
15565
15566 .option dns_cname_loops main integer 1
15567 .cindex DNS "CNAME following"
15568 This option controls the following of CNAME chains, needed if the resolver does
15569 not do it internally.
15570 As of 2018 most should, and the default can be left.
15571 If you have an ancient one, a value of 10 is likely needed.
15572
15573 The default value of one CNAME-follow is needed
15574 thanks to the observed return for an MX request,
15575 given no MX presence but a CNAME to an A, of the CNAME.
15576
15577
15578 .option dns_dnssec_ok main integer -1
15579 .cindex "DNS" "resolver options"
15580 .cindex "DNS" "DNSSEC"
15581 If this option is set to a non-negative number then Exim will initialise the
15582 DNS resolver library to either use or not use DNSSEC, overriding the system
15583 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15584
15585 If the resolver library does not support DNSSEC then this option has no effect.
15586
15587 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15588 will default to stripping out a successful validation status.
15589 This will break a previously working Exim installation.
15590 Provided that you do trust the resolver (ie, is on localhost) you can tell
15591 glibc to pass through any successful validation with a new option in
15592 &_/etc/resolv.conf_&:
15593 .code
15594 options trust-ad
15595 .endd
15596
15597
15598 .option dns_ipv4_lookup main "domain list&!!" unset
15599 .cindex "IPv6" "DNS lookup for AAAA records"
15600 .cindex "DNS" "IPv6 lookup for AAAA records"
15601 .cindex DNS "IPv6 disabling"
15602 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15603 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15604 (A records) when trying to find IP addresses for hosts, unless the host's
15605 domain matches this list.
15606
15607 This is a fudge to help with name servers that give big delays or otherwise do
15608 not work for the AAAA record type. In due course, when the world's name
15609 servers have all been upgraded, there should be no need for this option.
15610 Note that all lookups, including those done for verification, are affected;
15611 this will result in verify failure for IPv6 connections or ones using names
15612 only valid for IPv6 addresses.
15613
15614
15615 .option dns_retrans main time 0s
15616 .cindex "DNS" "resolver options"
15617 .cindex timeout "dns lookup"
15618 .cindex "DNS" timeout
15619 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15620 retransmission and retry parameters for DNS lookups. Values of zero (the
15621 defaults) leave the system default settings unchanged. The first value is the
15622 time between retries, and the second is the number of retries. It isn't
15623 totally clear exactly how these settings affect the total time a DNS lookup may
15624 take. I haven't found any documentation about timeouts on DNS lookups; these
15625 parameter values are available in the external resolver interface structure,
15626 but nowhere does it seem to describe how they are used or what you might want
15627 to set in them.
15628 See also the &%slow_lookup_log%& option.
15629
15630
15631 .option dns_retry main integer 0
15632 See &%dns_retrans%& above.
15633
15634
15635 .option dns_trust_aa main "domain list&!!" unset
15636 .cindex "DNS" "resolver options"
15637 .cindex "DNS" "DNSSEC"
15638 If this option is set then lookup results marked with the AA bit
15639 (Authoritative Answer) are trusted the same way as if they were
15640 DNSSEC-verified. The authority section's name of the answer must
15641 match with this expanded domain list.
15642
15643 Use this option only if you talk directly to a resolver that is
15644 authoritative for some zones and does not set the AD (Authentic Data)
15645 bit in the answer. Some DNS servers may have an configuration option to
15646 mark the answers from their own zones as verified (they set the AD bit).
15647 Others do not have this option. It is considered as poor practice using
15648 a resolver that is an authoritative server for some zones.
15649
15650 Use this option only if you really have to (e.g. if you want
15651 to use DANE for remote delivery to a server that is listed in the DNS
15652 zones that your resolver is authoritative for).
15653
15654 If the DNS answer packet has the AA bit set and contains resource record
15655 in the answer section, the name of the first NS record appearing in the
15656 authority section is compared against the list. If the answer packet is
15657 authoritative but the answer section is empty, the name of the first SOA
15658 record in the authoritative section is used instead.
15659
15660 .cindex "DNS" "resolver options"
15661 .option dns_use_edns0 main integer -1
15662 .cindex "DNS" "resolver options"
15663 .cindex "DNS" "EDNS0"
15664 .cindex "DNS" "OpenBSD
15665 If this option is set to a non-negative number then Exim will initialise the
15666 DNS resolver library to either use or not use EDNS0 extensions, overriding
15667 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15668 on.
15669
15670 If the resolver library does not support EDNS0 then this option has no effect.
15671
15672 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15673 means that DNSSEC will not work with Exim on that platform either, unless Exim
15674 is linked against an alternative DNS client library.
15675
15676
15677 .option drop_cr main boolean false
15678 This is an obsolete option that is now a no-op. It used to affect the way Exim
15679 handled CR and LF characters in incoming messages. What happens now is
15680 described in section &<<SECTlineendings>>&.
15681
15682 .option dsn_advertise_hosts main "host list&!!" unset
15683 .cindex "bounce messages" "success"
15684 .cindex "DSN" "success"
15685 .cindex "Delivery Status Notification" "success"
15686 .cindex "ESMTP extensions" DSN
15687 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15688 and accepted from, these hosts.
15689 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15690 and RET and ORCPT options on MAIL FROM commands.
15691 A NOTIFY=SUCCESS option requests success-DSN messages.
15692 A NOTIFY= option with no argument requests that no delay or failure DSNs
15693 are sent.
15694 &*Note*&: Supplying success-DSN messages has been criticised
15695 on privacy grounds; it can leak details of internal forwarding.
15696
15697 .option dsn_from main "string&!!" "see below"
15698 .cindex "&'From:'& header line" "in bounces"
15699 .cindex "bounce messages" "&'From:'& line, specifying"
15700 This option can be used to vary the contents of &'From:'& header lines in
15701 bounces and other automatically generated messages (&"Delivery Status
15702 Notifications"& &-- hence the name of the option). The default setting is:
15703 .code
15704 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15705 .endd
15706 The value is expanded every time it is needed. If the expansion fails, a
15707 panic is logged, and the default value is used.
15708
15709 .option envelope_to_remove main boolean true
15710 .cindex "&'Envelope-to:'& header line"
15711 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15712 message when it is delivered, in exactly the same way as &'Return-path:'& is
15713 handled. &'Envelope-to:'& records the original recipient address from the
15714 message's envelope that caused the delivery to happen. Such headers should not
15715 be present in incoming messages, and this option causes them to be removed at
15716 the time the message is received, to avoid any problems that might occur when a
15717 delivered message is subsequently sent on to some other recipient.
15718
15719
15720 .option errors_copy main "string list&!!" unset
15721 .cindex "bounce message" "copy to other address"
15722 .cindex "copy of bounce message"
15723 Setting this option causes Exim to send bcc copies of bounce messages that it
15724 generates to other addresses. &*Note*&: This does not apply to bounce messages
15725 coming from elsewhere. The value of the option is a colon-separated list of
15726 items. Each item consists of a pattern, terminated by white space, followed by
15727 a comma-separated list of email addresses. If a pattern contains spaces, it
15728 must be enclosed in double quotes.
15729
15730 Each pattern is processed in the same way as a single item in an address list
15731 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15732 the bounce message, the message is copied to the addresses on the list. The
15733 items are scanned in order, and once a matching one is found, no further items
15734 are examined. For example:
15735 .code
15736 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15737               rqps@mydomain   hostmaster@mydomain.example,\
15738                               postmaster@mydomain.example
15739 .endd
15740 .vindex "&$domain$&"
15741 .vindex "&$local_part$&"
15742 The address list is expanded before use. The expansion variables &$local_part$&
15743 and &$domain$& are set from the original recipient of the error message, and if
15744 there was any wildcard matching in the pattern, the expansion
15745 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15746 variables &$0$&, &$1$&, etc. are set in the normal way.
15747
15748
15749 .option errors_reply_to main string unset
15750 .cindex "bounce message" "&'Reply-to:'& in"
15751 By default, Exim's bounce and delivery warning messages contain the header line
15752 .display
15753 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15754 .endd
15755 .oindex &%quota_warn_message%&
15756 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15757 A warning message that is generated by the &%quota_warn_message%& option in an
15758 &(appendfile)& transport may contain its own &'From:'& header line that
15759 overrides the default.
15760
15761 Experience shows that people reply to bounce messages. If the
15762 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15763 and warning messages. For example:
15764 .code
15765 errors_reply_to = postmaster@my.domain.example
15766 .endd
15767 The value of the option is not expanded. It must specify a valid RFC 2822
15768 address. However, if a warning message that is generated by the
15769 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15770 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15771 not used.
15772
15773
15774 .option event_action main string&!! unset
15775 .cindex events
15776 This option declares a string to be expanded for Exim's events mechanism.
15777 For details see chapter &<<CHAPevents>>&.
15778
15779
15780 .option exim_group main string "compile-time configured"
15781 .cindex "gid (group id)" "Exim's own"
15782 .cindex "Exim group"
15783 This option changes the gid under which Exim runs when it gives up root
15784 privilege. The default value is compiled into the binary. The value of this
15785 option is used only when &%exim_user%& is also set. Unless it consists entirely
15786 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15787 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15788 security issues.
15789
15790
15791 .option exim_path main string "see below"
15792 .cindex "Exim binary, path name"
15793 This option specifies the path name of the Exim binary, which is used when Exim
15794 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15795 the directory configured at compile time by the BIN_DIRECTORY setting. It
15796 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15797 other place.
15798 &*Warning*&: Do not use a macro to define the value of this option, because
15799 you will break those Exim utilities that scan the configuration file to find
15800 where the binary is. (They then use the &%-bP%& option to extract option
15801 settings such as the value of &%spool_directory%&.)
15802
15803
15804 .option exim_user main string "compile-time configured"
15805 .cindex "uid (user id)" "Exim's own"
15806 .cindex "Exim user"
15807 This option changes the uid under which Exim runs when it gives up root
15808 privilege. The default value is compiled into the binary. Ownership of the run
15809 time configuration file and the use of the &%-C%& and &%-D%& command line
15810 options is checked against the values in the binary, not what is set here.
15811
15812 Unless it consists entirely of digits, the string is looked up using
15813 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15814 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15815 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15816
15817
15818 .option exim_version main string "current version"
15819 .cindex "Exim version"
15820 .cindex customizing "version number"
15821 .cindex "version number of Exim" override
15822 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15823 various places.  Use with care; this may fool stupid security scanners.
15824
15825
15826 .option extra_local_interfaces main "string list" unset
15827 This option defines network interfaces that are to be considered local when
15828 routing, but which are not used for listening by the daemon. See section
15829 &<<SECTreclocipadd>>& for details.
15830
15831
15832 . Allow this long option name to split; give it unsplit as a fifth argument
15833 . for the automatic .oindex that is generated by .option.
15834
15835 .option "extract_addresses_remove_arguments" main boolean true &&&
15836          extract_addresses_remove_arguments
15837 .oindex "&%-t%&"
15838 .cindex "command line" "addresses with &%-t%&"
15839 .cindex "Sendmail compatibility" "&%-t%& option"
15840 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15841 are present on the command line when the &%-t%& option is used to build an
15842 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15843 line addresses are removed from the recipients list. This is also how Smail
15844 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15845 command line addresses are added to those obtained from the header lines. When
15846 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15847 argument headers. If it is set false, Exim adds rather than removes argument
15848 addresses.
15849
15850
15851 .option finduser_retries main integer 0
15852 .cindex "NIS, retrying user lookups"
15853 On systems running NIS or other schemes in which user and group information is
15854 distributed from a remote system, there can be times when &[getpwnam()]& and
15855 related functions fail, even when given valid data, because things time out.
15856 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15857 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15858 many extra times to find a user or a group, waiting for one second between
15859 retries.
15860
15861 .cindex "&_/etc/passwd_&" "multiple reading of"
15862 You should not set this option greater than zero if your user information is in
15863 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15864 search the file multiple times for non-existent users, and also cause delay.
15865
15866
15867
15868 .option freeze_tell main "string list, comma separated" unset
15869 .cindex "freezing messages" "sending a message when freezing"
15870 On encountering certain errors, or when configured to do so in a system filter,
15871 ACL, or special router, Exim freezes a message. This means that no further
15872 delivery attempts take place until an administrator thaws the message, or the
15873 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15874 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15875 warning message whenever it freezes something, unless the message it is
15876 freezing is a locally-generated bounce message. (Without this exception there
15877 is the possibility of looping.) The warning message is sent to the addresses
15878 supplied as the comma-separated value of this option. If several of the
15879 message's addresses cause freezing, only a single message is sent. If the
15880 freezing was automatic, the reason(s) for freezing can be found in the message
15881 log. If you configure freezing in a filter or ACL, you must arrange for any
15882 logging that you require.
15883
15884
15885 .option gecos_name main string&!! unset
15886 .cindex "HP-UX"
15887 .cindex "&""gecos""& field, parsing"
15888 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15889 password file to hold other information in addition to users' real names. Exim
15890 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15891 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15892 of the field are used unchanged, except that, if an ampersand is encountered,
15893 it is replaced by the user's login name with the first character forced to
15894 upper case, since this is a convention that is observed on many systems.
15895
15896 When these options are set, &%gecos_pattern%& is treated as a regular
15897 expression that is to be applied to the field (again with && replaced by the
15898 login name), and if it matches, &%gecos_name%& is expanded and used as the
15899 user's name.
15900
15901 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15902 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15903 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15904 name terminates at the first comma, the following can be used:
15905 .code
15906 gecos_pattern = ([^,]*)
15907 gecos_name = $1
15908 .endd
15909
15910 .option gecos_pattern main string unset
15911 See &%gecos_name%& above.
15912
15913
15914 .option gnutls_compat_mode main boolean unset
15915 This option controls whether GnuTLS is used in compatibility mode in an Exim
15916 server. This reduces security slightly, but improves interworking with older
15917 implementations of TLS.
15918
15919
15920 .option gnutls_allow_auto_pkcs11 main boolean unset
15921 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15922 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15923
15924 See
15925 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15926 for documentation.
15927
15928
15929
15930 .option headers_charset main string "see below"
15931 This option sets a default character set for translating from encoded MIME
15932 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15933 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15934 ultimate default is ISO-8859-1. For more details see the description of header
15935 insertions in section &<<SECTexpansionitems>>&.
15936
15937
15938
15939 .option header_maxsize main integer "see below"
15940 .cindex "header section" "maximum size of"
15941 .cindex "limit" "size of message header section"
15942 This option controls the overall maximum size of a message's header
15943 section. The default is the value of HEADER_MAXSIZE in
15944 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15945 sections are rejected.
15946
15947
15948 .option header_line_maxsize main integer 0
15949 .cindex "header lines" "maximum size of"
15950 .cindex "limit" "size of one header line"
15951 This option limits the length of any individual header line in a message, after
15952 all the continuations have been joined together. Messages with individual
15953 header lines that are longer than the limit are rejected. The default value of
15954 zero means &"no limit"&.
15955
15956
15957
15958
15959 .option helo_accept_junk_hosts main "host list&!!" unset
15960 .cindex "HELO" "accepting junk data"
15961 .cindex "EHLO" "accepting junk data"
15962 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15963 mail, and gives an error response for invalid data. Unfortunately, there are
15964 some SMTP clients that send syntactic junk. They can be accommodated by setting
15965 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15966 if you want to do semantic checking.
15967 See also &%helo_allow_chars%& for a way of extending the permitted character
15968 set.
15969
15970
15971 .option helo_allow_chars main string unset
15972 .cindex "HELO" "underscores in"
15973 .cindex "EHLO" "underscores in"
15974 .cindex "underscore in EHLO/HELO"
15975 This option can be set to a string of rogue characters that are permitted in
15976 all EHLO and HELO names in addition to the standard letters, digits,
15977 hyphens, and dots. If you really must allow underscores, you can set
15978 .code
15979 helo_allow_chars = _
15980 .endd
15981 Note that the value is one string, not a list.
15982
15983
15984 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15985 .cindex "HELO" "forcing reverse lookup"
15986 .cindex "EHLO" "forcing reverse lookup"
15987 If the domain given by a client in a HELO or EHLO command matches this
15988 list, a reverse lookup is done in order to establish the host's true name. The
15989 default forces a lookup if the client host gives the server's name or any of
15990 its IP addresses (in brackets), something that broken clients have been seen to
15991 do.
15992
15993
15994 .option helo_try_verify_hosts main "host list&!!" unset
15995 .cindex "HELO verifying" "optional"
15996 .cindex "EHLO" "verifying, optional"
15997 By default, Exim just checks the syntax of HELO and EHLO commands (see
15998 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15999 to do more extensive checking of the data supplied by these commands. The ACL
16000 condition &`verify = helo`& is provided to make this possible.
16001 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16002 to force the check to occur. From release 4.53 onwards, this is no longer
16003 necessary. If the check has not been done before &`verify = helo`& is
16004 encountered, it is done at that time. Consequently, this option is obsolete.
16005 Its specification is retained here for backwards compatibility.
16006
16007 When an EHLO or HELO command is received, if the calling host matches
16008 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16009 EHLO command either:
16010
16011 .ilist
16012 is an IP literal matching the calling address of the host, or
16013 .next
16014 .cindex "DNS" "reverse lookup"
16015 .cindex "reverse DNS lookup"
16016 matches the host name that Exim obtains by doing a reverse lookup of the
16017 calling host address, or
16018 .next
16019 when looked up in DNS yields the calling host address.
16020 .endlist
16021
16022 However, the EHLO or HELO command is not rejected if any of the checks
16023 fail. Processing continues, but the result of the check is remembered, and can
16024 be detected later in an ACL by the &`verify = helo`& condition.
16025
16026 If DNS was used for successful verification, the variable
16027 .cindex "DNS" "DNSSEC"
16028 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16029
16030 .option helo_verify_hosts main "host list&!!" unset
16031 .cindex "HELO verifying" "mandatory"
16032 .cindex "EHLO" "verifying, mandatory"
16033 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16034 backwards compatibility. For hosts that match this option, Exim checks the host
16035 name given in the HELO or EHLO in the same way as for
16036 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16037 rejected with a 550 error, and entries are written to the main and reject logs.
16038 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16039 error.
16040
16041 .option hold_domains main "domain list&!!" unset
16042 .cindex "domain" "delaying delivery"
16043 .cindex "delivery" "delaying certain domains"
16044 This option allows mail for particular domains to be held in the queue
16045 manually. The option is overridden if a message delivery is forced with the
16046 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16047 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16048 item in &%hold_domains%&, no routing or delivery for that address is done, and
16049 it is deferred every time the message is looked at.
16050
16051 This option is intended as a temporary operational measure for delaying the
16052 delivery of mail while some problem is being sorted out, or some new
16053 configuration tested. If you just want to delay the processing of some
16054 domains until a queue run occurs, you should use &%queue_domains%& or
16055 &%queue_smtp_domains%&, not &%hold_domains%&.
16056
16057 A setting of &%hold_domains%& does not override Exim's code for removing
16058 messages from the queue if they have been there longer than the longest retry
16059 time in any retry rule. If you want to hold messages for longer than the normal
16060 retry times, insert a dummy retry rule with a long retry time.
16061
16062
16063 .option host_lookup main "host list&!!" unset
16064 .cindex "host name" "lookup, forcing"
16065 Exim does not look up the name of a calling host from its IP address unless it
16066 is required to compare against some host list, or the host matches
16067 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16068 option (which normally contains IP addresses rather than host names). The
16069 default configuration file contains
16070 .code
16071 host_lookup = *
16072 .endd
16073 which causes a lookup to happen for all hosts. If the expense of these lookups
16074 is felt to be too great, the setting can be changed or removed.
16075
16076 After a successful reverse lookup, Exim does a forward lookup on the name it
16077 has obtained, to verify that it yields the IP address that it started with. If
16078 this check fails, Exim behaves as if the name lookup failed.
16079
16080 .vindex "&$host_lookup_failed$&"
16081 .vindex "&$sender_host_name$&"
16082 After any kind of failure, the host name (in &$sender_host_name$&) remains
16083 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16084 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16085 &`verify = reverse_host_lookup`& in ACLs.
16086
16087
16088 .option host_lookup_order main "string list" &`bydns:byaddr`&
16089 This option specifies the order of different lookup methods when Exim is trying
16090 to find a host name from an IP address. The default is to do a DNS lookup
16091 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16092 if that fails. You can change the order of these lookups, or omit one entirely,
16093 if you want.
16094
16095 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16096 multiple PTR records in the DNS and the IP address is not listed in
16097 &_/etc/hosts_&. Different operating systems give different results in this
16098 case. That is why the default tries a DNS lookup first.
16099
16100
16101
16102 .option host_reject_connection main "host list&!!" unset
16103 .cindex "host" "rejecting connections from"
16104 If this option is set, incoming SMTP calls from the hosts listed are rejected
16105 as soon as the connection is made.
16106 This option is obsolete, and retained only for backward compatibility, because
16107 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16108 connections immediately.
16109
16110 The ability to give an immediate rejection (either by this option or using an
16111 ACL) is provided for use in unusual cases. Many hosts will just try again,
16112 sometimes without much delay. Normally, it is better to use an ACL to reject
16113 incoming messages at a later stage, such as after RCPT commands. See
16114 chapter &<<CHAPACL>>&.
16115
16116
16117 .option hosts_connection_nolog main "host list&!!" unset
16118 .cindex "host" "not logging connections from"
16119 This option defines a list of hosts for which connection logging does not
16120 happen, even though the &%smtp_connection%& log selector is set. For example,
16121 you might want not to log SMTP connections from local processes, or from
16122 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16123 the daemon; you should therefore strive to restrict its value to a short inline
16124 list of IP addresses and networks. To disable logging SMTP connections from
16125 local processes, you must create a host list with an empty item. For example:
16126 .code
16127 hosts_connection_nolog = :
16128 .endd
16129 If the &%smtp_connection%& log selector is not set, this option has no effect.
16130
16131
16132
16133 .option hosts_proxy main "host list&!!" unset
16134 .cindex proxy "proxy protocol"
16135 This option enables use of Proxy Protocol proxies for incoming
16136 connections.  For details see section &<<SECTproxyInbound>>&.
16137
16138
16139 .option hosts_treat_as_local main "domain list&!!" unset
16140 .cindex "local host" "domains treated as"
16141 .cindex "host" "treated as local"
16142 If this option is set, any host names that match the domain list are treated as
16143 if they were the local host when Exim is scanning host lists obtained from MX
16144 records
16145 or other sources. Note that the value of this option is a domain list, not a
16146 host list, because it is always used to check host names, not IP addresses.
16147
16148 This option also applies when Exim is matching the special items
16149 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16150 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16151 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16152 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16153 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16154 interfaces and recognizing the local host.
16155
16156
16157 .option ibase_servers main "string list" unset
16158 .cindex "InterBase" "server list"
16159 This option provides a list of InterBase servers and associated connection data,
16160 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16161 The option is available only if Exim has been built with InterBase support.
16162
16163
16164
16165 .option ignore_bounce_errors_after main time 10w
16166 .cindex "bounce message" "discarding"
16167 .cindex "discarding bounce message"
16168 This option affects the processing of bounce messages that cannot be delivered,
16169 that is, those that suffer a permanent delivery failure. (Bounce messages that
16170 suffer temporary delivery failures are of course retried in the usual way.)
16171
16172 After a permanent delivery failure, bounce messages are frozen,
16173 because there is no sender to whom they can be returned. When a frozen bounce
16174 message has been in the queue for more than the given time, it is unfrozen at
16175 the next queue run, and a further delivery is attempted. If delivery fails
16176 again, the bounce message is discarded. This makes it possible to keep failed
16177 bounce messages around for a shorter time than the normal maximum retry time
16178 for frozen messages. For example,
16179 .code
16180 ignore_bounce_errors_after = 12h
16181 .endd
16182 retries failed bounce message deliveries after 12 hours, discarding any further
16183 failures. If the value of this option is set to a zero time period, bounce
16184 failures are discarded immediately. Setting a very long time (as in the default
16185 value) has the effect of disabling this option. For ways of automatically
16186 dealing with other kinds of frozen message, see &%auto_thaw%& and
16187 &%timeout_frozen_after%&.
16188
16189
16190 .option ignore_fromline_hosts main "host list&!!" unset
16191 .cindex "&""From""& line"
16192 .cindex "UUCP" "&""From""& line"
16193 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16194 the headers of a message. By default this is treated as the start of the
16195 message's body, which means that any following headers are not recognized as
16196 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16197 match those hosts that insist on sending it. If the sender is actually a local
16198 process rather than a remote host, and is using &%-bs%& to inject the messages,
16199 &%ignore_fromline_local%& must be set to achieve this effect.
16200
16201
16202 .option ignore_fromline_local main boolean false
16203 See &%ignore_fromline_hosts%& above.
16204
16205 .option keep_environment main "string list" unset
16206 .cindex "environment" "values from"
16207 This option contains a string list of environment variables to keep.
16208 You have to trust these variables or you have to be sure that
16209 these variables do not impose any security risk. Keep in mind that
16210 during the startup phase Exim is running with an effective UID 0 in most
16211 installations. As the default value is an empty list, the default
16212 environment for using libraries, running embedded Perl code, or running
16213 external binaries is empty, and does not not even contain PATH or HOME.
16214
16215 Actually the list is interpreted as a list of patterns
16216 (&<<SECTlistexpand>>&), except that it is not expanded first.
16217
16218 WARNING: Macro substitution is still done first, so having a macro
16219 FOO and having FOO_HOME in your &%keep_environment%& option may have
16220 unexpected results. You may work around this using a regular expression
16221 that does not match the macro name: ^[F]OO_HOME$.
16222
16223 Current versions of Exim issue a warning during startup if you do not mention
16224 &%keep_environment%& in your runtime configuration file and if your
16225 current environment is not empty. Future versions may not issue that warning
16226 anymore.
16227
16228 See the &%add_environment%& main config option for a way to set
16229 environment variables to a fixed value.  The environment for &(pipe)&
16230 transports is handled separately, see section &<<SECTpipeenv>>& for
16231 details.
16232
16233
16234 .option keep_malformed main time 4d
16235 This option specifies the length of time to keep messages whose spool files
16236 have been corrupted in some way. This should, of course, never happen. At the
16237 next attempt to deliver such a message, it gets removed. The incident is
16238 logged.
16239
16240
16241 .option ldap_ca_cert_dir main string unset
16242 .cindex "LDAP", "TLS CA certificate directory"
16243 .cindex certificate "directory for LDAP"
16244 This option indicates which directory contains CA certificates for verifying
16245 a TLS certificate presented by an LDAP server.
16246 While Exim does not provide a default value, your SSL library may.
16247 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16248 and constrained to be a directory.
16249
16250
16251 .option ldap_ca_cert_file main string unset
16252 .cindex "LDAP", "TLS CA certificate file"
16253 .cindex certificate "file for LDAP"
16254 This option indicates which file contains CA certificates for verifying
16255 a TLS certificate presented by an LDAP server.
16256 While Exim does not provide a default value, your SSL library may.
16257 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16258 and constrained to be a file.
16259
16260
16261 .option ldap_cert_file main string unset
16262 .cindex "LDAP" "TLS client certificate file"
16263 .cindex certificate "file for LDAP"
16264 This option indicates which file contains an TLS client certificate which
16265 Exim should present to the LDAP server during TLS negotiation.
16266 Should be used together with &%ldap_cert_key%&.
16267
16268
16269 .option ldap_cert_key main string unset
16270 .cindex "LDAP" "TLS client key file"
16271 .cindex certificate "key for LDAP"
16272 This option indicates which file contains the secret/private key to use
16273 to prove identity to the LDAP server during TLS negotiation.
16274 Should be used together with &%ldap_cert_file%&, which contains the
16275 identity to be proven.
16276
16277
16278 .option ldap_cipher_suite main string unset
16279 .cindex "LDAP" "TLS cipher suite"
16280 This controls the TLS cipher-suite negotiation during TLS negotiation with
16281 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16282 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16283
16284
16285 .option ldap_default_servers main "string list" unset
16286 .cindex "LDAP" "default servers"
16287 This option provides a list of LDAP servers which are tried in turn when an
16288 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16289 details of LDAP queries. This option is available only when Exim has been built
16290 with LDAP support.
16291
16292
16293 .option ldap_require_cert main string unset.
16294 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16295 This should be one of the values "hard", "demand", "allow", "try" or "never".
16296 A value other than one of these is interpreted as "never".
16297 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16298 Although Exim does not set a default, the LDAP library probably defaults
16299 to hard/demand.
16300
16301
16302 .option ldap_start_tls main boolean false
16303 .cindex "LDAP" "whether or not to negotiate TLS"
16304 If set, Exim will attempt to negotiate TLS with the LDAP server when
16305 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16306 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16307 of SSL-on-connect.
16308 In the event of failure to negotiate TLS, the action taken is controlled
16309 by &%ldap_require_cert%&.
16310 This option is ignored for &`ldapi`& connections.
16311
16312
16313 .option ldap_version main integer unset
16314 .cindex "LDAP" "protocol version, forcing"
16315 This option can be used to force Exim to set a specific protocol version for
16316 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16317 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16318 the LDAP headers; otherwise it is 2. This option is available only when Exim
16319 has been built with LDAP support.
16320
16321
16322
16323 .option local_from_check main boolean true
16324 .cindex "&'Sender:'& header line" "disabling addition of"
16325 .cindex "&'From:'& header line" "disabling checking of"
16326 When a message is submitted locally (that is, not over a TCP/IP connection) by
16327 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16328 checks that the &'From:'& header line matches the login of the calling user and
16329 the domain specified by &%qualify_domain%&.
16330
16331 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16332 locally submitted message is automatically qualified by Exim, unless the
16333 &%-bnq%& command line option is used.
16334
16335 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16336 on the local part. If the &'From:'& header line does not match, Exim adds a
16337 &'Sender:'& header with an address constructed from the calling user's login
16338 and the default qualify domain.
16339
16340 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16341 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16342 &'Sender:'& header lines supplied by untrusted users, you must also set
16343 &%local_sender_retain%& to be true.
16344
16345 .cindex "envelope from"
16346 .cindex "envelope sender"
16347 These options affect only the header lines in the message. The envelope sender
16348 is still forced to be the login id at the qualify domain unless
16349 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16350
16351 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16352 request similar header line checking. See section &<<SECTthesenhea>>&, which
16353 has more details about &'Sender:'& processing.
16354
16355
16356
16357
16358 .option local_from_prefix main string unset
16359 When Exim checks the &'From:'& header line of locally submitted messages for
16360 matching the login id (see &%local_from_check%& above), it can be configured to
16361 ignore certain prefixes and suffixes in the local part of the address. This is
16362 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16363 appropriate lists, in the same form as the &%local_part_prefix%& and
16364 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16365 example, if
16366 .code
16367 local_from_prefix = *-
16368 .endd
16369 is set, a &'From:'& line containing
16370 .code
16371 From: anything-user@your.domain.example
16372 .endd
16373 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16374 matches the actual sender address that is constructed from the login name and
16375 qualify domain.
16376
16377
16378 .option local_from_suffix main string unset
16379 See &%local_from_prefix%& above.
16380
16381
16382 .option local_interfaces main "string list" "see below"
16383 This option controls which network interfaces are used by the daemon for
16384 listening; they are also used to identify the local host when routing. Chapter
16385 &<<CHAPinterfaces>>& contains a full description of this option and the related
16386 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16387 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16388 &%local_interfaces%& is
16389 .code
16390 local_interfaces = 0.0.0.0
16391 .endd
16392 when Exim is built without IPv6 support; otherwise it is
16393 .code
16394 local_interfaces = <; ::0 ; 0.0.0.0
16395 .endd
16396
16397 .option local_scan_timeout main time 5m
16398 .cindex "timeout" "for &[local_scan()]& function"
16399 .cindex "&[local_scan()]& function" "timeout"
16400 This timeout applies to the &[local_scan()]& function (see chapter
16401 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16402 the incoming message is rejected with a temporary error if it is an SMTP
16403 message. For a non-SMTP message, the message is dropped and Exim ends with a
16404 non-zero code. The incident is logged on the main and reject logs.
16405
16406
16407
16408 .option local_sender_retain main boolean false
16409 .cindex "&'Sender:'& header line" "retaining from local submission"
16410 When a message is submitted locally (that is, not over a TCP/IP connection) by
16411 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16412 do not want this to happen, you must set &%local_sender_retain%&, and you must
16413 also set &%local_from_check%& to be false (Exim will complain if you do not).
16414 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16415 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16416
16417
16418
16419
16420 .option localhost_number main string&!! unset
16421 .cindex "host" "locally unique number for"
16422 .cindex "message ids" "with multiple hosts"
16423 .vindex "&$localhost_number$&"
16424 Exim's message ids are normally unique only within the local host. If
16425 uniqueness among a set of hosts is required, each host must set a different
16426 value for the &%localhost_number%& option. The string is expanded immediately
16427 after reading the configuration file (so that a number can be computed from the
16428 host name, for example) and the result of the expansion must be a number in the
16429 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16430 systems). This is available in subsequent string expansions via the variable
16431 &$localhost_number$&. When &%localhost_number is set%&, the final two
16432 characters of the message id, instead of just being a fractional part of the
16433 time, are computed from the time and the local host number as described in
16434 section &<<SECTmessiden>>&.
16435
16436
16437
16438 .option log_file_path main "string list&!!" "set at compile time"
16439 .cindex "log" "file path for"
16440 This option sets the path which is used to determine the names of Exim's log
16441 files, or indicates that logging is to be to syslog, or both. It is expanded
16442 when Exim is entered, so it can, for example, contain a reference to the host
16443 name. If no specific path is set for the log files at compile or runtime,
16444 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16445 they are written in a sub-directory called &_log_& in Exim's spool directory.
16446 A path must start with a slash.
16447 To send to syslog, use the word &"syslog"&.
16448 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16449 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16450 used. If this string is fixed at your installation (contains no expansion
16451 variables) it is recommended that you do not set this option in the
16452 configuration file, but instead supply the path using LOG_FILE_PATH in
16453 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16454 early on &-- in particular, failure to read the configuration file.
16455
16456
16457 .option log_selector main string unset
16458 .cindex "log" "selectors"
16459 This option can be used to reduce or increase the number of things that Exim
16460 writes to its log files. Its argument is made up of names preceded by plus or
16461 minus characters. For example:
16462 .code
16463 log_selector = +arguments -retry_defer
16464 .endd
16465 A list of possible names and what they control is given in the chapter on
16466 logging, in section &<<SECTlogselector>>&.
16467
16468
16469 .option log_timezone main boolean false
16470 .cindex "log" "timezone for entries"
16471 .vindex "&$tod_log$&"
16472 .vindex "&$tod_zone$&"
16473 By default, the timestamps on log lines are in local time without the
16474 timezone. This means that if your timezone changes twice a year, the timestamps
16475 in log lines are ambiguous for an hour when the clocks go back. One way of
16476 avoiding this problem is to set the timezone to UTC. An alternative is to set
16477 &%log_timezone%& true. This turns on the addition of the timezone offset to
16478 timestamps in log lines. Turning on this option can add quite a lot to the size
16479 of log files because each line is extended by 6 characters. Note that the
16480 &$tod_log$& variable contains the log timestamp without the zone, but there is
16481 another variable called &$tod_zone$& that contains just the timezone offset.
16482
16483
16484 .option lookup_open_max main integer 25
16485 .cindex "too many open files"
16486 .cindex "open files, too many"
16487 .cindex "file" "too many open"
16488 .cindex "lookup" "maximum open files"
16489 .cindex "limit" "open files for lookups"
16490 This option limits the number of simultaneously open files for single-key
16491 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16492 Exim normally keeps these files open during routing, because often the same
16493 file is required several times. If the limit is reached, Exim closes the least
16494 recently used file. Note that if you are using the &'ndbm'& library, it
16495 actually opens two files for each logical DBM database, though it still counts
16496 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16497 open files"& errors with NDBM, you need to reduce the value of
16498 &%lookup_open_max%&.
16499
16500
16501 .option max_username_length main integer 0
16502 .cindex "length of login name"
16503 .cindex "user name" "maximum length"
16504 .cindex "limit" "user name length"
16505 Some operating systems are broken in that they truncate long arguments to
16506 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16507 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16508 an argument that is longer behaves as if &[getpwnam()]& failed.
16509
16510
16511 .option message_body_newlines main bool false
16512 .cindex "message body" "newlines in variables"
16513 .cindex "newline" "in message body variables"
16514 .vindex "&$message_body$&"
16515 .vindex "&$message_body_end$&"
16516 By default, newlines in the message body are replaced by spaces when setting
16517 the &$message_body$& and &$message_body_end$& expansion variables. If this
16518 option is set true, this no longer happens.
16519
16520
16521 .option message_body_visible main integer 500
16522 .cindex "body of message" "visible size"
16523 .cindex "message body" "visible size"
16524 .vindex "&$message_body$&"
16525 .vindex "&$message_body_end$&"
16526 This option specifies how much of a message's body is to be included in the
16527 &$message_body$& and &$message_body_end$& expansion variables.
16528
16529
16530 .option message_id_header_domain main string&!! unset
16531 .cindex "&'Message-ID:'& header line"
16532 If this option is set, the string is expanded and used as the right hand side
16533 (domain) of the &'Message-ID:'& header that Exim creates if a
16534 locally-originated incoming message does not have one. &"Locally-originated"&
16535 means &"not received over TCP/IP."&
16536 Otherwise, the primary host name is used.
16537 Only letters, digits, dot and hyphen are accepted; any other characters are
16538 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16539 empty string, the option is ignored.
16540
16541
16542 .option message_id_header_text main string&!! unset
16543 If this variable is set, the string is expanded and used to augment the text of
16544 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16545 message does not have one. The text of this header is required by RFC 2822 to
16546 take the form of an address. By default, Exim uses its internal message id as
16547 the local part, and the primary host name as the domain. If this option is set,
16548 it is expanded, and provided the expansion is not forced to fail, and does not
16549 yield an empty string, the result is inserted into the header immediately
16550 before the @, separated from the internal message id by a dot. Any characters
16551 that are illegal in an address are automatically converted into hyphens. This
16552 means that variables such as &$tod_log$& can be used, because the spaces and
16553 colons will become hyphens.
16554
16555
16556 .option message_logs main boolean true
16557 .cindex "message logs" "disabling"
16558 .cindex "log" "message log; disabling"
16559 If this option is turned off, per-message log files are not created in the
16560 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16561 Exim, by reducing the number of files involved in handling a message from a
16562 minimum of four (header spool file, body spool file, delivery journal, and
16563 per-message log) to three. The other major I/O activity is Exim's main log,
16564 which is not affected by this option.
16565
16566
16567 .option message_size_limit main string&!! 50M
16568 .cindex "message" "size limit"
16569 .cindex "limit" "message size"
16570 .cindex "size" "of message, limit"
16571 This option limits the maximum size of message that Exim will process. The
16572 value is expanded for each incoming connection so, for example, it can be made
16573 to depend on the IP address of the remote host for messages arriving via
16574 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16575 optionally followed by K or M.
16576
16577 .cindex "SIZE" "ESMTP extension, advertising"
16578 .cindex "ESMTP extensions" SIZE
16579 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16580 service extension keyword.
16581
16582 &*Note*&: This limit cannot be made to depend on a message's sender or any
16583 other properties of an individual message, because it has to be advertised in
16584 the server's response to EHLO. String expansion failure causes a temporary
16585 error. A value of zero means no limit, but its use is not recommended. See also
16586 &%bounce_return_size_limit%&.
16587
16588 Incoming SMTP messages are failed with a 552 error if the limit is
16589 exceeded; locally-generated messages either get a stderr message or a delivery
16590 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16591 an oversized message is logged in both the main and the reject logs. See also
16592 the generic transport option &%message_size_limit%&, which limits the size of
16593 message that an individual transport can process.
16594
16595 If you use a virus-scanner and set this option to to a value larger than the
16596 maximum size that your virus-scanner is configured to support, you may get
16597 failures triggered by large mails.  The right size to configure for the
16598 virus-scanner depends upon what data is passed and the options in use but it's
16599 probably safest to just set it to a little larger than this value.  E.g., with a
16600 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16601 some problems may result.
16602
16603 A value of 0 will disable size limit checking; Exim will still advertise the
16604 SIZE extension in an EHLO response, but without a limit, so as to permit
16605 SMTP clients to still indicate the message size along with the MAIL verb.
16606
16607
16608 .option move_frozen_messages main boolean false
16609 .cindex "frozen messages" "moving"
16610 This option, which is available only if Exim has been built with the setting
16611 .code
16612 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16613 .endd
16614 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16615 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16616 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16617 standard utilities for handling such moved messages, and they do not show up in
16618 lists generated by &%-bp%& or by the Exim monitor.
16619
16620
16621 .option mua_wrapper main boolean false
16622 Setting this option true causes Exim to run in a very restrictive mode in which
16623 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16624 contains a full description of this facility.
16625
16626
16627
16628 .option mysql_servers main "string list" unset
16629 .cindex "MySQL" "server list"
16630 This option provides a list of MySQL servers and associated connection data, to
16631 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16632 option is available only if Exim has been built with MySQL support.
16633
16634
16635 .option never_users main "string list&!!" unset
16636 This option is expanded just once, at the start of Exim's processing. Local
16637 message deliveries are normally run in processes that are setuid to the
16638 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16639 It is usually desirable to prevent any deliveries from running as root, as a
16640 safety precaution.
16641
16642 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16643 list of users that must not be used for local deliveries. This list is fixed in
16644 the binary and cannot be overridden by the configuration file. By default, it
16645 contains just the single user name &"root"&. The &%never_users%& runtime option
16646 can be used to add more users to the fixed list.
16647
16648 If a message is to be delivered as one of the users on the fixed list or the
16649 &%never_users%& list, an error occurs, and delivery is deferred. A common
16650 example is
16651 .code
16652 never_users = root:daemon:bin
16653 .endd
16654 Including root is redundant if it is also on the fixed list, but it does no
16655 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16656 transport driver.
16657
16658
16659 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16660 This option gives the name for a unix-domain socket on which the daemon
16661 listens for work and information-requests.
16662 Only installations running multiple daemons sharing a spool directory
16663 should need to modify the default.
16664
16665 The option is expanded before use.
16666 If the platform supports Linux-style abstract socket names, the result
16667 is used with a nul byte prefixed.
16668 Otherwise, it should be a full path name and use a directory accessible
16669 to Exim.
16670
16671 If the Exim command line uses a &%-oX%& option and does not use &%-oP%&
16672 then a notifier socket is not created.
16673
16674
16675 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16676 .cindex "OpenSSL "compatibility options"
16677 This option allows an administrator to adjust the SSL options applied
16678 by OpenSSL to connections.  It is given as a space-separated list of items,
16679 each one to be +added or -subtracted from the current value.
16680
16681 This option is only available if Exim is built against OpenSSL.  The values
16682 available for this option vary according to the age of your OpenSSL install.
16683 The &"all"& value controls a subset of flags which are available, typically
16684 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16685 list the values known on your system and Exim should support all the
16686 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16687 names lose the leading &"SSL_OP_"& and are lower-cased.
16688
16689 Note that adjusting the options can have severe impact upon the security of
16690 SSL as used by Exim.  It is possible to disable safety checks and shoot
16691 yourself in the foot in various unpleasant ways.  This option should not be
16692 adjusted lightly.  An unrecognised item will be detected at startup, by
16693 invoking Exim with the &%-bV%& flag.
16694
16695 The option affects Exim operating both as a server and as a client.
16696
16697 Historical note: prior to release 4.80, Exim defaulted this value to
16698 "+dont_insert_empty_fragments", which may still be needed for compatibility
16699 with some clients, but which lowers security by increasing exposure to
16700 some now infamous attacks.
16701
16702 Examples:
16703 .code
16704 # Make both old MS and old Eudora happy:
16705 openssl_options = -all +microsoft_big_sslv3_buffer \
16706                        +dont_insert_empty_fragments
16707
16708 # Disable older protocol versions:
16709 openssl_options = +no_sslv2 +no_sslv3
16710 .endd
16711
16712 Possible options may include:
16713 .ilist
16714 &`all`&
16715 .next
16716 &`allow_unsafe_legacy_renegotiation`&
16717 .next
16718 &`cipher_server_preference`&
16719 .next
16720 &`dont_insert_empty_fragments`&
16721 .next
16722 &`ephemeral_rsa`&
16723 .next
16724 &`legacy_server_connect`&
16725 .next
16726 &`microsoft_big_sslv3_buffer`&
16727 .next
16728 &`microsoft_sess_id_bug`&
16729 .next
16730 &`msie_sslv2_rsa_padding`&
16731 .next
16732 &`netscape_challenge_bug`&
16733 .next
16734 &`netscape_reuse_cipher_change_bug`&
16735 .next
16736 &`no_compression`&
16737 .next
16738 &`no_session_resumption_on_renegotiation`&
16739 .next
16740 &`no_sslv2`&
16741 .next
16742 &`no_sslv3`&
16743 .next
16744 &`no_ticket`&
16745 .next
16746 &`no_tlsv1`&
16747 .next
16748 &`no_tlsv1_1`&
16749 .next
16750 &`no_tlsv1_2`&
16751 .next
16752 &`safari_ecdhe_ecdsa_bug`&
16753 .next
16754 &`single_dh_use`&
16755 .next
16756 &`single_ecdh_use`&
16757 .next
16758 &`ssleay_080_client_dh_bug`&
16759 .next
16760 &`sslref2_reuse_cert_type_bug`&
16761 .next
16762 &`tls_block_padding_bug`&
16763 .next
16764 &`tls_d5_bug`&
16765 .next
16766 &`tls_rollback_bug`&
16767 .endlist
16768
16769 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16770 all clients connecting using the MacOS SecureTransport TLS facility prior
16771 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16772 to negotiate TLS then this option value might help, provided that your OpenSSL
16773 release is new enough to contain this work-around.  This may be a situation
16774 where you have to upgrade OpenSSL to get buggy clients working.
16775
16776
16777 .option oracle_servers main "string list" unset
16778 .cindex "Oracle" "server list"
16779 This option provides a list of Oracle servers and associated connection data,
16780 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16781 The option is available only if Exim has been built with Oracle support.
16782
16783
16784 .option percent_hack_domains main "domain list&!!" unset
16785 .cindex "&""percent hack""&"
16786 .cindex "source routing" "in email address"
16787 .cindex "address" "source-routed"
16788 The &"percent hack"& is the convention whereby a local part containing a
16789 percent sign is re-interpreted as a new email address, with the percent
16790 replaced by @. This is sometimes called &"source routing"&, though that term is
16791 also applied to RFC 2822 addresses that begin with an @ character. If this
16792 option is set, Exim implements the percent facility for those domains listed,
16793 but no others. This happens before an incoming SMTP address is tested against
16794 an ACL.
16795
16796 &*Warning*&: The &"percent hack"& has often been abused by people who are
16797 trying to get round relaying restrictions. For this reason, it is best avoided
16798 if at all possible. Unfortunately, a number of less security-conscious MTAs
16799 implement it unconditionally. If you are running Exim on a gateway host, and
16800 routing mail through to internal MTAs without processing the local parts, it is
16801 a good idea to reject recipient addresses with percent characters in their
16802 local parts. Exim's default configuration does this.
16803
16804
16805 .option perl_at_start main boolean false
16806 .cindex "Perl"
16807 This option is available only when Exim is built with an embedded Perl
16808 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16809
16810
16811 .option perl_startup main string unset
16812 .cindex "Perl"
16813 This option is available only when Exim is built with an embedded Perl
16814 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16815
16816 .option perl_taintmode main boolean false
16817 .cindex "Perl"
16818 This option enables the taint mode of the embedded Perl interpreter.
16819
16820
16821 .option pgsql_servers main "string list" unset
16822 .cindex "PostgreSQL lookup type" "server list"
16823 This option provides a list of PostgreSQL servers and associated connection
16824 data, to be used in conjunction with &(pgsql)& lookups (see section
16825 &<<SECID72>>&). The option is available only if Exim has been built with
16826 PostgreSQL support.
16827
16828
16829 .option pid_file_path main string&!! "set at compile time"
16830 .cindex "daemon" "pid file path"
16831 .cindex "pid file, path for"
16832 This option sets the name of the file to which the Exim daemon writes its
16833 process id. The string is expanded, so it can contain, for example, references
16834 to the host name:
16835 .code
16836 pid_file_path = /var/log/$primary_hostname/exim.pid
16837 .endd
16838 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16839 spool directory.
16840 The value set by the option can be overridden by the &%-oP%& command line
16841 option. A pid file is not written if a &"non-standard"& daemon is run by means
16842 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16843
16844
16845 .option pipelining_advertise_hosts main "host list&!!" *
16846 .cindex "PIPELINING" "suppressing advertising"
16847 .cindex "ESMTP extensions" PIPELINING
16848 This option can be used to suppress the advertisement of the SMTP
16849 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16850 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16851 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16852 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16853 that clients will use it; &"out of order"& commands that are &"expected"& do
16854 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16855
16856 .option pipelining_connect_advertise_hosts main "host list&!!" *
16857 .cindex "pipelining" "early connection"
16858 .cindex "pipelining" PIPE_CONNECT
16859 .cindex "ESMTP extensions" X_PIPE_CONNECT
16860 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16861 this option controls which hosts the facility is advertised to
16862 and from which pipeline early-connection (before MAIL) SMTP
16863 commands are acceptable.
16864 When used, the pipelining saves on roundtrip times.
16865
16866 See also the &%hosts_pipe_connect%& smtp transport option.
16867
16868 Currently the option name &"X_PIPE_CONNECT"& is used.
16869
16870
16871 .option prdr_enable main boolean false
16872 .cindex "PRDR" "enabling on server"
16873 .cindex "ESMTP extensions" PRDR
16874 This option can be used to enable the Per-Recipient Data Response extension
16875 to SMTP, defined by Eric Hall.
16876 If the option is set, PRDR is advertised by Exim when operating as a server.
16877 If the client requests PRDR, and more than one recipient, for a message
16878 an additional ACL is called for each recipient after the message content
16879 is received.  See section &<<SECTPRDRACL>>&.
16880
16881 .option preserve_message_logs main boolean false
16882 .cindex "message logs" "preserving"
16883 If this option is set, message log files are not deleted when messages are
16884 completed. Instead, they are moved to a sub-directory of the spool directory
16885 called &_msglog.OLD_&, where they remain available for statistical or debugging
16886 purposes. This is a dangerous option to set on systems with any appreciable
16887 volume of mail. Use with care!
16888
16889
16890 .option primary_hostname main string "see below"
16891 .cindex "name" "of local host"
16892 .cindex "host" "name of local"
16893 .cindex "local host" "name of"
16894 .vindex "&$primary_hostname$&"
16895 This specifies the name of the current host. It is used in the default EHLO or
16896 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16897 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16898 The value is also used by default in some SMTP response messages from an Exim
16899 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16900
16901 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16902 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16903 contains only one component, Exim passes it to &[gethostbyname()]& (or
16904 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16905 version. The variable &$primary_hostname$& contains the host name, whether set
16906 explicitly by this option, or defaulted.
16907
16908
16909 .option print_topbitchars main boolean false
16910 .cindex "printing characters"
16911 .cindex "8-bit characters"
16912 By default, Exim considers only those characters whose codes lie in the range
16913 32&--126 to be printing characters. In a number of circumstances (for example,
16914 when writing log entries) non-printing characters are converted into escape
16915 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16916 is set, code values of 128 and above are also considered to be printing
16917 characters.
16918
16919 This option also affects the header syntax checks performed by the
16920 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16921 the user's full name when constructing From: and Sender: addresses (as
16922 described in section &<<SECTconstr>>&). Setting this option can cause
16923 Exim to generate eight bit message headers that do not conform to the
16924 standards.
16925
16926
16927 .option process_log_path main string unset
16928 .cindex "process log path"
16929 .cindex "log" "process log"
16930 .cindex "&'exiwhat'&"
16931 This option sets the name of the file to which an Exim process writes its
16932 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16933 utility script. If this option is unset, the file called &_exim-process.info_&
16934 in Exim's spool directory is used. The ability to specify the name explicitly
16935 can be useful in environments where two different Exims are running, using
16936 different spool directories.
16937
16938
16939 .option prod_requires_admin main boolean true
16940 .cindex "restricting access to features"
16941 .oindex "&%-M%&"
16942 .oindex "&%-R%&"
16943 .oindex "&%-q%&"
16944 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16945 admin user unless &%prod_requires_admin%& is set false. See also
16946 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16947
16948
16949 .option qualify_domain main string "see below"
16950 .cindex "domain" "for qualifying addresses"
16951 .cindex "address" "qualification"
16952 This option specifies the domain name that is added to any envelope sender
16953 addresses that do not have a domain qualification. It also applies to
16954 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16955 are accepted by default only for locally-generated messages. Qualification is
16956 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16957 locally-generated messages, unless the &%-bnq%& command line option is used.
16958
16959 Messages from external sources must always contain fully qualified addresses,
16960 unless the sending host matches &%sender_unqualified_hosts%& or
16961 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16962 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16963 necessary. Internally, Exim always works with fully qualified envelope
16964 addresses. If &%qualify_domain%& is not set, it defaults to the
16965 &%primary_hostname%& value.
16966
16967
16968 .option qualify_recipient main string "see below"
16969 This option allows you to specify a different domain for qualifying recipient
16970 addresses to the one that is used for senders. See &%qualify_domain%& above.
16971
16972
16973
16974 .option queue_domains main "domain list&!!" unset
16975 .cindex "domain" "specifying non-immediate delivery"
16976 .cindex "queueing incoming messages"
16977 .cindex "message" "queueing certain domains"
16978 This option lists domains for which immediate delivery is not required.
16979 A delivery process is started whenever a message is received, but only those
16980 domains that do not match are processed. All other deliveries wait until the
16981 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16982
16983
16984 .new
16985 .option queue_fast_ramp main boolean false
16986 .cindex "queue runner" "two phase"
16987 .cindex "queue" "double scanning"
16988 If set to true, two-phase queue runs, initiated using &%-qq%& on the
16989 command line, may start parallel delivery processes during their first
16990 phase.  This will be done when a threshold number of messages have been
16991 routed for a single host.
16992 .wen
16993
16994
16995 .option queue_list_requires_admin main boolean true
16996 .cindex "restricting access to features"
16997 .oindex "&%-bp%&"
16998 The &%-bp%& command-line option, which lists the messages that are on the
16999 queue, requires the caller to be an admin user unless
17000 &%queue_list_requires_admin%& is set false.
17001 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17002
17003
17004 .option queue_only main boolean false
17005 .cindex "queueing incoming messages"
17006 .cindex "message" "queueing unconditionally"
17007 If &%queue_only%& is set, a delivery process is not automatically started
17008 whenever a message is received. Instead, the message waits in the queue for the
17009 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17010 delivered immediately when certain conditions (such as heavy load) occur.
17011
17012 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17013 and &%-odi%& command line options override &%queue_only%& unless
17014 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17015 &%queue_only_load%&, and &%smtp_accept_queue%&.
17016
17017
17018 .option queue_only_file main string unset
17019 .cindex "queueing incoming messages"
17020 .cindex "message" "queueing by file existence"
17021 This option can be set to a colon-separated list of absolute path names, each
17022 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17023 it tests for the existence of each listed path using a call to &[stat()]&. For
17024 each path that exists, the corresponding queueing option is set.
17025 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17026 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17027 .code
17028 queue_only_file = smtp/some/file
17029 .endd
17030 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17031 &_/some/file_& exists.
17032
17033
17034 .option queue_only_load main fixed-point unset
17035 .cindex "load average"
17036 .cindex "queueing incoming messages"
17037 .cindex "message" "queueing by load"
17038 If the system load average is higher than this value, incoming messages from
17039 all sources are queued, and no automatic deliveries are started. If this
17040 happens during local or remote SMTP input, all subsequent messages received on
17041 the same SMTP connection are queued by default, whatever happens to the load in
17042 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17043 false.
17044
17045 Deliveries will subsequently be performed by queue runner processes. This
17046 option has no effect on ancient operating systems on which Exim cannot
17047 determine the load average. See also &%deliver_queue_load_max%& and
17048 &%smtp_load_reserve%&.
17049
17050
17051 .option queue_only_load_latch main boolean true
17052 .cindex "load average" "re-evaluating per message"
17053 When this option is true (the default), once one message has been queued
17054 because the load average is higher than the value set by &%queue_only_load%&,
17055 all subsequent messages received on the same SMTP connection are also queued.
17056 This is a deliberate choice; even though the load average may fall below the
17057 threshold, it doesn't seem right to deliver later messages on the same
17058 connection when not delivering earlier ones. However, there are special
17059 circumstances such as very long-lived connections from scanning appliances
17060 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17061 should be set false. This causes the value of the load average to be
17062 re-evaluated for each message.
17063
17064
17065 .option queue_only_override main boolean true
17066 .cindex "queueing incoming messages"
17067 When this option is true, the &%-od%&&'x'& command line options override the
17068 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17069 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17070 to override; they are accepted, but ignored.
17071
17072
17073 .option queue_run_in_order main boolean false
17074 .cindex "queue runner" "processing messages in order"
17075 If this option is set, queue runs happen in order of message arrival instead of
17076 in an arbitrary order. For this to happen, a complete list of the entire queue
17077 must be set up before the deliveries start. When the queue is all held in a
17078 single directory (the default), a single list is created for both the ordered
17079 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17080 single list is not created when &%queue_run_in_order%& is false. In this case,
17081 the sub-directories are processed one at a time (in a random order), and this
17082 avoids setting up one huge list for the whole queue. Thus, setting
17083 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17084 when the queue is large, because of the extra work in setting up the single,
17085 large list. In most situations, &%queue_run_in_order%& should not be set.
17086
17087
17088
17089 .option queue_run_max main integer&!! 5
17090 .cindex "queue runner" "maximum number of"
17091 This controls the maximum number of queue runner processes that an Exim daemon
17092 can run simultaneously. This does not mean that it starts them all at once,
17093 but rather that if the maximum number are still running when the time comes to
17094 start another one, it refrains from starting another one. This can happen with
17095 very large queues and/or very sluggish deliveries. This option does not,
17096 however, interlock with other processes, so additional queue runners can be
17097 started by other means, or by killing and restarting the daemon.
17098
17099 Setting this option to zero does not suppress queue runs; rather, it disables
17100 the limit, allowing any number of simultaneous queue runner processes to be
17101 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17102 the daemon's command line.
17103
17104 .cindex queues named
17105 .cindex "named queues" "resource limit"
17106 To set limits for different named queues use
17107 an expansion depending on the &$queue_name$& variable.
17108
17109 .option queue_smtp_domains main "domain list&!!" unset
17110 .cindex "queueing incoming messages"
17111 .cindex "message" "queueing remote deliveries"
17112 .cindex "first pass routing"
17113 When this option is set, a delivery process is started whenever a message is
17114 received, routing is performed, and local deliveries take place.
17115 However, if any SMTP deliveries are required for domains that match
17116 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17117 message waits in the queue for the next queue run. Since routing of the message
17118 has taken place, Exim knows to which remote hosts it must be delivered, and so
17119 when the queue run happens, multiple messages for the same host are delivered
17120 over a single SMTP connection. The &%-odqs%& command line option causes all
17121 SMTP deliveries to be queued in this way, and is equivalent to setting
17122 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17123 &%queue_domains%&.
17124
17125
17126 .option receive_timeout main time 0s
17127 .cindex "timeout" "for non-SMTP input"
17128 This option sets the timeout for accepting a non-SMTP message, that is, the
17129 maximum time that Exim waits when reading a message on the standard input. If
17130 the value is zero, it will wait forever. This setting is overridden by the
17131 &%-or%& command line option. The timeout for incoming SMTP messages is
17132 controlled by &%smtp_receive_timeout%&.
17133
17134 .option received_header_text main string&!! "see below"
17135 .cindex "customizing" "&'Received:'& header"
17136 .cindex "&'Received:'& header line" "customizing"
17137 This string defines the contents of the &'Received:'& message header that is
17138 added to each message, except for the timestamp, which is automatically added
17139 on at the end (preceded by a semicolon). The string is expanded each time it is
17140 used. If the expansion yields an empty string, no &'Received:'& header line is
17141 added to the message. Otherwise, the string should start with the text
17142 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17143 header lines.
17144 The default setting is:
17145
17146 .code
17147 received_header_text = Received: \
17148   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17149     {${if def:sender_ident \
17150       {from ${quote_local_part:$sender_ident} }}\
17151         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17152   by $primary_hostname \
17153   ${if def:received_protocol {with $received_protocol }}\
17154   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17155   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17156   (Exim $version_number)\n\t\
17157   ${if def:sender_address \
17158   {(envelope-from <$sender_address>)\n\t}}\
17159   id $message_exim_id\
17160   ${if def:received_for {\n\tfor $received_for}}
17161 .endd
17162
17163 The references to the TLS version and cipher are
17164 omitted when Exim is built without TLS
17165 support. The use of conditional expansions ensures that this works for both
17166 locally generated messages and messages received from remote hosts, giving
17167 header lines such as the following:
17168 .code
17169 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17170 by marley.carol.example with esmtp (Exim 4.00)
17171 (envelope-from <bob@carol.example>)
17172 id 16IOWa-00019l-00
17173 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17174 Received: by scrooge.carol.example with local (Exim 4.00)
17175 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17176 .endd
17177 Until the body of the message has been received, the timestamp is the time when
17178 the message started to be received. Once the body has arrived, and all policy
17179 checks have taken place, the timestamp is updated to the time at which the
17180 message was accepted.
17181
17182
17183 .option received_headers_max main integer 30
17184 .cindex "loop" "prevention"
17185 .cindex "mail loop prevention"
17186 .cindex "&'Received:'& header line" "counting"
17187 When a message is to be delivered, the number of &'Received:'& headers is
17188 counted, and if it is greater than this parameter, a mail loop is assumed to
17189 have occurred, the delivery is abandoned, and an error message is generated.
17190 This applies to both local and remote deliveries.
17191
17192
17193 .option recipient_unqualified_hosts main "host list&!!" unset
17194 .cindex "unqualified addresses"
17195 .cindex "host" "unqualified addresses from"
17196 This option lists those hosts from which Exim is prepared to accept unqualified
17197 recipient addresses in message envelopes. The addresses are made fully
17198 qualified by the addition of the &%qualify_recipient%& value. This option also
17199 affects message header lines. Exim does not reject unqualified recipient
17200 addresses in headers, but it qualifies them only if the message came from a
17201 host that matches &%recipient_unqualified_hosts%&,
17202 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17203 option was not set.
17204
17205
17206 .option recipients_max main integer 0
17207 .cindex "limit" "number of recipients"
17208 .cindex "recipient" "maximum number"
17209 If this option is set greater than zero, it specifies the maximum number of
17210 original recipients for any message. Additional recipients that are generated
17211 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17212 all recipients over the limit; earlier recipients are delivered as normal.
17213 Non-SMTP messages with too many recipients are failed, and no deliveries are
17214 done.
17215
17216 .cindex "RCPT" "maximum number of incoming"
17217 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17218 RCPT commands in a single message.
17219
17220
17221 .option recipients_max_reject main boolean false
17222 If this option is set true, Exim rejects SMTP messages containing too many
17223 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17224 error to the eventual DATA command. Otherwise (the default) it gives a 452
17225 error to the surplus RCPT commands and accepts the message on behalf of the
17226 initial set of recipients. The remote server should then re-send the message
17227 for the remaining recipients at a later time.
17228
17229
17230 .option remote_max_parallel main integer 2
17231 .cindex "delivery" "parallelism for remote"
17232 This option controls parallel delivery of one message to a number of remote
17233 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17234 does all the remote deliveries for a message one by one. Otherwise, if a single
17235 message has to be delivered to more than one remote host, or if several copies
17236 have to be sent to the same remote host, up to &%remote_max_parallel%&
17237 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17238 deliveries are required, the maximum number of processes are started, and as
17239 each one finishes, another is begun. The order of starting processes is the
17240 same as if sequential delivery were being done, and can be controlled by the
17241 &%remote_sort_domains%& option. If parallel delivery takes place while running
17242 with debugging turned on, the debugging output from each delivery process is
17243 tagged with its process id.
17244
17245 This option controls only the maximum number of parallel deliveries for one
17246 message in one Exim delivery process. Because Exim has no central queue
17247 manager, there is no way of controlling the total number of simultaneous
17248 deliveries if the configuration allows a delivery attempt as soon as a message
17249 is received.
17250
17251 .cindex "number of deliveries"
17252 .cindex "delivery" "maximum number of"
17253 If you want to control the total number of deliveries on the system, you
17254 need to set the &%queue_only%& option. This ensures that all incoming messages
17255 are added to the queue without starting a delivery process. Then set up an Exim
17256 daemon to start queue runner processes at appropriate intervals (probably
17257 fairly often, for example, every minute), and limit the total number of queue
17258 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17259 delivers only one message at a time, the maximum number of deliveries that can
17260 then take place at once is &%queue_run_max%& multiplied by
17261 &%remote_max_parallel%&.
17262
17263 If it is purely remote deliveries you want to control, use
17264 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17265 doing the SMTP routing before queueing, so that several messages for the same
17266 host will eventually get delivered down the same connection.
17267
17268
17269 .option remote_sort_domains main "domain list&!!" unset
17270 .cindex "sorting remote deliveries"
17271 .cindex "delivery" "sorting remote"
17272 When there are a number of remote deliveries for a message, they are sorted by
17273 domain into the order given by this list. For example,
17274 .code
17275 remote_sort_domains = *.cam.ac.uk:*.uk
17276 .endd
17277 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17278 then to those in the &%uk%& domain, then to any others.
17279
17280
17281 .option retry_data_expire main time 7d
17282 .cindex "hints database" "data expiry"
17283 This option sets a &"use before"& time on retry information in Exim's hints
17284 database. Any older retry data is ignored. This means that, for example, once a
17285 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17286 past failures.
17287
17288
17289 .option retry_interval_max main time 24h
17290 .cindex "retry" "limit on interval"
17291 .cindex "limit" "on retry interval"
17292 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17293 intervals between delivery attempts for messages that cannot be delivered
17294 straight away. This option sets an overall limit to the length of time between
17295 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17296 the default value.
17297
17298
17299 .option return_path_remove main boolean true
17300 .cindex "&'Return-path:'& header line" "removing"
17301 RFC 2821, section 4.4, states that an SMTP server must insert a
17302 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17303 The &'Return-path:'& header preserves the sender address as received in the
17304 MAIL command. This description implies that this header should not be present
17305 in an incoming message. If &%return_path_remove%& is true, any existing
17306 &'Return-path:'& headers are removed from messages at the time they are
17307 received. Exim's transports have options for adding &'Return-path:'& headers at
17308 the time of delivery. They are normally used only for final local deliveries.
17309
17310
17311 .option return_size_limit main integer 100K
17312 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17313
17314
17315 .option rfc1413_hosts main "host list&!!" @[]
17316 .cindex "RFC 1413"
17317 .cindex "host" "for RFC 1413 calls"
17318 RFC 1413 identification calls are made to any client host which matches
17319 an item in the list.
17320 The default value specifies just this host, being any local interface
17321 for the system.
17322
17323 .option rfc1413_query_timeout main time 0s
17324 .cindex "RFC 1413" "query timeout"
17325 .cindex "timeout" "for RFC 1413 call"
17326 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17327 no RFC 1413 calls are ever made.
17328
17329
17330 .option sender_unqualified_hosts main "host list&!!" unset
17331 .cindex "unqualified addresses"
17332 .cindex "host" "unqualified addresses from"
17333 This option lists those hosts from which Exim is prepared to accept unqualified
17334 sender addresses. The addresses are made fully qualified by the addition of
17335 &%qualify_domain%&. This option also affects message header lines. Exim does
17336 not reject unqualified addresses in headers that contain sender addresses, but
17337 it qualifies them only if the message came from a host that matches
17338 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17339 using TCP/IP), and the &%-bnq%& option was not set.
17340
17341
17342 .option slow_lookup_log main integer 0
17343 .cindex "logging" "slow lookups"
17344 .cindex "dns" "logging slow lookups"
17345 This option controls logging of slow lookups.
17346 If the value is nonzero it is taken as a number of milliseconds
17347 and lookups taking longer than this are logged.
17348 Currently this applies only to DNS lookups.
17349
17350
17351
17352 .option smtp_accept_keepalive main boolean true
17353 .cindex "keepalive" "on incoming connection"
17354 This option controls the setting of the SO_KEEPALIVE option on incoming
17355 TCP/IP socket connections. When set, it causes the kernel to probe idle
17356 connections periodically, by sending packets with &"old"& sequence numbers. The
17357 other end of the connection should send an acknowledgment if the connection is
17358 still okay or a reset if the connection has been aborted. The reason for doing
17359 this is that it has the beneficial effect of freeing up certain types of
17360 connection that can get stuck when the remote host is disconnected without
17361 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17362 hours to detect unreachable hosts.
17363
17364
17365
17366 .option smtp_accept_max main integer 20
17367 .cindex "limit" "incoming SMTP connections"
17368 .cindex "SMTP" "incoming connection count"
17369 .cindex "inetd"
17370 This option specifies the maximum number of simultaneous incoming SMTP calls
17371 that Exim will accept. It applies only to the listening daemon; there is no
17372 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17373 value is set to zero, no limit is applied. However, it is required to be
17374 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17375 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17376
17377 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17378 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17379 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17380 and &%smtp_load_reserve%& are then checked before accepting the connection.
17381
17382
17383 .option smtp_accept_max_nonmail main integer 10
17384 .cindex "limit" "non-mail SMTP commands"
17385 .cindex "SMTP" "limiting non-mail commands"
17386 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17387 the connection if there are too many. This option defines &"too many"&. The
17388 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17389 client looping sending EHLO, for example. The check is applied only if the
17390 client host matches &%smtp_accept_max_nonmail_hosts%&.
17391
17392 When a new message is expected, one occurrence of RSET is not counted. This
17393 allows a client to send one RSET between messages (this is not necessary,
17394 but some clients do it). Exim also allows one uncounted occurrence of HELO
17395 or EHLO, and one occurrence of STARTTLS between messages. After
17396 starting up a TLS session, another EHLO is expected, and so it too is not
17397 counted. The first occurrence of AUTH in a connection, or immediately
17398 following STARTTLS is not counted. Otherwise, all commands other than
17399 MAIL, RCPT, DATA, and QUIT are counted.
17400
17401
17402 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17403 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17404 check by setting this option. The default value makes it apply to all hosts. By
17405 changing the value, you can exclude any badly-behaved hosts that you have to
17406 live with.
17407
17408
17409 . Allow this long option name to split; give it unsplit as a fifth argument
17410 . for the automatic .oindex that is generated by .option.
17411 . We insert " &~&~" which is both pretty nasty visually and results in
17412 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17413 . zero-width-space, which would be nicer visually and results in (at least)
17414 . html that Firefox will split on when it's forced to reflow (rather than
17415 . inserting a horizontal scrollbar).  However, the text is still not
17416 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17417 . the option name to split.
17418
17419 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17420          smtp_accept_max_per_connection
17421 .cindex "SMTP" "limiting incoming message count"
17422 .cindex "limit" "messages per SMTP connection"
17423 The value of this option limits the number of MAIL commands that Exim is
17424 prepared to accept over a single SMTP connection, whether or not each command
17425 results in the transfer of a message. After the limit is reached, a 421
17426 response is given to subsequent MAIL commands. This limit is a safety
17427 precaution against a client that goes mad (incidents of this type have been
17428 seen).
17429
17430
17431 .option smtp_accept_max_per_host main string&!! unset
17432 .cindex "limit" "SMTP connections from one host"
17433 .cindex "host" "limiting SMTP connections from"
17434 This option restricts the number of simultaneous IP connections from a single
17435 host (strictly, from a single IP address) to the Exim daemon. The option is
17436 expanded, to enable different limits to be applied to different hosts by
17437 reference to &$sender_host_address$&. Once the limit is reached, additional
17438 connection attempts from the same host are rejected with error code 421. This
17439 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17440 of zero imposes no limit. If this option is set greater than zero, it is
17441 required that &%smtp_accept_max%& be non-zero.
17442
17443 &*Warning*&: When setting this option you should not use any expansion
17444 constructions that take an appreciable amount of time. The expansion and test
17445 happen in the main daemon loop, in order to reject additional connections
17446 without forking additional processes (otherwise a denial-of-service attack
17447 could cause a vast number or processes to be created). While the daemon is
17448 doing this processing, it cannot accept any other incoming connections.
17449
17450
17451
17452 .option smtp_accept_queue main integer 0
17453 .cindex "SMTP" "incoming connection count"
17454 .cindex "queueing incoming messages"
17455 .cindex "message" "queueing by SMTP connection count"
17456 If the number of simultaneous incoming SMTP connections being handled via the
17457 listening daemon exceeds this value, messages received by SMTP are just placed
17458 in the queue; no delivery processes are started automatically. The count is
17459 fixed at the start of an SMTP connection. It cannot be updated in the
17460 subprocess that receives messages, and so the queueing or not queueing applies
17461 to all messages received in the same connection.
17462
17463 A value of zero implies no limit, and clearly any non-zero value is useful only
17464 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17465 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17466 various &%-od%&&'x'& command line options.
17467
17468
17469 . See the comment on smtp_accept_max_per_connection
17470
17471 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17472          smtp_accept_queue_per_connection
17473 .cindex "queueing incoming messages"
17474 .cindex "message" "queueing by message count"
17475 This option limits the number of delivery processes that Exim starts
17476 automatically when receiving messages via SMTP, whether via the daemon or by
17477 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17478 and the number of messages received in a single SMTP session exceeds this
17479 number, subsequent messages are placed in the queue, but no delivery processes
17480 are started. This helps to limit the number of Exim processes when a server
17481 restarts after downtime and there is a lot of mail waiting for it on other
17482 systems. On large systems, the default should probably be increased, and on
17483 dial-in client systems it should probably be set to zero (that is, disabled).
17484
17485
17486 .option smtp_accept_reserve main integer 0
17487 .cindex "SMTP" "incoming call count"
17488 .cindex "host" "reserved"
17489 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17490 number of SMTP connections that are reserved for connections from the hosts
17491 that are specified in &%smtp_reserve_hosts%&. The value set in
17492 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17493 restricted to this number of connections; the option specifies a minimum number
17494 of connection slots for them, not a maximum. It is a guarantee that this group
17495 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17496 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17497 individual host.
17498
17499 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17500 set to 5, once there are 45 active connections (from any hosts), new
17501 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17502 provided the other criteria for acceptance are met.
17503
17504
17505 .option smtp_active_hostname main string&!! unset
17506 .cindex "host" "name in SMTP responses"
17507 .cindex "SMTP" "host name in responses"
17508 .vindex "&$primary_hostname$&"
17509 This option is provided for multi-homed servers that want to masquerade as
17510 several different hosts. At the start of an incoming SMTP connection, its value
17511 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17512 responses. For example, it is used as domain name in the response to an
17513 incoming HELO or EHLO command.
17514
17515 .vindex "&$smtp_active_hostname$&"
17516 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17517 is saved with any messages that are received. It is therefore available for use
17518 in routers and transports when the message is later delivered.
17519
17520 If this option is unset, or if its expansion is forced to fail, or if the
17521 expansion results in an empty string, the value of &$primary_hostname$& is
17522 used. Other expansion failures cause a message to be written to the main and
17523 panic logs, and the SMTP command receives a temporary error. Typically, the
17524 value of &%smtp_active_hostname%& depends on the incoming interface address.
17525 For example:
17526 .code
17527 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17528   {cox.mydomain}{box.mydomain}}
17529 .endd
17530
17531 Although &$smtp_active_hostname$& is primarily concerned with incoming
17532 messages, it is also used as the default for HELO commands in callout
17533 verification if there is no remote transport from which to obtain a
17534 &%helo_data%& value.
17535
17536 .option smtp_banner main string&!! "see below"
17537 .cindex "SMTP" "welcome banner"
17538 .cindex "banner for SMTP"
17539 .cindex "welcome banner for SMTP"
17540 .cindex "customizing" "SMTP banner"
17541 This string, which is expanded every time it is used, is output as the initial
17542 positive response to an SMTP connection. The default setting is:
17543 .code
17544 smtp_banner = $smtp_active_hostname ESMTP Exim \
17545   $version_number $tod_full
17546 .endd
17547 Failure to expand the string causes a panic error. If you want to create a
17548 multiline response to the initial SMTP connection, use &"\n"& in the string at
17549 appropriate points, but not at the end. Note that the 220 code is not included
17550 in this string. Exim adds it automatically (several times in the case of a
17551 multiline response).
17552
17553
17554 .option smtp_check_spool_space main boolean true
17555 .cindex "checking disk space"
17556 .cindex "disk space, checking"
17557 .cindex "spool directory" "checking space"
17558 When this option is set, if an incoming SMTP session encounters the SIZE
17559 option on a MAIL command, it checks that there is enough space in the
17560 spool directory's partition to accept a message of that size, while still
17561 leaving free the amount specified by &%check_spool_space%& (even if that value
17562 is zero). If there isn't enough space, a temporary error code is returned.
17563
17564
17565 .option smtp_connect_backlog main integer 20
17566 .cindex "connection backlog"
17567 .cindex "SMTP" "connection backlog"
17568 .cindex "backlog of connections"
17569 This option specifies a maximum number of waiting SMTP connections. Exim passes
17570 this value to the TCP/IP system when it sets up its listener. Once this number
17571 of connections are waiting for the daemon's attention, subsequent connection
17572 attempts are refused at the TCP/IP level. At least, that is what the manuals
17573 say; in some circumstances such connection attempts have been observed to time
17574 out instead. For large systems it is probably a good idea to increase the
17575 value (to 50, say). It also gives some protection against denial-of-service
17576 attacks by SYN flooding.
17577
17578
17579 .option smtp_enforce_sync main boolean true
17580 .cindex "SMTP" "synchronization checking"
17581 .cindex "synchronization checking in SMTP"
17582 The SMTP protocol specification requires the client to wait for a response from
17583 the server at certain points in the dialogue. Without PIPELINING these
17584 synchronization points are after every command; with PIPELINING they are
17585 fewer, but they still exist.
17586
17587 Some spamming sites send out a complete set of SMTP commands without waiting
17588 for any response. Exim protects against this by rejecting a message if the
17589 client has sent further input when it should not have. The error response &"554
17590 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17591 for this error cannot be perfect because of transmission delays (unexpected
17592 input may be on its way but not yet received when Exim checks). However, it
17593 does detect many instances.
17594
17595 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17596 If you want to disable the check selectively (for example, only for certain
17597 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17598 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17599
17600
17601
17602 .option smtp_etrn_command main string&!! unset
17603 .cindex "ETRN" "command to be run"
17604 .cindex "ESMTP extensions" ETRN
17605 .vindex "&$domain$&"
17606 If this option is set, the given command is run whenever an SMTP ETRN
17607 command is received from a host that is permitted to issue such commands (see
17608 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17609 are independently expanded. The expansion variable &$domain$& is set to the
17610 argument of the ETRN command, and no syntax checking is done on it. For
17611 example:
17612 .code
17613 smtp_etrn_command = /etc/etrn_command $domain \
17614                     $sender_host_address
17615 .endd
17616 If the option is not set, the argument for the ETRN command must
17617 be a &'#'& followed by an address string.
17618 In this case an &'exim -R <string>'& command is used;
17619 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17620
17621 A new process is created to run the command, but Exim does not wait for it to
17622 complete. Consequently, its status cannot be checked. If the command cannot be
17623 run, a line is written to the panic log, but the ETRN caller still receives
17624 a 250 success response. Exim is normally running under its own uid when
17625 receiving SMTP, so it is not possible for it to change the uid before running
17626 the command.
17627
17628
17629 .option smtp_etrn_serialize main boolean true
17630 .cindex "ETRN" "serializing"
17631 When this option is set, it prevents the simultaneous execution of more than
17632 one identical command as a result of ETRN in an SMTP connection. See
17633 section &<<SECTETRN>>& for details.
17634
17635
17636 .option smtp_load_reserve main fixed-point unset
17637 .cindex "load average"
17638 If the system load average ever gets higher than this, incoming SMTP calls are
17639 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17640 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17641 the load is over the limit. The option has no effect on ancient operating
17642 systems on which Exim cannot determine the load average. See also
17643 &%deliver_queue_load_max%& and &%queue_only_load%&.
17644
17645
17646
17647 .option smtp_max_synprot_errors main integer 3
17648 .cindex "SMTP" "limiting syntax and protocol errors"
17649 .cindex "limit" "SMTP syntax and protocol errors"
17650 Exim rejects SMTP commands that contain syntax or protocol errors. In
17651 particular, a syntactically invalid email address, as in this command:
17652 .code
17653 RCPT TO:<abc xyz@a.b.c>
17654 .endd
17655 causes immediate rejection of the command, before any other tests are done.
17656 (The ACL cannot be run if there is no valid address to set up for it.) An
17657 example of a protocol error is receiving RCPT before MAIL. If there are
17658 too many syntax or protocol errors in one SMTP session, the connection is
17659 dropped. The limit is set by this option.
17660
17661 .cindex "PIPELINING" "expected errors"
17662 When the PIPELINING extension to SMTP is in use, some protocol errors are
17663 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17664 Exim assumes that PIPELINING will be used if it advertises it (see
17665 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17666 not count towards the limit.
17667
17668
17669
17670 .option smtp_max_unknown_commands main integer 3
17671 .cindex "SMTP" "limiting unknown commands"
17672 .cindex "limit" "unknown SMTP commands"
17673 If there are too many unrecognized commands in an incoming SMTP session, an
17674 Exim server drops the connection. This is a defence against some kinds of abuse
17675 that subvert web
17676 clients
17677 into making connections to SMTP ports; in these circumstances, a number of
17678 non-SMTP command lines are sent first.
17679
17680
17681
17682 .option smtp_ratelimit_hosts main "host list&!!" unset
17683 .cindex "SMTP" "rate limiting"
17684 .cindex "limit" "rate of message arrival"
17685 .cindex "RCPT" "rate limiting"
17686 Some sites find it helpful to be able to limit the rate at which certain hosts
17687 can send them messages, and the rate at which an individual message can specify
17688 recipients.
17689
17690 Exim has two rate-limiting facilities. This section describes the older
17691 facility, which can limit rates within a single connection. The newer
17692 &%ratelimit%& ACL condition can limit rates across all connections. See section
17693 &<<SECTratelimiting>>& for details of the newer facility.
17694
17695 When a host matches &%smtp_ratelimit_hosts%&, the values of
17696 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17697 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17698 respectively. Each option, if set, must contain a set of four comma-separated
17699 values:
17700
17701 .ilist
17702 A threshold, before which there is no rate limiting.
17703 .next
17704 An initial time delay. Unlike other times in Exim, numbers with decimal
17705 fractional parts are allowed here.
17706 .next
17707 A factor by which to increase the delay each time.
17708 .next
17709 A maximum value for the delay. This should normally be less than 5 minutes,
17710 because after that time, the client is liable to timeout the SMTP command.
17711 .endlist
17712
17713 For example, these settings have been used successfully at the site which
17714 first suggested this feature, for controlling mail from their customers:
17715 .code
17716 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17717 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17718 .endd
17719 The first setting specifies delays that are applied to MAIL commands after
17720 two have been received over a single connection. The initial delay is 0.5
17721 seconds, increasing by a factor of 1.05 each time. The second setting applies
17722 delays to RCPT commands when more than four occur in a single message.
17723
17724
17725 .option smtp_ratelimit_mail main string unset
17726 See &%smtp_ratelimit_hosts%& above.
17727
17728
17729 .option smtp_ratelimit_rcpt main string unset
17730 See &%smtp_ratelimit_hosts%& above.
17731
17732
17733 .option smtp_receive_timeout main time&!! 5m
17734 .cindex "timeout" "for SMTP input"
17735 .cindex "SMTP" "input timeout"
17736 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17737 input, including batch SMTP. If a line of input (either an SMTP command or a
17738 data line) is not received within this time, the SMTP connection is dropped and
17739 the message is abandoned.
17740 A line is written to the log containing one of the following messages:
17741 .code
17742 SMTP command timeout on connection from...
17743 SMTP data timeout on connection from...
17744 .endd
17745 The former means that Exim was expecting to read an SMTP command; the latter
17746 means that it was in the DATA phase, reading the contents of a message.
17747
17748 If the first character of the option is a &"$"& the option is
17749 expanded before use and may depend on
17750 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17751
17752
17753 .oindex "&%-os%&"
17754 The value set by this option can be overridden by the
17755 &%-os%& command-line option. A setting of zero time disables the timeout, but
17756 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17757 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17758 timeout is controlled by &%receive_timeout%& and &%-or%&.
17759
17760
17761 .option smtp_reserve_hosts main "host list&!!" unset
17762 This option defines hosts for which SMTP connections are reserved; see
17763 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17764
17765
17766 .option smtp_return_error_details main boolean false
17767 .cindex "SMTP" "details policy failures"
17768 .cindex "policy control" "rejection, returning details"
17769 In the default state, Exim uses bland messages such as
17770 &"Administrative prohibition"& when it rejects SMTP commands for policy
17771 reasons. Many sysadmins like this because it gives away little information
17772 to spammers. However, some other sysadmins who are applying strict checking
17773 policies want to give out much fuller information about failures. Setting
17774 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17775 example, instead of &"Administrative prohibition"&, it might give:
17776 .code
17777 550-Rejected after DATA: '>' missing at end of address:
17778 550 failing address in "From" header is: <user@dom.ain
17779 .endd
17780
17781
17782 .option smtputf8_advertise_hosts main "host list&!!" *
17783 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17784 .cindex "ESMTP extensions" SMTPUTF8
17785 When Exim is built with support for internationalised mail names,
17786 the availability thereof is advertised in
17787 response to EHLO only to those client hosts that match this option. See
17788 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17789
17790
17791 .option spamd_address main string "127.0.0.1 783"
17792 This option is available when Exim is compiled with the content-scanning
17793 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17794 See section &<<SECTscanspamass>>& for more details.
17795
17796
17797
17798 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17799 This option is available when Exim is compiled with SPF support.
17800 See section &<<SECSPF>>& for more details.
17801
17802 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17803 This option is available when Exim is compiled with SPF support.  It
17804 allows the customisation of the SMTP comment that the SPF library
17805 generates.  You are strongly encouraged to link to your own explanative
17806 site. The template must not contain spaces. If you need spaces in the
17807 output, use the proper placeholder. If libspf2 can not parse the
17808 template, it uses a built-in default broken link. The following placeholders
17809 (along with Exim variables (but see below)) are allowed in the template:
17810 .ilist
17811 &*%_*&: A space.
17812 .next
17813 &*%{L}*&: Envelope sender's local part.
17814 .next
17815 &*%{S}*&: Envelope sender.
17816 .next
17817 &*%{O}*&: Envelope sender's domain.
17818 .next
17819 &*%{D}*&: Current(?) domain.
17820 .next
17821 &*%{I}*&: SMTP client Ip.
17822 .next
17823 &*%{C}*&: SMTP client pretty IP.
17824 .next
17825 &*%{T}*&: Epoch time (UTC).
17826 .next
17827 &*%{P}*&: SMTP client domain name.
17828 .next
17829 &*%{V}*&: IP version.
17830 .next
17831 &*%{H}*&: EHLO/HELO domain.
17832 .next
17833 &*%{R}*&: Receiving domain.
17834 .endlist
17835 The capitalized placeholders do proper URL encoding, if you use them
17836 lowercased, no encoding takes place.  This list was compiled from the
17837 libspf2 sources.
17838
17839 A note on using Exim variables: As
17840 currently the SPF library is initialized before the SMTP EHLO phase,
17841 the variables useful for expansion are quite limited.
17842
17843
17844 .option split_spool_directory main boolean false
17845 .cindex "multiple spool directories"
17846 .cindex "spool directory" "split"
17847 .cindex "directories, multiple"
17848 If this option is set, it causes Exim to split its input directory into 62
17849 subdirectories, each with a single alphanumeric character as its name. The
17850 sixth character of the message id is used to allocate messages to
17851 subdirectories; this is the least significant base-62 digit of the time of
17852 arrival of the message.
17853
17854 Splitting up the spool in this way may provide better performance on systems
17855 where there are long mail queues, by reducing the number of files in any one
17856 directory. The msglog directory is also split up in a similar way to the input
17857 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17858 are still placed in the single directory &_msglog.OLD_&.
17859
17860 It is not necessary to take any special action for existing messages when
17861 changing &%split_spool_directory%&. Exim notices messages that are in the
17862 &"wrong"& place, and continues to process them. If the option is turned off
17863 after a period of being on, the subdirectories will eventually empty and be
17864 automatically deleted.
17865
17866 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17867 changes. Instead of creating a list of all messages in the queue, and then
17868 trying to deliver each one, in turn, it constructs a list of those in one
17869 sub-directory and tries to deliver them, before moving on to the next
17870 sub-directory. The sub-directories are processed in a random order. This
17871 spreads out the scanning of the input directories, and uses less memory. It is
17872 particularly beneficial when there are lots of messages in the queue. However,
17873 if &%queue_run_in_order%& is set, none of this new processing happens. The
17874 entire queue has to be scanned and sorted before any deliveries can start.
17875
17876
17877 .option spool_directory main string&!! "set at compile time"
17878 .cindex "spool directory" "path to"
17879 This defines the directory in which Exim keeps its spool, that is, the messages
17880 it is waiting to deliver. The default value is taken from the compile-time
17881 configuration setting, if there is one. If not, this option must be set. The
17882 string is expanded, so it can contain, for example, a reference to
17883 &$primary_hostname$&.
17884
17885 If the spool directory name is fixed on your installation, it is recommended
17886 that you set it at build time rather than from this option, particularly if the
17887 log files are being written to the spool directory (see &%log_file_path%&).
17888 Otherwise log files cannot be used for errors that are detected early on, such
17889 as failures in the configuration file.
17890
17891 By using this option to override the compiled-in path, it is possible to run
17892 tests of Exim without using the standard spool.
17893
17894 .option spool_wireformat main boolean false
17895 .cindex "spool directory" "file formats"
17896 If this option is set, Exim may for some messages use an alternative format
17897 for data-files in the spool which matches the wire format.
17898 Doing this permits more efficient message reception and transmission.
17899 Currently it is only done for messages received using the ESMTP CHUNKING
17900 option.
17901
17902 The following variables will not have useful values:
17903 .code
17904 $max_received_linelength
17905 $body_linecount
17906 $body_zerocount
17907 .endd
17908
17909 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17910 and any external programs which are passed a reference to a message data file
17911 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17912 will need to be aware of the different formats potentially available.
17913
17914 Using any of the ACL conditions noted will negate the reception benefit
17915 (as a Unix-mbox-format file is constructed for them).
17916 The transmission benefit is maintained.
17917
17918 .option sqlite_lock_timeout main time 5s
17919 .cindex "sqlite lookup type" "lock timeout"
17920 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17921 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17922
17923 .option strict_acl_vars main boolean false
17924 .cindex "&ACL;" "variables, handling unset"
17925 This option controls what happens if a syntactically valid but undefined ACL
17926 variable is referenced. If it is false (the default), an empty string
17927 is substituted; if it is true, an error is generated. See section
17928 &<<SECTaclvariables>>& for details of ACL variables.
17929
17930 .option strip_excess_angle_brackets main boolean false
17931 .cindex "angle brackets, excess"
17932 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17933 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17934 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17935 passed on to another MTA, the excess angle brackets are not passed on. If this
17936 option is not set, multiple pairs of angle brackets cause a syntax error.
17937
17938
17939 .option strip_trailing_dot main boolean false
17940 .cindex "trailing dot on domain"
17941 .cindex "dot" "trailing on domain"
17942 If this option is set, a trailing dot at the end of a domain in an address is
17943 ignored. If this is in the envelope and the message is passed on to another
17944 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17945 domain causes a syntax error.
17946 However, addresses in header lines are checked only when an ACL requests header
17947 syntax checking.
17948
17949
17950 .option syslog_duplication main boolean true
17951 .cindex "syslog" "duplicate log lines; suppressing"
17952 When Exim is logging to syslog, it writes the log lines for its three
17953 separate logs at different syslog priorities so that they can in principle
17954 be separated on the logging hosts. Some installations do not require this
17955 separation, and in those cases, the duplication of certain log lines is a
17956 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17957 particular log line is written to syslog. For lines that normally go to
17958 both the main log and the reject log, the reject log version (possibly
17959 containing message header lines) is written, at LOG_NOTICE priority.
17960 Lines that normally go to both the main and the panic log are written at
17961 the LOG_ALERT priority.
17962
17963
17964 .option syslog_facility main string unset
17965 .cindex "syslog" "facility; setting"
17966 This option sets the syslog &"facility"& name, used when Exim is logging to
17967 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17968 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17969 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17970 details of Exim's logging.
17971
17972
17973 .option syslog_pid main boolean true
17974 .cindex "syslog" "pid"
17975 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17976 omitted when these lines are sent to syslog. (Syslog normally prefixes
17977 the log lines with the PID of the logging process automatically.) You need
17978 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17979 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17980
17981
17982
17983 .option syslog_processname main string &`exim`&
17984 .cindex "syslog" "process name; setting"
17985 This option sets the syslog &"ident"& name, used when Exim is logging to
17986 syslog. The value must be no longer than 32 characters. See chapter
17987 &<<CHAPlog>>& for details of Exim's logging.
17988
17989
17990
17991 .option syslog_timestamp main boolean true
17992 .cindex "syslog" "timestamps"
17993 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17994 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17995 details of Exim's logging.
17996
17997
17998 .option system_filter main string&!! unset
17999 .cindex "filter" "system filter"
18000 .cindex "system filter" "specifying"
18001 .cindex "Sieve filter" "not available for system filter"
18002 This option specifies an Exim filter file that is applied to all messages at
18003 the start of each delivery attempt, before any routing is done. System filters
18004 must be Exim filters; they cannot be Sieve filters. If the system filter
18005 generates any deliveries to files or pipes, or any new mail messages, the
18006 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18007 which transports are to be used. Details of this facility are given in chapter
18008 &<<CHAPsystemfilter>>&.
18009 A forced expansion failure results in no filter operation.
18010
18011
18012 .option system_filter_directory_transport main string&!! unset
18013 .vindex "&$address_file$&"
18014 This sets the name of the transport driver that is to be used when the
18015 &%save%& command in a system message filter specifies a path ending in &"/"&,
18016 implying delivery of each message into a separate file in some directory.
18017 During the delivery, the variable &$address_file$& contains the path name.
18018
18019
18020 .option system_filter_file_transport main string&!! unset
18021 .cindex "file" "transport for system filter"
18022 This sets the name of the transport driver that is to be used when the &%save%&
18023 command in a system message filter specifies a path not ending in &"/"&. During
18024 the delivery, the variable &$address_file$& contains the path name.
18025
18026 .option system_filter_group main string unset
18027 .cindex "gid (group id)" "system filter"
18028 This option is used only when &%system_filter_user%& is also set. It sets the
18029 gid under which the system filter is run, overriding any gid that is associated
18030 with the user. The value may be numerical or symbolic.
18031
18032 .option system_filter_pipe_transport main string&!! unset
18033 .cindex "&(pipe)& transport" "for system filter"
18034 .vindex "&$address_pipe$&"
18035 This specifies the transport driver that is to be used when a &%pipe%& command
18036 is used in a system filter. During the delivery, the variable &$address_pipe$&
18037 contains the pipe command.
18038
18039
18040 .option system_filter_reply_transport main string&!! unset
18041 .cindex "&(autoreply)& transport" "for system filter"
18042 This specifies the transport driver that is to be used when a &%mail%& command
18043 is used in a system filter.
18044
18045
18046 .option system_filter_user main string unset
18047 .cindex "uid (user id)" "system filter"
18048 If this option is set to root, the system filter is run in the main Exim
18049 delivery process, as root.  Otherwise, the system filter runs in a separate
18050 process, as the given user, defaulting to the Exim run-time user.
18051 Unless the string consists entirely of digits, it
18052 is looked up in the password data. Failure to find the named user causes a
18053 configuration error. The gid is either taken from the password data, or
18054 specified by &%system_filter_group%&. When the uid is specified numerically,
18055 &%system_filter_group%& is required to be set.
18056
18057 If the system filter generates any pipe, file, or reply deliveries, the uid
18058 under which the filter is run is used when transporting them, unless a
18059 transport option overrides.
18060
18061
18062 .option tcp_nodelay main boolean true
18063 .cindex "daemon" "TCP_NODELAY on sockets"
18064 .cindex "Nagle algorithm"
18065 .cindex "TCP_NODELAY on listening sockets"
18066 If this option is set false, it stops the Exim daemon setting the
18067 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18068 turns off the &"Nagle algorithm"&, which is a way of improving network
18069 performance in interactive (character-by-character) situations. Turning it off
18070 should improve Exim's performance a bit, so that is what happens by default.
18071 However, it appears that some broken clients cannot cope, and time out. Hence
18072 this option. It affects only those sockets that are set up for listening by the
18073 daemon. Sockets created by the smtp transport for delivering mail always set
18074 TCP_NODELAY.
18075
18076
18077 .option timeout_frozen_after main time 0s
18078 .cindex "frozen messages" "timing out"
18079 .cindex "timeout" "frozen messages"
18080 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18081 message of any kind that has been in the queue for longer than the given time
18082 is automatically cancelled at the next queue run. If the frozen message is a
18083 bounce message, it is just discarded; otherwise, a bounce is sent to the
18084 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18085 If you want to timeout frozen bounce messages earlier than other kinds of
18086 frozen message, see &%ignore_bounce_errors_after%&.
18087
18088 &*Note:*& the default value of zero means no timeouts; with this setting,
18089 frozen messages remain in the queue forever (except for any frozen bounce
18090 messages that are released by &%ignore_bounce_errors_after%&).
18091
18092
18093 .option timezone main string unset
18094 .cindex "timezone, setting"
18095 .cindex "environment" "values from"
18096 The value of &%timezone%& is used to set the environment variable TZ while
18097 running Exim (if it is different on entry). This ensures that all timestamps
18098 created by Exim are in the required timezone. If you want all your timestamps
18099 to be in UTC (aka GMT) you should set
18100 .code
18101 timezone = UTC
18102 .endd
18103 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18104 or, if that is not set, from the value of the TZ environment variable when Exim
18105 is built. If &%timezone%& is set to the empty string, either at build or run
18106 time, any existing TZ variable is removed from the environment when Exim
18107 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18108 unfortunately not all, operating systems.
18109
18110
18111 .option tls_advertise_hosts main "host list&!!" *
18112 .cindex "TLS" "advertising"
18113 .cindex "encryption" "on SMTP connection"
18114 .cindex "SMTP" "encrypted connection"
18115 .cindex "ESMTP extensions" STARTTLS
18116 When Exim is built with support for TLS encrypted connections, the availability
18117 of the STARTTLS command to set up an encrypted session is advertised in
18118 response to EHLO only to those client hosts that match this option. See
18119 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18120 Note that the default value requires that a certificate be supplied
18121 using the &%tls_certificate%& option.  If TLS support for incoming connections
18122 is not required the &%tls_advertise_hosts%& option should be set empty.
18123
18124
18125 .option tls_certificate main string list&!! unset
18126 .cindex "TLS" "server certificate; location of"
18127 .cindex "certificate" "server, location of"
18128 The value of this option is expanded, and must then be a list of absolute paths to
18129 files which contain the server's certificates (in PEM format).
18130 Commonly only one file is needed.
18131 The server's private key is also
18132 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18133 &<<CHAPTLS>>& for further details.
18134
18135 &*Note*&: The certificates defined by this option are used only when Exim is
18136 receiving incoming messages as a server. If you want to supply certificates for
18137 use when sending messages as a client, you must set the &%tls_certificate%&
18138 option in the relevant &(smtp)& transport.
18139
18140 &*Note*&: If you use filenames based on IP addresses, change the list
18141 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18142
18143 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18144 when a list of more than one
18145 file is used, the &$tls_in_ourcert$& variable is unreliable.
18146 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18147
18148 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18149 if the OpenSSL build supports TLS extensions and the TLS client sends the
18150 Server Name Indication extension, then this option and others documented in
18151 &<<SECTtlssni>>& will be re-expanded.
18152
18153 If this option is unset or empty a fresh self-signed certificate will be
18154 generated for every connection.
18155
18156 .option tls_crl main string&!! unset
18157 .cindex "TLS" "server certificate revocation list"
18158 .cindex "certificate" "revocation list for server"
18159 This option specifies a certificate revocation list. The expanded value must
18160 be the name of a file that contains CRLs in PEM format.
18161
18162 Under OpenSSL the option can specify a directory with CRL files.
18163
18164 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18165 for each signing element of the certificate chain (i.e. all but the leaf).
18166 For the file variant this can be multiple PEM blocks in the one file.
18167
18168 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18169
18170
18171 .option tls_dh_max_bits main integer 2236
18172 .cindex "TLS" "D-H bit count"
18173 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18174 the chosen TLS library.  That value might prove to be too high for
18175 interoperability.  This option provides a maximum clamp on the value
18176 suggested, trading off security for interoperability.
18177
18178 The value must be at least 1024.
18179
18180 The value 2236 was chosen because, at time of adding the option, it was the
18181 hard-coded maximum value supported by the NSS cryptographic library, as used
18182 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18183
18184 If you prefer more security and are willing to break some clients, raise this
18185 number.
18186
18187 Note that the value passed to GnuTLS for *generating* a new prime may be a
18188 little less than this figure, because GnuTLS is inexact and may produce a
18189 larger prime than requested.
18190
18191
18192 .option tls_dhparam main string&!! unset
18193 .cindex "TLS" "D-H parameters for server"
18194 The value of this option is expanded and indicates the source of DH parameters
18195 to be used by Exim.
18196
18197 This option is ignored for GnuTLS version 3.6.0 and later.
18198 The library manages parameter negotiation internally.
18199
18200 &*Note: The Exim Maintainers strongly recommend,
18201 for other TLS library versions,
18202 using a filename with site-generated
18203 local DH parameters*&, which has been supported across all versions of Exim.  The
18204 other specific constants available are a fallback so that even when
18205 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18206
18207 If &%tls_dhparam%& is a filename starting with a &`/`&,
18208 then it names a file from which DH
18209 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18210 PKCS#3 representation of the DH prime.  If the file does not exist, for
18211 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18212 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18213 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18214 and treated as though the &%tls_dhparam%& were set to "none".
18215
18216 If this option expands to the string "none", then no DH parameters will be
18217 loaded by Exim.
18218
18219 If this option expands to the string "historic" and Exim is using GnuTLS, then
18220 Exim will attempt to load a file from inside the spool directory.  If the file
18221 does not exist, Exim will attempt to create it.
18222 See section &<<SECTgnutlsparam>>& for further details.
18223
18224 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18225 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18226
18227 In older versions of Exim the default was the 2048 bit prime described in section
18228 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18229 in IKE is assigned number 23.
18230
18231 Otherwise, the option must expand to the name used by Exim for any of a number
18232 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18233 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18234 the number used by IKE, or "default" which corresponds to
18235 &`exim.dev.20160529.3`&.
18236
18237 The available standard primes are:
18238 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18239 &`ike1`&, &`ike2`&, &`ike5`&,
18240 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18241 &`ike22`&, &`ike23`& and &`ike24`&.
18242
18243 The available additional primes are:
18244 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18245
18246 Some of these will be too small to be accepted by clients.
18247 Some may be too large to be accepted by clients.
18248 The open cryptographic community has suspicions about the integrity of some
18249 of the later IKE values, which led into RFC7919 providing new fixed constants
18250 (the "ffdhe" identifiers).
18251
18252 At this point, all of the "ike" values should be considered obsolete;
18253 they're still in Exim to avoid breaking unusual configurations, but are
18254 candidates for removal the next time we have backwards-incompatible changes.
18255
18256 The TLS protocol does not negotiate an acceptable size for this; clients tend
18257 to hard-drop connections if what is offered by the server is unacceptable,
18258 whether too large or too small, and there's no provision for the client to
18259 tell the server what these constraints are.  Thus, as a server operator, you
18260 need to make an educated guess as to what is most likely to work for your
18261 userbase.
18262
18263 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18264 is most likely to maximise interoperability.  The upper bound comes from
18265 applications using the Mozilla Network Security Services (NSS) library, which
18266 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18267 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18268 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18269 acceptable bound from 1024 to 2048.
18270
18271
18272 .option tls_eccurve main string&!! &`auto`&
18273 .cindex TLS "EC cryptography"
18274 This option selects a EC curve for use by Exim when used with OpenSSL.
18275 It has no effect when Exim is used with GnuTLS.
18276
18277 After expansion it must contain a valid EC curve parameter, such as
18278 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18279 for valid selections.
18280
18281 For OpenSSL versions before (and not including) 1.0.2, the string
18282 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18283 &`auto`& tells the library to choose.
18284
18285 If the option expands to an empty string, no EC curves will be enabled.
18286
18287
18288 .option tls_ocsp_file main string&!! unset
18289 .cindex TLS "certificate status"
18290 .cindex TLS "OCSP proof file"
18291 This option
18292 must if set expand to the absolute path to a file which contains a current
18293 status proof for the server's certificate, as obtained from the
18294 Certificate Authority.
18295
18296 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18297 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18298
18299 For OpenSSL 1.1.0 or later, and
18300 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18301 of files, to match a list given for the &%tls_certificate%& option.
18302 The ordering of the two lists must match.
18303 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18304
18305 The file(s) should be in DER format,
18306 except for GnuTLS 3.6.3 or later
18307 or for OpenSSL,
18308 when an optional filetype prefix can be used.
18309 The prefix must be one of "DER" or "PEM", followed by
18310 a single space.  If one is used it sets the format for subsequent
18311 files in the list; the initial format is DER.
18312 If multiple proofs are wanted, for multiple chain elements
18313 (this only works under TLS1.3)
18314 they must be coded as a combined OCSP response.
18315
18316 Although GnuTLS will accept PEM files with multiple separate
18317 PEM blobs (ie. separate OCSP responses), it sends them in the
18318 TLS Certificate record interleaved with the certificates of the chain;
18319 although a GnuTLS client is happy with that, an OpenSSL client is not.
18320
18321 .option tls_on_connect_ports main "string list" unset
18322 .cindex SSMTP
18323 .cindex SMTPS
18324 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18325 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18326 set up without waiting for the client to issue a STARTTLS command. For
18327 further details, see section &<<SECTsupobssmt>>&.
18328
18329
18330
18331 .option tls_privatekey main string list&!! unset
18332 .cindex "TLS" "server private key; location of"
18333 The value of this option is expanded, and must then be a list of absolute paths to
18334 files which contains the server's private keys.
18335 If this option is unset, or if
18336 the expansion is forced to fail, or the result is an empty string, the private
18337 key is assumed to be in the same file as the server's certificates. See chapter
18338 &<<CHAPTLS>>& for further details.
18339
18340 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18341
18342
18343 .option tls_remember_esmtp main boolean false
18344 .cindex "TLS" "esmtp state; remembering"
18345 .cindex "TLS" "broken clients"
18346 If this option is set true, Exim violates the RFCs by remembering that it is in
18347 &"esmtp"& state after successfully negotiating a TLS session. This provides
18348 support for broken clients that fail to send a new EHLO after starting a
18349 TLS session.
18350
18351
18352 .option tls_require_ciphers main string&!! unset
18353 .cindex "TLS" "requiring specific ciphers"
18354 .cindex "cipher" "requiring specific"
18355 This option controls which ciphers can be used for incoming TLS connections.
18356 The &(smtp)& transport has an option of the same name for controlling outgoing
18357 connections. This option is expanded for each connection, so can be varied for
18358 different clients if required. The value of this option must be a list of
18359 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18360 in somewhat different ways. If GnuTLS is being used, the client controls the
18361 preference order of the available ciphers. Details are given in sections
18362 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18363
18364
18365 .new
18366 .option tls_resumption_hosts main "host list&!!" unset
18367 .cindex TLS resumption
18368 This option controls which connections to offer the TLS resumption feature.
18369 See &<<SECTresumption>>& for details.
18370 .wen
18371
18372
18373 .option tls_try_verify_hosts main "host list&!!" unset
18374 .cindex "TLS" "client certificate verification"
18375 .cindex "certificate" "verification of client"
18376 See &%tls_verify_hosts%& below.
18377
18378
18379 .option tls_verify_certificates main string&!! system
18380 .cindex "TLS" "client certificate verification"
18381 .cindex "certificate" "verification of client"
18382 The value of this option is expanded, and must then be either the
18383 word "system"
18384 or the absolute path to
18385 a file or directory containing permitted certificates for clients that
18386 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18387
18388 The "system" value for the option will use a
18389 system default location compiled into the SSL library.
18390 This is not available for GnuTLS versions preceding 3.0.20,
18391 and will be taken as empty; an explicit location
18392 must be specified.
18393
18394 The use of a directory for the option value is not available for GnuTLS versions
18395 preceding 3.3.6 and a single file must be used.
18396
18397 With OpenSSL the certificates specified
18398 explicitly
18399 either by file or directory
18400 are added to those given by the system default location.
18401
18402 These certificates should be for the certificate authorities trusted, rather
18403 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18404 the value is a file then the certificates are sent by Exim as a server to
18405 connecting clients, defining the list of accepted certificate authorities.
18406 Thus the values defined should be considered public data.  To avoid this,
18407 use the explicit directory version.
18408
18409 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18410
18411 A forced expansion failure or setting to an empty string is equivalent to
18412 being unset.
18413
18414
18415 .option tls_verify_hosts main "host list&!!" unset
18416 .cindex "TLS" "client certificate verification"
18417 .cindex "certificate" "verification of client"
18418 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18419 certificates from clients. The expected certificates are defined by
18420 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18421 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18422 &%tls_verify_certificates%& is not set.
18423
18424 Any client that matches &%tls_verify_hosts%& is constrained by
18425 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18426 present one of the listed certificates. If it does not, the connection is
18427 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18428 the host to use TLS. It can still send SMTP commands through unencrypted
18429 connections. Forcing a client to use TLS has to be done separately using an
18430 ACL to reject inappropriate commands when the connection is not encrypted.
18431
18432 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18433 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18434 certificate and checks it against &%tls_verify_certificates%&, but does not
18435 abort the connection if there is no certificate or if it does not match. This
18436 state can be detected in an ACL, which makes it possible to implement policies
18437 such as &"accept for relay only if a verified certificate has been received,
18438 but accept for local delivery if encrypted, even without a verified
18439 certificate"&.
18440
18441 Client hosts that match neither of these lists are not asked to present
18442 certificates.
18443
18444
18445 .option trusted_groups main "string list&!!" unset
18446 .cindex "trusted groups"
18447 .cindex "groups" "trusted"
18448 This option is expanded just once, at the start of Exim's processing. If this
18449 option is set, any process that is running in one of the listed groups, or
18450 which has one of them as a supplementary group, is trusted. The groups can be
18451 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18452 details of what trusted callers are permitted to do. If neither
18453 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18454 are trusted.
18455
18456 .option trusted_users main "string list&!!" unset
18457 .cindex "trusted users"
18458 .cindex "user" "trusted"
18459 This option is expanded just once, at the start of Exim's processing. If this
18460 option is set, any process that is running as one of the listed users is
18461 trusted. The users can be specified numerically or by name. See section
18462 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18463 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18464 Exim user are trusted.
18465
18466 .option unknown_login main string&!! unset
18467 .cindex "uid (user id)" "unknown caller"
18468 .vindex "&$caller_uid$&"
18469 This is a specialized feature for use in unusual configurations. By default, if
18470 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18471 gives up. The &%unknown_login%& option can be used to set a login name to be
18472 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18473 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18474 is used for the user's real name (gecos field), unless this has been set by the
18475 &%-F%& option.
18476
18477 .option unknown_username main string unset
18478 See &%unknown_login%&.
18479
18480 .option untrusted_set_sender main "address list&!!" unset
18481 .cindex "trusted users"
18482 .cindex "sender" "setting by untrusted user"
18483 .cindex "untrusted user setting sender"
18484 .cindex "user" "untrusted setting sender"
18485 .cindex "envelope from"
18486 .cindex "envelope sender"
18487 When an untrusted user submits a message to Exim using the standard input, Exim
18488 normally creates an envelope sender address from the user's login and the
18489 default qualification domain. Data from the &%-f%& option (for setting envelope
18490 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18491 is used) is ignored.
18492
18493 However, untrusted users are permitted to set an empty envelope sender address,
18494 to declare that a message should never generate any bounces. For example:
18495 .code
18496 exim -f '<>' user@domain.example
18497 .endd
18498 .vindex "&$sender_ident$&"
18499 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18500 other envelope sender addresses in a controlled way. When it is set, untrusted
18501 users are allowed to set envelope sender addresses that match any of the
18502 patterns in the list. Like all address lists, the string is expanded. The
18503 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18504 users to setting senders that start with their login ids
18505 followed by a hyphen
18506 by a setting like this:
18507 .code
18508 untrusted_set_sender = ^$sender_ident-
18509 .endd
18510 If you want to allow untrusted users to set envelope sender addresses without
18511 restriction, you can use
18512 .code
18513 untrusted_set_sender = *
18514 .endd
18515 The &%untrusted_set_sender%& option applies to all forms of local input, but
18516 only to the setting of the envelope sender. It does not permit untrusted users
18517 to use the other options which trusted user can use to override message
18518 parameters. Furthermore, it does not stop Exim from removing an existing
18519 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18520 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18521 overriding these actions. The handling of the &'Sender:'& header is also
18522 described in section &<<SECTthesenhea>>&.
18523
18524 The log line for a message's arrival shows the envelope sender following
18525 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18526 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18527 envelope sender address, the user's login is shown in parentheses after the
18528 sender address.
18529
18530
18531 .option uucp_from_pattern main string "see below"
18532 .cindex "&""From""& line"
18533 .cindex "UUCP" "&""From""& line"
18534 Some applications that pass messages to an MTA via a command line interface use
18535 an initial line starting with &"From&~"& to pass the envelope sender. In
18536 particular, this is used by UUCP software. Exim recognizes such a line by means
18537 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18538 matches, the sender address is constructed by expanding the contents of
18539 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18540 default pattern recognizes lines in the following two forms:
18541 .code
18542 From ph10 Fri Jan  5 12:35 GMT 1996
18543 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18544 .endd
18545 The pattern can be seen by running
18546 .code
18547 exim -bP uucp_from_pattern
18548 .endd
18549 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18550 year in the second case. The first word after &"From&~"& is matched in the
18551 regular expression by a parenthesized subpattern. The default value for
18552 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18553 (&"ph10"& in the example above) as the message's sender. See also
18554 &%ignore_fromline_hosts%&.
18555
18556
18557 .option uucp_from_sender main string&!! &`$1`&
18558 See &%uucp_from_pattern%& above.
18559
18560
18561 .option warn_message_file main string&!! unset
18562 .cindex "warning of delay" "customizing the message"
18563 .cindex "customizing" "warning message"
18564 This option defines a template file containing paragraphs of text to be used
18565 for constructing the warning message which is sent by Exim when a message has
18566 been in the queue for a specified amount of time, as specified by
18567 &%delay_warning%&. Details of the file's contents are given in chapter
18568 &<<CHAPemsgcust>>&.
18569 .cindex warn_message_file "tainted data"
18570 The option is expanded to give the file path, which must be
18571 absolute and untainted.
18572 See also &%bounce_message_file%&.
18573
18574
18575 .option write_rejectlog main boolean true
18576 .cindex "reject log" "disabling"
18577 If this option is set false, Exim no longer writes anything to the reject log.
18578 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18579 .ecindex IIDconfima
18580 .ecindex IIDmaiconf
18581
18582
18583
18584
18585 . ////////////////////////////////////////////////////////////////////////////
18586 . ////////////////////////////////////////////////////////////////////////////
18587
18588 .chapter "Generic options for routers" "CHAProutergeneric"
18589 .scindex IIDgenoprou1 "options" "generic; for routers"
18590 .scindex IIDgenoprou2 "generic options" "router"
18591 This chapter describes the generic options that apply to all routers.
18592 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18593
18594 For a general description of how a router operates, see sections
18595 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18596 which the preconditions are tested. The order of expansion of the options that
18597 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18598 &%headers_remove%&, &%transport%&.
18599
18600
18601
18602 .option address_data routers string&!! unset
18603 .cindex "router" "data attached to address"
18604 The string is expanded just before the router is run, that is, after all the
18605 precondition tests have succeeded. If the expansion is forced to fail, the
18606 router declines, the value of &%address_data%& remains unchanged, and the
18607 &%more%& option controls what happens next. Other expansion failures cause
18608 delivery of the address to be deferred.
18609
18610 .vindex "&$address_data$&"
18611 When the expansion succeeds, the value is retained with the address, and can be
18612 accessed using the variable &$address_data$& in the current router, subsequent
18613 routers, and the eventual transport.
18614
18615 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18616 that runs a user's filter file, the contents of &$address_data$& are accessible
18617 in the filter. This is not normally a problem, because such data is usually
18618 either not confidential or it &"belongs"& to the current user, but if you do
18619 put confidential data into &$address_data$& you need to remember this point.
18620
18621 Even if the router declines or passes, the value of &$address_data$& remains
18622 with the address, though it can be changed by another &%address_data%& setting
18623 on a subsequent router. If a router generates child addresses, the value of
18624 &$address_data$& propagates to them. This also applies to the special kind of
18625 &"child"& that is generated by a router with the &%unseen%& option.
18626
18627 The idea of &%address_data%& is that you can use it to look up a lot of data
18628 for the address once, and then pick out parts of the data later. For example,
18629 you could use a single LDAP lookup to return a string of the form
18630 .code
18631 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18632 .endd
18633 In the transport you could pick out the mailbox by a setting such as
18634 .code
18635 file = ${extract{mailbox}{$address_data}}
18636 .endd
18637 This makes the configuration file less messy, and also reduces the number of
18638 lookups (though Exim does cache lookups).
18639
18640 See also the &%set%& option below.
18641
18642 .vindex "&$sender_address_data$&"
18643 .vindex "&$address_data$&"
18644 The &%address_data%& facility is also useful as a means of passing information
18645 from one router to another, and from a router to a transport. In addition, if
18646 &$address_data$& is set by a router when verifying a recipient address from an
18647 ACL, it remains available for use in the rest of the ACL statement. After
18648 verifying a sender, the value is transferred to &$sender_address_data$&.
18649
18650
18651
18652 .option address_test routers&!? boolean true
18653 .oindex "&%-bt%&"
18654 .cindex "router" "skipping when address testing"
18655 If this option is set false, the router is skipped when routing is being tested
18656 by means of the &%-bt%& command line option. This can be a convenience when
18657 your first router sends messages to an external scanner, because it saves you
18658 having to set the &"already scanned"& indicator when testing real address
18659 routing.
18660
18661
18662
18663 .option cannot_route_message routers string&!! unset
18664 .cindex "router" "customizing &""cannot route""& message"
18665 .cindex "customizing" "&""cannot route""& message"
18666 This option specifies a text message that is used when an address cannot be
18667 routed because Exim has run out of routers. The default message is
18668 &"Unrouteable address"&. This option is useful only on routers that have
18669 &%more%& set false, or on the very last router in a configuration, because the
18670 value that is used is taken from the last router that is considered. This
18671 includes a router that is skipped because its preconditions are not met, as
18672 well as a router that declines. For example, using the default configuration,
18673 you could put:
18674 .code
18675 cannot_route_message = Remote domain not found in DNS
18676 .endd
18677 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18678 and
18679 .code
18680 cannot_route_message = Unknown local user
18681 .endd
18682 on the final router that checks for local users. If string expansion fails for
18683 this option, the default message is used. Unless the expansion failure was
18684 explicitly forced, a message about the failure is written to the main and panic
18685 logs, in addition to the normal message about the routing failure.
18686
18687
18688 .option caseful_local_part routers boolean false
18689 .cindex "case of local parts"
18690 .cindex "router" "case of local parts"
18691 By default, routers handle the local parts of addresses in a case-insensitive
18692 manner, though the actual case is preserved for transmission with the message.
18693 If you want the case of letters to be significant in a router, you must set
18694 this option true. For individual router options that contain address or local
18695 part lists (for example, &%local_parts%&), case-sensitive matching can be
18696 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18697 more details.
18698
18699 .vindex "&$local_part$&"
18700 .vindex "&$original_local_part$&"
18701 .vindex "&$parent_local_part$&"
18702 The value of the &$local_part$& variable is forced to lower case while a
18703 router is running unless &%caseful_local_part%& is set. When a router assigns
18704 an address to a transport, the value of &$local_part$& when the transport runs
18705 is the same as it was in the router. Similarly, when a router generates child
18706 addresses by aliasing or forwarding, the values of &$original_local_part$&
18707 and &$parent_local_part$& are those that were used by the redirecting router.
18708
18709 This option applies to the processing of an address by a router. When a
18710 recipient address is being processed in an ACL, there is a separate &%control%&
18711 modifier that can be used to specify case-sensitive processing within the ACL
18712 (see section &<<SECTcontrols>>&).
18713
18714
18715
18716 .option check_local_user routers&!? boolean false
18717 .cindex "local user, checking in router"
18718 .cindex "router" "checking for local user"
18719 .cindex "&_/etc/passwd_&"
18720 .vindex "&$home$&"
18721 When this option is true, Exim checks that the local part of the recipient
18722 address (with affixes removed if relevant) is the name of an account on the
18723 local system. The check is done by calling the &[getpwnam()]& function rather
18724 than trying to read &_/etc/passwd_& directly. This means that other methods of
18725 holding password data (such as NIS) are supported. If the local part is a local
18726 user, &$home$& is set from the password data, and can be tested in other
18727 preconditions that are evaluated after this one (the order of evaluation is
18728 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18729 overridden by &%router_home_directory%&. If the local part is not a local user,
18730 the router is skipped.
18731
18732 If you want to check that the local part is either the name of a local user
18733 or matches something else, you cannot combine &%check_local_user%& with a
18734 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18735 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18736 setting to achieve this. For example:
18737 .code
18738 local_parts = passwd;$local_part : lsearch;/etc/other/users
18739 .endd
18740 Note, however, that the side effects of &%check_local_user%& (such as setting
18741 up a home directory) do not occur when a &(passwd)& lookup is used in a
18742 &%local_parts%& (or any other) precondition.
18743
18744
18745
18746 .option condition routers&!? string&!! unset
18747 .cindex "router" "customized precondition"
18748 This option specifies a general precondition test that has to succeed for the
18749 router to be called. The &%condition%& option is the last precondition to be
18750 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18751 result is a forced failure, or an empty string, or one of the strings &"0"& or
18752 &"no"& or &"false"& (checked without regard to the case of the letters), the
18753 router is skipped, and the address is offered to the next one.
18754
18755 If the result is any other value, the router is run (as this is the last
18756 precondition to be evaluated, all the other preconditions must be true).
18757
18758 This option is unusual in that multiple &%condition%& options may be present.
18759 All &%condition%& options must succeed.
18760
18761 The &%condition%& option provides a means of applying custom conditions to the
18762 running of routers. Note that in the case of a simple conditional expansion,
18763 the default expansion values are exactly what is wanted. For example:
18764 .code
18765 condition = ${if >{$message_age}{600}}
18766 .endd
18767 Because of the default behaviour of the string expansion, this is equivalent to
18768 .code
18769 condition = ${if >{$message_age}{600}{true}{}}
18770 .endd
18771
18772 A multiple condition example, which succeeds:
18773 .code
18774 condition = ${if >{$message_age}{600}}
18775 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18776 condition = foobar
18777 .endd
18778
18779 If the expansion fails (other than forced failure) delivery is deferred. Some
18780 of the other precondition options are common special cases that could in fact
18781 be specified using &%condition%&.
18782
18783 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18784 are far older, and use one set of semantics.  ACLs are newer and when
18785 they were created, the ACL &%condition%& process was given far stricter
18786 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18787 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18788 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18789 Router rules processing behavior.
18790
18791 This is best illustrated in an example:
18792 .code
18793 # If used in an ACL condition will fail with a syntax error, but
18794 # in a router condition any extra characters are treated as a string
18795
18796 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18797 true {yes} {no}}
18798
18799 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18800  {yes} {no}}
18801 .endd
18802 In each example above, the &%if%& statement actually ends after
18803 &"{google.com}}"&.  Since no true or false braces were defined, the
18804 default &%if%& behavior is to return a boolean true or a null answer
18805 (which evaluates to false). The rest of the line is then treated as a
18806 string. So the first example resulted in the boolean answer &"true"&
18807 with the string &" {yes} {no}}"& appended to it. The second example
18808 resulted in the null output (indicating false) with the string
18809 &" {yes} {no}}"& appended to it.
18810
18811 In fact you can put excess forward braces in too.  In the router
18812 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18813 mean something, like after a &"$"& or when required as part of a
18814 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18815 string characters.
18816
18817 Thus, in a Router, the above expansion strings will both always evaluate
18818 true, as the result of expansion is a non-empty string which doesn't
18819 match an explicit false value.  This can be tricky to debug.  By
18820 contrast, in an ACL either of those strings will always result in an
18821 expansion error because the result doesn't look sufficiently boolean.
18822
18823
18824 .option debug_print routers string&!! unset
18825 .cindex "testing" "variables in drivers"
18826 If this option is set and debugging is enabled (see the &%-d%& command line
18827 option) or in address-testing mode (see the &%-bt%& command line option),
18828 the string is expanded and included in the debugging output.
18829 If expansion of the string fails, the error message is written to the debugging
18830 output, and Exim carries on processing.
18831 This option is provided to help with checking out the values of variables and
18832 so on when debugging router configurations. For example, if a &%condition%&
18833 option appears not to be working, &%debug_print%& can be used to output the
18834 variables it references. The output happens after checks for &%domains%&,
18835 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18836 are tested. A newline is added to the text if it does not end with one.
18837 The variable &$router_name$& contains the name of the router.
18838
18839
18840
18841 .option disable_logging routers boolean false
18842 If this option is set true, nothing is logged for any routing errors
18843 or for any deliveries caused by this router. You should not set this option
18844 unless you really, really know what you are doing. See also the generic
18845 transport option of the same name.
18846
18847 .option dnssec_request_domains routers "domain list&!!" *
18848 .cindex "MX record" "security"
18849 .cindex "DNSSEC" "MX lookup"
18850 .cindex "security" "MX lookup"
18851 .cindex "DNS" "DNSSEC"
18852 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18853 the dnssec request bit set.
18854 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18855
18856 .option dnssec_require_domains routers "domain list&!!" unset
18857 .cindex "MX record" "security"
18858 .cindex "DNSSEC" "MX lookup"
18859 .cindex "security" "MX lookup"
18860 .cindex "DNS" "DNSSEC"
18861 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18862 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18863 (AD bit) set will be ignored and logged as a host-lookup failure.
18864 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18865
18866
18867 .option domains routers&!? "domain list&!!" unset
18868 .cindex "router" "restricting to specific domains"
18869 .vindex "&$domain_data$&"
18870 If this option is set, the router is skipped unless the current domain matches
18871 the list. If the match is achieved by means of a file lookup, the data that the
18872 lookup returned for the domain is placed in &$domain_data$& for use in string
18873 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18874 a list of the order in which preconditions are evaluated.
18875
18876
18877
18878 .option driver routers string unset
18879 This option must always be set. It specifies which of the available routers is
18880 to be used.
18881
18882
18883 .option dsn_lasthop routers boolean false
18884 .cindex "DSN" "success"
18885 .cindex "Delivery Status Notification" "success"
18886 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18887 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18888 instead send a success DSN as if the next hop does not support DSN.
18889 Not effective on redirect routers.
18890
18891
18892
18893 .option errors_to routers string&!! unset
18894 .cindex "envelope from"
18895 .cindex "envelope sender"
18896 .cindex "router" "changing address for errors"
18897 If a router successfully handles an address, it may assign the address to a
18898 transport for delivery or it may generate child addresses. In both cases, if
18899 there is a delivery problem during later processing, the resulting bounce
18900 message is sent to the address that results from expanding this string,
18901 provided that the address verifies successfully. The &%errors_to%& option is
18902 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18903
18904 The &%errors_to%& setting associated with an address can be overridden if it
18905 subsequently passes through other routers that have their own &%errors_to%&
18906 settings, or if the message is delivered by a transport with a &%return_path%&
18907 setting.
18908
18909 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18910 the expansion fails to verify, the errors address associated with the incoming
18911 address is used. At top level, this is the envelope sender. A non-forced
18912 expansion failure causes delivery to be deferred.
18913
18914 If an address for which &%errors_to%& has been set ends up being delivered over
18915 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18916 any bounces that are generated by other MTAs on the delivery route are also
18917 sent there. You can set &%errors_to%& to the empty string by either of these
18918 settings:
18919 .code
18920 errors_to =
18921 errors_to = ""
18922 .endd
18923 An expansion item that yields an empty string has the same effect. If you do
18924 this, a locally detected delivery error for addresses processed by this router
18925 no longer gives rise to a bounce message; the error is discarded. If the
18926 address is delivered to a remote host, the return path is set to &`<>`&, unless
18927 overridden by the &%return_path%& option on the transport.
18928
18929 .vindex "&$address_data$&"
18930 If for some reason you want to discard local errors, but use a non-empty
18931 MAIL command for remote delivery, you can preserve the original return
18932 path in &$address_data$& in the router, and reinstate it in the transport by
18933 setting &%return_path%&.
18934
18935 The most common use of &%errors_to%& is to direct mailing list bounces to the
18936 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18937 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18938
18939
18940
18941 .option expn routers&!? boolean true
18942 .cindex "address" "testing"
18943 .cindex "testing" "addresses"
18944 .cindex "EXPN" "router skipping"
18945 .cindex "router" "skipping for EXPN"
18946 If this option is turned off, the router is skipped when testing an address
18947 as a result of processing an SMTP EXPN command. You might, for example,
18948 want to turn it off on a router for users' &_.forward_& files, while leaving it
18949 on for the system alias file.
18950 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18951 are evaluated.
18952
18953 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18954 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18955 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18956
18957
18958
18959 .option fail_verify routers boolean false
18960 .cindex "router" "forcing verification failure"
18961 Setting this option has the effect of setting both &%fail_verify_sender%& and
18962 &%fail_verify_recipient%& to the same value.
18963
18964
18965
18966 .option fail_verify_recipient routers boolean false
18967 If this option is true and an address is accepted by this router when
18968 verifying a recipient, verification fails.
18969
18970
18971
18972 .option fail_verify_sender routers boolean false
18973 If this option is true and an address is accepted by this router when
18974 verifying a sender, verification fails.
18975
18976
18977
18978 .option fallback_hosts routers "string list" unset
18979 .cindex "router" "fallback hosts"
18980 .cindex "fallback" "hosts specified on router"
18981 String expansion is not applied to this option. The argument must be a
18982 colon-separated list of host names or IP addresses. The list separator can be
18983 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18984 each name or address. In fact, the format of each item is exactly the same as
18985 defined for the list of hosts in a &(manualroute)& router (see section
18986 &<<SECTformatonehostitem>>&).
18987
18988 If a router queues an address for a remote transport, this host list is
18989 associated with the address, and used instead of the transport's fallback host
18990 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18991 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18992 transport for further details.
18993
18994
18995 .option group routers string&!! "see below"
18996 .cindex "gid (group id)" "local delivery"
18997 .cindex "local transports" "uid and gid"
18998 .cindex "transport" "local"
18999 .cindex "router" "setting group"
19000 When a router queues an address for a transport, and the transport does not
19001 specify a group, the group given here is used when running the delivery
19002 process.
19003 The group may be specified numerically or by name. If expansion fails, the
19004 error is logged and delivery is deferred.
19005 The default is unset, unless &%check_local_user%& is set, when the default
19006 is taken from the password information. See also &%initgroups%& and &%user%&
19007 and the discussion in chapter &<<CHAPenvironment>>&.
19008
19009
19010
19011 .option headers_add routers list&!! unset
19012 .cindex "header lines" "adding"
19013 .cindex "router" "adding header lines"
19014 This option specifies a list of text headers,
19015 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19016 that is associated with any addresses that are accepted by the router.
19017 Each item is separately expanded, at routing time.  However, this
19018 option has no effect when an address is just being verified. The way in which
19019 the text is used to add header lines at transport time is described in section
19020 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19021 message is in the process of being transported. This means that references to
19022 header lines in string expansions in the transport's configuration do not
19023 &"see"& the added header lines.
19024
19025 The &%headers_add%& option is expanded after &%errors_to%&, but before
19026 &%headers_remove%& and &%transport%&. If an item is empty, or if
19027 an item expansion is forced to fail, the item has no effect. Other expansion
19028 failures are treated as configuration errors.
19029
19030 Unlike most options, &%headers_add%& can be specified multiple times
19031 for a router; all listed headers are added.
19032
19033 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19034 router that has the &%one_time%& option set.
19035
19036 .cindex "duplicate addresses"
19037 .oindex "&%unseen%&"
19038 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19039 additions are deleted when the address is passed on to subsequent routers.
19040 For a &%redirect%& router, if a generated address is the same as the incoming
19041 address, this can lead to duplicate addresses with different header
19042 modifications. Exim does not do duplicate deliveries (except, in certain
19043 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19044 which of the duplicates is discarded, so this ambiguous situation should be
19045 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19046
19047
19048
19049 .option headers_remove routers list&!! unset
19050 .cindex "header lines" "removing"
19051 .cindex "router" "removing header lines"
19052 This option specifies a list of text headers,
19053 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19054 that is associated with any addresses that are accepted by the router.
19055 However, the option has no effect when an address is just being verified.
19056 Each list item is separately expanded, at transport time.
19057 If an item ends in *, it will match any header with the given prefix.
19058 The way in which
19059 the text is used to remove header lines at transport time is described in
19060 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19061 the message is in the process of being transported. This means that references
19062 to header lines in string expansions in the transport's configuration still
19063 &"see"& the original header lines.
19064
19065 The &%headers_remove%& option is handled after &%errors_to%& and
19066 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19067 the item has no effect. Other expansion failures are treated as configuration
19068 errors.
19069
19070 Unlike most options, &%headers_remove%& can be specified multiple times
19071 for a router; all listed headers are removed.
19072
19073 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19074 router that has the &%one_time%& option set.
19075
19076 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19077 removal requests are deleted when the address is passed on to subsequent
19078 routers, and this can lead to problems with duplicates -- see the similar
19079 warning for &%headers_add%& above.
19080
19081 &*Warning 3*&: Because of the separate expansion of the list items,
19082 items that contain a list separator must have it doubled.
19083 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19084
19085
19086
19087 .option ignore_target_hosts routers "host list&!!" unset
19088 .cindex "IP address" "discarding"
19089 .cindex "router" "discarding IP addresses"
19090 Although this option is a host list, it should normally contain IP address
19091 entries rather than names. If any host that is looked up by the router has an
19092 IP address that matches an item in this list, Exim behaves as if that IP
19093 address did not exist. This option allows you to cope with rogue DNS entries
19094 like
19095 .code
19096 remote.domain.example.  A  127.0.0.1
19097 .endd
19098 by setting
19099 .code
19100 ignore_target_hosts = 127.0.0.1
19101 .endd
19102 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19103 discarded in this way, the router declines. In a conventional configuration, an
19104 attempt to mail to such a domain would normally provoke the &"unrouteable
19105 domain"& error, and an attempt to verify an address in the domain would fail.
19106 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19107 router declines if presented with one of the listed addresses.
19108
19109 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19110 means of the first or the second of the following settings, respectively:
19111 .code
19112 ignore_target_hosts = 0.0.0.0/0
19113 ignore_target_hosts = <; 0::0/0
19114 .endd
19115 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19116 in the second line matches all IPv6 addresses.
19117
19118 This option may also be useful for ignoring link-local and site-local IPv6
19119 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19120 is expanded before use as a list, it is possible to make it dependent on the
19121 domain that is being routed.
19122
19123 .vindex "&$host_address$&"
19124 During its expansion, &$host_address$& is set to the IP address that is being
19125 checked.
19126
19127 .option initgroups routers boolean false
19128 .cindex "additional groups"
19129 .cindex "groups" "additional"
19130 .cindex "local transports" "uid and gid"
19131 .cindex "transport" "local"
19132 If the router queues an address for a transport, and this option is true, and
19133 the uid supplied by the router is not overridden by the transport, the
19134 &[initgroups()]& function is called when running the transport to ensure that
19135 any additional groups associated with the uid are set up. See also &%group%&
19136 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19137
19138
19139
19140 .option local_part_prefix routers&!? "string list" unset
19141 .cindex affix "router precondition"
19142 .cindex "router" "prefix for local part"
19143 .cindex "prefix" "for local part, used in router"
19144 If this option is set, the router is skipped unless the local part starts with
19145 one of the given strings, or &%local_part_prefix_optional%& is true. See
19146 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19147 evaluated.
19148
19149 The list is scanned from left to right, and the first prefix that matches is
19150 used. A limited form of wildcard is available; if the prefix begins with an
19151 asterisk, it matches the longest possible sequence of arbitrary characters at
19152 the start of the local part. An asterisk should therefore always be followed by
19153 some character that does not occur in normal local parts.
19154 .cindex "multiple mailboxes"
19155 .cindex "mailbox" "multiple"
19156 Wildcarding can be used to set up multiple user mailboxes, as described in
19157 section &<<SECTmulbox>>&.
19158
19159 .vindex "&$local_part$&"
19160 .vindex "&$local_part_prefix$&"
19161 During the testing of the &%local_parts%& option, and while the router is
19162 running, the prefix is removed from the local part, and is available in the
19163 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19164 the router accepts the address, this remains true during subsequent delivery by
19165 a transport. In particular, the local part that is transmitted in the RCPT
19166 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19167 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19168 the relevant transport.
19169
19170 .vindex &$local_part_prefix_v$&
19171 If wildcarding (above) was used then the part of the prefix matching the
19172 wildcard is available in &$local_part_prefix_v$&.
19173
19174 When an address is being verified, &%local_part_prefix%& affects only the
19175 behaviour of the router. If the callout feature of verification is in use, this
19176 means that the full address, including the prefix, will be used during the
19177 callout.
19178
19179 The prefix facility is commonly used to handle local parts of the form
19180 &%owner-something%&. Another common use is to support local parts of the form
19181 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19182 to tell a user their forwarding is broken &-- by placing a router like this one
19183 immediately before the router that handles &_.forward_& files:
19184 .code
19185 real_localuser:
19186   driver = accept
19187   local_part_prefix = real-
19188   check_local_user
19189   transport = local_delivery
19190 .endd
19191 For security, it would probably be a good idea to restrict the use of this
19192 router to locally-generated messages, using a condition such as this:
19193 .code
19194   condition = ${if match {$sender_host_address}\
19195                          {\N^(|127\.0\.0\.1)$\N}}
19196 .endd
19197
19198 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19199 both conditions must be met if not optional. Care must be taken if wildcards
19200 are used in both a prefix and a suffix on the same router. Different
19201 separator characters must be used to avoid ambiguity.
19202
19203
19204 .option local_part_prefix_optional routers boolean false
19205 See &%local_part_prefix%& above.
19206
19207
19208
19209 .option local_part_suffix routers&!? "string list" unset
19210 .cindex "router" "suffix for local part"
19211 .cindex "suffix for local part" "used in router"
19212 This option operates in the same way as &%local_part_prefix%&, except that the
19213 local part must end (rather than start) with the given string, the
19214 &%local_part_suffix_optional%& option determines whether the suffix is
19215 mandatory, and the wildcard * character, if present, must be the last
19216 character of the suffix. This option facility is commonly used to handle local
19217 parts of the form &%something-request%& and multiple user mailboxes of the form
19218 &%username-foo%&.
19219
19220
19221 .option local_part_suffix_optional routers boolean false
19222 See &%local_part_suffix%& above.
19223
19224
19225
19226 .option local_parts routers&!? "local part list&!!" unset
19227 .cindex "router" "restricting to specific local parts"
19228 .cindex "local part" "checking in router"
19229 The router is run only if the local part of the address matches the list.
19230 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19231 are evaluated, and
19232 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19233 string is expanded, it is possible to make it depend on the domain, for
19234 example:
19235 .code
19236 local_parts = dbm;/usr/local/specials/$domain
19237 .endd
19238 .vindex "&$local_part_data$&"
19239 If the match is achieved by a lookup, the data that the lookup returned
19240 for the local part is placed in the variable &$local_part_data$& for use in
19241 expansions of the router's private options. You might use this option, for
19242 example, if you have a large number of local virtual domains, and you want to
19243 send all postmaster mail to the same place without having to set up an alias in
19244 each virtual domain:
19245 .code
19246 postmaster:
19247   driver = redirect
19248   local_parts = postmaster
19249   data = postmaster@real.domain.example
19250 .endd
19251
19252
19253 .option log_as_local routers boolean "see below"
19254 .cindex "log" "delivery line"
19255 .cindex "delivery" "log line format"
19256 Exim has two logging styles for delivery, the idea being to make local
19257 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19258 recipient address is given just as the local part, without a domain. The use of
19259 this style is controlled by this option. It defaults to true for the &(accept)&
19260 router, and false for all the others. This option applies only when a
19261 router assigns an address to a transport. It has no effect on routers that
19262 redirect addresses.
19263
19264
19265
19266 .option more routers boolean&!! true
19267 The result of string expansion for this option must be a valid boolean value,
19268 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19269 result causes an error, and delivery is deferred. If the expansion is forced to
19270 fail, the default value for the option (true) is used. Other failures cause
19271 delivery to be deferred.
19272
19273 If this option is set false, and the router declines to handle the address, no
19274 further routers are tried, routing fails, and the address is bounced.
19275 .oindex "&%self%&"
19276 However, if the router explicitly passes an address to the following router by
19277 means of the setting
19278 .code
19279 self = pass
19280 .endd
19281 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19282 does not affect the behaviour if one of the precondition tests fails. In that
19283 case, the address is always passed to the next router.
19284
19285 Note that &%address_data%& is not considered to be a precondition. If its
19286 expansion is forced to fail, the router declines, and the value of &%more%&
19287 controls what happens next.
19288
19289
19290 .option pass_on_timeout routers boolean false
19291 .cindex "timeout" "of router"
19292 .cindex "router" "timeout"
19293 If a router times out during a host lookup, it normally causes deferral of the
19294 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19295 router, overriding &%no_more%&. This may be helpful for systems that are
19296 intermittently connected to the Internet, or those that want to pass to a smart
19297 host any messages that cannot immediately be delivered.
19298
19299 There are occasional other temporary errors that can occur while doing DNS
19300 lookups. They are treated in the same way as a timeout, and this option
19301 applies to all of them.
19302
19303
19304
19305 .option pass_router routers string unset
19306 .cindex "router" "go to after &""pass""&"
19307 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19308 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19309 routing to continue, and overriding a false setting of &%more%&. When one of
19310 these routers returns &"pass"&, the address is normally handed on to the next
19311 router in sequence. This can be changed by setting &%pass_router%& to the name
19312 of another router. However (unlike &%redirect_router%&) the named router must
19313 be below the current router, to avoid loops. Note that this option applies only
19314 to the special case of &"pass"&. It does not apply when a router returns
19315 &"decline"& because it cannot handle an address.
19316
19317
19318
19319 .option redirect_router routers string unset
19320 .cindex "router" "start at after redirection"
19321 Sometimes an administrator knows that it is pointless to reprocess addresses
19322 generated from alias or forward files with the same router again. For
19323 example, if an alias file translates real names into login ids there is no
19324 point searching the alias file a second time, especially if it is a large file.
19325
19326 The &%redirect_router%& option can be set to the name of any router instance.
19327 It causes the routing of any generated addresses to start at the named router
19328 instead of at the first router. This option has no effect if the router in
19329 which it is set does not generate new addresses.
19330
19331
19332
19333 .option require_files routers&!? "string list&!!" unset
19334 .cindex "file" "requiring for router"
19335 .cindex "router" "requiring file existence"
19336 This option provides a general mechanism for predicating the running of a
19337 router on the existence or non-existence of certain files or directories.
19338 Before running a router, as one of its precondition tests, Exim works its way
19339 through the &%require_files%& list, expanding each item separately.
19340
19341 Because the list is split before expansion, any colons in expansion items must
19342 be doubled, or the facility for using a different list separator must be used
19343 (&<<SECTlistsepchange>>&).
19344 If any expansion is forced to fail, the item is ignored. Other expansion
19345 failures cause routing of the address to be deferred.
19346
19347 If any expanded string is empty, it is ignored. Otherwise, except as described
19348 below, each string must be a fully qualified file path, optionally preceded by
19349 &"!"&. The paths are passed to the &[stat()]& function to test for the
19350 existence of the files or directories. The router is skipped if any paths not
19351 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19352
19353 .cindex "NFS"
19354 If &[stat()]& cannot determine whether a file exists or not, delivery of
19355 the message is deferred. This can happen when NFS-mounted filesystems are
19356 unavailable.
19357
19358 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19359 options, so you cannot use it to check for the existence of a file in which to
19360 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19361 full list of the order in which preconditions are evaluated.) However, as
19362 these options are all expanded, you can use the &%exists%& expansion condition
19363 to make such tests. The &%require_files%& option is intended for checking files
19364 that the router may be going to use internally, or which are needed by a
19365 transport (e.g., &_.procmailrc_&).
19366
19367 During delivery, the &[stat()]& function is run as root, but there is a
19368 facility for some checking of the accessibility of a file by another user.
19369 This is not a proper permissions check, but just a &"rough"& check that
19370 operates as follows:
19371
19372 If an item in a &%require_files%& list does not contain any forward slash
19373 characters, it is taken to be the user (and optional group, separated by a
19374 comma) to be checked for subsequent files in the list. If no group is specified
19375 but the user is specified symbolically, the gid associated with the uid is
19376 used. For example:
19377 .code
19378 require_files = mail:/some/file
19379 require_files = $local_part_data:$home/.procmailrc
19380 .endd
19381 If a user or group name in a &%require_files%& list does not exist, the
19382 &%require_files%& condition fails.
19383
19384 Exim performs the check by scanning along the components of the file path, and
19385 checking the access for the given uid and gid. It checks for &"x"& access on
19386 directories, and &"r"& access on the final file. Note that this means that file
19387 access control lists, if the operating system has them, are ignored.
19388
19389 &*Warning 1*&: When the router is being run to verify addresses for an
19390 incoming SMTP message, Exim is not running as root, but under its own uid. This
19391 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19392 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19393 user is not permitted to read one of the directories on the file's path.
19394
19395 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19396 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19397 without root access. In this case, if a check for access by a particular user
19398 is requested, Exim creates a subprocess that runs as that user, and tries the
19399 check again in that process.
19400
19401 The default action for handling an unresolved EACCES is to consider it to
19402 be caused by a configuration error, and routing is deferred because the
19403 existence or non-existence of the file cannot be determined. However, in some
19404 circumstances it may be desirable to treat this condition as if the file did
19405 not exist. If the filename (or the exclamation mark that precedes the filename
19406 for non-existence) is preceded by a plus sign, the EACCES error is treated
19407 as if the file did not exist. For example:
19408 .code
19409 require_files = +/some/file
19410 .endd
19411 If the router is not an essential part of verification (for example, it
19412 handles users' &_.forward_& files), another solution is to set the &%verify%&
19413 option false so that the router is skipped when verifying.
19414
19415
19416
19417 .option retry_use_local_part routers boolean "see below"
19418 .cindex "hints database" "retry keys"
19419 .cindex "local part" "in retry keys"
19420 When a delivery suffers a temporary routing failure, a retry record is created
19421 in Exim's hints database. For addresses whose routing depends only on the
19422 domain, the key for the retry record should not involve the local part, but for
19423 other addresses, both the domain and the local part should be included.
19424 Usually, remote routing is of the former kind, and local routing is of the
19425 latter kind.
19426
19427 This option controls whether the local part is used to form the key for retry
19428 hints for addresses that suffer temporary errors while being handled by this
19429 router. The default value is true for any router that has any of
19430 &%check_local_user%&,
19431 &%local_parts%&,
19432 &%condition%&,
19433 &%local_part_prefix%&,
19434 &%local_part_suffix%&,
19435 &%senders%& or
19436 &%require_files%&
19437 set, and false otherwise. Note that this option does not apply to hints keys
19438 for transport delays; they are controlled by a generic transport option of the
19439 same name.
19440
19441 Failing to set this option when it is needed
19442 (because a remote router handles only some of the local-parts for a domain)
19443 can result in incorrect error messages being generated.
19444
19445 The setting of &%retry_use_local_part%& applies only to the router on which it
19446 appears. If the router generates child addresses, they are routed
19447 independently; this setting does not become attached to them.
19448
19449
19450
19451 .option router_home_directory routers string&!! unset
19452 .cindex "router" "home directory for"
19453 .cindex "home directory" "for router"
19454 .vindex "&$home$&"
19455 This option sets a home directory for use while the router is running. (Compare
19456 &%transport_home_directory%&, which sets a home directory for later
19457 transporting.) In particular, if used on a &(redirect)& router, this option
19458 sets a value for &$home$& while a filter is running. The value is expanded;
19459 forced expansion failure causes the option to be ignored &-- other failures
19460 cause the router to defer.
19461
19462 Expansion of &%router_home_directory%& happens immediately after the
19463 &%check_local_user%& test (if configured), before any further expansions take
19464 place.
19465 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19466 are evaluated.)
19467 While the router is running, &%router_home_directory%& overrides the value of
19468 &$home$& that came from &%check_local_user%&.
19469
19470 When a router accepts an address and assigns it to a local transport (including
19471 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19472 delivery), the home directory setting for the transport is taken from the first
19473 of these values that is set:
19474
19475 .ilist
19476 The &%home_directory%& option on the transport;
19477 .next
19478 The &%transport_home_directory%& option on the router;
19479 .next
19480 The password data if &%check_local_user%& is set on the router;
19481 .next
19482 The &%router_home_directory%& option on the router.
19483 .endlist
19484
19485 In other words, &%router_home_directory%& overrides the password data for the
19486 router, but not for the transport.
19487
19488
19489
19490 .option self routers string freeze
19491 .cindex "MX record" "pointing to local host"
19492 .cindex "local host" "MX pointing to"
19493 This option applies to those routers that use a recipient address to find a
19494 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19495 and &(manualroute)& routers.
19496 Certain configurations of the &(queryprogram)& router can also specify a list
19497 of remote hosts.
19498 Usually such routers are configured to send the message to a remote host via an
19499 &(smtp)& transport. The &%self%& option specifies what happens when the first
19500 host on the list turns out to be the local host.
19501 The way in which Exim checks for the local host is described in section
19502 &<<SECTreclocipadd>>&.
19503
19504 Normally this situation indicates either an error in Exim's configuration (for
19505 example, the router should be configured not to process this domain), or an
19506 error in the DNS (for example, the MX should not point to this host). For this
19507 reason, the default action is to log the incident, defer the address, and
19508 freeze the message. The following alternatives are provided for use in special
19509 cases:
19510
19511 .vlist
19512 .vitem &%defer%&
19513 Delivery of the message is tried again later, but the message is not frozen.
19514
19515 .vitem "&%reroute%&: <&'domain'&>"
19516 The domain is changed to the given domain, and the address is passed back to
19517 be reprocessed by the routers. No rewriting of headers takes place. This
19518 behaviour is essentially a redirection.
19519
19520 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19521 The domain is changed to the given domain, and the address is passed back to be
19522 reprocessed by the routers. Any headers that contain the original domain are
19523 rewritten.
19524
19525 .vitem &%pass%&
19526 .oindex "&%more%&"
19527 .vindex "&$self_hostname$&"
19528 The router passes the address to the next router, or to the router named in the
19529 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19530 subsequent routing and delivery, the variable &$self_hostname$& contains the
19531 name of the local host that the router encountered. This can be used to
19532 distinguish between different cases for hosts with multiple names. The
19533 combination
19534 .code
19535 self = pass
19536 no_more
19537 .endd
19538 ensures that only those addresses that routed to the local host are passed on.
19539 Without &%no_more%&, addresses that were declined for other reasons would also
19540 be passed to the next router.
19541
19542 .vitem &%fail%&
19543 Delivery fails and an error report is generated.
19544
19545 .vitem &%send%&
19546 .cindex "local host" "sending to"
19547 The anomaly is ignored and the address is queued for the transport. This
19548 setting should be used with extreme caution. For an &(smtp)& transport, it
19549 makes sense only in cases where the program that is listening on the SMTP port
19550 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19551 different configuration file that handles the domain in another way.
19552 .endlist
19553
19554
19555
19556 .option senders routers&!? "address list&!!" unset
19557 .cindex "router" "checking senders"
19558 If this option is set, the router is skipped unless the message's sender
19559 address matches something on the list.
19560 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19561 are evaluated.
19562
19563 There are issues concerning verification when the running of routers is
19564 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19565 setting, it sets the sender to the null string. When using the &%-bt%& option
19566 to check a configuration file, it is necessary also to use the &%-f%& option to
19567 set an appropriate sender. For incoming mail, the sender is unset when
19568 verifying the sender, but is available when verifying any recipients. If the
19569 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19570 matters.
19571
19572
19573 .option set routers "string list" unset
19574 .cindex router variables
19575 This option may be used multiple times on a router;
19576 because of this the list aspect is mostly irrelevant.
19577 The list separator is a semicolon but can be changed in the
19578 usual way.
19579
19580 Each list-element given must be of the form &"name = value"&
19581 and the names used must start with the string &"r_"&.
19582 Values containing a list-separator should have them doubled.
19583 When a router runs, the strings are evaluated in order,
19584 to create variables which are added to the set associated with
19585 the address.
19586 The variable is set with the expansion of the value.
19587 The variables can be used by the router options
19588 (not including any preconditions)
19589 and by the transport.
19590 Later definitions of a given named variable will override former ones.
19591 Variable use is via the usual &$r_...$& syntax.
19592
19593 This is similar to the &%address_data%& option, except that
19594 many independent variables can be used, with choice of naming.
19595
19596
19597 .option translate_ip_address routers string&!! unset
19598 .cindex "IP address" "translating"
19599 .cindex "packet radio"
19600 .cindex "router" "IP address translation"
19601 There exist some rare networking situations (for example, packet radio) where
19602 it is helpful to be able to translate IP addresses generated by normal routing
19603 mechanisms into other IP addresses, thus performing a kind of manual IP
19604 routing. This should be done only if the normal IP routing of the TCP/IP stack
19605 is inadequate or broken. Because this is an extremely uncommon requirement, the
19606 code to support this option is not included in the Exim binary unless
19607 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19608
19609 .vindex "&$host_address$&"
19610 The &%translate_ip_address%& string is expanded for every IP address generated
19611 by the router, with the generated address set in &$host_address$&. If the
19612 expansion is forced to fail, no action is taken.
19613 For any other expansion error, delivery of the message is deferred.
19614 If the result of the expansion is an IP address, that replaces the original
19615 address; otherwise the result is assumed to be a host name &-- this is looked
19616 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19617 produce one or more replacement IP addresses. For example, to subvert all IP
19618 addresses in some specific networks, this could be added to a router:
19619 .code
19620 translate_ip_address = \
19621   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19622     {$value}fail}}
19623 .endd
19624 The file would contain lines like
19625 .code
19626 10.2.3.128/26    some.host
19627 10.8.4.34/26     10.44.8.15
19628 .endd
19629 You should not make use of this facility unless you really understand what you
19630 are doing.
19631
19632
19633
19634 .option transport routers string&!! unset
19635 This option specifies the transport to be used when a router accepts an address
19636 and sets it up for delivery. A transport is never needed if a router is used
19637 only for verification. The value of the option is expanded at routing time,
19638 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19639 and result must be the name of one of the configured transports. If it is not,
19640 delivery is deferred.
19641
19642 The &%transport%& option is not used by the &(redirect)& router, but it does
19643 have some private options that set up transports for pipe and file deliveries
19644 (see chapter &<<CHAPredirect>>&).
19645
19646
19647
19648 .option transport_current_directory routers string&!! unset
19649 .cindex "current directory for local transport"
19650 This option associates a current directory with any address that is routed
19651 to a local transport. This can happen either because a transport is
19652 explicitly configured for the router, or because it generates a delivery to a
19653 file or a pipe. During the delivery process (that is, at transport time), this
19654 option string is expanded and is set as the current directory, unless
19655 overridden by a setting on the transport.
19656 If the expansion fails for any reason, including forced failure, an error is
19657 logged, and delivery is deferred.
19658 See chapter &<<CHAPenvironment>>& for details of the local delivery
19659 environment.
19660
19661
19662
19663
19664 .option transport_home_directory routers string&!! "see below"
19665 .cindex "home directory" "for local transport"
19666 This option associates a home directory with any address that is routed to a
19667 local transport. This can happen either because a transport is explicitly
19668 configured for the router, or because it generates a delivery to a file or a
19669 pipe. During the delivery process (that is, at transport time), the option
19670 string is expanded and is set as the home directory, unless overridden by a
19671 setting of &%home_directory%& on the transport.
19672 If the expansion fails for any reason, including forced failure, an error is
19673 logged, and delivery is deferred.
19674
19675 If the transport does not specify a home directory, and
19676 &%transport_home_directory%& is not set for the router, the home directory for
19677 the transport is taken from the password data if &%check_local_user%& is set for
19678 the router. Otherwise it is taken from &%router_home_directory%& if that option
19679 is set; if not, no home directory is set for the transport.
19680
19681 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19682 environment.
19683
19684
19685
19686
19687 .option unseen routers boolean&!! false
19688 .cindex "router" "carrying on after success"
19689 The result of string expansion for this option must be a valid boolean value,
19690 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19691 result causes an error, and delivery is deferred. If the expansion is forced to
19692 fail, the default value for the option (false) is used. Other failures cause
19693 delivery to be deferred.
19694
19695 When this option is set true, routing does not cease if the router accepts the
19696 address. Instead, a copy of the incoming address is passed to the next router,
19697 overriding a false setting of &%more%&. There is little point in setting
19698 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19699 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19700 sometimes true and sometimes false).
19701
19702 .cindex "copy of message (&%unseen%& option)"
19703 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19704 qualifier in filter files. It can be used to cause copies of messages to be
19705 delivered to some other destination, while also carrying out a normal delivery.
19706 In effect, the current address is made into a &"parent"& that has two children
19707 &-- one that is delivered as specified by this router, and a clone that goes on
19708 to be routed further. For this reason, &%unseen%& may not be combined with the
19709 &%one_time%& option in a &(redirect)& router.
19710
19711 &*Warning*&: Header lines added to the address (or specified for removal) by
19712 this router or by previous routers affect the &"unseen"& copy of the message
19713 only. The clone that continues to be processed by further routers starts with
19714 no added headers and none specified for removal. For a &%redirect%& router, if
19715 a generated address is the same as the incoming address, this can lead to
19716 duplicate addresses with different header modifications. Exim does not do
19717 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19718 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19719 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19720 &%redirect%& router may be of help.
19721
19722 Unlike the handling of header modifications, any data that was set by the
19723 &%address_data%& option in the current or previous routers &'is'& passed on to
19724 subsequent routers.
19725
19726
19727 .option user routers string&!! "see below"
19728 .cindex "uid (user id)" "local delivery"
19729 .cindex "local transports" "uid and gid"
19730 .cindex "transport" "local"
19731 .cindex "router" "user for filter processing"
19732 .cindex "filter" "user for processing"
19733 When a router queues an address for a transport, and the transport does not
19734 specify a user, the user given here is used when running the delivery process.
19735 The user may be specified numerically or by name. If expansion fails, the
19736 error is logged and delivery is deferred.
19737 This user is also used by the &(redirect)& router when running a filter file.
19738 The default is unset, except when &%check_local_user%& is set. In this case,
19739 the default is taken from the password information. If the user is specified as
19740 a name, and &%group%& is not set, the group associated with the user is used.
19741 See also &%initgroups%& and &%group%& and the discussion in chapter
19742 &<<CHAPenvironment>>&.
19743
19744
19745
19746 .option verify routers&!? boolean true
19747 Setting this option has the effect of setting &%verify_sender%& and
19748 &%verify_recipient%& to the same value.
19749
19750
19751 .option verify_only routers&!? boolean false
19752 .cindex "EXPN" "with &%verify_only%&"
19753 .oindex "&%-bv%&"
19754 .cindex "router" "used only when verifying"
19755 If this option is set, the router is used only when verifying an address,
19756 delivering in cutthrough mode or
19757 testing with the &%-bv%& option, not when actually doing a delivery, testing
19758 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19759 restricted to verifying only senders or recipients by means of
19760 &%verify_sender%& and &%verify_recipient%&.
19761
19762 &*Warning*&: When the router is being run to verify addresses for an incoming
19763 SMTP message, Exim is not running as root, but under its own uid. If the router
19764 accesses any files, you need to make sure that they are accessible to the Exim
19765 user or group.
19766
19767
19768 .option verify_recipient routers&!? boolean true
19769 If this option is false, the router is skipped when verifying recipient
19770 addresses,
19771 delivering in cutthrough mode
19772 or testing recipient verification using &%-bv%&.
19773 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19774 are evaluated.
19775 See also the &$verify_mode$& variable.
19776
19777
19778 .option verify_sender routers&!? boolean true
19779 If this option is false, the router is skipped when verifying sender addresses
19780 or testing sender verification using &%-bvs%&.
19781 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19782 are evaluated.
19783 See also the &$verify_mode$& variable.
19784 .ecindex IIDgenoprou1
19785 .ecindex IIDgenoprou2
19786
19787
19788
19789
19790
19791
19792 . ////////////////////////////////////////////////////////////////////////////
19793 . ////////////////////////////////////////////////////////////////////////////
19794
19795 .chapter "The accept router" "CHID4"
19796 .cindex "&(accept)& router"
19797 .cindex "routers" "&(accept)&"
19798 The &(accept)& router has no private options of its own. Unless it is being
19799 used purely for verification (see &%verify_only%&) a transport is required to
19800 be defined by the generic &%transport%& option. If the preconditions that are
19801 specified by generic options are met, the router accepts the address and queues
19802 it for the given transport. The most common use of this router is for setting
19803 up deliveries to local mailboxes. For example:
19804 .code
19805 localusers:
19806   driver = accept
19807   domains = mydomain.example
19808   check_local_user
19809   transport = local_delivery
19810 .endd
19811 The &%domains%& condition in this example checks the domain of the address, and
19812 &%check_local_user%& checks that the local part is the login of a local user.
19813 When both preconditions are met, the &(accept)& router runs, and queues the
19814 address for the &(local_delivery)& transport.
19815
19816
19817
19818
19819
19820
19821 . ////////////////////////////////////////////////////////////////////////////
19822 . ////////////////////////////////////////////////////////////////////////////
19823
19824 .chapter "The dnslookup router" "CHAPdnslookup"
19825 .scindex IIDdnsrou1 "&(dnslookup)& router"
19826 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19827 The &(dnslookup)& router looks up the hosts that handle mail for the
19828 recipient's domain in the DNS. A transport must always be set for this router,
19829 unless &%verify_only%& is set.
19830
19831 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19832 SRV records. If none are found, or if SRV support is not configured,
19833 MX records are looked up. If no MX records exist, address records are sought.
19834 However, &%mx_domains%& can be set to disable the direct use of address
19835 records.
19836
19837 MX records of equal priority are sorted by Exim into a random order. Exim then
19838 looks for address records for the host names obtained from MX or SRV records.
19839 When a host has more than one IP address, they are sorted into a random order,
19840 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19841 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19842 generic option, the router declines.
19843
19844 Unless they have the highest priority (lowest MX value), MX records that point
19845 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19846 are discarded, together with any other MX records of equal or lower priority.
19847
19848 .cindex "MX record" "pointing to local host"
19849 .cindex "local host" "MX pointing to"
19850 .oindex "&%self%&" "in &(dnslookup)& router"
19851 If the host pointed to by the highest priority MX record, or looked up as an
19852 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19853 happens is controlled by the generic &%self%& option.
19854
19855
19856 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19857 There have been problems with DNS servers when SRV records are looked up.
19858 Some misbehaving servers return a DNS error or timeout when a non-existent
19859 SRV record is sought. Similar problems have in the past been reported for
19860 MX records. The global &%dns_again_means_nonexist%& option can help with this
19861 problem, but it is heavy-handed because it is a global option.
19862
19863 For this reason, there are two options, &%srv_fail_domains%& and
19864 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19865 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19866 an attempt to look up an SRV or MX record causes one of these results, and the
19867 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19868 such record"&. In the case of an SRV lookup, this means that the router
19869 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19870 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19871 case routing fails.
19872
19873
19874 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19875 .cindex "&(dnslookup)& router" "declines"
19876 There are a few cases where a &(dnslookup)& router will decline to accept
19877 an address; if such a router is expected to handle "all remaining non-local
19878 domains", then it is important to set &%no_more%&.
19879
19880 The router will defer rather than decline if the domain
19881 is found in the &%fail_defer_domains%& router option.
19882
19883 Reasons for a &(dnslookup)& router to decline currently include:
19884 .ilist
19885 The domain does not exist in DNS
19886 .next
19887 The domain exists but the MX record's host part is just "."; this is a common
19888 convention (borrowed from SRV) used to indicate that there is no such service
19889 for this domain and to not fall back to trying A/AAAA records.
19890 .next
19891 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19892 .next
19893 MX record points to a non-existent host.
19894 .next
19895 MX record points to an IP address and the main section option
19896 &%allow_mx_to_ip%& is not set.
19897 .next
19898 MX records exist and point to valid hosts, but all hosts resolve only to
19899 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19900 .next
19901 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19902 &%dns_check_names_pattern%& for handling one variant of this)
19903 .next
19904 &%check_secondary_mx%& is set on this router but the local host can
19905 not be found in the MX records (see below)
19906 .endlist
19907
19908
19909
19910
19911 .section "Private options for dnslookup" "SECID118"
19912 .cindex "options" "&(dnslookup)& router"
19913 The private options for the &(dnslookup)& router are as follows:
19914
19915 .option check_secondary_mx dnslookup boolean false
19916 .cindex "MX record" "checking for secondary"
19917 If this option is set, the router declines unless the local host is found in
19918 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19919 process domains for which the local host is a secondary mail exchanger
19920 differently to other domains. The way in which Exim decides whether a host is
19921 the local host is described in section &<<SECTreclocipadd>>&.
19922
19923
19924 .option check_srv dnslookup string&!! unset
19925 .cindex "SRV record" "enabling use of"
19926 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19927 addition to MX and address records. The support is disabled by default. To
19928 enable SRV support, set the &%check_srv%& option to the name of the service
19929 required. For example,
19930 .code
19931 check_srv = smtp
19932 .endd
19933 looks for SRV records that refer to the normal smtp service. The option is
19934 expanded, so the service name can vary from message to message or address
19935 to address. This might be helpful if SRV records are being used for a
19936 submission service. If the expansion is forced to fail, the &%check_srv%&
19937 option is ignored, and the router proceeds to look for MX records in the
19938 normal way.
19939
19940 When the expansion succeeds, the router searches first for SRV records for
19941 the given service (it assumes TCP protocol). A single SRV record with a
19942 host name that consists of just a single dot indicates &"no such service for
19943 this domain"&; if this is encountered, the router declines. If other kinds of
19944 SRV record are found, they are used to construct a host list for delivery
19945 according to the rules of RFC 2782. MX records are not sought in this case.
19946
19947 When no SRV records are found, MX records (and address records) are sought in
19948 the traditional way. In other words, SRV records take precedence over MX
19949 records, just as MX records take precedence over address records. Note that
19950 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19951 defined it. It is apparently believed that MX records are sufficient for email
19952 and that SRV records should not be used for this purpose. However, SRV records
19953 have an additional &"weight"& feature which some people might find useful when
19954 trying to split an SMTP load between hosts of different power.
19955
19956 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19957 when there is a DNS lookup error.
19958
19959
19960
19961
19962 .option fail_defer_domains dnslookup "domain list&!!" unset
19963 .cindex "MX record" "not found"
19964 DNS lookups for domains matching &%fail_defer_domains%&
19965 which find no matching record will cause the router to defer
19966 rather than the default behaviour of decline.
19967 This maybe be useful for queueing messages for a newly created
19968 domain while the DNS configuration is not ready.
19969 However, it will result in any message with mistyped domains
19970 also being queued.
19971
19972
19973 .option ipv4_only "string&!!" unset
19974 .cindex IPv6 disabling
19975 .cindex DNS "IPv6 disabling"
19976 The string is expanded, and if the result is anything but a forced failure,
19977 or an empty string, or one of the strings “0” or “no” or “false”
19978 (checked without regard to the case of the letters),
19979 only A records are used.
19980
19981 .option ipv4_prefer "string&!!" unset
19982 .cindex IPv4 preference
19983 .cindex DNS "IPv4 preference"
19984 The string is expanded, and if the result is anything but a forced failure,
19985 or an empty string, or one of the strings “0” or “no” or “false”
19986 (checked without regard to the case of the letters),
19987 A records are sorted before AAAA records (inverting the default).
19988
19989 .option mx_domains dnslookup "domain list&!!" unset
19990 .cindex "MX record" "required to exist"
19991 .cindex "SRV record" "required to exist"
19992 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19993 record in order to be recognized. (The name of this option could be improved.)
19994 For example, if all the mail hosts in &'fict.example'& are known to have MX
19995 records, except for those in &'discworld.fict.example'&, you could use this
19996 setting:
19997 .code
19998 mx_domains = ! *.discworld.fict.example : *.fict.example
19999 .endd
20000 This specifies that messages addressed to a domain that matches the list but
20001 has no MX record should be bounced immediately instead of being routed using
20002 the address record.
20003
20004
20005 .option mx_fail_domains dnslookup "domain list&!!" unset
20006 If the DNS lookup for MX records for one of the domains in this list causes a
20007 DNS lookup error, Exim behaves as if no MX records were found. See section
20008 &<<SECTprowitdnsloo>>& for more discussion.
20009
20010
20011
20012
20013 .option qualify_single dnslookup boolean true
20014 .cindex "DNS" "resolver options"
20015 .cindex "DNS" "qualifying single-component names"
20016 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20017 lookups. Typically, but not standardly, this causes the resolver to qualify
20018 single-component names with the default domain. For example, on a machine
20019 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20020 &'thesaurus.ref.example'& inside the resolver. For details of what your
20021 resolver actually does, consult your man pages for &'resolver'& and
20022 &'resolv.conf'&.
20023
20024
20025
20026 .option rewrite_headers dnslookup boolean true
20027 .cindex "rewriting" "header lines"
20028 .cindex "header lines" "rewriting"
20029 If the domain name in the address that is being processed is not fully
20030 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20031 an address is specified as &'dormouse@teaparty'&, the domain might be
20032 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20033 occur as a result of setting the &%widen_domains%& option. If
20034 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20035 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20036 header lines of the message are rewritten with the full domain name.
20037
20038 This option should be turned off only when it is known that no message is
20039 ever going to be sent outside an environment where the abbreviation makes
20040 sense.
20041
20042 When an MX record is looked up in the DNS and matches a wildcard record, name
20043 servers normally return a record containing the name that has been looked up,
20044 making it impossible to detect whether a wildcard was present or not. However,
20045 some name servers have recently been seen to return the wildcard entry. If the
20046 name returned by a DNS lookup begins with an asterisk, it is not used for
20047 header rewriting.
20048
20049
20050 .option same_domain_copy_routing dnslookup boolean false
20051 .cindex "address" "copying routing"
20052 Addresses with the same domain are normally routed by the &(dnslookup)& router
20053 to the same list of hosts. However, this cannot be presumed, because the router
20054 options and preconditions may refer to the local part of the address. By
20055 default, therefore, Exim routes each address in a message independently. DNS
20056 servers run caches, so repeated DNS lookups are not normally expensive, and in
20057 any case, personal messages rarely have more than a few recipients.
20058
20059 If you are running mailing lists with large numbers of subscribers at the same
20060 domain, and you are using a &(dnslookup)& router which is independent of the
20061 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20062 lookups for identical domains in one message. In this case, when &(dnslookup)&
20063 routes an address to a remote transport, any other unrouted addresses in the
20064 message that have the same domain are automatically given the same routing
20065 without processing them independently,
20066 provided the following conditions are met:
20067
20068 .ilist
20069 No router that processed the address specified &%headers_add%& or
20070 &%headers_remove%&.
20071 .next
20072 The router did not change the address in any way, for example, by &"widening"&
20073 the domain.
20074 .endlist
20075
20076
20077
20078
20079 .option search_parents dnslookup boolean false
20080 .cindex "DNS" "resolver options"
20081 When this option is true, the resolver option RES_DNSRCH is set for DNS
20082 lookups. This is different from the &%qualify_single%& option in that it
20083 applies to domains containing dots. Typically, but not standardly, it causes
20084 the resolver to search for the name in the current domain and in parent
20085 domains. For example, on a machine in the &'fict.example'& domain, if looking
20086 up &'teaparty.wonderland'& failed, the resolver would try
20087 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20088 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20089
20090 Setting this option true can cause problems in domains that have a wildcard MX
20091 record, because any domain that does not have its own MX record matches the
20092 local wildcard.
20093
20094
20095
20096 .option srv_fail_domains dnslookup "domain list&!!" unset
20097 If the DNS lookup for SRV records for one of the domains in this list causes a
20098 DNS lookup error, Exim behaves as if no SRV records were found. See section
20099 &<<SECTprowitdnsloo>>& for more discussion.
20100
20101
20102
20103
20104 .option widen_domains dnslookup "string list" unset
20105 .cindex "domain" "partial; widening"
20106 If a DNS lookup fails and this option is set, each of its strings in turn is
20107 added onto the end of the domain, and the lookup is tried again. For example,
20108 if
20109 .code
20110 widen_domains = fict.example:ref.example
20111 .endd
20112 is set and a lookup of &'klingon.dictionary'& fails,
20113 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20114 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20115 and &%search_parents%& options can cause some widening to be undertaken inside
20116 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20117 when verifying, unless &%rewrite_headers%& is false (not the default).
20118
20119
20120 .section "Effect of qualify_single and search_parents" "SECID119"
20121 When a domain from an envelope recipient is changed by the resolver as a result
20122 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20123 corresponding address in the message's header lines unless &%rewrite_headers%&
20124 is set false. Exim then re-routes the address, using the full domain.
20125
20126 These two options affect only the DNS lookup that takes place inside the router
20127 for the domain of the address that is being routed. They do not affect lookups
20128 such as that implied by
20129 .code
20130 domains = @mx_any
20131 .endd
20132 that may happen while processing a router precondition before the router is
20133 entered. No widening ever takes place for these lookups.
20134 .ecindex IIDdnsrou1
20135 .ecindex IIDdnsrou2
20136
20137
20138
20139
20140
20141
20142
20143
20144
20145 . ////////////////////////////////////////////////////////////////////////////
20146 . ////////////////////////////////////////////////////////////////////////////
20147
20148 .chapter "The ipliteral router" "CHID5"
20149 .cindex "&(ipliteral)& router"
20150 .cindex "domain literal" "routing"
20151 .cindex "routers" "&(ipliteral)&"
20152 This router has no private options. Unless it is being used purely for
20153 verification (see &%verify_only%&) a transport is required to be defined by the
20154 generic &%transport%& option. The router accepts the address if its domain part
20155 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20156 router handles the address
20157 .code
20158 root@[192.168.1.1]
20159 .endd
20160 by setting up delivery to the host with that IP address. IPv4 domain literals
20161 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20162 are similar, but the address is preceded by &`ipv6:`&. For example:
20163 .code
20164 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20165 .endd
20166 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20167 grounds that sooner or later somebody will try it.
20168
20169 .oindex "&%self%&" "in &(ipliteral)& router"
20170 If the IP address matches something in &%ignore_target_hosts%&, the router
20171 declines. If an IP literal turns out to refer to the local host, the generic
20172 &%self%& option determines what happens.
20173
20174 The RFCs require support for domain literals; however, their use is
20175 controversial in today's Internet. If you want to use this router, you must
20176 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20177 Exim will not recognize the domain literal syntax in addresses.
20178
20179
20180
20181 . ////////////////////////////////////////////////////////////////////////////
20182 . ////////////////////////////////////////////////////////////////////////////
20183
20184 .chapter "The iplookup router" "CHID6"
20185 .cindex "&(iplookup)& router"
20186 .cindex "routers" "&(iplookup)&"
20187 The &(iplookup)& router was written to fulfil a specific requirement in
20188 Cambridge University (which in fact no longer exists). For this reason, it is
20189 not included in the binary of Exim by default. If you want to include it, you
20190 must set
20191 .code
20192 ROUTER_IPLOOKUP=yes
20193 .endd
20194 in your &_Local/Makefile_& configuration file.
20195
20196 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20197 connection to one or more specific hosts. The host can then return the same or
20198 a different address &-- in effect rewriting the recipient address in the
20199 message's envelope. The new address is then passed on to subsequent routers. If
20200 this process fails, the address can be passed on to other routers, or delivery
20201 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20202 must not be specified for it.
20203
20204 .cindex "options" "&(iplookup)& router"
20205 .option hosts iplookup string unset
20206 This option must be supplied. Its value is a colon-separated list of host
20207 names. The hosts are looked up using &[gethostbyname()]&
20208 (or &[getipnodebyname()]& when available)
20209 and are tried in order until one responds to the query. If none respond, what
20210 happens is controlled by &%optional%&.
20211
20212
20213 .option optional iplookup boolean false
20214 If &%optional%& is true, if no response is obtained from any host, the address
20215 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20216 delivery to the address is deferred.
20217
20218
20219 .option port iplookup integer 0
20220 .cindex "port" "&(iplookup)& router"
20221 This option must be supplied. It specifies the port number for the TCP or UDP
20222 call.
20223
20224
20225 .option protocol iplookup string udp
20226 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20227 protocols is to be used.
20228
20229
20230 .option query iplookup string&!! "see below"
20231 This defines the content of the query that is sent to the remote hosts. The
20232 default value is:
20233 .code
20234 $local_part@$domain $local_part@$domain
20235 .endd
20236 The repetition serves as a way of checking that a response is to the correct
20237 query in the default case (see &%response_pattern%& below).
20238
20239
20240 .option reroute iplookup string&!! unset
20241 If this option is not set, the rerouted address is precisely the byte string
20242 returned by the remote host, up to the first white space, if any. If set, the
20243 string is expanded to form the rerouted address. It can include parts matched
20244 in the response by &%response_pattern%& by means of numeric variables such as
20245 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20246 whether or not a pattern is in use. In all cases, the rerouted address must end
20247 up in the form &'local_part@domain'&.
20248
20249
20250 .option response_pattern iplookup string unset
20251 This option can be set to a regular expression that is applied to the string
20252 returned from the remote host. If the pattern does not match the response, the
20253 router declines. If &%response_pattern%& is not set, no checking of the
20254 response is done, unless the query was defaulted, in which case there is a
20255 check that the text returned after the first white space is the original
20256 address. This checks that the answer that has been received is in response to
20257 the correct question. For example, if the response is just a new domain, the
20258 following could be used:
20259 .code
20260 response_pattern = ^([^@]+)$
20261 reroute = $local_part@$1
20262 .endd
20263
20264 .option timeout iplookup time 5s
20265 This specifies the amount of time to wait for a response from the remote
20266 machine. The same timeout is used for the &[connect()]& function for a TCP
20267 call. It does not apply to UDP.
20268
20269
20270
20271
20272 . ////////////////////////////////////////////////////////////////////////////
20273 . ////////////////////////////////////////////////////////////////////////////
20274
20275 .chapter "The manualroute router" "CHID7"
20276 .scindex IIDmanrou1 "&(manualroute)& router"
20277 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20278 .cindex "domain" "manually routing"
20279 The &(manualroute)& router is so-called because it provides a way of manually
20280 routing an address according to its domain. It is mainly used when you want to
20281 route addresses to remote hosts according to your own rules, bypassing the
20282 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20283 route to local transports, a facility that may be useful if you want to save
20284 messages for dial-in hosts in local files.
20285
20286 The &(manualroute)& router compares a list of domain patterns with the domain
20287 it is trying to route. If there is no match, the router declines. Each pattern
20288 has associated with it a list of hosts and some other optional data, which may
20289 include a transport. The combination of a pattern and its data is called a
20290 &"routing rule"&. For patterns that do not have an associated transport, the
20291 generic &%transport%& option must specify a transport, unless the router is
20292 being used purely for verification (see &%verify_only%&).
20293
20294 .vindex "&$host$&"
20295 In the case of verification, matching the domain pattern is sufficient for the
20296 router to accept the address. When actually routing an address for delivery,
20297 an address that matches a domain pattern is queued for the associated
20298 transport. If the transport is not a local one, a host list must be associated
20299 with the pattern; IP addresses are looked up for the hosts, and these are
20300 passed to the transport along with the mail address. For local transports, a
20301 host list is optional. If it is present, it is passed in &$host$& as a single
20302 text string.
20303
20304 The list of routing rules can be provided as an inline string in
20305 &%route_list%&, or the data can be obtained by looking up the domain in a file
20306 or database by setting &%route_data%&. Only one of these settings may appear in
20307 any one instance of &(manualroute)&. The format of routing rules is described
20308 below, following the list of private options.
20309
20310
20311 .section "Private options for manualroute" "SECTprioptman"
20312
20313 .cindex "options" "&(manualroute)& router"
20314 The private options for the &(manualroute)& router are as follows:
20315
20316 .option host_all_ignored manualroute string defer
20317 See &%host_find_failed%&.
20318
20319 .option host_find_failed manualroute string freeze
20320 This option controls what happens when &(manualroute)& tries to find an IP
20321 address for a host, and the host does not exist. The option can be set to one
20322 of the following values:
20323 .code
20324 decline
20325 defer
20326 fail
20327 freeze
20328 ignore
20329 pass
20330 .endd
20331 The default (&"freeze"&) assumes that this state is a serious configuration
20332 error. The difference between &"pass"& and &"decline"& is that the former
20333 forces the address to be passed to the next router (or the router defined by
20334 &%pass_router%&),
20335 .oindex "&%more%&"
20336 overriding &%no_more%&, whereas the latter passes the address to the next
20337 router only if &%more%& is true.
20338
20339 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20340 cannot be found. If all the hosts in the list are ignored, the behaviour is
20341 controlled by the &%host_all_ignored%& option. This takes the same values
20342 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20343
20344 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20345 state; if a host lookup gets a temporary error, delivery is deferred unless the
20346 generic &%pass_on_timeout%& option is set.
20347
20348
20349 .option hosts_randomize manualroute boolean false
20350 .cindex "randomized host list"
20351 .cindex "host" "list of; randomized"
20352 If this option is set, the order of the items in a host list in a routing rule
20353 is randomized each time the list is used, unless an option in the routing rule
20354 overrides (see below). Randomizing the order of a host list can be used to do
20355 crude load sharing. However, if more than one mail address is routed by the
20356 same router to the same host list, the host lists are considered to be the same
20357 (even though they may be randomized into different orders) for the purpose of
20358 deciding whether to batch the deliveries into a single SMTP transaction.
20359
20360 When &%hosts_randomize%& is true, a host list may be split
20361 into groups whose order is separately randomized. This makes it possible to
20362 set up MX-like behaviour. The boundaries between groups are indicated by an
20363 item that is just &`+`& in the host list. For example:
20364 .code
20365 route_list = * host1:host2:host3:+:host4:host5
20366 .endd
20367 The order of the first three hosts and the order of the last two hosts is
20368 randomized for each use, but the first three always end up before the last two.
20369 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20370 randomized host list is passed to an &(smtp)& transport that also has
20371 &%hosts_randomize set%&, the list is not re-randomized.
20372
20373
20374 .option route_data manualroute string&!! unset
20375 If this option is set, it must expand to yield the data part of a routing rule.
20376 Typically, the expansion string includes a lookup based on the domain. For
20377 example:
20378 .code
20379 route_data = ${lookup{$domain}dbm{/etc/routes}}
20380 .endd
20381 If the expansion is forced to fail, or the result is an empty string, the
20382 router declines. Other kinds of expansion failure cause delivery to be
20383 deferred.
20384
20385
20386 .option route_list manualroute "string list" unset
20387 This string is a list of routing rules, in the form defined below. Note that,
20388 unlike most string lists, the items are separated by semicolons. This is so
20389 that they may contain colon-separated host lists.
20390
20391
20392 .option same_domain_copy_routing manualroute boolean false
20393 .cindex "address" "copying routing"
20394 Addresses with the same domain are normally routed by the &(manualroute)&
20395 router to the same list of hosts. However, this cannot be presumed, because the
20396 router options and preconditions may refer to the local part of the address. By
20397 default, therefore, Exim routes each address in a message independently. DNS
20398 servers run caches, so repeated DNS lookups are not normally expensive, and in
20399 any case, personal messages rarely have more than a few recipients.
20400
20401 If you are running mailing lists with large numbers of subscribers at the same
20402 domain, and you are using a &(manualroute)& router which is independent of the
20403 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20404 lookups for identical domains in one message. In this case, when
20405 &(manualroute)& routes an address to a remote transport, any other unrouted
20406 addresses in the message that have the same domain are automatically given the
20407 same routing without processing them independently. However, this is only done
20408 if &%headers_add%& and &%headers_remove%& are unset.
20409
20410
20411
20412
20413 .section "Routing rules in route_list" "SECID120"
20414 The value of &%route_list%& is a string consisting of a sequence of routing
20415 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20416 entered as two semicolons. Alternatively, the list separator can be changed as
20417 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20418 Empty rules are ignored. The format of each rule is
20419 .display
20420 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20421 .endd
20422 The following example contains two rules, each with a simple domain pattern and
20423 no options:
20424 .code
20425 route_list = \
20426   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20427   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20428 .endd
20429 The three parts of a rule are separated by white space. The pattern and the
20430 list of hosts can be enclosed in quotes if necessary, and if they are, the
20431 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20432 single domain pattern, which is the only mandatory item in the rule. The
20433 pattern is in the same format as one item in a domain list (see section
20434 &<<SECTdomainlist>>&),
20435 except that it may not be the name of an interpolated file.
20436 That is, it may be wildcarded, or a regular expression, or a file or database
20437 lookup (with semicolons doubled, because of the use of semicolon as a separator
20438 in a &%route_list%&).
20439
20440 The rules in &%route_list%& are searched in order until one of the patterns
20441 matches the domain that is being routed. The list of hosts and then options are
20442 then used as described below. If there is no match, the router declines. When
20443 &%route_list%& is set, &%route_data%& must not be set.
20444
20445
20446
20447 .section "Routing rules in route_data" "SECID121"
20448 The use of &%route_list%& is convenient when there are only a small number of
20449 routing rules. For larger numbers, it is easier to use a file or database to
20450 hold the routing information, and use the &%route_data%& option instead.
20451 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20452 Most commonly, &%route_data%& is set as a string that contains an
20453 expansion lookup. For example, suppose we place two routing rules in a file
20454 like this:
20455 .code
20456 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20457 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20458 .endd
20459 This data can be accessed by setting
20460 .code
20461 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20462 .endd
20463 Failure of the lookup results in an empty string, causing the router to
20464 decline. However, you do not have to use a lookup in &%route_data%&. The only
20465 requirement is that the result of expanding the string is a list of hosts,
20466 possibly followed by options, separated by white space. The list of hosts must
20467 be enclosed in quotes if it contains white space.
20468
20469
20470
20471
20472 .section "Format of the list of hosts" "SECID122"
20473 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20474 always separately expanded before use. If the expansion fails, the router
20475 declines. The result of the expansion must be a colon-separated list of names
20476 and/or IP addresses, optionally also including ports.
20477 If the list is written with spaces, it must be protected with quotes.
20478 The format of each item
20479 in the list is described in the next section. The list separator can be changed
20480 as described in section &<<SECTlistsepchange>>&.
20481
20482 If the list of hosts was obtained from a &%route_list%& item, the following
20483 variables are set during its expansion:
20484
20485 .ilist
20486 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20487 If the domain was matched against a regular expression, the numeric variables
20488 &$1$&, &$2$&, etc. may be set. For example:
20489 .code
20490 route_list = ^domain(\d+)   host-$1.text.example
20491 .endd
20492 .next
20493 &$0$& is always set to the entire domain.
20494 .next
20495 &$1$& is also set when partial matching is done in a file lookup.
20496
20497 .next
20498 .vindex "&$value$&"
20499 If the pattern that matched the domain was a lookup item, the data that was
20500 looked up is available in the expansion variable &$value$&. For example:
20501 .code
20502 route_list = lsearch;;/some/file.routes  $value
20503 .endd
20504 .endlist
20505
20506 Note the doubling of the semicolon in the pattern that is necessary because
20507 semicolon is the default route list separator.
20508
20509
20510
20511 .section "Format of one host item" "SECTformatonehostitem"
20512 Each item in the list of hosts can be either a host name or an IP address,
20513 optionally with an attached port number, or it can be a single "+"
20514 (see &%hosts_randomize%&).
20515 When no port is given, an IP address
20516 is not enclosed in brackets. When a port is specified, it overrides the port
20517 specification on the transport. The port is separated from the name or address
20518 by a colon. This leads to some complications:
20519
20520 .ilist
20521 Because colon is the default separator for the list of hosts, either
20522 the colon that specifies a port must be doubled, or the list separator must
20523 be changed. The following two examples have the same effect:
20524 .code
20525 route_list = * "host1.tld::1225 : host2.tld::1226"
20526 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20527 .endd
20528 .next
20529 When IPv6 addresses are involved, it gets worse, because they contain
20530 colons of their own. To make this case easier, it is permitted to
20531 enclose an IP address (either v4 or v6) in square brackets if a port
20532 number follows. For example:
20533 .code
20534 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20535 .endd
20536 .endlist
20537
20538 .section "How the list of hosts is used" "SECThostshowused"
20539 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20540 the hosts is tried, in the order specified, when carrying out the SMTP
20541 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20542 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20543 transport.
20544
20545 Hosts may be listed by name or by IP address. An unadorned name in the list of
20546 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20547 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20548 records in the DNS. For example:
20549 .code
20550 route_list = *  x.y.z:p.q.r/MX:e.f.g
20551 .endd
20552 If this feature is used with a port specifier, the port must come last. For
20553 example:
20554 .code
20555 route_list = *  dom1.tld/mx::1225
20556 .endd
20557 If the &%hosts_randomize%& option is set, the order of the items in the list is
20558 randomized before any lookups are done. Exim then scans the list; for any name
20559 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20560 be an interface on the local host and the item is not the first in the list,
20561 Exim discards it and any subsequent items. If it is the first item, what
20562 happens is controlled by the
20563 .oindex "&%self%&" "in &(manualroute)& router"
20564 &%self%& option of the router.
20565
20566 A name on the list that is followed by &`/MX`& is replaced with the list of
20567 hosts obtained by looking up MX records for the name. This is always a DNS
20568 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20569 below) are not relevant here. The order of these hosts is determined by the
20570 preference values in the MX records, according to the usual rules. Because
20571 randomizing happens before the MX lookup, it does not affect the order that is
20572 defined by MX preferences.
20573
20574 If the local host is present in the sublist obtained from MX records, but is
20575 not the most preferred host in that list, it and any equally or less
20576 preferred hosts are removed before the sublist is inserted into the main list.
20577
20578 If the local host is the most preferred host in the MX list, what happens
20579 depends on where in the original list of hosts the &`/MX`& item appears. If it
20580 is not the first item (that is, there are previous hosts in the main list),
20581 Exim discards this name and any subsequent items in the main list.
20582
20583 If the MX item is first in the list of hosts, and the local host is the
20584 most preferred host, what happens is controlled by the &%self%& option of the
20585 router.
20586
20587 DNS failures when lookup up the MX records are treated in the same way as DNS
20588 failures when looking up IP addresses: &%pass_on_timeout%& and
20589 &%host_find_failed%& are used when relevant.
20590
20591 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20592 whether obtained from an MX lookup or not.
20593
20594
20595
20596 .section "How the options are used" "SECThowoptused"
20597 The options are a sequence of words, space-separated.
20598 One of the words can be the name of a transport; this overrides the
20599 &%transport%& option on the router for this particular routing rule only. The
20600 other words (if present) control randomization of the list of hosts on a
20601 per-rule basis, and how the IP addresses of the hosts are to be found when
20602 routing to a remote transport. These options are as follows:
20603
20604 .ilist
20605 &%randomize%&: randomize the order of the hosts in this list, overriding the
20606 setting of &%hosts_randomize%& for this routing rule only.
20607 .next
20608 &%no_randomize%&: do not randomize the order of the hosts in this list,
20609 overriding the setting of &%hosts_randomize%& for this routing rule only.
20610 .next
20611 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20612 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20613 also look in &_/etc/hosts_& or other sources of information.
20614 .next
20615 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20616 no address records are found. If there is a temporary DNS error (such as a
20617 timeout), delivery is deferred.
20618 .next
20619 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20620 .next
20621 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20622 .endlist
20623
20624 For example:
20625 .code
20626 route_list = domain1  host1:host2:host3  randomize bydns;\
20627              domain2  host4:host5
20628 .endd
20629 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20630 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20631 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20632 or &[gethostbyname()]&, and the result of the lookup is the result of that
20633 call.
20634
20635 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20636 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20637 instead of TRY_AGAIN. That is why the default action is to try a DNS
20638 lookup first. Only if that gives a definite &"no such host"& is the local
20639 function called.
20640
20641 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20642 inadvertent constraint that a transport name as an option had to be the last
20643 option specified.
20644
20645
20646
20647 If no IP address for a host can be found, what happens is controlled by the
20648 &%host_find_failed%& option.
20649
20650 .vindex "&$host$&"
20651 When an address is routed to a local transport, IP addresses are not looked up.
20652 The host list is passed to the transport in the &$host$& variable.
20653
20654
20655
20656 .section "Manualroute examples" "SECID123"
20657 In some of the examples that follow, the presence of the &%remote_smtp%&
20658 transport, as defined in the default configuration file, is assumed:
20659
20660 .ilist
20661 .cindex "smart host" "example router"
20662 The &(manualroute)& router can be used to forward all external mail to a
20663 &'smart host'&. If you have set up, in the main part of the configuration, a
20664 named domain list that contains your local domains, for example:
20665 .code
20666 domainlist local_domains = my.domain.example
20667 .endd
20668 You can arrange for all other domains to be routed to a smart host by making
20669 your first router something like this:
20670 .code
20671 smart_route:
20672   driver = manualroute
20673   domains = !+local_domains
20674   transport = remote_smtp
20675   route_list = * smarthost.ref.example
20676 .endd
20677 This causes all non-local addresses to be sent to the single host
20678 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20679 they are tried in order
20680 (but you can use &%hosts_randomize%& to vary the order each time).
20681 Another way of configuring the same thing is this:
20682 .code
20683 smart_route:
20684   driver = manualroute
20685   transport = remote_smtp
20686   route_list = !+local_domains  smarthost.ref.example
20687 .endd
20688 There is no difference in behaviour between these two routers as they stand.
20689 However, they behave differently if &%no_more%& is added to them. In the first
20690 example, the router is skipped if the domain does not match the &%domains%&
20691 precondition; the following router is always tried. If the router runs, it
20692 always matches the domain and so can never decline. Therefore, &%no_more%&
20693 would have no effect. In the second case, the router is never skipped; it
20694 always runs. However, if it doesn't match the domain, it declines. In this case
20695 &%no_more%& would prevent subsequent routers from running.
20696
20697 .next
20698 .cindex "mail hub example"
20699 A &'mail hub'& is a host which receives mail for a number of domains via MX
20700 records in the DNS and delivers it via its own private routing mechanism. Often
20701 the final destinations are behind a firewall, with the mail hub being the one
20702 machine that can connect to machines both inside and outside the firewall. The
20703 &(manualroute)& router is usually used on a mail hub to route incoming messages
20704 to the correct hosts. For a small number of domains, the routing can be inline,
20705 using the &%route_list%& option, but for a larger number a file or database
20706 lookup is easier to manage.
20707
20708 If the domain names are in fact the names of the machines to which the mail is
20709 to be sent by the mail hub, the configuration can be quite simple. For
20710 example:
20711 .code
20712 hub_route:
20713   driver = manualroute
20714   transport = remote_smtp
20715   route_list = *.rhodes.tvs.example  $domain
20716 .endd
20717 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20718 whose names are the same as the mail domains. A similar approach can be taken
20719 if the host name can be obtained from the domain name by a string manipulation
20720 that the expansion facilities can handle. Otherwise, a lookup based on the
20721 domain can be used to find the host:
20722 .code
20723 through_firewall:
20724   driver = manualroute
20725   transport = remote_smtp
20726   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20727 .endd
20728 The result of the lookup must be the name or IP address of the host (or
20729 hosts) to which the address is to be routed. If the lookup fails, the route
20730 data is empty, causing the router to decline. The address then passes to the
20731 next router.
20732
20733 .next
20734 .cindex "batched SMTP output example"
20735 .cindex "SMTP" "batched outgoing; example"
20736 You can use &(manualroute)& to deliver messages to pipes or files in batched
20737 SMTP format for onward transportation by some other means. This is one way of
20738 storing mail for a dial-up host when it is not connected. The route list entry
20739 can be as simple as a single domain name in a configuration like this:
20740 .code
20741 save_in_file:
20742   driver = manualroute
20743   transport = batchsmtp_appendfile
20744   route_list = saved.domain.example
20745 .endd
20746 though often a pattern is used to pick up more than one domain. If there are
20747 several domains or groups of domains with different transport requirements,
20748 different transports can be listed in the routing information:
20749 .code
20750 save_in_file:
20751   driver = manualroute
20752   route_list = \
20753     *.saved.domain1.example  $domain  batch_appendfile; \
20754     *.saved.domain2.example  \
20755       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20756       batch_pipe
20757 .endd
20758 .vindex "&$domain$&"
20759 .vindex "&$host$&"
20760 The first of these just passes the domain in the &$host$& variable, which
20761 doesn't achieve much (since it is also in &$domain$&), but the second does a
20762 file lookup to find a value to pass, causing the router to decline to handle
20763 the address if the lookup fails.
20764
20765 .next
20766 .cindex "UUCP" "example of router for"
20767 Routing mail directly to UUCP software is a specific case of the use of
20768 &(manualroute)& in a gateway to another mail environment. This is an example of
20769 one way it can be done:
20770 .code
20771 # Transport
20772 uucp:
20773   driver = pipe
20774   user = nobody
20775   command = /usr/local/bin/uux -r - \
20776     ${substr_-5:$host}!rmail ${local_part}
20777   return_fail_output = true
20778
20779 # Router
20780 uucphost:
20781   transport = uucp
20782   driver = manualroute
20783   route_data = \
20784     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20785 .endd
20786 The file &_/usr/local/exim/uucphosts_& contains entries like
20787 .code
20788 darksite.ethereal.example:           darksite.UUCP
20789 .endd
20790 It can be set up more simply without adding and removing &".UUCP"& but this way
20791 makes clear the distinction between the domain name
20792 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20793 .endlist
20794 .ecindex IIDmanrou1
20795 .ecindex IIDmanrou2
20796
20797
20798
20799
20800
20801
20802
20803
20804 . ////////////////////////////////////////////////////////////////////////////
20805 . ////////////////////////////////////////////////////////////////////////////
20806
20807 .chapter "The queryprogram router" "CHAPdriverlast"
20808 .scindex IIDquerou1 "&(queryprogram)& router"
20809 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20810 .cindex "routing" "by external program"
20811 The &(queryprogram)& router routes an address by running an external command
20812 and acting on its output. This is an expensive way to route, and is intended
20813 mainly for use in lightly-loaded systems, or for performing experiments.
20814 However, if it is possible to use the precondition options (&%domains%&,
20815 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20816 be used in special cases, even on a busy host. There are the following private
20817 options:
20818 .cindex "options" "&(queryprogram)& router"
20819
20820 .option command queryprogram string&!! unset
20821 This option must be set. It specifies the command that is to be run. The
20822 command is split up into a command name and arguments, and then each is
20823 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20824 &<<CHAPpipetransport>>&).
20825
20826
20827 .option command_group queryprogram string unset
20828 .cindex "gid (group id)" "in &(queryprogram)& router"
20829 This option specifies a gid to be set when running the command while routing an
20830 address for deliver. It must be set if &%command_user%& specifies a numerical
20831 uid. If it begins with a digit, it is interpreted as the numerical value of the
20832 gid. Otherwise it is looked up using &[getgrnam()]&.
20833
20834
20835 .option command_user queryprogram string unset
20836 .cindex "uid (user id)" "for &(queryprogram)&"
20837 This option must be set. It specifies the uid which is set when running the
20838 command while routing an address for delivery. If the value begins with a digit,
20839 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20840 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20841 not set, a value for the gid also.
20842
20843 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20844 root, which it does during a normal delivery in a conventional configuration.
20845 However, when an address is being verified during message reception, Exim is
20846 usually running as the Exim user, not as root. If the &(queryprogram)& router
20847 is called from a non-root process, Exim cannot change uid or gid before running
20848 the command. In this circumstance the command runs under the current uid and
20849 gid.
20850
20851
20852 .option current_directory queryprogram string /
20853 This option specifies an absolute path which is made the current directory
20854 before running the command.
20855
20856
20857 .option timeout queryprogram time 1h
20858 If the command does not complete within the timeout period, its process group
20859 is killed and the message is frozen. A value of zero time specifies no
20860 timeout.
20861
20862
20863 The standard output of the command is connected to a pipe, which is read when
20864 the command terminates. It should consist of a single line of output,
20865 containing up to five fields, separated by white space. The maximum length of
20866 the line is 1023 characters. Longer lines are silently truncated. The first
20867 field is one of the following words (case-insensitive):
20868
20869 .ilist
20870 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20871 below).
20872 .next
20873 &'Decline'&: the router declines; pass the address to the next router, unless
20874 &%no_more%& is set.
20875 .next
20876 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20877 subsequent text on the line is an error message. If the router is run as part
20878 of address verification during an incoming SMTP message, the message is
20879 included in the SMTP response.
20880 .next
20881 &'Defer'&: routing could not be completed at this time; try again later. Any
20882 subsequent text on the line is an error message which is logged. It is not
20883 included in any SMTP response.
20884 .next
20885 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20886 .next
20887 &'Pass'&: pass the address to the next router (or the router specified by
20888 &%pass_router%&), overriding &%no_more%&.
20889 .next
20890 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20891 new addresses, which are routed independently, starting with the first router,
20892 or the router specified by &%redirect_router%&, if set.
20893 .endlist
20894
20895 When the first word is &'accept'&, the remainder of the line consists of a
20896 number of keyed data values, as follows (split into two lines here, to fit on
20897 the page):
20898 .code
20899 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20900 LOOKUP=byname|bydns DATA=<text>
20901 .endd
20902 The data items can be given in any order, and all are optional. If no transport
20903 is included, the transport specified by the generic &%transport%& option is
20904 used. The list of hosts and the lookup type are needed only if the transport is
20905 an &(smtp)& transport that does not itself supply a list of hosts.
20906
20907 The format of the list of hosts is the same as for the &(manualroute)& router.
20908 As well as host names and IP addresses with optional port numbers, as described
20909 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20910 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20911 (see section &<<SECThostshowused>>&).
20912
20913 If the lookup type is not specified, Exim behaves as follows when trying to
20914 find an IP address for each host: First, a DNS lookup is done. If this yields
20915 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20916 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20917 result of the lookup is the result of that call.
20918
20919 .vindex "&$address_data$&"
20920 If the DATA field is set, its value is placed in the &$address_data$&
20921 variable. For example, this return line
20922 .code
20923 accept hosts=x1.y.example:x2.y.example data="rule1"
20924 .endd
20925 routes the address to the default transport, passing a list of two hosts. When
20926 the transport runs, the string &"rule1"& is in &$address_data$&.
20927 .ecindex IIDquerou1
20928 .ecindex IIDquerou2
20929
20930
20931
20932
20933 . ////////////////////////////////////////////////////////////////////////////
20934 . ////////////////////////////////////////////////////////////////////////////
20935
20936 .chapter "The redirect router" "CHAPredirect"
20937 .scindex IIDredrou1 "&(redirect)& router"
20938 .scindex IIDredrou2 "routers" "&(redirect)&"
20939 .cindex "alias file" "in a &(redirect)& router"
20940 .cindex "address redirection" "&(redirect)& router"
20941 The &(redirect)& router handles several kinds of address redirection. Its most
20942 common uses are for resolving local part aliases from a central alias file
20943 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20944 files, but it has many other potential uses. The incoming address can be
20945 redirected in several different ways:
20946
20947 .ilist
20948 It can be replaced by one or more new addresses which are themselves routed
20949 independently.
20950 .next
20951 It can be routed to be delivered to a given file or directory.
20952 .next
20953 It can be routed to be delivered to a specified pipe command.
20954 .next
20955 It can cause an automatic reply to be generated.
20956 .next
20957 It can be forced to fail, optionally with a custom error message.
20958 .next
20959 It can be temporarily deferred, optionally with a custom message.
20960 .next
20961 It can be discarded.
20962 .endlist
20963
20964 The generic &%transport%& option must not be set for &(redirect)& routers.
20965 However, there are some private options which define transports for delivery to
20966 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20967 &%pipe_transport%& and &%reply_transport%& descriptions below.
20968
20969 If success DSNs have been requested
20970 .cindex "DSN" "success"
20971 .cindex "Delivery Status Notification" "success"
20972 redirection triggers one and the DSN options are not passed any further.
20973
20974
20975
20976 .section "Redirection data" "SECID124"
20977 The router operates by interpreting a text string which it obtains either by
20978 expanding the contents of the &%data%& option, or by reading the entire
20979 contents of a file whose name is given in the &%file%& option. These two
20980 options are mutually exclusive. The first is commonly used for handling system
20981 aliases, in a configuration like this:
20982 .code
20983 system_aliases:
20984   driver = redirect
20985   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20986 .endd
20987 If the lookup fails, the expanded string in this example is empty. When the
20988 expansion of &%data%& results in an empty string, the router declines. A forced
20989 expansion failure also causes the router to decline; other expansion failures
20990 cause delivery to be deferred.
20991
20992 A configuration using &%file%& is commonly used for handling users'
20993 &_.forward_& files, like this:
20994 .code
20995 userforward:
20996   driver = redirect
20997   check_local_user
20998   file = $home/.forward
20999   no_verify
21000 .endd
21001 If the file does not exist, or causes no action to be taken (for example, it is
21002 empty or consists only of comments), the router declines. &*Warning*&: This
21003 is not the case when the file contains syntactically valid items that happen to
21004 yield empty addresses, for example, items containing only RFC 2822 address
21005 comments.
21006
21007 .cindex "tainted data" "in filenames"
21008 .cindex redirect "tainted data"
21009 Tainted data may not be used for a filename.
21010
21011 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21012 directly for redirection,
21013 as they are provided by a potential attacker.
21014 In the examples above, &$local_part$& is used for looking up data held locally
21015 on the system, and not used directly (the second example derives &$home$& via
21016 the passsword file or database, using &$local_part$&).
21017
21018
21019
21020 .section "Forward files and address verification" "SECID125"
21021 .cindex "address redirection" "while verifying"
21022 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21023 &_.forward_& files, as in the example above. There are two reasons for this:
21024
21025 .ilist
21026 When Exim is receiving an incoming SMTP message from a remote host, it is
21027 running under the Exim uid, not as root. Exim is unable to change uid to read
21028 the file as the user, and it may not be able to read it as the Exim user. So in
21029 practice the router may not be able to operate.
21030 .next
21031 However, even when the router can operate, the existence of a &_.forward_& file
21032 is unimportant when verifying an address. What should be checked is whether the
21033 local part is a valid user name or not. Cutting out the redirection processing
21034 saves some resources.
21035 .endlist
21036
21037
21038
21039
21040
21041
21042 .section "Interpreting redirection data" "SECID126"
21043 .cindex "Sieve filter" "specifying in redirection data"
21044 .cindex "filter" "specifying in redirection data"
21045 The contents of the data string, whether obtained from &%data%& or &%file%&,
21046 can be interpreted in two different ways:
21047
21048 .ilist
21049 If the &%allow_filter%& option is set true, and the data begins with the text
21050 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21051 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21052 respectively. Details of the syntax and semantics of filter files are described
21053 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21054 document is intended for use by end users.
21055 .next
21056 Otherwise, the data must be a comma-separated list of redirection items, as
21057 described in the next section.
21058 .endlist
21059
21060 When a message is redirected to a file (a &"mail folder"&), the filename given
21061 in a non-filter redirection list must always be an absolute path. A filter may
21062 generate a relative path &-- how this is handled depends on the transport's
21063 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21064 for the &(appendfile)& transport.
21065
21066
21067
21068 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21069 .cindex "address redirection" "non-filter list items"
21070 When the redirection data is not an Exim or Sieve filter, for example, if it
21071 comes from a conventional alias or forward file, it consists of a list of
21072 addresses, filenames, pipe commands, or certain special items (see section
21073 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21074 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21075 depending on their default values. The items in the list are separated by
21076 commas or newlines.
21077 If a comma is required in an item, the entire item must be enclosed in double
21078 quotes.
21079
21080 Lines starting with a # character are comments, and are ignored, and # may
21081 also appear following a comma, in which case everything between the # and the
21082 next newline character is ignored.
21083
21084 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21085 double quotes are retained because some forms of mail address require their use
21086 (but never to enclose the entire address). In the following description,
21087 &"item"& refers to what remains after any surrounding double quotes have been
21088 removed.
21089
21090 .vindex "&$local_part$&"
21091 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21092 and the expansion contains a reference to &$local_part$&, you should make use
21093 of the &%quote_local_part%& expansion operator, in case the local part contains
21094 special characters. For example, to redirect all mail for the domain
21095 &'obsolete.example'&, retaining the existing local part, you could use this
21096 setting:
21097 .code
21098 data = ${quote_local_part:$local_part}@newdomain.example
21099 .endd
21100
21101
21102 .section "Redirecting to a local mailbox" "SECTredlocmai"
21103 .cindex "routing" "loops in"
21104 .cindex "loop" "while routing, avoidance of"
21105 .cindex "address redirection" "to local mailbox"
21106 A redirection item may safely be the same as the address currently under
21107 consideration. This does not cause a routing loop, because a router is
21108 automatically skipped if any ancestor of the address that is being processed
21109 is the same as the current address and was processed by the current router.
21110 Such an address is therefore passed to the following routers, so it is handled
21111 as if there were no redirection. When making this loop-avoidance test, the
21112 complete local part, including any prefix or suffix, is used.
21113
21114 .cindex "address redirection" "local part without domain"
21115 Specifying the same local part without a domain is a common usage in personal
21116 filter files when the user wants to have messages delivered to the local
21117 mailbox and also forwarded elsewhere. For example, the user whose login is
21118 &'cleo'& might have a &_.forward_& file containing this:
21119 .code
21120 cleo, cleopatra@egypt.example
21121 .endd
21122 .cindex "backslash in alias file"
21123 .cindex "alias file" "backslash in"
21124 For compatibility with other MTAs, such unqualified local parts may be
21125 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21126 it does make a difference if more than one domain is being handled
21127 synonymously.
21128
21129 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21130 2822 address that does not include a domain, the item is qualified using the
21131 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21132 addresses are qualified using the value in &%qualify_recipient%&, but you can
21133 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21134
21135 Care must be taken if there are alias names for local users.
21136 Consider an MTA handling a single local domain where the system alias file
21137 contains:
21138 .code
21139 Sam.Reman: spqr
21140 .endd
21141 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21142 messages in the local mailbox, and also forward copies elsewhere. He creates
21143 this forward file:
21144 .code
21145 Sam.Reman, spqr@reme.elsewhere.example
21146 .endd
21147 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21148 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21149 second time round, because it has previously routed it,
21150 and the following routers presumably cannot handle the alias. The forward file
21151 should really contain
21152 .code
21153 spqr, spqr@reme.elsewhere.example
21154 .endd
21155 but because this is such a common error, the &%check_ancestor%& option (see
21156 below) exists to provide a way to get round it. This is normally set on a
21157 &(redirect)& router that is handling users' &_.forward_& files.
21158
21159
21160
21161 .section "Special items in redirection lists" "SECTspecitredli"
21162 In addition to addresses, the following types of item may appear in redirection
21163 lists (that is, in non-filter redirection data):
21164
21165 .ilist
21166 .cindex "pipe" "in redirection list"
21167 .cindex "address redirection" "to pipe"
21168 An item is treated as a pipe command if it begins with &"|"& and does not parse
21169 as a valid RFC 2822 address that includes a domain. A transport for running the
21170 command must be specified by the &%pipe_transport%& option.
21171 Normally, either the router or the transport specifies a user and a group under
21172 which to run the delivery. The default is to use the Exim user and group.
21173
21174 Single or double quotes can be used for enclosing the individual arguments of
21175 the pipe command; no interpretation of escapes is done for single quotes. If
21176 the command contains a comma character, it is necessary to put the whole item
21177 in double quotes, for example:
21178 .code
21179 "|/some/command ready,steady,go"
21180 .endd
21181 since items in redirection lists are terminated by commas. Do not, however,
21182 quote just the command. An item such as
21183 .code
21184 |"/some/command ready,steady,go"
21185 .endd
21186 is interpreted as a pipe with a rather strange command name, and no arguments.
21187
21188 Note that the above example assumes that the text comes from a lookup source
21189 of some sort, so that the quotes are part of the data.  If composing a
21190 redirect router with a &%data%& option directly specifying this command, the
21191 quotes will be used by the configuration parser to define the extent of one
21192 string, but will not be passed down into the redirect router itself.  There
21193 are two main approaches to get around this: escape quotes to be part of the
21194 data itself, or avoid using this mechanism and instead create a custom
21195 transport with the &%command%& option set and reference that transport from
21196 an &%accept%& router.
21197
21198 .next
21199 .cindex "file" "in redirection list"
21200 .cindex "address redirection" "to file"
21201 An item is interpreted as a path name if it begins with &"/"& and does not
21202 parse as a valid RFC 2822 address that includes a domain. For example,
21203 .code
21204 /home/world/minbari
21205 .endd
21206 is treated as a filename, but
21207 .code
21208 /s=molari/o=babylon/@x400gate.way
21209 .endd
21210 is treated as an address. For a filename, a transport must be specified using
21211 the &%file_transport%& option. However, if the generated path name ends with a
21212 forward slash character, it is interpreted as a directory name rather than a
21213 filename, and &%directory_transport%& is used instead.
21214
21215 Normally, either the router or the transport specifies a user and a group under
21216 which to run the delivery. The default is to use the Exim user and group.
21217
21218 .cindex "&_/dev/null_&"
21219 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21220 bypassed at a high level, and the log entry shows &"**bypassed**"&
21221 instead of a transport name. In this case the user and group are not used.
21222
21223 .next
21224 .cindex "included address list"
21225 .cindex "address redirection" "included external list"
21226 If an item is of the form
21227 .code
21228 :include:<path name>
21229 .endd
21230 a list of further items is taken from the given file and included at that
21231 point. &*Note*&: Such a file can not be a filter file; it is just an
21232 out-of-line addition to the list. The items in the included list are separated
21233 by commas or newlines and are not subject to expansion. If this is the first
21234 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21235 the alias name. This example is incorrect:
21236 .code
21237 list1    :include:/opt/lists/list1
21238 .endd
21239 It must be given as
21240 .code
21241 list1:   :include:/opt/lists/list1
21242 .endd
21243 .cindex "tainted data" "in filenames"
21244 .cindex redirect "tainted data"
21245 Tainted data may not be used for a filename.
21246 .next
21247 .cindex "address redirection" "to black hole"
21248 .cindex "delivery" "discard"
21249 .cindex "delivery" "blackhole"
21250 .cindex "black hole"
21251 .cindex "abandoning mail"
21252 Sometimes you want to throw away mail to a particular local part.  Making the
21253 &%data%& option expand to an empty string does not work, because that causes
21254 the router to decline. Instead, the alias item
21255 .code
21256 :blackhole:
21257 .endd
21258 can be used. It does what its name implies. No delivery is
21259 done, and no error message is generated. This has the same effect as specifying
21260 &_/dev/null_& as a destination, but it can be independently disabled.
21261
21262 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21263 delivery is done for the original local part, even if other redirection items
21264 are present. If you are generating a multi-item list (for example, by reading a
21265 database) and need the ability to provide a no-op item, you must use
21266 &_/dev/null_&.
21267
21268 .next
21269 .cindex "delivery" "forcing failure"
21270 .cindex "delivery" "forcing deferral"
21271 .cindex "failing delivery" "forcing"
21272 .cindex "deferred delivery, forcing"
21273 .cindex "customizing" "failure message"
21274 An attempt to deliver a particular address can be deferred or forced to fail by
21275 redirection items of the form
21276 .code
21277 :defer:
21278 :fail:
21279 .endd
21280 respectively. When a redirection list contains such an item, it applies
21281 to the entire redirection; any other items in the list are ignored. Any
21282 text following &':fail:'& or &':defer:'& is placed in the error text
21283 associated with the failure. For example, an alias file might contain:
21284 .code
21285 X.Employee:  :fail: Gone away, no forwarding address
21286 .endd
21287 In the case of an address that is being verified from an ACL or as the subject
21288 of a
21289 .cindex "VRFY" "error text, display of"
21290 VRFY command, the text is included in the SMTP error response by
21291 default.
21292 .cindex "EXPN" "error text, display of"
21293 The text is not included in the response to an EXPN command. In non-SMTP cases
21294 the text is included in the error message that Exim generates.
21295
21296 .cindex "SMTP" "error codes"
21297 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21298 &':fail:'&. However, if the message starts with three digits followed by a
21299 space, optionally followed by an extended code of the form &'n.n.n'&, also
21300 followed by a space, and the very first digit is the same as the default error
21301 code, the code from the message is used instead. If the very first digit is
21302 incorrect, a panic error is logged, and the default code is used. You can
21303 suppress the use of the supplied code in a redirect router by setting the
21304 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21305 ignored.
21306
21307 .vindex "&$acl_verify_message$&"
21308 In an ACL, an explicitly provided message overrides the default, but the
21309 default message is available in the variable &$acl_verify_message$& and can
21310 therefore be included in a custom message if this is desired.
21311
21312 Normally the error text is the rest of the redirection list &-- a comma does
21313 not terminate it &-- but a newline does act as a terminator. Newlines are not
21314 normally present in alias expansions. In &(lsearch)& lookups they are removed
21315 as part of the continuation process, but they may exist in other kinds of
21316 lookup and in &':include:'& files.
21317
21318 During routing for message delivery (as opposed to verification), a redirection
21319 containing &':fail:'& causes an immediate failure of the incoming address,
21320 whereas &':defer:'& causes the message to remain in the queue so that a
21321 subsequent delivery attempt can happen at a later time. If an address is
21322 deferred for too long, it will ultimately fail, because the normal retry
21323 rules still apply.
21324
21325 .next
21326 .cindex "alias file" "exception to default"
21327 Sometimes it is useful to use a single-key search type with a default (see
21328 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21329 for exceptions to the default. These can be handled by aliasing them to
21330 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21331 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21332 results in an empty redirection list has the same effect.
21333 .endlist
21334
21335
21336 .section "Duplicate addresses" "SECTdupaddr"
21337 .cindex "duplicate addresses"
21338 .cindex "address duplicate, discarding"
21339 .cindex "pipe" "duplicated"
21340 Exim removes duplicate addresses from the list to which it is delivering, so as
21341 to deliver just one copy to each address. This does not apply to deliveries
21342 routed to pipes by different immediate parent addresses, but an indirect
21343 aliasing scheme of the type
21344 .code
21345 pipe:       |/some/command $local_part
21346 localpart1: pipe
21347 localpart2: pipe
21348 .endd
21349 does not work with a message that is addressed to both local parts, because
21350 when the second is aliased to the intermediate local part &"pipe"& it gets
21351 discarded as being the same as a previously handled address. However, a scheme
21352 such as
21353 .code
21354 localpart1: |/some/command $local_part
21355 localpart2: |/some/command $local_part
21356 .endd
21357 does result in two different pipe deliveries, because the immediate parents of
21358 the pipes are distinct.
21359
21360
21361
21362 .section "Repeated redirection expansion" "SECID128"
21363 .cindex "repeated redirection expansion"
21364 .cindex "address redirection" "repeated for each delivery attempt"
21365 When a message cannot be delivered to all of its recipients immediately,
21366 leading to two or more delivery attempts, redirection expansion is carried out
21367 afresh each time for those addresses whose children were not all previously
21368 delivered. If redirection is being used as a mailing list, this can lead to new
21369 members of the list receiving copies of old messages. The &%one_time%& option
21370 can be used to avoid this.
21371
21372
21373 .section "Errors in redirection lists" "SECID129"
21374 .cindex "address redirection" "errors"
21375 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21376 error is skipped, and an entry is written to the main log. This may be useful
21377 for mailing lists that are automatically managed. Otherwise, if an error is
21378 detected while generating the list of new addresses, the original address is
21379 deferred. See also &%syntax_errors_to%&.
21380
21381
21382
21383 .section "Private options for the redirect router" "SECID130"
21384
21385 .cindex "options" "&(redirect)& router"
21386 The private options for the &(redirect)& router are as follows:
21387
21388
21389 .option allow_defer redirect boolean false
21390 Setting this option allows the use of &':defer:'& in non-filter redirection
21391 data, or the &%defer%& command in an Exim filter file.
21392
21393
21394 .option allow_fail redirect boolean false
21395 .cindex "failing delivery" "from filter"
21396 If this option is true, the &':fail:'& item can be used in a redirection list,
21397 and the &%fail%& command may be used in an Exim filter file.
21398
21399
21400 .option allow_filter redirect boolean false
21401 .cindex "filter" "enabling use of"
21402 .cindex "Sieve filter" "enabling use of"
21403 Setting this option allows Exim to interpret redirection data that starts with
21404 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21405 are some features of Exim filter files that some administrators may wish to
21406 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21407
21408 It is also possible to lock out Exim filters or Sieve filters while allowing
21409 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21410
21411
21412 The filter is run using the uid and gid set by the generic &%user%& and
21413 &%group%& options. These take their defaults from the password data if
21414 &%check_local_user%& is set, so in the normal case of users' personal filter
21415 files, the filter is run as the relevant user. When &%allow_filter%& is set
21416 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21417
21418
21419
21420 .option allow_freeze redirect boolean false
21421 .cindex "freezing messages" "allowing in filter"
21422 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21423 This command is more normally encountered in system filters, and is disabled by
21424 default for redirection filters because it isn't something you usually want to
21425 let ordinary users do.
21426
21427
21428
21429 .option check_ancestor redirect boolean false
21430 This option is concerned with handling generated addresses that are the same
21431 as some address in the list of redirection ancestors of the current address.
21432 Although it is turned off by default in the code, it is set in the default
21433 configuration file for handling users' &_.forward_& files. It is recommended
21434 for this use of the &(redirect)& router.
21435
21436 When &%check_ancestor%& is set, if a generated address (including the domain)
21437 is the same as any ancestor of the current address, it is replaced by a copy of
21438 the current address. This helps in the case where local part A is aliased to B,
21439 and B has a &_.forward_& file pointing back to A. For example, within a single
21440 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21441 &_&~jb/.forward_& contains:
21442 .code
21443 \Joe.Bloggs, <other item(s)>
21444 .endd
21445 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21446 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21447 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21448 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21449 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21450 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21451 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21452 original address. See also the &%repeat_use%& option below.
21453
21454
21455 .option check_group redirect boolean "see below"
21456 When the &%file%& option is used, the group owner of the file is checked only
21457 when this option is set. The permitted groups are those listed in the
21458 &%owngroups%& option, together with the user's default group if
21459 &%check_local_user%& is set. If the file has the wrong group, routing is
21460 deferred. The default setting for this option is true if &%check_local_user%&
21461 is set and the &%modemask%& option permits the group write bit, or if the
21462 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21463
21464
21465
21466 .option check_owner redirect boolean "see below"
21467 When the &%file%& option is used, the owner of the file is checked only when
21468 this option is set. If &%check_local_user%& is set, the local user is
21469 permitted; otherwise the owner must be one of those listed in the &%owners%&
21470 option. The default value for this option is true if &%check_local_user%& or
21471 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21472
21473
21474 .option data redirect string&!! unset
21475 This option is mutually exclusive with &%file%&. One or other of them must be
21476 set, but not both. The contents of &%data%& are expanded, and then used as the
21477 list of forwarding items, or as a set of filtering instructions. If the
21478 expansion is forced to fail, or the result is an empty string or a string that
21479 has no effect (consists entirely of comments), the router declines.
21480
21481 When filtering instructions are used, the string must begin with &"#Exim
21482 filter"&, and all comments in the string, including this initial one, must be
21483 terminated with newline characters. For example:
21484 .code
21485 data = #Exim filter\n\
21486        if $h_to: contains Exim then save $home/mail/exim endif
21487 .endd
21488 If you are reading the data from a database where newlines cannot be included,
21489 you can use the &${sg}$& expansion item to turn the escape string of your
21490 choice into a newline.
21491
21492
21493 .option directory_transport redirect string&!! unset
21494 A &(redirect)& router sets up a direct delivery to a directory when a path name
21495 ending with a slash is specified as a new &"address"&. The transport used is
21496 specified by this option, which, after expansion, must be the name of a
21497 configured transport. This should normally be an &(appendfile)& transport.
21498
21499
21500 .option file redirect string&!! unset
21501 This option specifies the name of a file that contains the redirection data. It
21502 is mutually exclusive with the &%data%& option. The string is expanded before
21503 use; if the expansion is forced to fail, the router declines. Other expansion
21504 failures cause delivery to be deferred. The result of a successful expansion
21505 must be an absolute path. The entire file is read and used as the redirection
21506 data. If the data is an empty string or a string that has no effect (consists
21507 entirely of comments), the router declines.
21508
21509 .cindex "NFS" "checking for file existence"
21510 If the attempt to open the file fails with a &"does not exist"& error, Exim
21511 runs a check on the containing directory,
21512 unless &%ignore_enotdir%& is true (see below).
21513 If the directory does not appear to exist, delivery is deferred. This can
21514 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21515 is a mount problem. If the containing directory does exist, but the file does
21516 not, the router declines.
21517
21518
21519 .option file_transport redirect string&!! unset
21520 .vindex "&$address_file$&"
21521 A &(redirect)& router sets up a direct delivery to a file when a path name not
21522 ending in a slash is specified as a new &"address"&. The transport used is
21523 specified by this option, which, after expansion, must be the name of a
21524 configured transport. This should normally be an &(appendfile)& transport. When
21525 it is running, the filename is in &$address_file$&.
21526
21527
21528 .option filter_prepend_home redirect boolean true
21529 When this option is true, if a &(save)& command in an Exim filter specifies a
21530 relative path, and &$home$& is defined, it is automatically prepended to the
21531 relative path. If this option is set false, this action does not happen. The
21532 relative path is then passed to the transport unmodified.
21533
21534
21535 .option forbid_blackhole redirect boolean false
21536 .cindex "restricting access to features"
21537 .cindex "filter" "locking out certain features"
21538 If this option is true, the &':blackhole:'& item may not appear in a
21539 redirection list.
21540
21541
21542 .option forbid_exim_filter redirect boolean false
21543 .cindex "restricting access to features"
21544 .cindex "filter" "locking out certain features"
21545 If this option is set true, only Sieve filters are permitted when
21546 &%allow_filter%& is true.
21547
21548
21549
21550
21551 .option forbid_file redirect boolean false
21552 .cindex "restricting access to features"
21553 .cindex "delivery" "to file; forbidding"
21554 .cindex "filter" "locking out certain features"
21555 .cindex "Sieve filter" "forbidding delivery to a file"
21556 .cindex "Sieve filter" "&""keep""& facility; disabling"
21557 If this option is true, this router may not generate a new address that
21558 specifies delivery to a local file or directory, either from a filter or from a
21559 conventional forward file. This option is forced to be true if &%one_time%& is
21560 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21561 locks out the Sieve's &"keep"& facility.
21562
21563
21564 .option forbid_filter_dlfunc redirect boolean false
21565 .cindex "restricting access to features"
21566 .cindex "filter" "locking out certain features"
21567 If this option is true, string expansions in Exim filters are not allowed to
21568 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21569 functions.
21570
21571 .option forbid_filter_existstest redirect boolean false
21572 .cindex "restricting access to features"
21573 .cindex "filter" "locking out certain features"
21574 .cindex "expansion" "statting a file"
21575 If this option is true, string expansions in Exim filters are not allowed to
21576 make use of the &%exists%& condition or the &%stat%& expansion item.
21577
21578 .option forbid_filter_logwrite redirect boolean false
21579 .cindex "restricting access to features"
21580 .cindex "filter" "locking out certain features"
21581 If this option is true, use of the logging facility in Exim filters is not
21582 permitted. Logging is in any case available only if the filter is being run
21583 under some unprivileged uid (which is normally the case for ordinary users'
21584 &_.forward_& files).
21585
21586
21587 .option forbid_filter_lookup redirect boolean false
21588 .cindex "restricting access to features"
21589 .cindex "filter" "locking out certain features"
21590 If this option is true, string expansions in Exim filter files are not allowed
21591 to make use of &%lookup%& items.
21592
21593
21594 .option forbid_filter_perl redirect boolean false
21595 .cindex "restricting access to features"
21596 .cindex "filter" "locking out certain features"
21597 This option has an effect only if Exim is built with embedded Perl support. If
21598 it is true, string expansions in Exim filter files are not allowed to make use
21599 of the embedded Perl support.
21600
21601
21602 .option forbid_filter_readfile redirect boolean false
21603 .cindex "restricting access to features"
21604 .cindex "filter" "locking out certain features"
21605 If this option is true, string expansions in Exim filter files are not allowed
21606 to make use of &%readfile%& items.
21607
21608
21609 .option forbid_filter_readsocket redirect boolean false
21610 .cindex "restricting access to features"
21611 .cindex "filter" "locking out certain features"
21612 If this option is true, string expansions in Exim filter files are not allowed
21613 to make use of &%readsocket%& items.
21614
21615
21616 .option forbid_filter_reply redirect boolean false
21617 .cindex "restricting access to features"
21618 .cindex "filter" "locking out certain features"
21619 If this option is true, this router may not generate an automatic reply
21620 message. Automatic replies can be generated only from Exim or Sieve filter
21621 files, not from traditional forward files. This option is forced to be true if
21622 &%one_time%& is set.
21623
21624
21625 .option forbid_filter_run redirect boolean false
21626 .cindex "restricting access to features"
21627 .cindex "filter" "locking out certain features"
21628 If this option is true, string expansions in Exim filter files are not allowed
21629 to make use of &%run%& items.
21630
21631
21632 .option forbid_include redirect boolean false
21633 .cindex "restricting access to features"
21634 .cindex "filter" "locking out certain features"
21635 If this option is true, items of the form
21636 .code
21637 :include:<path name>
21638 .endd
21639 are not permitted in non-filter redirection lists.
21640
21641
21642 .option forbid_pipe redirect boolean false
21643 .cindex "restricting access to features"
21644 .cindex "filter" "locking out certain features"
21645 .cindex "delivery" "to pipe; forbidding"
21646 If this option is true, this router may not generate a new address which
21647 specifies delivery to a pipe, either from an Exim filter or from a conventional
21648 forward file. This option is forced to be true if &%one_time%& is set.
21649
21650
21651 .option forbid_sieve_filter redirect boolean false
21652 .cindex "restricting access to features"
21653 .cindex "filter" "locking out certain features"
21654 If this option is set true, only Exim filters are permitted when
21655 &%allow_filter%& is true.
21656
21657
21658 .cindex "SMTP" "error codes"
21659 .option forbid_smtp_code redirect boolean false
21660 If this option is set true, any SMTP error codes that are present at the start
21661 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21662 the default codes (451 and 550, respectively) are always used.
21663
21664
21665
21666
21667 .option hide_child_in_errmsg redirect boolean false
21668 .cindex "bounce message" "redirection details; suppressing"
21669 If this option is true, it prevents Exim from quoting a child address if it
21670 generates a bounce or delay message for it. Instead it says &"an address
21671 generated from <&'the top level address'&>"&. Of course, this applies only to
21672 bounces generated locally. If a message is forwarded to another host, &'its'&
21673 bounce may well quote the generated address.
21674
21675
21676 .option ignore_eacces redirect boolean false
21677 .cindex "EACCES"
21678 If this option is set and an attempt to open a redirection file yields the
21679 EACCES error (permission denied), the &(redirect)& router behaves as if the
21680 file did not exist.
21681
21682
21683 .option ignore_enotdir redirect boolean false
21684 .cindex "ENOTDIR"
21685 If this option is set and an attempt to open a redirection file yields the
21686 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21687 router behaves as if the file did not exist.
21688
21689 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21690 router that has the &%file%& option set discovers that the file does not exist
21691 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21692 against unmounted NFS directories. If the parent can not be statted, delivery
21693 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21694 is set, because that option tells Exim to ignore &"something on the path is not
21695 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21696 that some operating systems give ENOENT where others give ENOTDIR.
21697
21698
21699
21700 .option include_directory redirect string unset
21701 If this option is set, the path names of any &':include:'& items in a
21702 redirection list must start with this directory.
21703
21704
21705 .option modemask redirect "octal integer" 022
21706 This specifies mode bits which must not be set for a file specified by the
21707 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21708
21709
21710 .option one_time redirect boolean false
21711 .cindex "one-time aliasing/forwarding expansion"
21712 .cindex "alias file" "one-time expansion"
21713 .cindex "forward file" "one-time expansion"
21714 .cindex "mailing lists" "one-time expansion"
21715 .cindex "address redirection" "one-time expansion"
21716 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21717 files each time it tries to deliver a message causes a problem when one or more
21718 of the generated addresses fails be delivered at the first attempt. The problem
21719 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21720 but of what happens when the redirection list changes during the time that the
21721 message is on Exim's queue. This is particularly true in the case of mailing
21722 lists, where new subscribers might receive copies of messages that were posted
21723 before they subscribed.
21724
21725 If &%one_time%& is set and any addresses generated by the router fail to
21726 deliver at the first attempt, the failing addresses are added to the message as
21727 &"top level"& addresses, and the parent address that generated them is marked
21728 &"delivered"&. Thus, redirection does not happen again at the next delivery
21729 attempt.
21730
21731 &*Warning 1*&: Any header line addition or removal that is specified by this
21732 router would be lost if delivery did not succeed at the first attempt. For this
21733 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21734 permitted when &%one_time%& is set.
21735
21736 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21737 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21738 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21739
21740 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21741 &%one_time%&.
21742
21743 The original top-level address is remembered with each of the generated
21744 addresses, and is output in any log messages. However, any intermediate parent
21745 addresses are not recorded. This makes a difference to the log only if
21746 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21747 typically be used for mailing lists, where there is normally just one level of
21748 expansion.
21749
21750
21751 .option owners redirect "string list" unset
21752 .cindex "ownership" "alias file"
21753 .cindex "ownership" "forward file"
21754 .cindex "alias file" "ownership"
21755 .cindex "forward file" "ownership"
21756 This specifies a list of permitted owners for the file specified by &%file%&.
21757 This list is in addition to the local user when &%check_local_user%& is set.
21758 See &%check_owner%& above.
21759
21760
21761 .option owngroups redirect "string list" unset
21762 This specifies a list of permitted groups for the file specified by &%file%&.
21763 The list is in addition to the local user's primary group when
21764 &%check_local_user%& is set. See &%check_group%& above.
21765
21766
21767 .option pipe_transport redirect string&!! unset
21768 .vindex "&$address_pipe$&"
21769 A &(redirect)& router sets up a direct delivery to a pipe when a string
21770 starting with a vertical bar character is specified as a new &"address"&. The
21771 transport used is specified by this option, which, after expansion, must be the
21772 name of a configured transport. This should normally be a &(pipe)& transport.
21773 When the transport is run, the pipe command is in &$address_pipe$&.
21774
21775
21776 .option qualify_domain redirect string&!! unset
21777 .vindex "&$qualify_recipient$&"
21778 If this option is set, and an unqualified address (one without a domain) is
21779 generated, and that address would normally be qualified by the global setting
21780 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21781 expanding this string. If the expansion fails, the router declines. If you want
21782 to revert to the default, you can have the expansion generate
21783 &$qualify_recipient$&.
21784
21785 This option applies to all unqualified addresses generated by Exim filters,
21786 but for traditional &_.forward_& files, it applies only to addresses that are
21787 not preceded by a backslash. Sieve filters cannot generate unqualified
21788 addresses.
21789
21790 .option qualify_preserve_domain redirect boolean false
21791 .cindex "domain" "in redirection; preserving"
21792 .cindex "preserving domain in redirection"
21793 .cindex "address redirection" "domain; preserving"
21794 If this option is set, the router's local &%qualify_domain%& option must not be
21795 set (a configuration error occurs if it is). If an unqualified address (one
21796 without a domain) is generated, it is qualified with the domain of the parent
21797 address (the immediately preceding ancestor) instead of the global
21798 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21799 this applies whether or not the address is preceded by a backslash.
21800
21801
21802 .option repeat_use redirect boolean true
21803 If this option is set false, the router is skipped for a child address that has
21804 any ancestor that was routed by this router. This test happens before any of
21805 the other preconditions are tested. Exim's default anti-looping rules skip
21806 only when the ancestor is the same as the current address. See also
21807 &%check_ancestor%& above and the generic &%redirect_router%& option.
21808
21809
21810 .option reply_transport redirect string&!! unset
21811 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21812 &%vacation%& command is used in a filter file. The transport used is specified
21813 by this option, which, after expansion, must be the name of a configured
21814 transport. This should normally be an &(autoreply)& transport. Other transports
21815 are unlikely to do anything sensible or useful.
21816
21817
21818 .option rewrite redirect boolean true
21819 .cindex "address redirection" "disabling rewriting"
21820 If this option is set false, addresses generated by the router are not
21821 subject to address rewriting. Otherwise, they are treated like new addresses
21822 and are rewritten according to the global rewriting rules.
21823
21824
21825 .option sieve_subaddress redirect string&!! unset
21826 The value of this option is passed to a Sieve filter to specify the
21827 :subaddress part of an address.
21828
21829 .option sieve_useraddress redirect string&!! unset
21830 The value of this option is passed to a Sieve filter to specify the :user part
21831 of an address. However, if it is unset, the entire original local part
21832 (including any prefix or suffix) is used for :user.
21833
21834
21835 .option sieve_vacation_directory redirect string&!! unset
21836 .cindex "Sieve filter" "vacation directory"
21837 To enable the &"vacation"& extension for Sieve filters, you must set
21838 &%sieve_vacation_directory%& to the directory where vacation databases are held
21839 (do not put anything else in that directory), and ensure that the
21840 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21841 needs their own directory; Exim will create it if necessary.
21842
21843
21844
21845 .option skip_syntax_errors redirect boolean false
21846 .cindex "forward file" "broken"
21847 .cindex "address redirection" "broken files"
21848 .cindex "alias file" "broken"
21849 .cindex "broken alias or forward files"
21850 .cindex "ignoring faulty addresses"
21851 .cindex "skipping faulty addresses"
21852 .cindex "error" "skipping bad syntax"
21853 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21854 non-filter redirection data are skipped, and each failing address is logged. If
21855 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21856 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21857 are expanded and placed at the head of the error message generated by
21858 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21859 be the same address as the generic &%errors_to%& option. The
21860 &%skip_syntax_errors%& option is often used when handling mailing lists.
21861
21862 If all the addresses in a redirection list are skipped because of syntax
21863 errors, the router declines to handle the original address, and it is passed to
21864 the following routers.
21865
21866 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21867 error in the filter causes filtering to be abandoned without any action being
21868 taken. The incident is logged, and the router declines to handle the address,
21869 so it is passed to the following routers.
21870
21871 .cindex "Sieve filter" "syntax errors in"
21872 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21873 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21874 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21875
21876 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21877 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21878 option, used with an address that does not get redirected, can be used to
21879 notify users of these errors, by means of a router like this:
21880 .code
21881 userforward:
21882   driver = redirect
21883   allow_filter
21884   check_local_user
21885   file = $home/.forward
21886   file_transport = address_file
21887   pipe_transport = address_pipe
21888   reply_transport = address_reply
21889   no_verify
21890   skip_syntax_errors
21891   syntax_errors_to = real-$local_part@$domain
21892   syntax_errors_text = \
21893    This is an automatically generated message. An error has\n\
21894    been found in your .forward file. Details of the error are\n\
21895    reported below. While this error persists, you will receive\n\
21896    a copy of this message for every message that is addressed\n\
21897    to you. If your .forward file is a filter file, or if it is\n\
21898    a non-filter file containing no valid forwarding addresses,\n\
21899    a copy of each incoming message will be put in your normal\n\
21900    mailbox. If a non-filter file contains at least one valid\n\
21901    forwarding address, forwarding to the valid addresses will\n\
21902    happen, and those will be the only deliveries that occur.
21903 .endd
21904 You also need a router to ensure that local addresses that are prefixed by
21905 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21906 put this immediately before the &(userforward)& router:
21907 .code
21908 real_localuser:
21909   driver = accept
21910   check_local_user
21911   local_part_prefix = real-
21912   transport = local_delivery
21913 .endd
21914 For security, it would probably be a good idea to restrict the use of this
21915 router to locally-generated messages, using a condition such as this:
21916 .code
21917   condition = ${if match {$sender_host_address}\
21918                          {\N^(|127\.0\.0\.1)$\N}}
21919 .endd
21920
21921
21922 .option syntax_errors_text redirect string&!! unset
21923 See &%skip_syntax_errors%& above.
21924
21925
21926 .option syntax_errors_to redirect string unset
21927 See &%skip_syntax_errors%& above.
21928 .ecindex IIDredrou1
21929 .ecindex IIDredrou2
21930
21931
21932
21933
21934
21935
21936 . ////////////////////////////////////////////////////////////////////////////
21937 . ////////////////////////////////////////////////////////////////////////////
21938
21939 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21940          "Environment for local transports"
21941 .scindex IIDenvlotra1 "local transports" "environment for"
21942 .scindex IIDenvlotra2 "environment" "local transports"
21943 .scindex IIDenvlotra3 "transport" "local; environment for"
21944 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21945 transport can be thought of as similar to a pipe.) Exim always runs transports
21946 in subprocesses, under specified uids and gids. Typical deliveries to local
21947 mailboxes run under the uid and gid of the local user.
21948
21949 Exim also sets a specific current directory while running the transport; for
21950 some transports a home directory setting is also relevant. The &(pipe)&
21951 transport is the only one that sets up environment variables; see section
21952 &<<SECTpipeenv>>& for details.
21953
21954 The values used for the uid, gid, and the directories may come from several
21955 different places. In many cases, the router that handles the address associates
21956 settings with that address as a result of its &%check_local_user%&, &%group%&,
21957 or &%user%& options. However, values may also be given in the transport's own
21958 configuration, and these override anything that comes from the router.
21959
21960
21961
21962 .section "Concurrent deliveries" "SECID131"
21963 .cindex "concurrent deliveries"
21964 .cindex "simultaneous deliveries"
21965 If two different messages for the same local recipient arrive more or less
21966 simultaneously, the two delivery processes are likely to run concurrently. When
21967 the &(appendfile)& transport is used to write to a file, Exim applies locking
21968 rules to stop concurrent processes from writing to the same file at the same
21969 time.
21970
21971 However, when you use a &(pipe)& transport, it is up to you to arrange any
21972 locking that is needed. Here is a silly example:
21973 .code
21974 my_transport:
21975   driver = pipe
21976   command = /bin/sh -c 'cat >>/some/file'
21977 .endd
21978 This is supposed to write the message at the end of the file. However, if two
21979 messages arrive at the same time, the file will be scrambled. You can use the
21980 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21981 file using the same algorithm that Exim itself uses.
21982
21983
21984
21985
21986 .section "Uids and gids" "SECTenvuidgid"
21987 .cindex "local transports" "uid and gid"
21988 .cindex "transport" "local; uid and gid"
21989 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21990 overrides any group that the router set in the address, even if &%user%& is not
21991 set for the transport. This makes it possible, for example, to run local mail
21992 delivery under the uid of the recipient (set by the router), but in a special
21993 group (set by the transport). For example:
21994 .code
21995 # Routers ...
21996 # User/group are set by check_local_user in this router
21997 local_users:
21998   driver = accept
21999   check_local_user
22000   transport = group_delivery
22001
22002 # Transports ...
22003 # This transport overrides the group
22004 group_delivery:
22005   driver = appendfile
22006   file = /var/spool/mail/$local_part_data
22007   group = mail
22008 .endd
22009 If &%user%& is set for a transport, its value overrides what is set in the
22010 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22011 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22012 set.
22013
22014 .oindex "&%initgroups%&"
22015 When the uid is taken from the transport's configuration, the &[initgroups()]&
22016 function is called for the groups associated with that uid if the
22017 &%initgroups%& option is set for the transport. When the uid is not specified
22018 by the transport, but is associated with the address by a router, the option
22019 for calling &[initgroups()]& is taken from the router configuration.
22020
22021 .cindex "&(pipe)& transport" "uid for"
22022 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22023 is set and &%user%& is not set, the uid of the process that called Exim to
22024 receive the message is used, and if &%group%& is not set, the corresponding
22025 original gid is also used.
22026
22027 This is the detailed preference order for obtaining a gid; the first of the
22028 following that is set is used:
22029
22030 .ilist
22031 A &%group%& setting of the transport;
22032 .next
22033 A &%group%& setting of the router;
22034 .next
22035 A gid associated with a user setting of the router, either as a result of
22036 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22037 .next
22038 The group associated with a non-numeric &%user%& setting of the transport;
22039 .next
22040 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22041 the uid is the creator's uid;
22042 .next
22043 The Exim gid if the Exim uid is being used as a default.
22044 .endlist
22045
22046 If, for example, the user is specified numerically on the router and there are
22047 no group settings, no gid is available. In this situation, an error occurs.
22048 This is different for the uid, for which there always is an ultimate default.
22049 The first of the following that is set is used:
22050
22051 .ilist
22052 A &%user%& setting of the transport;
22053 .next
22054 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22055 .next
22056 A &%user%& setting of the router;
22057 .next
22058 A &%check_local_user%& setting of the router;
22059 .next
22060 The Exim uid.
22061 .endlist
22062
22063 Of course, an error will still occur if the uid that is chosen is on the
22064 &%never_users%& list.
22065
22066
22067
22068
22069
22070 .section "Current and home directories" "SECID132"
22071 .cindex "current directory for local transport"
22072 .cindex "home directory" "for local transport"
22073 .cindex "transport" "local; home directory for"
22074 .cindex "transport" "local; current directory for"
22075 Routers may set current and home directories for local transports by means of
22076 the &%transport_current_directory%& and &%transport_home_directory%& options.
22077 However, if the transport's &%current_directory%& or &%home_directory%& options
22078 are set, they override the router's values. In detail, the home directory
22079 for a local transport is taken from the first of these values that is set:
22080
22081 .ilist
22082 The &%home_directory%& option on the transport;
22083 .next
22084 The &%transport_home_directory%& option on the router;
22085 .next
22086 The password data if &%check_local_user%& is set on the router;
22087 .next
22088 The &%router_home_directory%& option on the router.
22089 .endlist
22090
22091 The current directory is taken from the first of these values that is set:
22092
22093 .ilist
22094 The &%current_directory%& option on the transport;
22095 .next
22096 The &%transport_current_directory%& option on the router.
22097 .endlist
22098
22099
22100 If neither the router nor the transport sets a current directory, Exim uses the
22101 value of the home directory, if it is set. Otherwise it sets the current
22102 directory to &_/_& before running a local transport.
22103
22104
22105
22106 .section "Expansion variables derived from the address" "SECID133"
22107 .vindex "&$domain$&"
22108 .vindex "&$local_part$&"
22109 .vindex "&$original_domain$&"
22110 Normally a local delivery is handling a single address, and in that case the
22111 variables such as &$domain$& and &$local_part$& are set during local
22112 deliveries. However, in some circumstances more than one address may be handled
22113 at once (for example, while writing batch SMTP for onward transmission by some
22114 other means). In this case, the variables associated with the local part are
22115 never set, &$domain$& is set only if all the addresses have the same domain,
22116 and &$original_domain$& is never set.
22117 .ecindex IIDenvlotra1
22118 .ecindex IIDenvlotra2
22119 .ecindex IIDenvlotra3
22120
22121
22122
22123
22124
22125
22126
22127 . ////////////////////////////////////////////////////////////////////////////
22128 . ////////////////////////////////////////////////////////////////////////////
22129
22130 .chapter "Generic options for transports" "CHAPtransportgeneric"
22131 .scindex IIDgenoptra1 "generic options" "transport"
22132 .scindex IIDgenoptra2 "options" "generic; for transports"
22133 .scindex IIDgenoptra3 "transport" "generic options for"
22134 The following generic options apply to all transports:
22135
22136
22137 .option body_only transports boolean false
22138 .cindex "transport" "body only"
22139 .cindex "message" "transporting body only"
22140 .cindex "body of message" "transporting"
22141 If this option is set, the message's headers are not transported. It is
22142 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22143 or &(pipe)& transports, the settings of &%message_prefix%& and
22144 &%message_suffix%& should be checked, because this option does not
22145 automatically suppress them.
22146
22147
22148 .option current_directory transports string&!! unset
22149 .cindex "transport" "current directory for"
22150 This specifies the current directory that is to be set while running the
22151 transport, overriding any value that may have been set by the router.
22152 If the expansion fails for any reason, including forced failure, an error is
22153 logged, and delivery is deferred.
22154
22155
22156 .option disable_logging transports boolean false
22157 If this option is set true, nothing is logged for any
22158 deliveries by the transport or for any
22159 transport errors. You should not set this option unless you really, really know
22160 what you are doing.
22161
22162
22163 .option debug_print transports string&!! unset
22164 .cindex "testing" "variables in drivers"
22165 If this option is set and debugging is enabled (see the &%-d%& command line
22166 option), the string is expanded and included in the debugging output when the
22167 transport is run.
22168 If expansion of the string fails, the error message is written to the debugging
22169 output, and Exim carries on processing.
22170 This facility is provided to help with checking out the values of variables and
22171 so on when debugging driver configurations. For example, if a &%headers_add%&
22172 option is not working properly, &%debug_print%& could be used to output the
22173 variables it references. A newline is added to the text if it does not end with
22174 one.
22175 The variables &$transport_name$& and &$router_name$& contain the name of the
22176 transport and the router that called it.
22177
22178 .option delivery_date_add transports boolean false
22179 .cindex "&'Delivery-date:'& header line"
22180 If this option is true, a &'Delivery-date:'& header is added to the message.
22181 This gives the actual time the delivery was made. As this is not a standard
22182 header, Exim has a configuration option (&%delivery_date_remove%&) which
22183 requests its removal from incoming messages, so that delivered messages can
22184 safely be resent to other recipients.
22185
22186
22187 .option driver transports string unset
22188 This specifies which of the available transport drivers is to be used.
22189 There is no default, and this option must be set for every transport.
22190
22191
22192 .option envelope_to_add transports boolean false
22193 .cindex "&'Envelope-to:'& header line"
22194 If this option is true, an &'Envelope-to:'& header is added to the message.
22195 This gives the original address(es) in the incoming envelope that caused this
22196 delivery to happen. More than one address may be present if the transport is
22197 configured to handle several addresses at once, or if more than one original
22198 address was redirected to the same final address. As this is not a standard
22199 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22200 its removal from incoming messages, so that delivered messages can safely be
22201 resent to other recipients.
22202
22203
22204 .option event_action transports string&!! unset
22205 .cindex events
22206 This option declares a string to be expanded for Exim's events mechanism.
22207 For details see chapter &<<CHAPevents>>&.
22208
22209
22210 .option group transports string&!! "Exim group"
22211 .cindex "transport" "group; specifying"
22212 This option specifies a gid for running the transport process, overriding any
22213 value that the router supplies, and also overriding any value associated with
22214 &%user%& (see below).
22215
22216
22217 .option headers_add transports list&!! unset
22218 .cindex "header lines" "adding in transport"
22219 .cindex "transport" "header lines; adding"
22220 This option specifies a list of text headers,
22221 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22222 which are (separately) expanded and added to the header
22223 portion of a message as it is transported, as described in section
22224 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22225 routers. If the result of the expansion is an empty string, or if the expansion
22226 is forced to fail, no action is taken. Other expansion failures are treated as
22227 errors and cause the delivery to be deferred.
22228
22229 Unlike most options, &%headers_add%& can be specified multiple times
22230 for a transport; all listed headers are added.
22231
22232
22233 .option headers_only transports boolean false
22234 .cindex "transport" "header lines only"
22235 .cindex "message" "transporting headers only"
22236 .cindex "header lines" "transporting"
22237 If this option is set, the message's body is not transported. It is mutually
22238 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22239 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22240 checked, since this option does not automatically suppress them.
22241
22242
22243 .option headers_remove transports list&!! unset
22244 .cindex "header lines" "removing"
22245 .cindex "transport" "header lines; removing"
22246 This option specifies a list of text headers,
22247 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22248 to be removed from the message.
22249 However, the option has no effect when an address is just being verified.
22250 Each list item is separately expanded.
22251 If the result of the expansion is an empty string, or if the expansion
22252 is forced to fail, no action is taken. Other expansion failures are treated as
22253 errors and cause the delivery to be deferred.
22254 If an item ends in *, it will match any header with the given prefix.
22255
22256 Matching headers are omitted from the message as it is transported, as described
22257 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22258 routers.
22259
22260 Unlike most options, &%headers_remove%& can be specified multiple times
22261 for a transport; all listed headers are removed.
22262
22263 &*Warning*&: Because of the separate expansion of the list items,
22264 items that contain a list separator must have it doubled.
22265 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22266
22267
22268
22269 .option headers_rewrite transports string unset
22270 .cindex "transport" "header lines; rewriting"
22271 .cindex "rewriting" "at transport time"
22272 This option allows addresses in header lines to be rewritten at transport time,
22273 that is, as the message is being copied to its destination. The contents of the
22274 option are a colon-separated list of rewriting rules. Each rule is in exactly
22275 the same form as one of the general rewriting rules that are applied when a
22276 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22277 example,
22278 .code
22279 headers_rewrite = a@b c@d f : \
22280                   x@y w@z
22281 .endd
22282 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22283 &'w@z'& in all address-bearing header lines. The rules are applied to the
22284 header lines just before they are written out at transport time, so they affect
22285 only those copies of the message that pass through the transport. However, only
22286 the message's original header lines, and any that were added by a system
22287 filter, are rewritten. If a router or transport adds header lines, they are not
22288 affected by this option. These rewriting rules are &'not'& applied to the
22289 envelope. You can change the return path using &%return_path%&, but you cannot
22290 change envelope recipients at this time.
22291
22292
22293 .option home_directory transports string&!! unset
22294 .cindex "transport" "home directory for"
22295 .vindex "&$home$&"
22296 This option specifies a home directory setting for a local transport,
22297 overriding any value that may be set by the router. The home directory is
22298 placed in &$home$& while expanding the transport's private options. It is also
22299 used as the current directory if no current directory is set by the
22300 &%current_directory%& option on the transport or the
22301 &%transport_current_directory%& option on the router. If the expansion fails
22302 for any reason, including forced failure, an error is logged, and delivery is
22303 deferred.
22304
22305
22306 .option initgroups transports boolean false
22307 .cindex "additional groups"
22308 .cindex "groups" "additional"
22309 .cindex "transport" "group; additional"
22310 If this option is true and the uid for the delivery process is provided by the
22311 transport, the &[initgroups()]& function is called when running the transport
22312 to ensure that any additional groups associated with the uid are set up.
22313
22314
22315 .option max_parallel transports integer&!! unset
22316 .cindex limit "transport parallelism"
22317 .cindex transport "parallel processes"
22318 .cindex transport "concurrency limit"
22319 .cindex "delivery" "parallelism for transport"
22320 If this option is set and expands to an integer greater than zero
22321 it limits the number of concurrent runs of the transport.
22322 The control does not apply to shadow transports.
22323
22324 .cindex "hints database" "transport concurrency control"
22325 Exim implements this control by means of a hints database in which a record is
22326 incremented whenever a transport process is being created. The record
22327 is decremented and possibly removed when the process terminates.
22328 Obviously there is scope for
22329 records to get left lying around if there is a system or program crash. To
22330 guard against this, Exim ignores any records that are more than six hours old.
22331
22332 If you use this option, you should also arrange to delete the
22333 relevant hints database whenever your system reboots. The names of the files
22334 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22335 may be one or two files, depending on the type of DBM in use. The same files
22336 are used for ETRN and smtp transport serialization.
22337
22338
22339 .option message_size_limit transports string&!! 0
22340 .cindex "limit" "message size per transport"
22341 .cindex "size" "of message, limit"
22342 .cindex "transport" "message size; limiting"
22343 This option controls the size of messages passed through the transport. It is
22344 expanded before use; the result of the expansion must be a sequence of decimal
22345 digits, optionally followed by K or M. If the expansion fails for any reason,
22346 including forced failure, or if the result is not of the required form,
22347 delivery is deferred. If the value is greater than zero and the size of a
22348 message exceeds this limit, the address is failed. If there is any chance that
22349 the resulting bounce message could be routed to the same transport, you should
22350 ensure that &%return_size_limit%& is less than the transport's
22351 &%message_size_limit%&, as otherwise the bounce message will fail to get
22352 delivered.
22353
22354
22355
22356 .option rcpt_include_affixes transports boolean false
22357 .cindex "prefix" "for local part, including in envelope"
22358 .cindex "suffix for local part" "including in envelope"
22359 .cindex "local part" "prefix"
22360 .cindex "local part" "suffix"
22361 When this option is false (the default), and an address that has had any
22362 affixes (prefixes or suffixes) removed from the local part is delivered by any
22363 form of SMTP or LMTP, the affixes are not included. For example, if a router
22364 that contains
22365 .code
22366 local_part_prefix = *-
22367 .endd
22368 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22369 is delivered with
22370 .code
22371 RCPT TO:<xyz@some.domain>
22372 .endd
22373 This is also the case when an ACL-time callout is being used to verify a
22374 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22375 whole local part is included in the RCPT command. This option applies to BSMTP
22376 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22377 &(lmtp)& and &(smtp)& transports.
22378
22379
22380 .option retry_use_local_part transports boolean "see below"
22381 .cindex "hints database" "retry keys"
22382 When a delivery suffers a temporary failure, a retry record is created
22383 in Exim's hints database. For remote deliveries, the key for the retry record
22384 is based on the name and/or IP address of the failing remote host. For local
22385 deliveries, the key is normally the entire address, including both the local
22386 part and the domain. This is suitable for most common cases of local delivery
22387 temporary failure &-- for example, exceeding a mailbox quota should delay only
22388 deliveries to that mailbox, not to the whole domain.
22389
22390 However, in some special cases you may want to treat a temporary local delivery
22391 as a failure associated with the domain, and not with a particular local part.
22392 (For example, if you are storing all mail for some domain in files.) You can do
22393 this by setting &%retry_use_local_part%& false.
22394
22395 For all the local transports, its default value is true. For remote transports,
22396 the default value is false for tidiness, but changing the value has no effect
22397 on a remote transport in the current implementation.
22398
22399
22400 .option return_path transports string&!! unset
22401 .cindex "envelope sender"
22402 .cindex "envelope from"
22403 .cindex "transport" "return path; changing"
22404 .cindex "return path" "changing in transport"
22405 If this option is set, the string is expanded at transport time and replaces
22406 the existing return path (envelope sender) value in the copy of the message
22407 that is being delivered. An empty return path is permitted. This feature is
22408 designed for remote deliveries, where the value of this option is used in the
22409 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22410 only effect is to change the address that is placed in the &'Return-path:'&
22411 header line, if one is added to the message (see the next option).
22412
22413 &*Note:*& A changed return path is not logged unless you add
22414 &%return_path_on_delivery%& to the log selector.
22415
22416 .vindex "&$return_path$&"
22417 The expansion can refer to the existing value via &$return_path$&. This is
22418 either the message's envelope sender, or an address set by the
22419 &%errors_to%& option on a router. If the expansion is forced to fail, no
22420 replacement occurs; if it fails for another reason, delivery is deferred. This
22421 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22422 section &<<SECTverp>>&.
22423
22424 &*Note*&: If a delivery error is detected locally, including the case when a
22425 remote server rejects a message at SMTP time, the bounce message is not sent to
22426 the value of this option. It is sent to the previously set errors address.
22427 This defaults to the incoming sender address, but can be changed by setting
22428 &%errors_to%& in a router.
22429
22430
22431
22432 .option return_path_add transports boolean false
22433 .cindex "&'Return-path:'& header line"
22434 If this option is true, a &'Return-path:'& header is added to the message.
22435 Although the return path is normally available in the prefix line of BSD
22436 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22437 have easy access to it.
22438
22439 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22440 the delivery SMTP server makes the final delivery"&. This implies that this
22441 header should not be present in incoming messages. Exim has a configuration
22442 option, &%return_path_remove%&, which requests removal of this header from
22443 incoming messages, so that delivered messages can safely be resent to other
22444 recipients.
22445
22446
22447 .option shadow_condition transports string&!! unset
22448 See &%shadow_transport%& below.
22449
22450
22451 .option shadow_transport transports string unset
22452 .cindex "shadow transport"
22453 .cindex "transport" "shadow"
22454 A local transport may set the &%shadow_transport%& option to the name of
22455 another local transport. Shadow remote transports are not supported.
22456
22457 Whenever a delivery to the main transport succeeds, and either
22458 &%shadow_condition%& is unset, or its expansion does not result in the empty
22459 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22460 passed to the shadow transport, with the same delivery address or addresses. If
22461 expansion fails, no action is taken except that non-forced expansion failures
22462 cause a log line to be written.
22463
22464 The result of the shadow transport is discarded and does not affect the
22465 subsequent processing of the message. Only a single level of shadowing is
22466 provided; the &%shadow_transport%& option is ignored on any transport when it
22467 is running as a shadow. Options concerned with output from pipes are also
22468 ignored. The log line for the successful delivery has an item added on the end,
22469 of the form
22470 .code
22471 ST=<shadow transport name>
22472 .endd
22473 If the shadow transport did not succeed, the error message is put in
22474 parentheses afterwards. Shadow transports can be used for a number of different
22475 purposes, including keeping more detailed log information than Exim normally
22476 provides, and implementing automatic acknowledgment policies based on message
22477 headers that some sites insist on.
22478
22479
22480 .option transport_filter transports string&!! unset
22481 .cindex "transport" "filter"
22482 .cindex "filter" "transport filter"
22483 This option sets up a filtering (in the Unix shell sense) process for messages
22484 at transport time. It should not be confused with mail filtering as set up by
22485 individual users or via a system filter.
22486 If unset, or expanding to an empty string, no filtering is done.
22487
22488 When the message is about to be written out, the command specified by
22489 &%transport_filter%& is started up in a separate, parallel process, and
22490 the entire message, including the header lines, is passed to it on its standard
22491 input (this in fact is done from a third process, to avoid deadlock). The
22492 command must be specified as an absolute path.
22493
22494 The lines of the message that are written to the transport filter are
22495 terminated by newline (&"\n"&). The message is passed to the filter before any
22496 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22497 lines beginning with a dot, and also before any processing implied by the
22498 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22499 &(pipe)& transports.
22500
22501 The standard error for the filter process is set to the same destination as its
22502 standard output; this is read and written to the message's ultimate
22503 destination. The process that writes the message to the filter, the
22504 filter itself, and the original process that reads the result and delivers it
22505 are all run in parallel, like a shell pipeline.
22506
22507 The filter can perform any transformations it likes, but of course should take
22508 care not to break RFC 2822 syntax. Exim does not check the result, except to
22509 test for a final newline when SMTP is in use. All messages transmitted over
22510 SMTP must end with a newline, so Exim supplies one if it is missing.
22511
22512 .cindex "content scanning" "per user"
22513 A transport filter can be used to provide content-scanning on a per-user basis
22514 at delivery time if the only required effect of the scan is to modify the
22515 message. For example, a content scan could insert a new header line containing
22516 a spam score. This could be interpreted by a filter in the user's MUA. It is
22517 not possible to discard a message at this stage.
22518
22519 .cindex "SIZE" "ESMTP extension"
22520 A problem might arise if the filter increases the size of a message that is
22521 being sent down an SMTP connection. If the receiving SMTP server has indicated
22522 support for the SIZE parameter, Exim will have sent the size of the message
22523 at the start of the SMTP session. If what is actually sent is substantially
22524 more, the server might reject the message. This can be worked round by setting
22525 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22526 additions to the message, or to disable the use of SIZE altogether.
22527
22528 .vindex "&$pipe_addresses$&"
22529 The value of the &%transport_filter%& option is the command string for starting
22530 the filter, which is run directly from Exim, not under a shell. The string is
22531 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22532 Exim breaks it up into arguments and then expands each argument separately (see
22533 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22534 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22535 of arguments, one for each address that applies to this delivery. (This isn't
22536 an ideal name for this feature here, but as it was already implemented for the
22537 &(pipe)& transport, it seemed sensible not to change it.)
22538
22539 .vindex "&$host$&"
22540 .vindex "&$host_address$&"
22541 The expansion variables &$host$& and &$host_address$& are available when the
22542 transport is a remote one. They contain the name and IP address of the host to
22543 which the message is being sent. For example:
22544 .code
22545 transport_filter = /some/directory/transport-filter.pl \
22546   $host $host_address $sender_address $pipe_addresses
22547 .endd
22548
22549 Two problems arise if you want to use more complicated expansion items to
22550 generate transport filter commands, both of which due to the fact that the
22551 command is split up &'before'& expansion.
22552 .ilist
22553 If an expansion item contains white space, you must quote it, so that it is all
22554 part of the same command item. If the entire option setting is one such
22555 expansion item, you have to take care what kind of quoting you use. For
22556 example:
22557 .code
22558 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22559 .endd
22560 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22561 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22562 stripped by Exim when it read the option's value. When the value is used, if
22563 the single quotes were missing, the line would be split into two items,
22564 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22565 Exim tried to expand the first one.
22566 .next
22567 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22568 expansion cannot generate multiple arguments, or a command name followed by
22569 arguments. Consider this example:
22570 .code
22571 transport_filter = ${lookup{$host}lsearch{/a/file}\
22572                     {$value}{/bin/cat}}
22573 .endd
22574 The result of the lookup is interpreted as the name of the command, even
22575 if it contains white space. The simplest way round this is to use a shell:
22576 .code
22577 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22578                                {$value}{/bin/cat}}
22579 .endd
22580 .endlist
22581
22582 The filter process is run under the same uid and gid as the normal delivery.
22583 For remote deliveries this is the Exim uid/gid by default. The command should
22584 normally yield a zero return code. Transport filters are not supposed to fail.
22585 A non-zero code is taken to mean that the transport filter encountered some
22586 serious problem. Delivery of the message is deferred; the message remains on
22587 the queue and is tried again later. It is not possible to cause a message to be
22588 bounced from a transport filter.
22589
22590 If a transport filter is set on an autoreply transport, the original message is
22591 passed through the filter as it is being copied into the newly generated
22592 message, which happens if the &%return_message%& option is set.
22593
22594
22595 .option transport_filter_timeout transports time 5m
22596 .cindex "transport" "filter, timeout"
22597 When Exim is reading the output of a transport filter, it applies a timeout
22598 that can be set by this option. Exceeding the timeout is normally treated as a
22599 temporary delivery failure. However, if a transport filter is used with a
22600 &(pipe)& transport, a timeout in the transport filter is treated in the same
22601 way as a timeout in the pipe command itself. By default, a timeout is a hard
22602 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22603 becomes a temporary error.
22604
22605
22606 .option user transports string&!! "Exim user"
22607 .cindex "uid (user id)" "local delivery"
22608 .cindex "transport" "user, specifying"
22609 This option specifies the user under whose uid the delivery process is to be
22610 run, overriding any uid that may have been set by the router. If the user is
22611 given as a name, the uid is looked up from the password data, and the
22612 associated group is taken as the value of the gid to be used if the &%group%&
22613 option is not set.
22614
22615 For deliveries that use local transports, a user and group are normally
22616 specified explicitly or implicitly (for example, as a result of
22617 &%check_local_user%&) by the router or transport.
22618
22619 .cindex "hints database" "access by remote transport"
22620 For remote transports, you should leave this option unset unless you really are
22621 sure you know what you are doing. When a remote transport is running, it needs
22622 to be able to access Exim's hints databases, because each host may have its own
22623 retry data.
22624 .ecindex IIDgenoptra1
22625 .ecindex IIDgenoptra2
22626 .ecindex IIDgenoptra3
22627
22628
22629
22630
22631
22632
22633 . ////////////////////////////////////////////////////////////////////////////
22634 . ////////////////////////////////////////////////////////////////////////////
22635
22636 .chapter "Address batching in local transports" "CHAPbatching" &&&
22637          "Address batching"
22638 .cindex "transport" "local; address batching in"
22639 The only remote transport (&(smtp)&) is normally configured to handle more than
22640 one address at a time, so that when several addresses are routed to the same
22641 remote host, just one copy of the message is sent. Local transports, however,
22642 normally handle one address at a time. That is, a separate instance of the
22643 transport is run for each address that is routed to the transport. A separate
22644 copy of the message is delivered each time.
22645
22646 .cindex "batched local delivery"
22647 .oindex "&%batch_max%&"
22648 .oindex "&%batch_id%&"
22649 In special cases, it may be desirable to handle several addresses at once in a
22650 local transport, for example:
22651
22652 .ilist
22653 In an &(appendfile)& transport, when storing messages in files for later
22654 delivery by some other means, a single copy of the message with multiple
22655 recipients saves space.
22656 .next
22657 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22658 a single copy saves time, and is the normal way LMTP is expected to work.
22659 .next
22660 In a &(pipe)& transport, when passing the message
22661 to a scanner program or
22662 to some other delivery mechanism such as UUCP, multiple recipients may be
22663 acceptable.
22664 .endlist
22665
22666 These three local transports all have the same options for controlling multiple
22667 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22668 repeating the information for each transport, these options are described here.
22669
22670 The &%batch_max%& option specifies the maximum number of addresses that can be
22671 delivered together in a single run of the transport. Its default value is one
22672 (no batching). When more than one address is routed to a transport that has a
22673 &%batch_max%& value greater than one, the addresses are delivered in a batch
22674 (that is, in a single run of the transport with multiple recipients), subject
22675 to certain conditions:
22676
22677 .ilist
22678 .vindex "&$local_part$&"
22679 If any of the transport's options contain a reference to &$local_part$&, no
22680 batching is possible.
22681 .next
22682 .vindex "&$domain$&"
22683 If any of the transport's options contain a reference to &$domain$&, only
22684 addresses with the same domain are batched.
22685 .next
22686 .cindex "customizing" "batching condition"
22687 If &%batch_id%& is set, it is expanded for each address, and only those
22688 addresses with the same expanded value are batched. This allows you to specify
22689 customized batching conditions. Failure of the expansion for any reason,
22690 including forced failure, disables batching, but it does not stop the delivery
22691 from taking place.
22692 .next
22693 Batched addresses must also have the same errors address (where to send
22694 delivery errors), the same header additions and removals, the same user and
22695 group for the transport, and if a host list is present, the first host must
22696 be the same.
22697 .endlist
22698
22699 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22700 both when the file or pipe command is specified in the transport, and when it
22701 is specified by a &(redirect)& router, but all the batched addresses must of
22702 course be routed to the same file or pipe command. These two transports have an
22703 option called &%use_bsmtp%&, which causes them to deliver the message in
22704 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22705 &%check_string%& and &%escape_string%& options are forced to the values
22706 .code
22707 check_string = "."
22708 escape_string = ".."
22709 .endd
22710 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22711 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22712 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22713
22714 .cindex "&'Envelope-to:'& header line"
22715 If the generic &%envelope_to_add%& option is set for a batching transport, the
22716 &'Envelope-to:'& header that is added to the message contains all the addresses
22717 that are being processed together. If you are using a batching &(appendfile)&
22718 transport without &%use_bsmtp%&, the only way to preserve the recipient
22719 addresses is to set the &%envelope_to_add%& option.
22720
22721 .cindex "&(pipe)& transport" "with multiple addresses"
22722 .vindex "&$pipe_addresses$&"
22723 If you are using a &(pipe)& transport without BSMTP, and setting the
22724 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22725 the command. This is not a true variable; it is a bit of magic that causes each
22726 of the recipient addresses to be inserted into the command as a separate
22727 argument. This provides a way of accessing all the addresses that are being
22728 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22729 are specified by a &(redirect)& router.
22730
22731
22732
22733
22734 . ////////////////////////////////////////////////////////////////////////////
22735 . ////////////////////////////////////////////////////////////////////////////
22736
22737 .chapter "The appendfile transport" "CHAPappendfile"
22738 .scindex IIDapptra1 "&(appendfile)& transport"
22739 .scindex IIDapptra2 "transports" "&(appendfile)&"
22740 .cindex "directory creation"
22741 .cindex "creating directories"
22742 The &(appendfile)& transport delivers a message by appending it to an existing
22743 file, or by creating an entirely new file in a specified directory. Single
22744 files to which messages are appended can be in the traditional Unix mailbox
22745 format, or optionally in the MBX format supported by the Pine MUA and
22746 University of Washington IMAP daemon, &'inter alia'&. When each message is
22747 being delivered as a separate file, &"maildir"& format can optionally be used
22748 to give added protection against failures that happen part-way through the
22749 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22750 supported. For all file formats, Exim attempts to create as many levels of
22751 directory as necessary, provided that &%create_directory%& is set.
22752
22753 The code for the optional formats is not included in the Exim binary by
22754 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22755 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22756 included.
22757
22758 .cindex "quota" "system"
22759 Exim recognizes system quota errors, and generates an appropriate message. Exim
22760 also supports its own quota control within the transport, for use when the
22761 system facility is unavailable or cannot be used for some reason.
22762
22763 If there is an error while appending to a file (for example, quota exceeded or
22764 partition filled), Exim attempts to reset the file's length and last
22765 modification time back to what they were before. If there is an error while
22766 creating an entirely new file, the new file is removed.
22767
22768 Before appending to a file, a number of security checks are made, and the
22769 file is locked. A detailed description is given below, after the list of
22770 private options.
22771
22772 The &(appendfile)& transport is most commonly used for local deliveries to
22773 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22774 putting messages into files for remote delivery by some means other than Exim.
22775 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22776 option).
22777
22778
22779
22780 .section "The file and directory options" "SECTfildiropt"
22781 The &%file%& option specifies a single file, to which the message is appended;
22782 the &%directory%& option specifies a directory, in which a new file containing
22783 the message is created. Only one of these two options can be set, and for
22784 normal deliveries to mailboxes, one of them &'must'& be set.
22785
22786 .vindex "&$address_file$&"
22787 .vindex "&$local_part$&"
22788 However, &(appendfile)& is also used for delivering messages to files or
22789 directories whose names (or parts of names) are obtained from alias,
22790 forwarding, or filtering operations (for example, a &%save%& command in a
22791 user's Exim filter). When such a transport is running, &$local_part$& contains
22792 the local part that was aliased or forwarded, and &$address_file$& contains the
22793 name (or partial name) of the file or directory generated by the redirection
22794 operation. There are two cases:
22795
22796 .ilist
22797 If neither &%file%& nor &%directory%& is set, the redirection operation
22798 must specify an absolute path (one that begins with &`/`&). This is the most
22799 common case when users with local accounts use filtering to sort mail into
22800 different folders. See for example, the &(address_file)& transport in the
22801 default configuration. If the path ends with a slash, it is assumed to be the
22802 name of a directory. A delivery to a directory can also be forced by setting
22803 &%maildir_format%& or &%mailstore_format%&.
22804 .next
22805 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22806 used to determine the file or directory name for the delivery. Normally, the
22807 contents of &$address_file$& are used in some way in the string expansion.
22808 .endlist
22809 .cindex "tainted data" "in filenames"
22810 .cindex appendfile "tainted data"
22811 Tainted data may not be used for a file or directory name.
22812 This means that, for instance, &$local_part$& cannot be used directly
22813 as a component of a path.  It can however be used as the key for a lookup
22814 which returns a path (or component).
22815
22816
22817 .cindex "Sieve filter" "configuring &(appendfile)&"
22818 .cindex "Sieve filter" "relative mailbox path handling"
22819 As an example of the second case, consider an environment where users do not
22820 have home directories. They may be permitted to use Exim filter commands of the
22821 form:
22822 .code
22823 save folder23
22824 .endd
22825 or Sieve filter commands of the form:
22826 .code
22827 require "fileinto";
22828 fileinto "folder23";
22829 .endd
22830 In this situation, the expansion of &%file%& or &%directory%& in the transport
22831 must transform the relative path into an appropriate absolute filename. In the
22832 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22833 is used as a result of a &"keep"& action in the filter. This example shows one
22834 way of handling this requirement:
22835 .code
22836 file = ${if eq{$address_file}{inbox} \
22837             {/var/mail/$local_part_data} \
22838             {${if eq{${substr_0_1:$address_file}}{/} \
22839                   {$address_file} \
22840                   {$home/mail/$address_file} \
22841             }} \
22842        }
22843 .endd
22844 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22845 location, absolute paths are used without change, and other folders are in the
22846 &_mail_& directory within the home directory.
22847
22848 &*Note 1*&: While processing an Exim filter, a relative path such as
22849 &_folder23_& is turned into an absolute path if a home directory is known to
22850 the router. In particular, this is the case if &%check_local_user%& is set. If
22851 you want to prevent this happening at routing time, you can set
22852 &%router_home_directory%& empty. This forces the router to pass the relative
22853 path to the transport.
22854
22855 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22856 the &%file%& or &%directory%& option is still used if it is set.
22857
22858
22859
22860
22861 .section "Private options for appendfile" "SECID134"
22862 .cindex "options" "&(appendfile)& transport"
22863
22864
22865
22866 .option allow_fifo appendfile boolean false
22867 .cindex "fifo (named pipe)"
22868 .cindex "named pipe (fifo)"
22869 .cindex "pipe" "named (fifo)"
22870 Setting this option permits delivery to named pipes (FIFOs) as well as to
22871 regular files. If no process is reading the named pipe at delivery time, the
22872 delivery is deferred.
22873
22874
22875 .option allow_symlink appendfile boolean false
22876 .cindex "symbolic link" "to mailbox"
22877 .cindex "mailbox" "symbolic link"
22878 By default, &(appendfile)& will not deliver if the path name for the file is
22879 that of a symbolic link. Setting this option relaxes that constraint, but there
22880 are security issues involved in the use of symbolic links. Be sure you know
22881 what you are doing if you set this. Details of exactly what this option affects
22882 are included in the discussion which follows this list of options.
22883
22884
22885 .option batch_id appendfile string&!! unset
22886 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22887 However, batching is automatically disabled for &(appendfile)& deliveries that
22888 happen as a result of forwarding or aliasing or other redirection directly to a
22889 file.
22890
22891
22892 .option batch_max appendfile integer 1
22893 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22894
22895
22896 .option check_group appendfile boolean false
22897 When this option is set, the group owner of the file defined by the &%file%&
22898 option is checked to see that it is the same as the group under which the
22899 delivery process is running. The default setting is false because the default
22900 file mode is 0600, which means that the group is irrelevant.
22901
22902
22903 .option check_owner appendfile boolean true
22904 When this option is set, the owner of the file defined by the &%file%& option
22905 is checked to ensure that it is the same as the user under which the delivery
22906 process is running.
22907
22908
22909 .option check_string appendfile string "see below"
22910 .cindex "&""From""& line"
22911 As &(appendfile)& writes the message, the start of each line is tested for
22912 matching &%check_string%&, and if it does, the initial matching characters are
22913 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22914 a literal string, not a regular expression, and the case of any letters it
22915 contains is significant.
22916
22917 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22918 are forced to &"."& and &".."& respectively, and any settings in the
22919 configuration are ignored. Otherwise, they default to &"From&~"& and
22920 &">From&~"& when the &%file%& option is set, and unset when any of the
22921 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22922
22923 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22924 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22925 &"From&~"& indicates the start of a new message. All four options need changing
22926 if another format is used. For example, to deliver to mailboxes in MMDF format:
22927 .cindex "MMDF format mailbox"
22928 .cindex "mailbox" "MMDF format"
22929 .code
22930 check_string = "\1\1\1\1\n"
22931 escape_string = "\1\1\1\1 \n"
22932 message_prefix = "\1\1\1\1\n"
22933 message_suffix = "\1\1\1\1\n"
22934 .endd
22935 .option create_directory appendfile boolean true
22936 .cindex "directory creation"
22937 When this option is true, Exim attempts to create any missing superior
22938 directories for the file that it is about to write. A created directory's mode
22939 is given by the &%directory_mode%& option.
22940
22941 The group ownership of a newly created directory is highly dependent on the
22942 operating system (and possibly the file system) that is being used. For
22943 example, in Solaris, if the parent directory has the setgid bit set, its group
22944 is propagated to the child; if not, the currently set group is used. However,
22945 in FreeBSD, the parent's group is always used.
22946
22947
22948
22949 .option create_file appendfile string anywhere
22950 This option constrains the location of files and directories that are created
22951 by this transport. It applies to files defined by the &%file%& option and
22952 directories defined by the &%directory%& option. In the case of maildir
22953 delivery, it applies to the top level directory, not the maildir directories
22954 beneath.
22955
22956 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22957 &"belowhome"&. In the second and third cases, a home directory must have been
22958 set for the transport. This option is not useful when an explicit filename is
22959 given for normal mailbox deliveries. It is intended for the case when filenames
22960 are generated from users' &_.forward_& files. These are usually handled
22961 by an &(appendfile)& transport called &%address_file%&. See also
22962 &%file_must_exist%&.
22963
22964
22965 .option directory appendfile string&!! unset
22966 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22967 or &%directory%& must be set, unless the delivery is the direct result of a
22968 redirection (see section &<<SECTfildiropt>>&).
22969
22970 When &%directory%& is set, the string is expanded, and the message is delivered
22971 into a new file or files in or below the given directory, instead of being
22972 appended to a single mailbox file. A number of different formats are provided
22973 (see &%maildir_format%& and &%mailstore_format%&), and see section
22974 &<<SECTopdir>>& for further details of this form of delivery.
22975
22976
22977 .option directory_file appendfile string&!! "see below"
22978 .cindex "base62"
22979 .vindex "&$inode$&"
22980 When &%directory%& is set, but neither &%maildir_format%& nor
22981 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22982 whose name is obtained by expanding this string. The default value is:
22983 .code
22984 q${base62:$tod_epoch}-$inode
22985 .endd
22986 This generates a unique name from the current time, in base 62 form, and the
22987 inode of the file. The variable &$inode$& is available only when expanding this
22988 option.
22989
22990
22991 .option directory_mode appendfile "octal integer" 0700
22992 If &(appendfile)& creates any directories as a result of the
22993 &%create_directory%& option, their mode is specified by this option.
22994
22995
22996 .option escape_string appendfile string "see description"
22997 See &%check_string%& above.
22998
22999
23000 .option file appendfile string&!! unset
23001 This option is mutually exclusive with the &%directory%& option, but one of
23002 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23003 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23004 specifies a single file, to which the message is appended. One or more of
23005 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23006 &%file%&.
23007
23008 .cindex "NFS" "lock file"
23009 .cindex "locking files"
23010 .cindex "lock files"
23011 If you are using more than one host to deliver over NFS into the same
23012 mailboxes, you should always use lock files.
23013
23014 The string value is expanded for each delivery, and must yield an absolute
23015 path. The most common settings of this option are variations on one of these
23016 examples:
23017 .code
23018 file = /var/spool/mail/$local_part_data
23019 file = /home/$local_part_data/inbox
23020 file = $home/inbox
23021 .endd
23022 .cindex "&""sticky""& bit"
23023 In the first example, all deliveries are done into the same directory. If Exim
23024 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23025 create a file in the directory, so the &"sticky"& bit must be turned on for
23026 deliveries to be possible, or alternatively the &%group%& option can be used to
23027 run the delivery under a group id which has write access to the directory.
23028
23029
23030
23031 .option file_format appendfile string unset
23032 .cindex "file" "mailbox; checking existing format"
23033 This option requests the transport to check the format of an existing file
23034 before adding to it. The check consists of matching a specific string at the
23035 start of the file. The value of the option consists of an even number of
23036 colon-separated strings. The first of each pair is the test string, and the
23037 second is the name of a transport. If the transport associated with a matched
23038 string is not the current transport, control is passed over to the other
23039 transport. For example, suppose the standard &(local_delivery)& transport has
23040 this added to it:
23041 .code
23042 file_format = "From       : local_delivery :\
23043                \1\1\1\1\n : local_mmdf_delivery"
23044 .endd
23045 Mailboxes that begin with &"From"& are still handled by this transport, but if
23046 a mailbox begins with four binary ones followed by a newline, control is passed
23047 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23048 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23049 is assumed to match the current transport. If the start of a mailbox doesn't
23050 match any string, or if the transport named for a given string is not defined,
23051 delivery is deferred.
23052
23053
23054 .option file_must_exist appendfile boolean false
23055 If this option is true, the file specified by the &%file%& option must exist.
23056 A temporary error occurs if it does not, causing delivery to be deferred.
23057 If this option is false, the file is created if it does not exist.
23058
23059
23060 .option lock_fcntl_timeout appendfile time 0s
23061 .cindex "timeout" "mailbox locking"
23062 .cindex "mailbox" "locking, blocking and non-blocking"
23063 .cindex "locking files"
23064 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23065 when locking an open mailbox file. If the call fails, the delivery process
23066 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23067 Non-blocking calls are used so that the file is not kept open during the wait
23068 for the lock; the reason for this is to make it as safe as possible for
23069 deliveries over NFS in the case when processes might be accessing an NFS
23070 mailbox without using a lock file. This should not be done, but
23071 misunderstandings and hence misconfigurations are not unknown.
23072
23073 On a busy system, however, the performance of a non-blocking lock approach is
23074 not as good as using a blocking lock with a timeout. In this case, the waiting
23075 is done inside the system call, and Exim's delivery process acquires the lock
23076 and can proceed as soon as the previous lock holder releases it.
23077
23078 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23079 timeout, are used. There may still be some retrying: the maximum number of
23080 retries is
23081 .code
23082 (lock_retries * lock_interval) / lock_fcntl_timeout
23083 .endd
23084 rounded up to the next whole number. In other words, the total time during
23085 which &(appendfile)& is trying to get a lock is roughly the same, unless
23086 &%lock_fcntl_timeout%& is set very large.
23087
23088 You should consider setting this option if you are getting a lot of delayed
23089 local deliveries because of errors of the form
23090 .code
23091 failed to lock mailbox /some/file (fcntl)
23092 .endd
23093
23094 .option lock_flock_timeout appendfile time 0s
23095 This timeout applies to file locking when using &[flock()]& (see
23096 &%use_flock%&); the timeout operates in a similar manner to
23097 &%lock_fcntl_timeout%&.
23098
23099
23100 .option lock_interval appendfile time 3s
23101 This specifies the time to wait between attempts to lock the file. See below
23102 for details of locking.
23103
23104
23105 .option lock_retries appendfile integer 10
23106 This specifies the maximum number of attempts to lock the file. A value of zero
23107 is treated as 1. See below for details of locking.
23108
23109
23110 .option lockfile_mode appendfile "octal integer" 0600
23111 This specifies the mode of the created lock file, when a lock file is being
23112 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23113
23114
23115 .option lockfile_timeout appendfile time 30m
23116 .cindex "timeout" "mailbox locking"
23117 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23118 exists and is older than this value, it is assumed to have been left behind by
23119 accident, and Exim attempts to remove it.
23120
23121
23122 .option mailbox_filecount appendfile string&!! unset
23123 .cindex "mailbox" "specifying size of"
23124 .cindex "size" "of mailbox"
23125 If this option is set, it is expanded, and the result is taken as the current
23126 number of files in the mailbox. It must be a decimal number, optionally
23127 followed by K or M. This provides a way of obtaining this information from an
23128 external source that maintains the data.
23129
23130
23131 .option mailbox_size appendfile string&!! unset
23132 .cindex "mailbox" "specifying size of"
23133 .cindex "size" "of mailbox"
23134 If this option is set, it is expanded, and the result is taken as the current
23135 size the mailbox. It must be a decimal number, optionally followed by K or M.
23136 This provides a way of obtaining this information from an external source that
23137 maintains the data. This is likely to be helpful for maildir deliveries where
23138 it is computationally expensive to compute the size of a mailbox.
23139
23140
23141
23142 .option maildir_format appendfile boolean false
23143 .cindex "maildir format" "specifying"
23144 If this option is set with the &%directory%& option, the delivery is into a new
23145 file, in the &"maildir"& format that is used by other mail software. When the
23146 transport is activated directly from a &(redirect)& router (for example, the
23147 &(address_file)& transport in the default configuration), setting
23148 &%maildir_format%& causes the path received from the router to be treated as a
23149 directory, whether or not it ends with &`/`&. This option is available only if
23150 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23151 &<<SECTmaildirdelivery>>& below for further details.
23152
23153
23154 .option maildir_quota_directory_regex appendfile string "See below"
23155 .cindex "maildir format" "quota; directories included in"
23156 .cindex "quota" "maildir; directories included in"
23157 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23158 a regular expression for specifying directories, relative to the quota
23159 directory (see &%quota_directory%&), that should be included in the quota
23160 calculation. The default value is:
23161 .code
23162 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23163 .endd
23164 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23165 (directories whose names begin with a dot). If you want to exclude the
23166 &_Trash_&
23167 folder from the count (as some sites do), you need to change this setting to
23168 .code
23169 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23170 .endd
23171 This uses a negative lookahead in the regular expression to exclude the
23172 directory whose name is &_.Trash_&. When a directory is excluded from quota
23173 calculations, quota processing is bypassed for any messages that are delivered
23174 directly into that directory.
23175
23176
23177 .option maildir_retries appendfile integer 10
23178 This option specifies the number of times to retry when writing a file in
23179 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23180
23181
23182 .option maildir_tag appendfile string&!! unset
23183 This option applies only to deliveries in maildir format, and is described in
23184 section &<<SECTmaildirdelivery>>& below.
23185
23186
23187 .option maildir_use_size_file appendfile&!! boolean false
23188 .cindex "maildir format" "&_maildirsize_& file"
23189 The result of string expansion for this option must be a valid boolean value.
23190 If it is true, it enables support for &_maildirsize_& files. Exim
23191 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23192 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23193 value is zero. See &%maildir_quota_directory_regex%& above and section
23194 &<<SECTmaildirdelivery>>& below for further details.
23195
23196 .option maildirfolder_create_regex appendfile string unset
23197 .cindex "maildir format" "&_maildirfolder_& file"
23198 .cindex "&_maildirfolder_&, creating"
23199 The value of this option is a regular expression. If it is unset, it has no
23200 effect. Otherwise, before a maildir delivery takes place, the pattern is
23201 matched against the name of the maildir directory, that is, the directory
23202 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23203 delivery. If there is a match, Exim checks for the existence of a file called
23204 &_maildirfolder_& in the directory, and creates it if it does not exist.
23205 See section &<<SECTmaildirdelivery>>& for more details.
23206
23207
23208 .option mailstore_format appendfile boolean false
23209 .cindex "mailstore format" "specifying"
23210 If this option is set with the &%directory%& option, the delivery is into two
23211 new files in  &"mailstore"& format. The option is available only if
23212 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23213 below for further details.
23214
23215
23216 .option mailstore_prefix appendfile string&!! unset
23217 This option applies only to deliveries in mailstore format, and is described in
23218 section &<<SECTopdir>>& below.
23219
23220
23221 .option mailstore_suffix appendfile string&!! unset
23222 This option applies only to deliveries in mailstore format, and is described in
23223 section &<<SECTopdir>>& below.
23224
23225
23226 .option mbx_format appendfile boolean false
23227 .cindex "locking files"
23228 .cindex "file" "locking"
23229 .cindex "file" "MBX format"
23230 .cindex "MBX format, specifying"
23231 This option is available only if Exim has been compiled with SUPPORT_MBX
23232 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23233 the message is appended to the mailbox file in MBX format instead of
23234 traditional Unix format. This format is supported by Pine4 and its associated
23235 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23236
23237 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23238 automatically changed by the use of &%mbx_format%&. They should normally be set
23239 empty when using MBX format, so this option almost always appears in this
23240 combination:
23241 .code
23242 mbx_format = true
23243 message_prefix =
23244 message_suffix =
23245 .endd
23246 If none of the locking options are mentioned in the configuration,
23247 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23248 is possible to specify the other kinds of locking with &%mbx_format%&, but
23249 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23250 interworks with &'c-client'&, providing for shared access to the mailbox. It
23251 should not be used if any program that does not use this form of locking is
23252 going to access the mailbox, nor should it be used if the mailbox file is NFS
23253 mounted, because it works only when the mailbox is accessed from a single host.
23254
23255 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23256 the standard version of &'c-client'&, because as long as it has a mailbox open
23257 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23258 append messages to it.
23259
23260
23261 .option message_prefix appendfile string&!! "see below"
23262 .cindex "&""From""& line"
23263 The string specified here is expanded and output at the start of every message.
23264 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23265 in which case it is:
23266 .code
23267 message_prefix = "From ${if def:return_path{$return_path}\
23268   {MAILER-DAEMON}} $tod_bsdinbox\n"
23269 .endd
23270 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23271 &`\n`& to &`\r\n`& in &%message_prefix%&.
23272
23273 .option message_suffix appendfile string&!! "see below"
23274 The string specified here is expanded and output at the end of every message.
23275 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23276 in which case it is a single newline character. The suffix can be suppressed by
23277 setting
23278 .code
23279 message_suffix =
23280 .endd
23281 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23282 &`\n`& to &`\r\n`& in &%message_suffix%&.
23283
23284 .option mode appendfile "octal integer" 0600
23285 If the output file is created, it is given this mode. If it already exists and
23286 has wider permissions, they are reduced to this mode. If it has narrower
23287 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23288 if the delivery is the result of a &%save%& command in a filter file specifying
23289 a particular mode, the mode of the output file is always forced to take that
23290 value, and this option is ignored.
23291
23292
23293 .option mode_fail_narrower appendfile boolean true
23294 This option applies in the case when an existing mailbox file has a narrower
23295 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23296 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23297 continues with the delivery attempt, using the existing mode of the file.
23298
23299
23300 .option notify_comsat appendfile boolean false
23301 If this option is true, the &'comsat'& daemon is notified after every
23302 successful delivery to a user mailbox. This is the daemon that notifies logged
23303 on users about incoming mail.
23304
23305
23306 .option quota appendfile string&!! unset
23307 .cindex "quota" "imposed by Exim"
23308 This option imposes a limit on the size of the file to which Exim is appending,
23309 or to the total space used in the directory tree when the &%directory%& option
23310 is set. In the latter case, computation of the space used is expensive, because
23311 all the files in the directory (and any sub-directories) have to be
23312 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23313 &%maildir_use_size_file%& for ways to avoid this in environments where users
23314 have no shell access to their mailboxes).
23315
23316 As there is no interlock against two simultaneous deliveries into a
23317 multi-file mailbox, it is possible for the quota to be overrun in this case.
23318 For single-file mailboxes, of course, an interlock is a necessity.
23319
23320 A file's size is taken as its &'used'& value. Because of blocking effects, this
23321 may be a lot less than the actual amount of disk space allocated to the file.
23322 If the sizes of a number of files are being added up, the rounding effect can
23323 become quite noticeable, especially on systems that have large block sizes.
23324 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23325 the obvious value which users understand most easily.
23326
23327 The value of the option is expanded, and must then be a numerical value
23328 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23329 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23330 and further option modifiers. If Exim is running on a system with
23331 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23332 be handled.
23333
23334 The option modifier &%no_check%& can be used to force delivery even if the over
23335 quota condition is met. The quota gets updated as usual.
23336
23337 &*Note*&: A value of zero is interpreted as &"no quota"&.
23338
23339 The expansion happens while Exim is running as root, before it changes uid for
23340 the delivery. This means that files that are inaccessible to the end user can
23341 be used to hold quota values that are looked up in the expansion. When delivery
23342 fails because this quota is exceeded, the handling of the error is as for
23343 system quota failures.
23344
23345 By default, Exim's quota checking mimics system quotas, and restricts the
23346 mailbox to the specified maximum size, though the value is not accurate to the
23347 last byte, owing to separator lines and additional headers that may get added
23348 during message delivery. When a mailbox is nearly full, large messages may get
23349 refused even though small ones are accepted, because the size of the current
23350 message is added to the quota when the check is made. This behaviour can be
23351 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23352 for exceeding the quota does not include the current message. Thus, deliveries
23353 continue until the quota has been exceeded; thereafter, no further messages are
23354 delivered. See also &%quota_warn_threshold%&.
23355
23356
23357 .option quota_directory appendfile string&!! unset
23358 This option defines the directory to check for quota purposes when delivering
23359 into individual files. The default is the delivery directory, or, if a file
23360 called &_maildirfolder_& exists in a maildir directory, the parent of the
23361 delivery directory.
23362
23363
23364 .option quota_filecount appendfile string&!! 0
23365 This option applies when the &%directory%& option is set. It limits the total
23366 number of files in the directory (compare the inode limit in system quotas). It
23367 can only be used if &%quota%& is also set. The value is expanded; an expansion
23368 failure causes delivery to be deferred. A value of zero is interpreted as
23369 &"no quota"&.
23370
23371 The option modifier &%no_check%& can be used to force delivery even if the over
23372 quota condition is met. The quota gets updated as usual.
23373
23374 .option quota_is_inclusive appendfile boolean true
23375 See &%quota%& above.
23376
23377
23378 .option quota_size_regex appendfile string unset
23379 This option applies when one of the delivery modes that writes a separate file
23380 for each message is being used. When Exim wants to find the size of one of
23381 these files in order to test the quota, it first checks &%quota_size_regex%&.
23382 If this is set to a regular expression that matches the filename, and it
23383 captures one string, that string is interpreted as a representation of the
23384 file's size. The value of &%quota_size_regex%& is not expanded.
23385
23386 This feature is useful only when users have no shell access to their mailboxes
23387 &-- otherwise they could defeat the quota simply by renaming the files. This
23388 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23389 the file length to the filename. For example:
23390 .code
23391 maildir_tag = ,S=$message_size
23392 quota_size_regex = ,S=(\d+)
23393 .endd
23394 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23395 number of lines in the message.
23396
23397 The regular expression should not assume that the length is at the end of the
23398 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23399 sometimes add other information onto the ends of message filenames.
23400
23401 Section &<<SECID136>>& contains further information.
23402
23403 This option should not be used when other message-handling software
23404 may duplicate messages by making hardlinks to the files.  When that is done Exim
23405 will count the message size once for each filename, in contrast with the actual
23406 disk usage.  When the option is not set, calculating total usage requires
23407 a system-call per file to get the size; the number of links is then available also
23408 as is used to adjust the effective size.
23409
23410
23411 .option quota_warn_message appendfile string&!! "see below"
23412 See below for the use of this option. If it is not set when
23413 &%quota_warn_threshold%& is set, it defaults to
23414 .code
23415 quota_warn_message = "\
23416   To: $local_part@$domain\n\
23417   Subject: Your mailbox\n\n\
23418   This message is automatically created \
23419   by mail delivery software.\n\n\
23420   The size of your mailbox has exceeded \
23421   a warning threshold that is\n\
23422   set by the system administrator.\n"
23423 .endd
23424
23425
23426 .option quota_warn_threshold appendfile string&!! 0
23427 .cindex "quota" "warning threshold"
23428 .cindex "mailbox" "size warning"
23429 .cindex "size" "of mailbox"
23430 This option is expanded in the same way as &%quota%& (see above). If the
23431 resulting value is greater than zero, and delivery of the message causes the
23432 size of the file or total space in the directory tree to cross the given
23433 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23434 may be specified as a percentage of it by following the value with a percent
23435 sign. For example:
23436 .code
23437 quota = 10M
23438 quota_warn_threshold = 75%
23439 .endd
23440 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23441 percent sign is ignored.
23442
23443 The warning message itself is specified by the &%quota_warn_message%& option,
23444 and it must start with a &'To:'& header line containing the recipient(s) of the
23445 warning message. These do not necessarily have to include the recipient(s) of
23446 the original message. A &'Subject:'& line should also normally be supplied. You
23447 can include any other header lines that you want. If you do not include a
23448 &'From:'& line, the default is:
23449 .code
23450 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23451 .endd
23452 .oindex &%errors_reply_to%&
23453 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23454 option.
23455
23456 The &%quota%& option does not have to be set in order to use this option; they
23457 are independent of one another except when the threshold is specified as a
23458 percentage.
23459
23460
23461 .option use_bsmtp appendfile boolean false
23462 .cindex "envelope from"
23463 .cindex "envelope sender"
23464 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23465 format, with the envelope sender and recipient(s) included as SMTP commands. If
23466 you want to include a leading HELO command with such messages, you can do
23467 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23468 for details of batch SMTP.
23469
23470
23471 .option use_crlf appendfile boolean false
23472 .cindex "carriage return"
23473 .cindex "linefeed"
23474 This option causes lines to be terminated with the two-character CRLF sequence
23475 (carriage return, linefeed) instead of just a linefeed character. In the case
23476 of batched SMTP, the byte sequence written to the file is then an exact image
23477 of what would be sent down a real SMTP connection.
23478
23479 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23480 (which are used to supply the traditional &"From&~"& and blank line separators
23481 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23482 carriage return characters if these are needed. In cases where these options
23483 have non-empty defaults, the values end with a single linefeed, so they must be
23484 changed to end with &`\r\n`& if &%use_crlf%& is set.
23485
23486
23487 .option use_fcntl_lock appendfile boolean "see below"
23488 This option controls the use of the &[fcntl()]& function to lock a file for
23489 exclusive use when a message is being appended. It is set by default unless
23490 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23491 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23492 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23493
23494
23495 .option use_flock_lock appendfile boolean false
23496 This option is provided to support the use of &[flock()]& for file locking, for
23497 the few situations where it is needed. Most modern operating systems support
23498 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23499 each other. Exim uses &[fcntl()]& locking by default.
23500
23501 This option is required only if you are using an operating system where
23502 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23503 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23504 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23505
23506 .cindex "Solaris" "&[flock()]& support"
23507 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23508 have it (and some, I think, provide a not quite right version built on top of
23509 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23510 the ability to use it, and any attempt to do so will cause a configuration
23511 error.
23512
23513 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23514 is just being mapped onto &[fcntl()]& by the OS).
23515
23516
23517 .option use_lockfile appendfile boolean "see below"
23518 If this option is turned off, Exim does not attempt to create a lock file when
23519 appending to a mailbox file. In this situation, the only locking is by
23520 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23521 sure that every MUA that is ever going to look at your users' mailboxes uses
23522 &[fcntl()]& rather than a lock file, and even then only when you are not
23523 delivering over NFS from more than one host.
23524
23525 .cindex "NFS" "lock file"
23526 In order to append to an NFS file safely from more than one host, it is
23527 necessary to take out a lock &'before'& opening the file, and the lock file
23528 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23529 file corruption.
23530
23531 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23532 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23533 except when &%mbx_format%& is set.
23534
23535
23536 .option use_mbx_lock appendfile boolean "see below"
23537 This option is available only if Exim has been compiled with SUPPORT_MBX
23538 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23539 locking rules be used. It is set by default if &%mbx_format%& is set and none
23540 of the locking options are mentioned in the configuration. The locking rules
23541 are the same as are used by the &'c-client'& library that underlies Pine and
23542 the IMAP4 and POP daemons that come with it (see the discussion below). The
23543 rules allow for shared access to the mailbox. However, this kind of locking
23544 does not work when the mailbox is NFS mounted.
23545
23546 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23547 &%use_flock_lock%& to control what kind of locking is used in implementing the
23548 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23549 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23550
23551
23552
23553
23554 .section "Operational details for appending" "SECTopappend"
23555 .cindex "appending to a file"
23556 .cindex "file" "appending"
23557 Before appending to a file, the following preparations are made:
23558
23559 .ilist
23560 If the name of the file is &_/dev/null_&, no action is taken, and a success
23561 return is given.
23562
23563 .next
23564 .cindex "directory creation"
23565 If any directories on the file's path are missing, Exim creates them if the
23566 &%create_directory%& option is set. A created directory's mode is given by the
23567 &%directory_mode%& option.
23568
23569 .next
23570 If &%file_format%& is set, the format of an existing file is checked. If this
23571 indicates that a different transport should be used, control is passed to that
23572 transport.
23573
23574 .next
23575 .cindex "file" "locking"
23576 .cindex "locking files"
23577 .cindex "NFS" "lock file"
23578 If &%use_lockfile%& is set, a lock file is built in a way that will work
23579 reliably over NFS, as follows:
23580
23581 .olist
23582 Create a &"hitching post"& file whose name is that of the lock file with the
23583 current time, primary host name, and process id added, by opening for writing
23584 as a new file. If this fails with an access error, delivery is deferred.
23585 .next
23586 Close the hitching post file, and hard link it to the lock filename.
23587 .next
23588 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23589 Unlink the hitching post name.
23590 .next
23591 Otherwise, use &[stat()]& to get information about the hitching post file, and
23592 then unlink hitching post name. If the number of links is exactly two, creation
23593 of the lock file succeeded but something (for example, an NFS server crash and
23594 restart) caused this fact not to be communicated to the &[link()]& call.
23595 .next
23596 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23597 up to &%lock_retries%& times. However, since any program that writes to a
23598 mailbox should complete its task very quickly, it is reasonable to time out old
23599 lock files that are normally the result of user agent and system crashes. If an
23600 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23601 it before trying again.
23602 .endlist olist
23603
23604 .next
23605 A call is made to &[lstat()]& to discover whether the main file exists, and if
23606 so, what its characteristics are. If &[lstat()]& fails for any reason other
23607 than non-existence, delivery is deferred.
23608
23609 .next
23610 .cindex "symbolic link" "to mailbox"
23611 .cindex "mailbox" "symbolic link"
23612 If the file does exist and is a symbolic link, delivery is deferred, unless the
23613 &%allow_symlink%& option is set, in which case the ownership of the link is
23614 checked, and then &[stat()]& is called to find out about the real file, which
23615 is then subjected to the checks below. The check on the top-level link
23616 ownership prevents one user creating a link for another's mailbox in a sticky
23617 directory, though allowing symbolic links in this case is definitely not a good
23618 idea. If there is a chain of symbolic links, the intermediate ones are not
23619 checked.
23620
23621 .next
23622 If the file already exists but is not a regular file, or if the file's owner
23623 and group (if the group is being checked &-- see &%check_group%& above) are
23624 different from the user and group under which the delivery is running,
23625 delivery is deferred.
23626
23627 .next
23628 If the file's permissions are more generous than specified, they are reduced.
23629 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23630 is set false, in which case the delivery is tried using the existing
23631 permissions.
23632
23633 .next
23634 The file's inode number is saved, and the file is then opened for appending.
23635 If this fails because the file has vanished, &(appendfile)& behaves as if it
23636 hadn't existed (see below). For any other failures, delivery is deferred.
23637
23638 .next
23639 If the file is opened successfully, check that the inode number hasn't
23640 changed, that it is still a regular file, and that the owner and permissions
23641 have not changed. If anything is wrong, defer delivery and freeze the message.
23642
23643 .next
23644 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23645 option is set. Otherwise, check that the file is being created in a permitted
23646 directory if the &%create_file%& option is set (deferring on failure), and then
23647 open for writing as a new file, with the O_EXCL and O_CREAT options,
23648 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23649 set). In this case, which can happen if the link points to a non-existent file,
23650 the file is opened for writing using O_CREAT but not O_EXCL, because
23651 that prevents link following.
23652
23653 .next
23654 .cindex "loop" "while file testing"
23655 If opening fails because the file exists, obey the tests given above for
23656 existing files. However, to avoid looping in a situation where the file is
23657 being continuously created and destroyed, the exists/not-exists loop is broken
23658 after 10 repetitions, and the message is then frozen.
23659
23660 .next
23661 If opening fails with any other error, defer delivery.
23662
23663 .next
23664 .cindex "file" "locking"
23665 .cindex "locking files"
23666 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23667 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23668 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23669 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23670 file, and an exclusive lock on the file whose name is
23671 .code
23672 /tmp/.<device-number>.<inode-number>
23673 .endd
23674 using the device and inode numbers of the open mailbox file, in accordance with
23675 the MBX locking rules. This file is created with a mode that is specified by
23676 the &%lockfile_mode%& option.
23677
23678 If Exim fails to lock the file, there are two possible courses of action,
23679 depending on the value of the locking timeout. This is obtained from
23680 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23681
23682 If the timeout value is zero, the file is closed, Exim waits for
23683 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23684 to lock it again. This happens up to &%lock_retries%& times, after which the
23685 delivery is deferred.
23686
23687 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23688 &[flock()]& are used (with the given timeout), so there has already been some
23689 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23690 immediately. It retries up to
23691 .code
23692 (lock_retries * lock_interval) / <timeout>
23693 .endd
23694 times (rounded up).
23695 .endlist
23696
23697 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23698 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23699
23700
23701 .section "Operational details for delivery to a new file" "SECTopdir"
23702 .cindex "delivery" "to single file"
23703 .cindex "&""From""& line"
23704 When the &%directory%& option is set instead of &%file%&, each message is
23705 delivered into a newly-created file or set of files. When &(appendfile)& is
23706 activated directly from a &(redirect)& router, neither &%file%& nor
23707 &%directory%& is normally set, because the path for delivery is supplied by the
23708 router. (See for example, the &(address_file)& transport in the default
23709 configuration.) In this case, delivery is to a new file if either the path name
23710 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23711
23712 No locking is required while writing the message to a new file, so the various
23713 locking options of the transport are ignored. The &"From"& line that by default
23714 separates messages in a single file is not normally needed, nor is the escaping
23715 of message lines that start with &"From"&, and there is no need to ensure a
23716 newline at the end of each message. Consequently, the default values for
23717 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23718 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23719
23720 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23721 the files in the delivery directory by default. However, you can specify a
23722 different directory by setting &%quota_directory%&. Also, for maildir
23723 deliveries (see below) the &_maildirfolder_& convention is honoured.
23724
23725
23726 .cindex "maildir format"
23727 .cindex "mailstore format"
23728 There are three different ways in which delivery to individual files can be
23729 done, controlled by the settings of the &%maildir_format%& and
23730 &%mailstore_format%& options. Note that code to support maildir or mailstore
23731 formats is not included in the binary unless SUPPORT_MAILDIR or
23732 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23733
23734 .cindex "directory creation"
23735 In all three cases an attempt is made to create the directory and any necessary
23736 sub-directories if they do not exist, provided that the &%create_directory%&
23737 option is set (the default). The location of a created directory can be
23738 constrained by setting &%create_file%&. A created directory's mode is given by
23739 the &%directory_mode%& option. If creation fails, or if the
23740 &%create_directory%& option is not set when creation is required, delivery is
23741 deferred.
23742
23743
23744
23745 .section "Maildir delivery" "SECTmaildirdelivery"
23746 .cindex "maildir format" "description of"
23747 If the &%maildir_format%& option is true, Exim delivers each message by writing
23748 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23749 directory that is defined by the &%directory%& option (the &"delivery
23750 directory"&). If the delivery is successful, the file is renamed into the
23751 &_new_& subdirectory.
23752
23753 In the filename, <&'stime'&> is the current time of day in seconds, and
23754 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23755 Exim checks that the time-of-day clock has moved on by at least one microsecond
23756 before terminating the delivery process. This guarantees uniqueness for the
23757 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23758 opening it. If any response other than ENOENT (does not exist) is given,
23759 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23760
23761 Before Exim carries out a maildir delivery, it ensures that subdirectories
23762 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23763 do not exist, Exim tries to create them and any superior directories in their
23764 path, subject to the &%create_directory%& and &%create_file%& options. If the
23765 &%maildirfolder_create_regex%& option is set, and the regular expression it
23766 contains matches the delivery directory, Exim also ensures that a file called
23767 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23768 &_maildirfolder_& file cannot be created, delivery is deferred.
23769
23770 These features make it possible to use Exim to create all the necessary files
23771 and directories in a maildir mailbox, including subdirectories for maildir++
23772 folders. Consider this example:
23773 .code
23774 maildir_format = true
23775 directory = /var/mail/$local_part_data\
23776            ${if eq{$local_part_suffix}{}{}\
23777            {/.${substr_1:$local_part_suffix}}}
23778 maildirfolder_create_regex = /\.[^/]+$
23779 .endd
23780 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23781 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23782 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23783 not match this name, so Exim will not look for or create the file
23784 &_/var/mail/pimbo/maildirfolder_&, though it will create
23785 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23786
23787 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23788 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23789 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23790 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23791 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23792
23793 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23794 not inadvertently match the toplevel maildir directory, because a
23795 &_maildirfolder_& file at top level would completely break quota calculations.
23796
23797 .cindex "quota" "in maildir delivery"
23798 .cindex "maildir++"
23799 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23800 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23801 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23802 Exim assumes the directory is a maildir++ folder directory, which is one level
23803 down from the user's top level mailbox directory. This causes it to start at
23804 the parent directory instead of the current directory when calculating the
23805 amount of space used.
23806
23807 One problem with delivering into a multi-file mailbox is that it is
23808 computationally expensive to compute the size of the mailbox for quota
23809 checking. Various approaches have been taken to reduce the amount of work
23810 needed. The next two sections describe two of them. A third alternative is to
23811 use some external process for maintaining the size data, and use the expansion
23812 of the &%mailbox_size%& option as a way of importing it into Exim.
23813
23814
23815
23816
23817 .section "Using tags to record message sizes" "SECID135"
23818 If &%maildir_tag%& is set, the string is expanded for each delivery.
23819 When the maildir file is renamed into the &_new_& sub-directory, the
23820 tag is added to its name. However, if adding the tag takes the length of the
23821 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23822 the tag is dropped and the maildir file is created with no tag.
23823
23824
23825 .vindex "&$message_size$&"
23826 Tags can be used to encode the size of files in their names; see
23827 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23828 happens after the message has been written. The value of the &$message_size$&
23829 variable is set to the number of bytes actually written. If the expansion is
23830 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23831 be deferred. The expanded tag may contain any printing characters except &"/"&.
23832 Non-printing characters in the string are ignored; if the resulting string is
23833 empty, it is ignored. If it starts with an alphanumeric character, a leading
23834 colon is inserted; this default has not proven to be the path that popular
23835 maildir implementations have chosen (but changing it in Exim would break
23836 backwards compatibility).
23837
23838 For one common implementation, you might set:
23839 .code
23840 maildir_tag = ,S=${message_size}
23841 .endd
23842 but you should check the documentation of the other software to be sure.
23843
23844 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23845 as this allows Exim to extract the size from your tag, instead of having to
23846 &[stat()]& each message file.
23847
23848
23849 .section "Using a maildirsize file" "SECID136"
23850 .cindex "quota" "in maildir delivery"
23851 .cindex "maildir format" "&_maildirsize_& file"
23852 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23853 storing quota and message size information in a file called &_maildirsize_&
23854 within the toplevel maildir directory. If this file does not exist, Exim
23855 creates it, setting the quota from the &%quota%& option of the transport. If
23856 the maildir directory itself does not exist, it is created before any attempt
23857 to write a &_maildirsize_& file.
23858
23859 The &_maildirsize_& file is used to hold information about the sizes of
23860 messages in the maildir, thus speeding up quota calculations. The quota value
23861 in the file is just a cache; if the quota is changed in the transport, the new
23862 value overrides the cached value when the next message is delivered. The cache
23863 is maintained for the benefit of other programs that access the maildir and
23864 need to know the quota.
23865
23866 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23867 file is maintained (with a zero quota setting), but no quota is imposed.
23868
23869 A regular expression is available for controlling which directories in the
23870 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23871 See the description of the &%maildir_quota_directory_regex%& option above for
23872 details.
23873
23874
23875 .section "Mailstore delivery" "SECID137"
23876 .cindex "mailstore format" "description of"
23877 If the &%mailstore_format%& option is true, each message is written as two
23878 files in the given directory. A unique base name is constructed from the
23879 message id and the current delivery process, and the files that are written use
23880 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23881 contains the message's envelope, and the &_.msg_& file contains the message
23882 itself. The base name is placed in the variable &$mailstore_basename$&.
23883
23884 During delivery, the envelope is first written to a file with the suffix
23885 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23886 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23887 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23888 file before accessing either of them. An alternative approach is to wait for
23889 the absence of a &_.tmp_& file.
23890
23891 The envelope file starts with any text defined by the &%mailstore_prefix%&
23892 option, expanded and terminated by a newline if there isn't one. Then follows
23893 the sender address on one line, then all the recipient addresses, one per line.
23894 There can be more than one recipient only if the &%batch_max%& option is set
23895 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23896 appended to the file, followed by a newline if it does not end with one.
23897
23898 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23899 failure, it is ignored. Other expansion errors are treated as serious
23900 configuration errors, and delivery is deferred. The variable
23901 &$mailstore_basename$& is available for use during these expansions.
23902
23903
23904 .section "Non-special new file delivery" "SECID138"
23905 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23906 file is created directly in the named directory. For example, when delivering
23907 messages into files in batched SMTP format for later delivery to some host (see
23908 section &<<SECTbatchSMTP>>&), a setting such as
23909 .code
23910 directory = /var/bsmtp/$host
23911 .endd
23912 might be used. A message is written to a file with a temporary name, which is
23913 then renamed when the delivery is complete. The final name is obtained by
23914 expanding the contents of the &%directory_file%& option.
23915 .ecindex IIDapptra1
23916 .ecindex IIDapptra2
23917
23918
23919
23920
23921
23922
23923 . ////////////////////////////////////////////////////////////////////////////
23924 . ////////////////////////////////////////////////////////////////////////////
23925
23926 .chapter "The autoreply transport" "CHID8"
23927 .scindex IIDauttra1 "transports" "&(autoreply)&"
23928 .scindex IIDauttra2 "&(autoreply)& transport"
23929 The &(autoreply)& transport is not a true transport in that it does not cause
23930 the message to be transmitted. Instead, it generates a new mail message as an
23931 automatic reply to the incoming message. &'References:'& and
23932 &'Auto-Submitted:'& header lines are included. These are constructed according
23933 to the rules in RFCs 2822 and 3834, respectively.
23934
23935 If the router that passes the message to this transport does not have the
23936 &%unseen%& option set, the original message (for the current recipient) is not
23937 delivered anywhere. However, when the &%unseen%& option is set on the router
23938 that passes the message to this transport, routing of the address continues, so
23939 another router can set up a normal message delivery.
23940
23941
23942 The &(autoreply)& transport is usually run as the result of mail filtering, a
23943 &"vacation"& message being the standard example. However, it can also be run
23944 directly from a router like any other transport. To reduce the possibility of
23945 message cascades, messages created by the &(autoreply)& transport always have
23946 empty envelope sender addresses, like bounce messages.
23947
23948 The parameters of the message to be sent can be specified in the configuration
23949 by options described below. However, these are used only when the address
23950 passed to the transport does not contain its own reply information. When the
23951 transport is run as a consequence of a
23952 &%mail%&
23953 or &%vacation%& command in a filter file, the parameters of the message are
23954 supplied by the filter, and passed with the address. The transport's options
23955 that define the message are then ignored (so they are not usually set in this
23956 case). The message is specified entirely by the filter or by the transport; it
23957 is never built from a mixture of options. However, the &%file_optional%&,
23958 &%mode%&, and &%return_message%& options apply in all cases.
23959
23960 &(Autoreply)& is implemented as a local transport. When used as a result of a
23961 command in a user's filter file, &(autoreply)& normally runs under the uid and
23962 gid of the user, and with appropriate current and home directories (see chapter
23963 &<<CHAPenvironment>>&).
23964
23965 There is a subtle difference between routing a message to a &(pipe)& transport
23966 that generates some text to be returned to the sender, and routing it to an
23967 &(autoreply)& transport. This difference is noticeable only if more than one
23968 address from the same message is so handled. In the case of a pipe, the
23969 separate outputs from the different addresses are gathered up and returned to
23970 the sender in a single message, whereas if &(autoreply)& is used, a separate
23971 message is generated for each address that is passed to it.
23972
23973 Non-printing characters are not permitted in the header lines generated for the
23974 message that &(autoreply)& creates, with the exception of newlines that are
23975 immediately followed by white space. If any non-printing characters are found,
23976 the transport defers.
23977 Whether characters with the top bit set count as printing characters or not is
23978 controlled by the &%print_topbitchars%& global option.
23979
23980 If any of the generic options for manipulating headers (for example,
23981 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23982 of the original message that is included in the generated message when
23983 &%return_message%& is set. They do not apply to the generated message itself.
23984
23985 .vindex "&$sender_address$&"
23986 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23987 the message, indicating that there were no recipients, it does not treat this
23988 as an error. This means that autoreplies sent to &$sender_address$& when this
23989 is empty (because the incoming message is a bounce message) do not cause
23990 problems. They are just discarded.
23991
23992
23993
23994 .section "Private options for autoreply" "SECID139"
23995 .cindex "options" "&(autoreply)& transport"
23996
23997 .option bcc autoreply string&!! unset
23998 This specifies the addresses that are to receive &"blind carbon copies"& of the
23999 message when the message is specified by the transport.
24000
24001
24002 .option cc autoreply string&!! unset
24003 This specifies recipients of the message and the contents of the &'Cc:'& header
24004 when the message is specified by the transport.
24005
24006
24007 .option file autoreply string&!! unset
24008 The contents of the file are sent as the body of the message when the message
24009 is specified by the transport. If both &%file%& and &%text%& are set, the text
24010 string comes first.
24011
24012
24013 .option file_expand autoreply boolean false
24014 If this is set, the contents of the file named by the &%file%& option are
24015 subjected to string expansion as they are added to the message.
24016
24017
24018 .option file_optional autoreply boolean false
24019 If this option is true, no error is generated if the file named by the &%file%&
24020 option or passed with the address does not exist or cannot be read.
24021
24022
24023 .option from autoreply string&!! unset
24024 This specifies the contents of the &'From:'& header when the message is
24025 specified by the transport.
24026
24027
24028 .option headers autoreply string&!! unset
24029 This specifies additional RFC 2822 headers that are to be added to the message
24030 when the message is specified by the transport. Several can be given by using
24031 &"\n"& to separate them. There is no check on the format.
24032
24033
24034 .option log autoreply string&!! unset
24035 This option names a file in which a record of every message sent is logged when
24036 the message is specified by the transport.
24037
24038
24039 .option mode autoreply "octal integer" 0600
24040 If either the log file or the &"once"& file has to be created, this mode is
24041 used.
24042
24043
24044 .option never_mail autoreply "address list&!!" unset
24045 If any run of the transport creates a message with a recipient that matches any
24046 item in the list, that recipient is quietly discarded. If all recipients are
24047 discarded, no message is created. This applies both when the recipients are
24048 generated by a filter and when they are specified in the transport.
24049
24050
24051
24052 .option once autoreply string&!! unset
24053 This option names a file or DBM database in which a record of each &'To:'&
24054 recipient is kept when the message is specified by the transport. &*Note*&:
24055 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24056
24057 If &%once%& is unset, or is set to an empty string, the message is always sent.
24058 By default, if &%once%& is set to a non-empty filename, the message
24059 is not sent if a potential recipient is already listed in the database.
24060 However, if the &%once_repeat%& option specifies a time greater than zero, the
24061 message is sent if that much time has elapsed since a message was last sent to
24062 this recipient. A setting of zero time for &%once_repeat%& (the default)
24063 prevents a message from being sent a second time &-- in this case, zero means
24064 infinity.
24065
24066 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24067 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24068 greater than zero, it changes the way Exim implements the &%once%& option.
24069 Instead of using a DBM file to record every recipient it sends to, it uses a
24070 regular file, whose size will never get larger than the given value.
24071
24072 In the file, Exim keeps a linear list of recipient addresses and the times at
24073 which they were sent messages. If the file is full when a new address needs to
24074 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24075 means that a given recipient may receive multiple messages, but at
24076 unpredictable intervals that depend on the rate of turnover of addresses in the
24077 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24078
24079
24080 .option once_file_size autoreply integer 0
24081 See &%once%& above.
24082
24083
24084 .option once_repeat autoreply time&!! 0s
24085 See &%once%& above.
24086 After expansion, the value of this option must be a valid time value.
24087
24088
24089 .option reply_to autoreply string&!! unset
24090 This specifies the contents of the &'Reply-To:'& header when the message is
24091 specified by the transport.
24092
24093
24094 .option return_message autoreply boolean false
24095 If this is set, a copy of the original message is returned with the new
24096 message, subject to the maximum size set in the &%return_size_limit%& global
24097 configuration option.
24098
24099
24100 .option subject autoreply string&!! unset
24101 This specifies the contents of the &'Subject:'& header when the message is
24102 specified by the transport. It is tempting to quote the original subject in
24103 automatic responses. For example:
24104 .code
24105 subject = Re: $h_subject:
24106 .endd
24107 There is a danger in doing this, however. It may allow a third party to
24108 subscribe your users to an opt-in mailing list, provided that the list accepts
24109 bounce messages as subscription confirmations. Well-managed lists require a
24110 non-bounce message to confirm a subscription, so the danger is relatively
24111 small.
24112
24113
24114
24115 .option text autoreply string&!! unset
24116 This specifies a single string to be used as the body of the message when the
24117 message is specified by the transport. If both &%text%& and &%file%& are set,
24118 the text comes first.
24119
24120
24121 .option to autoreply string&!! unset
24122 This specifies recipients of the message and the contents of the &'To:'& header
24123 when the message is specified by the transport.
24124 .ecindex IIDauttra1
24125 .ecindex IIDauttra2
24126
24127
24128
24129
24130 . ////////////////////////////////////////////////////////////////////////////
24131 . ////////////////////////////////////////////////////////////////////////////
24132
24133 .chapter "The lmtp transport" "CHAPLMTP"
24134 .cindex "transports" "&(lmtp)&"
24135 .cindex "&(lmtp)& transport"
24136 .cindex "LMTP" "over a pipe"
24137 .cindex "LMTP" "over a socket"
24138 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24139 specified command
24140 or by interacting with a Unix domain socket.
24141 This transport is something of a cross between the &(pipe)& and &(smtp)&
24142 transports. Exim also has support for using LMTP over TCP/IP; this is
24143 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24144 to be of minority interest, the default build-time configure in &_src/EDITME_&
24145 has it commented out. You need to ensure that
24146 .code
24147 TRANSPORT_LMTP=yes
24148 .endd
24149 .cindex "options" "&(lmtp)& transport"
24150 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24151 included in the Exim binary. The private options of the &(lmtp)& transport are
24152 as follows:
24153
24154 .option batch_id lmtp string&!! unset
24155 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24156
24157
24158 .option batch_max lmtp integer 1
24159 This limits the number of addresses that can be handled in a single delivery.
24160 Most LMTP servers can handle several addresses at once, so it is normally a
24161 good idea to increase this value. See the description of local delivery
24162 batching in chapter &<<CHAPbatching>>&.
24163
24164
24165 .option command lmtp string&!! unset
24166 This option must be set if &%socket%& is not set. The string is a command which
24167 is run in a separate process. It is split up into a command name and list of
24168 arguments, each of which is separately expanded (so expansion cannot change the
24169 number of arguments). The command is run directly, not via a shell. The message
24170 is passed to the new process using the standard input and output to operate the
24171 LMTP protocol.
24172
24173 .option ignore_quota lmtp boolean false
24174 .cindex "LMTP" "ignoring quota errors"
24175 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24176 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24177 in its response to the LHLO command.
24178
24179 .option socket lmtp string&!! unset
24180 This option must be set if &%command%& is not set. The result of expansion must
24181 be the name of a Unix domain socket. The transport connects to the socket and
24182 delivers the message to it using the LMTP protocol.
24183
24184
24185 .option timeout lmtp time 5m
24186 The transport is aborted if the created process or Unix domain socket does not
24187 respond to LMTP commands or message input within this timeout. Delivery
24188 is deferred, and will be tried again later. Here is an example of a typical
24189 LMTP transport:
24190 .code
24191 lmtp:
24192   driver = lmtp
24193   command = /some/local/lmtp/delivery/program
24194   batch_max = 20
24195   user = exim
24196 .endd
24197 This delivers up to 20 addresses at a time, in a mixture of domains if
24198 necessary, running as the user &'exim'&.
24199
24200
24201
24202 . ////////////////////////////////////////////////////////////////////////////
24203 . ////////////////////////////////////////////////////////////////////////////
24204
24205 .chapter "The pipe transport" "CHAPpipetransport"
24206 .scindex IIDpiptra1 "transports" "&(pipe)&"
24207 .scindex IIDpiptra2 "&(pipe)& transport"
24208 The &(pipe)& transport is used to deliver messages via a pipe to a command
24209 running in another process. One example is the use of &(pipe)& as a
24210 pseudo-remote transport for passing messages to some other delivery mechanism
24211 (such as UUCP). Another is the use by individual users to automatically process
24212 their incoming messages. The &(pipe)& transport can be used in one of the
24213 following ways:
24214
24215 .ilist
24216 .vindex "&$local_part$&"
24217 A router routes one address to a transport in the normal way, and the
24218 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24219 contains the local part of the address (as usual), and the command that is run
24220 is specified by the &%command%& option on the transport.
24221 .next
24222 .vindex "&$pipe_addresses$&"
24223 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24224 transport can handle more than one address in a single run. In this case, when
24225 more than one address is routed to the transport, &$local_part$& is not set
24226 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24227 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24228 that are routed to the transport.
24229 .next
24230 .vindex "&$address_pipe$&"
24231 A router redirects an address directly to a pipe command (for example, from an
24232 alias or forward file). In this case, &$address_pipe$& contains the text of the
24233 pipe command, and the &%command%& option on the transport is ignored unless
24234 &%force_command%& is set. If only one address is being transported
24235 (&%batch_max%& is not greater than one, or only one address was redirected to
24236 this pipe command), &$local_part$& contains the local part that was redirected.
24237 .endlist
24238
24239
24240 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24241 deliver messages over pipes using the LMTP interactive protocol. This is
24242 implemented by the &(lmtp)& transport.
24243
24244 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24245 &_.forward_& file, the command runs under the uid and gid of that user. In
24246 other cases, the uid and gid have to be specified explicitly, either on the
24247 transport or on the router that handles the address. Current and &"home"&
24248 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24249 details of the local delivery environment and chapter &<<CHAPbatching>>&
24250 for a discussion of local delivery batching.
24251
24252 .cindex "tainted data" "in pipe command"
24253 .cindex pipe "tainted data"
24254 Tainted data may not be used for the command name.
24255
24256
24257 .section "Concurrent delivery" "SECID140"
24258 If two messages arrive at almost the same time, and both are routed to a pipe
24259 delivery, the two pipe transports may be run concurrently. You must ensure that
24260 any pipe commands you set up are robust against this happening. If the commands
24261 write to a file, the &%exim_lock%& utility might be of use.
24262 Alternatively the &%max_parallel%& option could be used with a value
24263 of "1" to enforce serialization.
24264
24265
24266
24267
24268 .section "Returned status and data" "SECID141"
24269 .cindex "&(pipe)& transport" "returned data"
24270 If the command exits with a non-zero return code, the delivery is deemed to
24271 have failed, unless either the &%ignore_status%& option is set (in which case
24272 the return code is treated as zero), or the return code is one of those listed
24273 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24274 later"&. In this case, delivery is deferred. Details of a permanent failure are
24275 logged, but are not included in the bounce message, which merely contains
24276 &"local delivery failed"&.
24277
24278 If the command exits on a signal and the &%freeze_signal%& option is set then
24279 the message will be frozen in the queue. If that option is not set, a bounce
24280 will be sent as normal.
24281
24282 If the return code is greater than 128 and the command being run is a shell
24283 script, it normally means that the script was terminated by a signal whose
24284 value is the return code minus 128. The &%freeze_signal%& option does not
24285 apply in this case.
24286
24287 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24288 return code is set to 127. This is the value that a shell returns if it is
24289 asked to run a non-existent command. The wording for the log line suggests that
24290 a non-existent command may be the problem.
24291
24292 The &%return_output%& option can affect the result of a pipe delivery. If it is
24293 set and the command produces any output on its standard output or standard
24294 error streams, the command is considered to have failed, even if it gave a zero
24295 return code or if &%ignore_status%& is set. The output from the command is
24296 included as part of the bounce message. The &%return_fail_output%& option is
24297 similar, except that output is returned only when the command exits with a
24298 failure return code, that is, a value other than zero or a code that matches
24299 &%temp_errors%&.
24300
24301
24302
24303 .section "How the command is run" "SECThowcommandrun"
24304 .cindex "&(pipe)& transport" "path for command"
24305 The command line is (by default) broken down into a command name and arguments
24306 by the &(pipe)& transport itself. The &%allow_commands%& and
24307 &%restrict_to_path%& options can be used to restrict the commands that may be
24308 run.
24309
24310 .cindex "quoting" "in pipe command"
24311 Unquoted arguments are delimited by white space. If an argument appears in
24312 double quotes, backslash is interpreted as an escape character in the usual
24313 way. If an argument appears in single quotes, no escaping is done.
24314
24315 String expansion is applied to the command line except when it comes from a
24316 traditional &_.forward_& file (commands from a filter file are expanded). The
24317 expansion is applied to each argument in turn rather than to the whole line.
24318 For this reason, any string expansion item that contains white space must be
24319 quoted so as to be contained within a single argument. A setting such as
24320 .code
24321 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24322 .endd
24323 will not work, because the expansion item gets split between several
24324 arguments. You have to write
24325 .code
24326 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24327 .endd
24328 to ensure that it is all in one argument. The expansion is done in this way,
24329 argument by argument, so that the number of arguments cannot be changed as a
24330 result of expansion, and quotes or backslashes in inserted variables do not
24331 interact with external quoting. However, this leads to problems if you want to
24332 generate multiple arguments (or the command name plus arguments) from a single
24333 expansion. In this situation, the simplest solution is to use a shell. For
24334 example:
24335 .code
24336 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24337 .endd
24338
24339 .cindex "transport" "filter"
24340 .cindex "filter" "transport filter"
24341 .vindex "&$pipe_addresses$&"
24342 Special handling takes place when an argument consists of precisely the text
24343 &`$pipe_addresses`& (no quotes).
24344 This is not a general expansion variable; the only
24345 place this string is recognized is when it appears as an argument for a pipe or
24346 transport filter command. It causes each address that is being handled to be
24347 inserted in the argument list at that point &'as a separate argument'&. This
24348 avoids any problems with spaces or shell metacharacters, and is of use when a
24349 &(pipe)& transport is handling groups of addresses in a batch.
24350
24351 If &%force_command%& is enabled on the transport, special handling takes place
24352 for an argument that consists of precisely the text &`$address_pipe`&.  It
24353 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24354 argument is inserted in the argument list at that point
24355 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24356 the only item in the argument; in fact, if it were then &%force_command%&
24357 should behave as a no-op.  Rather, it should be used to adjust the command
24358 run while preserving the argument vector separation.
24359
24360 After splitting up into arguments and expansion, the resulting command is run
24361 in a subprocess directly from the transport, &'not'& under a shell. The
24362 message that is being delivered is supplied on the standard input, and the
24363 standard output and standard error are both connected to a single pipe that is
24364 read by Exim. The &%max_output%& option controls how much output the command
24365 may produce, and the &%return_output%& and &%return_fail_output%& options
24366 control what is done with it.
24367
24368 Not running the command under a shell (by default) lessens the security risks
24369 in cases when a command from a user's filter file is built out of data that was
24370 taken from an incoming message. If a shell is required, it can of course be
24371 explicitly specified as the command to be run. However, there are circumstances
24372 where existing commands (for example, in &_.forward_& files) expect to be run
24373 under a shell and cannot easily be modified. To allow for these cases, there is
24374 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24375 works. Instead of breaking up the command line as just described, it expands it
24376 as a single string and passes the result to &_/bin/sh_&. The
24377 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24378 with &%use_shell%&, and the whole mechanism is inherently less secure.
24379
24380
24381
24382 .section "Environment variables" "SECTpipeenv"
24383 .cindex "&(pipe)& transport" "environment for command"
24384 .cindex "environment" "&(pipe)& transport"
24385 The environment variables listed below are set up when the command is invoked.
24386 This list is a compromise for maximum compatibility with other MTAs. Note that
24387 the &%environment%& option can be used to add additional variables to this
24388 environment. The environment for the &(pipe)& transport is not subject
24389 to the &%add_environment%& and &%keep_environment%& main config options.
24390 .display
24391 &`DOMAIN            `&   the domain of the address
24392 &`HOME              `&   the home directory, if set
24393 &`HOST              `&   the host name when called from a router (see below)
24394 &`LOCAL_PART        `&   see below
24395 &`LOCAL_PART_PREFIX `&   see below
24396 &`LOCAL_PART_SUFFIX `&   see below
24397 &`LOGNAME           `&   see below
24398 &`MESSAGE_ID        `&   Exim's local ID for the message
24399 &`PATH              `&   as specified by the &%path%& option below
24400 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24401 &`RECIPIENT         `&   the complete recipient address
24402 &`SENDER            `&   the sender of the message (empty if a bounce)
24403 &`SHELL             `&   &`/bin/sh`&
24404 &`TZ                `&   the value of the &%timezone%& option, if set
24405 &`USER              `&   see below
24406 .endd
24407 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24408 router, LOCAL_PART is set to the local part of the address. When it is
24409 called as a result of a forward or alias expansion, LOCAL_PART is set to
24410 the local part of the address that was expanded. In both cases, any affixes are
24411 removed from the local part, and made available in LOCAL_PART_PREFIX and
24412 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24413 same value as LOCAL_PART for compatibility with other MTAs.
24414
24415 .cindex "HOST"
24416 HOST is set only when a &(pipe)& transport is called from a router that
24417 associates hosts with an address, typically when using &(pipe)& as a
24418 pseudo-remote transport. HOST is set to the first host name specified by
24419 the router.
24420
24421 .cindex "HOME"
24422 If the transport's generic &%home_directory%& option is set, its value is used
24423 for the HOME environment variable. Otherwise, a home directory may be set
24424 by the router's &%transport_home_directory%& option, which defaults to the
24425 user's home directory if &%check_local_user%& is set.
24426
24427
24428 .section "Private options for pipe" "SECID142"
24429 .cindex "options" "&(pipe)& transport"
24430
24431
24432
24433 .option allow_commands pipe "string list&!!" unset
24434 .cindex "&(pipe)& transport" "permitted commands"
24435 The string is expanded, and is then interpreted as a colon-separated list of
24436 permitted commands. If &%restrict_to_path%& is not set, the only commands
24437 permitted are those in the &%allow_commands%& list. They need not be absolute
24438 paths; the &%path%& option is still used for relative paths. If
24439 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24440 in the &%allow_commands%& list, or a name without any slashes that is found on
24441 the path. In other words, if neither &%allow_commands%& nor
24442 &%restrict_to_path%& is set, there is no restriction on the command, but
24443 otherwise only commands that are permitted by one or the other are allowed. For
24444 example, if
24445 .code
24446 allow_commands = /usr/bin/vacation
24447 .endd
24448 and &%restrict_to_path%& is not set, the only permitted command is
24449 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24450 &%use_shell%& is set.
24451
24452
24453 .option batch_id pipe string&!! unset
24454 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24455
24456
24457 .option batch_max pipe integer 1
24458 This limits the number of addresses that can be handled in a single delivery.
24459 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24460
24461
24462 .option check_string pipe string unset
24463 As &(pipe)& writes the message, the start of each line is tested for matching
24464 &%check_string%&, and if it does, the initial matching characters are replaced
24465 by the contents of &%escape_string%&, provided both are set. The value of
24466 &%check_string%& is a literal string, not a regular expression, and the case of
24467 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24468 of &%check_string%& and &%escape_string%& are forced to values that implement
24469 the SMTP escaping protocol. Any settings made in the configuration file are
24470 ignored.
24471
24472
24473 .option command pipe string&!! unset
24474 This option need not be set when &(pipe)& is being used to deliver to pipes
24475 obtained directly from address redirections. In other cases, the option must be
24476 set, to provide a command to be run. It need not yield an absolute path (see
24477 the &%path%& option below). The command is split up into separate arguments by
24478 Exim, and each argument is separately expanded, as described in section
24479 &<<SECThowcommandrun>>& above.
24480
24481
24482 .option environment pipe string&!! unset
24483 .cindex "&(pipe)& transport" "environment for command"
24484 .cindex "environment" "&(pipe)& transport"
24485 This option is used to add additional variables to the environment in which the
24486 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24487 a string which is expanded, and then interpreted as a colon-separated list of
24488 environment settings of the form <&'name'&>=<&'value'&>.
24489
24490
24491 .option escape_string pipe string unset
24492 See &%check_string%& above.
24493
24494
24495 .option freeze_exec_fail pipe boolean false
24496 .cindex "exec failure"
24497 .cindex "failure of exec"
24498 .cindex "&(pipe)& transport" "failure of exec"
24499 Failure to exec the command in a pipe transport is by default treated like
24500 any other failure while running the command. However, if &%freeze_exec_fail%&
24501 is set, failure to exec is treated specially, and causes the message to be
24502 frozen, whatever the setting of &%ignore_status%&.
24503
24504
24505 .option freeze_signal pipe boolean false
24506 .cindex "signal exit"
24507 .cindex "&(pipe)& transport", "signal exit"
24508 Normally if the process run by a command in a pipe transport exits on a signal,
24509 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24510 frozen in Exim's queue instead.
24511
24512
24513 .option force_command pipe boolean false
24514 .cindex "force command"
24515 .cindex "&(pipe)& transport", "force command"
24516 Normally when a router redirects an address directly to a pipe command
24517 the &%command%& option on the transport is ignored.  If &%force_command%&
24518 is set, the &%command%& option will used. This is especially
24519 useful for forcing a wrapper or additional argument to be added to the
24520 command. For example:
24521 .code
24522 command = /usr/bin/remote_exec myhost -- $address_pipe
24523 force_command
24524 .endd
24525
24526 Note that &$address_pipe$& is handled specially in &%command%& when
24527 &%force_command%& is set, expanding out to the original argument vector as
24528 separate items, similarly to a Unix shell &`"$@"`& construct.
24529
24530
24531 .option ignore_status pipe boolean false
24532 If this option is true, the status returned by the subprocess that is set up to
24533 run the command is ignored, and Exim behaves as if zero had been returned.
24534 Otherwise, a non-zero status or termination by signal causes an error return
24535 from the transport unless the status value is one of those listed in
24536 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24537
24538 &*Note*&: This option does not apply to timeouts, which do not return a status.
24539 See the &%timeout_defer%& option for how timeouts are handled.
24540
24541
24542 .option log_defer_output pipe boolean false
24543 .cindex "&(pipe)& transport" "logging output"
24544 If this option is set, and the status returned by the command is
24545 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24546 and any output was produced on stdout or stderr, the first line of it is
24547 written to the main log.
24548
24549
24550 .option log_fail_output pipe boolean false
24551 If this option is set, and the command returns any output on stdout or
24552 stderr, and also ends with a return code that is neither zero nor one of
24553 the return codes listed in &%temp_errors%& (that is, the delivery
24554 failed), the first line of output is written to the main log. This
24555 option and &%log_output%& are mutually exclusive.  Only one of them may
24556 be set.
24557
24558
24559 .option log_output pipe boolean false
24560 If this option is set and the command returns any output on stdout or
24561 stderr, the first line of output is written to the main log, whatever
24562 the return code. This option and &%log_fail_output%& are mutually
24563 exclusive. Only one of them may be set.
24564
24565
24566 .option max_output pipe integer 20K
24567 This specifies the maximum amount of output that the command may produce on its
24568 standard output and standard error file combined. If the limit is exceeded, the
24569 process running the command is killed. This is intended as a safety measure to
24570 catch runaway processes. The limit is applied independently of the settings of
24571 the options that control what is done with such output (for example,
24572 &%return_output%&). Because of buffering effects, the amount of output may
24573 exceed the limit by a small amount before Exim notices.
24574
24575
24576 .option message_prefix pipe string&!! "see below"
24577 The string specified here is expanded and output at the start of every message.
24578 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24579 .code
24580 message_prefix = \
24581   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24582   ${tod_bsdinbox}\n
24583 .endd
24584 .cindex "Cyrus"
24585 .cindex "&%tmail%&"
24586 .cindex "&""From""& line"
24587 This is required by the commonly used &_/usr/bin/vacation_& program.
24588 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24589 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24590 setting
24591 .code
24592 message_prefix =
24593 .endd
24594 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24595 &`\n`& to &`\r\n`& in &%message_prefix%&.
24596
24597
24598 .option message_suffix pipe string&!! "see below"
24599 The string specified here is expanded and output at the end of every message.
24600 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24601 The suffix can be suppressed by setting
24602 .code
24603 message_suffix =
24604 .endd
24605 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24606 &`\n`& to &`\r\n`& in &%message_suffix%&.
24607
24608
24609 .option path pipe string&!! "/bin:/usr/bin"
24610 This option is expanded and
24611 specifies the string that is set up in the PATH environment
24612 variable of the subprocess.
24613 If the &%command%& option does not yield an absolute path name, the command is
24614 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24615 apply to a command specified as a transport filter.
24616
24617
24618 .option permit_coredump pipe boolean false
24619 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24620 a core-dump of a pipe command, enable this command.  This enables core-dumps
24621 during delivery and affects both the Exim binary and the pipe command run.
24622 It is recommended that this option remain off unless and until you have a need
24623 for it and that this only be enabled when needed, as the risk of excessive
24624 resource consumption can be quite high.  Note also that Exim is typically
24625 installed as a setuid binary and most operating systems will inhibit coredumps
24626 of these by default, so further OS-specific action may be required.
24627
24628
24629 .option pipe_as_creator pipe boolean false
24630 .cindex "uid (user id)" "local delivery"
24631 If the generic &%user%& option is not set and this option is true, the delivery
24632 process is run under the uid that was in force when Exim was originally called
24633 to accept the message. If the group id is not otherwise set (via the generic
24634 &%group%& option), the gid that was in force when Exim was originally called to
24635 accept the message is used.
24636
24637
24638 .option restrict_to_path pipe boolean false
24639 When this option is set, any command name not listed in &%allow_commands%& must
24640 contain no slashes. The command is searched for only in the directories listed
24641 in the &%path%& option. This option is intended for use in the case when a pipe
24642 command has been generated from a user's &_.forward_& file. This is usually
24643 handled by a &(pipe)& transport called &%address_pipe%&.
24644
24645
24646 .option return_fail_output pipe boolean false
24647 If this option is true, and the command produced any output and ended with a
24648 return code other than zero or one of the codes listed in &%temp_errors%& (that
24649 is, the delivery failed), the output is returned in the bounce message.
24650 However, if the message has a null sender (that is, it is itself a bounce
24651 message), output from the command is discarded. This option and
24652 &%return_output%& are mutually exclusive. Only one of them may be set.
24653
24654
24655
24656 .option return_output pipe boolean false
24657 If this option is true, and the command produced any output, the delivery is
24658 deemed to have failed whatever the return code from the command, and the output
24659 is returned in the bounce message. Otherwise, the output is just discarded.
24660 However, if the message has a null sender (that is, it is a bounce message),
24661 output from the command is always discarded, whatever the setting of this
24662 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24663 of them may be set.
24664
24665
24666
24667 .option temp_errors pipe "string list" "see below"
24668 .cindex "&(pipe)& transport" "temporary failure"
24669 This option contains either a colon-separated list of numbers, or a single
24670 asterisk. If &%ignore_status%& is false
24671 and &%return_output%& is not set,
24672 and the command exits with a non-zero return code, the failure is treated as
24673 temporary and the delivery is deferred if the return code matches one of the
24674 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24675 codes are treated as permanent errors. The default setting contains the codes
24676 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24677 compiled on a system that does not define these macros, it assumes values of 75
24678 and 73, respectively.
24679
24680
24681 .option timeout pipe time 1h
24682 If the command fails to complete within this time, it is killed. This normally
24683 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24684 specifies no timeout. In order to ensure that any subprocesses created by the
24685 command are also killed, Exim makes the initial process a process group leader,
24686 and kills the whole process group on a timeout. However, this can be defeated
24687 if one of the processes starts a new process group.
24688
24689 .option timeout_defer pipe boolean false
24690 A timeout in a &(pipe)& transport, either in the command that the transport
24691 runs, or in a transport filter that is associated with it, is by default
24692 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24693 is set true, both kinds of timeout become temporary errors, causing the
24694 delivery to be deferred.
24695
24696 .option umask pipe "octal integer" 022
24697 This specifies the umask setting for the subprocess that runs the command.
24698
24699
24700 .option use_bsmtp pipe boolean false
24701 .cindex "envelope sender"
24702 If this option is set true, the &(pipe)& transport writes messages in &"batch
24703 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24704 commands. If you want to include a leading HELO command with such messages,
24705 you can do so by setting the &%message_prefix%& option. See section
24706 &<<SECTbatchSMTP>>& for details of batch SMTP.
24707
24708 .option use_classresources pipe boolean false
24709 .cindex "class resources (BSD)"
24710 This option is available only when Exim is running on FreeBSD, NetBSD, or
24711 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24712 resource limits when a &(pipe)& transport is run to perform a delivery. The
24713 limits for the uid under which the pipe is to run are obtained from the login
24714 class database.
24715
24716
24717 .option use_crlf pipe boolean false
24718 .cindex "carriage return"
24719 .cindex "linefeed"
24720 This option causes lines to be terminated with the two-character CRLF sequence
24721 (carriage return, linefeed) instead of just a linefeed character. In the case
24722 of batched SMTP, the byte sequence written to the pipe is then an exact image
24723 of what would be sent down a real SMTP connection.
24724
24725 The contents of the &%message_prefix%& and &%message_suffix%& options are
24726 written verbatim, so must contain their own carriage return characters if these
24727 are needed. When &%use_bsmtp%& is not set, the default values for both
24728 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24729 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24730
24731
24732 .option use_shell pipe boolean false
24733 .vindex "&$pipe_addresses$&"
24734 If this option is set, it causes the command to be passed to &_/bin/sh_&
24735 instead of being run directly from the transport, as described in section
24736 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24737 where the command is expected to be run under a shell and cannot easily be
24738 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24739 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24740 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24741 its &%-c%& option.
24742
24743
24744
24745 .section "Using an external local delivery agent" "SECID143"
24746 .cindex "local delivery" "using an external agent"
24747 .cindex "&'procmail'&"
24748 .cindex "external local delivery"
24749 .cindex "delivery" "&'procmail'&"
24750 .cindex "delivery" "by external agent"
24751 The &(pipe)& transport can be used to pass all messages that require local
24752 delivery to a separate local delivery agent such as &%procmail%&. When doing
24753 this, care must be taken to ensure that the pipe is run under an appropriate
24754 uid and gid. In some configurations one wants this to be a uid that is trusted
24755 by the delivery agent to supply the correct sender of the message. It may be
24756 necessary to recompile or reconfigure the delivery agent so that it trusts an
24757 appropriate user. The following is an example transport and router
24758 configuration for &%procmail%&:
24759 .code
24760 # transport
24761 procmail_pipe:
24762   driver = pipe
24763   command = /usr/local/bin/procmail -d $local_part_data
24764   return_path_add
24765   delivery_date_add
24766   envelope_to_add
24767   check_string = "From "
24768   escape_string = ">From "
24769   umask = 077
24770   user = $local_part_data
24771   group = mail
24772
24773 # router
24774 procmail:
24775   driver = accept
24776   check_local_user
24777   transport = procmail_pipe
24778 .endd
24779 In this example, the pipe is run as the local user, but with the group set to
24780 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24781 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24782 user to supply a correct sender address. If you do not specify either a
24783 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24784 home directory is the user's home directory by default.
24785
24786 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24787 .code
24788 IFS=" "
24789 .endd
24790 as shown in some &%procmail%& documentation, because Exim does not by default
24791 use a shell to run pipe commands.
24792
24793 .cindex "Cyrus"
24794 The next example shows a transport and a router for a system where local
24795 deliveries are handled by the Cyrus IMAP server.
24796 .code
24797 # transport
24798 local_delivery_cyrus:
24799   driver = pipe
24800   command = /usr/cyrus/bin/deliver \
24801             -m ${substr_1:$local_part_suffix} -- $local_part
24802   user = cyrus
24803   group = mail
24804   return_output
24805   log_output
24806   message_prefix =
24807   message_suffix =
24808
24809 # router
24810 local_user_cyrus:
24811   driver = accept
24812   check_local_user
24813   local_part_suffix = .*
24814   transport = local_delivery_cyrus
24815 .endd
24816 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24817 &%return_output%& to cause any text written by Cyrus to be returned to the
24818 sender.
24819 .ecindex IIDpiptra1
24820 .ecindex IIDpiptra2
24821
24822
24823 . ////////////////////////////////////////////////////////////////////////////
24824 . ////////////////////////////////////////////////////////////////////////////
24825
24826 .chapter "The smtp transport" "CHAPsmtptrans"
24827 .scindex IIDsmttra1 "transports" "&(smtp)&"
24828 .scindex IIDsmttra2 "&(smtp)& transport"
24829 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24830 or LMTP protocol. The list of hosts to try can either be taken from the address
24831 that is being processed (having been set up by the router), or specified
24832 explicitly for the transport. Timeout and retry processing (see chapter
24833 &<<CHAPretry>>&) is applied to each IP address independently.
24834
24835
24836 .section "Multiple messages on a single connection" "SECID144"
24837 The sending of multiple messages over a single TCP/IP connection can arise in
24838 two ways:
24839
24840 .ilist
24841 If a message contains more than &%max_rcpt%& (see below) addresses that are
24842 routed to the same host, more than one copy of the message has to be sent to
24843 that host. In this situation, multiple copies may be sent in a single run of
24844 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24845 does when it has too many addresses to send in one message also depends on the
24846 value of the global &%remote_max_parallel%& option. Details are given in
24847 section &<<SECToutSMTPTCP>>&.)
24848 .next
24849 .cindex "hints database" "remembering routing"
24850 When a message has been successfully delivered over a TCP/IP connection, Exim
24851 looks in its hints database to see if there are any other messages awaiting a
24852 connection to the same host. If there are, a new delivery process is started
24853 for one of them, and the current TCP/IP connection is passed on to it. The new
24854 process may in turn send multiple copies and possibly create yet another
24855 process.
24856 .endlist
24857
24858
24859 For each copy sent over the same TCP/IP connection, a sequence counter is
24860 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24861 no further messages are sent over that connection.
24862
24863
24864
24865 .section "Use of the $host and $host_address variables" "SECID145"
24866 .vindex "&$host$&"
24867 .vindex "&$host_address$&"
24868 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24869 &$host_address$& are the name and IP address of the first host on the host list
24870 passed by the router. However, when the transport is about to connect to a
24871 specific host, and while it is connected to that host, &$host$& and
24872 &$host_address$& are set to the values for that host. These are the values
24873 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24874 &%serialize_hosts%&, and the various TLS options are expanded.
24875
24876
24877 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24878 .vindex &$tls_bits$&
24879 .vindex &$tls_cipher$&
24880 .vindex &$tls_peerdn$&
24881 .vindex &$tls_sni$&
24882 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24883 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24884 are the values that were set when the message was received.
24885 These are the values that are used for options that are expanded before any
24886 SMTP connections are made. Just before each connection is made, these four
24887 variables are emptied. If TLS is subsequently started, they are set to the
24888 appropriate values for the outgoing connection, and these are the values that
24889 are in force when any authenticators are run and when the
24890 &%authenticated_sender%& option is expanded.
24891
24892 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24893 and will be removed in a future release.
24894
24895
24896 .section "Private options for smtp" "SECID146"
24897 .cindex "options" "&(smtp)& transport"
24898 The private options of the &(smtp)& transport are as follows:
24899
24900
24901 .option address_retry_include_sender smtp boolean true
24902 .cindex "4&'xx'& responses" "retrying after"
24903 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24904 is the combination of sender and recipient that is delayed in subsequent queue
24905 runs until the retry time is reached. You can delay the recipient without
24906 reference to the sender (which is what earlier versions of Exim did), by
24907 setting &%address_retry_include_sender%& false. However, this can lead to
24908 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24909
24910 .option allow_localhost smtp boolean false
24911 .cindex "local host" "sending to"
24912 .cindex "fallback" "hosts specified on transport"
24913 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24914 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24915 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24916 the delivery anyway. This should be used only in special cases when the
24917 configuration ensures that no looping will result (for example, a differently
24918 configured Exim is listening on the port to which the message is sent).
24919
24920
24921 .option authenticated_sender smtp string&!! unset
24922 .cindex "Cyrus"
24923 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24924 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24925 overriding any existing authenticated sender value. If the string expansion is
24926 forced to fail, the option is ignored. Other expansion failures cause delivery
24927 to be deferred. If the result of expansion is an empty string, that is also
24928 ignored.
24929
24930 The expansion happens after the outgoing connection has been made and TLS
24931 started, if required. This means that the &$host$&, &$host_address$&,
24932 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24933 particular connection.
24934
24935 If the SMTP session is not authenticated, the expansion of
24936 &%authenticated_sender%& still happens (and can cause the delivery to be
24937 deferred if it fails), but no AUTH= item is added to MAIL commands
24938 unless &%authenticated_sender_force%& is true.
24939
24940 This option allows you to use the &(smtp)& transport in LMTP mode to
24941 deliver mail to Cyrus IMAP and provide the proper local part as the
24942 &"authenticated sender"&, via a setting such as:
24943 .code
24944 authenticated_sender = $local_part
24945 .endd
24946 This removes the need for IMAP subfolders to be assigned special ACLs to
24947 allow direct delivery to those subfolders.
24948
24949 Because of expected uses such as that just described for Cyrus (when no
24950 domain is involved), there is no checking on the syntax of the provided
24951 value.
24952
24953
24954 .option authenticated_sender_force smtp boolean false
24955 If this option is set true, the &%authenticated_sender%& option's value
24956 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24957 authenticated as a client.
24958
24959
24960 .option command_timeout smtp time 5m
24961 This sets a timeout for receiving a response to an SMTP command that has been
24962 sent out. It is also used when waiting for the initial banner line from the
24963 remote host. Its value must not be zero.
24964
24965
24966 .option connect_timeout smtp time 5m
24967 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24968 to a remote host. A setting of zero allows the system timeout (typically
24969 several minutes) to act. To have any effect, the value of this option must be
24970 less than the system timeout. However, it has been observed that on some
24971 systems there is no system timeout, which is why the default value for this
24972 option is 5 minutes, a value recommended by RFC 1123.
24973
24974
24975 .option connection_max_messages smtp integer 500
24976 .cindex "SMTP" "passed connection"
24977 .cindex "SMTP" "multiple deliveries"
24978 .cindex "multiple SMTP deliveries"
24979 This controls the maximum number of separate message deliveries that are sent
24980 over a single TCP/IP connection. If the value is zero, there is no limit.
24981 For testing purposes, this value can be overridden by the &%-oB%& command line
24982 option.
24983
24984
24985 .option dane_require_tls_ciphers smtp string&!! unset
24986 .cindex "TLS" "requiring specific ciphers for DANE"
24987 .cindex "cipher" "requiring specific"
24988 .cindex DANE "TLS ciphers"
24989 This option may be used to override &%tls_require_ciphers%& for connections
24990 where DANE has been determined to be in effect.
24991 If not set, then &%tls_require_ciphers%& will be used.
24992 Normal SMTP delivery is not able to make strong demands of TLS cipher
24993 configuration, because delivery will fall back to plaintext.  Once DANE has
24994 been determined to be in effect, there is no plaintext fallback and making the
24995 TLS cipherlist configuration stronger will increase security, rather than
24996 counter-intuitively decreasing it.
24997 If the option expands to be empty or is forced to fail, then it will
24998 be treated as unset and &%tls_require_ciphers%& will be used instead.
24999
25000
25001 .option data_timeout smtp time 5m
25002 This sets a timeout for the transmission of each block in the data portion of
25003 the message. As a result, the overall timeout for a message depends on the size
25004 of the message. Its value must not be zero. See also &%final_timeout%&.
25005
25006
25007 .option dkim_canon smtp string&!! unset
25008 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25009 .option dkim_domain smtp string list&!! unset
25010 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25011 .option dkim_hash smtp string&!! sha256
25012 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25013 .option dkim_identity smtp string&!! unset
25014 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25015 .option dkim_private_key smtp string&!! unset
25016 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25017 .option dkim_selector smtp string&!! unset
25018 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25019 .option dkim_strict smtp string&!! unset
25020 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25021 .option dkim_sign_headers smtp string&!! "per RFC"
25022 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25023 .option dkim_timestamps smtp string&!! unset
25024 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25025
25026
25027 .option delay_after_cutoff smtp boolean true
25028 .cindex "final cutoff" "retries, controlling"
25029 .cindex retry "final cutoff"
25030 This option controls what happens when all remote IP addresses for a given
25031 domain have been inaccessible for so long that they have passed their retry
25032 cutoff times.
25033
25034 In the default state, if the next retry time has not been reached for any of
25035 them, the address is bounced without trying any deliveries. In other words,
25036 Exim delays retrying an IP address after the final cutoff time until a new
25037 retry time is reached, and can therefore bounce an address without ever trying
25038 a delivery, when machines have been down for a long time. Some people are
25039 unhappy at this prospect, so...
25040
25041 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25042 addresses are past their final cutoff time, Exim tries to deliver to those
25043 IP addresses that have not been tried since the message arrived. If there are
25044 none, of if they all fail, the address is bounced. In other words, it does not
25045 delay when a new message arrives, but immediately tries those expired IP
25046 addresses that haven't been tried since the message arrived. If there is a
25047 continuous stream of messages for the dead hosts, unsetting
25048 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25049 to them.
25050
25051
25052 .option dns_qualify_single smtp boolean true
25053 If the &%hosts%& or &%fallback_hosts%& option is being used,
25054 and the &%gethostbyname%& option is false,
25055 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25056 in chapter &<<CHAPdnslookup>>& for more details.
25057
25058
25059 .option dns_search_parents smtp boolean false
25060 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25061 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25062 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25063 details.
25064
25065
25066 .option dnssec_request_domains smtp "domain list&!!" *
25067 .cindex "MX record" "security"
25068 .cindex "DNSSEC" "MX lookup"
25069 .cindex "security" "MX lookup"
25070 .cindex "DNS" "DNSSEC"
25071 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25072 the dnssec request bit set. Setting this transport option is only useful if the
25073 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25074 router option.
25075
25076
25077
25078 .option dnssec_require_domains smtp "domain list&!!" unset
25079 .cindex "MX record" "security"
25080 .cindex "DNSSEC" "MX lookup"
25081 .cindex "security" "MX lookup"
25082 .cindex "DNS" "DNSSEC"
25083 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25084 the dnssec request bit set.  Setting this transport option is only
25085 useful if the transport overrides or sets the host names. See the
25086 &%dnssec_require_domains%& router option.
25087
25088
25089
25090 .option dscp smtp string&!! unset
25091 .cindex "DCSP" "outbound"
25092 This option causes the DSCP value associated with a socket to be set to one
25093 of a number of fixed strings or to numeric value.
25094 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25095 Common values include &`throughput`&, &`mincost`&, and on newer systems
25096 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25097
25098 The outbound packets from Exim will be marked with this value in the header
25099 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25100 that these values will have any effect, not be stripped by networking
25101 equipment, or do much of anything without cooperation with your Network
25102 Engineer and those of all network operators between the source and destination.
25103
25104
25105 .option fallback_hosts smtp "string list" unset
25106 .cindex "fallback" "hosts specified on transport"
25107 String expansion is not applied to this option. The argument must be a
25108 colon-separated list of host names or IP addresses, optionally also including
25109 port numbers, though the separator can be changed, as described in section
25110 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25111 item in a &%route_list%& setting for the &(manualroute)& router, as described
25112 in section &<<SECTformatonehostitem>>&.
25113
25114 Fallback hosts can also be specified on routers, which associate them with the
25115 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25116 &%fallback_hosts%& specified on the transport is used only if the address does
25117 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25118 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25119 However, &%hosts_randomize%& does apply to fallback host lists.
25120
25121 If Exim is unable to deliver to any of the hosts for a particular address, and
25122 the errors are not permanent rejections, the address is put on a separate
25123 transport queue with its host list replaced by the fallback hosts, unless the
25124 address was routed via MX records and the current host was in the original MX
25125 list. In that situation, the fallback host list is not used.
25126
25127 Once normal deliveries are complete, the fallback queue is delivered by
25128 re-running the same transports with the new host lists. If several failing
25129 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25130 copy of the message is sent.
25131
25132 The resolution of the host names on the fallback list is controlled by the
25133 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25134 both to cases when the host list comes with the address and when it is taken
25135 from &%hosts%&. This option provides a &"use a smart host only if delivery
25136 fails"& facility.
25137
25138
25139 .option final_timeout smtp time 10m
25140 This is the timeout that applies while waiting for the response to the final
25141 line containing just &"."& that terminates a message. Its value must not be
25142 zero.
25143
25144 .option gethostbyname smtp boolean false
25145 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25146 being used, names are looked up using &[gethostbyname()]&
25147 (or &[getipnodebyname()]& when available)
25148 instead of using the DNS. Of course, that function may in fact use the DNS, but
25149 it may also consult other sources of information such as &_/etc/hosts_&.
25150
25151 .option gnutls_compat_mode smtp boolean unset
25152 This option controls whether GnuTLS is used in compatibility mode in an Exim
25153 server. This reduces security slightly, but improves interworking with older
25154 implementations of TLS.
25155
25156 .option helo_data smtp string&!! "see below"
25157 .cindex "HELO" "argument, setting"
25158 .cindex "EHLO" "argument, setting"
25159 .cindex "LHLO argument setting"
25160 The value of this option is expanded after a connection to a another host has
25161 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25162 command that starts the outgoing SMTP or LMTP session. The default value of the
25163 option is:
25164 .code
25165 $primary_hostname
25166 .endd
25167 During the expansion, the variables &$host$& and &$host_address$& are set to
25168 the identity of the remote host, and the variables &$sending_ip_address$& and
25169 &$sending_port$& are set to the local IP address and port number that are being
25170 used. These variables can be used to generate different values for different
25171 servers or different local IP addresses. For example, if you want the string
25172 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25173 interface address, you could use this:
25174 .code
25175 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25176   {$primary_hostname}}
25177 .endd
25178 The use of &%helo_data%& applies both to sending messages and when doing
25179 callouts.
25180
25181 .option hosts smtp "string list&!!" unset
25182 Hosts are associated with an address by a router such as &(dnslookup)&, which
25183 finds the hosts by looking up the address domain in the DNS, or by
25184 &(manualroute)&, which has lists of hosts in its configuration. However,
25185 email addresses can be passed to the &(smtp)& transport by any router, and not
25186 all of them can provide an associated list of hosts.
25187
25188 The &%hosts%& option specifies a list of hosts to be used if the address being
25189 processed does not have any hosts associated with it. The hosts specified by
25190 &%hosts%& are also used, whether or not the address has its own hosts, if
25191 &%hosts_override%& is set.
25192
25193 The string is first expanded, before being interpreted as a colon-separated
25194 list of host names or IP addresses, possibly including port numbers. The
25195 separator may be changed to something other than colon, as described in section
25196 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25197 item in a &%route_list%& setting for the &(manualroute)& router, as described
25198 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25199 of the &(manualroute)& router is not available here.
25200
25201 If the expansion fails, delivery is deferred. Unless the failure was caused by
25202 the inability to complete a lookup, the error is logged to the panic log as
25203 well as the main log. Host names are looked up either by searching directly for
25204 address records in the DNS or by calling &[gethostbyname()]& (or
25205 &[getipnodebyname()]& when available), depending on the setting of the
25206 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25207 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25208 address are used.
25209
25210 During delivery, the hosts are tried in order, subject to their retry status,
25211 unless &%hosts_randomize%& is set.
25212
25213
25214 .option hosts_avoid_esmtp smtp "host list&!!" unset
25215 .cindex "ESMTP, avoiding use of"
25216 .cindex "HELO" "forcing use of"
25217 .cindex "EHLO" "avoiding use of"
25218 .cindex "PIPELINING" "avoiding the use of"
25219 This option is for use with broken hosts that announce ESMTP facilities (for
25220 example, PIPELINING) and then fail to implement them properly. When a host
25221 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25222 start of the SMTP session. This means that it cannot use any of the ESMTP
25223 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25224
25225
25226 .option hosts_avoid_pipelining smtp "host list&!!" unset
25227 .cindex "PIPELINING" "avoiding the use of"
25228 .cindex "ESMTP extensions" PIPELINING
25229 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25230 that matches this list, even if the server host advertises PIPELINING support.
25231
25232 .option hosts_pipe_connect smtp "host list&!!" unset
25233 .cindex "pipelining" "early connection"
25234 .cindex "pipelining" PIPE_CONNECT
25235 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25236 this option controls which to hosts the facility watched for
25237 and recorded, and used for subsequent connections.
25238
25239 The retry hints database is used for the record,
25240 and records are subject to the &%retry_data_expire%& option.
25241 When used, the pipelining saves on roundtrip times.
25242 It also turns SMTP into a client-first protocol
25243 so combines well with TCP Fast Open.
25244
25245 See also the &%pipelining_connect_advertise_hosts%& main option.
25246
25247 Note:
25248 When the facility is used, the transport &%helo_data%& option
25249 will be expanded before the &$sending_ip_address$& variable
25250 is filled in.
25251 A check is made for the use of that variable, without the
25252 presence of a &"def:"& test on it, but suitably complex coding
25253 can avoid the check and produce unexpected results.
25254 You have been warned.
25255
25256
25257 .option hosts_avoid_tls smtp "host list&!!" unset
25258 .cindex "TLS" "avoiding for certain hosts"
25259 Exim will not try to start a TLS session when delivering to any host that
25260 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25261
25262 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25263 .cindex "TLS" "avoiding for certain hosts"
25264 Exim will not try to start a TLS session for a verify callout,
25265 or when delivering in cutthrough mode,
25266 to any host that matches this list.
25267
25268
25269 .option hosts_max_try smtp integer 5
25270 .cindex "host" "maximum number to try"
25271 .cindex "limit" "number of hosts tried"
25272 .cindex "limit" "number of MX tried"
25273 .cindex "MX record" "maximum tried"
25274 This option limits the number of IP addresses that are tried for any one
25275 delivery in cases where there are temporary delivery errors. Section
25276 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25277
25278
25279 .option hosts_max_try_hardlimit smtp integer 50
25280 This is an additional check on the maximum number of IP addresses that Exim
25281 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25282 why it exists.
25283
25284
25285
25286 .option hosts_nopass_tls smtp "host list&!!" unset
25287 .cindex "TLS" "passing connection"
25288 .cindex "multiple SMTP deliveries"
25289 .cindex "TLS" "multiple message deliveries"
25290 For any host that matches this list, a connection on which a TLS session has
25291 been started will not be passed to a new delivery process for sending another
25292 message on the same connection. See section &<<SECTmulmessam>>& for an
25293 explanation of when this might be needed.
25294
25295 .option hosts_noproxy_tls smtp "host list&!!" unset
25296 .cindex "TLS" "passing connection"
25297 .cindex "multiple SMTP deliveries"
25298 .cindex "TLS" "multiple message deliveries"
25299 For any host that matches this list, a TLS session which has
25300 been started will not be passed to a new delivery process for sending another
25301 message on the same session.
25302
25303 The traditional implementation closes down TLS and re-starts it in the new
25304 process, on the same open TCP connection, for each successive message
25305 sent.  If permitted by this option a pipe to to the new process is set up
25306 instead, and the original process maintains the TLS connection and proxies
25307 the SMTP connection from and to the new process and any subsequents.
25308 The new process has no access to TLS information, so cannot include it in
25309 logging.
25310
25311
25312
25313 .option hosts_override smtp boolean false
25314 If this option is set and the &%hosts%& option is also set, any hosts that are
25315 attached to the address are ignored, and instead the hosts specified by the
25316 &%hosts%& option are always used. This option does not apply to
25317 &%fallback_hosts%&.
25318
25319
25320 .option hosts_randomize smtp boolean false
25321 .cindex "randomized host list"
25322 .cindex "host" "list of; randomized"
25323 .cindex "fallback" "randomized hosts"
25324 If this option is set, and either the list of hosts is taken from the
25325 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25326 were not obtained from MX records (this includes fallback hosts from the
25327 router), and were not randomized by the router, the order of trying the hosts
25328 is randomized each time the transport runs. Randomizing the order of a host
25329 list can be used to do crude load sharing.
25330
25331 When &%hosts_randomize%& is true, a host list may be split into groups whose
25332 order is separately randomized. This makes it possible to set up MX-like
25333 behaviour. The boundaries between groups are indicated by an item that is just
25334 &`+`& in the host list. For example:
25335 .code
25336 hosts = host1:host2:host3:+:host4:host5
25337 .endd
25338 The order of the first three hosts and the order of the last two hosts is
25339 randomized for each use, but the first three always end up before the last two.
25340 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25341
25342 .option hosts_require_auth smtp "host list&!!" unset
25343 .cindex "authentication" "required by client"
25344 This option provides a list of servers for which authentication must succeed
25345 before Exim will try to transfer a message. If authentication fails for
25346 servers which are not in this list, Exim tries to send unauthenticated. If
25347 authentication fails for one of these servers, delivery is deferred. This
25348 temporary error is detectable in the retry rules, so it can be turned into a
25349 hard failure if required. See also &%hosts_try_auth%&, and chapter
25350 &<<CHAPSMTPAUTH>>& for details of authentication.
25351
25352
25353 .option hosts_request_ocsp smtp "host list&!!" *
25354 .cindex "TLS" "requiring for certain servers"
25355 Exim will request a Certificate Status on a
25356 TLS session for any host that matches this list.
25357 &%tls_verify_certificates%& should also be set for the transport.
25358
25359 .option hosts_require_dane smtp "host list&!!" unset
25360 .cindex DANE "transport options"
25361 .cindex DANE "requiring for certain servers"
25362 If built with DANE support, Exim  will require that a DNSSEC-validated
25363 TLSA record is present for any host matching the list,
25364 and that a DANE-verified TLS connection is made. See
25365 the &%dnssec_request_domains%& router and transport options.
25366 There will be no fallback to in-clear communication.
25367 See section &<<SECDANE>>&.
25368
25369 .option hosts_require_ocsp smtp "host list&!!" unset
25370 .cindex "TLS" "requiring for certain servers"
25371 Exim will request, and check for a valid Certificate Status being given, on a
25372 TLS session for any host that matches this list.
25373 &%tls_verify_certificates%& should also be set for the transport.
25374
25375 .option hosts_require_tls smtp "host list&!!" unset
25376 .cindex "TLS" "requiring for certain servers"
25377 Exim will insist on using a TLS session when delivering to any host that
25378 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25379 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25380 incoming messages, use an appropriate ACL.
25381
25382 .option hosts_try_auth smtp "host list&!!" unset
25383 .cindex "authentication" "optional in client"
25384 This option provides a list of servers to which, provided they announce
25385 authentication support, Exim will attempt to authenticate as a client when it
25386 connects. If authentication fails, Exim will try to transfer the message
25387 unauthenticated. See also &%hosts_require_auth%&, and chapter
25388 &<<CHAPSMTPAUTH>>& for details of authentication.
25389
25390 .option hosts_try_chunking smtp "host list&!!" *
25391 .cindex CHUNKING "enabling, in client"
25392 .cindex BDAT "SMTP command"
25393 .cindex "RFC 3030" "CHUNKING"
25394 This option provides a list of servers to which, provided they announce
25395 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25396 Unless DKIM signing is being done,
25397 BDAT will not be used in conjunction with a transport filter.
25398
25399 .option hosts_try_dane smtp "host list&!!" *
25400 .cindex DANE "transport options"
25401 .cindex DANE "attempting for certain servers"
25402 If built with DANE support, Exim  will require that a DNSSEC-validated
25403 TLSA record is present for any host matching the list,
25404 and that a DANE-verified TLS connection is made. See
25405 the &%dnssec_request_domains%& router and transport options.
25406 There will be no fallback to in-clear communication.
25407 See section &<<SECDANE>>&.
25408
25409 .option hosts_try_fastopen smtp "host list&!!" *
25410 .cindex "fast open, TCP" "enabling, in client"
25411 .cindex "TCP Fast Open" "enabling, in client"
25412 .cindex "RFC 7413" "TCP Fast Open"
25413 This option provides a list of servers to which, provided
25414 the facility is supported by this system, Exim will attempt to
25415 perform a TCP Fast Open.
25416 No data is sent on the SYN segment but, if the remote server also
25417 supports the facility, it can send its SMTP banner immediately after
25418 the SYN,ACK segment.  This can save up to one round-trip time.
25419
25420 The facility is only active for previously-contacted servers,
25421 as the initiator must present a cookie in the SYN segment.
25422
25423 On (at least some) current Linux distributions the facility must be enabled
25424 in the kernel by the sysadmin before the support is usable.
25425 There is no option for control of the server side; if the system supports
25426 it it is always enabled.  Note that lengthy operations in the connect ACL,
25427 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25428
25429 .option hosts_try_prdr smtp "host list&!!" *
25430 .cindex "PRDR" "enabling, optional in client"
25431 .cindex "ESMTP extensions" PRDR
25432 This option provides a list of servers to which, provided they announce
25433 PRDR support, Exim will attempt to negotiate PRDR
25434 for multi-recipient messages.
25435 The option can usually be left as default.
25436
25437 .option interface smtp "string list&!!" unset
25438 .cindex "bind IP address"
25439 .cindex "IP address" "binding"
25440 .vindex "&$host$&"
25441 .vindex "&$host_address$&"
25442 This option specifies which interface to bind to when making an outgoing SMTP
25443 call. The value is an IP address, not an interface name such as
25444 &`eth0`&. Do not confuse this with the interface address that was used when a
25445 message was received, which is in &$received_ip_address$&, formerly known as
25446 &$interface_address$&. The name was changed to minimize confusion with the
25447 outgoing interface address. There is no variable that contains an outgoing
25448 interface address because, unless it is set by this option, its value is
25449 unknown.
25450
25451 During the expansion of the &%interface%& option the variables &$host$& and
25452 &$host_address$& refer to the host to which a connection is about to be made
25453 during the expansion of the string. Forced expansion failure, or an empty
25454 string result causes the option to be ignored. Otherwise, after expansion, the
25455 string must be a list of IP addresses, colon-separated by default, but the
25456 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25457 For example:
25458 .code
25459 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25460 .endd
25461 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25462 connection. If none of them are the correct type, the option is ignored. If
25463 &%interface%& is not set, or is ignored, the system's IP functions choose which
25464 interface to use if the host has more than one.
25465
25466
25467 .option keepalive smtp boolean true
25468 .cindex "keepalive" "on outgoing connection"
25469 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25470 connections. When set, it causes the kernel to probe idle connections
25471 periodically, by sending packets with &"old"& sequence numbers. The other end
25472 of the connection should send a acknowledgment if the connection is still okay
25473 or a reset if the connection has been aborted. The reason for doing this is
25474 that it has the beneficial effect of freeing up certain types of connection
25475 that can get stuck when the remote host is disconnected without tidying up the
25476 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25477 unreachable hosts.
25478
25479
25480 .option lmtp_ignore_quota smtp boolean false
25481 .cindex "LMTP" "ignoring quota errors"
25482 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25483 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25484 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25485
25486 .option max_rcpt smtp integer 100
25487 .cindex "RCPT" "maximum number of outgoing"
25488 This option limits the number of RCPT commands that are sent in a single
25489 SMTP message transaction. Each set of addresses is treated independently, and
25490 so can cause parallel connections to the same host if &%remote_max_parallel%&
25491 permits this.
25492
25493
25494 .new
25495 .option message_linelength_limit smtp integer 998
25496 .cindex "line length" limit
25497 This option sets the maximum line length, in bytes, that the transport
25498 will send.  Any messages with lines exceeding the given value
25499 will fail and a failure-DSN ("bounce") message will if possible be returned
25500 to the sender.
25501 The default value is that defined by the SMTP standards.
25502
25503 It is generally wise to also check in the data ACL so that messages
25504 received via SMTP can be refused without producing a bounce.
25505 .wen
25506
25507
25508 .option multi_domain smtp boolean&!! true
25509 .vindex "&$domain$&"
25510 When this option is set, the &(smtp)& transport can handle a number of
25511 addresses containing a mixture of different domains provided they all resolve
25512 to the same list of hosts. Turning the option off restricts the transport to
25513 handling only one domain at a time. This is useful if you want to use
25514 &$domain$& in an expansion for the transport, because it is set only when there
25515 is a single domain involved in a remote delivery.
25516
25517 It is expanded per-address and can depend on any of
25518 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25519 &$host$&, &$host_address$& and &$host_port$&.
25520
25521 .option port smtp string&!! "see below"
25522 .cindex "port" "sending TCP/IP"
25523 .cindex "TCP/IP" "setting outgoing port"
25524 This option specifies the TCP/IP port on the server to which Exim connects.
25525 &*Note:*& Do not confuse this with the port that was used when a message was
25526 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25527 The name was changed to minimize confusion with the outgoing port. There is no
25528 variable that contains an outgoing port.
25529
25530 If the value of this option begins with a digit it is taken as a port number;
25531 otherwise it is looked up using &[getservbyname()]&. The default value is
25532 normally &"smtp"&,
25533 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25534 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25535 If the expansion fails, or if a port number cannot be found, delivery
25536 is deferred.
25537
25538 Note that at least one Linux distribution has been seen failing
25539 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25540
25541
25542
25543 .option protocol smtp string smtp
25544 .cindex "LMTP" "over TCP/IP"
25545 .cindex "ssmtp protocol" "outbound"
25546 .cindex "TLS" "SSL-on-connect outbound"
25547 .vindex "&$port$&"
25548 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25549 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25550 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25551 deliveries into closed message stores. Exim also has support for running LMTP
25552 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25553
25554 If this option is set to &"smtps"&, the default value for the &%port%& option
25555 changes to &"smtps"&, and the transport initiates TLS immediately after
25556 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25557 The Internet standards bodies used to strongly discourage use of this mode,
25558 but as of RFC 8314 it is perferred over STARTTLS for message submission
25559 (as distinct from MTA-MTA communication).
25560
25561
25562 .option retry_include_ip_address smtp boolean&!! true
25563 Exim normally includes both the host name and the IP address in the key it
25564 constructs for indexing retry data after a temporary delivery failure. This
25565 means that when one of several IP addresses for a host is failing, it gets
25566 tried periodically (controlled by the retry rules), but use of the other IP
25567 addresses is not affected.
25568
25569 However, in some dialup environments hosts are assigned a different IP address
25570 each time they connect. In this situation the use of the IP address as part of
25571 the retry key leads to undesirable behaviour. Setting this option false causes
25572 Exim to use only the host name.
25573 Since it is expanded it can be made to depend on the host or domain.
25574
25575
25576 .option serialize_hosts smtp "host list&!!" unset
25577 .cindex "serializing connections"
25578 .cindex "host" "serializing connections"
25579 Because Exim operates in a distributed manner, if several messages for the same
25580 host arrive at around the same time, more than one simultaneous connection to
25581 the remote host can occur. This is not usually a problem except when there is a
25582 slow link between the hosts. In that situation it may be helpful to restrict
25583 Exim to one connection at a time. This can be done by setting
25584 &%serialize_hosts%& to match the relevant hosts.
25585
25586 .cindex "hints database" "serializing deliveries to a host"
25587 Exim implements serialization by means of a hints database in which a record is
25588 written whenever a process connects to one of the restricted hosts. The record
25589 is deleted when the connection is completed. Obviously there is scope for
25590 records to get left lying around if there is a system or program crash. To
25591 guard against this, Exim ignores any records that are more than six hours old.
25592
25593 If you set up this kind of serialization, you should also arrange to delete the
25594 relevant hints database whenever your system reboots. The names of the files
25595 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25596 may be one or two files, depending on the type of DBM in use. The same files
25597 are used for ETRN serialization.
25598
25599 See also the &%max_parallel%& generic transport option.
25600
25601
25602 .option size_addition smtp integer 1024
25603 .cindex "SIZE" "ESMTP extension"
25604 .cindex "message" "size issue for transport filter"
25605 .cindex "size" "of message"
25606 .cindex "transport" "filter"
25607 .cindex "filter" "transport filter"
25608 If a remote SMTP server indicates that it supports the SIZE option of the
25609 MAIL command, Exim uses this to pass over the message size at the start of
25610 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25611 sends, to allow for headers and other text that may be added during delivery by
25612 configuration options or in a transport filter. It may be necessary to increase
25613 this if a lot of text is added to messages.
25614
25615 Alternatively, if the value of &%size_addition%& is set negative, it disables
25616 the use of the SIZE option altogether.
25617
25618
25619 .option socks_proxy smtp string&!! unset
25620 .cindex proxy SOCKS
25621 This option enables use of SOCKS proxies for connections made by the
25622 transport.  For details see section &<<SECTproxySOCKS>>&.
25623
25624
25625 .option tls_certificate smtp string&!! unset
25626 .cindex "TLS" "client certificate, location of"
25627 .cindex "certificate" "client, location of"
25628 .vindex "&$host$&"
25629 .vindex "&$host_address$&"
25630 The value of this option must be the absolute path to a file which contains the
25631 client's certificate, for possible use when sending a message over an encrypted
25632 connection. The values of &$host$& and &$host_address$& are set to the name and
25633 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25634 details of TLS.
25635
25636 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25637 certificate when sending messages as a client. The global option of the same
25638 name specifies the certificate for Exim as a server; it is not automatically
25639 assumed that the same certificate should be used when Exim is operating as a
25640 client.
25641
25642
25643 .option tls_crl smtp string&!! unset
25644 .cindex "TLS" "client certificate revocation list"
25645 .cindex "certificate" "revocation list for client"
25646 This option specifies a certificate revocation list. The expanded value must
25647 be the name of a file that contains a CRL in PEM format.
25648
25649
25650 .option tls_dh_min_bits smtp integer 1024
25651 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25652 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25653 key agreement is negotiated, the server will provide a large prime number
25654 for use.  This option establishes the minimum acceptable size of that number.
25655 If the parameter offered by the server is too small, then the TLS handshake
25656 will fail.
25657
25658 Only supported when using GnuTLS.
25659
25660
25661 .option tls_privatekey smtp string&!! unset
25662 .cindex "TLS" "client private key, location of"
25663 .vindex "&$host$&"
25664 .vindex "&$host_address$&"
25665 The value of this option must be the absolute path to a file which contains the
25666 client's private key. This is used when sending a message over an encrypted
25667 connection using a client certificate. The values of &$host$& and
25668 &$host_address$& are set to the name and address of the server during the
25669 expansion. If this option is unset, or the expansion is forced to fail, or the
25670 result is an empty string, the private key is assumed to be in the same file as
25671 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25672
25673
25674 .option tls_require_ciphers smtp string&!! unset
25675 .cindex "TLS" "requiring specific ciphers"
25676 .cindex "cipher" "requiring specific"
25677 .vindex "&$host$&"
25678 .vindex "&$host_address$&"
25679 The value of this option must be a list of permitted cipher suites, for use
25680 when setting up an outgoing encrypted connection. (There is a global option of
25681 the same name for controlling incoming connections.) The values of &$host$& and
25682 &$host_address$& are set to the name and address of the server during the
25683 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25684 is used in different ways by OpenSSL and GnuTLS (see sections
25685 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25686 ciphers is a preference order.
25687
25688
25689 .new
25690 .option tls_resumption_hosts smtp "host list&!!" unset
25691 .cindex TLS resumption
25692 This option controls which connections to use the TLS resumption feature.
25693 See &<<SECTresumption>>& for details.
25694 .wen
25695
25696
25697
25698 .option tls_sni smtp string&!! unset
25699 .cindex "TLS" "Server Name Indication"
25700 .vindex "&$tls_sni$&"
25701 If this option is set then it sets the $tls_out_sni variable and causes any
25702 TLS session to pass this value as the Server Name Indication extension to
25703 the remote side, which can be used by the remote side to select an appropriate
25704 certificate and private key for the session.
25705
25706 See &<<SECTtlssni>>& for more information.
25707
25708 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25709 TLS extensions.
25710
25711
25712
25713
25714 .option tls_tempfail_tryclear smtp boolean true
25715 .cindex "4&'xx'& responses" "to STARTTLS"
25716 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25717 setting up a TLS session, this option determines whether or not Exim should try
25718 to deliver the message unencrypted. If it is set false, delivery to the
25719 current host is deferred; if there are other hosts, they are tried. If this
25720 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25721 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25722 TLS negotiation fails, Exim closes the current connection (because it is in an
25723 unknown state), opens a new one to the same host, and then tries the delivery
25724 in clear.
25725
25726
25727 .option tls_try_verify_hosts smtp "host list&!!" *
25728 .cindex "TLS" "server certificate verification"
25729 .cindex "certificate" "verification of server"
25730 This option gives a list of hosts for which, on encrypted connections,
25731 certificate verification will be tried but need not succeed.
25732 The &%tls_verify_certificates%& option must also be set.
25733 Note that unless the host is in this list
25734 TLS connections will be denied to hosts using self-signed certificates
25735 when &%tls_verify_certificates%& is matched.
25736 The &$tls_out_certificate_verified$& variable is set when
25737 certificate verification succeeds.
25738
25739
25740 .option tls_verify_cert_hostnames smtp "host list&!!" *
25741 .cindex "TLS" "server certificate hostname verification"
25742 .cindex "certificate" "verification of server"
25743 This option give a list of hosts for which,
25744 while verifying the server certificate,
25745 checks will be included on the host name
25746 (note that this will generally be the result of a DNS MX lookup)
25747 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25748 limited to being the initial component of a 3-or-more component FQDN.
25749
25750 There is no equivalent checking on client certificates.
25751
25752
25753 .option tls_verify_certificates smtp string&!! system
25754 .cindex "TLS" "server certificate verification"
25755 .cindex "certificate" "verification of server"
25756 .vindex "&$host$&"
25757 .vindex "&$host_address$&"
25758 The value of this option must be either the
25759 word "system"
25760 or the absolute path to
25761 a file or directory containing permitted certificates for servers,
25762 for use when setting up an encrypted connection.
25763
25764 The "system" value for the option will use a location compiled into the SSL library.
25765 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25766 is taken as empty and an explicit location
25767 must be specified.
25768
25769 The use of a directory for the option value is not available for GnuTLS versions
25770 preceding 3.3.6 and a single file must be used.
25771
25772 With OpenSSL the certificates specified
25773 explicitly
25774 either by file or directory
25775 are added to those given by the system default location.
25776
25777 The values of &$host$& and
25778 &$host_address$& are set to the name and address of the server during the
25779 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25780
25781 For back-compatibility,
25782 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25783 (a single-colon empty list counts as being set)
25784 and certificate verification fails the TLS connection is closed.
25785
25786
25787 .option tls_verify_hosts smtp "host list&!!" unset
25788 .cindex "TLS" "server certificate verification"
25789 .cindex "certificate" "verification of server"
25790 This option gives a list of hosts for which, on encrypted connections,
25791 certificate verification must succeed.
25792 The &%tls_verify_certificates%& option must also be set.
25793 If both this option and &%tls_try_verify_hosts%& are unset
25794 operation is as if this option selected all hosts.
25795
25796 .option utf8_downconvert smtp integer&!! -1
25797 .cindex utf8 "address downconversion"
25798 .cindex i18n "utf8 address downconversion"
25799 If built with internationalization support,
25800 this option controls conversion of UTF-8 in message envelope addresses
25801 to a-label form.
25802 If, after expansion, the value is 1, 0, or -1 then this value overrides
25803 any value previously set for the message.  Otherwise, any previously
25804 set value is used.  To permit use of a previous value,
25805 set this option to an empty string.
25806 For details on the values see section &<<SECTi18nMTA>>&.
25807
25808
25809
25810
25811 .section "How the limits for the number of hosts to try are used" &&&
25812          "SECTvalhosmax"
25813 .cindex "host" "maximum number to try"
25814 .cindex "limit" "hosts; maximum number tried"
25815 There are two options that are concerned with the number of hosts that are
25816 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25817 &%hosts_max_try_hardlimit%&.
25818
25819
25820 The &%hosts_max_try%& option limits the number of hosts that are tried
25821 for a single delivery. However, despite the term &"host"& in its name, the
25822 option actually applies to each IP address independently. In other words, a
25823 multihomed host is treated as several independent hosts, just as it is for
25824 retrying.
25825
25826 Many of the larger ISPs have multiple MX records which often point to
25827 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25828 created as a result of routing one of these domains.
25829
25830 Trying every single IP address on such a long list does not seem sensible; if
25831 several at the top of the list fail, it is reasonable to assume there is some
25832 problem that is likely to affect all of them. Roughly speaking, the value of
25833 &%hosts_max_try%& is the maximum number that are tried before deferring the
25834 delivery. However, the logic cannot be quite that simple.
25835
25836 Firstly, IP addresses that are skipped because their retry times have not
25837 arrived do not count, and in addition, addresses that are past their retry
25838 limits are also not counted, even when they are tried. This means that when
25839 some IP addresses are past their retry limits, more than the value of
25840 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25841 that all IP addresses are considered before timing out an email address (but
25842 see below for an exception).
25843
25844 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25845 list to see if there is a subsequent host with a different (higher valued) MX.
25846 If there is, that host is considered next, and the current IP address is used
25847 but not counted. This behaviour helps in the case of a domain with a retry rule
25848 that hardly ever delays any hosts, as is now explained:
25849
25850 Consider the case of a long list of hosts with one MX value, and a few with a
25851 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25852 hosts at the top of the list are tried at first. With the default retry rule,
25853 which specifies increasing retry times, the higher MX hosts are eventually
25854 tried when those at the top of the list are skipped because they have not
25855 reached their retry times.
25856
25857 However, it is common practice to put a fixed short retry time on domains for
25858 large ISPs, on the grounds that their servers are rarely down for very long.
25859 Unfortunately, these are exactly the domains that tend to resolve to long lists
25860 of hosts. The short retry time means that the lowest MX hosts are tried every
25861 time. The attempts may be in a different order because of random sorting, but
25862 without the special MX check, the higher MX hosts would never be tried until
25863 all the lower MX hosts had timed out (which might be several days), because
25864 there are always some lower MX hosts that have reached their retry times. With
25865 the special check, Exim considers at least one IP address from each MX value at
25866 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25867 reached.
25868
25869 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25870 particular, Exim normally eventually tries all the IP addresses before timing
25871 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25872 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25873 been set up with hundreds of IP addresses for some domains. It can
25874 take a very long time indeed for an address to time out in these cases.
25875
25876 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25877 Exim never tries more than this number of IP addresses; if it hits this limit
25878 and they are all timed out, the email address is bounced, even though not all
25879 possible IP addresses have been tried.
25880 .ecindex IIDsmttra1
25881 .ecindex IIDsmttra2
25882
25883
25884
25885
25886
25887 . ////////////////////////////////////////////////////////////////////////////
25888 . ////////////////////////////////////////////////////////////////////////////
25889
25890 .chapter "Address rewriting" "CHAPrewrite"
25891 .scindex IIDaddrew "rewriting" "addresses"
25892 There are some circumstances in which Exim automatically rewrites domains in
25893 addresses. The two most common are when an address is given without a domain
25894 (referred to as an &"unqualified address"&) or when an address contains an
25895 abbreviated domain that is expanded by DNS lookup.
25896
25897 Unqualified envelope addresses are accepted only for locally submitted
25898 messages, or for messages that are received from hosts matching
25899 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25900 appropriate. Unqualified addresses in header lines are qualified if they are in
25901 locally submitted messages, or messages from hosts that are permitted to send
25902 unqualified envelope addresses. Otherwise, unqualified addresses in header
25903 lines are neither qualified nor rewritten.
25904
25905 One situation in which Exim does &'not'& automatically rewrite a domain is
25906 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25907 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25908 do this. The new RFCs do not contain this suggestion.
25909
25910
25911 .section "Explicitly configured address rewriting" "SECID147"
25912 This chapter describes the rewriting rules that can be used in the
25913 main rewrite section of the configuration file, and also in the generic
25914 &%headers_rewrite%& option that can be set on any transport.
25915
25916 Some people believe that configured address rewriting is a Mortal Sin.
25917 Others believe that life is not possible without it. Exim provides the
25918 facility; you do not have to use it.
25919
25920 The main rewriting rules that appear in the &"rewrite"& section of the
25921 configuration file are applied to addresses in incoming messages, both envelope
25922 addresses and addresses in header lines. Each rule specifies the types of
25923 address to which it applies.
25924
25925 Whether or not addresses in header lines are rewritten depends on the origin of
25926 the headers and the type of rewriting. Global rewriting, that is, rewriting
25927 rules from the rewrite section of the configuration file, is applied only to
25928 those headers that were received with the message. Header lines that are added
25929 by ACLs or by a system filter or by individual routers or transports (which
25930 are specific to individual recipient addresses) are not rewritten by the global
25931 rules.
25932
25933 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25934 applies all headers except those added by routers and transports. That is, as
25935 well as the headers that were received with the message, it also applies to
25936 headers that were added by an ACL or a system filter.
25937
25938
25939 In general, rewriting addresses from your own system or domain has some
25940 legitimacy. Rewriting other addresses should be done only with great care and
25941 in special circumstances. The author of Exim believes that rewriting should be
25942 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25943 Although it can sometimes be used as a routing tool, this is very strongly
25944 discouraged.
25945
25946 There are two commonly encountered circumstances where rewriting is used, as
25947 illustrated by these examples:
25948
25949 .ilist
25950 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25951 exchange mail with each other behind a firewall, but there is only a single
25952 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25953 &'hitch.fict.example'& when sending mail off-site.
25954 .next
25955 A host rewrites the local parts of its own users so that, for example,
25956 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25957 .endlist
25958
25959
25960
25961 .section "When does rewriting happen?" "SECID148"
25962 .cindex "rewriting" "timing of"
25963 .cindex "&ACL;" "rewriting addresses in"
25964 Configured address rewriting can take place at several different stages of a
25965 message's processing.
25966
25967 .vindex "&$sender_address$&"
25968 At the start of an ACL for MAIL, the sender address may have been rewritten
25969 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25970 ordinary rewrite rules have yet been applied. If, however, the sender address
25971 is verified in the ACL, it is rewritten before verification, and remains
25972 rewritten thereafter. The subsequent value of &$sender_address$& is the
25973 rewritten address. This also applies if sender verification happens in a
25974 RCPT ACL. Otherwise, when the sender address is not verified, it is
25975 rewritten as soon as a message's header lines have been received.
25976
25977 .vindex "&$domain$&"
25978 .vindex "&$local_part$&"
25979 Similarly, at the start of an ACL for RCPT, the current recipient's address
25980 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25981 rewrite rules have yet been applied to it. However, the behaviour is different
25982 from the sender address when a recipient is verified. The address is rewritten
25983 for the verification, but the rewriting is not remembered at this stage. The
25984 value of &$local_part$& and &$domain$& after verification are always the same
25985 as they were before (that is, they contain the unrewritten &-- except for
25986 SMTP-time rewriting &-- address).
25987
25988 As soon as a message's header lines have been received, all the envelope
25989 recipient addresses are permanently rewritten, and rewriting is also applied to
25990 the addresses in the header lines (if configured). This happens before adding
25991 any header lines that were specified in MAIL or RCPT ACLs, and
25992 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25993 before the DATA ACL and &[local_scan()]& functions are run.
25994
25995 When an address is being routed, either for delivery or for verification,
25996 rewriting is applied immediately to child addresses that are generated by
25997 redirection, unless &%no_rewrite%& is set on the router.
25998
25999 .cindex "envelope from"
26000 .cindex "envelope sender" "rewriting at transport time"
26001 .cindex "rewriting" "at transport time"
26002 .cindex "header lines" "rewriting at transport time"
26003 At transport time, additional rewriting of addresses in header lines can be
26004 specified by setting the generic &%headers_rewrite%& option on a transport.
26005 This option contains rules that are identical in form to those in the rewrite
26006 section of the configuration file. They are applied to the original message
26007 header lines and any that were added by ACLs or a system filter. They are not
26008 applied to header lines that are added by routers or the transport.
26009
26010 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26011 transport option. However, it is not possible to rewrite envelope recipients at
26012 transport time.
26013
26014
26015
26016
26017 .section "Testing the rewriting rules that apply on input" "SECID149"
26018 .cindex "rewriting" "testing"
26019 .cindex "testing" "rewriting"
26020 Exim's input rewriting configuration appears in a part of the runtime
26021 configuration file headed by &"begin rewrite"&. It can be tested by the
26022 &%-brw%& command line option. This takes an address (which can be a full RFC
26023 2822 address) as its argument. The output is a list of how the address would be
26024 transformed by the rewriting rules for each of the different places it might
26025 appear in an incoming message, that is, for each different header and for the
26026 envelope sender and recipient fields. For example,
26027 .code
26028 exim -brw ph10@exim.workshop.example
26029 .endd
26030 might produce the output
26031 .code
26032 sender: Philip.Hazel@exim.workshop.example
26033 from: Philip.Hazel@exim.workshop.example
26034 to: ph10@exim.workshop.example
26035 cc: ph10@exim.workshop.example
26036 bcc: ph10@exim.workshop.example
26037 reply-to: Philip.Hazel@exim.workshop.example
26038 env-from: Philip.Hazel@exim.workshop.example
26039 env-to: ph10@exim.workshop.example
26040 .endd
26041 which shows that rewriting has been set up for that address when used in any of
26042 the source fields, but not when it appears as a recipient address. At the
26043 present time, there is no equivalent way of testing rewriting rules that are
26044 set for a particular transport.
26045
26046
26047 .section "Rewriting rules" "SECID150"
26048 .cindex "rewriting" "rules"
26049 The rewrite section of the configuration file consists of lines of rewriting
26050 rules in the form
26051 .display
26052 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26053 .endd
26054 Rewriting rules that are specified for the &%headers_rewrite%& generic
26055 transport option are given as a colon-separated list. Each item in the list
26056 takes the same form as a line in the main rewriting configuration (except that
26057 any colons must be doubled, of course).
26058
26059 The formats of source patterns and replacement strings are described below.
26060 Each is terminated by white space, unless enclosed in double quotes, in which
26061 case normal quoting conventions apply inside the quotes. The flags are single
26062 characters which may appear in any order. Spaces and tabs between them are
26063 ignored.
26064
26065 For each address that could potentially be rewritten, the rules are scanned in
26066 order, and replacements for the address from earlier rules can themselves be
26067 replaced by later rules (but see the &"q"& and &"R"& flags).
26068
26069 The order in which addresses are rewritten is undefined, may change between
26070 releases, and must not be relied on, with one exception: when a message is
26071 received, the envelope sender is always rewritten first, before any header
26072 lines are rewritten. For example, the replacement string for a rewrite of an
26073 address in &'To:'& must not assume that the message's address in &'From:'& has
26074 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26075 that the envelope sender has already been rewritten.
26076
26077 .vindex "&$domain$&"
26078 .vindex "&$local_part$&"
26079 The variables &$local_part$& and &$domain$& can be used in the replacement
26080 string to refer to the address that is being rewritten. Note that lookup-driven
26081 rewriting can be done by a rule of the form
26082 .code
26083 *@*   ${lookup ...
26084 .endd
26085 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26086 refer to the address that is being rewritten.
26087
26088
26089 .section "Rewriting patterns" "SECID151"
26090 .cindex "rewriting" "patterns"
26091 .cindex "address list" "in a rewriting pattern"
26092 The source pattern in a rewriting rule is any item which may appear in an
26093 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26094 single-item address list, which means that it is expanded before being tested
26095 against the address. As always, if you use a regular expression as a pattern,
26096 you must take care to escape dollar and backslash characters, or use the &`\N`&
26097 facility to suppress string expansion within the regular expression.
26098
26099 Domains in patterns should be given in lower case. Local parts in patterns are
26100 case-sensitive. If you want to do case-insensitive matching of local parts, you
26101 can use a regular expression that starts with &`^(?i)`&.
26102
26103 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26104 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26105 depending on the type of match which occurred. These can be used in the
26106 replacement string to insert portions of the incoming address. &$0$& always
26107 refers to the complete incoming address. When a regular expression is used, the
26108 numerical variables are set from its capturing subexpressions. For other types
26109 of pattern they are set as follows:
26110
26111 .ilist
26112 If a local part or domain starts with an asterisk, the numerical variables
26113 refer to the character strings matched by asterisks, with &$1$& associated with
26114 the first asterisk, and &$2$& with the second, if present. For example, if the
26115 pattern
26116 .code
26117 *queen@*.fict.example
26118 .endd
26119 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26120 .code
26121 $0 = hearts-queen@wonderland.fict.example
26122 $1 = hearts-
26123 $2 = wonderland
26124 .endd
26125 Note that if the local part does not start with an asterisk, but the domain
26126 does, it is &$1$& that contains the wild part of the domain.
26127
26128 .next
26129 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26130 of the domain are placed in the next available numerical variables. Suppose,
26131 for example, that the address &'foo@bar.baz.example'& is processed by a
26132 rewriting rule of the form
26133 .display
26134 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26135 .endd
26136 and the key in the file that matches the domain is &`*.baz.example`&. Then
26137 .code
26138 $1 = foo
26139 $2 = bar
26140 $3 = baz.example
26141 .endd
26142 If the address &'foo@baz.example'& is looked up, this matches the same
26143 wildcard file entry, and in this case &$2$& is set to the empty string, but
26144 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26145 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26146 whole domain. For non-partial domain lookups, no numerical variables are set.
26147 .endlist
26148
26149
26150 .section "Rewriting replacements" "SECID152"
26151 .cindex "rewriting" "replacements"
26152 If the replacement string for a rule is a single asterisk, addresses that
26153 match the pattern and the flags are &'not'& rewritten, and no subsequent
26154 rewriting rules are scanned. For example,
26155 .code
26156 hatta@lookingglass.fict.example  *  f
26157 .endd
26158 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26159 &'From:'& headers.
26160
26161 .vindex "&$domain$&"
26162 .vindex "&$local_part$&"
26163 If the replacement string is not a single asterisk, it is expanded, and must
26164 yield a fully qualified address. Within the expansion, the variables
26165 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26166 Any letters they contain retain their original case &-- they are not lower
26167 cased. The numerical variables are set up according to the type of pattern that
26168 matched the address, as described above. If the expansion is forced to fail by
26169 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26170 current rule is abandoned, but subsequent rules may take effect. Any other
26171 expansion failure causes the entire rewriting operation to be abandoned, and an
26172 entry written to the panic log.
26173
26174
26175
26176 .section "Rewriting flags" "SECID153"
26177 There are three different kinds of flag that may appear on rewriting rules:
26178
26179 .ilist
26180 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26181 c, f, h, r, s, t.
26182 .next
26183 A flag that specifies rewriting at SMTP time: S.
26184 .next
26185 Flags that control the rewriting process: Q, q, R, w.
26186 .endlist
26187
26188 For rules that are part of the &%headers_rewrite%& generic transport option,
26189 E, F, T, and S are not permitted.
26190
26191
26192
26193 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26194          "SECID154"
26195 .cindex "rewriting" "flags"
26196 If none of the following flag letters, nor the &"S"& flag (see section
26197 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26198 and to both the sender and recipient fields of the envelope, whereas a
26199 transport-time rewriting rule just applies to all headers. Otherwise, the
26200 rewriting rule is skipped unless the relevant addresses are being processed.
26201 .display
26202 &`E`&       rewrite all envelope fields
26203 &`F`&       rewrite the envelope From field
26204 &`T`&       rewrite the envelope To field
26205 &`b`&       rewrite the &'Bcc:'& header
26206 &`c`&       rewrite the &'Cc:'& header
26207 &`f`&       rewrite the &'From:'& header
26208 &`h`&       rewrite all headers
26209 &`r`&       rewrite the &'Reply-To:'& header
26210 &`s`&       rewrite the &'Sender:'& header
26211 &`t`&       rewrite the &'To:'& header
26212 .endd
26213 "All headers" means all of the headers listed above that can be selected
26214 individually, plus their &'Resent-'& versions. It does not include
26215 other headers such as &'Subject:'& etc.
26216
26217 You should be particularly careful about rewriting &'Sender:'& headers, and
26218 restrict this to special known cases in your own domains.
26219
26220
26221 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26222 .cindex "SMTP" "rewriting malformed addresses"
26223 .cindex "RCPT" "rewriting argument of"
26224 .cindex "MAIL" "rewriting argument of"
26225 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26226 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26227 before any other processing; even before syntax checking. The pattern is
26228 required to be a regular expression, and it is matched against the whole of the
26229 data for the command, including any surrounding angle brackets.
26230
26231 .vindex "&$domain$&"
26232 .vindex "&$local_part$&"
26233 This form of rewrite rule allows for the handling of addresses that are not
26234 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26235 input). Because the input is not required to be a syntactically valid address,
26236 the variables &$local_part$& and &$domain$& are not available during the
26237 expansion of the replacement string. The result of rewriting replaces the
26238 original address in the MAIL or RCPT command.
26239
26240
26241 .section "Flags controlling the rewriting process" "SECID155"
26242 There are four flags which control the way the rewriting process works. These
26243 take effect only when a rule is invoked, that is, when the address is of the
26244 correct type (matches the flags) and matches the pattern:
26245
26246 .ilist
26247 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26248 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26249 absence of &"Q"& the rewritten address must always include a domain.
26250 .next
26251 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26252 even if no rewriting actually takes place because of a &"fail"& in the
26253 expansion. The &"q"& flag is not effective if the address is of the wrong type
26254 (does not match the flags) or does not match the pattern.
26255 .next
26256 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26257 address, up to ten times. It can be combined with the &"q"& flag, to stop
26258 rewriting once it fails to match (after at least one successful rewrite).
26259 .next
26260 .cindex "rewriting" "whole addresses"
26261 When an address in a header is rewritten, the rewriting normally applies only
26262 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26263 left unchanged. For example, rewriting might change
26264 .code
26265 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26266 .endd
26267 into
26268 .code
26269 From: Ford Prefect <prefectf@hitch.fict.example>
26270 .endd
26271 .cindex "RFC 2047"
26272 Sometimes there is a need to replace the whole address item, and this can be
26273 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26274 causes an address in a header line to be rewritten, the entire address is
26275 replaced, not just the working part. The replacement must be a complete RFC
26276 2822 address, including the angle brackets if necessary. If text outside angle
26277 brackets contains a character whose value is greater than 126 or less than 32
26278 (except for tab), the text is encoded according to RFC 2047. The character set
26279 is taken from &%headers_charset%&, which gets its default at build time.
26280
26281 When the &"w"& flag is set on a rule that causes an envelope address to be
26282 rewritten, all but the working part of the replacement address is discarded.
26283 .endlist
26284
26285
26286 .section "Rewriting examples" "SECID156"
26287 Here is an example of the two common rewriting paradigms:
26288 .code
26289 *@*.hitch.fict.example  $1@hitch.fict.example
26290 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26291                      {$value}fail}@hitch.fict.example bctfrF
26292 .endd
26293 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26294 the string expansion to fail if the lookup does not succeed. In this context it
26295 has the effect of leaving the original address unchanged, but Exim goes on to
26296 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26297 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26298 explicitly, which would cause the rewritten address to be the same as before,
26299 at the cost of a small bit of processing. Not supplying either of these is an
26300 error, since the rewritten address would then contain no local part.
26301
26302 The first example above replaces the domain with a superior, more general
26303 domain. This may not be desirable for certain local parts. If the rule
26304 .code
26305 root@*.hitch.fict.example  *
26306 .endd
26307 were inserted before the first rule, rewriting would be suppressed for the
26308 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26309
26310 Rewriting can be made conditional on a number of tests, by making use of
26311 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26312 messages that originate outside the local host:
26313 .code
26314 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26315                          {$1@hitch.fict.example}fail}"
26316 .endd
26317 The replacement string is quoted in this example because it contains white
26318 space.
26319
26320 .cindex "rewriting" "bang paths"
26321 .cindex "bang paths" "rewriting"
26322 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26323 an address it treats it as an unqualified local part which it qualifies with
26324 the local qualification domain (if the source of the message is local or if the
26325 remote host is permitted to send unqualified addresses). Rewriting can
26326 sometimes be used to handle simple bang paths with a fixed number of
26327 components. For example, the rule
26328 .code
26329 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26330 .endd
26331 rewrites a two-component bang path &'host.name!user'& as the domain address
26332 &'user@host.name'&. However, there is a security implication in using this as
26333 a global rewriting rule for envelope addresses. It can provide a backdoor
26334 method for using your system as a relay, because the incoming addresses appear
26335 to be local. If the bang path addresses are received via SMTP, it is safer to
26336 use the &"S"& flag to rewrite them as they are received, so that relay checking
26337 can be done on the rewritten addresses.
26338 .ecindex IIDaddrew
26339
26340
26341
26342
26343
26344 . ////////////////////////////////////////////////////////////////////////////
26345 . ////////////////////////////////////////////////////////////////////////////
26346
26347 .chapter "Retry configuration" "CHAPretry"
26348 .scindex IIDretconf1 "retry" "configuration, description of"
26349 .scindex IIDregconf2 "configuration file" "retry section"
26350 The &"retry"& section of the runtime configuration file contains a list of
26351 retry rules that control how often Exim tries to deliver messages that cannot
26352 be delivered at the first attempt. If there are no retry rules (the section is
26353 empty or not present), there are no retries. In this situation, temporary
26354 errors are treated as permanent. The default configuration contains a single,
26355 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26356 line option can be used to test which retry rule will be used for a given
26357 address, domain and error.
26358
26359 The most common cause of retries is temporary failure to deliver to a remote
26360 host because the host is down, or inaccessible because of a network problem.
26361 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26362 address) basis, not on a per-message basis. Thus, if one message has recently
26363 been delayed, delivery of a new message to the same host is not immediately
26364 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26365 log selector is set, the message
26366 .cindex "retry" "time not reached"
26367 &"retry time not reached"& is written to the main log whenever a delivery is
26368 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26369 the handling of errors during remote deliveries.
26370
26371 Retry processing applies to routing as well as to delivering, except as covered
26372 in the next paragraph. The retry rules do not distinguish between these
26373 actions. It is not possible, for example, to specify different behaviour for
26374 failures to route the domain &'snark.fict.example'& and failures to deliver to
26375 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26376 added complication, so did not implement it. However, although they share the
26377 same retry rule, the actual retry times for routing and transporting a given
26378 domain are maintained independently.
26379
26380 When a delivery is not part of a queue run (typically an immediate delivery on
26381 receipt of a message), the routers are always run, and local deliveries are
26382 always attempted, even if retry times are set for them. This makes for better
26383 behaviour if one particular message is causing problems (for example, causing
26384 quota overflow, or provoking an error in a filter file). If such a delivery
26385 suffers a temporary failure, the retry data is updated as normal, and
26386 subsequent delivery attempts from queue runs occur only when the retry time for
26387 the local address is reached.
26388
26389 .section "Changing retry rules" "SECID157"
26390 If you change the retry rules in your configuration, you should consider
26391 whether or not to delete the retry data that is stored in Exim's spool area in
26392 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26393 always safe; that is why they are called &"hints"&.
26394
26395 The hints retry data contains suggested retry times based on the previous
26396 rules. In the case of a long-running problem with a remote host, it might
26397 record the fact that the host has timed out. If your new rules increase the
26398 timeout time for such a host, you should definitely remove the old retry data
26399 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26400 messages that it should now be retaining.
26401
26402
26403
26404 .section "Format of retry rules" "SECID158"
26405 .cindex "retry" "rules"
26406 Each retry rule occupies one line and consists of three or four parts,
26407 separated by white space: a pattern, an error name, an optional list of sender
26408 addresses, and a list of retry parameters. The pattern and sender lists must be
26409 enclosed in double quotes if they contain white space. The rules are searched
26410 in order until one is found where the pattern, error name, and sender list (if
26411 present) match the failing host or address, the error that occurred, and the
26412 message's sender, respectively.
26413
26414
26415 The pattern is any single item that may appear in an address list (see section
26416 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26417 which means that it is expanded before being tested against the address that
26418 has been delayed. A negated address list item is permitted. Address
26419 list processing treats a plain domain name as if it were preceded by &"*@"&,
26420 which makes it possible for many retry rules to start with just a domain. For
26421 example,
26422 .code
26423 lookingglass.fict.example        *  F,24h,30m;
26424 .endd
26425 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26426 whereas
26427 .code
26428 alice@lookingglass.fict.example  *  F,24h,30m;
26429 .endd
26430 applies only to temporary failures involving the local part &%alice%&.
26431 In practice, almost all rules start with a domain name pattern without a local
26432 part.
26433
26434 .cindex "regular expressions" "in retry rules"
26435 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26436 must match a complete address, not just a domain, because that is how regular
26437 expressions work in address lists.
26438 .display
26439 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26440 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26441 .endd
26442
26443
26444 .section "Choosing which retry rule to use for address errors" "SECID159"
26445 When Exim is looking for a retry rule after a routing attempt has failed (for
26446 example, after a DNS timeout), each line in the retry configuration is tested
26447 against the complete address only if &%retry_use_local_part%& is set for the
26448 router. Otherwise, only the domain is used, except when matching against a
26449 regular expression, when the local part of the address is replaced with &"*"&.
26450 A domain on its own can match a domain pattern, or a pattern that starts with
26451 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26452 &%check_local_user%& is true, and false for other routers.
26453
26454 Similarly, when Exim is looking for a retry rule after a local delivery has
26455 failed (for example, after a mailbox full error), each line in the retry
26456 configuration is tested against the complete address only if
26457 &%retry_use_local_part%& is set for the transport (it defaults true for all
26458 local transports).
26459
26460 .cindex "4&'xx'& responses" "retry rules for"
26461 However, when Exim is looking for a retry rule after a remote delivery attempt
26462 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26463 whole address is always used as the key when searching the retry rules. The
26464 rule that is found is used to create a retry time for the combination of the
26465 failing address and the message's sender. It is the combination of sender and
26466 recipient that is delayed in subsequent queue runs until its retry time is
26467 reached. You can delay the recipient without regard to the sender by setting
26468 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26469 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26470 commands.
26471
26472
26473
26474 .section "Choosing which retry rule to use for host and message errors" &&&
26475          "SECID160"
26476 For a temporary error that is not related to an individual address (for
26477 example, a connection timeout), each line in the retry configuration is checked
26478 twice. First, the name of the remote host is used as a domain name (preceded by
26479 &"*@"& when matching a regular expression). If this does not match the line,
26480 the domain from the email address is tried in a similar fashion. For example,
26481 suppose the MX records for &'a.b.c.example'& are
26482 .code
26483 a.b.c.example  MX  5  x.y.z.example
26484                MX  6  p.q.r.example
26485                MX  7  m.n.o.example
26486 .endd
26487 and the retry rules are
26488 .code
26489 p.q.r.example    *      F,24h,30m;
26490 a.b.c.example    *      F,4d,45m;
26491 .endd
26492 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26493 first rule matches neither the host nor the domain, so Exim looks at the second
26494 rule. This does not match the host, but it does match the domain, so it is used
26495 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26496 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26497 first retry rule is used, because it matches the host.
26498
26499 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26500 first rule to determine retry times, but for all the other hosts for the domain
26501 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26502 routing to &'a.b.c.example'& suffers a temporary failure.
26503
26504 &*Note*&: The host name is used when matching the patterns, not its IP address.
26505 However, if a message is routed directly to an IP address without the use of a
26506 host name, for example, if a &(manualroute)& router contains a setting such as:
26507 .code
26508 route_list = *.a.example  192.168.34.23
26509 .endd
26510 then the &"host name"& that is used when searching for a retry rule is the
26511 textual form of the IP address.
26512
26513 .section "Retry rules for specific errors" "SECID161"
26514 .cindex "retry" "specific errors; specifying"
26515 The second field in a retry rule is the name of a particular error, or an
26516 asterisk, which matches any error. The errors that can be tested for are:
26517
26518 .vlist
26519 .vitem &%auth_failed%&
26520 Authentication failed when trying to send to a host in the
26521 &%hosts_require_auth%& list in an &(smtp)& transport.
26522
26523 .vitem &%data_4xx%&
26524 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26525 after the command, or after sending the message's data.
26526
26527 .vitem &%mail_4xx%&
26528 A 4&'xx'& error was received for an outgoing MAIL command.
26529
26530 .vitem &%rcpt_4xx%&
26531 A 4&'xx'& error was received for an outgoing RCPT command.
26532 .endlist
26533
26534 For the three 4&'xx'& errors, either the first or both of the x's can be given
26535 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26536 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26537 and have retries every ten minutes with a one-hour timeout, you could set up a
26538 retry rule of this form:
26539 .code
26540 the.domain.name  rcpt_452   F,1h,10m
26541 .endd
26542 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26543 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26544
26545 .vlist
26546 .vitem &%lost_connection%&
26547 A server unexpectedly closed the SMTP connection. There may, of course,
26548 legitimate reasons for this (host died, network died), but if it repeats a lot
26549 for the same host, it indicates something odd.
26550
26551 .vitem &%lookup%&
26552 A DNS lookup for a host failed.
26553 Note that a &%dnslookup%& router will need to have matched
26554 its &%fail_defer_domains%& option for this retry type to be usable.
26555 Also note that a &%manualroute%& router will probably need
26556 its &%host_find_failed%& option set to &%defer%&.
26557
26558 .vitem &%refused_MX%&
26559 A connection to a host obtained from an MX record was refused.
26560
26561 .vitem &%refused_A%&
26562 A connection to a host not obtained from an MX record was refused.
26563
26564 .vitem &%refused%&
26565 A connection was refused.
26566
26567 .vitem &%timeout_connect_MX%&
26568 A connection attempt to a host obtained from an MX record timed out.
26569
26570 .vitem &%timeout_connect_A%&
26571 A connection attempt to a host not obtained from an MX record timed out.
26572
26573 .vitem &%timeout_connect%&
26574 A connection attempt timed out.
26575
26576 .vitem &%timeout_MX%&
26577 There was a timeout while connecting or during an SMTP session with a host
26578 obtained from an MX record.
26579
26580 .vitem &%timeout_A%&
26581 There was a timeout while connecting or during an SMTP session with a host not
26582 obtained from an MX record.
26583
26584 .vitem &%timeout%&
26585 There was a timeout while connecting or during an SMTP session.
26586
26587 .vitem &%tls_required%&
26588 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26589 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26590 to STARTTLS, or there was a problem setting up the TLS connection.
26591
26592 .vitem &%quota%&
26593 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26594 transport.
26595
26596 .vitem &%quota_%&<&'time'&>
26597 .cindex "quota" "error testing in retry rule"
26598 .cindex "retry" "quota error testing"
26599 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26600 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26601 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26602 for four days.
26603 .endlist
26604
26605 .cindex "mailbox" "time of last read"
26606 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26607 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26608 it should be based on the last time that the user accessed the mailbox.
26609 However, it is not always possible to determine this. Exim uses the following
26610 heuristic rules:
26611
26612 .ilist
26613 If the mailbox is a single file, the time of last access (the &"atime"&) is
26614 used. As no new messages are being delivered (because the mailbox is over
26615 quota), Exim does not access the file, so this is the time of last user access.
26616 .next
26617 .cindex "maildir format" "time of last read"
26618 For a maildir delivery, the time of last modification of the &_new_&
26619 subdirectory is used. As the mailbox is over quota, no new files are created in
26620 the &_new_& subdirectory, because no new messages are being delivered. Any
26621 change to the &_new_& subdirectory is therefore assumed to be the result of an
26622 MUA moving a new message to the &_cur_& directory when it is first read. The
26623 time that is used is therefore the last time that the user read a new message.
26624 .next
26625 For other kinds of multi-file mailbox, the time of last access cannot be
26626 obtained, so a retry rule that uses this type of error field is never matched.
26627 .endlist
26628
26629 The quota errors apply both to system-enforced quotas and to Exim's own quota
26630 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26631 when a local delivery is deferred because a partition is full (the ENOSPC
26632 error).
26633
26634
26635
26636 .section "Retry rules for specified senders" "SECID162"
26637 .cindex "retry" "rules; sender-specific"
26638 You can specify retry rules that apply only when the failing message has a
26639 specific sender. In particular, this can be used to define retry rules that
26640 apply only to bounce messages. The third item in a retry rule can be of this
26641 form:
26642 .display
26643 &`senders=`&<&'address list'&>
26644 .endd
26645 The retry timings themselves are then the fourth item. For example:
26646 .code
26647 *   rcpt_4xx   senders=:   F,1h,30m
26648 .endd
26649 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26650 host. If the address list contains white space, it must be enclosed in quotes.
26651 For example:
26652 .code
26653 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26654 .endd
26655 &*Warning*&: This facility can be unhelpful if it is used for host errors
26656 (which do not depend on the recipient). The reason is that the sender is used
26657 only to match the retry rule. Once the rule has been found for a host error,
26658 its contents are used to set a retry time for the host, and this will apply to
26659 all messages, not just those with specific senders.
26660
26661 When testing retry rules using &%-brt%&, you can supply a sender using the
26662 &%-f%& command line option, like this:
26663 .code
26664 exim -f "" -brt user@dom.ain
26665 .endd
26666 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26667 list is never matched.
26668
26669
26670
26671
26672
26673 .section "Retry parameters" "SECID163"
26674 .cindex "retry" "parameters in rules"
26675 The third (or fourth, if a senders list is present) field in a retry rule is a
26676 sequence of retry parameter sets, separated by semicolons. Each set consists of
26677 .display
26678 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26679 .endd
26680 The letter identifies the algorithm for computing a new retry time; the cutoff
26681 time is the time beyond which this algorithm no longer applies, and the
26682 arguments vary the algorithm's action. The cutoff time is measured from the
26683 time that the first failure for the domain (combined with the local part if
26684 relevant) was detected, not from the time the message was received.
26685
26686 .cindex "retry" "algorithms"
26687 .cindex "retry" "fixed intervals"
26688 .cindex "retry" "increasing intervals"
26689 .cindex "retry" "random intervals"
26690 The available algorithms are:
26691
26692 .ilist
26693 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26694 the interval.
26695 .next
26696 &'G'&: retry at geometrically increasing intervals. The first argument
26697 specifies a starting value for the interval, and the second a multiplier, which
26698 is used to increase the size of the interval at each retry.
26699 .next
26700 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26701 retry, the previous interval is multiplied by the factor in order to get a
26702 maximum for the next interval. The minimum interval is the first argument of
26703 the parameter, and an actual interval is chosen randomly between them. Such a
26704 rule has been found to be helpful in cluster configurations when all the
26705 members of the cluster restart at once, and may therefore synchronize their
26706 queue processing times.
26707 .endlist
26708
26709 When computing the next retry time, the algorithm definitions are scanned in
26710 order until one whose cutoff time has not yet passed is reached. This is then
26711 used to compute a new retry time that is later than the current time. In the
26712 case of fixed interval retries, this simply means adding the interval to the
26713 current time. For geometrically increasing intervals, retry intervals are
26714 computed from the rule's parameters until one that is greater than the previous
26715 interval is found. The main configuration variable
26716 .cindex "limit" "retry interval"
26717 .cindex "retry" "interval, maximum"
26718 .oindex "&%retry_interval_max%&"
26719 &%retry_interval_max%& limits the maximum interval between retries. It
26720 cannot be set greater than &`24h`&, which is its default value.
26721
26722 A single remote domain may have a number of hosts associated with it, and each
26723 host may have more than one IP address. Retry algorithms are selected on the
26724 basis of the domain name, but are applied to each IP address independently. If,
26725 for example, a host has two IP addresses and one is unusable, Exim will
26726 generate retry times for it and will not try to use it until its next retry
26727 time comes. Thus the good IP address is likely to be tried first most of the
26728 time.
26729
26730 .cindex "hints database" "use for retrying"
26731 Retry times are hints rather than promises. Exim does not make any attempt to
26732 run deliveries exactly at the computed times. Instead, a queue runner process
26733 starts delivery processes for delayed messages periodically, and these attempt
26734 new deliveries only for those addresses that have passed their next retry time.
26735 If a new message arrives for a deferred address, an immediate delivery attempt
26736 occurs only if the address has passed its retry time. In the absence of new
26737 messages, the minimum time between retries is the interval between queue runner
26738 processes. There is not much point in setting retry times of five minutes if
26739 your queue runners happen only once an hour, unless there are a significant
26740 number of incoming messages (which might be the case on a system that is
26741 sending everything to a smart host, for example).
26742
26743 The data in the retry hints database can be inspected by using the
26744 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26745 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26746 &'exinext'& utility script can be used to find out what the next retry times
26747 are for the hosts associated with a particular mail domain, and also for local
26748 deliveries that have been deferred.
26749
26750
26751 .section "Retry rule examples" "SECID164"
26752 Here are some example retry rules:
26753 .code
26754 alice@wonderland.fict.example quota_5d  F,7d,3h
26755 wonderland.fict.example       quota_5d
26756 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26757 lookingglass.fict.example     *         F,24h,30m;
26758 *                 refused_A   F,2h,20m;
26759 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26760 .endd
26761 The first rule sets up special handling for mail to
26762 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26763 mailbox has not been read for at least 5 days. Retries continue every three
26764 hours for 7 days. The second rule handles over-quota errors for all other local
26765 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26766 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26767 fail are bounced immediately if the mailbox has not been read for at least 5
26768 days.
26769
26770 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26771 happen every 15 minutes for an hour, then with geometrically increasing
26772 intervals until two days have passed since a delivery first failed. After the
26773 first hour there is a delay of one hour, then two hours, then four hours, and
26774 so on (this is a rather extreme example).
26775
26776 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26777 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26778 all other domains, with special action for connection refusal from hosts that
26779 were not obtained from an MX record.
26780
26781 The final rule in a retry configuration should always have asterisks in the
26782 first two fields so as to provide a general catch-all for any addresses that do
26783 not have their own special handling. This example tries every 15 minutes for 2
26784 hours, then with intervals starting at one hour and increasing by a factor of
26785 1.5 up to 16 hours, then every 8 hours up to 5 days.
26786
26787
26788
26789 .section "Timeout of retry data" "SECID165"
26790 .cindex "timeout" "of retry data"
26791 .oindex "&%retry_data_expire%&"
26792 .cindex "hints database" "data expiry"
26793 .cindex "retry" "timeout of data"
26794 Exim timestamps the data that it writes to its retry hints database. When it
26795 consults the data during a delivery it ignores any that is older than the value
26796 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26797 been tried for 7 days, Exim will try to deliver to it immediately a message
26798 arrives, and if that fails, it will calculate a retry time as if it were
26799 failing for the first time.
26800
26801 This improves the behaviour for messages routed to rarely-used hosts such as MX
26802 backups. If such a host was down at one time, and happens to be down again when
26803 Exim tries a month later, using the old retry data would imply that it had been
26804 down all the time, which is not a justified assumption.
26805
26806 If a host really is permanently dead, this behaviour causes a burst of retries
26807 every now and again, but only if messages routed to it are rare. If there is a
26808 message at least once every 7 days the retry data never expires.
26809
26810
26811
26812
26813 .section "Long-term failures" "SECID166"
26814 .cindex "delivery failure, long-term"
26815 .cindex "retry" "after long-term failure"
26816 Special processing happens when an email address has been failing for so long
26817 that the cutoff time for the last algorithm is reached. For example, using the
26818 default retry rule:
26819 .code
26820 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26821 .endd
26822 the cutoff time is four days. Reaching the retry cutoff is independent of how
26823 long any specific message has been failing; it is the length of continuous
26824 failure for the recipient address that counts.
26825
26826 When the cutoff time is reached for a local delivery, or for all the IP
26827 addresses associated with a remote delivery, a subsequent delivery failure
26828 causes Exim to give up on the address, and a bounce message is generated.
26829 In order to cater for new messages that use the failing address, a next retry
26830 time is still computed from the final algorithm, and is used as follows:
26831
26832 For local deliveries, one delivery attempt is always made for any subsequent
26833 messages. If this delivery fails, the address fails immediately. The
26834 post-cutoff retry time is not used.
26835
26836 .cindex "final cutoff" "retries, controlling"
26837 .cindex retry "final cutoff"
26838 If the delivery is remote, there are two possibilities, controlled by the
26839 .oindex "&%delay_after_cutoff%&"
26840 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26841 default. Until the post-cutoff retry time for one of the IP addresses,
26842 as set by the &%retry_data_expire%& option, is
26843 reached, the failing email address is bounced immediately, without a delivery
26844 attempt taking place. After that time, one new delivery attempt is made to
26845 those IP addresses that are past their retry times, and if that still fails,
26846 the address is bounced and new retry times are computed.
26847
26848 In other words, when all the hosts for a given email address have been failing
26849 for a long time, Exim bounces rather then defers until one of the hosts' retry
26850 times is reached. Then it tries once, and bounces if that attempt fails. This
26851 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26852 to a broken destination, but if the host does recover, Exim will eventually
26853 notice.
26854
26855 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26856 addresses are past their final cutoff time, Exim tries to deliver to those IP
26857 addresses that have not been tried since the message arrived. If there are
26858 no suitable IP addresses, or if they all fail, the address is bounced. In other
26859 words, it does not delay when a new message arrives, but tries the expired
26860 addresses immediately, unless they have been tried since the message arrived.
26861 If there is a continuous stream of messages for the failing domains, setting
26862 &%delay_after_cutoff%& false means that there will be many more attempts to
26863 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26864 true.
26865
26866 .section "Deliveries that work intermittently" "SECID167"
26867 .cindex "retry" "intermittently working deliveries"
26868 Some additional logic is needed to cope with cases where a host is
26869 intermittently available, or when a message has some attribute that prevents
26870 its delivery when others to the same address get through. In this situation,
26871 because some messages are successfully delivered, the &"retry clock"& for the
26872 host or address keeps getting reset by the successful deliveries, and so
26873 failing messages remain in the queue for ever because the cutoff time is never
26874 reached.
26875
26876 Two exceptional actions are applied to prevent this happening. The first
26877 applies to errors that are related to a message rather than a remote host.
26878 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26879 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26880 commands, and quota failures. For this type of error, if a message's arrival
26881 time is earlier than the &"first failed"& time for the error, the earlier time
26882 is used when scanning the retry rules to decide when to try next and when to
26883 time out the address.
26884
26885 The exceptional second action applies in all cases. If a message has been on
26886 the queue for longer than the cutoff time of any applicable retry rule for a
26887 given address, a delivery is attempted for that address, even if it is not yet
26888 time, and if this delivery fails, the address is timed out. A new retry time is
26889 not computed in this case, so that other messages for the same address are
26890 considered immediately.
26891 .ecindex IIDretconf1
26892 .ecindex IIDregconf2
26893
26894
26895
26896
26897
26898
26899 . ////////////////////////////////////////////////////////////////////////////
26900 . ////////////////////////////////////////////////////////////////////////////
26901
26902 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26903 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26904 .scindex IIDauthconf2 "authentication"
26905 The &"authenticators"& section of Exim's runtime configuration is concerned
26906 with SMTP authentication. This facility is an extension to the SMTP protocol,
26907 described in RFC 2554, which allows a client SMTP host to authenticate itself
26908 to a server. This is a common way for a server to recognize clients that are
26909 permitted to use it as a relay. SMTP authentication is not of relevance to the
26910 transfer of mail between servers that have no managerial connection with each
26911 other.
26912
26913 .cindex "AUTH" "description of"
26914 .cindex "ESMTP extensions" AUTH
26915 Very briefly, the way SMTP authentication works is as follows:
26916
26917 .ilist
26918 The server advertises a number of authentication &'mechanisms'& in response to
26919 the client's EHLO command.
26920 .next
26921 The client issues an AUTH command, naming a specific mechanism. The command
26922 may, optionally, contain some authentication data.
26923 .next
26924 The server may issue one or more &'challenges'&, to which the client must send
26925 appropriate responses. In simple authentication mechanisms, the challenges are
26926 just prompts for user names and passwords. The server does not have to issue
26927 any challenges &-- in some mechanisms the relevant data may all be transmitted
26928 with the AUTH command.
26929 .next
26930 The server either accepts or denies authentication.
26931 .next
26932 If authentication succeeds, the client may optionally make use of the AUTH
26933 option on the MAIL command to pass an authenticated sender in subsequent
26934 mail transactions. Authentication lasts for the remainder of the SMTP
26935 connection.
26936 .next
26937 If authentication fails, the client may give up, or it may try a different
26938 authentication mechanism, or it may try transferring mail over the
26939 unauthenticated connection.
26940 .endlist
26941
26942 If you are setting up a client, and want to know which authentication
26943 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26944 SMTP port) on the server, and issue an EHLO command. The response to this
26945 includes the list of supported mechanisms. For example:
26946 .display
26947 &`$ `&&*&`telnet server.example 25`&*&
26948 &`Trying 192.168.34.25...`&
26949 &`Connected to server.example.`&
26950 &`Escape character is &#x0027;^]&#x0027;.`&
26951 &`220 server.example ESMTP Exim 4.20 ...`&
26952 &*&`ehlo client.example`&*&
26953 &`250-server.example Hello client.example [10.8.4.5]`&
26954 &`250-SIZE 52428800`&
26955 &`250-PIPELINING`&
26956 &`250-AUTH PLAIN`&
26957 &`250 HELP`&
26958 .endd
26959 The second-last line of this example output shows that the server supports
26960 authentication using the PLAIN mechanism. In Exim, the different authentication
26961 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26962 routers and transports, which authenticators are included in the binary is
26963 controlled by build-time definitions. The following are currently available,
26964 included by setting
26965 .code
26966 AUTH_CRAM_MD5=yes
26967 AUTH_CYRUS_SASL=yes
26968 AUTH_DOVECOT=yes
26969 AUTH_EXTERNAL=yes
26970 AUTH_GSASL=yes
26971 AUTH_HEIMDAL_GSSAPI=yes
26972 AUTH_PLAINTEXT=yes
26973 AUTH_SPA=yes
26974 AUTH_TLS=yes
26975 .endd
26976 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26977 authentication mechanism (RFC 2195), and the second provides an interface to
26978 the Cyrus SASL authentication library.
26979 The third is an interface to Dovecot's authentication system, delegating the
26980 work via a socket interface.
26981 The fourth provides for negotiation of authentication done via non-SMTP means,
26982 as defined by RFC 4422 Appendix A.
26983 The fifth provides an interface to the GNU SASL authentication library, which
26984 provides mechanisms but typically not data sources.
26985 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26986 supporting setting a server keytab.
26987 The seventh can be configured to support
26988 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26989 not formally documented, but used by several MUAs.
26990 The eighth authenticator
26991 supports Microsoft's &'Secure Password Authentication'& mechanism.
26992 The last is an Exim authenticator but not an SMTP one;
26993 instead it can use information from a TLS negotiation.
26994
26995 The authenticators are configured using the same syntax as other drivers (see
26996 section &<<SECTfordricon>>&). If no authenticators are required, no
26997 authentication section need be present in the configuration file. Each
26998 authenticator can in principle have both server and client functions. When Exim
26999 is receiving SMTP mail, it is acting as a server; when it is sending out
27000 messages over SMTP, it is acting as a client. Authenticator configuration
27001 options are provided for use in both these circumstances.
27002
27003 To make it clear which options apply to which situation, the prefixes
27004 &%server_%& and &%client_%& are used on option names that are specific to
27005 either the server or the client function, respectively. Server and client
27006 functions are disabled if none of their options are set. If an authenticator is
27007 to be used for both server and client functions, a single definition, using
27008 both sets of options, is required. For example:
27009 .code
27010 cram:
27011   driver = cram_md5
27012   public_name = CRAM-MD5
27013   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27014   client_name = ph10
27015   client_secret = secret2
27016 .endd
27017 The &%server_%& option is used when Exim is acting as a server, and the
27018 &%client_%& options when it is acting as a client.
27019
27020 Descriptions of the individual authenticators are given in subsequent chapters.
27021 The remainder of this chapter covers the generic options for the
27022 authenticators, followed by general discussion of the way authentication works
27023 in Exim.
27024
27025 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27026 per-mechanism basis.  Please read carefully to determine which variables hold
27027 account labels such as usercodes and which hold passwords or other
27028 authenticating data.
27029
27030 Note that some mechanisms support two different identifiers for accounts: the
27031 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27032 and &'authz'& are commonly encountered.  The American spelling is standard here.
27033 Conceptually, authentication data such as passwords are tied to the identifier
27034 used to authenticate; servers may have rules to permit one user to act as a
27035 second user, so that after login the session is treated as though that second
27036 user had logged in.  That second user is the &'authorization id'&.  A robust
27037 configuration might confirm that the &'authz'& field is empty or matches the
27038 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27039 as verified data, the &'authz'& as an unverified request which the server might
27040 choose to honour.
27041
27042 A &'realm'& is a text string, typically a domain name, presented by a server
27043 to a client to help it select an account and credentials to use.  In some
27044 mechanisms, the client and server provably agree on the realm, but clients
27045 typically can not treat the realm as secure data to be blindly trusted.
27046
27047
27048
27049 .section "Generic options for authenticators" "SECID168"
27050 .cindex "authentication" "generic options"
27051 .cindex "options" "generic; for authenticators"
27052
27053 .option client_condition authenticators string&!! unset
27054 When Exim is authenticating as a client, it skips any authenticator whose
27055 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27056 used, for example, to skip plain text authenticators when the connection is not
27057 encrypted by a setting such as:
27058 .code
27059 client_condition = ${if !eq{$tls_out_cipher}{}}
27060 .endd
27061
27062
27063 .option client_set_id authenticators string&!! unset
27064 When client authentication succeeds, this condition is expanded; the
27065 result is used in the log lines for outbound messages.
27066 Typically it will be the user name used for authentication.
27067
27068
27069 .option driver authenticators string unset
27070 This option must always be set. It specifies which of the available
27071 authenticators is to be used.
27072
27073
27074 .option public_name authenticators string unset
27075 This option specifies the name of the authentication mechanism that the driver
27076 implements, and by which it is known to the outside world. These names should
27077 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27078 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27079 defaults to the driver's instance name.
27080
27081
27082 .option server_advertise_condition authenticators string&!! unset
27083 When a server is about to advertise an authentication mechanism, the condition
27084 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27085 mechanism is not advertised.
27086 If the expansion fails, the mechanism is not advertised. If the failure was not
27087 forced, and was not caused by a lookup defer, the incident is logged.
27088 See section &<<SECTauthexiser>>& below for further discussion.
27089
27090
27091 .option server_condition authenticators string&!! unset
27092 This option must be set for a &%plaintext%& server authenticator, where it
27093 is used directly to control authentication. See section &<<SECTplainserver>>&
27094 for details.
27095
27096 For the &(gsasl)& authenticator, this option is required for various
27097 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27098
27099 For the other authenticators, &%server_condition%& can be used as an additional
27100 authentication or authorization mechanism that is applied after the other
27101 authenticator conditions succeed. If it is set, it is expanded when the
27102 authenticator would otherwise return a success code. If the expansion is forced
27103 to fail, authentication fails. Any other expansion failure causes a temporary
27104 error code to be returned. If the result of a successful expansion is an empty
27105 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27106 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27107 other result, a temporary error code is returned, with the expanded string as
27108 the error text.
27109
27110
27111 .option server_debug_print authenticators string&!! unset
27112 If this option is set and authentication debugging is enabled (see the &%-d%&
27113 command line option), the string is expanded and included in the debugging
27114 output when the authenticator is run as a server. This can help with checking
27115 out the values of variables.
27116 If expansion of the string fails, the error message is written to the debugging
27117 output, and Exim carries on processing.
27118
27119
27120 .option server_set_id authenticators string&!! unset
27121 .vindex "&$authenticated_id$&"
27122 .vindex "&$authenticated_fail_id$&"
27123 When an Exim server successfully authenticates a client, this string is
27124 expanded using data from the authentication, and preserved for any incoming
27125 messages in the variable &$authenticated_id$&. It is also included in the log
27126 lines for incoming messages. For example, a user/password authenticator
27127 configuration might preserve the user name that was used to authenticate, and
27128 refer to it subsequently during delivery of the message.
27129 On a failing authentication the expansion result is instead saved in
27130 the &$authenticated_fail_id$& variable.
27131 If expansion fails, the option is ignored.
27132
27133
27134 .option server_mail_auth_condition authenticators string&!! unset
27135 This option allows a server to discard authenticated sender addresses supplied
27136 as part of MAIL commands in SMTP connections that are authenticated by the
27137 driver on which &%server_mail_auth_condition%& is set. The option is not used
27138 as part of the authentication process; instead its (unexpanded) value is
27139 remembered for later use.
27140 How it is used is described in the following section.
27141
27142
27143
27144
27145
27146 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27147 .cindex "authentication" "sender; authenticated"
27148 .cindex "AUTH" "on MAIL command"
27149 When a client supplied an AUTH= item on a MAIL command, Exim applies
27150 the following checks before accepting it as the authenticated sender of the
27151 message:
27152
27153 .ilist
27154 If the connection is not using extended SMTP (that is, HELO was used rather
27155 than EHLO), the use of AUTH= is a syntax error.
27156 .next
27157 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27158 .next
27159 .vindex "&$authenticated_sender$&"
27160 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27161 running, the value of &$authenticated_sender$& is set to the value obtained
27162 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27163 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27164 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27165 given for the MAIL command.
27166 .next
27167 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27168 is accepted and placed in &$authenticated_sender$& only if the client has
27169 authenticated.
27170 .next
27171 If the AUTH= value was accepted by either of the two previous rules, and
27172 the client has authenticated, and the authenticator has a setting for the
27173 &%server_mail_auth_condition%&, the condition is checked at this point. The
27174 valued that was saved from the authenticator is expanded. If the expansion
27175 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27176 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27177 the value of &$authenticated_sender$& is retained and passed on with the
27178 message.
27179 .endlist
27180
27181
27182 When &$authenticated_sender$& is set for a message, it is passed on to other
27183 hosts to which Exim authenticates as a client. Do not confuse this value with
27184 &$authenticated_id$&, which is a string obtained from the authentication
27185 process, and which is not usually a complete email address.
27186
27187 .vindex "&$sender_address$&"
27188 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27189 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27190 therefore make use of &$authenticated_sender$&. The converse is not true: the
27191 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27192 ACL is run.
27193
27194
27195
27196 .section "Authentication on an Exim server" "SECTauthexiser"
27197 .cindex "authentication" "on an Exim server"
27198 When Exim receives an EHLO command, it advertises the public names of those
27199 authenticators that are configured as servers, subject to the following
27200 conditions:
27201
27202 .ilist
27203 The client host must match &%auth_advertise_hosts%& (default *).
27204 .next
27205 It the &%server_advertise_condition%& option is set, its expansion must not
27206 yield the empty string, &"0"&, &"no"&, or &"false"&.
27207 .endlist
27208
27209 The order in which the authenticators are defined controls the order in which
27210 the mechanisms are advertised.
27211
27212 Some mail clients (for example, some versions of Netscape) require the user to
27213 provide a name and password for authentication whenever AUTH is advertised,
27214 even though authentication may not in fact be needed (for example, Exim may be
27215 set up to allow unconditional relaying from the client by an IP address check).
27216 You can make such clients more friendly by not advertising AUTH to them.
27217 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27218 that runs for RCPT) to relay without authentication, you should set
27219 .code
27220 auth_advertise_hosts = ! 10.9.8.0/24
27221 .endd
27222 so that no authentication mechanisms are advertised to them.
27223
27224 The &%server_advertise_condition%& controls the advertisement of individual
27225 authentication mechanisms. For example, it can be used to restrict the
27226 advertisement of a particular mechanism to encrypted connections, by a setting
27227 such as:
27228 .code
27229 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27230 .endd
27231 .vindex "&$tls_in_cipher$&"
27232 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27233 yields &"yes"&, which allows the advertisement to happen.
27234
27235 When an Exim server receives an AUTH command from a client, it rejects it
27236 immediately if AUTH was not advertised in response to an earlier EHLO
27237 command. This is the case if
27238
27239 .ilist
27240 The client host does not match &%auth_advertise_hosts%&; or
27241 .next
27242 No authenticators are configured with server options; or
27243 .next
27244 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27245 server authenticators.
27246 .endlist
27247
27248
27249 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27250 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27251 AUTH is accepted from any client host.
27252
27253 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27254 server authentication mechanism that was advertised in response to EHLO and
27255 that matches the one named in the AUTH command. If it finds one, it runs
27256 the appropriate authentication protocol, and authentication either succeeds or
27257 fails. If there is no matching advertised mechanism, the AUTH command is
27258 rejected with a 504 error.
27259
27260 .vindex "&$received_protocol$&"
27261 .vindex "&$sender_host_authenticated$&"
27262 When a message is received from an authenticated host, the value of
27263 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27264 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27265 public name) of the authenticator driver that successfully authenticated the
27266 client from which the message was received. This variable is empty if there was
27267 no successful authentication.
27268
27269 .cindex authentication "expansion item"
27270 Successful authentication sets up information used by the
27271 &%authresults%& expansion item.
27272
27273
27274
27275
27276 .section "Testing server authentication" "SECID169"
27277 .cindex "authentication" "testing a server"
27278 .cindex "AUTH" "testing a server"
27279 .cindex "base64 encoding" "creating authentication test data"
27280 Exim's &%-bh%& option can be useful for testing server authentication
27281 configurations. The data for the AUTH command has to be sent using base64
27282 encoding. A quick way to produce such data for testing is the following Perl
27283 script:
27284 .code
27285 use MIME::Base64;
27286 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27287 .endd
27288 .cindex "binary zero" "in authentication data"
27289 This interprets its argument as a Perl string, and then encodes it. The
27290 interpretation as a Perl string allows binary zeros, which are required for
27291 some kinds of authentication, to be included in the data. For example, a
27292 command line to run this script on such data might be
27293 .code
27294 encode '\0user\0password'
27295 .endd
27296 Note the use of single quotes to prevent the shell interpreting the
27297 backslashes, so that they can be interpreted by Perl to specify characters
27298 whose code value is zero.
27299
27300 &*Warning 1*&: If either of the user or password strings starts with an octal
27301 digit, you must use three zeros instead of one after the leading backslash. If
27302 you do not, the octal digit that starts your string will be incorrectly
27303 interpreted as part of the code for the first character.
27304
27305 &*Warning 2*&: If there are characters in the strings that Perl interprets
27306 specially, you must use a Perl escape to prevent them being misinterpreted. For
27307 example, a command such as
27308 .code
27309 encode '\0user@domain.com\0pas$$word'
27310 .endd
27311 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27312
27313 If you have the &%mimencode%& command installed, another way to do produce
27314 base64-encoded strings is to run the command
27315 .code
27316 echo -e -n `\0user\0password' | mimencode
27317 .endd
27318 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27319 in the argument, and the &%-n%& option specifies no newline at the end of its
27320 output. However, not all versions of &%echo%& recognize these options, so you
27321 should check your version before relying on this suggestion.
27322
27323
27324
27325 .section "Authentication by an Exim client" "SECID170"
27326 .cindex "authentication" "on an Exim client"
27327 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27328 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27329 announces support for authentication, and the host matches an entry in either
27330 of these options, Exim (as a client) tries to authenticate as follows:
27331
27332 .ilist
27333 For each authenticator that is configured as a client, in the order in which
27334 they are defined in the configuration, it searches the authentication
27335 mechanisms announced by the server for one whose name matches the public name
27336 of the authenticator.
27337 .next
27338 .vindex "&$host$&"
27339 .vindex "&$host_address$&"
27340 When it finds one that matches, it runs the authenticator's client code. The
27341 variables &$host$& and &$host_address$& are available for any string expansions
27342 that the client might do. They are set to the server's name and IP address. If
27343 any expansion is forced to fail, the authentication attempt is abandoned, and
27344 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27345 delivery to be deferred.
27346 .next
27347 If the result of the authentication attempt is a temporary error or a timeout,
27348 Exim abandons trying to send the message to the host for the moment. It will
27349 try again later. If there are any backup hosts available, they are tried in the
27350 usual way.
27351 .next
27352 If the response to authentication is a permanent error (5&'xx'& code), Exim
27353 carries on searching the list of authenticators and tries another one if
27354 possible. If all authentication attempts give permanent errors, or if there are
27355 no attempts because no mechanisms match (or option expansions force failure),
27356 what happens depends on whether the host matches &%hosts_require_auth%& or
27357 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27358 delivery is deferred. The error can be detected in the retry rules, and thereby
27359 turned into a permanent error if you wish. In the second case, Exim tries to
27360 deliver the message unauthenticated.
27361 .endlist
27362
27363 Note that the hostlist test for whether to do authentication can be
27364 confused if name-IP lookups change between the time the peer is decided
27365 upon and the time that the transport runs.  For example, with a manualroute
27366 router given a host name, and with DNS "round-robin" used by that name: if
27367 the local resolver cache times out between the router and the transport
27368 running, the transport may get an IP for the name for its authentication
27369 check which does not match the connection peer IP.
27370 No authentication will then be done, despite the names being identical.
27371
27372 For such cases use a separate transport which always authenticates.
27373
27374 .cindex "AUTH" "on MAIL command"
27375 When Exim has authenticated itself to a remote server, it adds the AUTH
27376 parameter to the MAIL commands it sends, if it has an authenticated sender for
27377 the message. If the message came from a remote host, the authenticated sender
27378 is the one that was receiving on an incoming MAIL command, provided that the
27379 incoming connection was authenticated and the &%server_mail_auth%& condition
27380 allowed the authenticated sender to be retained. If a local process calls Exim
27381 to send a message, the sender address that is built from the login name and
27382 &%qualify_domain%& is treated as authenticated. However, if the
27383 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27384 the authenticated sender that was received with the message.
27385 .ecindex IIDauthconf1
27386 .ecindex IIDauthconf2
27387
27388
27389
27390
27391
27392
27393 . ////////////////////////////////////////////////////////////////////////////
27394 . ////////////////////////////////////////////////////////////////////////////
27395
27396 .chapter "The plaintext authenticator" "CHAPplaintext"
27397 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27398 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27399 The &(plaintext)& authenticator can be configured to support the PLAIN and
27400 LOGIN authentication mechanisms, both of which transfer authentication data as
27401 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27402 security risk; you are strongly advised to insist on the use of SMTP encryption
27403 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27404 use unencrypted plain text, you should not use the same passwords for SMTP
27405 connections as you do for login accounts.
27406
27407 .section "Avoiding cleartext use" "SECTplain_TLS"
27408 The following generic option settings will disable &(plaintext)& authenticators when
27409 TLS is not being used:
27410 .code
27411   server_advertise_condition = ${if def:tls_in_cipher }
27412   client_condition =           ${if def:tls_out_cipher}
27413 .endd
27414
27415 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27416 but is still vulnerable to a Man In The Middle attack unless certificates
27417 (including their names) have been properly verified.
27418
27419 .section "Plaintext server options" "SECID171"
27420 .cindex "options" "&(plaintext)& authenticator (server)"
27421 When configured as a server, &(plaintext)& uses the following options:
27422
27423 .option server_condition authenticators string&!! unset
27424 This is actually a global authentication option, but it must be set in order to
27425 configure the &(plaintext)& driver as a server. Its use is described below.
27426
27427 .option server_prompts plaintext "string list&!!" unset
27428 The contents of this option, after expansion, must be a colon-separated list of
27429 prompt strings. If expansion fails, a temporary authentication rejection is
27430 given.
27431
27432 .section "Using plaintext in a server" "SECTplainserver"
27433 .cindex "AUTH" "in &(plaintext)& authenticator"
27434 .cindex "binary zero" "in &(plaintext)& authenticator"
27435 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27436         "in &(plaintext)& authenticator"
27437 .vindex "&$auth1$&, &$auth2$&, etc"
27438 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27439
27440 When running as a server, &(plaintext)& performs the authentication test by
27441 expanding a string. The data sent by the client with the AUTH command, or in
27442 response to subsequent prompts, is base64 encoded, and so may contain any byte
27443 values when decoded. If any data is supplied with the command, it is treated as
27444 a list of strings, separated by NULs (binary zeros), the first three of which
27445 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27446 (neither LOGIN nor PLAIN uses more than three strings).
27447
27448 For compatibility with previous releases of Exim, the values are also placed in
27449 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27450 variables for this purpose is now deprecated, as it can lead to confusion in
27451 string expansions that also use them for other things.
27452
27453 If there are more strings in &%server_prompts%& than the number of strings
27454 supplied with the AUTH command, the remaining prompts are used to obtain more
27455 data. Each response from the client may be a list of NUL-separated strings.
27456
27457 .vindex "&$authenticated_id$&"
27458 Once a sufficient number of data strings have been received,
27459 &%server_condition%& is expanded. If the expansion is forced to fail,
27460 authentication fails. Any other expansion failure causes a temporary error code
27461 to be returned. If the result of a successful expansion is an empty string,
27462 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27463 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27464 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27465 For any other result, a temporary error code is returned, with the expanded
27466 string as the error text.
27467
27468 &*Warning*&: If you use a lookup in the expansion to find the user's
27469 password, be sure to make the authentication fail if the user is unknown.
27470 There are good and bad examples at the end of the next section.
27471
27472
27473
27474 .section "The PLAIN authentication mechanism" "SECID172"
27475 .cindex "PLAIN authentication mechanism"
27476 .cindex authentication PLAIN
27477 .cindex "binary zero" "in &(plaintext)& authenticator"
27478 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27479 sent as one item of data (that is, one combined string containing two NUL
27480 separators). The data is sent either as part of the AUTH command, or
27481 subsequently in response to an empty prompt from the server.
27482
27483 The second and third strings are a user name and a corresponding password.
27484 Using a single fixed user name and password as an example, this could be
27485 configured as follows:
27486 .code
27487 fixed_plain:
27488   driver = plaintext
27489   public_name = PLAIN
27490   server_prompts = :
27491   server_condition = \
27492     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27493   server_set_id = $auth2
27494 .endd
27495 Note that the default result strings from &%if%& (&"true"& or an empty string)
27496 are exactly what we want here, so they need not be specified. Obviously, if the
27497 password contains expansion-significant characters such as dollar, backslash,
27498 or closing brace, they have to be escaped.
27499
27500 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27501 the end of a string list are ignored). If all the data comes as part of the
27502 AUTH command, as is commonly the case, the prompt is not used. This
27503 authenticator is advertised in the response to EHLO as
27504 .code
27505 250-AUTH PLAIN
27506 .endd
27507 and a client host can authenticate itself by sending the command
27508 .code
27509 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27510 .endd
27511 As this contains three strings (more than the number of prompts), no further
27512 data is required from the client. Alternatively, the client may just send
27513 .code
27514 AUTH PLAIN
27515 .endd
27516 to initiate authentication, in which case the server replies with an empty
27517 prompt. The client must respond with the combined data string.
27518
27519 The data string is base64 encoded, as required by the RFC. This example,
27520 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27521 represents a zero byte. This is split up into three strings, the first of which
27522 is empty. The &%server_condition%& option in the authenticator checks that the
27523 second two are &`username`& and &`mysecret`& respectively.
27524
27525 Having just one fixed user name and password, as in this example, is not very
27526 realistic, though for a small organization with only a handful of
27527 authenticating clients it could make sense.
27528
27529 A more sophisticated instance of this authenticator could use the user name in
27530 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27531 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27532 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27533 This is an incorrect example:
27534 .code
27535 server_condition = \
27536   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27537 .endd
27538 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27539 which it then compares to the supplied password (&$auth3$&). Why is this example
27540 incorrect? It works fine for existing users, but consider what happens if a
27541 non-existent user name is given. The lookup fails, but as no success/failure
27542 strings are given for the lookup, it yields an empty string. Thus, to defeat
27543 the authentication, all a client has to do is to supply a non-existent user
27544 name and an empty password. The correct way of writing this test is:
27545 .code
27546 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27547   {${if eq{$value}{$auth3}}} {false}}
27548 .endd
27549 In this case, if the lookup succeeds, the result is checked; if the lookup
27550 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27551 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27552 always fails if its second argument is empty. However, the second way of
27553 writing the test makes the logic clearer.
27554
27555
27556 .section "The LOGIN authentication mechanism" "SECID173"
27557 .cindex "LOGIN authentication mechanism"
27558 .cindex authentication LOGIN
27559 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27560 in a number of programs. No data is sent with the AUTH command. Instead, a
27561 user name and password are supplied separately, in response to prompts. The
27562 plaintext authenticator can be configured to support this as in this example:
27563 .code
27564 fixed_login:
27565   driver = plaintext
27566   public_name = LOGIN
27567   server_prompts = User Name : Password
27568   server_condition = \
27569     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27570   server_set_id = $auth1
27571 .endd
27572 Because of the way plaintext operates, this authenticator accepts data supplied
27573 with the AUTH command (in contravention of the specification of LOGIN), but
27574 if the client does not supply it (as is the case for LOGIN clients), the prompt
27575 strings are used to obtain two data items.
27576
27577 Some clients are very particular about the precise text of the prompts. For
27578 example, Outlook Express is reported to recognize only &"Username:"& and
27579 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27580 strings. It uses the &%ldapauth%& expansion condition to check the user
27581 name and password by binding to an LDAP server:
27582 .code
27583 login:
27584   driver = plaintext
27585   public_name = LOGIN
27586   server_prompts = Username:: : Password::
27587   server_condition = ${if and{{ \
27588     !eq{}{$auth1} }{ \
27589     ldapauth{\
27590       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27591       pass=${quote:$auth2} \
27592       ldap://ldap.example.org/} }} }
27593   server_set_id = uid=$auth1,ou=people,o=example.org
27594 .endd
27595 We have to check that the username is not empty before using it, because LDAP
27596 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27597 operator to correctly quote the DN for authentication. However, the basic
27598 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27599 correct one to use for the password, because quoting is needed only to make
27600 the password conform to the Exim syntax. At the LDAP level, the password is an
27601 uninterpreted string.
27602
27603
27604 .section "Support for different kinds of authentication" "SECID174"
27605 A number of string expansion features are provided for the purpose of
27606 interfacing to different ways of user authentication. These include checking
27607 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27608 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27609 &<<SECTexpcond>>&.
27610
27611
27612
27613
27614 .section "Using plaintext in a client" "SECID175"
27615 .cindex "options" "&(plaintext)& authenticator (client)"
27616 The &(plaintext)& authenticator has two client options:
27617
27618 .option client_ignore_invalid_base64 plaintext boolean false
27619 If the client receives a server prompt that is not a valid base64 string,
27620 authentication is abandoned by default. However, if this option is set true,
27621 the error in the challenge is ignored and the client sends the response as
27622 usual.
27623
27624 .option client_send plaintext string&!! unset
27625 The string is a colon-separated list of authentication data strings. Each
27626 string is independently expanded before being sent to the server. The first
27627 string is sent with the AUTH command; any more strings are sent in response
27628 to prompts from the server. Before each string is expanded, the value of the
27629 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27630 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27631 way. Thus, the prompt that is received in response to sending the first string
27632 (with the AUTH command) can be used in the expansion of the second string, and
27633 so on. If an invalid base64 string is received when
27634 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27635 &$auth$&<&'n'&> variable.
27636
27637 &*Note*&: You cannot use expansion to create multiple strings, because
27638 splitting takes priority and happens first.
27639
27640 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27641 the data, further processing is applied to each string before it is sent. If
27642 there are any single circumflex characters in the string, they are converted to
27643 NULs. Should an actual circumflex be required as data, it must be doubled in
27644 the string.
27645
27646 This is an example of a client configuration that implements the PLAIN
27647 authentication mechanism with a fixed user name and password:
27648 .code
27649 fixed_plain:
27650   driver = plaintext
27651   public_name = PLAIN
27652   client_send = ^username^mysecret
27653 .endd
27654 The lack of colons means that the entire text is sent with the AUTH
27655 command, with the circumflex characters converted to NULs. A similar example
27656 that uses the LOGIN mechanism is:
27657 .code
27658 fixed_login:
27659   driver = plaintext
27660   public_name = LOGIN
27661   client_send = : username : mysecret
27662 .endd
27663 The initial colon means that the first string is empty, so no data is sent with
27664 the AUTH command itself. The remaining strings are sent in response to
27665 prompts.
27666 .ecindex IIDplaiauth1
27667 .ecindex IIDplaiauth2
27668
27669
27670
27671
27672 . ////////////////////////////////////////////////////////////////////////////
27673 . ////////////////////////////////////////////////////////////////////////////
27674
27675 .chapter "The cram_md5 authenticator" "CHID9"
27676 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27677 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27678 .cindex "CRAM-MD5 authentication mechanism"
27679 .cindex authentication CRAM-MD5
27680 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27681 sends a challenge string to the client, and the response consists of a user
27682 name and the CRAM-MD5 digest of the challenge string combined with a secret
27683 string (password) which is known to both server and client. Thus, the secret
27684 is not sent over the network as plain text, which makes this authenticator more
27685 secure than &(plaintext)&. However, the downside is that the secret has to be
27686 available in plain text at either end.
27687
27688
27689 .section "Using cram_md5 as a server" "SECID176"
27690 .cindex "options" "&(cram_md5)& authenticator (server)"
27691 This authenticator has one server option, which must be set to configure the
27692 authenticator as a server:
27693
27694 .option server_secret cram_md5 string&!! unset
27695 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27696 When the server receives the client's response, the user name is placed in
27697 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27698 obtain the password for that user. The server then computes the CRAM-MD5 digest
27699 that the client should have sent, and checks that it received the correct
27700 string. If the expansion of &%server_secret%& is forced to fail, authentication
27701 fails. If the expansion fails for some other reason, a temporary error code is
27702 returned to the client.
27703
27704 For compatibility with previous releases of Exim, the user name is also placed
27705 in &$1$&. However, the use of this variables for this purpose is now
27706 deprecated, as it can lead to confusion in string expansions that also use
27707 numeric variables for other things.
27708
27709 For example, the following authenticator checks that the user name given by the
27710 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27711 user name, authentication fails.
27712 .code
27713 fixed_cram:
27714   driver = cram_md5
27715   public_name = CRAM-MD5
27716   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27717   server_set_id = $auth1
27718 .endd
27719 .vindex "&$authenticated_id$&"
27720 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27721 name in &$authenticated_id$&. A more typical configuration might look up the
27722 secret string in a file, using the user name as the key. For example:
27723 .code
27724 lookup_cram:
27725   driver = cram_md5
27726   public_name = CRAM-MD5
27727   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27728                   {$value}fail}
27729   server_set_id = $auth1
27730 .endd
27731 Note that this expansion explicitly forces failure if the lookup fails
27732 because &$auth1$& contains an unknown user name.
27733
27734 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27735 using the relevant libraries, you need to know the realm to specify in the
27736 lookup and then ask for the &"userPassword"& attribute for that user in that
27737 realm, with:
27738 .code
27739 cyrusless_crammd5:
27740   driver = cram_md5
27741   public_name = CRAM-MD5
27742   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27743                   dbmjz{/etc/sasldb2}{$value}fail}
27744   server_set_id = $auth1
27745 .endd
27746
27747 .section "Using cram_md5 as a client" "SECID177"
27748 .cindex "options" "&(cram_md5)& authenticator (client)"
27749 When used as a client, the &(cram_md5)& authenticator has two options:
27750
27751
27752
27753 .option client_name cram_md5 string&!! "the primary host name"
27754 This string is expanded, and the result used as the user name data when
27755 computing the response to the server's challenge.
27756
27757
27758 .option client_secret cram_md5 string&!! unset
27759 This option must be set for the authenticator to work as a client. Its value is
27760 expanded and the result used as the secret string when computing the response.
27761
27762
27763 .vindex "&$host$&"
27764 .vindex "&$host_address$&"
27765 Different user names and secrets can be used for different servers by referring
27766 to &$host$& or &$host_address$& in the options. Forced failure of either
27767 expansion string is treated as an indication that this authenticator is not
27768 prepared to handle this case. Exim moves on to the next configured client
27769 authenticator. Any other expansion failure causes Exim to give up trying to
27770 send the message to the current server.
27771
27772 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27773 strings, is:
27774 .code
27775 fixed_cram:
27776   driver = cram_md5
27777   public_name = CRAM-MD5
27778   client_name = ph10
27779   client_secret = secret
27780 .endd
27781 .ecindex IIDcramauth1
27782 .ecindex IIDcramauth2
27783
27784
27785
27786 . ////////////////////////////////////////////////////////////////////////////
27787 . ////////////////////////////////////////////////////////////////////////////
27788
27789 .chapter "The cyrus_sasl authenticator" "CHID10"
27790 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27791 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27792 .cindex "Cyrus" "SASL library"
27793 .cindex "Kerberos"
27794 The code for this authenticator was provided by Matthew Byng-Maddick while
27795 at A L Digital Ltd.
27796
27797 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27798 library implementation of the RFC 2222 (&"Simple Authentication and Security
27799 Layer"&). This library supports a number of authentication mechanisms,
27800 including PLAIN and LOGIN, but also several others that Exim does not support
27801 directly. In particular, there is support for Kerberos authentication.
27802
27803 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27804 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27805 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27806 name of the driver to determine which mechanism to support.
27807
27808 Where access to some kind of secret file is required, for example, in GSSAPI
27809 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27810 user, and that the Cyrus SASL library has no way of escalating privileges
27811 by default. You may also find you need to set environment variables,
27812 depending on the driver you are using.
27813
27814 The application name provided by Exim is &"exim"&, so various SASL options may
27815 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27816 Kerberos, note that because of limitations in the GSSAPI interface,
27817 changing the server keytab might need to be communicated down to the Kerberos
27818 layer independently. The mechanism for doing so is dependent upon the Kerberos
27819 implementation.
27820
27821 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27822 may be set to point to an alternative keytab file. Exim will pass this
27823 variable through from its own inherited environment when started as root or the
27824 Exim user. The keytab file needs to be readable by the Exim user.
27825 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27826 environment variable.  In practice, for those releases, the Cyrus authenticator
27827 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27828 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27829
27830
27831 .section "Using cyrus_sasl as a server" "SECID178"
27832 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27833 (on a successful authentication) into &$auth1$&. For compatibility with
27834 previous releases of Exim, the username is also placed in &$1$&. However, the
27835 use of this variable for this purpose is now deprecated, as it can lead to
27836 confusion in string expansions that also use numeric variables for other
27837 things.
27838
27839
27840 .option server_hostname cyrus_sasl string&!! "see below"
27841 This option selects the hostname that is used when communicating with the
27842 library. The default value is &`$primary_hostname`&. It is up to the underlying
27843 SASL plug-in what it does with this data.
27844
27845
27846 .option server_mech cyrus_sasl string "see below"
27847 This option selects the authentication mechanism this driver should use. The
27848 default is the value of the generic &%public_name%& option. This option allows
27849 you to use a different underlying mechanism from the advertised name. For
27850 example:
27851 .code
27852 sasl:
27853   driver = cyrus_sasl
27854   public_name = X-ANYTHING
27855   server_mech = CRAM-MD5
27856   server_set_id = $auth1
27857 .endd
27858
27859 .option server_realm cyrus_sasl string&!! unset
27860 This specifies the SASL realm that the server claims to be in.
27861
27862
27863 .option server_service cyrus_sasl string &`smtp`&
27864 This is the SASL service that the server claims to implement.
27865
27866
27867 For straightforward cases, you do not need to set any of the authenticator's
27868 private options. All you need to do is to specify an appropriate mechanism as
27869 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27870 PLAIN, you could have two authenticators as follows:
27871 .code
27872 sasl_cram_md5:
27873   driver = cyrus_sasl
27874   public_name = CRAM-MD5
27875   server_set_id = $auth1
27876
27877 sasl_plain:
27878   driver = cyrus_sasl
27879   public_name = PLAIN
27880   server_set_id = $auth2
27881 .endd
27882 Cyrus SASL does implement the LOGIN authentication method, even though it is
27883 not a standard method. It is disabled by default in the source distribution,
27884 but it is present in many binary distributions.
27885 .ecindex IIDcyrauth1
27886 .ecindex IIDcyrauth2
27887
27888
27889
27890
27891 . ////////////////////////////////////////////////////////////////////////////
27892 . ////////////////////////////////////////////////////////////////////////////
27893 .chapter "The dovecot authenticator" "CHAPdovecot"
27894 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27895 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27896 This authenticator is an interface to the authentication facility of the
27897 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27898 Note that Dovecot must be configured to use auth-client not auth-userdb.
27899 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27900 to use the same mechanisms for SMTP authentication. This is a server
27901 authenticator only. There is only one option:
27902
27903 .option server_socket dovecot string unset
27904
27905 This option must specify the UNIX socket that is the interface to Dovecot
27906 authentication. The &%public_name%& option must specify an authentication
27907 mechanism that Dovecot is configured to support. You can have several
27908 authenticators for different mechanisms. For example:
27909 .code
27910 dovecot_plain:
27911   driver = dovecot
27912   public_name = PLAIN
27913   server_socket = /var/run/dovecot/auth-client
27914   server_set_id = $auth1
27915
27916 dovecot_ntlm:
27917   driver = dovecot
27918   public_name = NTLM
27919   server_socket = /var/run/dovecot/auth-client
27920   server_set_id = $auth1
27921 .endd
27922 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27923 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27924 option is passed in the Dovecot authentication command. If, for a TLS
27925 connection, a client certificate has been verified, the &"valid-client-cert"&
27926 option is passed. When authentication succeeds, the identity of the user
27927 who authenticated is placed in &$auth1$&.
27928
27929 The Dovecot configuration to match the above wil look
27930 something like:
27931 .code
27932 conf.d/10-master.conf :-
27933
27934 service auth {
27935 ...
27936 #SASL
27937   unix_listener auth-client {
27938     mode = 0660
27939     user = mail
27940   }
27941 ...
27942 }
27943
27944 conf.d/10-auth.conf :-
27945
27946 auth_mechanisms = plain login ntlm
27947 .endd
27948
27949 .ecindex IIDdcotauth1
27950 .ecindex IIDdcotauth2
27951
27952
27953 . ////////////////////////////////////////////////////////////////////////////
27954 . ////////////////////////////////////////////////////////////////////////////
27955 .chapter "The gsasl authenticator" "CHAPgsasl"
27956 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27957 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27958 .cindex "authentication" "GNU SASL"
27959 .cindex "authentication" "SASL"
27960 .cindex "authentication" "EXTERNAL"
27961 .cindex "authentication" "ANONYMOUS"
27962 .cindex "authentication" "PLAIN"
27963 .cindex "authentication" "LOGIN"
27964 .cindex "authentication" "DIGEST-MD5"
27965 .cindex "authentication" "CRAM-MD5"
27966 .cindex "authentication" "SCRAM family"
27967 The &(gsasl)& authenticator provides integration for the GNU SASL
27968 library and the mechanisms it provides.  This is new as of the 4.80 release
27969 and there are a few areas where the library does not let Exim smoothly
27970 scale to handle future authentication mechanisms, so no guarantee can be
27971 made that any particular new authentication mechanism will be supported
27972 without code changes in Exim.
27973
27974 The library is expected to add support in an upcoming
27975 realease for the SCRAM-SHA-256 method.
27976 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27977 when this happens.
27978
27979
27980 .option client_authz gsasl string&!! unset
27981 This option can be used to supply an &'authorization id'&
27982 which is different to the &'authentication_id'& provided
27983 by &%client_username%& option.
27984 If unset or (after expansion) empty it is not used,
27985 which is the common case.
27986
27987 .option client_channelbinding gsasl boolean false
27988 See &%server_channelbinding%& below.
27989
27990 .option client_password gsasl string&!! unset
27991 This option is exapanded before use, and should result in
27992 the password to be used, in clear.
27993
27994 .option client_username gsasl string&!! unset
27995 This option is exapanded before use, and should result in
27996 the account name to be used.
27997
27998 .option client_spassword gsasl string&!! unset
27999 If a SCRAM mechanism is being used and this option is set
28000 it is used in preference to &%client_password%&.
28001 The value after expansion should be
28002 a 40 (for SHA-1) or 64 (for SHA-256) character string
28003 with the PBKDF2-prepared password, hex-encoded.
28004 Note that this value will depend on the salt and iteration-count
28005 supplied by the server.
28006
28007
28008
28009 .option server_channelbinding gsasl boolean false
28010 Do not set this true and rely on the properties
28011 without consulting a cryptographic engineer.
28012
28013 Some authentication mechanisms are able to use external context at both ends
28014 of the session to bind the authentication to that context, and fail the
28015 authentication process if that context differs.  Specifically, some TLS
28016 ciphersuites can provide identifying information about the cryptographic
28017 context.
28018
28019 This should have meant that certificate identity and verification becomes a
28020 non-issue, as a man-in-the-middle attack will cause the correct client and
28021 server to see different identifiers and authentication will fail.
28022
28023 This is
28024 only usable by mechanisms which support "channel binding"; at time of
28025 writing, that's the SCRAM family.
28026 When using this feature the "-PLUS" variants of the method names need to be used.
28027
28028 This defaults off to ensure smooth upgrade across Exim releases, in case
28029 this option causes some clients to start failing.  Some future release
28030 of Exim might have switched the default to be true.
28031
28032 However, Channel Binding in TLS has proven to be vulnerable in current versions.
28033 Do not plan to rely upon this feature for security, ever, without consulting
28034 with a subject matter expert (a cryptographic engineer).
28035
28036
28037 .option server_hostname gsasl string&!! "see below"
28038 This option selects the hostname that is used when communicating with the
28039 library. The default value is &`$primary_hostname`&.
28040 Some mechanisms will use this data.
28041
28042
28043 .option server_mech gsasl string "see below"
28044 This option selects the authentication mechanism this driver should use. The
28045 default is the value of the generic &%public_name%& option. This option allows
28046 you to use a different underlying mechanism from the advertised name. For
28047 example:
28048 .code
28049 sasl:
28050   driver = gsasl
28051   public_name = X-ANYTHING
28052   server_mech = CRAM-MD5
28053   server_set_id = $auth1
28054 .endd
28055
28056
28057 .option server_password gsasl string&!! unset
28058 Various mechanisms need access to the cleartext password on the server, so
28059 that proof-of-possession can be demonstrated on the wire, without sending
28060 the password itself.
28061
28062 The data available for lookup varies per mechanism.
28063 In all cases, &$auth1$& is set to the &'authentication id'&.
28064 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28065 if available, else the empty string.
28066 The &$auth3$& variable will always be the &'realm'& if available,
28067 else the empty string.
28068
28069 A forced failure will cause authentication to defer.
28070
28071 If using this option, it may make sense to set the &%server_condition%&
28072 option to be simply "true".
28073
28074
28075 .option server_realm gsasl string&!! unset
28076 This specifies the SASL realm that the server claims to be in.
28077 Some mechanisms will use this data.
28078
28079
28080 .option server_scram_iter gsasl string&!! 4096
28081 This option provides data for the SCRAM family of mechanisms.
28082 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28083 when this option is expanded.
28084
28085 The result of expansion should be a decimal number,
28086 and represents both a lower-bound on the security, and
28087 a compute cost factor imposed on the client
28088 (if it does not cache results, or the server changes
28089 either the iteration count or the salt).
28090 A minimum value of 4096 is required by the standards
28091 for all current SCRAM mechanism variants.
28092
28093 .option server_scram_salt gsasl string&!! unset
28094 This option provides data for the SCRAM family of mechanisms.
28095 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28096 when this option is expanded.
28097 The value should be a base64-encoded string,
28098 of random data typically 4-to-16 bytes long.
28099 If unset or empty after expansion the library will provides a value for the
28100 protocol conversation.
28101
28102
28103 .option server_key gsasl string&!! unset
28104 .option server_skey gsasl string&!! unset
28105 These options can be used for the SCRAM family of mechanisms
28106 to provide stored information related to a password,
28107 the storage of which is preferable to plaintext.
28108
28109 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28110 &%server_skey%& is StoredKey.
28111
28112 They are only available for version 1.9.0 (or later) of the gsasl library.
28113 When this is so, the macros
28114 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28115 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28116 will be defined.
28117
28118 The &$authN$& variables are available when these options are expanded.
28119
28120 If set, the results of expansion should for each
28121 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28122 of base64-coded data, and will be used in preference to the
28123 &%server_password%& option.
28124 If unset or not of the right length, &%server_password%& will be used.
28125
28126 The libgsasl library release includes a utility &'gsasl'& which can be used
28127 to generate these values.
28128
28129
28130 .option server_service gsasl string &`smtp`&
28131 This is the SASL service that the server claims to implement.
28132 Some mechanisms will use this data.
28133
28134
28135 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28136 .vindex "&$auth1$&, &$auth2$&, etc"
28137 These may be set when evaluating specific options, as detailed above.
28138 They will also be set when evaluating &%server_condition%&.
28139
28140 Unless otherwise stated below, the &(gsasl)& integration will use the following
28141 meanings for these variables:
28142
28143 .ilist
28144 .vindex "&$auth1$&"
28145 &$auth1$&: the &'authentication id'&
28146 .next
28147 .vindex "&$auth2$&"
28148 &$auth2$&: the &'authorization id'&
28149 .next
28150 .vindex "&$auth3$&"
28151 &$auth3$&: the &'realm'&
28152 .endlist
28153
28154 On a per-mechanism basis:
28155
28156 .ilist
28157 .cindex "authentication" "EXTERNAL"
28158 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28159 the &%server_condition%& option must be present.
28160 .next
28161 .cindex "authentication" "ANONYMOUS"
28162 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28163 the &%server_condition%& option must be present.
28164 .next
28165 .cindex "authentication" "GSSAPI"
28166 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28167 &$auth2$& will be set to the &'authorization id'&,
28168 the &%server_condition%& option must be present.
28169 .endlist
28170
28171 An &'anonymous token'& is something passed along as an unauthenticated
28172 identifier; this is analogous to FTP anonymous authentication passing an
28173 email address, or software-identifier@, as the "password".
28174
28175
28176 An example showing the password having the realm specified in the callback
28177 and demonstrating a Cyrus SASL to GSASL migration approach is:
28178 .code
28179 gsasl_cyrusless_crammd5:
28180   driver = gsasl
28181   public_name = CRAM-MD5
28182   server_realm = imap.example.org
28183   server_password = ${lookup{$auth1:$auth3:userPassword}\
28184                     dbmjz{/etc/sasldb2}{$value}fail}
28185   server_set_id = ${quote:$auth1}
28186   server_condition = yes
28187 .endd
28188
28189
28190 . ////////////////////////////////////////////////////////////////////////////
28191 . ////////////////////////////////////////////////////////////////////////////
28192
28193 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28194 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28195 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28196 .cindex "authentication" "GSSAPI"
28197 .cindex "authentication" "Kerberos"
28198 The &(heimdal_gssapi)& authenticator provides server integration for the
28199 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28200 reliably.
28201
28202 .option server_hostname heimdal_gssapi string&!! "see below"
28203 This option selects the hostname that is used, with &%server_service%&,
28204 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28205 identifier.  The default value is &`$primary_hostname`&.
28206
28207 .option server_keytab heimdal_gssapi string&!! unset
28208 If set, then Heimdal will not use the system default keytab (typically
28209 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28210 The value should be a pathname, with no &"file:"& prefix.
28211
28212 .option server_service heimdal_gssapi string&!! "smtp"
28213 This option specifies the service identifier used, in conjunction with
28214 &%server_hostname%&, for building the identifier for finding credentials
28215 from the keytab.
28216
28217
28218 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28219 Beware that these variables will typically include a realm, thus will appear
28220 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28221 not verified, so a malicious client can set it to anything.
28222
28223 The &$auth1$& field should be safely trustable as a value from the Key
28224 Distribution Center.  Note that these are not quite email addresses.
28225 Each identifier is for a role, and so the left-hand-side may include a
28226 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28227
28228 .vindex "&$auth1$&, &$auth2$&, etc"
28229 .ilist
28230 .vindex "&$auth1$&"
28231 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28232 .next
28233 .vindex "&$auth2$&"
28234 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28235 authentication.  If that was empty, this will also be set to the
28236 GSS Display Name.
28237 .endlist
28238
28239
28240 . ////////////////////////////////////////////////////////////////////////////
28241 . ////////////////////////////////////////////////////////////////////////////
28242
28243 .chapter "The spa authenticator" "CHAPspa"
28244 .scindex IIDspaauth1 "&(spa)& authenticator"
28245 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28246 .cindex "authentication" "Microsoft Secure Password"
28247 .cindex "authentication" "NTLM"
28248 .cindex "Microsoft Secure Password Authentication"
28249 .cindex "NTLM authentication"
28250 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28251 Password Authentication'& mechanism,
28252 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28253 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28254 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28255 server side was subsequently contributed by Tom Kistner. The mechanism works as
28256 follows:
28257
28258 .ilist
28259 After the AUTH command has been accepted, the client sends an SPA
28260 authentication request based on the user name and optional domain.
28261 .next
28262 The server sends back a challenge.
28263 .next
28264 The client builds a challenge response which makes use of the user's password
28265 and sends it to the server, which then accepts or rejects it.
28266 .endlist
28267
28268 Encryption is used to protect the password in transit.
28269
28270
28271
28272 .section "Using spa as a server" "SECID179"
28273 .cindex "options" "&(spa)& authenticator (server)"
28274 The &(spa)& authenticator has just one server option:
28275
28276 .option server_password spa string&!! unset
28277 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28278 This option is expanded, and the result must be the cleartext password for the
28279 authenticating user, whose name is at this point in &$auth1$&. For
28280 compatibility with previous releases of Exim, the user name is also placed in
28281 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28282 it can lead to confusion in string expansions that also use numeric variables
28283 for other things. For example:
28284 .code
28285 spa:
28286   driver = spa
28287   public_name = NTLM
28288   server_password = \
28289     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28290 .endd
28291 If the expansion is forced to fail, authentication fails. Any other expansion
28292 failure causes a temporary error code to be returned.
28293
28294
28295
28296
28297
28298 .section "Using spa as a client" "SECID180"
28299 .cindex "options" "&(spa)& authenticator (client)"
28300 The &(spa)& authenticator has the following client options:
28301
28302
28303
28304 .option client_domain spa string&!! unset
28305 This option specifies an optional domain for the authentication.
28306
28307
28308 .option client_password spa string&!! unset
28309 This option specifies the user's password, and must be set.
28310
28311
28312 .option client_username spa string&!! unset
28313 This option specifies the user name, and must be set. Here is an example of a
28314 configuration of this authenticator for use with the mail servers at
28315 &'msn.com'&:
28316 .code
28317 msn:
28318   driver = spa
28319   public_name = MSN
28320   client_username = msn/msn_username
28321   client_password = msn_plaintext_password
28322   client_domain = DOMAIN_OR_UNSET
28323 .endd
28324 .ecindex IIDspaauth1
28325 .ecindex IIDspaauth2
28326
28327
28328
28329
28330
28331 . ////////////////////////////////////////////////////////////////////////////
28332 . ////////////////////////////////////////////////////////////////////////////
28333
28334 .chapter "The external authenticator" "CHAPexternauth"
28335 .scindex IIDexternauth1 "&(external)& authenticator"
28336 .scindex IIDexternauth2 "authenticators" "&(external)&"
28337 .cindex "authentication" "Client Certificate"
28338 .cindex "authentication" "X509"
28339 .cindex "Certificate-based authentication"
28340 The &(external)& authenticator provides support for
28341 authentication based on non-SMTP information.
28342 The specification is in RFC 4422 Appendix A
28343 (&url(https://tools.ietf.org/html/rfc4422)).
28344 It is only a transport and negotiation mechanism;
28345 the process of authentication is entirely controlled
28346 by the server configuration.
28347
28348 The client presents an identity in-clear.
28349 It is probably wise for a server to only advertise,
28350 and for clients to only attempt,
28351 this authentication method on a secure (eg. under TLS) connection.
28352
28353 One possible use, compatible with the
28354 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
28355 is for using X509 client certificates.
28356
28357 It thus overlaps in function with the TLS authenticator
28358 (see &<<CHAPtlsauth>>&)
28359 but is a full SMTP SASL authenticator
28360 rather than being implicit for TLS-connection carried
28361 client certificates only.
28362
28363 The examples and discussion in this chapter assume that
28364 client-certificate authentication is being done.
28365
28366 The client must present a certificate,
28367 for which it must have been requested via the
28368 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28369 (see &<<CHAPTLS>>&).
28370 For authentication to be effective the certificate should be
28371 verifiable against a trust-anchor certificate known to the server.
28372
28373 .section "External options" "SECTexternsoptions"
28374 .cindex "options" "&(external)& authenticator (server)"
28375 The &(external)& authenticator has two server options:
28376
28377 .option server_param2 external string&!! unset
28378 .option server_param3 external string&!! unset
28379 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28380 These options are expanded before the &%server_condition%& option
28381 and the result are placed in &$auth2$& and &$auth3$& resectively.
28382 If the expansion is forced to fail, authentication fails. Any other expansion
28383 failure causes a temporary error code to be returned.
28384
28385 They can be used to clarify the coding of a complex &%server_condition%&.
28386
28387 .section "Using external in a server" "SECTexternserver"
28388 .cindex "AUTH" "in &(external)& authenticator"
28389 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28390         "in &(external)& authenticator"
28391 .vindex "&$auth1$&, &$auth2$&, etc"
28392 .cindex "base64 encoding" "in &(external)& authenticator"
28393
28394 When running as a server, &(external)& performs the authentication test by
28395 expanding a string. The data sent by the client with the AUTH command, or in
28396 response to subsequent prompts, is base64 encoded, and so may contain any byte
28397 values when decoded. The decoded value is treated as
28398 an identity for authentication and
28399 placed in the expansion variable &$auth1$&.
28400
28401 For compatibility with previous releases of Exim, the value is also placed in
28402 the expansion variable &$1$&. However, the use of this
28403 variable for this purpose is now deprecated, as it can lead to confusion in
28404 string expansions that also use them for other things.
28405
28406 .vindex "&$authenticated_id$&"
28407 Once an identity has been received,
28408 &%server_condition%& is expanded. If the expansion is forced to fail,
28409 authentication fails. Any other expansion failure causes a temporary error code
28410 to be returned. If the result of a successful expansion is an empty string,
28411 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28412 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28413 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28414 For any other result, a temporary error code is returned, with the expanded
28415 string as the error text.
28416
28417 Example:
28418 .code
28419 ext_ccert_san_mail:
28420   driver =            external
28421   public_name =       EXTERNAL
28422
28423   server_advertise_condition = $tls_in_certificate_verified
28424   server_param2 =     ${certextract {subj_altname,mail,>:} \
28425                                     {$tls_in_peercert}}
28426   server_condition =  ${if forany {$auth2} \
28427                             {eq {$item}{$auth1}}}
28428   server_set_id =     $auth1
28429 .endd
28430 This accepts a client certificate that is verifiable against any
28431 of your configured trust-anchors
28432 (which usually means the full set of public CAs)
28433 and which has a mail-SAN matching the claimed identity sent by the client.
28434
28435 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28436 The account name is therefore guessable by an opponent.
28437 TLS 1.3 protects both server and client certificates, and is not vulnerable
28438 in this way.
28439
28440
28441 .section "Using external in a client" "SECTexternclient"
28442 .cindex "options" "&(external)& authenticator (client)"
28443 The &(external)& authenticator has one client option:
28444
28445 .option client_send external string&!! unset
28446 This option is expanded and sent with the AUTH command as the
28447 identity being asserted.
28448
28449 Example:
28450 .code
28451 ext_ccert:
28452   driver =      external
28453   public_name = EXTERNAL
28454
28455   client_condition = ${if !eq{$tls_out_cipher}{}}
28456   client_send = myaccount@smarthost.example.net
28457 .endd
28458
28459
28460 .ecindex IIDexternauth1
28461 .ecindex IIDexternauth2
28462
28463
28464
28465
28466
28467 . ////////////////////////////////////////////////////////////////////////////
28468 . ////////////////////////////////////////////////////////////////////////////
28469
28470 .chapter "The tls authenticator" "CHAPtlsauth"
28471 .scindex IIDtlsauth1 "&(tls)& authenticator"
28472 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28473 .cindex "authentication" "Client Certificate"
28474 .cindex "authentication" "X509"
28475 .cindex "Certificate-based authentication"
28476 The &(tls)& authenticator provides server support for
28477 authentication based on client certificates.
28478
28479 It is not an SMTP authentication mechanism and is not
28480 advertised by the server as part of the SMTP EHLO response.
28481 It is an Exim authenticator in the sense that it affects
28482 the protocol element of the log line, can be tested for
28483 by the &%authenticated%& ACL condition, and can set
28484 the &$authenticated_id$& variable.
28485
28486 The client must present a verifiable certificate,
28487 for which it must have been requested via the
28488 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28489 (see &<<CHAPTLS>>&).
28490
28491 If an authenticator of this type is configured it is
28492 run before any SMTP-level communication is done,
28493 and can authenticate the connection.
28494 If it does, SMTP authentication is not offered.
28495
28496 A maximum of one authenticator of this type may be present.
28497
28498
28499 .cindex "options" "&(tls)& authenticator (server)"
28500 The &(tls)& authenticator has three server options:
28501
28502 .option server_param1 tls string&!! unset
28503 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28504 This option is expanded after the TLS negotiation and
28505 the result is placed in &$auth1$&.
28506 If the expansion is forced to fail, authentication fails. Any other expansion
28507 failure causes a temporary error code to be returned.
28508
28509 .option server_param2 tls string&!! unset
28510 .option server_param3 tls string&!! unset
28511 As above, for &$auth2$& and &$auth3$&.
28512
28513 &%server_param1%& may also be spelled &%server_param%&.
28514
28515
28516 Example:
28517 .code
28518 tls:
28519   driver = tls
28520   server_param1 =     ${certextract {subj_altname,mail,>:} \
28521                                     {$tls_in_peercert}}
28522   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28523                                  {forany {$auth1} \
28524                             {!= {0} \
28525                                 {${lookup ldap{ldap:///\
28526                          mailname=${quote_ldap_dn:${lc:$item}},\
28527                          ou=users,LDAP_DC?mailid} {$value}{0} \
28528                        }    }  } }}}
28529   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28530 .endd
28531 This accepts a client certificate that is verifiable against any
28532 of your configured trust-anchors
28533 (which usually means the full set of public CAs)
28534 and which has a SAN with a good account name.
28535
28536 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28537 The account name is therefore guessable by an opponent.
28538 TLS 1.3 protects both server and client certificates, and is not vulnerable
28539 in this way.
28540 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28541
28542 . An alternative might use
28543 . .code
28544 .   server_param1 = ${sha256:$tls_in_peercert}
28545 . .endd
28546 . to require one of a set of specific certs that define a given account
28547 . (the verification is still required, but mostly irrelevant).
28548 . This would help for per-device use.
28549 .
28550 . However, for the future we really need support for checking a
28551 . user cert in LDAP - which probably wants a base-64 DER.
28552
28553 .ecindex IIDtlsauth1
28554 .ecindex IIDtlsauth2
28555
28556
28557 Note that because authentication is traditionally an SMTP operation,
28558 the &%authenticated%& ACL condition cannot be used in
28559 a connect- or helo-ACL.
28560
28561
28562
28563 . ////////////////////////////////////////////////////////////////////////////
28564 . ////////////////////////////////////////////////////////////////////////////
28565
28566 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28567          "Encrypted SMTP connections"
28568 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28569 .scindex IIDencsmtp2 "SMTP" "encryption"
28570 .cindex "TLS" "on SMTP connection"
28571 .cindex "OpenSSL"
28572 .cindex "GnuTLS"
28573 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28574 Sockets Layer), is implemented by making use of the OpenSSL library or the
28575 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28576 cryptographic code in the Exim distribution itself for implementing TLS. In
28577 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28578 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28579 You also need to understand the basic concepts of encryption at a managerial
28580 level, and in particular, the way that public keys, private keys, and
28581 certificates are used.
28582
28583 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28584 connection is established, the client issues a STARTTLS command. If the
28585 server accepts this, the client and the server negotiate an encryption
28586 mechanism. If the negotiation succeeds, the data that subsequently passes
28587 between them is encrypted.
28588
28589 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28590 and if so, what cipher suite is in use, whether the client supplied a
28591 certificate, and whether or not that certificate was verified. This makes it
28592 possible for an Exim server to deny or accept certain commands based on the
28593 encryption state.
28594
28595 &*Warning*&: Certain types of firewall and certain anti-virus products can
28596 disrupt TLS connections. You need to turn off SMTP scanning for these products
28597 in order to get TLS to work.
28598
28599
28600
28601 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28602          "SECID284"
28603 .cindex "submissions protocol"
28604 .cindex "ssmtp protocol"
28605 .cindex "smtps protocol"
28606 .cindex "SMTP" "submissions protocol"
28607 .cindex "SMTP" "ssmtp protocol"
28608 .cindex "SMTP" "smtps protocol"
28609 The history of port numbers for TLS in SMTP is a little messy and has been
28610 contentious.  As of RFC 8314, the common practice of using the historically
28611 allocated port 465 for "email submission but with TLS immediately upon connect
28612 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28613 by them in preference to STARTTLS.
28614
28615 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28616 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28617 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28618
28619 This approach was, for a while, officially abandoned when encrypted SMTP was
28620 standardized, but many clients kept using it, even as the TCP port number was
28621 reassigned for other use.
28622 Thus you may encounter guidance claiming that you shouldn't enable use of
28623 this port.
28624 In practice, a number of mail-clients have only ever supported submissions,
28625 not submission with STARTTLS upgrade.
28626 Ideally, offer both submission (587) and submissions (465) service.
28627
28628 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28629 global option. Its value must be a list of port numbers;
28630 the most common use is expected to be:
28631 .code
28632 tls_on_connect_ports = 465
28633 .endd
28634 The port numbers specified by this option apply to all SMTP connections, both
28635 via the daemon and via &'inetd'&. You still need to specify all the ports that
28636 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28637 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28638 an extra port &-- rather, it specifies different behaviour on a port that is
28639 defined elsewhere.
28640
28641 There is also a &%-tls-on-connect%& command line option. This overrides
28642 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28643
28644
28645
28646
28647
28648
28649 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28650 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28651 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28652 To build Exim to use OpenSSL you need to set
28653 .code
28654 USE_OPENSSL=yes
28655 .endd
28656 in Local/Makefile.
28657
28658 To build Exim to use GnuTLS, you need to set
28659 .code
28660 USE_GNUTLS=yes
28661 .endd
28662 in Local/Makefile.
28663
28664 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28665 include files and libraries for GnuTLS can be found.
28666
28667 There are some differences in usage when using GnuTLS instead of OpenSSL:
28668
28669 .ilist
28670 The &%tls_verify_certificates%& option
28671 cannot be the path of a directory
28672 for GnuTLS versions before 3.3.6
28673 (for later versions, or OpenSSL, it can be either).
28674 .next
28675 The default value for &%tls_dhparam%& differs for historical reasons.
28676 .next
28677 .vindex "&$tls_in_peerdn$&"
28678 .vindex "&$tls_out_peerdn$&"
28679 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28680 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28681 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28682 .next
28683 OpenSSL identifies cipher suites using hyphens as separators, for example:
28684 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28685 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28686 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28687 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28688 to handle its own older variants) when processing lists of cipher suites in the
28689 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28690 option).
28691 .next
28692 The &%tls_require_ciphers%& options operate differently, as described in the
28693 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28694 .next
28695 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28696 When using OpenSSL, this option is ignored.
28697 (If an API is found to let OpenSSL be configured in this way,
28698 let the Exim Maintainers know and we'll likely use it).
28699 .next
28700 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28701 main option, it must be ordered to match the &%tls_certificate%& list.
28702 .next
28703 Some other recently added features may only be available in one or the other.
28704 This should be documented with the feature.  If the documentation does not
28705 explicitly state that the feature is infeasible in the other TLS
28706 implementation, then patches are welcome.
28707 .endlist
28708
28709
28710 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28711 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28712 an explicit path; if the latter, then the text about generation still applies,
28713 but not the chosen filename.
28714 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28715 See the documentation of &%tls_dhparam%& for more information.
28716
28717 GnuTLS uses D-H parameters that may take a substantial amount of time
28718 to compute. It is unreasonable to re-compute them for every TLS session.
28719 Therefore, Exim keeps this data in a file in its spool directory, called
28720 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28721 of bits requested.
28722 The file is owned by the Exim user and is readable only by
28723 its owner. Every Exim process that start up GnuTLS reads the D-H
28724 parameters from this file. If the file does not exist, the first Exim process
28725 that needs it computes the data and writes it to a temporary file which is
28726 renamed once it is complete. It does not matter if several Exim processes do
28727 this simultaneously (apart from wasting a few resources). Once a file is in
28728 place, new Exim processes immediately start using it.
28729
28730 For maximum security, the parameters that are stored in this file should be
28731 recalculated periodically, the frequency depending on your paranoia level.
28732 If you are avoiding using the fixed D-H primes published in RFCs, then you
28733 are concerned about some advanced attacks and will wish to do this; if you do
28734 not regenerate then you might as well stick to the standard primes.
28735
28736 Arranging this is easy in principle; just delete the file when you want new
28737 values to be computed. However, there may be a problem. The calculation of new
28738 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28739 If the system is not very active, &_/dev/random_& may delay returning data
28740 until enough randomness (entropy) is available. This may cause Exim to hang for
28741 a substantial amount of time, causing timeouts on incoming connections.
28742
28743 The solution is to generate the parameters externally to Exim. They are stored
28744 in &_gnutls-params-N_& in PEM format, which means that they can be
28745 generated externally using the &(certtool)& command that is part of GnuTLS.
28746
28747 To replace the parameters with new ones, instead of deleting the file
28748 and letting Exim re-create it, you can generate new parameters using
28749 &(certtool)& and, when this has been done, replace Exim's cache file by
28750 renaming. The relevant commands are something like this:
28751 .code
28752 # ls
28753 [ look for file; assume gnutls-params-2236 is the most recent ]
28754 # rm -f new-params
28755 # touch new-params
28756 # chown exim:exim new-params
28757 # chmod 0600 new-params
28758 # certtool --generate-dh-params --bits 2236 >>new-params
28759 # openssl dhparam -noout -text -in new-params | head
28760 [ check the first line, make sure it's not more than 2236;
28761   if it is, then go back to the start ("rm") and repeat
28762   until the size generated is at most the size requested ]
28763 # chmod 0400 new-params
28764 # mv new-params gnutls-params-2236
28765 .endd
28766 If Exim never has to generate the parameters itself, the possibility of
28767 stalling is removed.
28768
28769 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28770 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28771 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28772 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28773 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28774 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28775 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28776 which applies to all D-H usage, client or server.  If the value returned by
28777 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28778 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28779 limit, which is still much higher than Exim historically used.
28780
28781 The filename and bits used will change as the GnuTLS maintainers change the
28782 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28783 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28784 2432 bits, while NSS is limited to 2236 bits.
28785
28786 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28787 increase the chance of the generated prime actually being within acceptable
28788 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28789 procedure above.  There is no sane procedure available to Exim to double-check
28790 the size of the generated prime, so it might still be too large.
28791
28792
28793 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28794 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28795 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28796 There is a function in the OpenSSL library that can be passed a list of cipher
28797 suites before the cipher negotiation takes place. This specifies which ciphers
28798 are acceptable for TLS versions prior to 1.3.
28799 The list is colon separated and may contain names like
28800 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28801 directly to this function call.
28802 Many systems will install the OpenSSL manual-pages, so you may have
28803 &'ciphers(1)'& available to you.
28804 The following quotation from the OpenSSL
28805 documentation specifies what forms of item are allowed in the cipher string:
28806
28807 .ilist
28808 It can consist of a single cipher suite such as RC4-SHA.
28809 .next
28810 It can represent a list of cipher suites containing a certain algorithm,
28811 or cipher suites of a certain type. For example SHA1 represents all
28812 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28813 SSL v3 algorithms.
28814 .next
28815 Lists of cipher suites can be combined in a single cipher string using
28816 the + character. This is used as a logical and operation. For example
28817 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28818 algorithms.
28819 .endlist
28820
28821 Each cipher string can be optionally preceded by one of the characters &`!`&,
28822 &`-`& or &`+`&.
28823 .ilist
28824 If &`!`& is used, the ciphers are permanently deleted from the list. The
28825 ciphers deleted can never reappear in the list even if they are explicitly
28826 stated.
28827 .next
28828 If &`-`& is used, the ciphers are deleted from the list, but some or all
28829 of the ciphers can be added again by later options.
28830 .next
28831 If &`+`& is used, the ciphers are moved to the end of the list. This
28832 option does not add any new ciphers; it just moves matching existing ones.
28833 .endlist
28834
28835 If none of these characters is present, the string is interpreted as
28836 a list of ciphers to be appended to the current preference list. If the list
28837 includes any ciphers already present they will be ignored: that is, they will
28838 not be moved to the end of the list.
28839 .endlist
28840
28841 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28842 string:
28843 .code
28844 # note single-quotes to get ! past any shell history expansion
28845 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28846 .endd
28847
28848 This example will let the library defaults be permitted on the MX port, where
28849 there's probably no identity verification anyway, but ups the ante on the
28850 submission ports where the administrator might have some influence on the
28851 choice of clients used:
28852 .code
28853 # OpenSSL variant; see man ciphers(1)
28854 tls_require_ciphers = ${if =={$received_port}{25}\
28855                            {DEFAULT}\
28856                            {HIGH:!MD5:!SHA1}}
28857 .endd
28858
28859 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28860 .code
28861 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28862 .endd
28863
28864 For TLS version 1.3 the control available is less fine-grained
28865 and Exim does not provide access to it at present.
28866 The value of the &%tls_require_ciphers%& option is ignored when
28867 TLS version 1.3 is negotiated.
28868
28869 As of writing the library default cipher suite list for TLSv1.3 is
28870 .code
28871 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28872 .endd
28873
28874
28875 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28876          "SECTreqciphgnu"
28877 .cindex "GnuTLS" "specifying parameters for"
28878 .cindex "TLS" "specifying ciphers (GnuTLS)"
28879 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28880 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28881 .cindex "TLS" "specifying protocols (GnuTLS)"
28882 .cindex "TLS" "specifying priority string (GnuTLS)"
28883 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28884 The GnuTLS library allows the caller to provide a "priority string", documented
28885 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28886 ciphersuite specification in OpenSSL.
28887
28888 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28889 and controls both protocols and ciphers.
28890
28891 The &%tls_require_ciphers%& option is available both as an global option,
28892 controlling how Exim behaves as a server, and also as an option of the
28893 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28894 the value is string expanded.  The resulting string is not an Exim list and
28895 the string is given to the GnuTLS library, so that Exim does not need to be
28896 aware of future feature enhancements of GnuTLS.
28897
28898 Documentation of the strings accepted may be found in the GnuTLS manual, under
28899 "Priority strings".  This is online as
28900 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28901 but beware that this relates to GnuTLS 3, which may be newer than the version
28902 installed on your system.  If you are using GnuTLS 3,
28903 then the example code
28904 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28905 on that site can be used to test a given string.
28906
28907 For example:
28908 .code
28909 # Disable older versions of protocols
28910 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28911 .endd
28912
28913 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28914 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28915 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28916
28917 This example will let the library defaults be permitted on the MX port, where
28918 there's probably no identity verification anyway, and lowers security further
28919 by increasing compatibility; but this ups the ante on the submission ports
28920 where the administrator might have some influence on the choice of clients
28921 used:
28922 .code
28923 # GnuTLS variant
28924 tls_require_ciphers = ${if =={$received_port}{25}\
28925                            {NORMAL:%COMPAT}\
28926                            {SECURE128}}
28927 .endd
28928
28929
28930 .section "Configuring an Exim server to use TLS" "SECID182"
28931 .cindex "TLS" "configuring an Exim server"
28932 .cindex "ESMTP extensions" STARTTLS
28933 When Exim has been built with TLS support, it advertises the availability of
28934 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28935 but not to any others. The default value of this option is *, which means
28936 that STARTTLS is always advertised.  Set it to blank to never advertise;
28937 this is reasonable for systems that want to use TLS only as a client.
28938
28939 If STARTTLS is to be used you
28940 need to set some other options in order to make TLS available.
28941
28942 If a client issues a STARTTLS command and there is some configuration
28943 problem in the server, the command is rejected with a 454 error. If the client
28944 persists in trying to issue SMTP commands, all except QUIT are rejected
28945 with the error
28946 .code
28947 554 Security failure
28948 .endd
28949 If a STARTTLS command is issued within an existing TLS session, it is
28950 rejected with a 554 error code.
28951
28952 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28953 must be set to match some hosts. The default is * which matches all hosts.
28954
28955 If this is all you do, TLS encryption will be enabled but not authentication -
28956 meaning that the peer has no assurance it is actually you he is talking to.
28957 You gain protection from a passive sniffer listening on the wire but not
28958 from someone able to intercept the communication.
28959
28960 Further protection requires some further configuration at the server end.
28961
28962 To make TLS work you need to set, in the server,
28963 .code
28964 tls_certificate = /some/file/name
28965 tls_privatekey = /some/file/name
28966 .endd
28967 These options are, in fact, expanded strings, so you can make them depend on
28968 the identity of the client that is connected if you wish. The first file
28969 contains the server's X509 certificate, and the second contains the private key
28970 that goes with it. These files need to be
28971 PEM format and readable by the Exim user, and must
28972 always be given as full path names.
28973 The key must not be password-protected.
28974 They can be the same file if both the
28975 certificate and the key are contained within it. If &%tls_privatekey%& is not
28976 set, or if its expansion is forced to fail or results in an empty string, this
28977 is assumed to be the case. The certificate file may also contain intermediate
28978 certificates that need to be sent to the client to enable it to authenticate
28979 the server's certificate.
28980
28981 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28982 colon-separated lists of file paths.  Ciphers using given authentication
28983 algorithms require the presence of a suitable certificate to supply the
28984 public-key.  The server selects among the certificates to present to the
28985 client depending on the selected cipher, hence the priority ordering for
28986 ciphers will affect which certificate is used.
28987
28988 If you do not understand about certificates and keys, please try to find a
28989 source of this background information, which is not Exim-specific. (There are a
28990 few comments below in section &<<SECTcerandall>>&.)
28991
28992 &*Note*&: These options do not apply when Exim is operating as a client &--
28993 they apply only in the case of a server. If you need to use a certificate in an
28994 Exim client, you must set the options of the same names in an &(smtp)&
28995 transport.
28996
28997 With just these options, an Exim server will be able to use TLS. It does not
28998 require the client to have a certificate (but see below for how to insist on
28999 this). There is one other option that may be needed in other situations. If
29000 .code
29001 tls_dhparam = /some/file/name
29002 .endd
29003 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29004 with the parameters contained in the file.
29005 Set this to &`none`& to disable use of DH entirely, by making no prime
29006 available:
29007 .code
29008 tls_dhparam = none
29009 .endd
29010 This may also be set to a string identifying a standard prime to be used for
29011 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29012 used is &`ike23`&.  There are a few standard primes available, see the
29013 documentation for &%tls_dhparam%& for the complete list.
29014
29015 See the command
29016 .code
29017 openssl dhparam
29018 .endd
29019 for a way of generating file data.
29020
29021 The strings supplied for these three options are expanded every time a client
29022 host connects. It is therefore possible to use different certificates and keys
29023 for different hosts, if you so wish, by making use of the client's IP address
29024 in &$sender_host_address$& to control the expansion. If a string expansion is
29025 forced to fail, Exim behaves as if the option is not set.
29026
29027 .cindex "cipher" "logging"
29028 .cindex "log" "TLS cipher"
29029 .vindex "&$tls_in_cipher$&"
29030 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29031 an incoming TLS connection. It is included in the &'Received:'& header of an
29032 incoming message (by default &-- you can, of course, change this), and it is
29033 also included in the log line that records a message's arrival, keyed by
29034 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29035 condition can be used to test for specific cipher suites in ACLs.
29036
29037 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29038 can check the name of the cipher suite and vary their actions accordingly. The
29039 cipher suite names vary, depending on which TLS library is being used. For
29040 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29041 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29042 documentation for more details.
29043
29044 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29045 (again depending on the &%tls_cipher%& log selector).
29046
29047
29048 .section "Requesting and verifying client certificates" "SECID183"
29049 .cindex "certificate" "verification of client"
29050 .cindex "TLS" "client certificate verification"
29051 If you want an Exim server to request a certificate when negotiating a TLS
29052 session with a client, you must set either &%tls_verify_hosts%& or
29053 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29054 apply to all TLS connections. For any host that matches one of these options,
29055 Exim requests a certificate as part of the setup of the TLS session. The
29056 contents of the certificate are verified by comparing it with a list of
29057 expected trust-anchors or certificates.
29058 These may be the system default set (depending on library version),
29059 an explicit file or,
29060 depending on library version, a directory, identified by
29061 &%tls_verify_certificates%&.
29062
29063 A file can contain multiple certificates, concatenated end to end. If a
29064 directory is used
29065 (OpenSSL only),
29066 each certificate must be in a separate file, with a name (or a symbolic link)
29067 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29068 certificate. You can compute the relevant hash by running the command
29069 .code
29070 openssl x509 -hash -noout -in /cert/file
29071 .endd
29072 where &_/cert/file_& contains a single certificate.
29073
29074 There is no checking of names of the client against the certificate
29075 Subject Name or Subject Alternate Names.
29076
29077 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29078 what happens if the client does not supply a certificate, or if the certificate
29079 does not match any of the certificates in the collection named by
29080 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29081 attempt to set up a TLS session is aborted, and the incoming connection is
29082 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29083 session continues. ACLs that run for subsequent SMTP commands can detect the
29084 fact that no certificate was verified, and vary their actions accordingly. For
29085 example, you can insist on a certificate before accepting a message for
29086 relaying, but not when the message is destined for local delivery.
29087
29088 .vindex "&$tls_in_peerdn$&"
29089 When a client supplies a certificate (whether it verifies or not), the value of
29090 the Distinguished Name of the certificate is made available in the variable
29091 &$tls_in_peerdn$& during subsequent processing of the message.
29092
29093 .cindex "log" "distinguished name"
29094 Because it is often a long text string, it is not included in the log line or
29095 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29096 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29097 &%received_header_text%& to change the &'Received:'& header. When no
29098 certificate is supplied, &$tls_in_peerdn$& is empty.
29099
29100
29101 .section "Revoked certificates" "SECID184"
29102 .cindex "TLS" "revoked certificates"
29103 .cindex "revocation list"
29104 .cindex "certificate" "revocation list"
29105 .cindex "OCSP" "stapling"
29106 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29107 certificates are revoked. If you have such a list, you can pass it to an Exim
29108 server using the global option called &%tls_crl%& and to an Exim client using
29109 an identically named option for the &(smtp)& transport. In each case, the value
29110 of the option is expanded and must then be the name of a file that contains a
29111 CRL in PEM format.
29112 The downside is that clients have to periodically re-download a potentially huge
29113 file from every certificate authority they know of.
29114
29115 The way with most moving parts at query time is Online Certificate
29116 Status Protocol (OCSP), where the client verifies the certificate
29117 against an OCSP server run by the CA.  This lets the CA track all
29118 usage of the certs.  It requires running software with access to the
29119 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29120 is based on HTTP and can be proxied accordingly.
29121
29122 The only widespread OCSP server implementation (known to this writer)
29123 comes as part of OpenSSL and aborts on an invalid request, such as
29124 connecting to the port and then disconnecting.  This requires
29125 re-entering the passphrase each time some random client does this.
29126
29127 The third way is OCSP Stapling; in this, the server using a certificate
29128 issued by the CA periodically requests an OCSP proof of validity from
29129 the OCSP server, then serves it up inline as part of the TLS
29130 negotiation.   This approach adds no extra round trips, does not let the
29131 CA track users, scales well with number of certs issued by the CA and is
29132 resilient to temporary OCSP server failures, as long as the server
29133 starts retrying to fetch an OCSP proof some time before its current
29134 proof expires.  The downside is that it requires server support.
29135
29136 Unless Exim is built with the support disabled,
29137 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29138 support for OCSP stapling is included.
29139
29140 There is a global option called &%tls_ocsp_file%&.
29141 The file specified therein is expected to be in DER format, and contain
29142 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29143 option will be re-expanded for SNI, if the &%tls_certificate%& option
29144 contains &`tls_in_sni`&, as per other TLS options.
29145
29146 Exim does not at this time implement any support for fetching a new OCSP
29147 proof.  The burden is on the administrator to handle this, outside of
29148 Exim.  The file specified should be replaced atomically, so that the
29149 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29150 on each connection, so a new file will be handled transparently on the
29151 next connection.
29152
29153 When built with OpenSSL Exim will check for a valid next update timestamp
29154 in the OCSP proof; if not present, or if the proof has expired, it will be
29155 ignored.
29156
29157 For the client to be able to verify the stapled OCSP the server must
29158 also supply, in its stapled information, any intermediate
29159 certificates for the chain leading to the OCSP proof from the signer
29160 of the server certificate.  There may be zero or one such. These
29161 intermediate certificates should be added to the server OCSP stapling
29162 file named by &%tls_ocsp_file%&.
29163
29164 Note that the proof only covers the terminal server certificate,
29165 not any of the chain from CA to it.
29166
29167 There is no current way to staple a proof for a client certificate.
29168
29169 .code
29170   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29171   OCSP server is supplied.  The server URL may be included in the
29172   server certificate, if the CA is helpful.
29173
29174   One failure mode seen was the OCSP Signer cert expiring before the end
29175   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29176   noted this as invalid overall, but the re-fetch script did not.
29177 .endd
29178
29179
29180
29181
29182 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29183 .cindex "cipher" "logging"
29184 .cindex "log" "TLS cipher"
29185 .cindex "log" "distinguished name"
29186 .cindex "TLS" "configuring an Exim client"
29187 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29188 deliveries as well as to incoming, the latter one causing logging of the
29189 server certificate's DN. The remaining client configuration for TLS is all
29190 within the &(smtp)& transport.
29191
29192 .cindex "ESMTP extensions" STARTTLS
29193 It is not necessary to set any options to have TLS work in the &(smtp)&
29194 transport. If Exim is built with TLS support, and TLS is advertised by a
29195 server, the &(smtp)& transport always tries to start a TLS session. However,
29196 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29197 transport) to a list of server hosts for which TLS should not be used.
29198
29199 If you do not want Exim to attempt to send messages unencrypted when an attempt
29200 to set up an encrypted connection fails in any way, you can set
29201 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29202 those hosts, delivery is always deferred if an encrypted connection cannot be
29203 set up. If there are any other hosts for the address, they are tried in the
29204 usual way.
29205
29206 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29207 the message unencrypted. It always does this if the response to STARTTLS is
29208 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29209 session after a success response code, what happens is controlled by the
29210 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29211 delivery to this host is deferred, and other hosts (if available) are tried. If
29212 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29213 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29214 negotiation fails, Exim closes the current connection (because it is in an
29215 unknown state), opens a new one to the same host, and then tries the delivery
29216 unencrypted.
29217
29218 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29219 transport provide the client with a certificate, which is passed to the server
29220 if it requests it. If the server is Exim, it will request a certificate only if
29221 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29222
29223 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29224 for client use (they are usable for server use).
29225 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29226 in failed connections.
29227
29228 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29229 specifies a collection of expected server certificates.
29230 These may be
29231 the system default set (depending on library version),
29232 a file,
29233 or (depending on library version) a directory.
29234 The client verifies the server's certificate
29235 against this collection, taking into account any revoked certificates that are
29236 in the list defined by &%tls_crl%&.
29237 Failure to verify fails the TLS connection unless either of the
29238 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29239
29240 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29241 certificate verification to the listed servers.  Verification either must
29242 or need not succeed respectively.
29243
29244 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29245 name checks are made on the server certificate.
29246 .new
29247 The match against this list is, as per other Exim usage, the
29248 IP for the host.  That is most closely associated with the
29249 name on the DNS A (or AAAA) record for the host.
29250 However, the name that needs to be in the certificate
29251 is the one at the head of any CNAME chain leading to the A record.
29252 .wen
29253 The option defaults to always checking.
29254
29255 The &(smtp)& transport has two OCSP-related options:
29256 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29257 is requested and required for the connection to proceed.  The default
29258 value is empty.
29259 &%hosts_request_ocsp%&; a host-list for which (additionally)
29260 a Certificate Status is requested (but not necessarily verified).  The default
29261 value is "*" meaning that requests are made unless configured
29262 otherwise.
29263
29264 The host(s) should also be in &%hosts_require_tls%&, and
29265 &%tls_verify_certificates%& configured for the transport,
29266 for OCSP to be relevant.
29267
29268 If
29269 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29270 list of permitted cipher suites. If either of these checks fails, delivery to
29271 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29272 alternative hosts, if any.
29273
29274  &*Note*&:
29275 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29276 is operating as a client. Exim does not assume that a server certificate (set
29277 by the global options of the same name) should also be used when operating as a
29278 client.
29279
29280 .vindex "&$host$&"
29281 .vindex "&$host_address$&"
29282 All the TLS options in the &(smtp)& transport are expanded before use, with
29283 &$host$& and &$host_address$& containing the name and address of the server to
29284 which the client is connected. Forced failure of an expansion causes Exim to
29285 behave as if the relevant option were unset.
29286
29287 .vindex &$tls_out_bits$&
29288 .vindex &$tls_out_cipher$&
29289 .vindex &$tls_out_peerdn$&
29290 .vindex &$tls_out_sni$&
29291 Before an SMTP connection is established, the
29292 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29293 variables are emptied. (Until the first connection, they contain the values
29294 that were set when the message was received.) If STARTTLS is subsequently
29295 successfully obeyed, these variables are set to the relevant values for the
29296 outgoing connection.
29297
29298
29299
29300 .section "Use of TLS Server Name Indication" "SECTtlssni"
29301 .cindex "TLS" "Server Name Indication"
29302 .vindex "&$tls_in_sni$&"
29303 .oindex "&%tls_in_sni%&"
29304 With TLS1.0 or above, there is an extension mechanism by which extra
29305 information can be included at various points in the protocol.  One of these
29306 extensions, documented in RFC 6066 (and before that RFC 4366) is
29307 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29308 client in the initial handshake, so that the server can examine the servername
29309 within and possibly choose to use different certificates and keys (and more)
29310 for this session.
29311
29312 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29313 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29314 address.
29315
29316 With SMTP to MX, there are the same problems here as in choosing the identity
29317 against which to validate a certificate: you can't rely on insecure DNS to
29318 provide the identity which you then cryptographically verify.  So this will
29319 be of limited use in that environment.
29320
29321 With SMTP to Submission, there is a well-defined hostname which clients are
29322 connecting to and can validate certificates against.  Thus clients &*can*&
29323 choose to include this information in the TLS negotiation.  If this becomes
29324 wide-spread, then hosters can choose to present different certificates to
29325 different clients.  Or even negotiate different cipher suites.
29326
29327 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29328 if not empty, will be sent on a TLS session as part of the handshake.  There's
29329 nothing more to it.  Choosing a sensible value not derived insecurely is the
29330 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29331 for the lifetime of the client connection (including during authentication).
29332
29333 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29334 received from a client.
29335 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29336
29337 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29338 option (prior to expansion) then the following options will be re-expanded
29339 during TLS session handshake, to permit alternative values to be chosen:
29340
29341 .ilist
29342 &%tls_certificate%&
29343 .next
29344 &%tls_crl%&
29345 .next
29346 &%tls_privatekey%&
29347 .next
29348 &%tls_verify_certificates%&
29349 .next
29350 &%tls_ocsp_file%&
29351 .endlist
29352
29353 Great care should be taken to deal with matters of case, various injection
29354 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29355 can always be referenced; it is important to remember that &$tls_in_sni$& is
29356 arbitrary unverified data provided prior to authentication.
29357 Further, the initial certificate is loaded before SNI has arrived, so
29358 an expansion for &%tls_certificate%& must have a default which is used
29359 when &$tls_in_sni$& is empty.
29360
29361 The Exim developers are proceeding cautiously and so far no other TLS options
29362 are re-expanded.
29363
29364 When Exim is built against OpenSSL, OpenSSL must have been built with support
29365 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29366 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29367 see &`-servername`& in the output, then OpenSSL has support.
29368
29369 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29370 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29371 built, then you have SNI support).
29372
29373
29374
29375 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29376          "SECTmulmessam"
29377 .cindex "multiple SMTP deliveries with TLS"
29378 .cindex "TLS" "multiple message deliveries"
29379 Exim sends multiple messages down the same TCP/IP connection by starting up
29380 an entirely new delivery process for each message, passing the socket from
29381 one process to the next. This implementation does not fit well with the use
29382 of TLS, because there is quite a lot of state information associated with a TLS
29383 connection, not just a socket identification. Passing all the state information
29384 to a new process is not feasible. Consequently, for sending using TLS Exim
29385 starts an additional proxy process for handling the encryption, piping the
29386 unencrypted data stream from and to the delivery processes.
29387
29388 An older mode of operation can be enabled on a per-host basis by the
29389 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29390 this list the proxy process described above is not used; instead Exim
29391 shuts down an existing TLS session being run by the delivery process
29392 before passing the socket to a new process. The new process may then
29393 try to start a new TLS session, and if successful, may try to re-authenticate
29394 if AUTH is in use, before sending the next message.
29395
29396 The RFC is not clear as to whether or not an SMTP session continues in clear
29397 after TLS has been shut down, or whether TLS may be restarted again later, as
29398 just described. However, if the server is Exim, this shutdown and
29399 reinitialization works. It is not known which (if any) other servers operate
29400 successfully if the client closes a TLS session and continues with unencrypted
29401 SMTP, but there are certainly some that do not work. For such servers, Exim
29402 should not pass the socket to another process, because the failure of the
29403 subsequent attempt to use it would cause Exim to record a temporary host error,
29404 and delay other deliveries to that host.
29405
29406 To test for this case, Exim sends an EHLO command to the server after
29407 closing down the TLS session. If this fails in any way, the connection is
29408 closed instead of being passed to a new delivery process, but no retry
29409 information is recorded.
29410
29411 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29412 &(smtp)& transport to match those hosts for which Exim should not pass
29413 connections to new processes if TLS has been used.
29414
29415
29416
29417
29418 .section "Certificates and all that" "SECTcerandall"
29419 .cindex "certificate" "references to discussion"
29420 In order to understand fully how TLS works, you need to know about
29421 certificates, certificate signing, and certificate authorities.
29422 This is a large topic and an introductory guide is unsuitable for the Exim
29423 reference manual, so instead we provide pointers to existing documentation.
29424
29425 The Apache web-server was for a long time the canonical guide, so their
29426 documentation is a good place to start; their SSL module's Introduction
29427 document is currently at
29428 .display
29429 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29430 .endd
29431 and their FAQ is at
29432 .display
29433 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29434 .endd
29435
29436 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29437 0-201-61598-3) in 2001, contains both introductory and more in-depth
29438 descriptions.
29439 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29440 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29441 Ivan is the author of the popular TLS testing tools at
29442 &url(https://www.ssllabs.com/).
29443
29444
29445 .section "Certificate chains" "SECID186"
29446 The file named by &%tls_certificate%& may contain more than one
29447 certificate. This is useful in the case where the certificate that is being
29448 sent is validated by an intermediate certificate which the other end does
29449 not have. Multiple certificates must be in the correct order in the file.
29450 First the host's certificate itself, then the first intermediate
29451 certificate to validate the issuer of the host certificate, then the next
29452 intermediate certificate to validate the issuer of the first intermediate
29453 certificate, and so on, until finally (optionally) the root certificate.
29454 The root certificate must already be trusted by the recipient for
29455 validation to succeed, of course, but if it's not preinstalled, sending the
29456 root certificate along with the rest makes it available for the user to
29457 install if the receiving end is a client MUA that can interact with a user.
29458
29459 Note that certificates using MD5 are unlikely to work on today's Internet;
29460 even if your libraries allow loading them for use in Exim when acting as a
29461 server, increasingly clients will not accept such certificates.  The error
29462 diagnostics in such a case can be frustratingly vague.
29463
29464
29465
29466 .section "Self-signed certificates" "SECID187"
29467 .cindex "certificate" "self-signed"
29468 You can create a self-signed certificate using the &'req'& command provided
29469 with OpenSSL, like this:
29470 . ==== Do not shorten the duration here without reading and considering
29471 . ==== the text below.  Please leave it at 9999 days.
29472 .code
29473 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29474             -days 9999 -nodes
29475 .endd
29476 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29477 delimited and so can be identified independently. The &%-days%& option
29478 specifies a period for which the certificate is valid. The &%-nodes%& option is
29479 important: if you do not set it, the key is encrypted with a passphrase
29480 that you are prompted for, and any use that is made of the key causes more
29481 prompting for the passphrase. This is not helpful if you are going to use
29482 this certificate and key in an MTA, where prompting is not possible.
29483
29484 . ==== I expect to still be working 26 years from now.  The less technical
29485 . ==== debt I create, in terms of storing up trouble for my later years, the
29486 . ==== happier I will be then.  We really have reached the point where we
29487 . ==== should start, at the very least, provoking thought and making folks
29488 . ==== pause before proceeding, instead of leaving all the fixes until two
29489 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29490 . ==== -pdp, 2012
29491 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29492 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29493 the above command might produce a date in the past.  Think carefully about
29494 the lifetime of the systems you're deploying, and either reduce the duration
29495 of the certificate or reconsider your platform deployment.  (At time of
29496 writing, reducing the duration is the most likely choice, but the inexorable
29497 progression of time takes us steadily towards an era where this will not
29498 be a sensible resolution).
29499
29500 A self-signed certificate made in this way is sufficient for testing, and
29501 may be adequate for all your requirements if you are mainly interested in
29502 encrypting transfers, and not in secure identification.
29503
29504 However, many clients require that the certificate presented by the server be a
29505 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29506 certificate. In this situation, the self-signed certificate described above
29507 must be installed on the client host as a trusted root &'certification
29508 authority'& (CA), and the certificate used by Exim must be a user certificate
29509 signed with that self-signed certificate.
29510
29511 For information on creating self-signed CA certificates and using them to sign
29512 user certificates, see the &'General implementation overview'& chapter of the
29513 Open-source PKI book, available online at
29514 &url(https://sourceforge.net/projects/ospkibook/).
29515 .ecindex IIDencsmtp1
29516 .ecindex IIDencsmtp2
29517
29518
29519 .new
29520 .section "TLS Resumption" "SECTresumption"
29521 .cindex TLS resumption
29522 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
29523 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
29524 (or later).
29525
29526 Session resumption (this is the "stateless" variant) involves the server sending
29527 a "session ticket" to the client on one connection, which can be stored by the
29528 client and used for a later session.  The ticket contains sufficient state for
29529 the server to reconstruct the TLS session, avoiding some expensive crypto
29530 calculation and (on TLS1.2) one full packet roundtrip time.
29531
29532 .ilist
29533 Operational cost/benefit:
29534
29535  The extra data being transmitted costs a minor amount, and the client has
29536  extra costs in storing and retrieving the data.
29537
29538  In the Exim/Gnutls implementation the extra cost on an initial connection
29539  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
29540  The saved cost on a subsequent connection is about 4ms; three or more
29541  connections become a net win.  On longer network paths, two or more
29542  connections will have an average lower startup time thanks to the one
29543  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
29544  packet roundtrips.
29545
29546 .cindex "hints database" tls
29547  Since a new hints DB is used on the TLS client,
29548  the hints DB maintenance should be updated to additionally handle "tls".
29549
29550 .next
29551 Security aspects:
29552
29553  The session ticket is encrypted, but is obviously an additional security
29554  vulnarability surface.  An attacker able to decrypt it would have access
29555  all connections using the resumed session.
29556  The session ticket encryption key is not committed to storage by the server
29557  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
29558  overlap; GnuTLS 6hr but does not specify any overlap).
29559  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
29560  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
29561
29562  There is a question-mark over the security of the Diffie-Helman parameters
29563  used for session negotiation.
29564
29565 .next
29566 Observability:
29567
29568  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
29569  element.
29570
29571  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
29572  have bits 0-4 indicating respectively
29573  support built, client requested ticket, client offered session,
29574  server issued ticket, resume used.  A suitable decode list is provided
29575  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
29576
29577 .next
29578 Control:
29579
29580 The &%tls_resumption_hosts%& main option specifies a hostlist for which
29581 exim, operating as a server, will offer resumption to clients.
29582 Current best practice is to not offer the feature to MUA connection.
29583 Commonly this can be done like this:
29584 .code
29585 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
29586 .endd
29587 If the peer host matches the list after expansion then resumption
29588 is offered and/or accepted.
29589
29590 The &%tls_resumption_hosts%& smtp transport option performs the
29591 equivalent function for operation as a client.
29592 If the peer host matches the list after expansion then resumption
29593 is attempted (if a stored session is available) or the information
29594 stored (if supplied by the peer).
29595
29596
29597 .next
29598 Issues:
29599
29600  In a resumed session:
29601 .ilist
29602   The variables &$tls_{in,out}_cipher$& will have values different
29603  to the original (under GnuTLS).
29604 .next
29605   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
29606  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
29607 . XXX need to do something with that hosts_require_ocsp
29608 .endlist
29609
29610 .endlist
29611 .wen
29612
29613
29614 .section DANE "SECDANE"
29615 .cindex DANE
29616 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29617 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29618 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29619 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29620 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29621 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29622
29623 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29624 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29625 by (a) is thought to be smaller than that of the set of root CAs.
29626
29627 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29628 fail to pass on a server's STARTTLS.
29629
29630 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29631 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29632 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29633
29634 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29635 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29636 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29637 DNSSEC.
29638 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29639 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29640
29641 There are no changes to Exim specific to server-side operation of DANE.
29642 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29643 in &_Local/Makefile_&.
29644 If it has been included, the macro "_HAVE_DANE" will be defined.
29645
29646 A TLSA record consist of 4 fields, the "Certificate Usage", the
29647 "Selector", the "Matching type", and the "Certificate Association Data".
29648 For a detailed description of the TLSA record see
29649 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29650
29651 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29652 These are the "Trust Anchor" and "End Entity" variants.
29653 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29654 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29655 this is appropriate for a single system, using a self-signed certificate.
29656 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29657 well-known one.
29658 A private CA at simplest is just a self-signed certificate (with certain
29659 attributes) which is used to sign server certificates, but running one securely
29660 does require careful arrangement.
29661 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29662 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29663 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29664 all of which point to a single TLSA record.
29665 DANE-TA and DANE-EE can both be used together.
29666
29667 Our recommendation is to use DANE with a certificate from a public CA,
29668 because this enables a variety of strategies for remote clients to verify
29669 your certificate.
29670 You can then publish information both via DANE and another technology,
29671 "MTA-STS", described below.
29672
29673 When you use DANE-TA to publish trust anchor information, you ask entities
29674 outside your administrative control to trust the Certificate Authority for
29675 connections to you.
29676 If using a private CA then you should expect others to still apply the
29677 technical criteria they'd use for a public CA to your certificates.
29678 In particular, you should probably try to follow current best practices for CA
29679 operation around hash algorithms and key sizes.
29680 Do not expect other organizations to lower their security expectations just
29681 because a particular profile might be reasonable for your own internal use.
29682
29683 When this text was last updated, this in practice means to avoid use of SHA-1
29684 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29685 than 4096, for interoperability); to use keyUsage fields correctly; to use
29686 random serial numbers.
29687 The list of requirements is subject to change as best practices evolve.
29688 If you're not already using a private CA, or it doesn't meet these
29689 requirements, then we encourage you to avoid all these issues and use a public
29690 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29691
29692 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29693 a "Matching Type" (3rd) field of SHA2-512(2).
29694
29695 For the "Certificate Authority Data" (4th) field, commands like
29696
29697 .code
29698   openssl x509 -pubkey -noout <certificate.pem \
29699   | openssl rsa -outform der -pubin 2>/dev/null \
29700   | openssl sha512 \
29701   | awk '{print $2}'
29702 .endd
29703
29704 are workable to create a hash of the certificate's public key.
29705
29706 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29707
29708 .code
29709   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29710 .endd
29711
29712 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29713 is useful for quickly generating TLSA records.
29714
29715
29716 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29717
29718 The Certificate issued by the CA published in the DANE-TA model should be
29719 issued using a strong hash algorithm.
29720 Exim, and importantly various other MTAs sending to you, will not
29721 re-enable hash algorithms which have been disabled by default in TLS
29722 libraries.
29723 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29724 interoperability (and probably the maximum too, in 2018).
29725
29726 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29727 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29728 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29729
29730 .code
29731   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29732                                  {= {4}{$tls_out_tlsa_usage}} } \
29733                          {*}{}}
29734 .endd
29735
29736 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29737 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29738 found. If the definition of &%hosts_request_ocsp%& includes the
29739 string "tls_out_tlsa_usage", they are re-expanded in time to
29740 control the OCSP request.
29741
29742 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29743 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29744
29745
29746 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29747 and &%dane_require_tls_ciphers%&.
29748 The &"require"& variant will result in failure if the target host is not
29749 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29750 the &%dnssec_request_domains%& router or transport option.
29751
29752 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29753
29754 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29755 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29756 will be required for the host.  If it does not, the host will not
29757 be used; there is no fallback to non-DANE or non-TLS.
29758
29759 If DANE is requested and usable, then the TLS cipher list configuration
29760 prefers to use the option &%dane_require_tls_ciphers%& and falls
29761 back to &%tls_require_ciphers%& only if that is unset.
29762 This lets you configure "decent crypto" for DANE and "better than nothing
29763 crypto" as the default.  Note though that while GnuTLS lets the string control
29764 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29765 limited to ciphersuite constraints.
29766
29767 If DANE is requested and useable (see above) the following transport options are ignored:
29768 .code
29769   hosts_require_tls
29770   tls_verify_hosts
29771   tls_try_verify_hosts
29772   tls_verify_certificates
29773   tls_crl
29774   tls_verify_cert_hostnames
29775 .endd
29776
29777 If DANE is not usable, whether requested or not, and CA-anchored
29778 verification evaluation is wanted, the above variables should be set appropriately.
29779
29780 The router and transport option &%dnssec_request_domains%& must not be
29781 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29782
29783 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29784
29785 There is a new variable &$tls_out_dane$& which will have "yes" if
29786 verification succeeded using DANE and "no" otherwise (only useful
29787 in combination with events; see &<<CHAPevents>>&),
29788 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29789
29790 .cindex DANE reporting
29791 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29792 to achieve DANE-verified connection, if one was either requested and offered, or
29793 required.  This is intended to support TLS-reporting as defined in
29794 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29795 The &$event_data$& will be one of the Result Types defined in
29796 Section 4.3 of that document.
29797
29798 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29799
29800 DANE is specified in published RFCs and decouples certificate authority trust
29801 selection from a "race to the bottom" of "you must trust everything for mail
29802 to get through".  There is an alternative technology called MTA-STS, which
29803 instead publishes MX trust anchor information on an HTTPS website.  At the
29804 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29805 Exim has no support for MTA-STS as a client, but Exim mail server operators
29806 can choose to publish information describing their TLS configuration using
29807 MTA-STS to let those clients who do use that protocol derive trust
29808 information.
29809
29810 The MTA-STS design requires a certificate from a public Certificate Authority
29811 which is recognized by clients sending to you.
29812 That selection of which CAs are trusted by others is outside your control.
29813
29814 The most interoperable course of action is probably to use
29815 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29816 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29817 records for DANE clients (such as Exim and Postfix) and to publish anchor
29818 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29819 domain itself (with caveats around occasionally broken MTA-STS because of
29820 incompatible specification changes prior to reaching RFC status).
29821
29822
29823
29824 . ////////////////////////////////////////////////////////////////////////////
29825 . ////////////////////////////////////////////////////////////////////////////
29826
29827 .chapter "Access control lists" "CHAPACL"
29828 .scindex IIDacl "&ACL;" "description"
29829 .cindex "control of incoming mail"
29830 .cindex "message" "controlling incoming"
29831 .cindex "policy control" "access control lists"
29832 Access Control Lists (ACLs) are defined in a separate section of the runtime
29833 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29834 name, terminated by a colon. Here is a complete ACL section that contains just
29835 one very small ACL:
29836 .code
29837 begin acl
29838 small_acl:
29839   accept   hosts = one.host.only
29840 .endd
29841 You can have as many lists as you like in the ACL section, and the order in
29842 which they appear does not matter. The lists are self-terminating.
29843
29844 The majority of ACLs are used to control Exim's behaviour when it receives
29845 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29846 when a local process submits a message using SMTP by specifying the &%-bs%&
29847 option. The most common use is for controlling which recipients are accepted
29848 in incoming messages. In addition, you can define an ACL that is used to check
29849 local non-SMTP messages. The default configuration file contains an example of
29850 a realistic ACL for checking RCPT commands. This is discussed in chapter
29851 &<<CHAPdefconfil>>&.
29852
29853
29854 .section "Testing ACLs" "SECID188"
29855 The &%-bh%& command line option provides a way of testing your ACL
29856 configuration locally by running a fake SMTP session with which you interact.
29857
29858
29859 .section "Specifying when ACLs are used" "SECID189"
29860 .cindex "&ACL;" "options for specifying"
29861 In order to cause an ACL to be used, you have to name it in one of the relevant
29862 options in the main part of the configuration. These options are:
29863 .cindex "AUTH" "ACL for"
29864 .cindex "DATA" "ACLs for"
29865 .cindex "ETRN" "ACL for"
29866 .cindex "EXPN" "ACL for"
29867 .cindex "HELO" "ACL for"
29868 .cindex "EHLO" "ACL for"
29869 .cindex "DKIM" "ACL for"
29870 .cindex "MAIL" "ACL for"
29871 .cindex "QUIT, ACL for"
29872 .cindex "RCPT" "ACL for"
29873 .cindex "STARTTLS, ACL for"
29874 .cindex "VRFY" "ACL for"
29875 .cindex "SMTP" "connection, ACL for"
29876 .cindex "non-SMTP messages" "ACLs for"
29877 .cindex "MIME content scanning" "ACL for"
29878 .cindex "PRDR" "ACL for"
29879
29880 .table2 140pt
29881 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29882 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29883 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29884 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29885 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29886 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29887 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29888 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29889 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29890 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29891 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29892 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29893 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29894 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29895 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29896 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29897 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29898 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29899 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29900 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29901 .endtable
29902
29903 For example, if you set
29904 .code
29905 acl_smtp_rcpt = small_acl
29906 .endd
29907 the little ACL defined above is used whenever Exim receives a RCPT command
29908 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29909 done when RCPT commands arrive. A rejection of RCPT should cause the
29910 sending MTA to give up on the recipient address contained in the RCPT
29911 command, whereas rejection at other times may cause the client MTA to keep on
29912 trying to deliver the message. It is therefore recommended that you do as much
29913 testing as possible at RCPT time.
29914
29915
29916 .section "The non-SMTP ACLs" "SECID190"
29917 .cindex "non-SMTP messages" "ACLs for"
29918 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29919 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29920 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29921 the state of the SMTP connection such as encryption and authentication) are not
29922 relevant and are forbidden in these ACLs. However, the sender and recipients
29923 are known, so the &%senders%& and &%sender_domains%& conditions and the
29924 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29925 &$authenticated_sender$& are also available. You can specify added header lines
29926 in any of these ACLs.
29927
29928 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29929 non-SMTP message, before any of the message has been read. (This is the
29930 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29931 batched SMTP input, it runs after the DATA command has been reached. The
29932 result of this ACL is ignored; it cannot be used to reject a message. If you
29933 really need to, you could set a value in an ACL variable here and reject based
29934 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29935 controls, and in particular, it can be used to set
29936 .code
29937 control = suppress_local_fixups
29938 .endd
29939 This cannot be used in the other non-SMTP ACLs because by the time they are
29940 run, it is too late.
29941
29942 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29943 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29944
29945 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29946 kind of rejection is treated as permanent, because there is no way of sending a
29947 temporary error for these kinds of message.
29948
29949
29950 .section "The SMTP connect ACL" "SECID191"
29951 .cindex "SMTP" "connection, ACL for"
29952 .oindex &%smtp_banner%&
29953 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29954 session, after the test specified by &%host_reject_connection%& (which is now
29955 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29956 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29957 the message override the banner message that is otherwise specified by the
29958 &%smtp_banner%& option.
29959
29960
29961 .section "The EHLO/HELO ACL" "SECID192"
29962 .cindex "EHLO" "ACL for"
29963 .cindex "HELO" "ACL for"
29964 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29965 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29966 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29967 Note that a client may issue more than one EHLO or HELO command in an SMTP
29968 session, and indeed is required to issue a new EHLO or HELO after successfully
29969 setting up encryption following a STARTTLS command.
29970
29971 Note also that a deny neither forces the client to go away nor means that
29972 mail will be refused on the connection.  Consider checking for
29973 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29974
29975 If the command is accepted by an &%accept%& verb that has a &%message%&
29976 modifier, the message may not contain more than one line (it will be truncated
29977 at the first newline and a panic logged if it does). Such a message cannot
29978 affect the EHLO options that are listed on the second and subsequent lines of
29979 an EHLO response.
29980
29981
29982 .section "The DATA ACLs" "SECID193"
29983 .cindex "DATA" "ACLs for"
29984 Two ACLs are associated with the DATA command, because it is two-stage
29985 command, with two responses being sent to the client.
29986 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29987 is obeyed. This gives you control after all the RCPT commands, but before
29988 the message itself is received. It offers the opportunity to give a negative
29989 response to the DATA command before the data is transmitted. Header lines
29990 added by MAIL or RCPT ACLs are not visible at this time, but any that
29991 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29992
29993 You cannot test the contents of the message, for example, to verify addresses
29994 in the headers, at RCPT time or when the DATA command is received. Such
29995 tests have to appear in the ACL that is run after the message itself has been
29996 received, before the final response to the DATA command is sent. This is
29997 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29998 associated with the DATA command.
29999
30000 .cindex CHUNKING "BDAT command"
30001 .cindex BDAT "SMTP command"
30002 .cindex "RFC 3030" CHUNKING
30003 If CHUNKING was advertised and a BDAT command sequence is received,
30004 the &%acl_smtp_predata%& ACL is not run.
30005 . XXX why not?  It should be possible, for the first BDAT.
30006 The &%acl_smtp_data%& is run after the last BDAT command and all of
30007 the data specified is received.
30008
30009 For both of these ACLs, it is not possible to reject individual recipients. An
30010 error response rejects the entire message. Unfortunately, it is known that some
30011 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30012 before or after the data) correctly &-- they keep the message on their queues
30013 and try again later, but that is their problem, though it does waste some of
30014 your resources.
30015
30016 The &%acl_smtp_data%& ACL is run after
30017 the &%acl_smtp_data_prdr%&,
30018 the &%acl_smtp_dkim%&
30019 and the &%acl_smtp_mime%& ACLs.
30020
30021 .section "The SMTP DKIM ACL" "SECTDKIMACL"
30022 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30023 enabled (which is the default).
30024
30025 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30026 received, and is executed for each DKIM signature found in a message.  If not
30027 otherwise specified, the default action is to accept.
30028
30029 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30030
30031 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30032
30033
30034 .section "The SMTP MIME ACL" "SECID194"
30035 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30036 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30037
30038 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30039
30040
30041 .section "The SMTP PRDR ACL" "SECTPRDRACL"
30042 .cindex "PRDR" "ACL for"
30043 .oindex "&%prdr_enable%&"
30044 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30045 with PRDR support enabled (which is the default).
30046 It becomes active only when the PRDR feature is negotiated between
30047 client and server for a message, and more than one recipient
30048 has been accepted.
30049
30050 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30051 has been received, and is executed once for each recipient of the message
30052 with &$local_part$& and &$domain$& valid.
30053 The test may accept, defer or deny for individual recipients.
30054 The &%acl_smtp_data%& will still be called after this ACL and
30055 can reject the message overall, even if this ACL has accepted it
30056 for some or all recipients.
30057
30058 PRDR may be used to support per-user content filtering.  Without it
30059 one must defer any recipient after the first that has a different
30060 content-filter configuration.  With PRDR, the RCPT-time check
30061 .cindex "PRDR" "variable for"
30062 for this can be disabled when the variable &$prdr_requested$&
30063 is &"yes"&.
30064 Any required difference in behaviour of the main DATA-time
30065 ACL should however depend on the PRDR-time ACL having run, as Exim
30066 will avoid doing so in some situations (e.g. single-recipient mails).
30067
30068 See also the &%prdr_enable%& global option
30069 and the &%hosts_try_prdr%& smtp transport option.
30070
30071 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30072 If the ACL is not defined, processing completes as if
30073 the feature was not requested by the client.
30074
30075 .section "The QUIT ACL" "SECTQUITACL"
30076 .cindex "QUIT, ACL for"
30077 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30078 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30079 does not in fact control any access.
30080 For this reason, it may only accept
30081 or warn as its final result.
30082
30083 This ACL can be used for tasks such as custom logging at the end of an SMTP
30084 session. For example, you can use ACL variables in other ACLs to count
30085 messages, recipients, etc., and log the totals at QUIT time using one or
30086 more &%logwrite%& modifiers on a &%warn%& verb.
30087
30088 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30089 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30090
30091 You do not need to have a final &%accept%&, but if you do, you can use a
30092 &%message%& modifier to specify custom text that is sent as part of the 221
30093 response to QUIT.
30094
30095 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30096 failure (for example, failure to open a log file, or when Exim is bombing out
30097 because it has detected an unrecoverable error), all SMTP commands from the
30098 client are given temporary error responses until QUIT is received or the
30099 connection is closed. In these special cases, the QUIT ACL does not run.
30100
30101
30102 .section "The not-QUIT ACL" "SECTNOTQUITACL"
30103 .vindex &$acl_smtp_notquit$&
30104 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30105 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30106 trouble, such as being unable to write to its log files, this ACL is not run,
30107 because it might try to do things (such as write to log files) that make the
30108 situation even worse.
30109
30110 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30111 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30112 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30113 and &%warn%&.
30114
30115 .vindex &$smtp_notquit_reason$&
30116 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30117 to a string that indicates the reason for the termination of the SMTP
30118 connection. The possible values are:
30119 .table2
30120 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30121 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30122 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30123 .irow &`connection-lost`&          "The SMTP connection has been lost"
30124 .irow &`data-timeout`&             "Timeout while reading message data"
30125 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30126 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30127 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30128 .irow &`synchronization-error`&    "SMTP synchronization error"
30129 .irow &`tls-failed`&               "TLS failed to start"
30130 .endtable
30131 In most cases when an SMTP connection is closed without having received QUIT,
30132 Exim sends an SMTP response message before actually closing the connection.
30133 With the exception of the &`acl-drop`& case, the default message can be
30134 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30135 &%drop%& verb in another ACL, it is the message from the other ACL that is
30136 used.
30137
30138
30139 .section "Finding an ACL to use" "SECID195"
30140 .cindex "&ACL;" "finding which to use"
30141 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30142 you can use different ACLs in different circumstances. For example,
30143 .code
30144 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30145                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30146 .endd
30147 In the default configuration file there are some example settings for
30148 providing an RFC 4409 message &"submission"& service on port 587 and
30149 an RFC 8314 &"submissions"& service on port 465. You can use a string
30150 expansion like this to choose an ACL for MUAs on these ports which is
30151 more appropriate for this purpose than the default ACL on port 25.
30152
30153 The expanded string does not have to be the name of an ACL in the
30154 configuration file; there are other possibilities. Having expanded the
30155 string, Exim searches for an ACL as follows:
30156
30157 .ilist
30158 If the string begins with a slash, Exim uses it as a filename, and reads its
30159 contents as an ACL. The lines are processed in the same way as lines in the
30160 Exim configuration file. In particular, continuation lines are supported, blank
30161 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30162 If the file does not exist or cannot be read, an error occurs (typically
30163 causing a temporary failure of whatever caused the ACL to be run). For example:
30164 .code
30165 acl_smtp_data = /etc/acls/\
30166   ${lookup{$sender_host_address}lsearch\
30167   {/etc/acllist}{$value}{default}}
30168 .endd
30169 This looks up an ACL file to use on the basis of the host's IP address, falling
30170 back to a default if the lookup fails. If an ACL is successfully read from a
30171 file, it is retained in memory for the duration of the Exim process, so that it
30172 can be re-used without having to re-read the file.
30173 .next
30174 If the string does not start with a slash, and does not contain any spaces,
30175 Exim searches the ACL section of the configuration for an ACL whose name
30176 matches the string.
30177 .next
30178 If no named ACL is found, or if the string contains spaces, Exim parses
30179 the string as an inline ACL. This can save typing in cases where you just
30180 want to have something like
30181 .code
30182 acl_smtp_vrfy = accept
30183 .endd
30184 in order to allow free use of the VRFY command. Such a string may contain
30185 newlines; it is processed in the same way as an ACL that is read from a file.
30186 .endlist
30187
30188
30189
30190
30191 .section "ACL return codes" "SECID196"
30192 .cindex "&ACL;" "return codes"
30193 Except for the QUIT ACL, which does not affect the SMTP return code (see
30194 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30195 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30196 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30197 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30198 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30199 This also causes a 4&'xx'& return code.
30200
30201 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30202 &"deny"&, because there is no mechanism for passing temporary errors to the
30203 submitters of non-SMTP messages.
30204
30205
30206 ACLs that are relevant to message reception may also return &"discard"&. This
30207 has the effect of &"accept"&, but causes either the entire message or an
30208 individual recipient address to be discarded. In other words, it is a
30209 blackholing facility. Use it with care.
30210
30211 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30212 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30213 RCPT ACL is to discard just the one recipient address. If there are no
30214 recipients left when the message's data is received, the DATA ACL is not
30215 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30216 remaining recipients. The &"discard"& return is not permitted for the
30217 &%acl_smtp_predata%& ACL.
30218
30219 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30220 is done on the address and the result determines the SMTP response.
30221
30222
30223 .cindex "&[local_scan()]& function" "when all recipients discarded"
30224 The &[local_scan()]& function is always run, even if there are no remaining
30225 recipients; it may create new recipients.
30226
30227
30228
30229 .section "Unset ACL options" "SECID197"
30230 .cindex "&ACL;" "unset options"
30231 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30232 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30233 not defined at all. For any defined ACL, the default action when control
30234 reaches the end of the ACL statements is &"deny"&.
30235
30236 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30237 these two are ACLs that are used only for their side effects. They cannot be
30238 used to accept or reject anything.
30239
30240 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30241 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30242 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30243 when the ACL is not defined is &"accept"&.
30244
30245 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30246 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30247 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30248 messages over an SMTP connection. For an example, see the ACL in the default
30249 configuration file.
30250
30251
30252
30253
30254 .section "Data for message ACLs" "SECID198"
30255 .cindex "&ACL;" "data for message ACL"
30256 .vindex &$domain$&
30257 .vindex &$local_part$&
30258 .vindex &$sender_address$&
30259 .vindex &$sender_host_address$&
30260 .vindex &$smtp_command$&
30261 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30262 that contain information about the host and the message's sender (for example,
30263 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30264 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30265 &$local_part$& are set from the argument address. The entire SMTP command
30266 is available in &$smtp_command$&.
30267
30268 When an ACL for the AUTH parameter of MAIL is running, the variables that
30269 contain information about the host are set, but &$sender_address$& is not yet
30270 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30271 how it is used.
30272
30273 .vindex "&$message_size$&"
30274 The &$message_size$& variable is set to the value of the SIZE parameter on
30275 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30276 that parameter is not given. The value is updated to the true message size by
30277 the time the final DATA ACL is run (after the message data has been
30278 received).
30279
30280 .vindex "&$rcpt_count$&"
30281 .vindex "&$recipients_count$&"
30282 The &$rcpt_count$& variable increases by one for each RCPT command received.
30283 The &$recipients_count$& variable increases by one each time a RCPT command is
30284 accepted, so while an ACL for RCPT is being processed, it contains the number
30285 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30286 &$rcpt_count$& contains the total number of RCPT commands, and
30287 &$recipients_count$& contains the total number of accepted recipients.
30288
30289
30290
30291
30292
30293 .section "Data for non-message ACLs" "SECTdatfornon"
30294 .cindex "&ACL;" "data for non-message ACL"
30295 .vindex &$smtp_command_argument$&
30296 .vindex &$smtp_command$&
30297 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30298 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30299 and the entire SMTP command is available in &$smtp_command$&.
30300 These variables can be tested using a &%condition%& condition. For example,
30301 here is an ACL for use with AUTH, which insists that either the session is
30302 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30303 does not permit authentication methods that use cleartext passwords on
30304 unencrypted connections.
30305 .code
30306 acl_check_auth:
30307   accept encrypted = *
30308   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30309                      {CRAM-MD5}}
30310   deny   message   = TLS encryption or CRAM-MD5 required
30311 .endd
30312 (Another way of applying this restriction is to arrange for the authenticators
30313 that use cleartext passwords not to be advertised when the connection is not
30314 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30315 option to do this.)
30316
30317
30318
30319 .section "Format of an ACL" "SECID199"
30320 .cindex "&ACL;" "format of"
30321 .cindex "&ACL;" "verbs, definition of"
30322 An individual ACL consists of a number of statements. Each statement starts
30323 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30324 Modifiers can change the way the verb operates, define error and log messages,
30325 set variables, insert delays, and vary the processing of accepted messages.
30326
30327 If all the conditions are met, the verb is obeyed. The same condition may be
30328 used (with different arguments) more than once in the same statement. This
30329 provides a means of specifying an &"and"& conjunction between conditions. For
30330 example:
30331 .code
30332 deny  dnslists = list1.example
30333       dnslists = list2.example
30334 .endd
30335 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30336 the conditions and modifiers when it reaches a condition that fails. What
30337 happens then depends on the verb (and in one case, on a special modifier). Not
30338 all the conditions make sense at every testing point. For example, you cannot
30339 test a sender address in the ACL that is run for a VRFY command.
30340
30341
30342 .section "ACL verbs" "SECID200"
30343 The ACL verbs are as follows:
30344
30345 .ilist
30346 .cindex "&%accept%& ACL verb"
30347 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30348 of the conditions are not met, what happens depends on whether &%endpass%&
30349 appears among the conditions (for syntax see below). If the failing condition
30350 is before &%endpass%&, control is passed to the next ACL statement; if it is
30351 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30352 check a RCPT command:
30353 .code
30354 accept domains = +local_domains
30355        endpass
30356        verify = recipient
30357 .endd
30358 If the recipient domain does not match the &%domains%& condition, control
30359 passes to the next statement. If it does match, the recipient is verified, and
30360 the command is accepted if verification succeeds. However, if verification
30361 fails, the ACL yields &"deny"&, because the failing condition is after
30362 &%endpass%&.
30363
30364 The &%endpass%& feature has turned out to be confusing to many people, so its
30365 use is not recommended nowadays. It is always possible to rewrite an ACL so
30366 that &%endpass%& is not needed, and it is no longer used in the default
30367 configuration.
30368
30369 .cindex "&%message%& ACL modifier" "with &%accept%&"
30370 If a &%message%& modifier appears on an &%accept%& statement, its action
30371 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30372 (when an &%accept%& verb either accepts or passes control to the next
30373 statement), &%message%& can be used to vary the message that is sent when an
30374 SMTP command is accepted. For example, in a RCPT ACL you could have:
30375 .display
30376 &`accept  `&<&'some conditions'&>
30377 &`        message = OK, I will allow you through today`&
30378 .endd
30379 You can specify an SMTP response code, optionally followed by an &"extended
30380 response code"& at the start of the message, but the first digit must be the
30381 same as would be sent by default, which is 2 for an &%accept%& verb.
30382
30383 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30384 an error message that is used when access is denied. This behaviour is retained
30385 for backward compatibility, but current &"best practice"& is to avoid the use
30386 of &%endpass%&.
30387
30388
30389 .next
30390 .cindex "&%defer%& ACL verb"
30391 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30392 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30393 &%defer%& is the same as &%deny%&, because there is no way of sending a
30394 temporary error. For a RCPT command, &%defer%& is much the same as using a
30395 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30396 be used in any ACL, and even for a recipient it might be a simpler approach.
30397
30398
30399 .next
30400 .cindex "&%deny%& ACL verb"
30401 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30402 the conditions are not met, control is passed to the next ACL statement. For
30403 example,
30404 .code
30405 deny dnslists = blackholes.mail-abuse.org
30406 .endd
30407 rejects commands from hosts that are on a DNS black list.
30408
30409
30410 .next
30411 .cindex "&%discard%& ACL verb"
30412 &%discard%&: This verb behaves like &%accept%&, except that it returns
30413 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30414 that are concerned with receiving messages. When all the conditions are true,
30415 the sending entity receives a &"success"& response. However, &%discard%& causes
30416 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30417 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30418 message's recipients are discarded. Recipients that are discarded before DATA
30419 do not appear in the log line when the &%received_recipients%& log selector is set.
30420
30421 If the &%log_message%& modifier is set when &%discard%& operates,
30422 its contents are added to the line that is automatically written to the log.
30423 The &%message%& modifier operates exactly as it does for &%accept%&.
30424
30425
30426 .next
30427 .cindex "&%drop%& ACL verb"
30428 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30429 forcibly closed after the 5&'xx'& error message has been sent. For example:
30430 .code
30431 drop   condition = ${if > {$rcpt_count}{20}}
30432        message   = I don't take more than 20 RCPTs
30433 .endd
30434 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30435 The connection is always dropped after sending a 550 response.
30436
30437 .next
30438 .cindex "&%require%& ACL verb"
30439 &%require%&: If all the conditions are met, control is passed to the next ACL
30440 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30441 example, when checking a RCPT command,
30442 .code
30443 require message = Sender did not verify
30444         verify  = sender
30445 .endd
30446 passes control to subsequent statements only if the message's sender can be
30447 verified. Otherwise, it rejects the command. Note the positioning of the
30448 &%message%& modifier, before the &%verify%& condition. The reason for this is
30449 discussed in section &<<SECTcondmodproc>>&.
30450
30451 .next
30452 .cindex "&%warn%& ACL verb"
30453 &%warn%&: If all the conditions are true, a line specified by the
30454 &%log_message%& modifier is written to Exim's main log. Control always passes
30455 to the next ACL statement. If any condition is false, the log line is not
30456 written. If an identical log line is requested several times in the same
30457 message, only one copy is actually written to the log. If you want to force
30458 duplicates to be written, use the &%logwrite%& modifier instead.
30459
30460 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30461 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30462 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30463 first failing condition. There is more about adding header lines in section
30464 &<<SECTaddheadacl>>&.
30465
30466 If any condition on a &%warn%& statement cannot be completed (that is, there is
30467 some sort of defer), the log line specified by &%log_message%& is not written.
30468 This does not include the case of a forced failure from a lookup, which
30469 is considered to be a successful completion. After a defer, no further
30470 conditions or modifiers in the &%warn%& statement are processed. The incident
30471 is logged, and the ACL continues to be processed, from the next statement
30472 onwards.
30473
30474
30475 .vindex "&$acl_verify_message$&"
30476 When one of the &%warn%& conditions is an address verification that fails, the
30477 text of the verification failure message is in &$acl_verify_message$&. If you
30478 want this logged, you must set it up explicitly. For example:
30479 .code
30480 warn   !verify = sender
30481        log_message = sender verify failed: $acl_verify_message
30482 .endd
30483 .endlist
30484
30485 At the end of each ACL there is an implicit unconditional &%deny%&.
30486
30487 As you can see from the examples above, the conditions and modifiers are
30488 written one to a line, with the first one on the same line as the verb, and
30489 subsequent ones on following lines. If you have a very long condition, you can
30490 continue it onto several physical lines by the usual backslash continuation
30491 mechanism. It is conventional to align the conditions vertically.
30492
30493
30494
30495 .section "ACL variables" "SECTaclvariables"
30496 .cindex "&ACL;" "variables"
30497 There are some special variables that can be set during ACL processing. They
30498 can be used to pass information between different ACLs, different invocations
30499 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30500 transports, and filters that are used to deliver a message. The names of these
30501 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30502 an underscore, but the remainder of the name can be any sequence of
30503 alphanumeric characters and underscores that you choose. There is no limit on
30504 the number of ACL variables. The two sets act as follows:
30505 .ilist
30506 The values of those variables whose names begin with &$acl_c$& persist
30507 throughout an SMTP connection. They are never reset. Thus, a value that is set
30508 while receiving one message is still available when receiving the next message
30509 on the same SMTP connection.
30510 .next
30511 The values of those variables whose names begin with &$acl_m$& persist only
30512 while a message is being received. They are reset afterwards. They are also
30513 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30514 .endlist
30515
30516 When a message is accepted, the current values of all the ACL variables are
30517 preserved with the message and are subsequently made available at delivery
30518 time. The ACL variables are set by a modifier called &%set%&. For example:
30519 .code
30520 accept hosts = whatever
30521        set acl_m4 = some value
30522 accept authenticated = *
30523        set acl_c_auth = yes
30524 .endd
30525 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30526 be set. If you want to set a variable without taking any action, you can use a
30527 &%warn%& verb without any other modifiers or conditions.
30528
30529 .oindex &%strict_acl_vars%&
30530 What happens if a syntactically valid but undefined ACL variable is
30531 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30532 false (the default), an empty string is substituted; if it is true, an
30533 error is generated.
30534
30535 Versions of Exim before 4.64 have a limited set of numbered variables, but
30536 their names are compatible, so there is no problem with upgrading.
30537
30538
30539 .section "Condition and modifier processing" "SECTcondmodproc"
30540 .cindex "&ACL;" "conditions; processing"
30541 .cindex "&ACL;" "modifiers; processing"
30542 An exclamation mark preceding a condition negates its result. For example:
30543 .code
30544 deny   domains = *.dom.example
30545       !verify  = recipient
30546 .endd
30547 causes the ACL to return &"deny"& if the recipient domain ends in
30548 &'dom.example'& and the recipient address cannot be verified. Sometimes
30549 negation can be used on the right-hand side of a condition. For example, these
30550 two statements are equivalent:
30551 .code
30552 deny  hosts = !192.168.3.4
30553 deny !hosts =  192.168.3.4
30554 .endd
30555 However, for many conditions (&%verify%& being a good example), only left-hand
30556 side negation of the whole condition is possible.
30557
30558 The arguments of conditions and modifiers are expanded. A forced failure
30559 of an expansion causes a condition to be ignored, that is, it behaves as if the
30560 condition is true. Consider these two statements:
30561 .code
30562 accept  senders = ${lookup{$host_name}lsearch\
30563                   {/some/file}{$value}fail}
30564 accept  senders = ${lookup{$host_name}lsearch\
30565                   {/some/file}{$value}{}}
30566 .endd
30567 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30568 the returned list is searched, but if the lookup fails the behaviour is
30569 different in the two cases. The &%fail%& in the first statement causes the
30570 condition to be ignored, leaving no further conditions. The &%accept%& verb
30571 therefore succeeds. The second statement, however, generates an empty list when
30572 the lookup fails. No sender can match an empty list, so the condition fails,
30573 and therefore the &%accept%& also fails.
30574
30575 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30576 specify actions that are taken as the conditions for a statement are checked;
30577 others specify text for messages that are used when access is denied or a
30578 warning is generated. The &%control%& modifier affects the way an incoming
30579 message is handled.
30580
30581 The positioning of the modifiers in an ACL statement is important, because the
30582 processing of a verb ceases as soon as its outcome is known. Only those
30583 modifiers that have already been encountered will take effect. For example,
30584 consider this use of the &%message%& modifier:
30585 .code
30586 require message = Can't verify sender
30587         verify  = sender
30588         message = Can't verify recipient
30589         verify  = recipient
30590         message = This message cannot be used
30591 .endd
30592 If sender verification fails, Exim knows that the result of the statement is
30593 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30594 so its text is used as the error message. If sender verification succeeds, but
30595 recipient verification fails, the second message is used. If recipient
30596 verification succeeds, the third message becomes &"current"&, but is never used
30597 because there are no more conditions to cause failure.
30598
30599 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30600 modifier that is used, because all the conditions must be true for rejection to
30601 happen. Specifying more than one &%message%& modifier does not make sense, and
30602 the message can even be specified after all the conditions. For example:
30603 .code
30604 deny   hosts = ...
30605       !senders = *@my.domain.example
30606        message = Invalid sender from client host
30607 .endd
30608 The &"deny"& result does not happen until the end of the statement is reached,
30609 by which time Exim has set up the message.
30610
30611
30612
30613 .section "ACL modifiers" "SECTACLmodi"
30614 .cindex "&ACL;" "modifiers; list of"
30615 The ACL modifiers are as follows:
30616
30617 .vlist
30618 .vitem &*add_header*&&~=&~<&'text'&>
30619 This modifier specifies one or more header lines that are to be added to an
30620 incoming message, assuming, of course, that the message is ultimately
30621 accepted. For details, see section &<<SECTaddheadacl>>&.
30622
30623 .vitem &*continue*&&~=&~<&'text'&>
30624 .cindex "&%continue%& ACL modifier"
30625 .cindex "database" "updating in ACL"
30626 This modifier does nothing of itself, and processing of the ACL always
30627 continues with the next condition or modifier. The value of &%continue%& is in
30628 the side effects of expanding its argument. Typically this could be used to
30629 update a database. It is really just a syntactic tidiness, to avoid having to
30630 write rather ugly lines like this:
30631 .display
30632 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30633 .endd
30634 Instead, all you need is
30635 .display
30636 &`continue = `&<&'some expansion'&>
30637 .endd
30638
30639 .vitem &*control*&&~=&~<&'text'&>
30640 .cindex "&%control%& ACL modifier"
30641 This modifier affects the subsequent processing of the SMTP connection or of an
30642 incoming message that is accepted. The effect of the first type of control
30643 lasts for the duration of the connection, whereas the effect of the second type
30644 lasts only until the current message has been received. The message-specific
30645 controls always apply to the whole message, not to individual recipients,
30646 even if the &%control%& modifier appears in a RCPT ACL.
30647
30648 As there are now quite a few controls that can be applied, they are described
30649 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30650 in several different ways. For example:
30651
30652 . ==== As this is a nested list, any displays it contains must be indented
30653 . ==== as otherwise they are too far to the left. That comment applies only
30654 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30655 . ==== way.
30656
30657 .ilist
30658 It can be at the end of an &%accept%& statement:
30659 .code
30660     accept  ...some conditions
30661             control = queue
30662 .endd
30663 In this case, the control is applied when this statement yields &"accept"&, in
30664 other words, when the conditions are all true.
30665
30666 .next
30667 It can be in the middle of an &%accept%& statement:
30668 .code
30669     accept  ...some conditions...
30670             control = queue
30671             ...some more conditions...
30672 .endd
30673 If the first set of conditions are true, the control is applied, even if the
30674 statement does not accept because one of the second set of conditions is false.
30675 In this case, some subsequent statement must yield &"accept"& for the control
30676 to be relevant.
30677
30678 .next
30679 It can be used with &%warn%& to apply the control, leaving the
30680 decision about accepting or denying to a subsequent verb. For
30681 example:
30682 .code
30683     warn    ...some conditions...
30684             control = freeze
30685     accept  ...
30686 .endd
30687 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30688 &%logwrite%&, so it does not add anything to the message and does not write a
30689 log entry.
30690
30691 .next
30692 If you want to apply a control unconditionally, you can use it with a
30693 &%require%& verb. For example:
30694 .code
30695     require  control = no_multiline_responses
30696 .endd
30697 .endlist
30698
30699 .vitem &*delay*&&~=&~<&'time'&>
30700 .cindex "&%delay%& ACL modifier"
30701 .oindex "&%-bh%&"
30702 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30703 the time interval before proceeding. However, when testing Exim using the
30704 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30705 output instead). The time is given in the usual Exim notation, and the delay
30706 happens as soon as the modifier is processed. In an SMTP session, pending
30707 output is flushed before the delay is imposed.
30708
30709 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30710 example:
30711 .code
30712 deny    ...some conditions...
30713         delay = 30s
30714 .endd
30715 The delay happens if all the conditions are true, before the statement returns
30716 &"deny"&. Compare this with:
30717 .code
30718 deny    delay = 30s
30719         ...some conditions...
30720 .endd
30721 which waits for 30s before processing the conditions. The &%delay%& modifier
30722 can also be used with &%warn%& and together with &%control%&:
30723 .code
30724 warn    ...some conditions...
30725         delay = 2m
30726         control = freeze
30727 accept  ...
30728 .endd
30729
30730 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30731 responses to several commands are no longer buffered and sent in one packet (as
30732 they would normally be) because all output is flushed before imposing the
30733 delay. This optimization is disabled so that a number of small delays do not
30734 appear to the client as one large aggregated delay that might provoke an
30735 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30736 using a &%control%& modifier to set &%no_delay_flush%&.
30737
30738
30739 .vitem &*endpass*&
30740 .cindex "&%endpass%& ACL modifier"
30741 This modifier, which has no argument, is recognized only in &%accept%& and
30742 &%discard%& statements. It marks the boundary between the conditions whose
30743 failure causes control to pass to the next statement, and the conditions whose
30744 failure causes the ACL to return &"deny"&. This concept has proved to be
30745 confusing to some people, so the use of &%endpass%& is no longer recommended as
30746 &"best practice"&. See the description of &%accept%& above for more details.
30747
30748
30749 .vitem &*log_message*&&~=&~<&'text'&>
30750 .cindex "&%log_message%& ACL modifier"
30751 This modifier sets up a message that is used as part of the log message if the
30752 ACL denies access or a &%warn%& statement's conditions are true. For example:
30753 .code
30754 require log_message = wrong cipher suite $tls_in_cipher
30755         encrypted   = DES-CBC3-SHA
30756 .endd
30757 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30758 example:
30759 .display
30760 &`discard `&<&'some conditions'&>
30761 &`        log_message = Discarded $local_part@$domain because...`&
30762 .endd
30763 When access is denied, &%log_message%& adds to any underlying error message
30764 that may exist because of a condition failure. For example, while verifying a
30765 recipient address, a &':fail:'& redirection might have already set up a
30766 message.
30767
30768 The message may be defined before the conditions to which it applies, because
30769 the string expansion does not happen until Exim decides that access is to be
30770 denied. This means that any variables that are set by the condition are
30771 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30772 variables are set after a DNS black list lookup succeeds. If the expansion of
30773 &%log_message%& fails, or if the result is an empty string, the modifier is
30774 ignored.
30775
30776 .vindex "&$acl_verify_message$&"
30777 If you want to use a &%warn%& statement to log the result of an address
30778 verification, you can use &$acl_verify_message$& to include the verification
30779 error message.
30780
30781 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30782 the start of the logged message. If the same warning log message is requested
30783 more than once while receiving  a single email message, only one copy is
30784 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30785 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30786 is logged for a successful &%warn%& statement.
30787
30788 If &%log_message%& is not present and there is no underlying error message (for
30789 example, from the failure of address verification), but &%message%& is present,
30790 the &%message%& text is used for logging rejections. However, if any text for
30791 logging contains newlines, only the first line is logged. In the absence of
30792 both &%log_message%& and &%message%&, a default built-in message is used for
30793 logging rejections.
30794
30795
30796 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30797 .cindex "&%log_reject_target%& ACL modifier"
30798 .cindex "logging in ACL" "specifying which log"
30799 This modifier makes it possible to specify which logs are used for messages
30800 about ACL rejections. Its argument is a colon-separated list of words that can
30801 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30802 may be empty, in which case a rejection is not logged at all. For example, this
30803 ACL fragment writes no logging information when access is denied:
30804 .display
30805 &`deny `&<&'some conditions'&>
30806 &`     log_reject_target =`&
30807 .endd
30808 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30809 permanent and temporary rejections. Its effect lasts for the rest of the
30810 current ACL.
30811
30812
30813 .vitem &*logwrite*&&~=&~<&'text'&>
30814 .cindex "&%logwrite%& ACL modifier"
30815 .cindex "logging in ACL" "immediate"
30816 This modifier writes a message to a log file as soon as it is encountered when
30817 processing an ACL. (Compare &%log_message%&, which, except in the case of
30818 &%warn%& and &%discard%&, is used only if the ACL statement denies
30819 access.) The &%logwrite%& modifier can be used to log special incidents in
30820 ACLs. For example:
30821 .display
30822 &`accept `&<&'some special conditions'&>
30823 &`       control  = freeze`&
30824 &`       logwrite = froze message because ...`&
30825 .endd
30826 By default, the message is written to the main log. However, it may begin
30827 with a colon, followed by a comma-separated list of log names, and then
30828 another colon, to specify exactly which logs are to be written. For
30829 example:
30830 .code
30831 logwrite = :main,reject: text for main and reject logs
30832 logwrite = :panic: text for panic log only
30833 .endd
30834
30835
30836 .vitem &*message*&&~=&~<&'text'&>
30837 .cindex "&%message%& ACL modifier"
30838 This modifier sets up a text string that is expanded and used as a response
30839 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30840 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30841 there is some complication if &%endpass%& is involved; see the description of
30842 &%accept%& for details.)
30843
30844 The expansion of the message happens at the time Exim decides that the ACL is
30845 to end, not at the time it processes &%message%&. If the expansion fails, or
30846 generates an empty string, the modifier is ignored. Here is an example where
30847 &%message%& must be specified first, because the ACL ends with a rejection if
30848 the &%hosts%& condition fails:
30849 .code
30850 require  message = Host not recognized
30851          hosts = 10.0.0.0/8
30852 .endd
30853 (Once a condition has failed, no further conditions or modifiers are
30854 processed.)
30855
30856 .cindex "SMTP" "error codes"
30857 .oindex "&%smtp_banner%&
30858 For ACLs that are triggered by SMTP commands, the message is returned as part
30859 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30860 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30861 is accepted. In the case of the connect ACL, accepting with a message modifier
30862 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30863 accept message may not contain more than one line (otherwise it will be
30864 truncated at the first newline and a panic logged), and it cannot affect the
30865 EHLO options.
30866
30867 When SMTP is involved, the message may begin with an overriding response code,
30868 consisting of three digits optionally followed by an &"extended response code"&
30869 of the form &'n.n.n'&, each code being followed by a space. For example:
30870 .code
30871 deny  message = 599 1.2.3 Host not welcome
30872       hosts = 192.168.34.0/24
30873 .endd
30874 The first digit of the supplied response code must be the same as would be sent
30875 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30876 access, but for the predata ACL, note that the default success code is 354, not
30877 2&'xx'&.
30878
30879 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30880 the message modifier cannot override the 221 response code.
30881
30882 The text in a &%message%& modifier is literal; any quotes are taken as
30883 literals, but because the string is expanded, backslash escapes are processed
30884 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30885 response.
30886
30887 .vindex "&$acl_verify_message$&"
30888 For ACLs that are called by an &%acl =%& ACL condition, the message is
30889 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30890
30891 If &%message%& is used on a statement that verifies an address, the message
30892 specified overrides any message that is generated by the verification process.
30893 However, the original message is available in the variable
30894 &$acl_verify_message$&, so you can incorporate it into your message if you
30895 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30896 routers to be passed back as part of the SMTP response, you should either not
30897 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30898
30899 For compatibility with previous releases of Exim, a &%message%& modifier that
30900 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30901 modifier, but this usage is now deprecated. However, &%message%& acts only when
30902 all the conditions are true, wherever it appears in an ACL command, whereas
30903 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30904 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30905 effect.
30906
30907
30908 .vitem &*queue*&&~=&~<&'text'&>
30909 .cindex "&%queue%& ACL modifier"
30910 .cindex "named queues" "selecting in ACL"
30911 This modifier specifies the use of a named queue for spool files
30912 for the message.
30913 It can only be used before the message is received (i.e. not in
30914 the DATA ACL).
30915 This could be used, for example, for known high-volume burst sources
30916 of traffic, or for quarantine of messages.
30917 Separate queue-runner processes will be needed for named queues.
30918 If the text after expansion is empty, the default queue is used.
30919
30920
30921 .vitem &*remove_header*&&~=&~<&'text'&>
30922 This modifier specifies one or more header names in a colon-separated list
30923  that are to be removed from an incoming message, assuming, of course, that
30924 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30925
30926
30927 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30928 .cindex "&%set%& ACL modifier"
30929 This modifier puts a value into one of the ACL variables (see section
30930 &<<SECTaclvariables>>&).
30931
30932
30933 .vitem &*udpsend*&&~=&~<&'parameters'&>
30934 .cindex "UDP communications"
30935 This modifier sends a UDP packet, for purposes such as statistics
30936 collection or behaviour monitoring. The parameters are expanded, and
30937 the result of the expansion must be a colon-separated list consisting
30938 of a destination server, port number, and the packet contents. The
30939 server can be specified as a host name or IPv4 or IPv6 address. The
30940 separator can be changed with the usual angle bracket syntax. For
30941 example, you might want to collect information on which hosts connect
30942 when:
30943 .code
30944 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30945              $tod_zulu $sender_host_address
30946 .endd
30947 .endlist
30948
30949
30950
30951
30952 .section "Use of the control modifier" "SECTcontrols"
30953 .cindex "&%control%& ACL modifier"
30954 The &%control%& modifier supports the following settings:
30955
30956 .vlist
30957 .vitem &*control&~=&~allow_auth_unadvertised*&
30958 This modifier allows a client host to use the SMTP AUTH command even when it
30959 has not been advertised in response to EHLO. Furthermore, because there are
30960 apparently some really broken clients that do this, Exim will accept AUTH after
30961 HELO (rather than EHLO) when this control is set. It should be used only if you
30962 really need it, and you should limit its use to those broken clients that do
30963 not work without it. For example:
30964 .code
30965 warn hosts   = 192.168.34.25
30966      control = allow_auth_unadvertised
30967 .endd
30968 Normally, when an Exim server receives an AUTH command, it checks the name of
30969 the authentication mechanism that is given in the command to ensure that it
30970 matches an advertised mechanism. When this control is set, the check that a
30971 mechanism has been advertised is bypassed. Any configured mechanism can be used
30972 by the client. This control is permitted only in the connection and HELO ACLs.
30973
30974
30975 .vitem &*control&~=&~caseful_local_part*& &&&
30976        &*control&~=&~caselower_local_part*&
30977 .cindex "&ACL;" "case of local part in"
30978 .cindex "case of local parts"
30979 .vindex "&$local_part$&"
30980 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30981 (that is, during RCPT processing). By default, the contents of &$local_part$&
30982 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30983 any uppercase letters in the original local part are restored in &$local_part$&
30984 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30985 is encountered.
30986
30987 These controls affect only the current recipient. Moreover, they apply only to
30988 local part handling that takes place directly in the ACL (for example, as a key
30989 in lookups). If a test to verify the recipient is obeyed, the case-related
30990 handling of the local part during the verification is controlled by the router
30991 configuration (see the &%caseful_local_part%& generic router option).
30992
30993 This facility could be used, for example, to add a spam score to local parts
30994 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30995 spam score:
30996 .code
30997 warn  control = caseful_local_part
30998       set acl_m4 = ${eval:\
30999                      $acl_m4 + \
31000                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31001                     }
31002       control = caselower_local_part
31003 .endd
31004 Notice that we put back the lower cased version afterwards, assuming that
31005 is what is wanted for subsequent tests.
31006
31007
31008 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31009 .cindex "&ACL;" "cutthrough routing"
31010 .cindex "cutthrough" "requesting"
31011 This option requests delivery be attempted while the item is being received.
31012
31013 The option is usable in the RCPT ACL.
31014 If enabled for a message received via smtp and routed to an smtp transport,
31015 and only one transport, interface, destination host and port combination
31016 is used for all recipients of the message,
31017 then the delivery connection is made while the receiving connection is open
31018 and data is copied from one to the other.
31019
31020 An attempt to set this option for any recipient but the first
31021 for a mail will be quietly ignored.
31022 If a recipient-verify callout
31023 (with use_sender)
31024 connection is subsequently
31025 requested in the same ACL it is held open and used for
31026 any subsequent recipients and the data,
31027 otherwise one is made after the initial RCPT ACL completes.
31028
31029 Note that routers are used in verify mode,
31030 and cannot depend on content of received headers.
31031 Note also that headers cannot be
31032 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31033 Headers may be modified by routers (subject to the above) and transports.
31034 The &'Received-By:'& header is generated as soon as the body reception starts,
31035 rather than the traditional time after the full message is received;
31036 this will affect the timestamp.
31037
31038 All the usual ACLs are called; if one results in the message being
31039 rejected, all effort spent in delivery (including the costs on
31040 the ultimate destination) will be wasted.
31041 Note that in the case of data-time ACLs this includes the entire
31042 message body.
31043
31044 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31045 of outgoing messages is done, because it sends data to the ultimate destination
31046 before the entire message has been received from the source.
31047 It is not supported for messages received with the SMTP PRDR
31048 or CHUNKING
31049 options in use.
31050
31051 Should the ultimate destination system positively accept or reject the mail,
31052 a corresponding indication is given to the source system and nothing is queued.
31053 If the item is successfully delivered in cutthrough mode
31054 the delivery log lines are tagged with ">>" rather than "=>" and appear
31055 before the acceptance "<=" line.
31056
31057 If there is a temporary error the item is queued for later delivery in the
31058 usual fashion.
31059 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31060 to the control; the default value is &"spool"& and the alternate value
31061 &"pass"& copies an SMTP defer response from the target back to the initiator
31062 and does not queue the message.
31063 Note that this is independent of any recipient verify conditions in the ACL.
31064
31065 Delivery in this mode avoids the generation of a bounce mail to a
31066 (possibly faked)
31067 sender when the destination system is doing content-scan based rejection.
31068
31069
31070 .vitem &*control&~=&~debug/*&<&'options'&>
31071 .cindex "&ACL;" "enabling debug logging"
31072 .cindex "debugging" "enabling from an ACL"
31073 This control turns on debug logging, almost as though Exim had been invoked
31074 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31075 by default called &'debuglog'&.
31076 The filename can be adjusted with the &'tag'& option, which
31077 may access any variables already defined.  The logging may be adjusted with
31078 the &'opts'& option, which takes the same values as the &`-d`& command-line
31079 option.
31080 Logging started this way may be stopped, and the file removed,
31081 with the &'kill'& option.
31082 Some examples (which depend on variables that don't exist in all
31083 contexts):
31084 .code
31085       control = debug
31086       control = debug/tag=.$sender_host_address
31087       control = debug/opts=+expand+acl
31088       control = debug/tag=.$message_exim_id/opts=+expand
31089       control = debug/kill
31090 .endd
31091
31092
31093 .vitem &*control&~=&~dkim_disable_verify*&
31094 .cindex "disable DKIM verify"
31095 .cindex "DKIM" "disable verify"
31096 This control turns off DKIM verification processing entirely.  For details on
31097 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31098
31099
31100 .vitem &*control&~=&~dmarc_disable_verify*&
31101 .cindex "disable DMARC verify"
31102 .cindex "DMARC" "disable verify"
31103 This control turns off DMARC verification processing entirely.  For details on
31104 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31105
31106
31107 .vitem &*control&~=&~dscp/*&<&'value'&>
31108 .cindex "&ACL;" "setting DSCP value"
31109 .cindex "DSCP" "inbound"
31110 This option causes the DSCP value associated with the socket for the inbound
31111 connection to be adjusted to a given value, given as one of a number of fixed
31112 strings or to numeric value.
31113 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31114 Common values include &`throughput`&, &`mincost`&, and on newer systems
31115 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31116
31117 The outbound packets from Exim will be marked with this value in the header
31118 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31119 that these values will have any effect, not be stripped by networking
31120 equipment, or do much of anything without cooperation with your Network
31121 Engineer and those of all network operators between the source and destination.
31122
31123
31124 .vitem &*control&~=&~enforce_sync*& &&&
31125        &*control&~=&~no_enforce_sync*&
31126 .cindex "SMTP" "synchronization checking"
31127 .cindex "synchronization checking in SMTP"
31128 These controls make it possible to be selective about when SMTP synchronization
31129 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31130 state of the switch (it is true by default). See the description of this option
31131 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31132
31133 The effect of these two controls lasts for the remainder of the SMTP
31134 connection. They can appear in any ACL except the one for the non-SMTP
31135 messages. The most straightforward place to put them is in the ACL defined by
31136 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31137 before the first synchronization check. The expected use is to turn off the
31138 synchronization checks for badly-behaved hosts that you nevertheless need to
31139 work with.
31140
31141
31142 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31143 .cindex "fake defer"
31144 .cindex "defer, fake"
31145 This control works in exactly the same way as &%fakereject%& (described below)
31146 except that it causes an SMTP 450 response after the message data instead of a
31147 550 response. You must take care when using &%fakedefer%& because it causes the
31148 messages to be duplicated when the sender retries. Therefore, you should not
31149 use &%fakedefer%& if the message is to be delivered normally.
31150
31151 .vitem &*control&~=&~fakereject/*&<&'message'&>
31152 .cindex "fake rejection"
31153 .cindex "rejection, fake"
31154 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31155 words, only when an SMTP message is being received. If Exim accepts the
31156 message, instead the final 250 response, a 550 rejection message is sent.
31157 However, Exim proceeds to deliver the message as normal. The control applies
31158 only to the current message, not to any subsequent ones that may be received in
31159 the same SMTP connection.
31160
31161 The text for the 550 response is taken from the &%control%& modifier. If no
31162 message is supplied, the following is used:
31163 .code
31164 550-Your message has been rejected but is being
31165 550-kept for evaluation.
31166 550-If it was a legitimate message, it may still be
31167 550 delivered to the target recipient(s).
31168 .endd
31169 This facility should be used with extreme caution.
31170
31171 .vitem &*control&~=&~freeze*&
31172 .cindex "frozen messages" "forcing in ACL"
31173 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31174 other words, only when a message is being received. If the message is accepted,
31175 it is placed on Exim's queue and frozen. The control applies only to the
31176 current message, not to any subsequent ones that may be received in the same
31177 SMTP connection.
31178
31179 This modifier can optionally be followed by &`/no_tell`&. If the global option
31180 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31181 is told about the freezing), provided all the &*control=freeze*& modifiers that
31182 are obeyed for the current message have the &`/no_tell`& option.
31183
31184 .vitem &*control&~=&~no_delay_flush*&
31185 .cindex "SMTP" "output flushing, disabling for delay"
31186 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31187 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31188 use. This control, as long as it is encountered before the &%delay%& modifier,
31189 disables such output flushing.
31190
31191 .vitem &*control&~=&~no_callout_flush*&
31192 .cindex "SMTP" "output flushing, disabling for callout"
31193 Exim normally flushes SMTP output before performing a callout in an ACL, to
31194 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31195 use. This control, as long as it is encountered before the &%verify%& condition
31196 that causes the callout, disables such output flushing.
31197
31198 .vitem &*control&~=&~no_mbox_unspool*&
31199 This control is available when Exim is compiled with the content scanning
31200 extension. Content scanning may require a copy of the current message, or parts
31201 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31202 or spam scanner. Normally, such copies are deleted when they are no longer
31203 needed. If this control is set, the copies are not deleted. The control applies
31204 only to the current message, not to any subsequent ones that may be received in
31205 the same SMTP connection. It is provided for debugging purposes and is unlikely
31206 to be useful in production.
31207
31208 .vitem &*control&~=&~no_multiline_responses*&
31209 .cindex "multiline responses, suppressing"
31210 This control is permitted for any ACL except the one for non-SMTP messages.
31211 It seems that there are broken clients in use that cannot handle multiline
31212 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31213
31214 If this control is set, multiline SMTP responses from ACL rejections are
31215 suppressed. One way of doing this would have been to put out these responses as
31216 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31217 (&"use multiline responses for more"& it says &-- ha!), and some of the
31218 responses might get close to that. So this facility, which is after all only a
31219 sop to broken clients, is implemented by doing two very easy things:
31220
31221 .ilist
31222 Extra information that is normally output as part of a rejection caused by
31223 sender verification failure is omitted. Only the final line (typically &"sender
31224 verification failed"&) is sent.
31225 .next
31226 If a &%message%& modifier supplies a multiline response, only the first
31227 line is output.
31228 .endlist
31229
31230 The setting of the switch can, of course, be made conditional on the
31231 calling host. Its effect lasts until the end of the SMTP connection.
31232
31233 .vitem &*control&~=&~no_pipelining*&
31234 .cindex "PIPELINING" "suppressing advertising"
31235 .cindex "ESMTP extensions" PIPELINING
31236 This control turns off the advertising of the PIPELINING extension to SMTP in
31237 the current session. To be useful, it must be obeyed before Exim sends its
31238 response to an EHLO command. Therefore, it should normally appear in an ACL
31239 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31240 &%pipelining_advertise_hosts%&.
31241
31242 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31243        &*control&~=&~queue_only*&
31244 .oindex "&%queue%&"
31245 .oindex "&%queue_only%&"
31246 .cindex "queueing incoming messages"
31247 .cindex queueing "forcing in ACL"
31248 .cindex "first pass routing"
31249 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31250 other words, only when a message is being received. If the message is accepted,
31251 it is placed on Exim's queue and left there for delivery by a subsequent queue
31252 runner.
31253 If used with no options set,
31254 no immediate delivery process is started. In other words, it has the
31255 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31256
31257 If the &'first_pass_route'& option is given then
31258 the behaviour is like the command-line &'-oqds'& option;
31259 a delivery process is started which stops short of making
31260 any SMTP delivery.  The benefit is that the hints database will be updated for
31261 the message being waiting for a specific host, and a later queue run will be
31262 able to send all such messages on a single connection.
31263
31264 The control only applies to the current message, not to any subsequent ones that
31265  may be received in the same SMTP connection.
31266
31267 .vitem &*control&~=&~submission/*&<&'options'&>
31268 .cindex "message" "submission"
31269 .cindex "submission mode"
31270 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31271 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31272 the current message is a submission from a local MUA. In this case, Exim
31273 operates in &"submission mode"&, and applies certain fixups to the message if
31274 necessary. For example, it adds a &'Date:'& header line if one is not present.
31275 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31276 late (the message has already been created).
31277
31278 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31279 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31280 submission mode; the available options for this control are described there.
31281 The control applies only to the current message, not to any subsequent ones
31282 that may be received in the same SMTP connection.
31283
31284 .vitem &*control&~=&~suppress_local_fixups*&
31285 .cindex "submission fixups, suppressing"
31286 This control applies to locally submitted (non TCP/IP) messages, and is the
31287 complement of &`control = submission`&. It disables the fixups that are
31288 normally applied to locally-submitted messages. Specifically:
31289
31290 .ilist
31291 Any &'Sender:'& header line is left alone (in this respect, it is a
31292 dynamic version of &%local_sender_retain%&).
31293 .next
31294 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31295 .next
31296 There is no check that &'From:'& corresponds to the actual sender.
31297 .endlist ilist
31298
31299 This control may be useful when a remotely-originated message is accepted,
31300 passed to some scanning program, and then re-submitted for delivery. It can be
31301 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31302 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31303 data is read.
31304
31305 &*Note:*& This control applies only to the current message, not to any others
31306 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31307
31308 .vitem &*control&~=&~utf8_downconvert*&
31309 This control enables conversion of UTF-8 in message envelope addresses
31310 to a-label form.
31311 For details see section &<<SECTi18nMTA>>&.
31312 .endlist vlist
31313
31314
31315 .section "Summary of message fixup control" "SECTsummesfix"
31316 All four possibilities for message fixups can be specified:
31317
31318 .ilist
31319 Locally submitted, fixups applied: the default.
31320 .next
31321 Locally submitted, no fixups applied: use
31322 &`control = suppress_local_fixups`&.
31323 .next
31324 Remotely submitted, no fixups applied: the default.
31325 .next
31326 Remotely submitted, fixups applied: use &`control = submission`&.
31327 .endlist
31328
31329
31330
31331 .section "Adding header lines in ACLs" "SECTaddheadacl"
31332 .cindex "header lines" "adding in an ACL"
31333 .cindex "header lines" "position of added lines"
31334 .cindex "&%add_header%& ACL modifier"
31335 The &%add_header%& modifier can be used to add one or more extra header lines
31336 to an incoming message, as in this example:
31337 .code
31338 warn dnslists = sbl.spamhaus.org : \
31339                 dialup.mail-abuse.org
31340      add_header = X-blacklisted-at: $dnslist_domain
31341 .endd
31342 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31343 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31344 receiving a message). The message must ultimately be accepted for
31345 &%add_header%& to have any significant effect. You can use &%add_header%& with
31346 any ACL verb, including &%deny%& (though this is potentially useful only in a
31347 RCPT ACL).
31348
31349 Headers will not be added to the message if the modifier is used in
31350 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31351
31352 Leading and trailing newlines are removed from
31353 the data for the &%add_header%& modifier; if it then
31354 contains one or more newlines that
31355 are not followed by a space or a tab, it is assumed to contain multiple header
31356 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31357 front of any line that is not a valid header line.
31358
31359 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31360 They are added to the message before processing the DATA and MIME ACLs.
31361 However, if an identical header line is requested more than once, only one copy
31362 is actually added to the message. Further header lines may be accumulated
31363 during the DATA and MIME ACLs, after which they are added to the message, again
31364 with duplicates suppressed. Thus, it is possible to add two identical header
31365 lines to an SMTP message, but only if one is added before DATA and one after.
31366 In the case of non-SMTP messages, new headers are accumulated during the
31367 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31368 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31369 are included in the entry that is written to the reject log.
31370
31371 .cindex "header lines" "added; visibility of"
31372 Header lines are not visible in string expansions
31373 of message headers
31374 until they are added to the
31375 message. It follows that header lines defined in the MAIL, RCPT, and predata
31376 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31377 header lines that are added by the DATA or MIME ACLs are not visible in those
31378 ACLs. Because of this restriction, you cannot use header lines as a way of
31379 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31380 this, you can use ACL variables, as described in section
31381 &<<SECTaclvariables>>&.
31382
31383 The list of headers yet to be added is given by the &%$headers_added%& variable.
31384
31385 The &%add_header%& modifier acts immediately as it is encountered during the
31386 processing of an ACL. Notice the difference between these two cases:
31387 .display
31388 &`accept add_header = ADDED: some text`&
31389 &`       `&<&'some condition'&>
31390
31391 &`accept `&<&'some condition'&>
31392 &`       add_header = ADDED: some text`&
31393 .endd
31394 In the first case, the header line is always added, whether or not the
31395 condition is true. In the second case, the header line is added only if the
31396 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31397 ACL statement. All those that are encountered before a condition fails are
31398 honoured.
31399
31400 .cindex "&%warn%& ACL verb"
31401 For compatibility with previous versions of Exim, a &%message%& modifier for a
31402 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31403 effect only if all the conditions are true, even if it appears before some of
31404 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31405 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31406 are present on a &%warn%& verb, both are processed according to their
31407 specifications.
31408
31409 By default, new header lines are added to a message at the end of the existing
31410 header lines. However, you can specify that any particular header line should
31411 be added right at the start (before all the &'Received:'& lines), immediately
31412 after the first block of &'Received:'& lines, or immediately before any line
31413 that is not a &'Received:'& or &'Resent-something:'& header.
31414
31415 This is done by specifying &":at_start:"&, &":after_received:"&, or
31416 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31417 header line, respectively. (Header text cannot start with a colon, as there has
31418 to be a header name first.) For example:
31419 .code
31420 warn add_header = \
31421        :after_received:X-My-Header: something or other...
31422 .endd
31423 If more than one header line is supplied in a single &%add_header%& modifier,
31424 each one is treated independently and can therefore be placed differently. If
31425 you add more than one line at the start, or after the Received: block, they end
31426 up in reverse order.
31427
31428 &*Warning*&: This facility currently applies only to header lines that are
31429 added in an ACL. It does NOT work for header lines that are added in a
31430 system filter or in a router or transport.
31431
31432
31433
31434 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31435 .cindex "header lines" "removing in an ACL"
31436 .cindex "header lines" "position of removed lines"
31437 .cindex "&%remove_header%& ACL modifier"
31438 The &%remove_header%& modifier can be used to remove one or more header lines
31439 from an incoming message, as in this example:
31440 .code
31441 warn   message        = Remove internal headers
31442        remove_header  = x-route-mail1 : x-route-mail2
31443 .endd
31444 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31445 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31446 receiving a message). The message must ultimately be accepted for
31447 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31448 with any ACL verb, including &%deny%&, though this is really not useful for
31449 any verb that doesn't result in a delivered message.
31450
31451 Headers will not be removed from the message if the modifier is used in
31452 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31453
31454 More than one header can be removed at the same time by using a colon separated
31455 list of header names. The header matching is case insensitive. Wildcards are
31456 not permitted, nor is list expansion performed, so you cannot use hostlists to
31457 create a list of headers, however both connection and message variable expansion
31458 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31459 .code
31460 warn   hosts           = +internal_hosts
31461        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31462 warn   message         = Remove internal headers
31463        remove_header   = $acl_c_ihdrs
31464 .endd
31465 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31466 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31467 If multiple header lines match, all are removed.
31468 There is no harm in attempting to remove the same header twice nor in removing
31469 a non-existent header. Further header lines to be removed may be accumulated
31470 during the DATA and MIME ACLs, after which they are removed from the message,
31471 if present. In the case of non-SMTP messages, headers to be removed are
31472 accumulated during the non-SMTP ACLs, and are removed from the message after
31473 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31474 ACL, there really is no effect because there is no logging of what headers
31475 would have been removed.
31476
31477 .cindex "header lines" "removed; visibility of"
31478 Header lines are not visible in string expansions until the DATA phase when it
31479 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31480 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31481 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31482 this restriction, you cannot use header lines as a way of controlling data
31483 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31484 you should instead use ACL variables, as described in section
31485 &<<SECTaclvariables>>&.
31486
31487 The &%remove_header%& modifier acts immediately as it is encountered during the
31488 processing of an ACL. Notice the difference between these two cases:
31489 .display
31490 &`accept remove_header = X-Internal`&
31491 &`       `&<&'some condition'&>
31492
31493 &`accept `&<&'some condition'&>
31494 &`       remove_header = X-Internal`&
31495 .endd
31496 In the first case, the header line is always removed, whether or not the
31497 condition is true. In the second case, the header line is removed only if the
31498 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31499 same ACL statement. All those that are encountered before a condition fails
31500 are honoured.
31501
31502 &*Warning*&: This facility currently applies only to header lines that are
31503 present during ACL processing. It does NOT remove header lines that are added
31504 in a system filter or in a router or transport.
31505
31506
31507
31508
31509 .section "ACL conditions" "SECTaclconditions"
31510 .cindex "&ACL;" "conditions; list of"
31511 Some of the conditions listed in this section are available only when Exim is
31512 compiled with the content-scanning extension. They are included here briefly
31513 for completeness. More detailed descriptions can be found in the discussion on
31514 content scanning in chapter &<<CHAPexiscan>>&.
31515
31516 Not all conditions are relevant in all circumstances. For example, testing
31517 senders and recipients does not make sense in an ACL that is being run as the
31518 result of the arrival of an ETRN command, and checks on message headers can be
31519 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31520 can use the same condition (with different parameters) more than once in the
31521 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31522 The conditions are as follows:
31523
31524
31525 .vlist
31526 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31527 .cindex "&ACL;" "nested"
31528 .cindex "&ACL;" "indirect"
31529 .cindex "&ACL;" "arguments"
31530 .cindex "&%acl%& ACL condition"
31531 The possible values of the argument are the same as for the
31532 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31533 &"accept"& the condition is true; if it returns &"deny"& the condition is
31534 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31535 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31536 condition false. This means that further processing of the &%warn%& verb
31537 ceases, but processing of the ACL continues.
31538
31539 If the argument is a named ACL, up to nine space-separated optional values
31540 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31541 and $acl_narg is set to the count of values.
31542 Previous values of these variables are restored after the call returns.
31543 The name and values are expanded separately.
31544 Note that spaces in complex expansions which are used as arguments
31545 will act as argument separators.
31546
31547 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31548 the connection is dropped. If it returns &"discard"&, the verb must be
31549 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31550 conditions are tested.
31551
31552 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31553 loops. This condition allows you to use different ACLs in different
31554 circumstances. For example, different ACLs can be used to handle RCPT commands
31555 for different local users or different local domains.
31556
31557 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31558 .cindex "&%authenticated%& ACL condition"
31559 .cindex "authentication" "ACL checking"
31560 .cindex "&ACL;" "testing for authentication"
31561 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31562 the name of the authenticator is tested against the list. To test for
31563 authentication by any authenticator, you can set
31564 .code
31565 authenticated = *
31566 .endd
31567
31568 .vitem &*condition&~=&~*&<&'string'&>
31569 .cindex "&%condition%& ACL condition"
31570 .cindex "customizing" "ACL condition"
31571 .cindex "&ACL;" "customized test"
31572 .cindex "&ACL;" "testing, customized"
31573 This feature allows you to make up custom conditions. If the result of
31574 expanding the string is an empty string, the number zero, or one of the strings
31575 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31576 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31577 any other value, some error is assumed to have occurred, and the ACL returns
31578 &"defer"&. However, if the expansion is forced to fail, the condition is
31579 ignored. The effect is to treat it as true, whether it is positive or
31580 negative.
31581
31582 .vitem &*decode&~=&~*&<&'location'&>
31583 .cindex "&%decode%& ACL condition"
31584 This condition is available only when Exim is compiled with the
31585 content-scanning extension, and it is allowed only in the ACL defined by
31586 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31587 If all goes well, the condition is true. It is false only if there are
31588 problems such as a syntax error or a memory shortage. For more details, see
31589 chapter &<<CHAPexiscan>>&.
31590
31591 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31592 .cindex "&%dnslists%& ACL condition"
31593 .cindex "DNS list" "in ACL"
31594 .cindex "black list (DNS)"
31595 .cindex "&ACL;" "testing a DNS list"
31596 This condition checks for entries in DNS black lists. These are also known as
31597 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31598 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31599 different variants of this condition to describe briefly here. See sections
31600 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31601
31602 .vitem &*domains&~=&~*&<&'domain&~list'&>
31603 .cindex "&%domains%& ACL condition"
31604 .cindex "domain" "ACL checking"
31605 .cindex "&ACL;" "testing a recipient domain"
31606 .vindex "&$domain_data$&"
31607 This condition is relevant only after a RCPT command. It checks that the domain
31608 of the recipient address is in the domain list. If percent-hack processing is
31609 enabled, it is done before this test is done. If the check succeeds with a
31610 lookup, the result of the lookup is placed in &$domain_data$& until the next
31611 &%domains%& test.
31612
31613 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31614 use &%domains%& in a DATA ACL.
31615
31616
31617 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31618 .cindex "&%encrypted%& ACL condition"
31619 .cindex "encryption" "checking in an ACL"
31620 .cindex "&ACL;" "testing for encryption"
31621 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31622 name of the cipher suite in use is tested against the list. To test for
31623 encryption without testing for any specific cipher suite(s), set
31624 .code
31625 encrypted = *
31626 .endd
31627
31628
31629 .vitem &*hosts&~=&~*&<&'host&~list'&>
31630 .cindex "&%hosts%& ACL condition"
31631 .cindex "host" "ACL checking"
31632 .cindex "&ACL;" "testing the client host"
31633 This condition tests that the calling host matches the host list. If you have
31634 name lookups or wildcarded host names and IP addresses in the same host list,
31635 you should normally put the IP addresses first. For example, you could have:
31636 .code
31637 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31638 .endd
31639 The lookup in this example uses the host name for its key. This is implied by
31640 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31641 and it wouldn't matter which way round you had these two items.)
31642
31643 The reason for the problem with host names lies in the left-to-right way that
31644 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31645 but when it reaches an item that requires a host name, it fails if it cannot
31646 find a host name to compare with the pattern. If the above list is given in the
31647 opposite order, the &%accept%& statement fails for a host whose name cannot be
31648 found, even if its IP address is 10.9.8.7.
31649
31650 If you really do want to do the name check first, and still recognize the IP
31651 address even if the name lookup fails, you can rewrite the ACL like this:
31652 .code
31653 accept hosts = dbm;/etc/friendly/hosts
31654 accept hosts = 10.9.8.7
31655 .endd
31656 The default action on failing to find the host name is to assume that the host
31657 is not in the list, so the first &%accept%& statement fails. The second
31658 statement can then check the IP address.
31659
31660 .vindex "&$host_data$&"
31661 If a &%hosts%& condition is satisfied by means of a lookup, the result
31662 of the lookup is made available in the &$host_data$& variable. This
31663 allows you, for example, to set up a statement like this:
31664 .code
31665 deny  hosts = net-lsearch;/some/file
31666       message = $host_data
31667 .endd
31668 which gives a custom error message for each denied host.
31669
31670 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31671 .cindex "&%local_parts%& ACL condition"
31672 .cindex "local part" "ACL checking"
31673 .cindex "&ACL;" "testing a local part"
31674 .vindex "&$local_part_data$&"
31675 This condition is relevant only after a RCPT command. It checks that the local
31676 part of the recipient address is in the list. If percent-hack processing is
31677 enabled, it is done before this test. If the check succeeds with a lookup, the
31678 result of the lookup is placed in &$local_part_data$&, which remains set until
31679 the next &%local_parts%& test.
31680
31681 .vitem &*malware&~=&~*&<&'option'&>
31682 .cindex "&%malware%& ACL condition"
31683 .cindex "&ACL;" "virus scanning"
31684 .cindex "&ACL;" "scanning for viruses"
31685 This condition is available only when Exim is compiled with the
31686 content-scanning extension
31687 and only after a DATA command.
31688 It causes the incoming message to be scanned for
31689 viruses. For details, see chapter &<<CHAPexiscan>>&.
31690
31691 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31692 .cindex "&%mime_regex%& ACL condition"
31693 .cindex "&ACL;" "testing by regex matching"
31694 This condition is available only when Exim is compiled with the
31695 content-scanning extension, and it is allowed only in the ACL defined by
31696 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31697 with any of the regular expressions. For details, see chapter
31698 &<<CHAPexiscan>>&.
31699
31700 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31701 .cindex "rate limiting"
31702 This condition can be used to limit the rate at which a user or host submits
31703 messages. Details are given in section &<<SECTratelimiting>>&.
31704
31705 .vitem &*recipients&~=&~*&<&'address&~list'&>
31706 .cindex "&%recipients%& ACL condition"
31707 .cindex "recipient" "ACL checking"
31708 .cindex "&ACL;" "testing a recipient"
31709 This condition is relevant only after a RCPT command. It checks the entire
31710 recipient address against a list of recipients.
31711
31712 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31713 .cindex "&%regex%& ACL condition"
31714 .cindex "&ACL;" "testing by regex matching"
31715 This condition is available only when Exim is compiled with the
31716 content-scanning extension, and is available only in the DATA, MIME, and
31717 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31718 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31719
31720 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31721 .cindex "&%sender_domains%& ACL condition"
31722 .cindex "sender" "ACL checking"
31723 .cindex "&ACL;" "testing a sender domain"
31724 .vindex "&$domain$&"
31725 .vindex "&$sender_address_domain$&"
31726 This condition tests the domain of the sender of the message against the given
31727 domain list. &*Note*&: The domain of the sender address is in
31728 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31729 of this condition. This is an exception to the general rule for testing domain
31730 lists. It is done this way so that, if this condition is used in an ACL for a
31731 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31732 influence the sender checking.
31733
31734 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31735 relaying, because sender addresses are easily, and commonly, forged.
31736
31737 .vitem &*senders&~=&~*&<&'address&~list'&>
31738 .cindex "&%senders%& ACL condition"
31739 .cindex "sender" "ACL checking"
31740 .cindex "&ACL;" "testing a sender"
31741 This condition tests the sender of the message against the given list. To test
31742 for a bounce message, which has an empty sender, set
31743 .code
31744 senders = :
31745 .endd
31746 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31747 relaying, because sender addresses are easily, and commonly, forged.
31748
31749 .vitem &*spam&~=&~*&<&'username'&>
31750 .cindex "&%spam%& ACL condition"
31751 .cindex "&ACL;" "scanning for spam"
31752 This condition is available only when Exim is compiled with the
31753 content-scanning extension. It causes the incoming message to be scanned by
31754 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31755
31756 .vitem &*verify&~=&~certificate*&
31757 .cindex "&%verify%& ACL condition"
31758 .cindex "TLS" "client certificate verification"
31759 .cindex "certificate" "verification of client"
31760 .cindex "&ACL;" "certificate verification"
31761 .cindex "&ACL;" "testing a TLS certificate"
31762 This condition is true in an SMTP session if the session is encrypted, and a
31763 certificate was received from the client, and the certificate was verified. The
31764 server requests a certificate only if the client matches &%tls_verify_hosts%&
31765 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31766
31767 .vitem &*verify&~=&~csa*&
31768 .cindex "CSA verification"
31769 This condition checks whether the sending host (the client) is authorized to
31770 send email. Details of how this works are given in section
31771 &<<SECTverifyCSA>>&.
31772
31773 .vitem &*verify&~=&~header_names_ascii*&
31774 .cindex "&%verify%& ACL condition"
31775 .cindex "&ACL;" "verifying header names only ASCII"
31776 .cindex "header lines" "verifying header names only ASCII"
31777 .cindex "verifying" "header names only ASCII"
31778 This condition is relevant only in an ACL that is run after a message has been
31779 received, that is, in an ACL specified by &%acl_smtp_data%& or
31780 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31781 there are no non-ASCII characters, also excluding control characters.  The
31782 allowable characters are decimal ASCII values 33 through 126.
31783
31784 Exim itself will handle headers with non-ASCII characters, but it can cause
31785 problems for downstream applications, so this option will allow their
31786 detection and rejection in the DATA ACL's.
31787
31788 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31789 .cindex "&%verify%& ACL condition"
31790 .cindex "&ACL;" "verifying sender in the header"
31791 .cindex "header lines" "verifying the sender in"
31792 .cindex "sender" "verifying in header"
31793 .cindex "verifying" "sender in header"
31794 This condition is relevant only in an ACL that is run after a message has been
31795 received, that is, in an ACL specified by &%acl_smtp_data%& or
31796 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31797 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31798 is loosely thought of as a &"sender"& address (hence the name of the test).
31799 However, an address that appears in one of these headers need not be an address
31800 that accepts bounce messages; only sender addresses in envelopes are required
31801 to accept bounces. Therefore, if you use the callout option on this check, you
31802 might want to arrange for a non-empty address in the MAIL command.
31803
31804 Details of address verification and the options are given later, starting at
31805 section &<<SECTaddressverification>>& (callouts are described in section
31806 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31807 condition to restrict it to bounce messages only:
31808 .code
31809 deny    senders = :
31810        !verify  = header_sender
31811         message = A valid sender header is required for bounces
31812 .endd
31813
31814 .vitem &*verify&~=&~header_syntax*&
31815 .cindex "&%verify%& ACL condition"
31816 .cindex "&ACL;" "verifying header syntax"
31817 .cindex "header lines" "verifying syntax"
31818 .cindex "verifying" "header syntax"
31819 This condition is relevant only in an ACL that is run after a message has been
31820 received, that is, in an ACL specified by &%acl_smtp_data%& or
31821 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31822 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31823 and &'Bcc:'&), returning true if there are no problems.
31824 Unqualified addresses (local parts without domains) are
31825 permitted only in locally generated messages and from hosts that match
31826 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31827 appropriate.
31828
31829 Note that this condition is a syntax check only. However, a common spamming
31830 ploy used to be to send syntactically invalid headers such as
31831 .code
31832 To: @
31833 .endd
31834 and this condition can be used to reject such messages, though they are not as
31835 common as they used to be.
31836
31837 .vitem &*verify&~=&~helo*&
31838 .cindex "&%verify%& ACL condition"
31839 .cindex "&ACL;" "verifying HELO/EHLO"
31840 .cindex "HELO" "verifying"
31841 .cindex "EHLO" "verifying"
31842 .cindex "verifying" "EHLO"
31843 .cindex "verifying" "HELO"
31844 This condition is true if a HELO or EHLO command has been received from the
31845 client host, and its contents have been verified. If there has been no previous
31846 attempt to verify the HELO/EHLO contents, it is carried out when this
31847 condition is encountered. See the description of the &%helo_verify_hosts%& and
31848 &%helo_try_verify_hosts%& options for details of how to request verification
31849 independently of this condition, and for detail of the verification.
31850
31851 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31852 option), this condition is always true.
31853
31854
31855 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31856 .cindex "verifying" "not blind"
31857 .cindex "bcc recipients, verifying none"
31858 This condition checks that there are no blind (bcc) recipients in the message.
31859 Every envelope recipient must appear either in a &'To:'& header line or in a
31860 &'Cc:'& header line for this condition to be true. Local parts are checked
31861 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31862 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31863 used only in a DATA or non-SMTP ACL.
31864
31865 There is one possible option, &`case_insensitive`&.  If this is present then
31866 local parts are checked case-insensitively.
31867
31868 There are, of course, many legitimate messages that make use of blind (bcc)
31869 recipients. This check should not be used on its own for blocking messages.
31870
31871
31872 .vitem &*verify&~=&~recipient/*&<&'options'&>
31873 .cindex "&%verify%& ACL condition"
31874 .cindex "&ACL;" "verifying recipient"
31875 .cindex "recipient" "verifying"
31876 .cindex "verifying" "recipient"
31877 .vindex "&$address_data$&"
31878 This condition is relevant only after a RCPT command. It verifies the current
31879 recipient. Details of address verification are given later, starting at section
31880 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31881 of &$address_data$& is the last value that was set while routing the address.
31882 This applies even if the verification fails. When an address that is being
31883 verified is redirected to a single address, verification continues with the new
31884 address, and in that case, the subsequent value of &$address_data$& is the
31885 value for the child address.
31886
31887 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31888 .cindex "&%verify%& ACL condition"
31889 .cindex "&ACL;" "verifying host reverse lookup"
31890 .cindex "host" "verifying reverse lookup"
31891 This condition ensures that a verified host name has been looked up from the IP
31892 address of the client host. (This may have happened already if the host name
31893 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31894 Verification ensures that the host name obtained from a reverse DNS lookup, or
31895 one of its aliases, does, when it is itself looked up in the DNS, yield the
31896 original IP address.
31897
31898 There is one possible option, &`defer_ok`&.  If this is present and a
31899 DNS operation returns a temporary error, the verify condition succeeds.
31900
31901 If this condition is used for a locally generated message (that is, when there
31902 is no client host involved), it always succeeds.
31903
31904 .vitem &*verify&~=&~sender/*&<&'options'&>
31905 .cindex "&%verify%& ACL condition"
31906 .cindex "&ACL;" "verifying sender"
31907 .cindex "sender" "verifying"
31908 .cindex "verifying" "sender"
31909 This condition is relevant only after a MAIL or RCPT command, or after a
31910 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31911 the message's sender is empty (that is, this is a bounce message), the
31912 condition is true. Otherwise, the sender address is verified.
31913
31914 .vindex "&$address_data$&"
31915 .vindex "&$sender_address_data$&"
31916 If there is data in the &$address_data$& variable at the end of routing, its
31917 value is placed in &$sender_address_data$& at the end of verification. This
31918 value can be used in subsequent conditions and modifiers in the same ACL
31919 statement. It does not persist after the end of the current statement. If you
31920 want to preserve the value for longer, you can save it in an ACL variable.
31921
31922 Details of verification are given later, starting at section
31923 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31924 to avoid doing it more than once per message.
31925
31926 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31927 .cindex "&%verify%& ACL condition"
31928 This is a variation of the previous option, in which a modified address is
31929 verified as a sender.
31930
31931 Note that '/' is legal in local-parts; if the address may have such
31932 (eg. is generated from the received message)
31933 they must be protected from the options parsing by doubling:
31934 .code
31935 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31936 .endd
31937 .endlist
31938
31939
31940
31941 .section "Using DNS lists" "SECTmorednslists"
31942 .cindex "DNS list" "in ACL"
31943 .cindex "black list (DNS)"
31944 .cindex "&ACL;" "testing a DNS list"
31945 In its simplest form, the &%dnslists%& condition tests whether the calling host
31946 is on at least one of a number of DNS lists by looking up the inverted IP
31947 address in one or more DNS domains. (Note that DNS list domains are not mail
31948 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31949 special options instead.) For example, if the calling host's IP
31950 address is 192.168.62.43, and the ACL statement is
31951 .code
31952 deny dnslists = blackholes.mail-abuse.org : \
31953                 dialups.mail-abuse.org
31954 .endd
31955 the following records are looked up:
31956 .code
31957 43.62.168.192.blackholes.mail-abuse.org
31958 43.62.168.192.dialups.mail-abuse.org
31959 .endd
31960 As soon as Exim finds an existing DNS record, processing of the list stops.
31961 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31962 to test that a host is on more than one list (an &"and"& conjunction), you can
31963 use two separate conditions:
31964 .code
31965 deny dnslists = blackholes.mail-abuse.org
31966      dnslists = dialups.mail-abuse.org
31967 .endd
31968 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31969 behaves as if the host does not match the list item, that is, as if the DNS
31970 record does not exist. If there are further items in the DNS list, they are
31971 processed.
31972
31973 This is usually the required action when &%dnslists%& is used with &%deny%&
31974 (which is the most common usage), because it prevents a DNS failure from
31975 blocking mail. However, you can change this behaviour by putting one of the
31976 following special items in the list:
31977 .display
31978 &`+include_unknown `&   behave as if the item is on the list
31979 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31980 &`+defer_unknown   `&   give a temporary error
31981 .endd
31982 .cindex "&`+include_unknown`&"
31983 .cindex "&`+exclude_unknown`&"
31984 .cindex "&`+defer_unknown`&"
31985 Each of these applies to any subsequent items on the list. For example:
31986 .code
31987 deny dnslists = +defer_unknown : foo.bar.example
31988 .endd
31989 Testing the list of domains stops as soon as a match is found. If you want to
31990 warn for one list and block for another, you can use two different statements:
31991 .code
31992 deny  dnslists = blackholes.mail-abuse.org
31993 warn  dnslists = dialups.mail-abuse.org
31994       message  = X-Warn: sending host is on dialups list
31995 .endd
31996 .cindex caching "of dns lookup"
31997 .cindex DNS TTL
31998 DNS list lookups are cached by Exim for the duration of the SMTP session
31999 (but limited by the DNS return TTL value),
32000 so a lookup based on the IP address is done at most once for any incoming
32001 connection (assuming long-enough TTL).
32002 Exim does not share information between multiple incoming
32003 connections (but your local name server cache should be active).
32004
32005 There are a number of DNS lists to choose from, some commercial, some free,
32006 or free for small deployments.  An overview can be found at
32007 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32008
32009
32010
32011 .section "Specifying the IP address for a DNS list lookup" "SECID201"
32012 .cindex "DNS list" "keyed by explicit IP address"
32013 By default, the IP address that is used in a DNS list lookup is the IP address
32014 of the calling host. However, you can specify another IP address by listing it
32015 after the domain name, introduced by a slash. For example:
32016 .code
32017 deny dnslists = black.list.tld/192.168.1.2
32018 .endd
32019 This feature is not very helpful with explicit IP addresses; it is intended for
32020 use with IP addresses that are looked up, for example, the IP addresses of the
32021 MX hosts or nameservers of an email sender address. For an example, see section
32022 &<<SECTmulkeyfor>>& below.
32023
32024
32025
32026
32027 .section "DNS lists keyed on domain names" "SECID202"
32028 .cindex "DNS list" "keyed by domain name"
32029 There are some lists that are keyed on domain names rather than inverted IP
32030 addresses (see, e.g., the &'domain based zones'& link at
32031 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32032 with these lists. You can change the name that is looked up in a DNS list by
32033 listing it after the domain name, introduced by a slash. For example,
32034 .code
32035 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32036       message  = Sender's domain is listed at $dnslist_domain
32037 .endd
32038 This particular example is useful only in ACLs that are obeyed after the
32039 RCPT or DATA commands, when a sender address is available. If (for
32040 example) the message's sender is &'user@tld.example'& the name that is looked
32041 up by this example is
32042 .code
32043 tld.example.dsn.rfc-ignorant.org
32044 .endd
32045 A single &%dnslists%& condition can contain entries for both names and IP
32046 addresses. For example:
32047 .code
32048 deny dnslists = sbl.spamhaus.org : \
32049                 dsn.rfc-ignorant.org/$sender_address_domain
32050 .endd
32051 The first item checks the sending host's IP address; the second checks a domain
32052 name. The whole condition is true if either of the DNS lookups succeeds.
32053
32054
32055
32056
32057 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
32058 .cindex "DNS list" "multiple keys for"
32059 The syntax described above for looking up explicitly-defined values (either
32060 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32061 name for the DNS list, what follows the slash can in fact be a list of items.
32062 As with all lists in Exim, the default separator is a colon. However, because
32063 this is a sublist within the list of DNS blacklist domains, it is necessary
32064 either to double the separators like this:
32065 .code
32066 dnslists = black.list.tld/name.1::name.2
32067 .endd
32068 or to change the separator character, like this:
32069 .code
32070 dnslists = black.list.tld/<;name.1;name.2
32071 .endd
32072 If an item in the list is an IP address, it is inverted before the DNS
32073 blacklist domain is appended. If it is not an IP address, no inversion
32074 occurs. Consider this condition:
32075 .code
32076 dnslists = black.list.tld/<;192.168.1.2;a.domain
32077 .endd
32078 The DNS lookups that occur are:
32079 .code
32080 2.1.168.192.black.list.tld
32081 a.domain.black.list.tld
32082 .endd
32083 Once a DNS record has been found (that matches a specific IP return
32084 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32085 are done. If there is a temporary DNS error, the rest of the sublist of domains
32086 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32087 only if no other DNS lookup in this sublist succeeds. In other words, a
32088 successful lookup for any of the items in the sublist overrides a temporary
32089 error for a previous item.
32090
32091 The ability to supply a list of items after the slash is in some sense just a
32092 syntactic convenience. These two examples have the same effect:
32093 .code
32094 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32095 dnslists = black.list.tld/a.domain::b.domain
32096 .endd
32097 However, when the data for the list is obtained from a lookup, the second form
32098 is usually much more convenient. Consider this example:
32099 .code
32100 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32101                                    ${lookup dnsdb {>|mxh=\
32102                                    $sender_address_domain} }} }
32103      message  = The mail servers for the domain \
32104                 $sender_address_domain \
32105                 are listed at $dnslist_domain ($dnslist_value); \
32106                 see $dnslist_text.
32107 .endd
32108 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32109 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32110 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32111 of expanding the condition might be something like this:
32112 .code
32113 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32114 .endd
32115 Thus, this example checks whether or not the IP addresses of the sender
32116 domain's mail servers are on the Spamhaus black list.
32117
32118 The key that was used for a successful DNS list lookup is put into the variable
32119 &$dnslist_matched$& (see section &<<SECID204>>&).
32120
32121
32122
32123
32124 .section "Data returned by DNS lists" "SECID203"
32125 .cindex "DNS list" "data returned from"
32126 DNS lists are constructed using address records in the DNS. The original RBL
32127 just used the address 127.0.0.1 on the right hand side of each record, but the
32128 RBL+ list and some other lists use a number of values with different meanings.
32129 The values used on the RBL+ list are:
32130 .display
32131 127.1.0.1  RBL
32132 127.1.0.2  DUL
32133 127.1.0.3  DUL and RBL
32134 127.1.0.4  RSS
32135 127.1.0.5  RSS and RBL
32136 127.1.0.6  RSS and DUL
32137 127.1.0.7  RSS and DUL and RBL
32138 .endd
32139 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32140 different values. Some DNS lists may return more than one address record;
32141 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32142
32143
32144 .section "Variables set from DNS lists" "SECID204"
32145 .cindex "expansion" "variables, set from DNS list"
32146 .cindex "DNS list" "variables set from"
32147 .vindex "&$dnslist_domain$&"
32148 .vindex "&$dnslist_matched$&"
32149 .vindex "&$dnslist_text$&"
32150 .vindex "&$dnslist_value$&"
32151 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32152 the name of the overall domain that matched (for example,
32153 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32154 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32155 the DNS record. When the key is an IP address, it is not reversed in
32156 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32157 cases, for example:
32158 .code
32159 deny dnslists = spamhaus.example
32160 .endd
32161 the key is also available in another variable (in this case,
32162 &$sender_host_address$&). In more complicated cases, however, this is not true.
32163 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32164 might generate a dnslists lookup like this:
32165 .code
32166 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32167 .endd
32168 If this condition succeeds, the value in &$dnslist_matched$& might be
32169 &`192.168.6.7`& (for example).
32170
32171 If more than one address record is returned by the DNS lookup, all the IP
32172 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32173 The variable &$dnslist_text$& contains the contents of any associated TXT
32174 record. For lists such as RBL+ the TXT record for a merged entry is often not
32175 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32176 information.
32177
32178 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32179 &-- even if these appear before the condition in the ACL, they are not
32180 expanded until after it has failed. For example:
32181 .code
32182 deny    hosts = !+local_networks
32183         message = $sender_host_address is listed \
32184                   at $dnslist_domain
32185         dnslists = rbl-plus.mail-abuse.example
32186 .endd
32187
32188
32189
32190 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
32191 .cindex "DNS list" "matching specific returned data"
32192 You can add an equals sign and an IP address after a &%dnslists%& domain name
32193 in order to restrict its action to DNS records with a matching right hand side.
32194 For example,
32195 .code
32196 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32197 .endd
32198 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32199 any address record is considered to be a match. For the moment, we assume
32200 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32201 describes how multiple records are handled.
32202
32203 More than one IP address may be given for checking, using a comma as a
32204 separator. These are alternatives &-- if any one of them matches, the
32205 &%dnslists%& condition is true. For example:
32206 .code
32207 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32208 .endd
32209 If you want to specify a constraining address list and also specify names or IP
32210 addresses to be looked up, the constraining address list must be specified
32211 first. For example:
32212 .code
32213 deny dnslists = dsn.rfc-ignorant.org\
32214                 =127.0.0.2/$sender_address_domain
32215 .endd
32216
32217 If the character &`&&`& is used instead of &`=`&, the comparison for each
32218 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32219 In other words, the listed addresses are used as bit masks. The comparison is
32220 true if all the bits in the mask are present in the address that is being
32221 tested. For example:
32222 .code
32223 dnslists = a.b.c&0.0.0.3
32224 .endd
32225 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32226 want to test whether one bit or another bit is present (as opposed to both
32227 being present), you must use multiple values. For example:
32228 .code
32229 dnslists = a.b.c&0.0.0.1,0.0.0.2
32230 .endd
32231 matches if the final component of the address is an odd number or two times
32232 an odd number.
32233
32234
32235
32236 .section "Negated DNS matching conditions" "SECID205"
32237 You can supply a negative list of IP addresses as part of a &%dnslists%&
32238 condition. Whereas
32239 .code
32240 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32241 .endd
32242 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32243 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32244 .code
32245 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32246 .endd
32247 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32248 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32249 words, the result of the test is inverted if an exclamation mark appears before
32250 the &`=`& (or the &`&&`&) sign.
32251
32252 &*Note*&: This kind of negation is not the same as negation in a domain,
32253 host, or address list (which is why the syntax is different).
32254
32255 If you are using just one list, the negation syntax does not gain you much. The
32256 previous example is precisely equivalent to
32257 .code
32258 deny  dnslists = a.b.c
32259      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32260 .endd
32261 However, if you are using multiple lists, the negation syntax is clearer.
32262 Consider this example:
32263 .code
32264 deny  dnslists = sbl.spamhaus.org : \
32265                  list.dsbl.org : \
32266                  dnsbl.njabl.org!=127.0.0.3 : \
32267                  relays.ordb.org
32268 .endd
32269 Using only positive lists, this would have to be:
32270 .code
32271 deny  dnslists = sbl.spamhaus.org : \
32272                  list.dsbl.org
32273 deny  dnslists = dnsbl.njabl.org
32274      !dnslists = dnsbl.njabl.org=127.0.0.3
32275 deny  dnslists = relays.ordb.org
32276 .endd
32277 which is less clear, and harder to maintain.
32278
32279
32280
32281
32282 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32283 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32284 thereby providing more than one IP address. When an item in a &%dnslists%& list
32285 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32286 the match to specific results from the DNS lookup, there are two ways in which
32287 the checking can be handled. For example, consider the condition:
32288 .code
32289 dnslists = a.b.c=127.0.0.1
32290 .endd
32291 What happens if the DNS lookup for the incoming IP address yields both
32292 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32293 condition true because at least one given value was found, or is it false
32294 because at least one of the found values was not listed? And how does this
32295 affect negated conditions? Both possibilities are provided for with the help of
32296 additional separators &`==`& and &`=&&`&.
32297
32298 .ilist
32299 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32300 IP addresses matches one of the listed addresses. For the example above, the
32301 condition is true because 127.0.0.1 matches.
32302 .next
32303 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32304 looked up IP addresses matches one of the listed addresses. If the condition is
32305 changed to:
32306 .code
32307 dnslists = a.b.c==127.0.0.1
32308 .endd
32309 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32310 false because 127.0.0.2 is not listed. You would need to have:
32311 .code
32312 dnslists = a.b.c==127.0.0.1,127.0.0.2
32313 .endd
32314 for the condition to be true.
32315 .endlist
32316
32317 When &`!`& is used to negate IP address matching, it inverts the result, giving
32318 the precise opposite of the behaviour above. Thus:
32319 .ilist
32320 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32321 addresses matches one of the listed addresses. Consider:
32322 .code
32323 dnslists = a.b.c!&0.0.0.1
32324 .endd
32325 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32326 false because 127.0.0.1 matches.
32327 .next
32328 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32329 looked up IP address that does not match. Consider:
32330 .code
32331 dnslists = a.b.c!=&0.0.0.1
32332 .endd
32333 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32334 true, because 127.0.0.2 does not match. You would need to have:
32335 .code
32336 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32337 .endd
32338 for the condition to be false.
32339 .endlist
32340 When the DNS lookup yields only a single IP address, there is no difference
32341 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32342
32343
32344
32345
32346 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32347 .cindex "DNS list" "information from merged"
32348 When the facility for restricting the matching IP values in a DNS list is used,
32349 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32350 the true reason for rejection. This happens when lists are merged and the IP
32351 address in the A record is used to distinguish them; unfortunately there is
32352 only one TXT record. One way round this is not to use merged lists, but that
32353 can be inefficient because it requires multiple DNS lookups where one would do
32354 in the vast majority of cases when the host of interest is not on any of the
32355 lists.
32356
32357 A less inefficient way of solving this problem is available. If
32358 two domain names, comma-separated, are given, the second is used first to
32359 do an initial check, making use of any IP value restrictions that are set.
32360 If there is a match, the first domain is used, without any IP value
32361 restrictions, to get the TXT record. As a byproduct of this, there is also
32362 a check that the IP being tested is indeed on the first list. The first
32363 domain is the one that is put in &$dnslist_domain$&. For example:
32364 .code
32365 deny   dnslists = \
32366          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32367          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32368        message  = \
32369          rejected because $sender_host_address is blacklisted \
32370          at $dnslist_domain\n$dnslist_text
32371 .endd
32372 For the first blacklist item, this starts by doing a lookup in
32373 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32374 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32375 value, and as long as something is found, it looks for the corresponding TXT
32376 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32377 The second blacklist item is processed similarly.
32378
32379 If you are interested in more than one merged list, the same list must be
32380 given several times, but because the results of the DNS lookups are cached,
32381 the DNS calls themselves are not repeated. For example:
32382 .code
32383 deny dnslists = \
32384          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32385          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32386          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32387          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32388 .endd
32389 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32390 values matches (or if no record is found), this is the only lookup that is
32391 done. Only if there is a match is one of the more specific lists consulted.
32392
32393
32394
32395 .section "DNS lists and IPv6" "SECTmorednslistslast"
32396 .cindex "IPv6" "DNS black lists"
32397 .cindex "DNS list" "IPv6 usage"
32398 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32399 nibble by nibble. For example, if the calling host's IP address is
32400 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32401 .code
32402 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32403   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32404 .endd
32405 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32406 lists contain wildcard records, intended for IPv4, that interact badly with
32407 IPv6. For example, the DNS entry
32408 .code
32409 *.3.some.list.example.    A    127.0.0.1
32410 .endd
32411 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32412 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32413
32414 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32415 &%condition%& condition, as in this example:
32416 .code
32417 deny   condition = ${if isip4{$sender_host_address}}
32418        dnslists  = some.list.example
32419 .endd
32420
32421 If an explicit key is being used for a DNS lookup and it may be an IPv6
32422 address you should specify alternate list separators for both the outer
32423 (DNS list name) list and inner (lookup keys) list:
32424 .code
32425        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32426 .endd
32427
32428 .section "Rate limiting incoming messages" "SECTratelimiting"
32429 .cindex "rate limiting" "client sending"
32430 .cindex "limiting client sending rates"
32431 .oindex "&%smtp_ratelimit_*%&"
32432 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32433 which clients can send email. This is more powerful than the
32434 &%smtp_ratelimit_*%& options, because those options control the rate of
32435 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32436 works across all connections (concurrent and sequential) from the same client
32437 host. The syntax of the &%ratelimit%& condition is:
32438 .display
32439 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32440 .endd
32441 If the average client sending rate is less than &'m'& messages per time
32442 period &'p'& then the condition is false; otherwise it is true.
32443
32444 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32445 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32446 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32447 of &'p'&.
32448
32449 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32450 time interval, for example, &`8h`& for eight hours. A larger time constant
32451 means that it takes Exim longer to forget a client's past behaviour. The
32452 parameter &'m'& is the maximum number of messages that a client is permitted to
32453 send in each time interval. It also specifies the number of messages permitted
32454 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32455 constant, you can allow a client to send more messages in a burst without
32456 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32457 both small, messages must be sent at an even rate.
32458
32459 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32460 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32461 when deploying the &%ratelimit%& ACL condition. The script prints usage
32462 instructions when it is run with no arguments.
32463
32464 The key is used to look up the data for calculating the client's average
32465 sending rate. This data is stored in Exim's spool directory, alongside the
32466 retry and other hints databases. The default key is &$sender_host_address$&,
32467 which means Exim computes the sending rate of each client host IP address.
32468 By changing the key you can change how Exim identifies clients for the purpose
32469 of ratelimiting. For example, to limit the sending rate of each authenticated
32470 user, independent of the computer they are sending from, set the key to
32471 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32472 example, &$authenticated_id$& is only meaningful if the client has
32473 authenticated (which you can check with the &%authenticated%& ACL condition).
32474
32475 The lookup key does not have to identify clients: If you want to limit the
32476 rate at which a recipient receives messages, you can use the key
32477 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32478 ACL.
32479
32480 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32481 specifies what Exim measures the rate of, for example, messages or recipients
32482 or bytes. You can adjust the measurement using the &%unique=%& and/or
32483 &%count=%& options. You can also control when Exim updates the recorded rate
32484 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32485 separated by a slash, like the other parameters. They may appear in any order.
32486
32487 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32488 any options that alter the meaning of the stored data. The limit &'m'& is not
32489 stored, so you can alter the configured maximum rate and Exim will still
32490 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32491 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32492 behaviour. The lookup key is not affected by changes to the update mode and
32493 the &%count=%& option.
32494
32495
32496 .section "Ratelimit options for what is being measured" "ratoptmea"
32497 .cindex "rate limiting" "per_* options"
32498 The &%per_conn%& option limits the client's connection rate. It is not
32499 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32500 &%acl_not_smtp_start%& ACLs.
32501
32502 The &%per_mail%& option limits the client's rate of sending messages. This is
32503 the default if none of the &%per_*%& options is specified. It can be used in
32504 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32505 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32506
32507 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32508 the same ACLs as the &%per_mail%& option, though it is best to use this option
32509 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32510 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32511 in its MAIL command, which may be inaccurate or completely missing. You can
32512 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32513 in kilobytes, megabytes, or gigabytes, respectively.
32514
32515 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32516 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32517 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32518 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32519 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32520 in either case the rate limiting engine will see a message with many
32521 recipients as a large high-speed burst.
32522
32523 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32524 number of different recipients that the client has sent messages to in the
32525 last time period. That is, if the client repeatedly sends messages to the same
32526 recipient, its measured rate is not increased. This option can only be used in
32527 &%acl_smtp_rcpt%&.
32528
32529 The &%per_cmd%& option causes Exim to recompute the rate every time the
32530 condition is processed. This can be used to limit the rate of any SMTP
32531 command. If it is used in multiple ACLs it can limit the aggregate rate of
32532 multiple different commands.
32533
32534 The &%count=%& option can be used to alter how much Exim adds to the client's
32535 measured rate. For example, the &%per_byte%& option is equivalent to
32536 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32537 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32538 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32539
32540 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32541
32542
32543 .section "Ratelimit update modes" "ratoptupd"
32544 .cindex "rate limiting" "reading data without updating"
32545 You can specify one of three options with the &%ratelimit%& condition to
32546 control when its database is updated. This section describes the &%readonly%&
32547 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32548
32549 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32550 previously-computed rate to check against the limit.
32551
32552 For example, you can test the client's sending rate and deny it access (when
32553 it is too fast) in the connect ACL. If the client passes this check then it
32554 can go on to send a message, in which case its recorded rate will be updated
32555 in the MAIL ACL. Subsequent connections from the same client will check this
32556 new rate.
32557 .code
32558 acl_check_connect:
32559  deny ratelimit = 100 / 5m / readonly
32560       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32561                   (max $sender_rate_limit)
32562 # ...
32563 acl_check_mail:
32564  warn ratelimit = 100 / 5m / strict
32565       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32566                   (max $sender_rate_limit)
32567 .endd
32568
32569 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32570 processing a message then it may increase the client's measured rate more than
32571 it should. For example, this will happen if you check the &%per_rcpt%& option
32572 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32573 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32574 multiple update problems by using the &%readonly%& option on later ratelimit
32575 checks.
32576
32577 The &%per_*%& options described above do not make sense in some ACLs. If you
32578 use a &%per_*%& option in an ACL where it is not normally permitted then the
32579 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32580 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32581 next section) so you must specify the &%readonly%& option explicitly.
32582
32583
32584 .section "Ratelimit options for handling fast clients" "ratoptfast"
32585 .cindex "rate limiting" "strict and leaky modes"
32586 If a client's average rate is greater than the maximum, the rate limiting
32587 engine can react in two possible ways, depending on the presence of the
32588 &%strict%& or &%leaky%& update modes. This is independent of the other
32589 counter-measures (such as rejecting the message) that may be specified by the
32590 rest of the ACL.
32591
32592 The &%leaky%& (default) option means that the client's recorded rate is not
32593 updated if it is above the limit. The effect of this is that Exim measures the
32594 client's average rate of successfully sent email,
32595 up to the given limit.
32596 This is appropriate if the countermeasure when the condition is true
32597 consists of refusing the message, and
32598 is generally the better choice if you have clients that retry automatically.
32599 If the action when true is anything more complex then this option is
32600 likely not what is wanted.
32601
32602 The &%strict%& option means that the client's recorded rate is always
32603 updated. The effect of this is that Exim measures the client's average rate
32604 of attempts to send email, which can be much higher than the maximum it is
32605 actually allowed. If the client is over the limit it may be subjected to
32606 counter-measures by the ACL. It must slow down and allow sufficient time to
32607 pass that its computed rate falls below the maximum before it can send email
32608 again. The time (the number of smoothing periods) it must wait and not
32609 attempt to send mail can be calculated with this formula:
32610 .code
32611         ln(peakrate/maxrate)
32612 .endd
32613
32614
32615 .section "Limiting the rate of different events" "ratoptuniq"
32616 .cindex "rate limiting" "counting unique events"
32617 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32618 rate of different events. For example, the &%per_addr%& option uses this
32619 mechanism to count the number of different recipients that the client has
32620 sent messages to in the last time period; it is equivalent to
32621 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32622 measure the rate that a client uses different sender addresses with the
32623 options &`per_mail/unique=$sender_address`&.
32624
32625 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32626 has seen for that key. The whole set is thrown away when it is older than the
32627 rate smoothing period &'p'&, so each different event is counted at most once
32628 per period. In the &%leaky%& update mode, an event that causes the client to
32629 go over the limit is not added to the set, in the same way that the client's
32630 recorded rate is not updated in the same situation.
32631
32632 When you combine the &%unique=%& and &%readonly%& options, the specific
32633 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32634 rate.
32635
32636 The &%unique=%& mechanism needs more space in the ratelimit database than the
32637 other &%ratelimit%& options in order to store the event set. The number of
32638 unique values is potentially as large as the rate limit, so the extra space
32639 required increases with larger limits.
32640
32641 The uniqueification is not perfect: there is a small probability that Exim
32642 will think a new event has happened before. If the sender's rate is less than
32643 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32644 the measured rate can go above the limit, in which case Exim may under-count
32645 events by a significant margin. Fortunately, if the rate is high enough (2.7
32646 times the limit) that the false positive rate goes above 9%, then Exim will
32647 throw away the over-full event set before the measured rate falls below the
32648 limit. Therefore the only harm should be that exceptionally high sending rates
32649 are logged incorrectly; any countermeasures you configure will be as effective
32650 as intended.
32651
32652
32653 .section "Using rate limiting" "useratlim"
32654 Exim's other ACL facilities are used to define what counter-measures are taken
32655 when the rate limit is exceeded. This might be anything from logging a warning
32656 (for example, while measuring existing sending rates in order to define
32657 policy), through time delays to slow down fast senders, up to rejecting the
32658 message. For example:
32659 .code
32660 # Log all senders' rates
32661 warn ratelimit = 0 / 1h / strict
32662      log_message = Sender rate $sender_rate / $sender_rate_period
32663
32664 # Slow down fast senders; note the need to truncate $sender_rate
32665 # at the decimal point.
32666 warn ratelimit = 100 / 1h / per_rcpt / strict
32667      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32668                    $sender_rate_limit }s
32669
32670 # Keep authenticated users under control
32671 deny authenticated = *
32672      ratelimit = 100 / 1d / strict / $authenticated_id
32673
32674 # System-wide rate limit
32675 defer ratelimit = 10 / 1s / $primary_hostname
32676       message = Sorry, too busy. Try again later.
32677
32678 # Restrict incoming rate from each host, with a default
32679 # set using a macro and special cases looked up in a table.
32680 defer ratelimit = ${lookup {$sender_host_address} \
32681                    cdb {DB/ratelimits.cdb} \
32682                    {$value} {RATELIMIT} }
32683       message = Sender rate exceeds $sender_rate_limit \
32684                messages per $sender_rate_period
32685 .endd
32686 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32687 especially with the &%per_rcpt%& option, you may suffer from a performance
32688 bottleneck caused by locking on the ratelimit hints database. Apart from
32689 making your ACLs less complicated, you can reduce the problem by using a
32690 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32691 this means that Exim will lose its hints data after a reboot (including retry
32692 hints, the callout cache, and ratelimit data).
32693
32694
32695
32696 .section "Address verification" "SECTaddressverification"
32697 .cindex "verifying address" "options for"
32698 .cindex "policy control" "address verification"
32699 Several of the &%verify%& conditions described in section
32700 &<<SECTaclconditions>>& cause addresses to be verified. Section
32701 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32702 The verification conditions can be followed by options that modify the
32703 verification process. The options are separated from the keyword and from each
32704 other by slashes, and some of them contain parameters. For example:
32705 .code
32706 verify = sender/callout
32707 verify = recipient/defer_ok/callout=10s,defer_ok
32708 .endd
32709 The first stage of address verification, which always happens, is to run the
32710 address through the routers, in &"verify mode"&. Routers can detect the
32711 difference between verification and routing for delivery, and their actions can
32712 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32713 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32714 The available options are as follows:
32715
32716 .ilist
32717 If the &%callout%& option is specified, successful routing to one or more
32718 remote hosts is followed by a &"callout"& to those hosts as an additional
32719 check. Callouts and their sub-options are discussed in the next section.
32720 .next
32721 If there is a defer error while doing verification routing, the ACL
32722 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32723 options, the condition is forced to be true instead. Note that this is a main
32724 verification option as well as a suboption for callouts.
32725 .next
32726 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32727 discusses the reporting of sender address verification failures.
32728 .next
32729 The &%success_on_redirect%& option causes verification always to succeed
32730 immediately after a successful redirection. By default, if a redirection
32731 generates just one address, that address is also verified. See further
32732 discussion in section &<<SECTredirwhilveri>>&.
32733 .new
32734 .next
32735 If the &%quota%& option is specified for recipient verify,
32736 successful routing to an appendfile transport is followed by a call into
32737 the transport to evaluate the quota status for the recipient.
32738 No actual delivery is done, but verification will succeed if the quota
32739 is sufficient for the message (if the sender gave a message size) or
32740 not already exceeded (otherwise).
32741 .wen
32742 .endlist
32743
32744 .cindex "verifying address" "differentiating failures"
32745 .vindex "&$recipient_verify_failure$&"
32746 .vindex "&$sender_verify_failure$&"
32747 .vindex "&$acl_verify_message$&"
32748 After an address verification failure, &$acl_verify_message$& contains the
32749 error message that is associated with the failure. It can be preserved by
32750 coding like this:
32751 .code
32752 warn  !verify = sender
32753        set acl_m0 = $acl_verify_message
32754 .endd
32755 If you are writing your own custom rejection message or log message when
32756 denying access, you can use this variable to include information about the
32757 verification failure.
32758
32759 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32760 appropriate) contains one of the following words:
32761
32762 .ilist
32763 &%qualify%&: The address was unqualified (no domain), and the message
32764 was neither local nor came from an exempted host.
32765 .next
32766 &%route%&: Routing failed.
32767 .next
32768 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32769 occurred at or before the MAIL command (that is, on initial
32770 connection, HELO, or MAIL).
32771 .next
32772 &%recipient%&: The RCPT command in a callout was rejected.
32773 .next
32774 &%postmaster%&: The postmaster check in a callout was rejected.
32775 .new
32776 .next
32777 &%quota%&: The quota check for a local recipient did non pass.
32778 .endlist
32779
32780 The main use of these variables is expected to be to distinguish between
32781 rejections of MAIL and rejections of RCPT in callouts.
32782
32783 The above variables may also be set after a &*successful*&
32784 address verification to:
32785
32786 .ilist
32787 &%random%&: A random local-part callout succeeded
32788 .endlist
32789
32790
32791
32792
32793 .section "Callout verification" "SECTcallver"
32794 .cindex "verifying address" "by callout"
32795 .cindex "callout" "verification"
32796 .cindex "SMTP" "callout verification"
32797 For non-local addresses, routing verifies the domain, but is unable to do any
32798 checking of the local part. There are situations where some means of verifying
32799 the local part is desirable. One way this can be done is to make an SMTP
32800 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32801 a subsequent host for a recipient address, to see if the host accepts the
32802 address. We use the term &'callout'& to cover both cases. Note that for a
32803 sender address, the callback is not to the client host that is trying to
32804 deliver the message, but to one of the hosts that accepts incoming mail for the
32805 sender's domain.
32806
32807 Exim does not do callouts by default. If you want them to happen, you must
32808 request them by setting appropriate options on the &%verify%& condition, as
32809 described below. This facility should be used with care, because it can add a
32810 lot of resource usage to the cost of verifying an address. However, Exim does
32811 cache the results of callouts, which helps to reduce the cost. Details of
32812 caching are in section &<<SECTcallvercache>>&.
32813
32814 Recipient callouts are usually used only between hosts that are controlled by
32815 the same administration. For example, a corporate gateway host could use
32816 callouts to check for valid recipients on an internal mailserver. A successful
32817 callout does not guarantee that a real delivery to the address would succeed;
32818 on the other hand, a failing callout does guarantee that a delivery would fail.
32819
32820 If the &%callout%& option is present on a condition that verifies an address, a
32821 second stage of verification occurs if the address is successfully routed to
32822 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32823 &(manualroute)& router, where the router specifies the hosts. However, if a
32824 router that does not set up hosts routes to an &(smtp)& transport with a
32825 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32826 &%hosts_override%& set, its hosts are always used, whether or not the router
32827 supplies a host list.
32828 Callouts are only supported on &(smtp)& transports.
32829
32830 The port that is used is taken from the transport, if it is specified and is a
32831 remote transport. (For routers that do verification only, no transport need be
32832 specified.) Otherwise, the default SMTP port is used. If a remote transport
32833 specifies an outgoing interface, this is used; otherwise the interface is not
32834 specified. Likewise, the text that is used for the HELO command is taken from
32835 the transport's &%helo_data%& option; if there is no transport, the value of
32836 &$smtp_active_hostname$& is used.
32837
32838 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32839 test whether a bounce message could be delivered to the sender address. The
32840 following SMTP commands are sent:
32841 .display
32842 &`HELO `&<&'local host name'&>
32843 &`MAIL FROM:<>`&
32844 &`RCPT TO:`&<&'the address to be tested'&>
32845 &`QUIT`&
32846 .endd
32847 LHLO is used instead of HELO if the transport's &%protocol%& option is
32848 set to &"lmtp"&.
32849
32850 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32851 settings.
32852
32853 A recipient callout check is similar. By default, it also uses an empty address
32854 for the sender. This default is chosen because most hosts do not make use of
32855 the sender address when verifying a recipient. Using the same address means
32856 that a single cache entry can be used for each recipient. Some sites, however,
32857 do make use of the sender address when verifying. These are catered for by the
32858 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32859
32860 If the response to the RCPT command is a 2&'xx'& code, the verification
32861 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32862 Exim tries the next host, if any. If there is a problem with all the remote
32863 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32864 &%callout%& option is given, in which case the condition is forced to succeed.
32865
32866 .cindex "SMTP" "output flushing, disabling for callout"
32867 A callout may take a little time. For this reason, Exim normally flushes SMTP
32868 output before performing a callout in an ACL, to avoid unexpected timeouts in
32869 clients when the SMTP PIPELINING extension is in use. The flushing can be
32870 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32871
32872
32873
32874
32875 .section "Additional parameters for callouts" "CALLaddparcall"
32876 .cindex "callout" "additional parameters for"
32877 The &%callout%& option can be followed by an equals sign and a number of
32878 optional parameters, separated by commas. For example:
32879 .code
32880 verify = recipient/callout=10s,defer_ok
32881 .endd
32882 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32883 separate verify options, is retained for backwards compatibility, but is now
32884 deprecated. The additional parameters for &%callout%& are as follows:
32885
32886
32887 .vlist
32888 .vitem <&'a&~time&~interval'&>
32889 .cindex "callout" "timeout, specifying"
32890 This specifies the timeout that applies for the callout attempt to each host.
32891 For example:
32892 .code
32893 verify = sender/callout=5s
32894 .endd
32895 The default is 30 seconds. The timeout is used for each response from the
32896 remote host. It is also used for the initial connection, unless overridden by
32897 the &%connect%& parameter.
32898
32899
32900 .vitem &*connect&~=&~*&<&'time&~interval'&>
32901 .cindex "callout" "connection timeout, specifying"
32902 This parameter makes it possible to set a different (usually smaller) timeout
32903 for making the SMTP connection. For example:
32904 .code
32905 verify = sender/callout=5s,connect=1s
32906 .endd
32907 If not specified, this timeout defaults to the general timeout value.
32908
32909 .vitem &*defer_ok*&
32910 .cindex "callout" "defer, action on"
32911 When this parameter is present, failure to contact any host, or any other kind
32912 of temporary error, is treated as success by the ACL. However, the cache is not
32913 updated in this circumstance.
32914
32915 .vitem &*fullpostmaster*&
32916 .cindex "callout" "full postmaster check"
32917 This operates like the &%postmaster%& option (see below), but if the check for
32918 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32919 accordance with the specification in RFC 2821. The RFC states that the
32920 unqualified address &'postmaster'& should be accepted.
32921
32922
32923 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32924 .cindex "callout" "sender when verifying header"
32925 When verifying addresses in header lines using the &%header_sender%&
32926 verification option, Exim behaves by default as if the addresses are envelope
32927 sender addresses from a message. Callout verification therefore tests to see
32928 whether a bounce message could be delivered, by using an empty address in the
32929 MAIL command. However, it is arguable that these addresses might never be used
32930 as envelope senders, and could therefore justifiably reject bounce messages
32931 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32932 address to use in the MAIL command. For example:
32933 .code
32934 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32935 .endd
32936 This parameter is available only for the &%header_sender%& verification option.
32937
32938
32939 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32940 .cindex "callout" "overall timeout, specifying"
32941 This parameter sets an overall timeout for performing a callout verification.
32942 For example:
32943 .code
32944 verify = sender/callout=5s,maxwait=30s
32945 .endd
32946 This timeout defaults to four times the callout timeout for individual SMTP
32947 commands. The overall timeout applies when there is more than one host that can
32948 be tried. The timeout is checked before trying the next host. This prevents
32949 very long delays if there are a large number of hosts and all are timing out
32950 (for example, when network connections are timing out).
32951
32952
32953 .vitem &*no_cache*&
32954 .cindex "callout" "cache, suppressing"
32955 .cindex "caching callout, suppressing"
32956 When this parameter is given, the callout cache is neither read nor updated.
32957
32958 .vitem &*postmaster*&
32959 .cindex "callout" "postmaster; checking"
32960 When this parameter is set, a successful callout check is followed by a similar
32961 check for the local part &'postmaster'& at the same domain. If this address is
32962 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32963 the postmaster check is recorded in a cache record; if it is a failure, this is
32964 used to fail subsequent callouts for the domain without a connection being
32965 made, until the cache record expires.
32966
32967 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32968 The postmaster check uses an empty sender in the MAIL command by default.
32969 You can use this parameter to do a postmaster check using a different address.
32970 For example:
32971 .code
32972 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32973 .endd
32974 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32975 one overrides. The &%postmaster%& parameter is equivalent to this example:
32976 .code
32977 require  verify = sender/callout=postmaster_mailfrom=
32978 .endd
32979 &*Warning*&: The caching arrangements for postmaster checking do not take
32980 account of the sender address. It is assumed that either the empty address or
32981 a fixed non-empty address will be used. All that Exim remembers is that the
32982 postmaster check for the domain succeeded or failed.
32983
32984
32985 .vitem &*random*&
32986 .cindex "callout" "&""random""& check"
32987 When this parameter is set, before doing the normal callout check, Exim does a
32988 check for a &"random"& local part at the same domain. The local part is not
32989 really random &-- it is defined by the expansion of the option
32990 &%callout_random_local_part%&, which defaults to
32991 .code
32992 $primary_hostname-$tod_epoch-testing
32993 .endd
32994 The idea here is to try to determine whether the remote host accepts all local
32995 parts without checking. If it does, there is no point in doing callouts for
32996 specific local parts. If the &"random"& check succeeds, the result is saved in
32997 a cache record, and used to force the current and subsequent callout checks to
32998 succeed without a connection being made, until the cache record expires.
32999
33000 .vitem &*use_postmaster*&
33001 .cindex "callout" "sender for recipient check"
33002 This parameter applies to recipient callouts only. For example:
33003 .code
33004 deny  !verify = recipient/callout=use_postmaster
33005 .endd
33006 .vindex "&$qualify_domain$&"
33007 It causes a non-empty postmaster address to be used in the MAIL command when
33008 performing the callout for the recipient, and also for a &"random"& check if
33009 that is configured. The local part of the address is &`postmaster`& and the
33010 domain is the contents of &$qualify_domain$&.
33011
33012 .vitem &*use_sender*&
33013 This option applies to recipient callouts only. For example:
33014 .code
33015 require  verify = recipient/callout=use_sender
33016 .endd
33017 It causes the message's actual sender address to be used in the MAIL
33018 command when performing the callout, instead of an empty address. There is no
33019 need to use this option unless you know that the called hosts make use of the
33020 sender when checking recipients. If used indiscriminately, it reduces the
33021 usefulness of callout caching.
33022
33023 .vitem &*hold*&
33024 This option applies to recipient callouts only. For example:
33025 .code
33026 require  verify = recipient/callout=use_sender,hold
33027 .endd
33028 It causes the connection to be held open and used for any further recipients
33029 and for eventual delivery (should that be done quickly).
33030 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33031 when that is used for the connections.
33032 The advantage is only gained if there are no callout cache hits
33033 (which could be enforced by the no_cache option),
33034 if the use_sender option is used,
33035 if neither the random nor the use_postmaster option is used,
33036 and if no other callouts intervene.
33037 .endlist
33038
33039 If you use any of the parameters that set a non-empty sender for the MAIL
33040 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33041 &%use_sender%&), you should think about possible loops. Recipient checking is
33042 usually done between two hosts that are under the same management, and the host
33043 that receives the callouts is not normally configured to do callouts itself.
33044 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33045 these circumstances.
33046
33047 However, if you use a non-empty sender address for a callout to an arbitrary
33048 host, there is the likelihood that the remote host will itself initiate a
33049 callout check back to your host. As it is checking what appears to be a message
33050 sender, it is likely to use an empty address in MAIL, thus avoiding a
33051 callout loop. However, to be on the safe side it would be best to set up your
33052 own ACLs so that they do not do sender verification checks when the recipient
33053 is the address you use for header sender or postmaster callout checking.
33054
33055 Another issue to think about when using non-empty senders for callouts is
33056 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33057 by the sender/recipient combination; thus, for any given recipient, many more
33058 actual callouts are performed than when an empty sender or postmaster is used.
33059
33060
33061
33062
33063 .section "Callout caching" "SECTcallvercache"
33064 .cindex "hints database" "callout cache"
33065 .cindex "callout" "cache, description of"
33066 .cindex "caching" "callout"
33067 Exim caches the results of callouts in order to reduce the amount of resources
33068 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33069 option. A hints database called &"callout"& is used for the cache. Two
33070 different record types are used: one records the result of a callout check for
33071 a specific address, and the other records information that applies to the
33072 entire domain (for example, that it accepts the local part &'postmaster'&).
33073
33074 When an original callout fails, a detailed SMTP error message is given about
33075 the failure. However, for subsequent failures use the cache data, this message
33076 is not available.
33077
33078 The expiry times for negative and positive address cache records are
33079 independent, and can be set by the global options &%callout_negative_expire%&
33080 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33081
33082 If a host gives a negative response to an SMTP connection, or rejects any
33083 commands up to and including
33084 .code
33085 MAIL FROM:<>
33086 .endd
33087 (but not including the MAIL command with a non-empty address),
33088 any callout attempt is bound to fail. Exim remembers such failures in a
33089 domain cache record, which it uses to fail callouts for the domain without
33090 making new connections, until the domain record times out. There are two
33091 separate expiry times for domain cache records:
33092 &%callout_domain_negative_expire%& (default 3h) and
33093 &%callout_domain_positive_expire%& (default 7d).
33094
33095 Domain records expire when the negative expiry time is reached if callouts
33096 cannot be made for the domain, or if the postmaster check failed.
33097 Otherwise, they expire when the positive expiry time is reached. This
33098 ensures that, for example, a host that stops accepting &"random"& local parts
33099 will eventually be noticed.
33100
33101 The callout caching mechanism is based on the domain of the address that is
33102 being tested. If the domain routes to several hosts, it is assumed that their
33103 behaviour will be the same.
33104
33105
33106
33107 .new
33108 .section "Quota caching" "SECTquotacache"
33109 .cindex "hints database" "quota cache"
33110 .cindex "quota" "cache, description of"
33111 .cindex "caching" "quota"
33112 Exim caches the results of quota verification
33113 in order to reduce the amount of resources used.
33114 The &"callout"& hints database is used.
33115
33116 The default cache periods are five minutes for a positive (good) result
33117 and one hour for a negative result.
33118 To change the periods the &%quota%& option can be followed by an equals sign
33119 and a number of optional paramemters, separated by commas.
33120 For example:
33121 .code
33122 verify = recipient/quota=cachepos=1h,cacheneg=1d
33123 .endd
33124 Possible parameters are:
33125 .vlist
33126 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33127 .cindex "quota cache" "positive entry expiry, specifying"
33128 Set the lifetime for a positive cache entry.
33129 A value of zero seconds is legitimate.
33130
33131 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33132 .cindex "quota cache" "negative entry expiry, specifying"
33133 As above, for a negative entry.
33134
33135 .vitem &*no_cache*&
33136 Set both positive and negative lifetimes to zero.
33137 .wen
33138
33139 .section "Sender address verification reporting" "SECTsenaddver"
33140 .cindex "verifying" "suppressing error details"
33141 See section &<<SECTaddressverification>>& for a general discussion of
33142 verification. When sender verification fails in an ACL, the details of the
33143 failure are given as additional output lines before the 550 response to the
33144 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33145 you might see:
33146 .code
33147 MAIL FROM:<xyz@abc.example>
33148 250 OK
33149 RCPT TO:<pqr@def.example>
33150 550-Verification failed for <xyz@abc.example>
33151 550-Called:   192.168.34.43
33152 550-Sent:     RCPT TO:<xyz@abc.example>
33153 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33154 550 Sender verification failed
33155 .endd
33156 If more than one RCPT command fails in the same way, the details are given
33157 only for the first of them. However, some administrators do not want to send
33158 out this much information. You can suppress the details by adding
33159 &`/no_details`& to the ACL statement that requests sender verification. For
33160 example:
33161 .code
33162 verify = sender/no_details
33163 .endd
33164
33165 .section "Redirection while verifying" "SECTredirwhilveri"
33166 .cindex "verifying" "redirection while"
33167 .cindex "address redirection" "while verifying"
33168 A dilemma arises when a local address is redirected by aliasing or forwarding
33169 during verification: should the generated addresses themselves be verified,
33170 or should the successful expansion of the original address be enough to verify
33171 it? By default, Exim takes the following pragmatic approach:
33172
33173 .ilist
33174 When an incoming address is redirected to just one child address, verification
33175 continues with the child address, and if that fails to verify, the original
33176 verification also fails.
33177 .next
33178 When an incoming address is redirected to more than one child address,
33179 verification does not continue. A success result is returned.
33180 .endlist
33181
33182 This seems the most reasonable behaviour for the common use of aliasing as a
33183 way of redirecting different local parts to the same mailbox. It means, for
33184 example, that a pair of alias entries of the form
33185 .code
33186 A.Wol:   aw123
33187 aw123:   :fail: Gone away, no forwarding address
33188 .endd
33189 work as expected, with both local parts causing verification failure. When a
33190 redirection generates more than one address, the behaviour is more like a
33191 mailing list, where the existence of the alias itself is sufficient for
33192 verification to succeed.
33193
33194 It is possible, however, to change the default behaviour so that all successful
33195 redirections count as successful verifications, however many new addresses are
33196 generated. This is specified by the &%success_on_redirect%& verification
33197 option. For example:
33198 .code
33199 require verify = recipient/success_on_redirect/callout=10s
33200 .endd
33201 In this example, verification succeeds if a router generates a new address, and
33202 the callout does not occur, because no address was routed to a remote host.
33203
33204 When verification is being tested via the &%-bv%& option, the treatment of
33205 redirections is as just described, unless the &%-v%& or any debugging option is
33206 also specified. In that case, full verification is done for every generated
33207 address and a report is output for each of them.
33208
33209
33210
33211 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33212 .cindex "CSA" "verifying"
33213 Client SMTP Authorization is a system that allows a site to advertise
33214 which machines are and are not permitted to send email. This is done by placing
33215 special SRV records in the DNS; these are looked up using the client's HELO
33216 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33217 Authorization checks in Exim are performed by the ACL condition:
33218 .code
33219 verify = csa
33220 .endd
33221 This fails if the client is not authorized. If there is a DNS problem, or if no
33222 valid CSA SRV record is found, or if the client is authorized, the condition
33223 succeeds. These three cases can be distinguished using the expansion variable
33224 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33225 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33226 be likely to cause problems for legitimate email.
33227
33228 The error messages produced by the CSA code include slightly more
33229 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33230 looking up the CSA SRV record, or problems looking up the CSA target
33231 address record. There are four reasons for &$csa_status$& being &"fail"&:
33232
33233 .ilist
33234 The client's host name is explicitly not authorized.
33235 .next
33236 The client's IP address does not match any of the CSA target IP addresses.
33237 .next
33238 The client's host name is authorized but it has no valid target IP addresses
33239 (for example, the target's addresses are IPv6 and the client is using IPv4).
33240 .next
33241 The client's host name has no CSA SRV record but a parent domain has asserted
33242 that all subdomains must be explicitly authorized.
33243 .endlist
33244
33245 The &%csa%& verification condition can take an argument which is the domain to
33246 use for the DNS query. The default is:
33247 .code
33248 verify = csa/$sender_helo_name
33249 .endd
33250 This implementation includes an extension to CSA. If the query domain
33251 is an address literal such as [192.0.2.95], or if it is a bare IP
33252 address, Exim searches for CSA SRV records in the reverse DNS as if
33253 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33254 meaningful to say:
33255 .code
33256 verify = csa/$sender_host_address
33257 .endd
33258 In fact, this is the check that Exim performs if the client does not say HELO.
33259 This extension can be turned off by setting the main configuration option
33260 &%dns_csa_use_reverse%& to be false.
33261
33262 If a CSA SRV record is not found for the domain itself, a search
33263 is performed through its parent domains for a record which might be
33264 making assertions about subdomains. The maximum depth of this search is limited
33265 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33266 default. Exim does not look for CSA SRV records in a top level domain, so the
33267 default settings handle HELO domains as long as seven
33268 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33269 of legitimate HELO domains.
33270
33271 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33272 direct SRV lookups, this is not sufficient because of the extra parent domain
33273 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33274 addresses into lookups in the reverse DNS space. The result of a successful
33275 lookup such as:
33276 .code
33277 ${lookup dnsdb {csa=$sender_helo_name}}
33278 .endd
33279 has two space-separated fields: an authorization code and a target host name.
33280 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33281 authorization required but absent, or &"?"& for unknown.
33282
33283
33284
33285
33286 .section "Bounce address tag validation" "SECTverifyPRVS"
33287 .cindex "BATV, verifying"
33288 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33289 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33290 Genuine incoming bounce messages should therefore always be addressed to
33291 recipients that have a valid tag. This scheme is a way of detecting unwanted
33292 bounce messages caused by sender address forgeries (often called &"collateral
33293 spam"&), because the recipients of such messages do not include valid tags.
33294
33295 There are two expansion items to help with the implementation of the BATV
33296 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33297 the original envelope sender address by using a simple key to add a hash of the
33298 address and some time-based randomizing information. The &%prvs%& expansion
33299 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33300 The syntax of these expansion items is described in section
33301 &<<SECTexpansionitems>>&.
33302 The validity period on signed addresses is seven days.
33303
33304 As an example, suppose the secret per-address keys are stored in an MySQL
33305 database. A query to look up the key for an address could be defined as a macro
33306 like this:
33307 .code
33308 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33309                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33310                 }{$value}}
33311 .endd
33312 Suppose also that the senders who make use of BATV are defined by an address
33313 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33314 use this:
33315 .code
33316 # Bounces: drop unsigned addresses for BATV senders
33317 deny senders = :
33318      recipients = +batv_senders
33319      message = This address does not send an unsigned reverse path
33320
33321 # Bounces: In case of prvs-signed address, check signature.
33322 deny senders = :
33323      condition  = ${prvscheck {$local_part@$domain}\
33324                   {PRVSCHECK_SQL}{1}}
33325      !condition = $prvscheck_result
33326      message = Invalid reverse path signature.
33327 .endd
33328 The first statement rejects recipients for bounce messages that are addressed
33329 to plain BATV sender addresses, because it is known that BATV senders do not
33330 send out messages with plain sender addresses. The second statement rejects
33331 recipients that are prvs-signed, but with invalid signatures (either because
33332 the key is wrong, or the signature has timed out).
33333
33334 A non-prvs-signed address is not rejected by the second statement, because the
33335 &%prvscheck%& expansion yields an empty string if its first argument is not a
33336 prvs-signed address, thus causing the &%condition%& condition to be false. If
33337 the first argument is a syntactically valid prvs-signed address, the yield is
33338 the third string (in this case &"1"&), whether or not the cryptographic and
33339 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33340 of the checks (empty for failure, &"1"& for success).
33341
33342 There is one more issue you must consider when implementing prvs-signing:
33343 you have to ensure that the routers accept prvs-signed addresses and
33344 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33345 router to remove the signature with a configuration along these lines:
33346 .code
33347 batv_redirect:
33348   driver = redirect
33349   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33350 .endd
33351 This works because, if the third argument of &%prvscheck%& is empty, the result
33352 of the expansion of a prvs-signed address is the decoded value of the original
33353 address. This router should probably be the first of your routers that handles
33354 local addresses.
33355
33356 To create BATV-signed addresses in the first place, a transport of this form
33357 can be used:
33358 .code
33359 external_smtp_batv:
33360   driver = smtp
33361   return_path = ${prvs {$return_path} \
33362                        {${lookup mysql{SELECT \
33363                        secret FROM batv_prvs WHERE \
33364                        sender='${quote_mysql:$sender_address}'} \
33365                        {$value}fail}}}
33366 .endd
33367 If no key can be found for the existing return path, no signing takes place.
33368
33369
33370
33371 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33372 .cindex "&ACL;" "relay control"
33373 .cindex "relaying" "control by ACL"
33374 .cindex "policy control" "relay control"
33375 An MTA is said to &'relay'& a message if it receives it from some host and
33376 delivers it directly to another host as a result of a remote address contained
33377 within it. Redirecting a local address via an alias or forward file and then
33378 passing the message on to another host is not relaying,
33379 .cindex "&""percent hack""&"
33380 but a redirection as a result of the &"percent hack"& is.
33381
33382 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33383 A host which is acting as a gateway or an MX backup is concerned with incoming
33384 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33385 a host which is acting as a smart host for a number of clients is concerned
33386 with outgoing relaying from those clients to the Internet at large. Often the
33387 same host is fulfilling both functions,
33388 . ///
33389 . as illustrated in the diagram below,
33390 . ///
33391 but in principle these two kinds of relaying are entirely independent. What is
33392 not wanted is the transmission of mail from arbitrary remote hosts through your
33393 system to arbitrary domains.
33394
33395
33396 You can implement relay control by means of suitable statements in the ACL that
33397 runs for each RCPT command. For convenience, it is often easiest to use
33398 Exim's named list facility to define the domains and hosts involved. For
33399 example, suppose you want to do the following:
33400
33401 .ilist
33402 Deliver a number of domains to mailboxes on the local host (or process them
33403 locally in some other way). Let's say these are &'my.dom1.example'& and
33404 &'my.dom2.example'&.
33405 .next
33406 Relay mail for a number of other domains for which you are the secondary MX.
33407 These might be &'friend1.example'& and &'friend2.example'&.
33408 .next
33409 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33410 Suppose your LAN is 192.168.45.0/24.
33411 .endlist
33412
33413
33414 In the main part of the configuration, you put the following definitions:
33415 .code
33416 domainlist local_domains    = my.dom1.example : my.dom2.example
33417 domainlist relay_to_domains = friend1.example : friend2.example
33418 hostlist   relay_from_hosts = 192.168.45.0/24
33419 .endd
33420 Now you can use these definitions in the ACL that is run for every RCPT
33421 command:
33422 .code
33423 acl_check_rcpt:
33424   accept domains = +local_domains : +relay_to_domains
33425   accept hosts   = +relay_from_hosts
33426 .endd
33427 The first statement accepts any RCPT command that contains an address in
33428 the local or relay domains. For any other domain, control passes to the second
33429 statement, which accepts the command only if it comes from one of the relay
33430 hosts. In practice, you will probably want to make your ACL more sophisticated
33431 than this, for example, by including sender and recipient verification. The
33432 default configuration includes a more comprehensive example, which is described
33433 in chapter &<<CHAPdefconfil>>&.
33434
33435
33436
33437 .section "Checking a relay configuration" "SECTcheralcon"
33438 .cindex "relaying" "checking control of"
33439 You can check the relay characteristics of your configuration in the same way
33440 that you can test any ACL behaviour for an incoming SMTP connection, by using
33441 the &%-bh%& option to run a fake SMTP session with which you interact.
33442 .ecindex IIDacl
33443
33444
33445
33446 . ////////////////////////////////////////////////////////////////////////////
33447 . ////////////////////////////////////////////////////////////////////////////
33448
33449 .chapter "Content scanning at ACL time" "CHAPexiscan"
33450 .scindex IIDcosca "content scanning" "at ACL time"
33451 The extension of Exim to include content scanning at ACL time, formerly known
33452 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33453 was integrated into the main source for Exim release 4.50, and Tom continues to
33454 maintain it. Most of the wording of this chapter is taken from Tom's
33455 specification.
33456
33457 It is also possible to scan the content of messages at other times. The
33458 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33459 scanning after all the ACLs have run. A transport filter can be used to scan
33460 messages at delivery time (see the &%transport_filter%& option, described in
33461 chapter &<<CHAPtransportgeneric>>&).
33462
33463 If you want to include the ACL-time content-scanning features when you compile
33464 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33465 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33466
33467 .ilist
33468 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33469 for all MIME parts for SMTP and non-SMTP messages, respectively.
33470 .next
33471 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33472 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33473 run at the end of message reception (the &%acl_smtp_data%& ACL).
33474 .next
33475 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33476 of messages, or parts of messages, for debugging purposes.
33477 .next
33478 Additional expansion variables that are set in the new ACL and by the new
33479 conditions.
33480 .next
33481 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33482 .endlist
33483
33484 Content-scanning is continually evolving, and new features are still being
33485 added. While such features are still unstable and liable to incompatible
33486 changes, they are made available in Exim by setting options whose names begin
33487 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33488 this manual. You can find out about them by reading the file called
33489 &_doc/experimental.txt_&.
33490
33491 All the content-scanning facilities work on a MBOX copy of the message that is
33492 temporarily created in a file called:
33493 .display
33494 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33495 .endd
33496 The &_.eml_& extension is a friendly hint to virus scanners that they can
33497 expect an MBOX-like structure inside that file. The file is created when the
33498 first content scanning facility is called. Subsequent calls to content
33499 scanning conditions open the same file again. The directory is recursively
33500 removed when the &%acl_smtp_data%& ACL has finished running, unless
33501 .code
33502 control = no_mbox_unspool
33503 .endd
33504 has been encountered. When the MIME ACL decodes files, they are put into the
33505 same directory by default.
33506
33507
33508
33509 .section "Scanning for viruses" "SECTscanvirus"
33510 .cindex "virus scanning"
33511 .cindex "content scanning" "for viruses"
33512 .cindex "content scanning" "the &%malware%& condition"
33513 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33514 It supports a &"generic"& interface to scanners called via the shell, and
33515 specialized interfaces for &"daemon"& type virus scanners, which are resident
33516 in memory and thus are much faster.
33517
33518 Since message data needs to have arrived,
33519 the condition may be only called in ACL defined by
33520 &%acl_smtp_data%&,
33521 &%acl_smtp_data_prdr%&,
33522 &%acl_smtp_mime%& or
33523 &%acl_smtp_dkim%&
33524
33525 A timeout of 2 minutes is applied to a scanner call (by default);
33526 if it expires then a defer action is taken.
33527
33528 .oindex "&%av_scanner%&"
33529 You can set the &%av_scanner%& option in the main part of the configuration
33530 to specify which scanner to use, together with any additional options that
33531 are needed. The basic syntax is as follows:
33532 .display
33533 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33534 .endd
33535 If you do not set &%av_scanner%&, it defaults to
33536 .code
33537 av_scanner = sophie:/var/run/sophie
33538 .endd
33539 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33540 before use.
33541 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33542 The following scanner types are supported in this release,
33543 though individual ones can be included or not at build time:
33544
33545 .vlist
33546 .vitem &%avast%&
33547 .cindex "virus scanners" "avast"
33548 This is the scanner daemon of Avast. It has been tested with Avast Core
33549 Security (currently at version 2.2.0).
33550 You can get a trial version at &url(https://www.avast.com) or for Linux
33551 at &url(https://www.avast.com/linux-server-antivirus).
33552 This scanner type takes one option,
33553 which can be either a full path to a UNIX socket,
33554 or host and port specifiers separated by white space.
33555 The host may be a name or an IP address; the port is either a
33556 single number or a pair of numbers with a dash between.
33557 A list of options may follow. These options are interpreted on the
33558 Exim's side of the malware scanner, or are given on separate lines to
33559 the daemon as options before the main scan command.
33560
33561 .cindex &`pass_unscanned`& "avast"
33562 If &`pass_unscanned`&
33563 is set, any files the Avast scanner can't scan (e.g.
33564 decompression bombs, or invalid archives) are considered clean. Use with
33565 care.
33566
33567 For example:
33568 .code
33569 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33570 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33571 av_scanner = avast:192.168.2.22 5036
33572 .endd
33573 If you omit the argument, the default path
33574 &_/var/run/avast/scan.sock_&
33575 is used.
33576 If you use a remote host,
33577 you need to make Exim's spool directory available to it,
33578 as the scanner is passed a file path, not file contents.
33579 For information about available commands and their options you may use
33580 .code
33581 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33582     FLAGS
33583     SENSITIVITY
33584     PACK
33585 .endd
33586
33587 If the scanner returns a temporary failure (e.g. license issues, or
33588 permission problems), the message is deferred and a paniclog entry is
33589 written.  The usual &`defer_ok`& option is available.
33590
33591 .vitem &%aveserver%&
33592 .cindex "virus scanners" "Kaspersky"
33593 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33594 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33595 which is the path to the daemon's UNIX socket. The default is shown in this
33596 example:
33597 .code
33598 av_scanner = aveserver:/var/run/aveserver
33599 .endd
33600
33601
33602 .vitem &%clamd%&
33603 .cindex "virus scanners" "clamd"
33604 This daemon-type scanner is GPL and free. You can get it at
33605 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33606 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33607 in the MIME ACL. This is no longer believed to be necessary.
33608
33609 The options are a list of server specifiers, which may be
33610 a UNIX socket specification,
33611 a TCP socket specification,
33612 or a (global) option.
33613
33614 A socket specification consists of a space-separated list.
33615 For a Unix socket the first element is a full path for the socket,
33616 for a TCP socket the first element is the IP address
33617 and the second a port number,
33618 Any further elements are per-server (non-global) options.
33619 These per-server options are supported:
33620 .code
33621 retry=<timespec>        Retry on connect fail
33622 .endd
33623
33624 The &`retry`& option specifies a time after which a single retry for
33625 a failed connect is made.  The default is to not retry.
33626
33627 If a Unix socket file is specified, only one server is supported.
33628
33629 Examples:
33630 .code
33631 av_scanner = clamd:/opt/clamd/socket
33632 av_scanner = clamd:192.0.2.3 1234
33633 av_scanner = clamd:192.0.2.3 1234:local
33634 av_scanner = clamd:192.0.2.3 1234 retry=10s
33635 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33636 .endd
33637 If the value of av_scanner points to a UNIX socket file or contains the
33638 &`local`&
33639 option, then the ClamAV interface will pass a filename containing the data
33640 to be scanned, which should normally result in less I/O happening and be
33641 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33642 Exim does not assume that there is a common filesystem with the remote host.
33643
33644 The final example shows that multiple TCP targets can be specified.  Exim will
33645 randomly use one for each incoming email (i.e. it load balances them).  Note
33646 that only TCP targets may be used if specifying a list of scanners; a UNIX
33647 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33648 unavailable, Exim will try the remaining one(s) until it finds one that works.
33649 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33650 not keep track of scanner state between multiple messages, and the scanner
33651 selection is random, so the message will get logged in the mainlog for each
33652 email that the down scanner gets chosen first (message wrapped to be readable):
33653 .code
33654 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33655    clamd: connection to localhost, port 3310 failed
33656    (Connection refused)
33657 .endd
33658
33659 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33660 contributing the code for this scanner.
33661
33662 .vitem &%cmdline%&
33663 .cindex "virus scanners" "command line interface"
33664 This is the keyword for the generic command line scanner interface. It can be
33665 used to attach virus scanners that are invoked from the shell. This scanner
33666 type takes 3 mandatory options:
33667
33668 .olist
33669 The full path and name of the scanner binary, with all command line options,
33670 and a placeholder (&`%s`&) for the directory to scan.
33671
33672 .next
33673 A regular expression to match against the STDOUT and STDERR output of the
33674 virus scanner. If the expression matches, a virus was found. You must make
33675 absolutely sure that this expression matches on &"virus found"&. This is called
33676 the &"trigger"& expression.
33677
33678 .next
33679 Another regular expression, containing exactly one pair of parentheses, to
33680 match the name of the virus found in the scanners output. This is called the
33681 &"name"& expression.
33682 .endlist olist
33683
33684 For example, Sophos Sweep reports a virus on a line like this:
33685 .code
33686 Virus 'W32/Magistr-B' found in file ./those.bat
33687 .endd
33688 For the trigger expression, we can match the phrase &"found in file"&. For the
33689 name expression, we want to extract the W32/Magistr-B string, so we can match
33690 for the single quotes left and right of it. Altogether, this makes the
33691 configuration setting:
33692 .code
33693 av_scanner = cmdline:\
33694              /path/to/sweep -ss -all -rec -archive %s:\
33695              found in file:'(.+)'
33696 .endd
33697 .vitem &%drweb%&
33698 .cindex "virus scanners" "DrWeb"
33699 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33700 takes one option,
33701 either a full path to a UNIX socket,
33702 or host and port specifiers separated by white space.
33703 The host may be a name or an IP address; the port is either a
33704 single number or a pair of numbers with a dash between.
33705 For example:
33706 .code
33707 av_scanner = drweb:/var/run/drwebd.sock
33708 av_scanner = drweb:192.168.2.20 31337
33709 .endd
33710 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33711 is used. Thanks to Alex Miller for contributing the code for this scanner.
33712
33713 .vitem &%f-protd%&
33714 .cindex "virus scanners" "f-protd"
33715 The f-protd scanner is accessed via HTTP over TCP.
33716 One argument is taken, being a space-separated hostname and port number
33717 (or port-range).
33718 For example:
33719 .code
33720 av_scanner = f-protd:localhost 10200-10204
33721 .endd
33722 If you omit the argument, the default values shown above are used.
33723
33724 .vitem &%f-prot6d%&
33725 .cindex "virus scanners" "f-prot6d"
33726 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33727 One argument is taken, being a space-separated hostname and port number.
33728 For example:
33729 .code
33730 av_scanner = f-prot6d:localhost 10200
33731 .endd
33732 If you omit the argument, the default values show above are used.
33733
33734 .vitem &%fsecure%&
33735 .cindex "virus scanners" "F-Secure"
33736 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33737 argument which is the path to a UNIX socket. For example:
33738 .code
33739 av_scanner = fsecure:/path/to/.fsav
33740 .endd
33741 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33742 Thelmen for contributing the code for this scanner.
33743
33744 .vitem &%kavdaemon%&
33745 .cindex "virus scanners" "Kaspersky"
33746 This is the scanner daemon of Kaspersky Version 4. This version of the
33747 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33748 scanner type takes one option, which is the path to the daemon's UNIX socket.
33749 For example:
33750 .code
33751 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33752 .endd
33753 The default path is &_/var/run/AvpCtl_&.
33754
33755 .vitem &%mksd%&
33756 .cindex "virus scanners" "mksd"
33757 This was a daemon type scanner that is aimed mainly at Polish users,
33758 though some documentation was available in English.
33759 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33760 and this appears to be a candidate for removal from Exim, unless
33761 we are informed of other virus scanners which use the same protocol
33762 to integrate.
33763 The only option for this scanner type is
33764 the maximum number of processes used simultaneously to scan the attachments,
33765 provided that mksd has
33766 been run with at least the same number of child processes. For example:
33767 .code
33768 av_scanner = mksd:2
33769 .endd
33770 You can safely omit this option (the default value is 1).
33771
33772 .vitem &%sock%&
33773 .cindex "virus scanners" "simple socket-connected"
33774 This is a general-purpose way of talking to simple scanner daemons
33775 running on the local machine.
33776 There are four options:
33777 an address (which may be an IP address and port, or the path of a Unix socket),
33778 a commandline to send (may include a single %s which will be replaced with
33779 the path to the mail file to be scanned),
33780 an RE to trigger on from the returned data,
33781 and an RE to extract malware_name from the returned data.
33782 For example:
33783 .code
33784 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33785 .endd
33786 Note that surrounding whitespace is stripped from each option, meaning
33787 there is no way to specify a trailing newline.
33788 The socket specifier and both regular-expressions are required.
33789 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33790 specify an empty element to get this.
33791
33792 .vitem &%sophie%&
33793 .cindex "virus scanners" "Sophos and Sophie"
33794 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33795 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33796 for this scanner type is the path to the UNIX socket that Sophie uses for
33797 client communication. For example:
33798 .code
33799 av_scanner = sophie:/tmp/sophie
33800 .endd
33801 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33802 the option.
33803 .endlist
33804
33805 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33806 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33807 ACL.
33808
33809 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33810 makes it possible to use different scanners. See further below for an example.
33811 The &%malware%& condition caches its results, so when you use it multiple times
33812 for the same message, the actual scanning process is only carried out once.
33813 However, using expandable items in &%av_scanner%& disables this caching, in
33814 which case each use of the &%malware%& condition causes a new scan of the
33815 message.
33816
33817 The &%malware%& condition takes a right-hand argument that is expanded before
33818 use and taken as a list, slash-separated by default.
33819 The first element can then be one of
33820
33821 .ilist
33822 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33823 The condition succeeds if a virus was found, and fail otherwise. This is the
33824 recommended usage.
33825 .next
33826 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33827 the condition fails immediately.
33828 .next
33829 A regular expression, in which case the message is scanned for viruses. The
33830 condition succeeds if a virus is found and its name matches the regular
33831 expression. This allows you to take special actions on certain types of virus.
33832 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33833 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33834 .endlist
33835
33836 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33837 messages even if there is a problem with the virus scanner.
33838 Otherwise, such a problem causes the ACL to defer.
33839
33840 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33841 specify a non-default timeout.  The default is two minutes.
33842 For example:
33843 .code
33844 malware = * / defer_ok / tmo=10s
33845 .endd
33846 A timeout causes the ACL to defer.
33847
33848 .vindex "&$callout_address$&"
33849 When a connection is made to the scanner the expansion variable &$callout_address$&
33850 is set to record the actual address used.
33851
33852 .vindex "&$malware_name$&"
33853 When a virus is found, the condition sets up an expansion variable called
33854 &$malware_name$& that contains the name of the virus. You can use it in a
33855 &%message%& modifier that specifies the error returned to the sender, and/or in
33856 logging data.
33857
33858 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33859 imposed by your anti-virus scanner.
33860
33861 Here is a very simple scanning example:
33862 .code
33863 deny malware = *
33864      message = This message contains malware ($malware_name)
33865 .endd
33866 The next example accepts messages when there is a problem with the scanner:
33867 .code
33868 deny malware = */defer_ok
33869      message = This message contains malware ($malware_name)
33870 .endd
33871 The next example shows how to use an ACL variable to scan with both sophie and
33872 aveserver. It assumes you have set:
33873 .code
33874 av_scanner = $acl_m0
33875 .endd
33876 in the main Exim configuration.
33877 .code
33878 deny set acl_m0 = sophie
33879      malware = *
33880      message = This message contains malware ($malware_name)
33881
33882 deny set acl_m0 = aveserver
33883      malware = *
33884      message = This message contains malware ($malware_name)
33885 .endd
33886
33887
33888 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33889 .cindex "content scanning" "for spam"
33890 .cindex "spam scanning"
33891 .cindex "SpamAssassin"
33892 .cindex "Rspamd"
33893 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33894 score and a report for the message.
33895 Support is also provided for Rspamd.
33896
33897 For more information about installation and configuration of SpamAssassin or
33898 Rspamd refer to their respective websites at
33899 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33900
33901 SpamAssassin can be installed with CPAN by running:
33902 .code
33903 perl -MCPAN -e 'install Mail::SpamAssassin'
33904 .endd
33905 SpamAssassin has its own set of configuration files. Please review its
33906 documentation to see how you can tweak it. The default installation should work
33907 nicely, however.
33908
33909 .oindex "&%spamd_address%&"
33910 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33911 intend to use an instance running on the local host you do not need to set
33912 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33913 you must set the &%spamd_address%& option in the global part of the Exim
33914 configuration as follows (example):
33915 .code
33916 spamd_address = 192.168.99.45 783
33917 .endd
33918 The SpamAssassin protocol relies on a TCP half-close from the client.
33919 If your SpamAssassin client side is running a Linux system with an
33920 iptables firewall, consider setting
33921 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33922 timeout, Exim uses when waiting for a response from the SpamAssassin
33923 server (currently defaulting to 120s).  With a lower value the Linux
33924 connection tracking may consider your half-closed connection as dead too
33925 soon.
33926
33927
33928 To use Rspamd (which by default listens on all local addresses
33929 on TCP port 11333)
33930 you should add &%variant=rspamd%& after the address/port pair, for example:
33931 .code
33932 spamd_address = 127.0.0.1 11333 variant=rspamd
33933 .endd
33934
33935 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33936 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33937 filename instead of an address/port pair:
33938 .code
33939 spamd_address = /var/run/spamd_socket
33940 .endd
33941 You can have multiple &%spamd%& servers to improve scalability. These can
33942 reside on other hardware reachable over the network. To specify multiple
33943 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33944 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33945 .code
33946 spamd_address = 192.168.2.10 783 : \
33947                 192.168.2.11 783 : \
33948                 192.168.2.12 783
33949 .endd
33950 Up to 32 &%spamd%& servers are supported.
33951 When a server fails to respond to the connection attempt, all other
33952 servers are tried until one succeeds. If no server responds, the &%spam%&
33953 condition defers.
33954
33955 Unix and TCP socket specifications may be mixed in any order.
33956 Each element of the list is a list itself, space-separated by default
33957 and changeable in the usual way (&<<SECTlistsepchange>>&);
33958 take care to not double the separator.
33959
33960 For TCP socket specifications a host name or IP (v4 or v6, but
33961 subject to list-separator quoting rules) address can be used,
33962 and the port can be one or a dash-separated pair.
33963 In the latter case, the range is tried in strict order.
33964
33965 Elements after the first for Unix sockets, or second for TCP socket,
33966 are options.
33967 The supported options are:
33968 .code
33969 pri=<priority>      Selection priority
33970 weight=<value>      Selection bias
33971 time=<start>-<end>  Use only between these times of day
33972 retry=<timespec>    Retry on connect fail
33973 tmo=<timespec>      Connection time limit
33974 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33975 .endd
33976
33977 The &`pri`& option specifies a priority for the server within the list,
33978 higher values being tried first.
33979 The default priority is 1.
33980
33981 The &`weight`& option specifies a selection bias.
33982 Within a priority set
33983 servers are queried in a random fashion, weighted by this value.
33984 The default value for selection bias is 1.
33985
33986 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33987 in the local time zone; each element being one or more digits.
33988 Either the seconds or both minutes and seconds, plus the leading &`.`&
33989 characters, may be omitted and will be taken as zero.
33990
33991 Timeout specifications for the &`retry`& and &`tmo`& options
33992 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33993
33994 The &`tmo`& option specifies an overall timeout for communication.
33995 The default value is two minutes.
33996
33997 The &`retry`& option specifies a time after which a single retry for
33998 a failed connect is made.
33999 The default is to not retry.
34000
34001 The &%spamd_address%& variable is expanded before use if it starts with
34002 a dollar sign. In this case, the expansion may return a string that is
34003 used as the list so that multiple spamd servers can be the result of an
34004 expansion.
34005
34006 .vindex "&$callout_address$&"
34007 When a connection is made to the server the expansion variable &$callout_address$&
34008 is set to record the actual address used.
34009
34010 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34011 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34012 .code
34013 deny spam = joe
34014      message = This message was classified as SPAM
34015 .endd
34016 The right-hand side of the &%spam%& condition specifies a name. This is
34017 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34018 to scan using a specific profile, but rather use the SpamAssassin system-wide
34019 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34020 Rspamd does not use this setting. However, you must put something on the
34021 right-hand side.
34022
34023 The name allows you to use per-domain or per-user antispam profiles in
34024 principle, but this is not straightforward in practice, because a message may
34025 have multiple recipients, not necessarily all in the same domain. Because the
34026 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34027 read the contents of the message, the variables &$local_part$& and &$domain$&
34028 are not set.
34029 Careful enforcement of single-recipient messages
34030 (e.g. by responding with defer in the recipient ACL for all recipients
34031 after the first),
34032 or the use of PRDR,
34033 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34034 are needed to use this feature.
34035
34036 The right-hand side of the &%spam%& condition is expanded before being used, so
34037 you can put lookups or conditions there. When the right-hand side evaluates to
34038 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34039
34040
34041 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34042 large ones may cause significant performance degradation. As most spam messages
34043 are quite small, it is recommended that you do not scan the big ones. For
34044 example:
34045 .code
34046 deny condition = ${if < {$message_size}{10K}}
34047      spam = nobody
34048      message = This message was classified as SPAM
34049 .endd
34050
34051 The &%spam%& condition returns true if the threshold specified in the user's
34052 SpamAssassin profile has been matched or exceeded. If you want to use the
34053 &%spam%& condition for its side effects (see the variables below), you can make
34054 it always return &"true"& by appending &`:true`& to the username.
34055
34056 .cindex "spam scanning" "returned variables"
34057 When the &%spam%& condition is run, it sets up a number of expansion
34058 variables.
34059 Except for &$spam_report$&,
34060 these variables are saved with the received message so are
34061 available for use at delivery time.
34062
34063 .vlist
34064 .vitem &$spam_score$&
34065 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34066 for inclusion in log or reject messages.
34067
34068 .vitem &$spam_score_int$&
34069 The spam score of the message, multiplied by ten, as an integer value. For
34070 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34071 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34072 The integer value is useful for numeric comparisons in conditions.
34073
34074 .vitem &$spam_bar$&
34075 A string consisting of a number of &"+"& or &"-"& characters, representing the
34076 integer part of the spam score value. A spam score of 4.4 would have a
34077 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34078 headers, since MUAs can match on such strings. The maximum length of the
34079 spam bar is 50 characters.
34080
34081 .vitem &$spam_report$&
34082 A multiline text table, containing the full SpamAssassin report for the
34083 message. Useful for inclusion in headers or reject messages.
34084 This variable is only usable in a DATA-time ACL.
34085 Beware that SpamAssassin may return non-ASCII characters, especially
34086 when running in country-specific locales, which are not legal
34087 unencoded in headers.
34088
34089 .vitem &$spam_action$&
34090 For SpamAssassin either 'reject' or 'no action' depending on the
34091 spam score versus threshold.
34092 For Rspamd, the recommended action.
34093
34094 .endlist
34095
34096 The &%spam%& condition caches its results unless expansion in
34097 spamd_address was used. If you call it again with the same user name, it
34098 does not scan again, but rather returns the same values as before.
34099
34100 The &%spam%& condition returns DEFER if there is any error while running
34101 the message through SpamAssassin or if the expansion of spamd_address
34102 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34103 statement block), append &`/defer_ok`& to the right-hand side of the
34104 spam condition, like this:
34105 .code
34106 deny spam    = joe/defer_ok
34107      message = This message was classified as SPAM
34108 .endd
34109 This causes messages to be accepted even if there is a problem with &%spamd%&.
34110
34111 Here is a longer, commented example of the use of the &%spam%&
34112 condition:
34113 .code
34114 # put headers in all messages (no matter if spam or not)
34115 warn  spam = nobody:true
34116       add_header = X-Spam-Score: $spam_score ($spam_bar)
34117       add_header = X-Spam-Report: $spam_report
34118
34119 # add second subject line with *SPAM* marker when message
34120 # is over threshold
34121 warn  spam = nobody
34122       add_header = Subject: *SPAM* $h_Subject:
34123
34124 # reject spam at high scores (> 12)
34125 deny  spam = nobody:true
34126       condition = ${if >{$spam_score_int}{120}{1}{0}}
34127       message = This message scored $spam_score spam points.
34128 .endd
34129
34130
34131
34132 .section "Scanning MIME parts" "SECTscanmimepart"
34133 .cindex "content scanning" "MIME parts"
34134 .cindex "MIME content scanning"
34135 .oindex "&%acl_smtp_mime%&"
34136 .oindex "&%acl_not_smtp_mime%&"
34137 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34138 each MIME part of an SMTP message, including multipart types, in the sequence
34139 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34140 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34141 options may both refer to the same ACL if you want the same processing in both
34142 cases.
34143
34144 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34145 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34146 the case of a non-SMTP message. However, a MIME ACL is called only if the
34147 message contains a &'Content-Type:'& header line. When a call to a MIME
34148 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34149 result code is sent to the client. In the case of an SMTP message, the
34150 &%acl_smtp_data%& ACL is not called when this happens.
34151
34152 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34153 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34154 condition to match against the raw MIME part. You can also use the
34155 &%mime_regex%& condition to match against the decoded MIME part (see section
34156 &<<SECTscanregex>>&).
34157
34158 At the start of a MIME ACL, a number of variables are set from the header
34159 information for the relevant MIME part. These are described below. The contents
34160 of the MIME part are not by default decoded into a disk file except for MIME
34161 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34162 part into a disk file, you can use the &%decode%& condition. The general
34163 syntax is:
34164 .display
34165 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34166 .endd
34167 The right hand side is expanded before use. After expansion,
34168 the value can be:
34169
34170 .olist
34171 &"0"& or &"false"&, in which case no decoding is done.
34172 .next
34173 The string &"default"&. In that case, the file is put in the temporary
34174 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34175 a sequential filename consisting of the message id and a sequence number. The
34176 full path and name is available in &$mime_decoded_filename$& after decoding.
34177 .next
34178 A full path name starting with a slash. If the full name is an existing
34179 directory, it is used as a replacement for the default directory. The filename
34180 is then sequentially assigned. If the path does not exist, it is used as
34181 the full path and filename.
34182 .next
34183 If the string does not start with a slash, it is used as the
34184 filename, and the default path is then used.
34185 .endlist
34186 The &%decode%& condition normally succeeds. It is only false for syntax
34187 errors or unusual circumstances such as memory shortages. You can easily decode
34188 a file with its original, proposed filename using
34189 .code
34190 decode = $mime_filename
34191 .endd
34192 However, you should keep in mind that &$mime_filename$& might contain
34193 anything. If you place files outside of the default path, they are not
34194 automatically unlinked.
34195
34196 For RFC822 attachments (these are messages attached to messages, with a
34197 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34198 as for the primary message, only that the &$mime_is_rfc822$& expansion
34199 variable is set (see below). Attached messages are always decoded to disk
34200 before being checked, and the files are unlinked once the check is done.
34201
34202 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34203 used to match regular expressions against raw and decoded MIME parts,
34204 respectively. They are described in section &<<SECTscanregex>>&.
34205
34206 .cindex "MIME content scanning" "returned variables"
34207 The following list describes all expansion variables that are
34208 available in the MIME ACL:
34209
34210 .vlist
34211 .vitem &$mime_anomaly_level$& &&&
34212        &$mime_anomaly_text$&
34213 .vindex &$mime_anomaly_level$&
34214 .vindex &$mime_anomaly_text$&
34215 If there are problems decoding, these variables contain information on
34216 the detected issue.
34217
34218 .vitem &$mime_boundary$&
34219 .vindex &$mime_boundary$&
34220 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34221 have a boundary string, which is stored in this variable. If the current part
34222 has no boundary parameter in the &'Content-Type:'& header, this variable
34223 contains the empty string.
34224
34225 .vitem &$mime_charset$&
34226 .vindex &$mime_charset$&
34227 This variable contains the character set identifier, if one was found in the
34228 &'Content-Type:'& header. Examples for charset identifiers are:
34229 .code
34230 us-ascii
34231 gb2312 (Chinese)
34232 iso-8859-1
34233 .endd
34234 Please note that this value is not normalized, so you should do matches
34235 case-insensitively.
34236
34237 .vitem &$mime_content_description$&
34238 .vindex &$mime_content_description$&
34239 This variable contains the normalized content of the &'Content-Description:'&
34240 header. It can contain a human-readable description of the parts content. Some
34241 implementations repeat the filename for attachments here, but they are usually
34242 only used for display purposes.
34243
34244 .vitem &$mime_content_disposition$&
34245 .vindex &$mime_content_disposition$&
34246 This variable contains the normalized content of the &'Content-Disposition:'&
34247 header. You can expect strings like &"attachment"& or &"inline"& here.
34248
34249 .vitem &$mime_content_id$&
34250 .vindex &$mime_content_id$&
34251 This variable contains the normalized content of the &'Content-ID:'& header.
34252 This is a unique ID that can be used to reference a part from another part.
34253
34254 .vitem &$mime_content_size$&
34255 .vindex &$mime_content_size$&
34256 This variable is set only after the &%decode%& modifier (see above) has been
34257 successfully run. It contains the size of the decoded part in kilobytes. The
34258 size is always rounded up to full kilobytes, so only a completely empty part
34259 has a &$mime_content_size$& of zero.
34260
34261 .vitem &$mime_content_transfer_encoding$&
34262 .vindex &$mime_content_transfer_encoding$&
34263 This variable contains the normalized content of the
34264 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34265 type. Typical values are &"base64"& and &"quoted-printable"&.
34266
34267 .vitem &$mime_content_type$&
34268 .vindex &$mime_content_type$&
34269 If the MIME part has a &'Content-Type:'& header, this variable contains its
34270 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34271 are some examples of popular MIME types, as they may appear in this variable:
34272 .code
34273 text/plain
34274 text/html
34275 application/octet-stream
34276 image/jpeg
34277 audio/midi
34278 .endd
34279 If the MIME part has no &'Content-Type:'& header, this variable contains the
34280 empty string.
34281
34282 .vitem &$mime_decoded_filename$&
34283 .vindex &$mime_decoded_filename$&
34284 This variable is set only after the &%decode%& modifier (see above) has been
34285 successfully run. It contains the full path and filename of the file
34286 containing the decoded data.
34287 .endlist
34288
34289 .cindex "RFC 2047"
34290 .vlist
34291 .vitem &$mime_filename$&
34292 .vindex &$mime_filename$&
34293 This is perhaps the most important of the MIME variables. It contains a
34294 proposed filename for an attachment, if one was found in either the
34295 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34296 RFC2047
34297 or RFC2231
34298 decoded, but no additional sanity checks are done.
34299  If no filename was
34300 found, this variable contains the empty string.
34301
34302 .vitem &$mime_is_coverletter$&
34303 .vindex &$mime_is_coverletter$&
34304 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34305 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34306 content in the cover letter, while not restricting attachments at all.
34307
34308 The variable contains 1 (true) for a MIME part believed to be part of the
34309 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34310 follows:
34311
34312 .olist
34313 The outermost MIME part of a message is always a cover letter.
34314
34315 .next
34316 If a multipart/alternative or multipart/related MIME part is a cover letter,
34317 so are all MIME subparts within that multipart.
34318
34319 .next
34320 If any other multipart is a cover letter, the first subpart is a cover letter,
34321 and the rest are attachments.
34322
34323 .next
34324 All parts contained within an attachment multipart are attachments.
34325 .endlist olist
34326
34327 As an example, the following will ban &"HTML mail"& (including that sent with
34328 alternative plain text), while allowing HTML files to be attached. HTML
34329 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34330 .code
34331 deny !condition = $mime_is_rfc822
34332      condition = $mime_is_coverletter
34333      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34334      message = HTML mail is not accepted here
34335 .endd
34336
34337 .vitem &$mime_is_multipart$&
34338 .vindex &$mime_is_multipart$&
34339 This variable has the value 1 (true) when the current part has the main type
34340 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34341 Since multipart entities only serve as containers for other parts, you may not
34342 want to carry out specific actions on them.
34343
34344 .vitem &$mime_is_rfc822$&
34345 .vindex &$mime_is_rfc822$&
34346 This variable has the value 1 (true) if the current part is not a part of the
34347 checked message itself, but part of an attached message. Attached message
34348 decoding is fully recursive.
34349
34350 .vitem &$mime_part_count$&
34351 .vindex &$mime_part_count$&
34352 This variable is a counter that is raised for each processed MIME part. It
34353 starts at zero for the very first part (which is usually a multipart). The
34354 counter is per-message, so it is reset when processing RFC822 attachments (see
34355 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34356 complete, so you can use it in the DATA ACL to determine the number of MIME
34357 parts of a message. For non-MIME messages, this variable contains the value -1.
34358 .endlist
34359
34360
34361
34362 .section "Scanning with regular expressions" "SECTscanregex"
34363 .cindex "content scanning" "with regular expressions"
34364 .cindex "regular expressions" "content scanning with"
34365 You can specify your own custom regular expression matches on the full body of
34366 the message, or on individual MIME parts.
34367
34368 The &%regex%& condition takes one or more regular expressions as arguments and
34369 matches them against the full message (when called in the DATA ACL) or a raw
34370 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34371 linewise, with a maximum line length of 32K characters. That means you cannot
34372 have multiline matches with the &%regex%& condition.
34373
34374 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34375 to 32K of decoded content (the whole content at once, not linewise). If the
34376 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34377 is decoded automatically when &%mime_regex%& is executed (using default path
34378 and filename values). If the decoded data is larger than  32K, only the first
34379 32K characters are checked.
34380
34381 The regular expressions are passed as a colon-separated list. To include a
34382 literal colon, you must double it. Since the whole right-hand side string is
34383 expanded before being used, you must also escape dollar signs and backslashes
34384 with more backslashes, or use the &`\N`& facility to disable expansion.
34385 Here is a simple example that contains two regular expressions:
34386 .code
34387 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34388      message = contains blacklisted regex ($regex_match_string)
34389 .endd
34390 The conditions returns true if any one of the regular expressions matches. The
34391 &$regex_match_string$& expansion variable is then set up and contains the
34392 matching regular expression.
34393 The expansion variables &$regex1$& &$regex2$& etc
34394 are set to any substrings captured by the regular expression.
34395
34396 &*Warning*&: With large messages, these conditions can be fairly
34397 CPU-intensive.
34398
34399 .ecindex IIDcosca
34400
34401
34402
34403
34404 . ////////////////////////////////////////////////////////////////////////////
34405 . ////////////////////////////////////////////////////////////////////////////
34406
34407 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34408          "Local scan function"
34409 .scindex IIDlosca "&[local_scan()]& function" "description of"
34410 .cindex "customizing" "input scan using C function"
34411 .cindex "policy control" "by local scan function"
34412 In these days of email worms, viruses, and ever-increasing spam, some sites
34413 want to apply a lot of checking to messages before accepting them.
34414
34415 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34416 passing messages to external virus and spam scanning software. You can also do
34417 a certain amount in Exim itself through string expansions and the &%condition%&
34418 condition in the ACL that runs after the SMTP DATA command or the ACL for
34419 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34420
34421 To allow for further customization to a site's own requirements, there is the
34422 possibility of linking Exim with a private message scanning function, written
34423 in C. If you want to run code that is written in something other than C, you
34424 can of course use a little C stub to call it.
34425
34426 The local scan function is run once for every incoming message, at the point
34427 when Exim is just about to accept the message.
34428 It can therefore be used to control non-SMTP messages from local processes as
34429 well as messages arriving via SMTP.
34430
34431 Exim applies a timeout to calls of the local scan function, and there is an
34432 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34433 Zero means &"no timeout"&.
34434 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34435 before calling the local scan function, so that the most common types of crash
34436 are caught. If the timeout is exceeded or one of those signals is caught, the
34437 incoming message is rejected with a temporary error if it is an SMTP message.
34438 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34439 code. The incident is logged on the main and reject logs.
34440
34441
34442
34443 .section "Building Exim to use a local scan function" "SECID207"
34444 .cindex "&[local_scan()]& function" "building Exim to use"
34445 To make use of the local scan function feature, you must tell Exim where your
34446 function is before building Exim, by setting
34447 both HAVE_LOCAL_SCAN and
34448 LOCAL_SCAN_SOURCE in your
34449 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34450 directory, so you might set
34451 .code
34452 HAVE_LOCAL_SCAN=yes
34453 LOCAL_SCAN_SOURCE=Local/local_scan.c
34454 .endd
34455 for example. The function must be called &[local_scan()]&;
34456 the source file(s) for it should first #define LOCAL_SCAN
34457 and then #include "local_scan.h".
34458 It is called by
34459 Exim after it has received a message, when the success return code is about to
34460 be sent. This is after all the ACLs have been run. The return code from your
34461 function controls whether the message is actually accepted or not. There is a
34462 commented template function (that just accepts the message) in the file
34463 _src/local_scan.c_.
34464
34465 If you want to make use of Exim's runtime configuration file to set options
34466 for your &[local_scan()]& function, you must also set
34467 .code
34468 LOCAL_SCAN_HAS_OPTIONS=yes
34469 .endd
34470 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34471
34472
34473
34474
34475 .section "API for local_scan()" "SECTapiforloc"
34476 .cindex "&[local_scan()]& function" "API description"
34477 .cindex &%dlfunc%& "API description"
34478 You must include this line near the start of your code:
34479 .code
34480 #define LOCAL_SCAN
34481 #include "local_scan.h"
34482 .endd
34483 This header file defines a number of variables and other values, and the
34484 prototype for the function itself. Exim is coded to use unsigned char values
34485 almost exclusively, and one of the things this header defines is a shorthand
34486 for &`unsigned char`& called &`uschar`&.
34487 It also makes available the following macro definitions, to simplify casting character
34488 strings and pointers to character strings:
34489 .code
34490 #define CS   (char *)
34491 #define CCS  (const char *)
34492 #define CSS  (char **)
34493 #define US   (unsigned char *)
34494 #define CUS  (const unsigned char *)
34495 #define USS  (unsigned char **)
34496 .endd
34497 The function prototype for &[local_scan()]& is:
34498 .code
34499 extern int local_scan(int fd, uschar **return_text);
34500 .endd
34501 The arguments are as follows:
34502
34503 .ilist
34504 &%fd%& is a file descriptor for the file that contains the body of the message
34505 (the -D file). The file is open for reading and writing, but updating it is not
34506 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34507
34508 The descriptor is positioned at character 19 of the file, which is the first
34509 character of the body itself, because the first 19 characters are the message
34510 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34511 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34512 case this changes in some future version.
34513 .next
34514 &%return_text%& is an address which you can use to return a pointer to a text
34515 string at the end of the function. The value it points to on entry is NULL.
34516 .endlist
34517
34518 The function must return an &%int%& value which is one of the following macros:
34519
34520 .vlist
34521 .vitem &`LOCAL_SCAN_ACCEPT`&
34522 .vindex "&$local_scan_data$&"
34523 The message is accepted. If you pass back a string of text, it is saved with
34524 the message, and made available in the variable &$local_scan_data$&. No
34525 newlines are permitted (if there are any, they are turned into spaces) and the
34526 maximum length of text is 1000 characters.
34527
34528 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34529 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34530 queued without immediate delivery, and is frozen.
34531
34532 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34533 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34534 queued without immediate delivery.
34535
34536 .vitem &`LOCAL_SCAN_REJECT`&
34537 The message is rejected; the returned text is used as an error message which is
34538 passed back to the sender and which is also logged. Newlines are permitted &--
34539 they cause a multiline response for SMTP rejections, but are converted to
34540 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34541 used.
34542
34543 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34544 The message is temporarily rejected; the returned text is used as an error
34545 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34546 problem"& is used.
34547
34548 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34549 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34550 message is not written to the reject log. It has the effect of unsetting the
34551 &%rejected_header%& log selector for just this rejection. If
34552 &%rejected_header%& is already unset (see the discussion of the
34553 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34554 same as LOCAL_SCAN_REJECT.
34555
34556 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34557 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34558 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34559 .endlist
34560
34561 If the message is not being received by interactive SMTP, rejections are
34562 reported by writing to &%stderr%& or by sending an email, as configured by the
34563 &%-oe%& command line options.
34564
34565
34566
34567 .section "Configuration options for local_scan()" "SECTconoptloc"
34568 .cindex "&[local_scan()]& function" "configuration options"
34569 It is possible to have option settings in the main configuration file
34570 that set values in static variables in the &[local_scan()]& module. If you
34571 want to do this, you must have the line
34572 .code
34573 LOCAL_SCAN_HAS_OPTIONS=yes
34574 .endd
34575 in your &_Local/Makefile_& when you build Exim. (This line is in
34576 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34577 file, you must define static variables to hold the option values, and a table
34578 to define them.
34579
34580 The table must be a vector called &%local_scan_options%&, of type
34581 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34582 and a pointer to the variable that holds the value. The entries must appear in
34583 alphabetical order. Following &%local_scan_options%& you must also define a
34584 variable called &%local_scan_options_count%& that contains the number of
34585 entries in the table. Here is a short example, showing two kinds of option:
34586 .code
34587 static int my_integer_option = 42;
34588 static uschar *my_string_option = US"a default string";
34589
34590 optionlist local_scan_options[] = {
34591   { "my_integer", opt_int,       &my_integer_option },
34592   { "my_string",  opt_stringptr, &my_string_option }
34593 };
34594
34595 int local_scan_options_count =
34596   sizeof(local_scan_options)/sizeof(optionlist);
34597 .endd
34598 The values of the variables can now be changed from Exim's runtime
34599 configuration file by including a local scan section as in this example:
34600 .code
34601 begin local_scan
34602 my_integer = 99
34603 my_string = some string of text...
34604 .endd
34605 The available types of option data are as follows:
34606
34607 .vlist
34608 .vitem &*opt_bool*&
34609 This specifies a boolean (true/false) option. The address should point to a
34610 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34611 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34612 whether such a variable has been set at all, you can initialize it to
34613 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34614 values.)
34615
34616 .vitem &*opt_fixed*&
34617 This specifies a fixed point number, such as is used for load averages.
34618 The address should point to a variable of type &`int`&. The value is stored
34619 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34620
34621 .vitem &*opt_int*&
34622 This specifies an integer; the address should point to a variable of type
34623 &`int`&. The value may be specified in any of the integer formats accepted by
34624 Exim.
34625
34626 .vitem &*opt_mkint*&
34627 This is the same as &%opt_int%&, except that when such a value is output in a
34628 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34629 printed with the suffix K or M.
34630
34631 .vitem &*opt_octint*&
34632 This also specifies an integer, but the value is always interpreted as an
34633 octal integer, whether or not it starts with the digit zero, and it is
34634 always output in octal.
34635
34636 .vitem &*opt_stringptr*&
34637 This specifies a string value; the address must be a pointer to a
34638 variable that points to a string (for example, of type &`uschar *`&).
34639
34640 .vitem &*opt_time*&
34641 This specifies a time interval value. The address must point to a variable of
34642 type &`int`&. The value that is placed there is a number of seconds.
34643 .endlist
34644
34645 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34646 out the values of all the &[local_scan()]& options.
34647
34648
34649
34650 .section "Available Exim variables" "SECID208"
34651 .cindex "&[local_scan()]& function" "available Exim variables"
34652 The header &_local_scan.h_& gives you access to a number of C variables. These
34653 are the only ones that are guaranteed to be maintained from release to release.
34654 Note, however, that you can obtain the value of any Exim expansion variable,
34655 including &$recipients$&, by calling &'expand_string()'&. The exported
34656 C variables are as follows:
34657
34658 .vlist
34659 .vitem &*int&~body_linecount*&
34660 This variable contains the number of lines in the message's body.
34661 It is not valid if the &%spool_files_wireformat%& option is used.
34662
34663 .vitem &*int&~body_zerocount*&
34664 This variable contains the number of binary zero bytes in the message's body.
34665 It is not valid if the &%spool_files_wireformat%& option is used.
34666
34667 .vitem &*unsigned&~int&~debug_selector*&
34668 This variable is set to zero when no debugging is taking place. Otherwise, it
34669 is a bitmap of debugging selectors. Two bits are identified for use in
34670 &[local_scan()]&; they are defined as macros:
34671
34672 .ilist
34673 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34674 testing option that is not privileged &-- any caller may set it. All the
34675 other selector bits can be set only by admin users.
34676
34677 .next
34678 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34679 by the &`+local_scan`& debug selector. It is not included in the default set
34680 of debugging bits.
34681 .endlist ilist
34682
34683 Thus, to write to the debugging output only when &`+local_scan`& has been
34684 selected, you should use code like this:
34685 .code
34686 if ((debug_selector & D_local_scan) != 0)
34687   debug_printf("xxx", ...);
34688 .endd
34689 .vitem &*uschar&~*expand_string_message*&
34690 After a failing call to &'expand_string()'& (returned value NULL), the
34691 variable &%expand_string_message%& contains the error message, zero-terminated.
34692
34693 .vitem &*header_line&~*header_list*&
34694 A pointer to a chain of header lines. The &%header_line%& structure is
34695 discussed below.
34696
34697 .vitem &*header_line&~*header_last*&
34698 A pointer to the last of the header lines.
34699
34700 .vitem &*uschar&~*headers_charset*&
34701 The value of the &%headers_charset%& configuration option.
34702
34703 .vitem &*BOOL&~host_checking*&
34704 This variable is TRUE during a host checking session that is initiated by the
34705 &%-bh%& command line option.
34706
34707 .vitem &*uschar&~*interface_address*&
34708 The IP address of the interface that received the message, as a string. This
34709 is NULL for locally submitted messages.
34710
34711 .vitem &*int&~interface_port*&
34712 The port on which this message was received. When testing with the &%-bh%&
34713 command line option, the value of this variable is -1 unless a port has been
34714 specified via the &%-oMi%& option.
34715
34716 .vitem &*uschar&~*message_id*&
34717 This variable contains Exim's message id for the incoming message (the value of
34718 &$message_exim_id$&) as a zero-terminated string.
34719
34720 .vitem &*uschar&~*received_protocol*&
34721 The name of the protocol by which the message was received.
34722
34723 .vitem &*int&~recipients_count*&
34724 The number of accepted recipients.
34725
34726 .vitem &*recipient_item&~*recipients_list*&
34727 .cindex "recipient" "adding in local scan"
34728 .cindex "recipient" "removing in local scan"
34729 The list of accepted recipients, held in a vector of length
34730 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34731 can add additional recipients by calling &'receive_add_recipient()'& (see
34732 below). You can delete recipients by removing them from the vector and
34733 adjusting the value in &%recipients_count%&. In particular, by setting
34734 &%recipients_count%& to zero you remove all recipients. If you then return the
34735 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34736 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34737 and then call &'receive_add_recipient()'& as often as needed.
34738
34739 .vitem &*uschar&~*sender_address*&
34740 The envelope sender address. For bounce messages this is the empty string.
34741
34742 .vitem &*uschar&~*sender_host_address*&
34743 The IP address of the sending host, as a string. This is NULL for
34744 locally-submitted messages.
34745
34746 .vitem &*uschar&~*sender_host_authenticated*&
34747 The name of the authentication mechanism that was used, or NULL if the message
34748 was not received over an authenticated SMTP connection.
34749
34750 .vitem &*uschar&~*sender_host_name*&
34751 The name of the sending host, if known.
34752
34753 .vitem &*int&~sender_host_port*&
34754 The port on the sending host.
34755
34756 .vitem &*BOOL&~smtp_input*&
34757 This variable is TRUE for all SMTP input, including BSMTP.
34758
34759 .vitem &*BOOL&~smtp_batched_input*&
34760 This variable is TRUE for BSMTP input.
34761
34762 .vitem &*int&~store_pool*&
34763 The contents of this variable control which pool of memory is used for new
34764 requests. See section &<<SECTmemhanloc>>& for details.
34765 .endlist
34766
34767
34768 .section "Structure of header lines" "SECID209"
34769 The &%header_line%& structure contains the members listed below.
34770 You can add additional header lines by calling the &'header_add()'& function
34771 (see below). You can cause header lines to be ignored (deleted) by setting
34772 their type to *.
34773
34774
34775 .vlist
34776 .vitem &*struct&~header_line&~*next*&
34777 A pointer to the next header line, or NULL for the last line.
34778
34779 .vitem &*int&~type*&
34780 A code identifying certain headers that Exim recognizes. The codes are printing
34781 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34782 Notice in particular that any header line whose type is * is not transmitted
34783 with the message. This flagging is used for header lines that have been
34784 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34785 lines.) Effectively, * means &"deleted"&.
34786
34787 .vitem &*int&~slen*&
34788 The number of characters in the header line, including the terminating and any
34789 internal newlines.
34790
34791 .vitem &*uschar&~*text*&
34792 A pointer to the text of the header. It always ends with a newline, followed by
34793 a zero byte. Internal newlines are preserved.
34794 .endlist
34795
34796
34797
34798 .section "Structure of recipient items" "SECID210"
34799 The &%recipient_item%& structure contains these members:
34800
34801 .vlist
34802 .vitem &*uschar&~*address*&
34803 This is a pointer to the recipient address as it was received.
34804
34805 .vitem &*int&~pno*&
34806 This is used in later Exim processing when top level addresses are created by
34807 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34808 and must always contain -1 at this stage.
34809
34810 .vitem &*uschar&~*errors_to*&
34811 If this value is not NULL, bounce messages caused by failing to deliver to the
34812 recipient are sent to the address it contains. In other words, it overrides the
34813 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34814 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34815 an unqualified address, Exim qualifies it using the domain from
34816 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34817 is NULL for all recipients.
34818 .endlist
34819
34820
34821
34822 .section "Available Exim functions" "SECID211"
34823 .cindex "&[local_scan()]& function" "available Exim functions"
34824 The header &_local_scan.h_& gives you access to a number of Exim functions.
34825 These are the only ones that are guaranteed to be maintained from release to
34826 release:
34827
34828 .vlist
34829 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34830        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34831
34832 This function creates a child process that runs the command specified by
34833 &%argv%&. The environment for the process is specified by &%envp%&, which can
34834 be NULL if no environment variables are to be passed. A new umask is supplied
34835 for the process in &%newumask%&.
34836
34837 Pipes to the standard input and output of the new process are set up
34838 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34839 standard error is cloned to the standard output. If there are any file
34840 descriptors &"in the way"& in the new process, they are closed. If the final
34841 argument is TRUE, the new process is made into a process group leader.
34842
34843 The function returns the pid of the new process, or -1 if things go wrong.
34844
34845 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34846 This function waits for a child process to terminate, or for a timeout (in
34847 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34848 return value is as follows:
34849
34850 .ilist
34851 >= 0
34852
34853 The process terminated by a normal exit and the value is the process
34854 ending status.
34855
34856 .next
34857 < 0 and > &--256
34858
34859 The process was terminated by a signal and the value is the negation of the
34860 signal number.
34861
34862 .next
34863 &--256
34864
34865 The process timed out.
34866 .next
34867 &--257
34868
34869 The was some other error in wait(); &%errno%& is still set.
34870 .endlist
34871
34872 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34873 This function provide you with a means of submitting a new message to
34874 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34875 want, but this packages it all up for you.) The function creates a pipe,
34876 forks a subprocess that is running
34877 .code
34878 exim -t -oem -oi -f <>
34879 .endd
34880 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34881 that is connected to the standard input. The yield of the function is the PID
34882 of the subprocess. You can then write a message to the file descriptor, with
34883 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34884
34885 When you have finished, call &'child_close()'& to wait for the process to
34886 finish and to collect its ending status. A timeout value of zero is usually
34887 fine in this circumstance. Unless you have made a mistake with the recipient
34888 addresses, you should get a return code of zero.
34889
34890
34891 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34892        *sender_authentication)*&
34893 This function is a more sophisticated version of &'child_open()'&. The command
34894 that it runs is:
34895 .display
34896 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34897 .endd
34898 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34899
34900
34901 .vitem &*void&~debug_printf(char&~*,&~...)*&
34902 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34903 output is written to the standard error stream. If no debugging is selected,
34904 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34905 conditional on the &`local_scan`& debug selector by coding like this:
34906 .code
34907 if ((debug_selector & D_local_scan) != 0)
34908   debug_printf("xxx", ...);
34909 .endd
34910
34911 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34912 This is an interface to Exim's string expansion code. The return value is the
34913 expanded string, or NULL if there was an expansion failure.
34914 The C variable &%expand_string_message%& contains an error message after an
34915 expansion failure. If expansion does not change the string, the return value is
34916 the pointer to the input string. Otherwise, the return value points to a new
34917 block of memory that was obtained by a call to &'store_get()'&. See section
34918 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34919
34920 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34921 This function allows you to an add additional header line at the end of the
34922 existing ones. The first argument is the type, and should normally be a space
34923 character. The second argument is a format string and any number of
34924 substitution arguments as for &[sprintf()]&. You may include internal newlines
34925 if you want, and you must ensure that the string ends with a newline.
34926
34927 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34928         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34929 This function adds a new header line at a specified point in the header
34930 chain. The header itself is specified as for &'header_add()'&.
34931
34932 If &%name%& is NULL, the new header is added at the end of the chain if
34933 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34934 NULL, the header lines are searched for the first non-deleted header that
34935 matches the name. If one is found, the new header is added before it if
34936 &%after%& is false. If &%after%& is true, the new header is added after the
34937 found header and any adjacent subsequent ones with the same name (even if
34938 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34939 option controls where the header is added. If it is true, addition is at the
34940 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34941 headers, or at the top if there are no &'Received:'& headers, you could use
34942 .code
34943 header_add_at_position(TRUE, US"Received", TRUE,
34944   ' ', "X-xxx: ...");
34945 .endd
34946 Normally, there is always at least one non-deleted &'Received:'& header, but
34947 there may not be if &%received_header_text%& expands to an empty string.
34948
34949
34950 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34951 This function removes header lines. If &%occurrence%& is zero or negative, all
34952 occurrences of the header are removed. If occurrence is greater than zero, that
34953 particular instance of the header is removed. If no header(s) can be found that
34954 match the specification, the function does nothing.
34955
34956
34957 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34958         int&~length,&~BOOL&~notdel)*&"
34959 This function tests whether the given header has the given name. It is not just
34960 a string comparison, because white space is permitted between the name and the
34961 colon. If the &%notdel%& argument is true, a false return is forced for all
34962 &"deleted"& headers; otherwise they are not treated specially. For example:
34963 .code
34964 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34965 .endd
34966 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34967 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34968 This function base64-encodes a string, which is passed by address and length.
34969 The text may contain bytes of any value, including zero. The result is passed
34970 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34971 zero-terminated.
34972
34973 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34974 This function decodes a base64-encoded string. Its arguments are a
34975 zero-terminated base64-encoded string and the address of a variable that is set
34976 to point to the result, which is in dynamic memory. The length of the decoded
34977 string is the yield of the function. If the input is invalid base64 data, the
34978 yield is -1. A zero byte is added to the end of the output string to make it
34979 easy to interpret as a C string (assuming it contains no zeros of its own). The
34980 added zero byte is not included in the returned count.
34981
34982 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34983 This function checks for a match in a domain list. Domains are always
34984 matched caselessly. The return value is one of the following:
34985 .display
34986 &`OK     `& match succeeded
34987 &`FAIL   `& match failed
34988 &`DEFER  `& match deferred
34989 .endd
34990 DEFER is usually caused by some kind of lookup defer, such as the
34991 inability to contact a database.
34992
34993 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34994         BOOL&~caseless)*&"
34995 This function checks for a match in a local part list. The third argument
34996 controls case-sensitivity. The return values are as for
34997 &'lss_match_domain()'&.
34998
34999 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35000         BOOL&~caseless)*&"
35001 This function checks for a match in an address list. The third argument
35002 controls the case-sensitivity of the local part match. The domain is always
35003 matched caselessly. The return values are as for &'lss_match_domain()'&.
35004
35005 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35006         uschar&~*list)*&"
35007 This function checks for a match in a host list. The most common usage is
35008 expected to be
35009 .code
35010 lss_match_host(sender_host_name, sender_host_address, ...)
35011 .endd
35012 .vindex "&$sender_host_address$&"
35013 An empty address field matches an empty item in the host list. If the host name
35014 is NULL, the name corresponding to &$sender_host_address$& is automatically
35015 looked up if a host name is required to match an item in the list. The return
35016 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35017 returns ERROR in the case when it had to look up a host name, but the lookup
35018 failed.
35019
35020 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35021         *format,&~...)*&"
35022 This function writes to Exim's log files. The first argument should be zero (it
35023 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35024 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35025 them. It specifies to which log or logs the message is written. The remaining
35026 arguments are a format and relevant insertion arguments. The string should not
35027 contain any newlines, not even at the end.
35028
35029
35030 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35031 This function adds an additional recipient to the message. The first argument
35032 is the recipient address. If it is unqualified (has no domain), it is qualified
35033 with the &%qualify_recipient%& domain. The second argument must always be -1.
35034
35035 This function does not allow you to specify a private &%errors_to%& address (as
35036 described with the structure of &%recipient_item%& above), because it pre-dates
35037 the addition of that field to the structure. However, it is easy to add such a
35038 value afterwards. For example:
35039 .code
35040  receive_add_recipient(US"monitor@mydom.example", -1);
35041  recipients_list[recipients_count-1].errors_to =
35042    US"postmaster@mydom.example";
35043 .endd
35044
35045 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35046 This is a convenience function to remove a named recipient from the list of
35047 recipients. It returns true if a recipient was removed, and false if no
35048 matching recipient could be found. The argument must be a complete email
35049 address.
35050 .endlist
35051
35052
35053 .cindex "RFC 2047"
35054 .vlist
35055 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35056   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35057 This function decodes strings that are encoded according to RFC 2047. Typically
35058 these are the contents of header lines. First, each &"encoded word"& is decoded
35059 from the Q or B encoding into a byte-string. Then, if provided with the name of
35060 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35061 made  to translate the result to the named character set. If this fails, the
35062 binary string is returned with an error message.
35063
35064 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35065 maximum MIME word length is enforced. The third argument is the target
35066 encoding, or NULL if no translation is wanted.
35067
35068 .cindex "binary zero" "in RFC 2047 decoding"
35069 .cindex "RFC 2047" "binary zero in"
35070 If a binary zero is encountered in the decoded string, it is replaced by the
35071 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35072 not be 0 because header lines are handled as zero-terminated strings.
35073
35074 The function returns the result of processing the string, zero-terminated; if
35075 &%lenptr%& is not NULL, the length of the result is set in the variable to
35076 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35077
35078 If an error is encountered, the function returns NULL and uses the &%error%&
35079 argument to return an error message. The variable pointed to by &%error%& is
35080 set to NULL if there is no error; it may be set non-NULL even when the function
35081 returns a non-NULL value if decoding was successful, but there was a problem
35082 with translation.
35083
35084
35085 .vitem &*int&~smtp_fflush(void)*&
35086 This function is used in conjunction with &'smtp_printf()'&, as described
35087 below.
35088
35089 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35090 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35091 output stream. You should use this function only when there is an SMTP output
35092 stream, that is, when the incoming message is being received via interactive
35093 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35094 is FALSE. If you want to test for an incoming message from another host (as
35095 opposed to a local process that used the &%-bs%& command line option), you can
35096 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35097 is involved.
35098
35099 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35100 output function, so it can be used for all forms of SMTP connection.
35101
35102 The second argument is used to request that the data be buffered
35103 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35104 This is advisory only, but likely to save on system-calls and packets
35105 sent when a sequence of calls to the function are made.
35106
35107 The argument was added in Exim version 4.90 - changing the API/ABI.
35108 Nobody noticed until 4.93 was imminent, at which point the
35109 ABI version number was incremented.
35110
35111 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35112 must start with an appropriate response code: 550 if you are going to return
35113 LOCAL_SCAN_REJECT, 451 if you are going to return
35114 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35115 initial lines of a multi-line response, the code must be followed by a hyphen
35116 to indicate that the line is not the final response line. You must also ensure
35117 that the lines you write terminate with CRLF. For example:
35118 .code
35119 smtp_printf("550-this is some extra info\r\n");
35120 return LOCAL_SCAN_REJECT;
35121 .endd
35122 Note that you can also create multi-line responses by including newlines in
35123 the data returned via the &%return_text%& argument. The added value of using
35124 &'smtp_printf()'& is that, for instance, you could introduce delays between
35125 multiple output lines.
35126
35127 The &'smtp_printf()'& function does not return any error indication, because it
35128 does not
35129 guarantee a flush of
35130 pending output, and therefore does not test
35131 the state of the stream. (In the main code of Exim, flushing and error
35132 detection is done when Exim is ready for the next SMTP input command.) If
35133 you want to flush the output and check for an error (for example, the
35134 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35135 arguments. It flushes the output stream, and returns a non-zero value if there
35136 is an error.
35137
35138 .vitem &*void&~*store_get(int,BOOL)*&
35139 This function accesses Exim's internal store (memory) manager. It gets a new
35140 chunk of memory whose size is given by the first argument.
35141 The second argument should be given as TRUE if the memory will be used for
35142 data possibly coming from an attacker (eg. the message content),
35143 FALSE if it is locally-sourced.
35144 Exim bombs out if it ever
35145 runs out of memory. See the next section for a discussion of memory handling.
35146
35147 .vitem &*void&~*store_get_perm(int,BOOL)*&
35148 This function is like &'store_get()'&, but it always gets memory from the
35149 permanent pool. See the next section for a discussion of memory handling.
35150
35151 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35152 See below.
35153
35154 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35155 See below.
35156
35157 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35158 These three functions create strings using Exim's dynamic memory facilities.
35159 The first makes a copy of an entire string. The second copies up to a maximum
35160 number of characters, indicated by the second argument. The third uses a format
35161 and insertion arguments to create a new string. In each case, the result is a
35162 pointer to a new string in the current memory pool. See the next section for
35163 more discussion.
35164 .endlist
35165
35166
35167
35168 .section "More about Exim's memory handling" "SECTmemhanloc"
35169 .cindex "&[local_scan()]& function" "memory handling"
35170 No function is provided for freeing memory, because that is never needed.
35171 The dynamic memory that Exim uses when receiving a message is automatically
35172 recycled if another message is received by the same process (this applies only
35173 to incoming SMTP connections &-- other input methods can supply only one
35174 message at a time). After receiving the last message, a reception process
35175 terminates.
35176
35177 Because it is recycled, the normal dynamic memory cannot be used for holding
35178 data that must be preserved over a number of incoming messages on the same SMTP
35179 connection. However, Exim in fact uses two pools of dynamic memory; the second
35180 one is not recycled, and can be used for this purpose.
35181
35182 If you want to allocate memory that remains available for subsequent messages
35183 in the same SMTP connection, you should set
35184 .code
35185 store_pool = POOL_PERM
35186 .endd
35187 before calling the function that does the allocation. There is no need to
35188 restore the value if you do not need to; however, if you do want to revert to
35189 the normal pool, you can either restore the previous value of &%store_pool%& or
35190 set it explicitly to POOL_MAIN.
35191
35192 The pool setting applies to all functions that get dynamic memory, including
35193 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35194 There is also a convenience function called &'store_get_perm()'& that gets a
35195 block of memory from the permanent pool while preserving the value of
35196 &%store_pool%&.
35197 .ecindex IIDlosca
35198
35199
35200
35201
35202 . ////////////////////////////////////////////////////////////////////////////
35203 . ////////////////////////////////////////////////////////////////////////////
35204
35205 .chapter "System-wide message filtering" "CHAPsystemfilter"
35206 .scindex IIDsysfil1 "filter" "system filter"
35207 .scindex IIDsysfil2 "filtering all mail"
35208 .scindex IIDsysfil3 "system filter"
35209 The previous chapters (on ACLs and the local scan function) describe checks
35210 that can be applied to messages before they are accepted by a host. There is
35211 also a mechanism for checking messages once they have been received, but before
35212 they are delivered. This is called the &'system filter'&.
35213
35214 The system filter operates in a similar manner to users' filter files, but it
35215 is run just once per message (however many recipients the message has).
35216 It should not normally be used as a substitute for routing, because &%deliver%&
35217 commands in a system router provide new envelope recipient addresses.
35218 The system filter must be an Exim filter. It cannot be a Sieve filter.
35219
35220 The system filter is run at the start of a delivery attempt, before any routing
35221 is done. If a message fails to be completely delivered at the first attempt,
35222 the system filter is run again at the start of every retry.
35223 If you want your filter to do something only once per message, you can make use
35224 of the &%first_delivery%& condition in an &%if%& command in the filter to
35225 prevent it happening on retries.
35226
35227 .vindex "&$domain$&"
35228 .vindex "&$local_part$&"
35229 &*Warning*&: Because the system filter runs just once, variables that are
35230 specific to individual recipient addresses, such as &$local_part$& and
35231 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35232 you want to run a centrally-specified filter for each recipient address
35233 independently, you can do so by setting up a suitable &(redirect)& router, as
35234 described in section &<<SECTperaddfil>>& below.
35235
35236
35237 .section "Specifying a system filter" "SECID212"
35238 .cindex "uid (user id)" "system filter"
35239 .cindex "gid (group id)" "system filter"
35240 The name of the file that contains the system filter must be specified by
35241 setting &%system_filter%&. If you want the filter to run under a uid and gid
35242 other than root, you must also set &%system_filter_user%& and
35243 &%system_filter_group%& as appropriate. For example:
35244 .code
35245 system_filter = /etc/mail/exim.filter
35246 system_filter_user = exim
35247 .endd
35248 If a system filter generates any deliveries directly to files or pipes (via the
35249 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35250 specified by setting &%system_filter_file_transport%& and
35251 &%system_filter_pipe_transport%&, respectively. Similarly,
35252 &%system_filter_reply_transport%& must be set to handle any messages generated
35253 by the &%reply%& command.
35254
35255
35256 .section "Testing a system filter" "SECID213"
35257 You can run simple tests of a system filter in the same way as for a user
35258 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35259 are permitted only in system filters are recognized.
35260
35261 If you want to test the combined effect of a system filter and a user filter,
35262 you can use both &%-bF%& and &%-bf%& on the same command line.
35263
35264
35265
35266 .section "Contents of a system filter" "SECID214"
35267 The language used to specify system filters is the same as for users' filter
35268 files. It is described in the separate end-user document &'Exim's interface to
35269 mail filtering'&. However, there are some additional features that are
35270 available only in system filters; these are described in subsequent sections.
35271 If they are encountered in a user's filter file or when testing with &%-bf%&,
35272 they cause errors.
35273
35274 .cindex "frozen messages" "manual thaw; testing in filter"
35275 There are two special conditions which, though available in users' filter
35276 files, are designed for use in system filters. The condition &%first_delivery%&
35277 is true only for the first attempt at delivering a message, and
35278 &%manually_thawed%& is true only if the message has been frozen, and
35279 subsequently thawed by an admin user. An explicit forced delivery counts as a
35280 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35281
35282 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35283 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35284 succeed, it will not be tried again.
35285 If you want Exim to retry an unseen delivery until it succeeds, you should
35286 arrange to set it up every time the filter runs.
35287
35288 When a system filter finishes running, the values of the variables &$n0$& &--
35289 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35290 users' filter files. Thus a system filter can, for example, set up &"scores"&
35291 to which users' filter files can refer.
35292
35293
35294
35295 .section "Additional variable for system filters" "SECID215"
35296 .vindex "&$recipients$&"
35297 The expansion variable &$recipients$&, containing a list of all the recipients
35298 of the message (separated by commas and white space), is available in system
35299 filters. It is not available in users' filters for privacy reasons.
35300
35301
35302
35303 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35304 .cindex "freezing messages"
35305 .cindex "message" "freezing"
35306 .cindex "message" "forced failure"
35307 .cindex "&%fail%&" "in system filter"
35308 .cindex "&%freeze%& in system filter"
35309 .cindex "&%defer%& in system filter"
35310 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35311 always available in system filters, but are not normally enabled in users'
35312 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35313 for the &(redirect)& router.) These commands can optionally be followed by the
35314 word &%text%& and a string containing an error message, for example:
35315 .code
35316 fail text "this message looks like spam to me"
35317 .endd
35318 The keyword &%text%& is optional if the next character is a double quote.
35319
35320 The &%defer%& command defers delivery of the original recipients of the
35321 message. The &%fail%& command causes all the original recipients to be failed,
35322 and a bounce message to be created. The &%freeze%& command suspends all
35323 delivery attempts for the original recipients. In all cases, any new deliveries
35324 that are specified by the filter are attempted as normal after the filter has
35325 run.
35326
35327 The &%freeze%& command is ignored if the message has been manually unfrozen and
35328 not manually frozen since. This means that automatic freezing by a system
35329 filter can be used as a way of checking out suspicious messages. If a message
35330 is found to be all right, manually unfreezing it allows it to be delivered.
35331
35332 .cindex "log" "&%fail%& command log line"
35333 .cindex "&%fail%&" "log line; reducing"
35334 The text given with a fail command is used as part of the bounce message as
35335 well as being written to the log. If the message is quite long, this can fill
35336 up a lot of log space when such failures are common. To reduce the size of the
35337 log message, Exim interprets the text in a special way if it starts with the
35338 two characters &`<<`& and contains &`>>`& later. The text between these two
35339 strings is written to the log, and the rest of the text is used in the bounce
35340 message. For example:
35341 .code
35342 fail "<<filter test 1>>Your message is rejected \
35343      because it contains attachments that we are \
35344      not prepared to receive."
35345 .endd
35346
35347 .cindex "loop" "caused by &%fail%&"
35348 Take great care with the &%fail%& command when basing the decision to fail on
35349 the contents of the message, because the bounce message will of course include
35350 the contents of the original message and will therefore trigger the &%fail%&
35351 command again (causing a mail loop) unless steps are taken to prevent this.
35352 Testing the &%error_message%& condition is one way to prevent this. You could
35353 use, for example
35354 .code
35355 if $message_body contains "this is spam" and not error_message
35356 then fail text "spam is not wanted here" endif
35357 .endd
35358 though of course that might let through unwanted bounce messages. The
35359 alternative is clever checking of the body and/or headers to detect bounces
35360 generated by the filter.
35361
35362 The interpretation of a system filter file ceases after a
35363 &%defer%&,
35364 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35365 set up earlier in the filter file are honoured, so you can use a sequence such
35366 as
35367 .code
35368 mail ...
35369 freeze
35370 .endd
35371 to send a specified message when the system filter is freezing (or deferring or
35372 failing) a message. The normal deliveries for the message do not, of course,
35373 take place.
35374
35375
35376
35377 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35378 .cindex "header lines" "adding; in system filter"
35379 .cindex "header lines" "removing; in system filter"
35380 .cindex "filter" "header lines; adding/removing"
35381 Two filter commands that are available only in system filters are:
35382 .code
35383 headers add <string>
35384 headers remove <string>
35385 .endd
35386 The argument for the &%headers add%& is a string that is expanded and then
35387 added to the end of the message's headers. It is the responsibility of the
35388 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35389 space is ignored, and if the string is otherwise empty, or if the expansion is
35390 forced to fail, the command has no effect.
35391
35392 You can use &"\n"& within the string, followed by white space, to specify
35393 continued header lines. More than one header may be added in one command by
35394 including &"\n"& within the string without any following white space. For
35395 example:
35396 .code
35397 headers add "X-header-1: ....\n  \
35398              continuation of X-header-1 ...\n\
35399              X-header-2: ...."
35400 .endd
35401 Note that the header line continuation white space after the first newline must
35402 be placed before the backslash that continues the input string, because white
35403 space after input continuations is ignored.
35404
35405 The argument for &%headers remove%& is a colon-separated list of header names.
35406 This command applies only to those headers that are stored with the message;
35407 those that are added at delivery time (such as &'Envelope-To:'& and
35408 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35409 header with the same name, they are all removed.
35410
35411 The &%headers%& command in a system filter makes an immediate change to the set
35412 of header lines that was received with the message (with possible additions
35413 from ACL processing). Subsequent commands in the system filter operate on the
35414 modified set, which also forms the basis for subsequent message delivery.
35415 Unless further modified during routing or transporting, this set of headers is
35416 used for all recipients of the message.
35417
35418 During routing and transporting, the variables that refer to the contents of
35419 header lines refer only to those lines that are in this set. Thus, header lines
35420 that are added by a system filter are visible to users' filter files and to all
35421 routers and transports. This contrasts with the manipulation of header lines by
35422 routers and transports, which is not immediate, but which instead is saved up
35423 until the message is actually being written (see section
35424 &<<SECTheadersaddrem>>&).
35425
35426 If the message is not delivered at the first attempt, header lines that were
35427 added by the system filter are stored with the message, and so are still
35428 present at the next delivery attempt. Header lines that were removed are still
35429 present, but marked &"deleted"& so that they are not transported with the
35430 message. For this reason, it is usual to make the &%headers%& command
35431 conditional on &%first_delivery%& so that the set of header lines is not
35432 modified more than once.
35433
35434 Because header modification in a system filter acts immediately, you have to
35435 use an indirect approach if you want to modify the contents of a header line.
35436 For example:
35437 .code
35438 headers add "Old-Subject: $h_subject:"
35439 headers remove "Subject"
35440 headers add "Subject: new subject (was: $h_old-subject:)"
35441 headers remove "Old-Subject"
35442 .endd
35443
35444
35445
35446 .section "Setting an errors address in a system filter" "SECID217"
35447 .cindex "envelope from"
35448 .cindex "envelope sender"
35449 In a system filter, if a &%deliver%& command is followed by
35450 .code
35451 errors_to <some address>
35452 .endd
35453 in order to change the envelope sender (and hence the error reporting) for that
35454 delivery, any address may be specified. (In a user filter, only the current
35455 user's address can be set.) For example, if some mail is being monitored, you
35456 might use
35457 .code
35458 unseen deliver monitor@spying.example errors_to root@local.example
35459 .endd
35460 to take a copy which would not be sent back to the normal error reporting
35461 address if its delivery failed.
35462
35463
35464
35465 .section "Per-address filtering" "SECTperaddfil"
35466 .vindex "&$domain$&"
35467 .vindex "&$local_part$&"
35468 In contrast to the system filter, which is run just once per message for each
35469 delivery attempt, it is also possible to set up a system-wide filtering
35470 operation that runs once for each recipient address. In this case, variables
35471 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
35472 filter file could be made dependent on them. This is an example of a router
35473 which implements such a filter:
35474 .code
35475 central_filter:
35476   check_local_user
35477   driver = redirect
35478   domains = +local_domains
35479   file = /central/filters/$local_part_data
35480   no_verify
35481   allow_filter
35482   allow_freeze
35483 .endd
35484 The filter is run in a separate process under its own uid. Therefore, either
35485 &%check_local_user%& must be set (as above), in which case the filter is run as
35486 the local user, or the &%user%& option must be used to specify which user to
35487 use. If both are set, &%user%& overrides.
35488
35489 Care should be taken to ensure that none of the commands in the filter file
35490 specify a significant delivery if the message is to go on to be delivered to
35491 its intended recipient. The router will not then claim to have dealt with the
35492 address, so it will be passed on to subsequent routers to be delivered in the
35493 normal way.
35494 .ecindex IIDsysfil1
35495 .ecindex IIDsysfil2
35496 .ecindex IIDsysfil3
35497
35498
35499
35500
35501
35502
35503 . ////////////////////////////////////////////////////////////////////////////
35504 . ////////////////////////////////////////////////////////////////////////////
35505
35506 .chapter "Message processing" "CHAPmsgproc"
35507 .scindex IIDmesproc "message" "general processing"
35508 Exim performs various transformations on the sender and recipient addresses of
35509 all messages that it handles, and also on the messages' header lines. Some of
35510 these are optional and configurable, while others always take place. All of
35511 this processing, except rewriting as a result of routing, and the addition or
35512 removal of header lines while delivering, happens when a message is received,
35513 before it is placed on Exim's queue.
35514
35515 Some of the automatic processing takes place by default only for
35516 &"locally-originated"& messages. This adjective is used to describe messages
35517 that are not received over TCP/IP, but instead are passed to an Exim process on
35518 its standard input. This includes the interactive &"local SMTP"& case that is
35519 set up by the &%-bs%& command line option.
35520
35521 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35522 or ::1) are not considered to be locally-originated. Exim does not treat the
35523 loopback interface specially in any way.
35524
35525 If you want the loopback interface to be treated specially, you must ensure
35526 that there are appropriate entries in your ACLs.
35527
35528
35529
35530
35531 .section "Submission mode for non-local messages" "SECTsubmodnon"
35532 .cindex "message" "submission"
35533 .cindex "submission mode"
35534 Processing that happens automatically for locally-originated messages (unless
35535 &%suppress_local_fixups%& is set) can also be requested for messages that are
35536 received over TCP/IP. The term &"submission mode"& is used to describe this
35537 state. Submission mode is set by the modifier
35538 .code
35539 control = submission
35540 .endd
35541 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35542 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35543 a local submission, and is normally used when the source of the message is
35544 known to be an MUA running on a client host (as opposed to an MTA). For
35545 example, to set submission mode for messages originating on the IPv4 loopback
35546 interface, you could include the following in the MAIL ACL:
35547 .code
35548 warn  hosts = 127.0.0.1
35549       control = submission
35550 .endd
35551 .cindex "&%sender_retain%& submission option"
35552 There are some options that can be used when setting submission mode. A slash
35553 is used to separate options. For example:
35554 .code
35555 control = submission/sender_retain
35556 .endd
35557 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35558 true and &%local_from_check%& false for the current incoming message. The first
35559 of these allows an existing &'Sender:'& header in the message to remain, and
35560 the second suppresses the check to ensure that &'From:'& matches the
35561 authenticated sender. With this setting, Exim still fixes up messages by adding
35562 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35563 attempt to check sender authenticity in header lines.
35564
35565 When &%sender_retain%& is not set, a submission mode setting may specify a
35566 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35567 example:
35568 .code
35569 control = submission/domain=some.domain
35570 .endd
35571 The domain may be empty. How this value is used is described in sections
35572 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35573 that allows you to specify the user's full name for inclusion in a created
35574 &'Sender:'& or &'From:'& header line. For example:
35575 .code
35576 accept authenticated = *
35577        control = submission/domain=wonderland.example/\
35578                             name=${lookup {$authenticated_id} \
35579                                    lsearch {/etc/exim/namelist}}
35580 .endd
35581 Because the name may contain any characters, including slashes, the &%name%&
35582 option must be given last. The remainder of the string is used as the name. For
35583 the example above, if &_/etc/exim/namelist_& contains:
35584 .code
35585 bigegg:  Humpty Dumpty
35586 .endd
35587 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35588 line would be:
35589 .code
35590 Sender: Humpty Dumpty <bigegg@wonderland.example>
35591 .endd
35592 .cindex "return path" "in submission mode"
35593 By default, submission mode forces the return path to the same address as is
35594 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35595 specified, the return path is also left unchanged.
35596
35597 &*Note*&: The changes caused by submission mode take effect after the predata
35598 ACL. This means that any sender checks performed before the fix-ups use the
35599 untrusted sender address specified by the user, not the trusted sender address
35600 specified by submission mode. Although this might be slightly unexpected, it
35601 does mean that you can configure ACL checks to spot that a user is trying to
35602 spoof another's address.
35603
35604 .section "Line endings" "SECTlineendings"
35605 .cindex "line endings"
35606 .cindex "carriage return"
35607 .cindex "linefeed"
35608 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35609 linefeed) is the line ending for messages transmitted over the Internet using
35610 SMTP over TCP/IP. However, within individual operating systems, different
35611 conventions are used. For example, Unix-like systems use just LF, but others
35612 use CRLF or just CR.
35613
35614 Exim was designed for Unix-like systems, and internally, it stores messages
35615 using the system's convention of a single LF as a line terminator. When
35616 receiving a message, all line endings are translated to this standard format.
35617 Originally, it was thought that programs that passed messages directly to an
35618 MTA within an operating system would use that system's convention. Experience
35619 has shown that this is not the case; for example, there are Unix applications
35620 that use CRLF in this circumstance. For this reason, and for compatibility with
35621 other MTAs, the way Exim handles line endings for all messages is now as
35622 follows:
35623
35624 .ilist
35625 LF not preceded by CR is treated as a line ending.
35626 .next
35627 CR is treated as a line ending; if it is immediately followed by LF, the LF
35628 is ignored.
35629 .next
35630 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35631 nor a local message in the state where a line containing only a dot is a
35632 terminator.
35633 .next
35634 If a bare CR is encountered within a header line, an extra space is added after
35635 the line terminator so as not to end the header line. The reasoning behind this
35636 is that bare CRs in header lines are most likely either to be mistakes, or
35637 people trying to play silly games.
35638 .next
35639 If the first header line received in a message ends with CRLF, a subsequent
35640 bare LF in a header line is treated in the same way as a bare CR in a header
35641 line.
35642 .endlist
35643
35644
35645
35646
35647
35648 .section "Unqualified addresses" "SECID218"
35649 .cindex "unqualified addresses"
35650 .cindex "address" "qualification"
35651 By default, Exim expects every envelope address it receives from an external
35652 host to be fully qualified. Unqualified addresses cause negative responses to
35653 SMTP commands. However, because SMTP is used as a means of transporting
35654 messages from MUAs running on personal workstations, there is sometimes a
35655 requirement to accept unqualified addresses from specific hosts or IP networks.
35656
35657 Exim has two options that separately control which hosts may send unqualified
35658 sender or recipient addresses in SMTP commands, namely
35659 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35660 cases, if an unqualified address is accepted, it is qualified by adding the
35661 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35662
35663 .oindex "&%qualify_domain%&"
35664 .oindex "&%qualify_recipient%&"
35665 Unqualified addresses in header lines are automatically qualified for messages
35666 that are locally originated, unless the &%-bnq%& option is given on the command
35667 line. For messages received over SMTP, unqualified addresses in header lines
35668 are qualified only if unqualified addresses are permitted in SMTP commands. In
35669 other words, such qualification is also controlled by
35670 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35671
35672
35673
35674
35675 .section "The UUCP From line" "SECID219"
35676 .cindex "&""From""& line"
35677 .cindex "UUCP" "&""From""& line"
35678 .cindex "sender" "address"
35679 .oindex "&%uucp_from_pattern%&"
35680 .oindex "&%uucp_from_sender%&"
35681 .cindex "envelope from"
35682 .cindex "envelope sender"
35683 .cindex "Sendmail compatibility" "&""From""& line"
35684 Messages that have come from UUCP (and some other applications) often begin
35685 with a line containing the envelope sender and a timestamp, following the word
35686 &"From"&. Examples of two common formats are:
35687 .code
35688 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35689 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35690 .endd
35691 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35692 Exim recognizes such lines at the start of messages that are submitted to it
35693 via the command line (that is, on the standard input). It does not recognize
35694 such lines in incoming SMTP messages, unless the sending host matches
35695 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35696 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35697 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35698 default value matches the two common cases shown above and puts the address
35699 that follows &"From"& into &$1$&.
35700
35701 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35702 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35703 a trusted user, the message's sender address is constructed by expanding the
35704 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35705 then parsed as an RFC 2822 address. If there is no domain, the local part is
35706 qualified with &%qualify_domain%& unless it is the empty string. However, if
35707 the command line &%-f%& option is used, it overrides the &"From"& line.
35708
35709 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35710 sender address is not changed. This is also the case for incoming SMTP messages
35711 that are permitted to contain &"From"& lines.
35712
35713 Only one &"From"& line is recognized. If there is more than one, the second is
35714 treated as a data line that starts the body of the message, as it is not valid
35715 as a header line. This also happens if a &"From"& line is present in an
35716 incoming SMTP message from a source that is not permitted to send them.
35717
35718
35719
35720 .section "Resent- header lines" "SECID220"
35721 .cindex "&%Resent-%& header lines"
35722 .cindex "header lines" "Resent-"
35723 RFC 2822 makes provision for sets of header lines starting with the string
35724 &`Resent-`& to be added to a message when it is resent by the original
35725 recipient to somebody else. These headers are &'Resent-Date:'&,
35726 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35727 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35728
35729 .blockquote
35730 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35731 processing of replies or other such automatic actions on messages.'&
35732 .endblockquote
35733
35734 This leaves things a bit vague as far as other processing actions such as
35735 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35736 follows:
35737
35738 .ilist
35739 A &'Resent-From:'& line that just contains the login id of the submitting user
35740 is automatically rewritten in the same way as &'From:'& (see below).
35741 .next
35742 If there's a rewriting rule for a particular header line, it is also applied to
35743 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35744 &'From:'& also rewrites &'Resent-From:'&.
35745 .next
35746 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35747 also removed.
35748 .next
35749 For a locally-submitted message,
35750 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35751 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35752 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35753 included in log lines in this case.
35754 .next
35755 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35756 &%Resent-%& header lines are present.
35757 .endlist
35758
35759
35760
35761
35762 .section "The Auto-Submitted: header line" "SECID221"
35763 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35764 includes the header line:
35765 .code
35766 Auto-Submitted: auto-replied
35767 .endd
35768
35769 .section "The Bcc: header line" "SECID222"
35770 .cindex "&'Bcc:'& header line"
35771 If Exim is called with the &%-t%& option, to take recipient addresses from a
35772 message's header, it removes any &'Bcc:'& header line that may exist (after
35773 extracting its addresses). If &%-t%& is not present on the command line, any
35774 existing &'Bcc:'& is not removed.
35775
35776
35777 .section "The Date: header line" "SECID223"
35778 .cindex "&'Date:'& header line"
35779 .cindex "header lines" "Date:"
35780 If a locally-generated or submission-mode message has no &'Date:'& header line,
35781 Exim adds one, using the current date and time, unless the
35782 &%suppress_local_fixups%& control has been specified.
35783
35784 .section "The Delivery-date: header line" "SECID224"
35785 .cindex "&'Delivery-date:'& header line"
35786 .oindex "&%delivery_date_remove%&"
35787 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35788 set. Exim can be configured to add them to the final delivery of messages. (See
35789 the generic &%delivery_date_add%& transport option.) They should not be present
35790 in messages in transit. If the &%delivery_date_remove%& configuration option is
35791 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35792 messages.
35793
35794
35795 .section "The Envelope-to: header line" "SECID225"
35796 .cindex "&'Envelope-to:'& header line"
35797 .cindex "header lines" "Envelope-to:"
35798 .oindex "&%envelope_to_remove%&"
35799 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35800 Exim can be configured to add them to the final delivery of messages. (See the
35801 generic &%envelope_to_add%& transport option.) They should not be present in
35802 messages in transit. If the &%envelope_to_remove%& configuration option is set
35803 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35804 messages.
35805
35806
35807 .section "The From: header line" "SECTthefrohea"
35808 .cindex "&'From:'& header line"
35809 .cindex "header lines" "From:"
35810 .cindex "Sendmail compatibility" "&""From""& line"
35811 .cindex "message" "submission"
35812 .cindex "submission mode"
35813 If a submission-mode message does not contain a &'From:'& header line, Exim
35814 adds one if either of the following conditions is true:
35815
35816 .ilist
35817 The envelope sender address is not empty (that is, this is not a bounce
35818 message). The added header line copies the envelope sender address.
35819 .next
35820 .vindex "&$authenticated_id$&"
35821 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35822 .olist
35823 .vindex "&$qualify_domain$&"
35824 If no domain is specified by the submission control, the local part is
35825 &$authenticated_id$& and the domain is &$qualify_domain$&.
35826 .next
35827 If a non-empty domain is specified by the submission control, the local
35828 part is &$authenticated_id$&, and the domain is the specified domain.
35829 .next
35830 If an empty domain is specified by the submission control,
35831 &$authenticated_id$& is assumed to be the complete address.
35832 .endlist
35833 .endlist
35834
35835 A non-empty envelope sender takes precedence.
35836
35837 If a locally-generated incoming message does not contain a &'From:'& header
35838 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35839 containing the sender's address. The calling user's login name and full name
35840 are used to construct the address, as described in section &<<SECTconstr>>&.
35841 They are obtained from the password data by calling &[getpwuid()]& (but see the
35842 &%unknown_login%& configuration option). The address is qualified with
35843 &%qualify_domain%&.
35844
35845 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35846 &'From:'& header line containing just the unqualified login name of the calling
35847 user, this is replaced by an address containing the user's login name and full
35848 name as described in section &<<SECTconstr>>&.
35849
35850
35851 .section "The Message-ID: header line" "SECID226"
35852 .cindex "&'Message-ID:'& header line"
35853 .cindex "header lines" "Message-ID:"
35854 .cindex "message" "submission"
35855 .oindex "&%message_id_header_text%&"
35856 If a locally-generated or submission-mode incoming message does not contain a
35857 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35858 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35859 to the message. If there are any &'Resent-:'& headers in the message, it
35860 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35861 message id, preceded by the letter E to ensure it starts with a letter, and
35862 followed by @ and the primary host name. Additional information can be included
35863 in this header line by setting the &%message_id_header_text%& and/or
35864 &%message_id_header_domain%& options.
35865
35866
35867 .section "The Received: header line" "SECID227"
35868 .cindex "&'Received:'& header line"
35869 .cindex "header lines" "Received:"
35870 A &'Received:'& header line is added at the start of every message. The
35871 contents are defined by the &%received_header_text%& configuration option, and
35872 Exim automatically adds a semicolon and a timestamp to the configured string.
35873
35874 The &'Received:'& header is generated as soon as the message's header lines
35875 have been received. At this stage, the timestamp in the &'Received:'& header
35876 line is the time that the message started to be received. This is the value
35877 that is seen by the DATA ACL and by the &[local_scan()]& function.
35878
35879 Once a message is accepted, the timestamp in the &'Received:'& header line is
35880 changed to the time of acceptance, which is (apart from a small delay while the
35881 -H spool file is written) the earliest time at which delivery could start.
35882
35883
35884 .section "The References: header line" "SECID228"
35885 .cindex "&'References:'& header line"
35886 .cindex "header lines" "References:"
35887 Messages created by the &(autoreply)& transport include a &'References:'&
35888 header line. This is constructed according to the rules that are described in
35889 section 3.64 of RFC 2822 (which states that replies should contain such a
35890 header line), and section 3.14 of RFC 3834 (which states that automatic
35891 responses are not different in this respect). However, because some mail
35892 processing software does not cope well with very long header lines, no more
35893 than 12 message IDs are copied from the &'References:'& header line in the
35894 incoming message. If there are more than 12, the first one and then the final
35895 11 are copied, before adding the message ID of the incoming message.
35896
35897
35898
35899 .section "The Return-path: header line" "SECID229"
35900 .cindex "&'Return-path:'& header line"
35901 .cindex "header lines" "Return-path:"
35902 .oindex "&%return_path_remove%&"
35903 &'Return-path:'& header lines are defined as something an MTA may insert when
35904 it does the final delivery of messages. (See the generic &%return_path_add%&
35905 transport option.) Therefore, they should not be present in messages in
35906 transit. If the &%return_path_remove%& configuration option is set (the
35907 default), Exim removes &'Return-path:'& header lines from incoming messages.
35908
35909
35910
35911 .section "The Sender: header line" "SECTthesenhea"
35912 .cindex "&'Sender:'& header line"
35913 .cindex "message" "submission"
35914 .cindex "header lines" "Sender:"
35915 For a locally-originated message from an untrusted user, Exim may remove an
35916 existing &'Sender:'& header line, and it may add a new one. You can modify
35917 these actions by setting the &%local_sender_retain%& option true, the
35918 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35919 control setting.
35920
35921 When a local message is received from an untrusted user and
35922 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35923 control has not been set, a check is made to see if the address given in the
35924 &'From:'& header line is the correct (local) sender of the message. The address
35925 that is expected has the login name as the local part and the value of
35926 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35927 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35928 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35929 line is added to the message.
35930
35931 If you set &%local_from_check%& false, this checking does not occur. However,
35932 the removal of an existing &'Sender:'& line still happens, unless you also set
35933 &%local_sender_retain%& to be true. It is not possible to set both of these
35934 options true at the same time.
35935
35936 .cindex "submission mode"
35937 By default, no processing of &'Sender:'& header lines is done for messages
35938 received over TCP/IP or for messages submitted by trusted users. However, when
35939 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35940 not specified on the submission control, the following processing takes place:
35941
35942 .vindex "&$authenticated_id$&"
35943 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35944 authenticated, and &$authenticated_id$& is not empty, a sender address is
35945 created as follows:
35946
35947 .ilist
35948 .vindex "&$qualify_domain$&"
35949 If no domain is specified by the submission control, the local part is
35950 &$authenticated_id$& and the domain is &$qualify_domain$&.
35951 .next
35952 If a non-empty domain is specified by the submission control, the local part
35953 is &$authenticated_id$&, and the domain is the specified domain.
35954 .next
35955 If an empty domain is specified by the submission control,
35956 &$authenticated_id$& is assumed to be the complete address.
35957 .endlist
35958
35959 This address is compared with the address in the &'From:'& header line. If they
35960 are different, a &'Sender:'& header line containing the created address is
35961 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35962 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35963
35964 .cindex "return path" "created from &'Sender:'&"
35965 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35966 the message (the envelope sender address) is changed to be the same address,
35967 except in the case of submission mode when &%sender_retain%& is specified.
35968
35969
35970
35971 .section "Adding and removing header lines in routers and transports" &&&
35972          "SECTheadersaddrem"
35973 .cindex "header lines" "adding; in router or transport"
35974 .cindex "header lines" "removing; in router or transport"
35975 When a message is delivered, the addition and removal of header lines can be
35976 specified in a system filter, or on any of the routers and transports that
35977 process the message. Section &<<SECTaddremheasys>>& contains details about
35978 modifying headers in a system filter. Header lines can also be added in an ACL
35979 as a message is received (see section &<<SECTaddheadacl>>&).
35980
35981 In contrast to what happens in a system filter, header modifications that are
35982 specified on routers and transports apply only to the particular recipient
35983 addresses that are being processed by those routers and transports. These
35984 changes do not actually take place until a copy of the message is being
35985 transported. Therefore, they do not affect the basic set of header lines, and
35986 they do not affect the values of the variables that refer to header lines.
35987
35988 &*Note*&: In particular, this means that any expansions in the configuration of
35989 the transport cannot refer to the modified header lines, because such
35990 expansions all occur before the message is actually transported.
35991
35992 For both routers and transports, the argument of a &%headers_add%&
35993 option must be in the form of one or more RFC 2822 header lines, separated by
35994 newlines (coded as &"\n"&). For example:
35995 .code
35996 headers_add = X-added-header: added by $primary_hostname\n\
35997               X-added-second: another added header line
35998 .endd
35999 Exim does not check the syntax of these added header lines.
36000
36001 Multiple &%headers_add%& options for a single router or transport can be
36002 specified; the values will append to a single list of header lines.
36003 Each header-line is separately expanded.
36004
36005 The argument of a &%headers_remove%& option must consist of a colon-separated
36006 list of header names. This is confusing, because header names themselves are
36007 often terminated by colons. In this case, the colons are the list separators,
36008 not part of the names. For example:
36009 .code
36010 headers_remove = return-receipt-to:acknowledge-to
36011 .endd
36012
36013 Multiple &%headers_remove%& options for a single router or transport can be
36014 specified; the arguments will append to a single header-names list.
36015 Each item is separately expanded.
36016 Note that colons in complex expansions which are used to
36017 form all or part of a &%headers_remove%& list
36018 will act as list separators.
36019
36020 When &%headers_add%& or &%headers_remove%& is specified on a router,
36021 items are expanded at routing time,
36022 and then associated with all addresses that are
36023 accepted by that router, and also with any new addresses that it generates. If
36024 an address passes through several routers as a result of aliasing or
36025 forwarding, the changes are cumulative.
36026
36027 .oindex "&%unseen%&"
36028 However, this does not apply to multiple routers that result from the use of
36029 the &%unseen%& option. Any header modifications that were specified by the
36030 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36031
36032 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36033 settings cannot be delivered together in a batch, so a transport is always
36034 dealing with a set of addresses that have the same header-processing
36035 requirements.
36036
36037 The transport starts by writing the original set of header lines that arrived
36038 with the message, possibly modified by the system filter. As it writes out
36039 these lines, it consults the list of header names that were attached to the
36040 recipient address(es) by &%headers_remove%& options in routers, and it also
36041 consults the transport's own &%headers_remove%& option. Header lines whose
36042 names are on either of these lists are not written out. If there are multiple
36043 instances of any listed header, they are all skipped.
36044
36045 After the remaining original header lines have been written, new header
36046 lines that were specified by routers' &%headers_add%& options are written, in
36047 the order in which they were attached to the address. These are followed by any
36048 header lines specified by the transport's &%headers_add%& option.
36049
36050 This way of handling header line modifications in routers and transports has
36051 the following consequences:
36052
36053 .ilist
36054 The original set of header lines, possibly modified by the system filter,
36055 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36056 to it, at all times.
36057 .next
36058 Header lines that are added by a router's
36059 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36060 expansion syntax in subsequent routers or the transport.
36061 .next
36062 Conversely, header lines that are specified for removal by &%headers_remove%&
36063 in a router remain visible to subsequent routers and the transport.
36064 .next
36065 Headers added to an address by &%headers_add%& in a router cannot be removed by
36066 a later router or by a transport.
36067 .next
36068 An added header can refer to the contents of an original header that is to be
36069 removed, even it has the same name as the added header. For example:
36070 .code
36071 headers_remove = subject
36072 headers_add = Subject: new subject (was: $h_subject:)
36073 .endd
36074 .endlist
36075
36076 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36077 for a &(redirect)& router that has the &%one_time%& option set.
36078
36079
36080
36081
36082
36083 .section "Constructed addresses" "SECTconstr"
36084 .cindex "address" "constructed"
36085 .cindex "constructed address"
36086 When Exim constructs a sender address for a locally-generated message, it uses
36087 the form
36088 .display
36089 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36090 .endd
36091 For example:
36092 .code
36093 Zaphod Beeblebrox <zaphod@end.univ.example>
36094 .endd
36095 The user name is obtained from the &%-F%& command line option if set, or
36096 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36097 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36098 ampersand character, this is replaced by the login name with the first letter
36099 upper cased, as is conventional in a number of operating systems. See the
36100 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36101 The &%unknown_username%& option can be used to specify user names in cases when
36102 there is no password file entry.
36103
36104 .cindex "RFC 2047"
36105 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36106 parts of it if necessary. In addition, if it contains any non-printing
36107 characters, it is encoded as described in RFC 2047, which defines a way of
36108 including non-ASCII characters in header lines. The value of the
36109 &%headers_charset%& option specifies the name of the encoding that is used (the
36110 characters are assumed to be in this encoding). The setting of
36111 &%print_topbitchars%& controls whether characters with the top bit set (that
36112 is, with codes greater than 127) count as printing characters or not.
36113
36114
36115
36116 .section "Case of local parts" "SECID230"
36117 .cindex "case of local parts"
36118 .cindex "local part" "case of"
36119 RFC 2822 states that the case of letters in the local parts of addresses cannot
36120 be assumed to be non-significant. Exim preserves the case of local parts of
36121 addresses, but by default it uses a lower-cased form when it is routing,
36122 because on most Unix systems, usernames are in lower case and case-insensitive
36123 routing is required. However, any particular router can be made to use the
36124 original case for local parts by setting the &%caseful_local_part%& generic
36125 router option.
36126
36127 .cindex "mixed-case login names"
36128 If you must have mixed-case user names on your system, the best way to proceed,
36129 assuming you want case-independent handling of incoming email, is to set up
36130 your first router to convert incoming local parts in your domains to the
36131 correct case by means of a file lookup. For example:
36132 .code
36133 correct_case:
36134   driver = redirect
36135   domains = +local_domains
36136   data = ${lookup{$local_part}cdb\
36137               {/etc/usercased.cdb}{$value}fail}\
36138               @$domain
36139 .endd
36140 For this router, the local part is forced to lower case by the default action
36141 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36142 up a new local part in the correct case. If you then set &%caseful_local_part%&
36143 on any subsequent routers which process your domains, they will operate on
36144 local parts with the correct case in a case-sensitive manner.
36145
36146
36147
36148 .section "Dots in local parts" "SECID231"
36149 .cindex "dot" "in local part"
36150 .cindex "local part" "dots in"
36151 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36152 part may not begin or end with a dot, nor have two consecutive dots in the
36153 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36154 empty components for compatibility.
36155
36156
36157
36158 .section "Rewriting addresses" "SECID232"
36159 .cindex "rewriting" "addresses"
36160 Rewriting of sender and recipient addresses, and addresses in headers, can
36161 happen automatically, or as the result of configuration options, as described
36162 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36163 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36164
36165 Automatic rewriting includes qualification, as mentioned above. The other case
36166 in which it can happen is when an incomplete non-local domain is given. The
36167 routing process may cause this to be expanded into the full domain name. For
36168 example, a header such as
36169 .code
36170 To: hare@teaparty
36171 .endd
36172 might get rewritten as
36173 .code
36174 To: hare@teaparty.wonderland.fict.example
36175 .endd
36176 Rewriting as a result of routing is the one kind of message processing that
36177 does not happen at input time, as it cannot be done until the address has
36178 been routed.
36179
36180 Strictly, one should not do &'any'& deliveries of a message until all its
36181 addresses have been routed, in case any of the headers get changed as a
36182 result of routing. However, doing this in practice would hold up many
36183 deliveries for unreasonable amounts of time, just because one address could not
36184 immediately be routed. Exim therefore does not delay other deliveries when
36185 routing of one or more addresses is deferred.
36186 .ecindex IIDmesproc
36187
36188
36189
36190 . ////////////////////////////////////////////////////////////////////////////
36191 . ////////////////////////////////////////////////////////////////////////////
36192
36193 .chapter "SMTP processing" "CHAPSMTP"
36194 .scindex IIDsmtpproc1 "SMTP" "processing details"
36195 .scindex IIDsmtpproc2 "LMTP" "processing details"
36196 Exim supports a number of different ways of using the SMTP protocol, and its
36197 LMTP variant, which is an interactive protocol for transferring messages into a
36198 closed mail store application. This chapter contains details of how SMTP is
36199 processed. For incoming mail, the following are available:
36200
36201 .ilist
36202 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36203 .next
36204 SMTP over the standard input and output (the &%-bs%& option);
36205 .next
36206 Batched SMTP on the standard input (the &%-bS%& option).
36207 .endlist
36208
36209 For mail delivery, the following are available:
36210
36211 .ilist
36212 SMTP over TCP/IP (the &(smtp)& transport);
36213 .next
36214 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36215 &"lmtp"&);
36216 .next
36217 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36218 transport);
36219 .next
36220 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36221 the &%use_bsmtp%& option set).
36222 .endlist
36223
36224 &'Batched SMTP'& is the name for a process in which batches of messages are
36225 stored in or read from files (or pipes), in a format in which SMTP commands are
36226 used to contain the envelope information.
36227
36228
36229
36230 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36231 .cindex "SMTP" "outgoing over TCP/IP"
36232 .cindex "outgoing SMTP over TCP/IP"
36233 .cindex "LMTP" "over TCP/IP"
36234 .cindex "outgoing LMTP over TCP/IP"
36235 .cindex "EHLO"
36236 .cindex "HELO"
36237 .cindex "SIZE" "option on MAIL command"
36238 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36239 The &%protocol%& option selects which protocol is to be used, but the actual
36240 processing is the same in both cases.
36241
36242 .cindex "ESMTP extensions" SIZE
36243 If, in response to its EHLO command, Exim is told that the SIZE
36244 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36245 command. The value of <&'n'&> is the message size plus the value of the
36246 &%size_addition%& option (default 1024) to allow for additions to the message
36247 such as per-transport header lines, or changes made in a
36248 .cindex "transport" "filter"
36249 .cindex "filter" "transport filter"
36250 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36251 suppressed.
36252
36253 If the remote server advertises support for PIPELINING, Exim uses the
36254 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36255 required for the transaction.
36256
36257 If the remote server advertises support for the STARTTLS command, and Exim
36258 was built to support TLS encryption, it tries to start a TLS session unless the
36259 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36260 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36261 is called for verification.
36262
36263 If the remote server advertises support for the AUTH command, Exim scans
36264 the authenticators configuration for any suitable client settings, as described
36265 in chapter &<<CHAPSMTPAUTH>>&.
36266
36267 .cindex "carriage return"
36268 .cindex "linefeed"
36269 Responses from the remote host are supposed to be terminated by CR followed by
36270 LF. However, there are known to be hosts that do not send CR characters, so in
36271 order to be able to interwork with such hosts, Exim treats LF on its own as a
36272 line terminator.
36273
36274 If a message contains a number of different addresses, all those with the same
36275 characteristics (for example, the same envelope sender) that resolve to the
36276 same set of hosts, in the same order, are sent in a single SMTP transaction,
36277 even if they are for different domains, unless there are more than the setting
36278 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36279 they are split into groups containing no more than &%max_rcpt%&s addresses
36280 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36281 in parallel sessions. The order of hosts with identical MX values is not
36282 significant when checking whether addresses can be batched in this way.
36283
36284 When the &(smtp)& transport suffers a temporary failure that is not
36285 message-related, Exim updates its transport-specific database, which contains
36286 records indexed by host name that remember which messages are waiting for each
36287 particular host. It also updates the retry database with new retry times.
36288
36289 .cindex "hints database" "retry keys"
36290 Exim's retry hints are based on host name plus IP address, so if one address of
36291 a multi-homed host is broken, it will soon be skipped most of the time.
36292 See the next section for more detail about error handling.
36293
36294 .cindex "SMTP" "passed connection"
36295 .cindex "SMTP" "batching over TCP/IP"
36296 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36297 looks in the hints database for the transport to see if there are any queued
36298 messages waiting for the host to which it is connected. If it finds one, it
36299 creates a new Exim process using the &%-MC%& option (which can only be used by
36300 a process running as root or the Exim user) and passes the TCP/IP socket to it
36301 so that it can deliver another message using the same socket. The new process
36302 does only those deliveries that are routed to the connected host, and may in
36303 turn pass the socket on to a third process, and so on.
36304
36305 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36306 limit the number of messages sent down a single TCP/IP connection.
36307
36308 .cindex "asterisk" "after IP address"
36309 The second and subsequent messages delivered down an existing connection are
36310 identified in the main log by the addition of an asterisk after the closing
36311 square bracket of the IP address.
36312
36313
36314
36315
36316 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36317 .cindex "error" "in outgoing SMTP"
36318 .cindex "SMTP" "errors in outgoing"
36319 .cindex "host" "error"
36320 Three different kinds of error are recognized for outgoing SMTP: host errors,
36321 message errors, and recipient errors.
36322
36323 .vlist
36324 .vitem "&*Host errors*&"
36325 A host error is not associated with a particular message or with a
36326 particular recipient of a message. The host errors are:
36327
36328 .ilist
36329 Connection refused or timed out,
36330 .next
36331 Any error response code on connection,
36332 .next
36333 Any error response code to EHLO or HELO,
36334 .next
36335 Loss of connection at any time, except after &"."&,
36336 .next
36337 I/O errors at any time,
36338 .next
36339 Timeouts during the session, other than in response to MAIL, RCPT or
36340 the &"."& at the end of the data.
36341 .endlist ilist
36342
36343 For a host error, a permanent error response on connection, or in response to
36344 EHLO, causes all addresses routed to the host to be failed. Any other host
36345 error causes all addresses to be deferred, and retry data to be created for the
36346 host. It is not tried again, for any message, until its retry time arrives. If
36347 the current set of addresses are not all delivered in this run (to some
36348 alternative host), the message is added to the list of those waiting for this
36349 host, so if it is still undelivered when a subsequent successful delivery is
36350 made to the host, it will be sent down the same SMTP connection.
36351
36352 .vitem "&*Message errors*&"
36353 .cindex "message" "error"
36354 A message error is associated with a particular message when sent to a
36355 particular host, but not with a particular recipient of the message. The
36356 message errors are:
36357
36358 .ilist
36359 Any error response code to MAIL, DATA, or the &"."& that terminates
36360 the data,
36361 .next
36362 Timeout after MAIL,
36363 .next
36364 Timeout or loss of connection after the &"."& that terminates the data. A
36365 timeout after the DATA command itself is treated as a host error, as is loss of
36366 connection at any other time.
36367 .endlist ilist
36368
36369 For a message error, a permanent error response (5&'xx'&) causes all addresses
36370 to be failed, and a delivery error report to be returned to the sender. A
36371 temporary error response (4&'xx'&), or one of the timeouts, causes all
36372 addresses to be deferred. Retry data is not created for the host, but instead,
36373 a retry record for the combination of host plus message id is created. The
36374 message is not added to the list of those waiting for this host. This ensures
36375 that the failing message will not be sent to this host again until the retry
36376 time arrives. However, other messages that are routed to the host are not
36377 affected, so if it is some property of the message that is causing the error,
36378 it will not stop the delivery of other mail.
36379
36380 If the remote host specified support for the SIZE parameter in its response
36381 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36382 over-large message will cause a message error because the error arrives as a
36383 response to MAIL.
36384
36385 .vitem "&*Recipient errors*&"
36386 .cindex "recipient" "error"
36387 A recipient error is associated with a particular recipient of a message. The
36388 recipient errors are:
36389
36390 .ilist
36391 Any error response to RCPT,
36392 .next
36393 Timeout after RCPT.
36394 .endlist
36395
36396 For a recipient error, a permanent error response (5&'xx'&) causes the
36397 recipient address to be failed, and a bounce message to be returned to the
36398 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36399 address to be deferred, and routing retry data to be created for it. This is
36400 used to delay processing of the address in subsequent queue runs, until its
36401 routing retry time arrives. This applies to all messages, but because it
36402 operates only in queue runs, one attempt will be made to deliver a new message
36403 to the failing address before the delay starts to operate. This ensures that,
36404 if the failure is really related to the message rather than the recipient
36405 (&"message too big for this recipient"& is a possible example), other messages
36406 have a chance of getting delivered. If a delivery to the address does succeed,
36407 the retry information gets cleared, so all stuck messages get tried again, and
36408 the retry clock is reset.
36409
36410 The message is not added to the list of those waiting for this host. Use of the
36411 host for other messages is unaffected, and except in the case of a timeout,
36412 other recipients are processed independently, and may be successfully delivered
36413 in the current SMTP session. After a timeout it is of course impossible to
36414 proceed with the session, so all addresses get deferred. However, those other
36415 than the one that failed do not suffer any subsequent retry delays. Therefore,
36416 if one recipient is causing trouble, the others have a chance of getting
36417 through when a subsequent delivery attempt occurs before the failing
36418 recipient's retry time.
36419 .endlist
36420
36421 In all cases, if there are other hosts (or IP addresses) available for the
36422 current set of addresses (for example, from multiple MX records), they are
36423 tried in this run for any undelivered addresses, subject of course to their
36424 own retry data. In other words, recipient error retry data does not take effect
36425 until the next delivery attempt.
36426
36427 Some hosts have been observed to give temporary error responses to every
36428 MAIL command at certain times (&"insufficient space"& has been seen). It
36429 would be nice if such circumstances could be recognized, and defer data for the
36430 host itself created, but this is not possible within the current Exim design.
36431 What actually happens is that retry data for every (host, message) combination
36432 is created.
36433
36434 The reason that timeouts after MAIL and RCPT are treated specially is that
36435 these can sometimes arise as a result of the remote host's verification
36436 procedures. Exim makes this assumption, and treats them as if a temporary error
36437 response had been received. A timeout after &"."& is treated specially because
36438 it is known that some broken implementations fail to recognize the end of the
36439 message if the last character of the last line is a binary zero. Thus, it is
36440 helpful to treat this case as a message error.
36441
36442 Timeouts at other times are treated as host errors, assuming a problem with the
36443 host, or the connection to it. If a timeout after MAIL, RCPT,
36444 or &"."& is really a connection problem, the assumption is that at the next try
36445 the timeout is likely to occur at some other point in the dialogue, causing it
36446 then to be treated as a host error.
36447
36448 There is experimental evidence that some MTAs drop the connection after the
36449 terminating &"."& if they do not like the contents of the message for some
36450 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36451 should be given. That is why Exim treats this case as a message rather than a
36452 host error, in order not to delay other messages to the same host.
36453
36454
36455
36456
36457 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36458 .cindex "SMTP" "incoming over TCP/IP"
36459 .cindex "incoming SMTP over TCP/IP"
36460 .cindex "inetd"
36461 .cindex "daemon"
36462 Incoming SMTP messages can be accepted in one of two ways: by running a
36463 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36464 &_/etc/inetd.conf_& should be like this:
36465 .code
36466 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36467 .endd
36468 Exim distinguishes between this case and the case of a locally running user
36469 agent using the &%-bs%& option by checking whether or not the standard input is
36470 a socket. When it is, either the port must be privileged (less than 1024), or
36471 the caller must be root or the Exim user. If any other user passes a socket
36472 with an unprivileged port number, Exim prints a message on the standard error
36473 stream and exits with an error code.
36474
36475 By default, Exim does not make a log entry when a remote host connects or
36476 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36477 unexpected. It can be made to write such log entries by setting the
36478 &%smtp_connection%& log selector.
36479
36480 .cindex "carriage return"
36481 .cindex "linefeed"
36482 Commands from the remote host are supposed to be terminated by CR followed by
36483 LF. However, there are known to be hosts that do not send CR characters. In
36484 order to be able to interwork with such hosts, Exim treats LF on its own as a
36485 line terminator.
36486 Furthermore, because common code is used for receiving messages from all
36487 sources, a CR on its own is also interpreted as a line terminator. However, the
36488 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36489
36490 .cindex "EHLO" "invalid data"
36491 .cindex "HELO" "invalid data"
36492 One area that sometimes gives rise to problems concerns the EHLO or
36493 HELO commands. Some clients send syntactically invalid versions of these
36494 commands, which Exim rejects by default. (This is nothing to do with verifying
36495 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36496 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36497 match the broken hosts that send invalid commands.
36498
36499 .cindex "SIZE option on MAIL command"
36500 .cindex "MAIL" "SIZE option"
36501 The amount of disk space available is checked whenever SIZE is received on
36502 a MAIL command, independently of whether &%message_size_limit%& or
36503 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36504 false. A temporary error is given if there is not enough space. If
36505 &%check_spool_space%& is set, the check is for that amount of space plus the
36506 value given with SIZE, that is, it checks that the addition of the incoming
36507 message will not reduce the space below the threshold.
36508
36509 When a message is successfully received, Exim includes the local message id in
36510 its response to the final &"."& that terminates the data. If the remote host
36511 logs this text it can help with tracing what has happened to a message.
36512
36513 The Exim daemon can limit the number of simultaneous incoming connections it is
36514 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36515 number of simultaneous incoming connections from a single remote host (see the
36516 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36517 rejected using the SMTP temporary error code 421.
36518
36519 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36520 subprocess has finished, as this can get lost at busy times. Instead, it looks
36521 for completed subprocesses every time it wakes up. Provided there are other
36522 things happening (new incoming calls, starts of queue runs), completed
36523 processes will be noticed and tidied away. On very quiet systems you may
36524 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36525 it will be noticed when the daemon next wakes up.
36526
36527 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36528 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36529 high system load &-- for details see the &%smtp_accept_reserve%&,
36530 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36531 applies in both the daemon and &'inetd'& cases.
36532
36533 Exim normally starts a delivery process for each message received, though this
36534 can be varied by means of the &%-odq%& command line option and the
36535 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36536 number of simultaneously running delivery processes started in this way from
36537 SMTP input can be limited by the &%smtp_accept_queue%& and
36538 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36539 subsequently received messages are just put on the input queue without starting
36540 a delivery process.
36541
36542 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36543 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36544 started up from the &'inetd'& daemon, because in that case each connection is
36545 handled by an entirely independent Exim process. Control by load average is,
36546 however, available with &'inetd'&.
36547
36548 Exim can be configured to verify addresses in incoming SMTP commands as they
36549 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36550 to rewrite addresses at this time &-- before any syntax checking is done. See
36551 section &<<SECTrewriteS>>&.
36552
36553 Exim can also be configured to limit the rate at which a client host submits
36554 MAIL and RCPT commands in a single SMTP session. See the
36555 &%smtp_ratelimit_hosts%& option.
36556
36557
36558
36559 .section "Unrecognized SMTP commands" "SECID234"
36560 .cindex "SMTP" "unrecognized commands"
36561 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36562 commands during a single SMTP connection, it drops the connection after sending
36563 the error response to the last command. The default value for
36564 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36565 abuse that subvert web servers into making connections to SMTP ports; in these
36566 circumstances, a number of non-SMTP lines are sent first.
36567
36568
36569 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36570 .cindex "SMTP" "syntax errors"
36571 .cindex "SMTP" "protocol errors"
36572 A syntax error is detected if an SMTP command is recognized, but there is
36573 something syntactically wrong with its data, for example, a malformed email
36574 address in a RCPT command. Protocol errors include invalid command
36575 sequencing such as RCPT before MAIL. If Exim receives more than
36576 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36577 drops the connection after sending the error response to the last command. The
36578 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36579 broken clients that loop sending bad commands (yes, it has been seen).
36580
36581
36582
36583 .section "Use of non-mail SMTP commands" "SECID236"
36584 .cindex "SMTP" "non-mail commands"
36585 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36586 DATA. Exim counts such commands, and drops the connection if there are too
36587 many of them in a single SMTP session. This action catches some
36588 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36589 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36590 defines what &"too many"& means. Its default value is 10.
36591
36592 When a new message is expected, one occurrence of RSET is not counted. This
36593 allows a client to send one RSET between messages (this is not necessary,
36594 but some clients do it). Exim also allows one uncounted occurrence of HELO
36595 or EHLO, and one occurrence of STARTTLS between messages. After
36596 starting up a TLS session, another EHLO is expected, and so it too is not
36597 counted.
36598
36599 The first occurrence of AUTH in a connection, or immediately following
36600 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36601 RCPT, DATA, and QUIT are counted.
36602
36603 You can control which hosts are subject to the limit set by
36604 &%smtp_accept_max_nonmail%& by setting
36605 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36606 the limit apply to all hosts. This option means that you can exclude any
36607 specific badly-behaved hosts that you have to live with.
36608
36609
36610
36611
36612 .section "The VRFY and EXPN commands" "SECID237"
36613 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36614 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36615 appropriate) in order to decide whether the command should be accepted or not.
36616
36617 .cindex "VRFY" "processing"
36618 When no ACL is defined for VRFY, or if it rejects without
36619 setting an explicit response code, the command is accepted
36620 (with a 252 SMTP response code)
36621 in order to support awkward clients that do a VRFY before every RCPT.
36622 When VRFY is accepted, it runs exactly the same code as when Exim is
36623 called with the &%-bv%& option, and returns 250/451/550
36624 SMTP response codes.
36625
36626 .cindex "EXPN" "processing"
36627 If no ACL for EXPN is defined, the command is rejected.
36628 When EXPN is accepted, a single-level expansion of the address is done.
36629 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36630 than a verification (the &%-bv%& option). If an unqualified local part is given
36631 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36632 of VRFY and EXPN commands are logged on the main and reject logs, and
36633 VRFY verification failures are logged on the main log for consistency with
36634 RCPT failures.
36635
36636
36637
36638 .section "The ETRN command" "SECTETRN"
36639 .cindex "ETRN" "processing"
36640 .cindex "ESMTP extensions" ETRN
36641 RFC 1985 describes an ESMTP command called ETRN that is designed to
36642 overcome the security problems of the TURN command (which has fallen into
36643 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36644 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36645 should be accepted or not. If no ACL is defined, the command is rejected.
36646
36647 The ETRN command is concerned with &"releasing"& messages that are awaiting
36648 delivery to certain hosts. As Exim does not organize its message queue by host,
36649 the only form of ETRN that is supported by default is the one where the
36650 text starts with the &"#"& prefix, in which case the remainder of the text is
36651 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36652 the &%-R%& option to happen, with the remainder of the ETRN text as its
36653 argument. For example,
36654 .code
36655 ETRN #brigadoon
36656 .endd
36657 runs the command
36658 .code
36659 exim -R brigadoon
36660 .endd
36661 which causes a delivery attempt on all messages with undelivered addresses
36662 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36663 default), Exim prevents the simultaneous execution of more than one queue run
36664 for the same argument string as a result of an ETRN command. This stops
36665 a misbehaving client from starting more than one queue runner at once.
36666
36667 .cindex "hints database" "ETRN serialization"
36668 Exim implements the serialization by means of a hints database in which a
36669 record is written whenever a process is started by ETRN, and deleted when
36670 the process completes. However, Exim does not keep the SMTP session waiting for
36671 the ETRN process to complete. Once ETRN is accepted, the client is sent
36672 a &"success"& return code. Obviously there is scope for hints records to get
36673 left lying around if there is a system or program crash. To guard against this,
36674 Exim ignores any records that are more than six hours old.
36675
36676 .oindex "&%smtp_etrn_command%&"
36677 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36678 used. This specifies a command that is run whenever ETRN is received,
36679 whatever the form of its argument. For
36680 example:
36681 .code
36682 smtp_etrn_command = /etc/etrn_command $domain \
36683                     $sender_host_address
36684 .endd
36685 .vindex "&$domain$&"
36686 The string is split up into arguments which are independently expanded. The
36687 expansion variable &$domain$& is set to the argument of the ETRN command,
36688 and no syntax checking is done on the contents of this argument. Exim does not
36689 wait for the command to complete, so its status code is not checked. Exim runs
36690 under its own uid and gid when receiving incoming SMTP, so it is not possible
36691 for it to change them before running the command.
36692
36693
36694
36695 .section "Incoming local SMTP" "SECID238"
36696 .cindex "SMTP" "local incoming"
36697 Some user agents use SMTP to pass messages to their local MTA using the
36698 standard input and output, as opposed to passing the envelope on the command
36699 line and writing the message to the standard input. This is supported by the
36700 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36701 messages over TCP/IP (including the use of ACLs), except that the envelope
36702 sender given in a MAIL command is ignored unless the caller is trusted. In
36703 an ACL you can detect this form of SMTP input by testing for an empty host
36704 identification. It is common to have this as the first line in the ACL that
36705 runs for RCPT commands:
36706 .code
36707 accept hosts = :
36708 .endd
36709 This accepts SMTP messages from local processes without doing any other tests.
36710
36711
36712
36713 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36714 .cindex "SMTP" "batched outgoing"
36715 .cindex "batched SMTP output"
36716 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36717 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36718 be output in BSMTP format. No SMTP responses are possible for this form of
36719 delivery. All it is doing is using SMTP commands as a way of transmitting the
36720 envelope along with the message.
36721
36722 The message is written to the file or pipe preceded by the SMTP commands
36723 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36724 the message that start with a dot have an extra dot added. The SMTP command
36725 HELO is not normally used. If it is required, the &%message_prefix%& option
36726 can be used to specify it.
36727
36728 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36729 one recipient address at a time by default. However, you can arrange for them
36730 to handle several addresses at once by setting the &%batch_max%& option. When
36731 this is done for BSMTP, messages may contain multiple RCPT commands. See
36732 chapter &<<CHAPbatching>>& for more details.
36733
36734 .vindex "&$host$&"
36735 When one or more addresses are routed to a BSMTP transport by a router that
36736 sets up a host list, the name of the first host on the list is available to the
36737 transport in the variable &$host$&. Here is an example of such a transport and
36738 router:
36739 .code
36740 begin routers
36741 route_append:
36742   driver = manualroute
36743   transport = smtp_appendfile
36744   route_list = domain.example  batch.host.example
36745
36746 begin transports
36747 smtp_appendfile:
36748   driver = appendfile
36749   directory = /var/bsmtp/$host
36750   batch_max = 1000
36751   use_bsmtp
36752   user = exim
36753 .endd
36754 This causes messages addressed to &'domain.example'& to be written in BSMTP
36755 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36756 message (unless there are more than 1000 recipients).
36757
36758
36759
36760 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36761 .cindex "SMTP" "batched incoming"
36762 .cindex "batched SMTP input"
36763 The &%-bS%& command line option causes Exim to accept one or more messages by
36764 reading SMTP on the standard input, but to generate no responses. If the caller
36765 is trusted, the senders in the MAIL commands are believed; otherwise the
36766 sender is always the caller of Exim. Unqualified senders and receivers are not
36767 rejected (there seems little point) but instead just get qualified. HELO
36768 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36769 as NOOP; QUIT quits.
36770
36771 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36772 ACL is run in the same way as for non-SMTP local input.
36773
36774 If an error is detected while reading a message, including a missing &"."& at
36775 the end, Exim gives up immediately. It writes details of the error to the
36776 standard output in a stylized way that the calling program should be able to
36777 make some use of automatically, for example:
36778 .code
36779 554 Unexpected end of file
36780 Transaction started in line 10
36781 Error detected in line 14
36782 .endd
36783 It writes a more verbose version, for human consumption, to the standard error
36784 file, for example:
36785 .code
36786 An error was detected while processing a file of BSMTP input.
36787 The error message was:
36788
36789 501 '>' missing at end of address
36790
36791 The SMTP transaction started in line 10.
36792 The error was detected in line 12.
36793 The SMTP command at fault was:
36794
36795 rcpt to:<malformed@in.com.plete
36796
36797 1 previous message was successfully processed.
36798 The rest of the batch was abandoned.
36799 .endd
36800 The return code from Exim is zero only if there were no errors. It is 1 if some
36801 messages were accepted before an error was detected, and 2 if no messages were
36802 accepted.
36803 .ecindex IIDsmtpproc1
36804 .ecindex IIDsmtpproc2
36805
36806
36807
36808 . ////////////////////////////////////////////////////////////////////////////
36809 . ////////////////////////////////////////////////////////////////////////////
36810
36811 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36812          "Customizing messages"
36813 When a message fails to be delivered, or remains in the queue for more than a
36814 configured amount of time, Exim sends a message to the original sender, or
36815 to an alternative configured address. The text of these messages is built into
36816 the code of Exim, but it is possible to change it, either by adding a single
36817 string, or by replacing each of the paragraphs by text supplied in a file.
36818
36819 The &'From:'& and &'To:'& header lines are automatically generated; you can
36820 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36821 option. Exim also adds the line
36822 .code
36823 Auto-Submitted: auto-generated
36824 .endd
36825 to all warning and bounce messages,
36826
36827
36828 .section "Customizing bounce messages" "SECID239"
36829 .cindex "customizing" "bounce message"
36830 .cindex "bounce message" "customizing"
36831 If &%bounce_message_text%& is set, its contents are included in the default
36832 message immediately after &"This message was created automatically by mail
36833 delivery software."& The string is not expanded. It is not used if
36834 &%bounce_message_file%& is set.
36835
36836 When &%bounce_message_file%& is set, it must point to a template file for
36837 constructing error messages. The file consists of a series of text items,
36838 separated by lines consisting of exactly four asterisks. If the file cannot be
36839 opened, default text is used and a message is written to the main and panic
36840 logs. If any text item in the file is empty, default text is used for that
36841 item.
36842
36843 .vindex "&$bounce_recipient$&"
36844 .vindex "&$bounce_return_size_limit$&"
36845 Each item of text that is read from the file is expanded, and there are two
36846 expansion variables which can be of use here: &$bounce_recipient$& is set to
36847 the recipient of an error message while it is being created, and
36848 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36849 option, rounded to a whole number.
36850
36851 The items must appear in the file in the following order:
36852
36853 .ilist
36854 The first item is included in the headers, and should include at least a
36855 &'Subject:'& header. Exim does not check the syntax of these headers.
36856 .next
36857 The second item forms the start of the error message. After it, Exim lists the
36858 failing addresses with their error messages.
36859 .next
36860 The third item is used to introduce any text from pipe transports that is to be
36861 returned to the sender. It is omitted if there is no such text.
36862 .next
36863 The fourth, fifth and sixth items will be ignored and may be empty.
36864 The fields exist for back-compatibility
36865 .endlist
36866
36867 The default state (&%bounce_message_file%& unset) is equivalent to the
36868 following file, in which the sixth item is empty. The &'Subject:'& and some
36869 other lines have been split in order to fit them on the page:
36870 .code
36871 Subject: Mail delivery failed
36872   ${if eq{$sender_address}{$bounce_recipient}
36873   {: returning message to sender}}
36874 ****
36875 This message was created automatically by mail delivery software.
36876
36877 A message ${if eq{$sender_address}{$bounce_recipient}
36878   {that you sent }{sent by
36879
36880 <$sender_address>
36881
36882 }}could not be delivered to all of its recipients.
36883 This is a permanent error. The following address(es) failed:
36884 ****
36885 The following text was generated during the delivery attempt(s):
36886 ****
36887 ------ This is a copy of the message, including all the headers.
36888   ------
36889 ****
36890 ------ The body of the message is $message_size characters long;
36891   only the first
36892 ------ $bounce_return_size_limit or so are included here.
36893 ****
36894 .endd
36895 .section "Customizing warning messages" "SECTcustwarn"
36896 .cindex "customizing" "warning message"
36897 .cindex "warning of delay" "customizing the message"
36898 The option &%warn_message_file%& can be pointed at a template file for use when
36899 warnings about message delays are created. In this case there are only three
36900 text sections:
36901
36902 .ilist
36903 The first item is included in the headers, and should include at least a
36904 &'Subject:'& header. Exim does not check the syntax of these headers.
36905 .next
36906 The second item forms the start of the warning message. After it, Exim lists
36907 the delayed addresses.
36908 .next
36909 The third item then ends the message.
36910 .endlist
36911
36912 The default state is equivalent to the following file, except that some lines
36913 have been split here, in order to fit them on the page:
36914 .code
36915 Subject: Warning: message $message_exim_id delayed
36916   $warn_message_delay
36917 ****
36918 This message was created automatically by mail delivery software.
36919
36920 A message ${if eq{$sender_address}{$warn_message_recipients}
36921 {that you sent }{sent by
36922
36923 <$sender_address>
36924
36925 }}has not been delivered to all of its recipients after
36926 more than $warn_message_delay in the queue on $primary_hostname.
36927
36928 The message identifier is:     $message_exim_id
36929 The subject of the message is: $h_subject
36930 The date of the message is:    $h_date
36931
36932 The following address(es) have not yet been delivered:
36933 ****
36934 No action is required on your part. Delivery attempts will
36935 continue for some time, and this warning may be repeated at
36936 intervals if the message remains undelivered. Eventually the
36937 mail delivery software will give up, and when that happens,
36938 the message will be returned to you.
36939 .endd
36940 .vindex "&$warn_message_delay$&"
36941 .vindex "&$warn_message_recipients$&"
36942 However, in the default state the subject and date lines are omitted if no
36943 appropriate headers exist. During the expansion of this file,
36944 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36945 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36946 of recipients for the warning message. There may be more than one if there are
36947 multiple addresses with different &%errors_to%& settings on the routers that
36948 handled them.
36949
36950
36951
36952
36953 . ////////////////////////////////////////////////////////////////////////////
36954 . ////////////////////////////////////////////////////////////////////////////
36955
36956 .chapter "Some common configuration settings" "CHAPcomconreq"
36957 This chapter discusses some configuration settings that seem to be fairly
36958 common. More examples and discussion can be found in the Exim book.
36959
36960
36961
36962 .section "Sending mail to a smart host" "SECID240"
36963 .cindex "smart host" "example router"
36964 If you want to send all mail for non-local domains to a &"smart host"&, you
36965 should replace the default &(dnslookup)& router with a router which does the
36966 routing explicitly:
36967 .code
36968 send_to_smart_host:
36969   driver = manualroute
36970   route_list = !+local_domains smart.host.name
36971   transport = remote_smtp
36972 .endd
36973 You can use the smart host's IP address instead of the name if you wish.
36974 If you are using Exim only to submit messages to a smart host, and not for
36975 receiving incoming messages, you can arrange for it to do the submission
36976 synchronously by setting the &%mua_wrapper%& option (see chapter
36977 &<<CHAPnonqueueing>>&).
36978
36979
36980
36981
36982 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36983 .cindex "mailing lists"
36984 Exim can be used to run simple mailing lists, but for large and/or complicated
36985 requirements, the use of additional specialized mailing list software such as
36986 Majordomo or Mailman is recommended.
36987
36988 The &(redirect)& router can be used to handle mailing lists where each list
36989 is maintained in a separate file, which can therefore be managed by an
36990 independent manager. The &%domains%& router option can be used to run these
36991 lists in a separate domain from normal mail. For example:
36992 .code
36993 lists:
36994   driver = redirect
36995   domains = lists.example
36996   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
36997   forbid_pipe
36998   forbid_file
36999   errors_to = ${quote_local_part:$local_part-request}@lists.example
37000   no_more
37001 .endd
37002 This router is skipped for domains other than &'lists.example'&. For addresses
37003 in that domain, it looks for a file that matches the local part. If there is no
37004 such file, the router declines, but because &%no_more%& is set, no subsequent
37005 routers are tried, and so the whole delivery fails.
37006
37007 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37008 expanded into a filename or a pipe delivery, which is usually inappropriate in
37009 a mailing list.
37010
37011 .oindex "&%errors_to%&"
37012 The &%errors_to%& option specifies that any delivery errors caused by addresses
37013 taken from a mailing list are to be sent to the given address rather than the
37014 original sender of the message. However, before acting on this, Exim verifies
37015 the error address, and ignores it if verification fails.
37016
37017 For example, using the configuration above, mail sent to
37018 &'dicts@lists.example'& is passed on to those addresses contained in
37019 &_/usr/lists/dicts_&, with error reports directed to
37020 &'dicts-request@lists.example'&, provided that this address can be verified.
37021 There could be a file called &_/usr/lists/dicts-request_& containing
37022 the address(es) of this particular list's manager(s), but other approaches,
37023 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37024 or &%local_part_suffix%& options) to handle addresses of the form
37025 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37026
37027
37028
37029 .section "Syntax errors in mailing lists" "SECID241"
37030 .cindex "mailing lists" "syntax errors in"
37031 If an entry in redirection data contains a syntax error, Exim normally defers
37032 delivery of the original address. That means that a syntax error in a mailing
37033 list holds up all deliveries to the list. This may not be appropriate when a
37034 list is being maintained automatically from data supplied by users, and the
37035 addresses are not rigorously checked.
37036
37037 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37038 entries that fail to parse, noting the incident in the log. If in addition
37039 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37040 whenever a broken address is skipped. It is usually appropriate to set
37041 &%syntax_errors_to%& to the same address as &%errors_to%&.
37042
37043
37044
37045 .section "Re-expansion of mailing lists" "SECID242"
37046 .cindex "mailing lists" "re-expansion of"
37047 Exim remembers every individual address to which a message has been delivered,
37048 in order to avoid duplication, but it normally stores only the original
37049 recipient addresses with a message. If all the deliveries to a mailing list
37050 cannot be done at the first attempt, the mailing list is re-expanded when the
37051 delivery is next tried. This means that alterations to the list are taken into
37052 account at each delivery attempt, so addresses that have been added to
37053 the list since the message arrived will therefore receive a copy of the
37054 message, even though it pre-dates their subscription.
37055
37056 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37057 on the &(redirect)& router. If this is done, any addresses generated by the
37058 router that fail to deliver at the first attempt are added to the message as
37059 &"top level"& addresses, and the parent address that generated them is marked
37060 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37061 subsequent delivery attempts. The disadvantage of this is that if any of the
37062 failing addresses are incorrect, correcting them in the file has no effect on
37063 pre-existing messages.
37064
37065 The original top-level address is remembered with each of the generated
37066 addresses, and is output in any log messages. However, any intermediate parent
37067 addresses are not recorded. This makes a difference to the log only if the
37068 &%all_parents%& selector is set, but for mailing lists there is normally only
37069 one level of expansion anyway.
37070
37071
37072
37073 .section "Closed mailing lists" "SECID243"
37074 .cindex "mailing lists" "closed"
37075 The examples so far have assumed open mailing lists, to which anybody may
37076 send mail. It is also possible to set up closed lists, where mail is accepted
37077 from specified senders only. This is done by making use of the generic
37078 &%senders%& option to restrict the router that handles the list.
37079
37080 The following example uses the same file as a list of recipients and as a list
37081 of permitted senders. It requires three routers:
37082 .code
37083 lists_request:
37084   driver = redirect
37085   domains = lists.example
37086   local_part_suffix = -request
37087   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37088   file = /usr/lists/${local_part_data}-request
37089   no_more
37090
37091 lists_post:
37092   driver = redirect
37093   domains = lists.example
37094   senders = ${if exists {/usr/lists/$local_part}\
37095              {lsearch;/usr/lists/$local_part}{*}}
37096   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37097   forbid_pipe
37098   forbid_file
37099   errors_to = ${quote_local_part:$local_part-request}@lists.example
37100   no_more
37101
37102 lists_closed:
37103   driver = redirect
37104   domains = lists.example
37105   allow_fail
37106   data = :fail: $local_part@lists.example is a closed mailing list
37107 .endd
37108 All three routers have the same &%domains%& setting, so for any other domains,
37109 they are all skipped. The first router runs only if the local part ends in
37110 &%-request%&. It handles messages to the list manager(s) by means of an open
37111 mailing list.
37112
37113 The second router runs only if the &%senders%& precondition is satisfied. It
37114 checks for the existence of a list that corresponds to the local part, and then
37115 checks that the sender is on the list by means of a linear search. It is
37116 necessary to check for the existence of the file before trying to search it,
37117 because otherwise Exim thinks there is a configuration error. If the file does
37118 not exist, the expansion of &%senders%& is *, which matches all senders. This
37119 means that the router runs, but because there is no list, declines, and
37120 &%no_more%& ensures that no further routers are run. The address fails with an
37121 &"unrouteable address"& error.
37122
37123 The third router runs only if the second router is skipped, which happens when
37124 a mailing list exists, but the sender is not on it. This router forcibly fails
37125 the address, giving a suitable error message.
37126
37127
37128
37129
37130 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37131 .cindex "VERP"
37132 .cindex "Variable Envelope Return Paths"
37133 .cindex "envelope from"
37134 .cindex "envelope sender"
37135 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37136 are a way of helping mailing list administrators discover which subscription
37137 address is the cause of a particular delivery failure. The idea is to encode
37138 the original recipient address in the outgoing envelope sender address, so that
37139 if the message is forwarded by another host and then subsequently bounces, the
37140 original recipient can be extracted from the recipient address of the bounce.
37141
37142 .oindex &%errors_to%&
37143 .oindex &%return_path%&
37144 Envelope sender addresses can be modified by Exim using two different
37145 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37146 list examples), or the &%return_path%& option on a transport. The second of
37147 these is effective only if the message is successfully delivered to another
37148 host; it is not used for errors detected on the local host (see the description
37149 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37150 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37151 .code
37152 verp_smtp:
37153   driver = smtp
37154   max_rcpt = 1
37155   return_path = \
37156     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37157       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37158 .endd
37159 This has the effect of rewriting the return path (envelope sender) on outgoing
37160 SMTP messages, if the local part of the original return path ends in
37161 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37162 local part and domain of the recipient into the return path. Suppose, for
37163 example, that a message whose return path has been set to
37164 &'somelist-request@your.dom.example'& is sent to
37165 &'subscriber@other.dom.example'&. In the transport, the return path is
37166 rewritten as
37167 .code
37168 somelist-request+subscriber=other.dom.example@your.dom.example
37169 .endd
37170 .vindex "&$local_part$&"
37171 For this to work, you must tell Exim to send multiple copies of messages that
37172 have more than one recipient, so that each copy has just one recipient. This is
37173 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37174 might be sent to several different recipients in the same domain, in which case
37175 &$local_part$& is not available in the transport, because it is not unique.
37176
37177 Unless your host is doing nothing but mailing list deliveries, you should
37178 probably use a separate transport for the VERP deliveries, so as not to use
37179 extra resources in making one-per-recipient copies for other deliveries. This
37180 can easily be done by expanding the &%transport%& option in the router:
37181 .code
37182 dnslookup:
37183   driver = dnslookup
37184   domains = ! +local_domains
37185   transport = \
37186     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37187       {verp_smtp}{remote_smtp}}
37188   no_more
37189 .endd
37190 If you want to change the return path using &%errors_to%& in a router instead
37191 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37192 routers that handle mailing list addresses. This will ensure that all delivery
37193 errors, including those detected on the local host, are sent to the VERP
37194 address.
37195
37196 On a host that does no local deliveries and has no manual routing, only the
37197 &(dnslookup)& router needs to be changed. A special transport is not needed for
37198 SMTP deliveries. Every mailing list recipient has its own return path value,
37199 and so Exim must hand them to the transport one at a time. Here is an example
37200 of a &(dnslookup)& router that implements VERP:
37201 .code
37202 verp_dnslookup:
37203   driver = dnslookup
37204   domains = ! +local_domains
37205   transport = remote_smtp
37206   errors_to = \
37207     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37208      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37209   no_more
37210 .endd
37211 Before you start sending out messages with VERPed return paths, you must also
37212 configure Exim to accept the bounce messages that come back to those paths.
37213 Typically this is done by setting a &%local_part_suffix%& option for a
37214 router, and using this to route the messages to wherever you want to handle
37215 them.
37216
37217 The overhead incurred in using VERP depends very much on the size of the
37218 message, the number of recipient addresses that resolve to the same remote
37219 host, and the speed of the connection over which the message is being sent. If
37220 a lot of addresses resolve to the same host and the connection is slow, sending
37221 a separate copy of the message for each address may take substantially longer
37222 than sending a single copy with many recipients (for which VERP cannot be
37223 used).
37224
37225
37226
37227
37228
37229
37230 .section "Virtual domains" "SECTvirtualdomains"
37231 .cindex "virtual domains"
37232 .cindex "domain" "virtual"
37233 The phrase &'virtual domain'& is unfortunately used with two rather different
37234 meanings:
37235
37236 .ilist
37237 A domain for which there are no real mailboxes; all valid local parts are
37238 aliases for other email addresses. Common examples are organizational
37239 top-level domains and &"vanity"& domains.
37240 .next
37241 One of a number of independent domains that are all handled by the same host,
37242 with mailboxes on that host, but where the mailbox owners do not necessarily
37243 have login accounts on that host.
37244 .endlist
37245
37246 The first usage is probably more common, and does seem more &"virtual"& than
37247 the second. This kind of domain can be handled in Exim with a straightforward
37248 aliasing router. One approach is to create a separate alias file for each
37249 virtual domain. Exim can test for the existence of the alias file to determine
37250 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37251 to a router of this form:
37252 .code
37253 virtual:
37254   driver = redirect
37255   domains = dsearch;/etc/mail/virtual
37256   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37257   no_more
37258 .endd
37259 The &%domains%& option specifies that the router is to be skipped, unless there
37260 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37261 domain that is being processed.
37262 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37263 being placed into the &$domain_data$& variable.
37264
37265 When the router runs, it looks up the local
37266 part in the file to find a new address (or list of addresses). The &%no_more%&
37267 setting ensures that if the lookup fails (leading to &%data%& being an empty
37268 string), Exim gives up on the address without trying any subsequent routers.
37269
37270 This one router can handle all the virtual domains because the alias filenames
37271 follow a fixed pattern. Permissions can be arranged so that appropriate people
37272 can edit the different alias files. A successful aliasing operation results in
37273 a new envelope recipient address, which is then routed from scratch.
37274
37275 The other kind of &"virtual"& domain can also be handled in a straightforward
37276 way. One approach is to create a file for each domain containing a list of
37277 valid local parts, and use it in a router like this:
37278 .code
37279 my_domains:
37280   driver = accept
37281   domains = dsearch;/etc/mail/domains
37282   local_parts = lsearch;/etc/mail/domains/$domain
37283   transport = my_mailboxes
37284 .endd
37285 The address is accepted if there is a file for the domain, and the local part
37286 can be found in the file. The &%domains%& option is used to check for the
37287 file's existence because &%domains%& is tested before the &%local_parts%&
37288 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37289 because that option is tested after &%local_parts%&. The transport is as
37290 follows:
37291 .code
37292 my_mailboxes:
37293   driver = appendfile
37294   file = /var/mail/$domain/$local_part_data
37295   user = mail
37296 .endd
37297 This uses a directory of mailboxes for each domain. The &%user%& setting is
37298 required, to specify which uid is to be used for writing to the mailboxes.
37299
37300 The configuration shown here is just one example of how you might support this
37301 requirement. There are many other ways this kind of configuration can be set
37302 up, for example, by using a database instead of separate files to hold all the
37303 information about the domains.
37304
37305
37306
37307 .section "Multiple user mailboxes" "SECTmulbox"
37308 .cindex "multiple mailboxes"
37309 .cindex "mailbox" "multiple"
37310 .cindex "local part" "prefix"
37311 .cindex "local part" "suffix"
37312 Heavy email users often want to operate with multiple mailboxes, into which
37313 incoming mail is automatically sorted. A popular way of handling this is to
37314 allow users to use multiple sender addresses, so that replies can easily be
37315 identified. Users are permitted to add prefixes or suffixes to their local
37316 parts for this purpose. The wildcard facility of the generic router options
37317 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37318 example, consider this router:
37319 .code
37320 userforward:
37321   driver = redirect
37322   check_local_user
37323   file = $home/.forward
37324   local_part_suffix = -*
37325   local_part_suffix_optional
37326   allow_filter
37327 .endd
37328 .vindex "&$local_part_suffix$&"
37329 It runs a user's &_.forward_& file for all local parts of the form
37330 &'username-*'&. Within the filter file the user can distinguish different
37331 cases by testing the variable &$local_part_suffix$&. For example:
37332 .code
37333 if $local_part_suffix contains -special then
37334 save /home/$local_part/Mail/special
37335 endif
37336 .endd
37337 If the filter file does not exist, or does not deal with such addresses, they
37338 fall through to subsequent routers, and, assuming no subsequent use of the
37339 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37340 control over which suffixes are valid.
37341
37342 Alternatively, a suffix can be used to trigger the use of a different
37343 &_.forward_& file &-- which is the way a similar facility is implemented in
37344 another MTA:
37345 .code
37346 userforward:
37347   driver = redirect
37348   check_local_user
37349   local_part_suffix = -*
37350   local_part_suffix_optional
37351   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37352   allow_filter
37353 .endd
37354 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37355 example, &_.forward-special_& is used. Once again, if the appropriate file
37356 does not exist, or does not deal with the address, it is passed on to
37357 subsequent routers, which could, if required, look for an unqualified
37358 &_.forward_& file to use as a default.
37359
37360
37361
37362 .section "Simplified vacation processing" "SECID244"
37363 .cindex "vacation processing"
37364 The traditional way of running the &'vacation'& program is for a user to set up
37365 a pipe command in a &_.forward_& file
37366 (see section &<<SECTspecitredli>>& for syntax details).
37367 This is prone to error by inexperienced users. There are two features of Exim
37368 that can be used to make this process simpler for users:
37369
37370 .ilist
37371 A local part prefix such as &"vacation-"& can be specified on a router which
37372 can cause the message to be delivered directly to the &'vacation'& program, or
37373 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37374 &_.forward_& file are then much simpler. For example:
37375 .code
37376 spqr, vacation-spqr
37377 .endd
37378 .next
37379 The &%require_files%& generic router option can be used to trigger a
37380 vacation delivery by checking for the existence of a certain file in the
37381 user's home directory. The &%unseen%& generic option should also be used, to
37382 ensure that the original delivery also proceeds. In this case, all the user has
37383 to do is to create a file called, say, &_.vacation_&, containing a vacation
37384 message.
37385 .endlist
37386
37387 Another advantage of both these methods is that they both work even when the
37388 use of arbitrary pipes by users is locked out.
37389
37390
37391
37392 .section "Taking copies of mail" "SECID245"
37393 .cindex "message" "copying every"
37394 Some installations have policies that require archive copies of all messages to
37395 be made. A single copy of each message can easily be taken by an appropriate
37396 command in a system filter, which could, for example, use a different file for
37397 each day's messages.
37398
37399 There is also a shadow transport mechanism that can be used to take copies of
37400 messages that are successfully delivered by local transports, one copy per
37401 delivery. This could be used, &'inter alia'&, to implement automatic
37402 notification of delivery by sites that insist on doing such things.
37403
37404
37405
37406 .section "Intermittently connected hosts" "SECID246"
37407 .cindex "intermittently connected hosts"
37408 It has become quite common (because it is cheaper) for hosts to connect to the
37409 Internet periodically rather than remain connected all the time. The normal
37410 arrangement is that mail for such hosts accumulates on a system that is
37411 permanently connected.
37412
37413 Exim was designed for use on permanently connected hosts, and so it is not
37414 particularly well-suited to use in an intermittently connected environment.
37415 Nevertheless there are some features that can be used.
37416
37417
37418 .section "Exim on the upstream server host" "SECID247"
37419 It is tempting to arrange for incoming mail for the intermittently connected
37420 host to remain in Exim's queue until the client connects. However, this
37421 approach does not scale very well. Two different kinds of waiting message are
37422 being mixed up in the same queue &-- those that cannot be delivered because of
37423 some temporary problem, and those that are waiting for their destination host
37424 to connect. This makes it hard to manage the queue, as well as wasting
37425 resources, because each queue runner scans the entire queue.
37426
37427 A better approach is to separate off those messages that are waiting for an
37428 intermittently connected host. This can be done by delivering these messages
37429 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37430 format, from where they are transmitted by other software when their
37431 destination connects. This makes it easy to collect all the mail for one host
37432 in a single directory, and to apply local timeout rules on a per-message basis
37433 if required.
37434
37435 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37436 you are doing this, you should configure Exim with a long retry period for the
37437 intermittent host. For example:
37438 .code
37439 cheshire.wonderland.fict.example    *   F,5d,24h
37440 .endd
37441 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37442 which messages it has queued up for that host. Once the intermittent host comes
37443 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37444 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37445 causes all the queued up messages to be delivered, often down a single SMTP
37446 connection. While the host remains connected, any new messages get delivered
37447 immediately.
37448
37449 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37450 issued with a different IP address each time it connects, Exim's retry
37451 mechanisms on the holding host get confused, because the IP address is normally
37452 used as part of the key string for holding retry information. This can be
37453 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37454 Since this has disadvantages for permanently connected hosts, it is best to
37455 arrange a separate transport for the intermittently connected ones.
37456
37457
37458
37459 .section "Exim on the intermittently connected client host" "SECID248"
37460 The value of &%smtp_accept_queue_per_connection%& should probably be
37461 increased, or even set to zero (that is, disabled) on the intermittently
37462 connected host, so that all incoming messages down a single connection get
37463 delivered immediately.
37464
37465 .cindex "SMTP" "passed connection"
37466 .cindex "SMTP" "multiple deliveries"
37467 .cindex "multiple SMTP deliveries"
37468 .cindex "first pass routing"
37469 Mail waiting to be sent from an intermittently connected host will probably
37470 not have been routed, because without a connection DNS lookups are not
37471 possible. This means that if a normal queue run is done at connection time,
37472 each message is likely to be sent in a separate SMTP session. This can be
37473 avoided by starting the queue run with a command line option beginning with
37474 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37475 first pass, routing is done but no deliveries take place. The second pass is a
37476 normal queue run; since all the messages have been previously routed, those
37477 destined for the same host are likely to get sent as multiple deliveries in a
37478 single SMTP connection.
37479
37480
37481
37482 . ////////////////////////////////////////////////////////////////////////////
37483 . ////////////////////////////////////////////////////////////////////////////
37484
37485 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37486          "Exim as a non-queueing client"
37487 .cindex "client, non-queueing"
37488 .cindex "smart host" "suppressing queueing"
37489 On a personal computer, it is a common requirement for all
37490 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37491 configured to operate that way, for all the popular operating systems.
37492 However, there are some MUAs for Unix-like systems that cannot be so
37493 configured: they submit messages using the command line interface of
37494 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37495 messages this way.
37496
37497 If the personal computer runs continuously, there is no problem, because it can
37498 run a conventional MTA that handles delivery to the smart host, and deal with
37499 any delays via its queueing mechanism. However, if the computer does not run
37500 continuously or runs different operating systems at different times, queueing
37501 email is not desirable.
37502
37503 There is therefore a requirement for something that can provide the
37504 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37505 any queueing or retrying facilities. Furthermore, the delivery to the smart
37506 host should be synchronous, so that if it fails, the sending MUA is immediately
37507 informed. In other words, we want something that extends an MUA that submits
37508 to a local MTA via the command line so that it behaves like one that submits
37509 to a remote smart host using TCP/SMTP.
37510
37511 There are a number of applications (for example, there is one called &'ssmtp'&)
37512 that do this job. However, people have found them to be lacking in various
37513 ways. For instance, you might want to allow aliasing and forwarding to be done
37514 before sending a message to the smart host.
37515
37516 Exim already had the necessary infrastructure for doing this job. Just a few
37517 tweaks were needed to make it behave as required, though it is somewhat of an
37518 overkill to use a fully-featured MTA for this purpose.
37519
37520 .oindex "&%mua_wrapper%&"
37521 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37522 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37523 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37524 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37525 compatible router and transport configuration. Typically there will be just one
37526 router and one transport, sending everything to a smart host.
37527
37528 When run in MUA wrapping mode, the behaviour of Exim changes in the
37529 following ways:
37530
37531 .ilist
37532 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37533 In other words, the only way to submit messages is via the command line.
37534 .next
37535 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37536 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37537 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37538 does not finish until the delivery attempt is complete. If the delivery is
37539 successful, a zero return code is given.
37540 .next
37541 Address redirection is permitted, but the final routing for all addresses must
37542 be to the same remote transport, and to the same list of hosts. Furthermore,
37543 the return address (envelope sender) must be the same for all recipients, as
37544 must any added or deleted header lines. In other words, it must be possible to
37545 deliver the message in a single SMTP transaction, however many recipients there
37546 are.
37547 .next
37548 If these conditions are not met, or if routing any address results in a
37549 failure or defer status, or if Exim is unable to deliver all the recipients
37550 successfully to one of the smart hosts, delivery of the entire message fails.
37551 .next
37552 Because no queueing is allowed, all failures are treated as permanent; there
37553 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37554 smart host. Furthermore, because only a single yes/no response can be given to
37555 the caller, it is not possible to deliver to some recipients and not others. If
37556 there is an error (temporary or permanent) for any recipient, all are failed.
37557 .next
37558 If more than one smart host is listed, Exim will try another host after a
37559 connection failure or a timeout, in the normal way. However, if this kind of
37560 failure happens for all the hosts, the delivery fails.
37561 .next
37562 When delivery fails, an error message is written to the standard error stream
37563 (as well as to Exim's log), and Exim exits to the caller with a return code
37564 value 1. The message is expunged from Exim's spool files. No bounce messages
37565 are ever generated.
37566 .next
37567 No retry data is maintained, and any retry rules are ignored.
37568 .next
37569 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37570 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37571 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37572 .endlist
37573
37574 The overall effect is that Exim makes a single synchronous attempt to deliver
37575 the message, failing if there is any kind of problem. Because no local
37576 deliveries are done and no daemon can be run, Exim does not need root
37577 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37578 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37579 the advantages and disadvantages of running without root privilege.
37580
37581
37582
37583
37584 . ////////////////////////////////////////////////////////////////////////////
37585 . ////////////////////////////////////////////////////////////////////////////
37586
37587 .chapter "Log files" "CHAPlog"
37588 .scindex IIDloggen "log" "general description"
37589 .cindex "log" "types of"
37590 Exim writes three different logs, referred to as the main log, the reject log,
37591 and the panic log:
37592
37593 .ilist
37594 .cindex "main log"
37595 The main log records the arrival of each message and each delivery in a single
37596 line in each case. The format is as compact as possible, in an attempt to keep
37597 down the size of log files. Two-character flag sequences make it easy to pick
37598 out these lines. A number of other events are recorded in the main log. Some of
37599 them are optional, in which case the &%log_selector%& option controls whether
37600 they are included or not. A Perl script called &'eximstats'&, which does simple
37601 analysis of main log files, is provided in the Exim distribution (see section
37602 &<<SECTmailstat>>&).
37603 .next
37604 .cindex "reject log"
37605 The reject log records information from messages that are rejected as a result
37606 of a configuration option (that is, for policy reasons).
37607 The first line of each rejection is a copy of the line that is also written to
37608 the main log. Then, if the message's header has been read at the time the log
37609 is written, its contents are written to this log. Only the original header
37610 lines are available; header lines added by ACLs are not logged. You can use the
37611 reject log to check that your policy controls are working correctly; on a busy
37612 host this may be easier than scanning the main log for rejection messages. You
37613 can suppress the writing of the reject log by setting &%write_rejectlog%&
37614 false.
37615 .next
37616 .cindex "panic log"
37617 .cindex "system log"
37618 When certain serious errors occur, Exim writes entries to its panic log. If the
37619 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37620 are usually written to the main log as well, but can get lost amid the mass of
37621 other entries. The panic log should be empty under normal circumstances. It is
37622 therefore a good idea to check it (or to have a &'cron'& script check it)
37623 regularly, in order to become aware of any problems. When Exim cannot open its
37624 panic log, it tries as a last resort to write to the system log (syslog). This
37625 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37626 message itself is written at priority LOG_CRIT.
37627 .endlist
37628
37629 Every log line starts with a timestamp, in the format shown in the following
37630 example. Note that many of the examples shown in this chapter are line-wrapped.
37631 In the log file, this would be all on one line:
37632 .code
37633 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37634   by QUIT
37635 .endd
37636 By default, the timestamps are in the local timezone. There are two
37637 ways of changing this:
37638
37639 .ilist
37640 You can set the &%timezone%& option to a different time zone; in particular, if
37641 you set
37642 .code
37643 timezone = UTC
37644 .endd
37645 the timestamps will be in UTC (aka GMT).
37646 .next
37647 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37648 example:
37649 .code
37650 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37651 .endd
37652 .endlist
37653
37654 .cindex "log" "process ids in"
37655 .cindex "pid (process id)" "in log lines"
37656 Exim does not include its process id in log lines by default, but you can
37657 request that it does so by specifying the &`pid`& log selector (see section
37658 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37659 brackets, immediately after the time and date.
37660
37661
37662
37663
37664 .section "Where the logs are written" "SECTwhelogwri"
37665 .cindex "log" "destination"
37666 .cindex "log" "to file"
37667 .cindex "log" "to syslog"
37668 .cindex "syslog"
37669 The logs may be written to local files, or to syslog, or both. However, it
37670 should be noted that many syslog implementations use UDP as a transport, and
37671 are therefore unreliable in the sense that messages are not guaranteed to
37672 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37673 It has also been reported that on large log files (tens of megabytes) you may
37674 need to tweak syslog to prevent it syncing the file with each write &-- on
37675 Linux this has been seen to make syslog take 90% plus of CPU time.
37676
37677 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37678 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37679 configuration. This latter string is expanded, so it can contain, for example,
37680 references to the host name:
37681 .code
37682 log_file_path = /var/log/$primary_hostname/exim_%slog
37683 .endd
37684 It is generally advisable, however, to set the string in &_Local/Makefile_&
37685 rather than at runtime, because then the setting is available right from the
37686 start of Exim's execution. Otherwise, if there's something it wants to log
37687 before it has read the configuration file (for example, an error in the
37688 configuration file) it will not use the path you want, and may not be able to
37689 log at all.
37690
37691 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37692 list, currently limited to at most two items. This is one option where the
37693 facility for changing a list separator may not be used. The list must always be
37694 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37695 otherwise the item must either be an absolute path, containing &`%s`& at the
37696 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37697 implying the use of a default path.
37698
37699 When Exim encounters an empty item in the list, it searches the list defined by
37700 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37701 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37702 mean &"use the path specified at build time"&. It no such item exists, log
37703 files are written in the &_log_& subdirectory of the spool directory. This is
37704 equivalent to the setting:
37705 .code
37706 log_file_path = $spool_directory/log/%slog
37707 .endd
37708 If you do not specify anything at build time or runtime,
37709 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37710 that is where the logs are written.
37711
37712 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37713 are in use &-- see section &<<SECTdatlogfil>>& below.
37714
37715 Here are some examples of possible settings:
37716 .display
37717 &`LOG_FILE_PATH=syslog                    `& syslog only
37718 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37719 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37720 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37721 .endd
37722 If there are more than two paths in the list, the first is used and a panic
37723 error is logged.
37724
37725
37726
37727 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37728 .cindex "log" "cycling local files"
37729 .cindex "cycling logs"
37730 .cindex "&'exicyclog'&"
37731 .cindex "log" "local files; writing to"
37732 Some operating systems provide centralized and standardized methods for cycling
37733 log files. For those that do not, a utility script called &'exicyclog'& is
37734 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37735 main and reject logs each time it is called. The maximum number of old logs to
37736 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37737
37738 An Exim delivery process opens the main log when it first needs to write to it,
37739 and it keeps the file open in case subsequent entries are required &-- for
37740 example, if a number of different deliveries are being done for the same
37741 message. However, remote SMTP deliveries can take a long time, and this means
37742 that the file may be kept open long after it is renamed if &'exicyclog'& or
37743 something similar is being used to rename log files on a regular basis. To
37744 ensure that a switch of log files is noticed as soon as possible, Exim calls
37745 &[stat()]& on the main log's name before reusing an open file, and if the file
37746 does not exist, or its inode has changed, the old file is closed and Exim
37747 tries to open the main log from scratch. Thus, an old log file may remain open
37748 for quite some time, but no Exim processes should write to it once it has been
37749 renamed.
37750
37751
37752
37753 .section "Datestamped log files" "SECTdatlogfil"
37754 .cindex "log" "datestamped files"
37755 Instead of cycling the main and reject log files by renaming them
37756 periodically, some sites like to use files whose names contain a datestamp,
37757 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37758 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37759 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37760 point where the datestamp is required. For example:
37761 .code
37762 log_file_path = /var/spool/exim/log/%slog-%D
37763 log_file_path = /var/log/exim-%s-%D.log
37764 log_file_path = /var/spool/exim/log/%D-%slog
37765 log_file_path = /var/log/exim/%s.%M
37766 .endd
37767 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37768 examples of names generated by the above examples:
37769 .code
37770 /var/spool/exim/log/mainlog-20021225
37771 /var/log/exim-reject-20021225.log
37772 /var/spool/exim/log/20021225-mainlog
37773 /var/log/exim/main.200212
37774 .endd
37775 When this form of log file is specified, Exim automatically switches to new
37776 files at midnight. It does not make any attempt to compress old logs; you
37777 will need to write your own script if you require this. You should not
37778 run &'exicyclog'& with this form of logging.
37779
37780 The location of the panic log is also determined by &%log_file_path%&, but it
37781 is not datestamped, because rotation of the panic log does not make sense.
37782 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37783 the string. In addition, if it immediately follows a slash, a following
37784 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37785 character is removed. Thus, the four examples above would give these panic
37786 log names:
37787 .code
37788 /var/spool/exim/log/paniclog
37789 /var/log/exim-panic.log
37790 /var/spool/exim/log/paniclog
37791 /var/log/exim/panic
37792 .endd
37793
37794
37795 .section "Logging to syslog" "SECID249"
37796 .cindex "log" "syslog; writing to"
37797 The use of syslog does not change what Exim logs or the format of its messages,
37798 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37799 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37800 that, the same strings are written to syslog as to log files. The syslog
37801 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37802 by default, but you can change these by setting the &%syslog_facility%& and
37803 &%syslog_processname%& options, respectively. If Exim was compiled with
37804 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37805 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37806 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37807 the time and host name to each line.
37808 The three log streams are mapped onto syslog priorities as follows:
37809
37810 .ilist
37811 &'mainlog'& is mapped to LOG_INFO
37812 .next
37813 &'rejectlog'& is mapped to LOG_NOTICE
37814 .next
37815 &'paniclog'& is mapped to LOG_ALERT
37816 .endlist
37817
37818 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37819 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37820 these are routed by syslog to the same place. You can suppress this duplication
37821 by setting &%syslog_duplication%& false.
37822
37823 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37824 entries contain multiple lines when headers are included. To cope with both
37825 these cases, entries written to syslog are split into separate &[syslog()]&
37826 calls at each internal newline, and also after a maximum of
37827 870 data characters. (This allows for a total syslog line length of 1024, when
37828 additions such as timestamps are added.) If you are running a syslog
37829 replacement that can handle lines longer than the 1024 characters allowed by
37830 RFC 3164, you should set
37831 .code
37832 SYSLOG_LONG_LINES=yes
37833 .endd
37834 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37835 lines, but it still splits at internal newlines in &'reject'& log entries.
37836
37837 To make it easy to re-assemble split lines later, each component of a split
37838 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37839 where <&'n'&> is the component number and <&'m'&> is the total number of
37840 components in the entry. The / delimiter is used when the line was split
37841 because it was too long; if it was split because of an internal newline, the \
37842 delimiter is used. For example, supposing the length limit to be 50 instead of
37843 870, the following would be the result of a typical rejection message to
37844 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37845 name, and pid as added by syslog:
37846 .code
37847 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37848 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37849 [3/5]  when scanning for sender: missing or malformed lo
37850 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37851 [5/5] mple>)
37852 .endd
37853 The same error might cause the following lines to be written to &"rejectlog"&
37854 (LOG_NOTICE):
37855 .code
37856 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37857 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37858 [3/18] er when scanning for sender: missing or malformed
37859 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37860 [5\18] .example>)
37861 [6\18] Recipients: ph10@some.domain.cam.example
37862 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37863 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37864 [9\18]        id 16RdAL-0006pc-00
37865 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37866 [11\18] 09:43 +0100
37867 [12\18] F From: <>
37868 [13\18]   Subject: this is a test header
37869 [18\18]   X-something: this is another header
37870 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37871 [16\18] le>
37872 [17\18] B Bcc:
37873 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37874 .endd
37875 Log lines that are neither too long nor contain newlines are written to syslog
37876 without modification.
37877
37878 If only syslog is being used, the Exim monitor is unable to provide a log tail
37879 display, unless syslog is routing &'mainlog'& to a file on the local host and
37880 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37881 where it is.
37882
37883
37884
37885 .section "Log line flags" "SECID250"
37886 One line is written to the main log for each message received, and for each
37887 successful, unsuccessful, and delayed delivery. These lines can readily be
37888 picked out by the distinctive two-character flags that immediately follow the
37889 timestamp. The flags are:
37890 .display
37891 &`<=`&     message arrival
37892 &`(=`&     message fakereject
37893 &`=>`&     normal message delivery
37894 &`->`&     additional address in same delivery
37895 &`>>`&     cutthrough message delivery
37896 &`*>`&     delivery suppressed by &%-N%&
37897 &`**`&     delivery failed; address bounced
37898 &`==`&     delivery deferred; temporary problem
37899 .endd
37900
37901
37902 .section "Logging message reception" "SECID251"
37903 .cindex "log" "reception line"
37904 The format of the single-line entry in the main log that is written for every
37905 message received is shown in the basic example below, which is split over
37906 several lines in order to fit it on the page:
37907 .code
37908 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37909   H=mailer.fict.example [192.168.123.123] U=exim
37910   P=smtp S=5678 id=<incoming message id>
37911 .endd
37912 The address immediately following &"<="& is the envelope sender address. A
37913 bounce message is shown with the sender address &"<>"&, and if it is locally
37914 generated, this is followed by an item of the form
37915 .code
37916 R=<message id>
37917 .endd
37918 which is a reference to the message that caused the bounce to be sent.
37919
37920 .cindex "HELO"
37921 .cindex "EHLO"
37922 For messages from other hosts, the H and U fields identify the remote host and
37923 record the RFC 1413 identity of the user that sent the message, if one was
37924 received. The number given in square brackets is the IP address of the sending
37925 host. If there is a single, unparenthesized  host name in the H field, as
37926 above, it has been verified to correspond to the IP address (see the
37927 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37928 by the remote host in the SMTP HELO or EHLO command, and has not been
37929 verified. If verification yields a different name to that given for HELO or
37930 EHLO, the verified name appears first, followed by the HELO or EHLO
37931 name in parentheses.
37932
37933 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37934 without brackets, in the HELO or EHLO command, leading to entries in
37935 the log containing text like these examples:
37936 .code
37937 H=(10.21.32.43) [192.168.8.34]
37938 H=([10.21.32.43]) [192.168.8.34]
37939 .endd
37940 This can be confusing. Only the final address in square brackets can be relied
37941 on.
37942
37943 For locally generated messages (that is, messages not received over TCP/IP),
37944 the H field is omitted, and the U field contains the login name of the caller
37945 of Exim.
37946
37947 .cindex "authentication" "logging"
37948 .cindex "AUTH" "logging"
37949 For all messages, the P field specifies the protocol used to receive the
37950 message. This is the value that is stored in &$received_protocol$&. In the case
37951 of incoming SMTP messages, the value indicates whether or not any SMTP
37952 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37953 session was encrypted, there is an additional X field that records the cipher
37954 suite that was used.
37955
37956 .cindex log protocol
37957 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37958 hosts that have authenticated themselves using the SMTP AUTH command. The first
37959 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37960 there is an additional item A= followed by the name of the authenticator that
37961 was used. If an authenticated identification was set up by the authenticator's
37962 &%server_set_id%& option, this is logged too, separated by a colon from the
37963 authenticator name.
37964
37965 .cindex "size" "of message"
37966 The id field records the existing message id, if present. The size of the
37967 received message is given by the S field. When the message is delivered,
37968 headers may be removed or added, so that the size of delivered copies of the
37969 message may not correspond with this value (and indeed may be different to each
37970 other).
37971
37972 The &%log_selector%& option can be used to request the logging of additional
37973 data when a message is received. See section &<<SECTlogselector>>& below.
37974
37975
37976
37977 .section "Logging deliveries" "SECID252"
37978 .cindex "log" "delivery line"
37979 The format of the single-line entry in the main log that is written for every
37980 delivery is shown in one of the examples below, for local and remote
37981 deliveries, respectively. Each example has been split into multiple lines in order
37982 to fit it on the page:
37983 .code
37984 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37985   <marv@hitch.fict.example> R=localuser T=local_delivery
37986 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37987   monk@holistic.fict.example R=dnslookup T=remote_smtp
37988   H=holistic.fict.example [192.168.234.234]
37989 .endd
37990 For ordinary local deliveries, the original address is given in angle brackets
37991 after the final delivery address, which might be a pipe or a file. If
37992 intermediate address(es) exist between the original and the final address, the
37993 last of these is given in parentheses after the final address. The R and T
37994 fields record the router and transport that were used to process the address.
37995
37996 If SMTP AUTH was used for the delivery there is an additional item A=
37997 followed by the name of the authenticator that was used.
37998 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37999 option, this is logged too, separated by a colon from the authenticator name.
38000
38001 If a shadow transport was run after a successful local delivery, the log line
38002 for the successful delivery has an item added on the end, of the form
38003 .display
38004 &`ST=<`&&'shadow transport name'&&`>`&
38005 .endd
38006 If the shadow transport did not succeed, the error message is put in
38007 parentheses afterwards.
38008
38009 .cindex "asterisk" "after IP address"
38010 When more than one address is included in a single delivery (for example, two
38011 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38012 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38013 down a single SMTP connection, an asterisk follows the IP address in the log
38014 lines for the second and subsequent messages.
38015 When two or more messages are delivered down a single TLS connection, the
38016 DNS and some TLS-related information logged for the first message delivered
38017 will not be present in the log lines for the second and subsequent messages.
38018 TLS cipher information is still available.
38019
38020 .cindex "delivery" "cutthrough; logging"
38021 .cindex "cutthrough" "logging"
38022 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38023 line precedes the reception line, since cutthrough waits for a possible
38024 rejection from the destination in case it can reject the sourced item.
38025
38026 The generation of a reply message by a filter file gets logged as a
38027 &"delivery"& to the addressee, preceded by &">"&.
38028
38029 The &%log_selector%& option can be used to request the logging of additional
38030 data when a message is delivered. See section &<<SECTlogselector>>& below.
38031
38032
38033 .section "Discarded deliveries" "SECID253"
38034 .cindex "discarded messages"
38035 .cindex "message" "discarded"
38036 .cindex "delivery" "discarded; logging"
38037 When a message is discarded as a result of the command &"seen finish"& being
38038 obeyed in a filter file which generates no deliveries, a log entry of the form
38039 .code
38040 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38041   <low.club@bridge.example> R=userforward
38042 .endd
38043 is written, to record why no deliveries are logged. When a message is discarded
38044 because it is aliased to &":blackhole:"& the log line is like this:
38045 .code
38046 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38047   <hole@nowhere.example> R=blackhole_router
38048 .endd
38049
38050
38051 .section "Deferred deliveries" "SECID254"
38052 When a delivery is deferred, a line of the following form is logged:
38053 .code
38054 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38055   R=dnslookup T=smtp defer (146): Connection refused
38056 .endd
38057 In the case of remote deliveries, the error is the one that was given for the
38058 last IP address that was tried. Details of individual SMTP failures are also
38059 written to the log, so the above line would be preceded by something like
38060 .code
38061 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38062   mail1.endrest.example [192.168.239.239]: Connection refused
38063 .endd
38064 When a deferred address is skipped because its retry time has not been reached,
38065 a message is written to the log, but this can be suppressed by setting an
38066 appropriate value in &%log_selector%&.
38067
38068
38069
38070 .section "Delivery failures" "SECID255"
38071 .cindex "delivery" "failure; logging"
38072 If a delivery fails because an address cannot be routed, a line of the
38073 following form is logged:
38074 .code
38075 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38076   <jim@trek99.example>: unknown mail domain
38077 .endd
38078 If a delivery fails at transport time, the router and transport are shown, and
38079 the response from the remote host is included, as in this example:
38080 .code
38081 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38082   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38083   after pipelined RCPT TO:<ace400@pb.example>: host
38084   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38085   <ace400@pb.example>...Addressee unknown
38086 .endd
38087 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38088 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38089 disabling PIPELINING. The log lines for all forms of delivery failure are
38090 flagged with &`**`&.
38091
38092
38093
38094 .section "Fake deliveries" "SECID256"
38095 .cindex "delivery" "fake; logging"
38096 If a delivery does not actually take place because the &%-N%& option has been
38097 used to suppress it, a normal delivery line is written to the log, except that
38098 &"=>"& is replaced by &"*>"&.
38099
38100
38101
38102 .section "Completion" "SECID257"
38103 A line of the form
38104 .code
38105 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38106 .endd
38107 is written to the main log when a message is about to be removed from the spool
38108 at the end of its processing.
38109
38110
38111
38112
38113 .section "Summary of Fields in Log Lines" "SECID258"
38114 .cindex "log" "summary of fields"
38115 A summary of the field identifiers that are used in log lines is shown in
38116 the following table:
38117 .display
38118 &`A   `&        authenticator name (and optional id and sender)
38119 &`C   `&        SMTP confirmation on delivery
38120 &`    `&        command list for &"no mail in SMTP session"&
38121 &`CV  `&        certificate verification status
38122 &`D   `&        duration of &"no mail in SMTP session"&
38123 &`DKIM`&        domain verified in incoming message
38124 &`DN  `&        distinguished name from peer certificate
38125 &`DS  `&        DNSSEC secured lookups
38126 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38127 &`F   `&        sender address (on delivery lines)
38128 &`H   `&        host name and IP address
38129 &`I   `&        local interface used
38130 &`id  `&        message id (from header) for incoming message
38131 &`K   `&        CHUNKING extension used
38132 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38133 &`M8S `&        8BITMIME status for incoming message
38134 &`P   `&        on &`<=`& lines: protocol used
38135 &`    `&        on &`=>`& and &`**`& lines: return path
38136 &`PRDR`&        PRDR extension used
38137 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38138 &`Q   `&        alternate queue name
38139 &`QT  `&        on &`=>`& lines: time spent on queue so far
38140 &`    `&        on &"Completed"& lines: time spent on queue
38141 &`R   `&        on &`<=`& lines: reference for local bounce
38142 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38143 &`RT  `&        on &`<=`& lines: time taken for reception
38144 &`S   `&        size of message in bytes
38145 &`SNI `&        server name indication from TLS client hello
38146 &`ST  `&        shadow transport name
38147 &`T   `&        on &`<=`& lines: message subject (topic)
38148 &`TFO `&        connection took advantage of TCP Fast Open
38149 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38150 &`U   `&        local user or RFC 1413 identity
38151 &`X   `&        TLS cipher suite
38152 .endd
38153
38154
38155 .section "Other log entries" "SECID259"
38156 Various other types of log entry are written from time to time. Most should be
38157 self-explanatory. Among the more common are:
38158
38159 .ilist
38160 .cindex "retry" "time not reached"
38161 &'retry time not reached'&&~&~An address previously suffered a temporary error
38162 during routing or local delivery, and the time to retry has not yet arrived.
38163 This message is not written to an individual message log file unless it happens
38164 during the first delivery attempt.
38165 .next
38166 &'retry time not reached for any host'&&~&~An address previously suffered
38167 temporary errors during remote delivery, and the retry time has not yet arrived
38168 for any of the hosts to which it is routed.
38169 .next
38170 .cindex "spool directory" "file locked"
38171 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38172 some other Exim process is already working on the message. This can be quite
38173 common if queue running processes are started at frequent intervals. The
38174 &'exiwhat'& utility script can be used to find out what Exim processes are
38175 doing.
38176 .next
38177 .cindex "error" "ignored"
38178 &'error ignored'&&~&~There are several circumstances that give rise to this
38179 message:
38180 .olist
38181 Exim failed to deliver a bounce message whose age was greater than
38182 &%ignore_bounce_errors_after%&. The bounce was discarded.
38183 .next
38184 A filter file set up a delivery using the &"noerror"& option, and the delivery
38185 failed. The delivery was discarded.
38186 .next
38187 A delivery set up by a router configured with
38188 . ==== As this is a nested list, any displays it contains must be indented
38189 . ==== as otherwise they are too far to the left.
38190 .code
38191     errors_to = <>
38192 .endd
38193 failed. The delivery was discarded.
38194 .endlist olist
38195 .next
38196 .cindex DKIM "log line"
38197 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38198 logging and the message has a DKIM signature header.
38199 .endlist ilist
38200
38201
38202
38203
38204
38205 .section "Reducing or increasing what is logged" "SECTlogselector"
38206 .cindex "log" "selectors"
38207 By setting the &%log_selector%& global option, you can disable some of Exim's
38208 default logging, or you can request additional logging. The value of
38209 &%log_selector%& is made up of names preceded by plus or minus characters. For
38210 example:
38211 .code
38212 log_selector = +arguments -retry_defer
38213 .endd
38214 The list of optional log items is in the following table, with the default
38215 selection marked by asterisks:
38216 .display
38217 &` 8bitmime                   `&  received 8BITMIME status
38218 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
38219 &` address_rewrite            `&  address rewriting
38220 &` all_parents                `&  all parents in => lines
38221 &` arguments                  `&  command line arguments
38222 &`*connection_reject          `&  connection rejections
38223 &`*delay_delivery             `&  immediate delivery delayed
38224 &` deliver_time               `&  time taken to attempt delivery
38225 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
38226 &`*dkim                       `&  DKIM verified domain on <= lines
38227 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
38228 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
38229 &` dnssec                     `&  DNSSEC secured lookups
38230 &`*etrn                       `&  ETRN commands
38231 &`*host_lookup_failed         `&  as it says
38232 &` ident_timeout              `&  timeout for ident connection
38233 &` incoming_interface         `&  local interface on <= and => lines
38234 &` incoming_port              `&  remote port on <= lines
38235 &`*lost_incoming_connection   `&  as it says (includes timeouts)
38236 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38237 &`*msg_id                     `&  on <= lines, Message-ID: header value
38238 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38239 &` outgoing_interface         `&  local interface on => lines
38240 &` outgoing_port              `&  add remote port to => lines
38241 &`*queue_run                  `&  start and end queue runs
38242 &` queue_time                 `&  time on queue for one recipient
38243 &` queue_time_overall         `&  time on queue for whole message
38244 &` pid                        `&  Exim process id
38245 &` pipelining                 `&  PIPELINING use, on <= and => lines
38246 &` proxy                      `&  proxy address on <= and => lines
38247 &` receive_time               `&  time taken to receive message
38248 &` received_recipients        `&  recipients on <= lines
38249 &` received_sender            `&  sender on <= lines
38250 &`*rejected_header            `&  header contents on reject log
38251 &`*retry_defer                `&  &"retry time not reached"&
38252 &` return_path_on_delivery    `&  put return path on => and ** lines
38253 &` sender_on_delivery         `&  add sender to => lines
38254 &`*sender_verify_fail         `&  sender verification failures
38255 &`*size_reject                `&  rejection because too big
38256 &`*skip_delivery              `&  delivery skipped in a queue run
38257 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38258 &` smtp_connection            `&  incoming SMTP connections
38259 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38260 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38261 &` smtp_no_mail               `&  session with no MAIL commands
38262 &` smtp_protocol_error        `&  SMTP protocol errors
38263 &` smtp_syntax_error          `&  SMTP syntax errors
38264 &` subject                    `&  contents of &'Subject:'& on <= lines
38265 &`*tls_certificate_verified   `&  certificate verification status
38266 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38267 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38268 &` tls_resumption             `&  append * to cipher field
38269 &` tls_sni                    `&  TLS SNI on <= lines
38270 &` unknown_in_list            `&  DNS lookup failed in list match
38271
38272 &` all                        `&  all of the above
38273 .endd
38274 See also the &%slow_lookup_log%& main configuration option,
38275 section &<<SECID99>>&
38276
38277 More details on each of these items follows:
38278
38279 .ilist
38280 .cindex "8BITMIME"
38281 .cindex "log" "8BITMIME"
38282 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38283 which may help in tracking down interoperability issues with ancient MTAs
38284 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38285 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38286 &`7BIT`& and &`8BITMIME`& respectively.
38287 .next
38288 .cindex "&%warn%& ACL verb" "log when skipping"
38289 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38290 its conditions cannot be evaluated, a log line to this effect is written if
38291 this log selector is set.
38292 .next
38293 .cindex "log" "rewriting"
38294 .cindex "rewriting" "logging"
38295 &%address_rewrite%&: This applies both to global rewrites and per-transport
38296 rewrites, but not to rewrites in filters run as an unprivileged user (because
38297 such users cannot access the log).
38298 .next
38299 .cindex "log" "full parentage"
38300 &%all_parents%&: Normally only the original and final addresses are logged on
38301 delivery lines; with this selector, intermediate parents are given in
38302 parentheses between them.
38303 .next
38304 .cindex "log" "Exim arguments"
38305 .cindex "Exim arguments, logging"
38306 &%arguments%&: This causes Exim to write the arguments with which it was called
38307 to the main log, preceded by the current working directory. This is a debugging
38308 feature, added to make it easier to find out how certain MUAs call
38309 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38310 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38311 that are empty or that contain white space are quoted. Non-printing characters
38312 are shown as escape sequences. This facility cannot log unrecognized arguments,
38313 because the arguments are checked before the configuration file is read. The
38314 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38315 between the caller and Exim.
38316 .next
38317 .cindex "log" "connection rejections"
38318 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38319 connection is rejected, for whatever reason.
38320 .next
38321 .cindex "log" "delayed delivery"
38322 .cindex "delayed delivery, logging"
38323 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38324 started for an incoming message because the load is too high or too many
38325 messages were received on one connection. Logging does not occur if no delivery
38326 process is started because &%queue_only%& is set or &%-odq%& was used.
38327 .next
38328 .cindex "log" "delivery duration"
38329 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38330 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38331 If millisecond logging is enabled, short times will be shown with greater
38332 precision, eg. &`DT=0.304s`&.
38333 .next
38334 .cindex "log" "message size on delivery"
38335 .cindex "size" "of message"
38336 &%delivery_size%&: For each delivery, the size of message delivered is added to
38337 the &"=>"& line, tagged with S=.
38338 .next
38339 .cindex log "DKIM verification"
38340 .cindex DKIM "verification logging"
38341 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38342 verifies successfully a tag of DKIM is added, with one of the verified domains.
38343 .next
38344 .cindex log "DKIM verification"
38345 .cindex DKIM "verification logging"
38346 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38347 .next
38348 .cindex "log" "dnslist defer"
38349 .cindex "DNS list" "logging defer"
38350 .cindex "black list (DNS)"
38351 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38352 DNS black list suffers a temporary error.
38353 .next
38354 .cindex log dnssec
38355 .cindex dnssec logging
38356 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38357 dns lookups gave secure results a tag of DS is added.
38358 For acceptance this covers the reverse and forward lookups for host name verification.
38359 It does not cover helo-name verification.
38360 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38361 .next
38362 .cindex "log" "ETRN commands"
38363 .cindex "ETRN" "logging"
38364 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38365 is run to determine whether or not it is actually accepted. An invalid ETRN
38366 command, or one received within a message transaction is not logged by this
38367 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38368 .next
38369 .cindex "log" "host lookup failure"
38370 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38371 any addresses, or when a lookup of an IP address fails to find a host name, a
38372 log line is written. This logging does not apply to direct DNS lookups when
38373 routing email addresses, but it does apply to &"byname"& lookups.
38374 .next
38375 .cindex "log" "ident timeout"
38376 .cindex "RFC 1413" "logging timeout"
38377 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38378 client's ident port times out.
38379 .next
38380 .cindex "log" "incoming interface"
38381 .cindex "log" "local interface"
38382 .cindex "log" "local address and port"
38383 .cindex "TCP/IP" "logging local address and port"
38384 .cindex "interface" "logging"
38385 &%incoming_interface%&: The interface on which a message was received is added
38386 to the &"<="& line as an IP address in square brackets, tagged by I= and
38387 followed by a colon and the port number. The local interface and port are also
38388 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38389 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
38390 The latter can be disabled by turning off the &%outgoing_interface%& option.
38391 .next
38392 .cindex log "incoming proxy address"
38393 .cindex proxy "logging proxy address"
38394 .cindex "TCP/IP" "logging proxy address"
38395 &%proxy%&: The internal (closest to the system running Exim) IP address
38396 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38397 on a proxied connection
38398 or the &"=>"& line for a message delivered on a proxied connection.
38399 See &<<SECTproxyInbound>>& for more information.
38400 .next
38401 .cindex "log" "incoming remote port"
38402 .cindex "port" "logging remote"
38403 .cindex "TCP/IP" "logging incoming remote port"
38404 .vindex "&$sender_fullhost$&"
38405 .vindex "&$sender_rcvhost$&"
38406 &%incoming_port%&: The remote port number from which a message was received is
38407 added to log entries and &'Received:'& header lines, following the IP address
38408 in square brackets, and separated from it by a colon. This is implemented by
38409 changing the value that is put in the &$sender_fullhost$& and
38410 &$sender_rcvhost$& variables. Recording the remote port number has become more
38411 important with the widening use of NAT (see RFC 2505).
38412 .next
38413 .cindex "log" "dropped connection"
38414 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38415 connection is unexpectedly dropped.
38416 .next
38417 .cindex "log" "millisecond timestamps"
38418 .cindex millisecond logging
38419 .cindex timestamps "millisecond, in logs"
38420 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38421 appended to the seconds value.
38422 .next
38423 .cindex "log" "message id"
38424 &%msg_id%&: The value of the Message-ID: header.
38425 .next
38426 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38427 This will be either because the message is a bounce, or was submitted locally
38428 (submission mode) without one.
38429 The field identifier will have an asterix appended: &"id*="&.
38430 .next
38431 .cindex "log" "outgoing interface"
38432 .cindex "log" "local interface"
38433 .cindex "log" "local address and port"
38434 .cindex "TCP/IP" "logging local address and port"
38435 .cindex "interface" "logging"
38436 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38437 interface on which a message was sent is added to delivery lines as an I= tag
38438 followed by IP address in square brackets. You can disable this by turning
38439 off the &%outgoing_interface%& option.
38440 .next
38441 .cindex "log" "outgoing remote port"
38442 .cindex "port" "logging outgoing remote"
38443 .cindex "TCP/IP" "logging outgoing remote port"
38444 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38445 containing => tags) following the IP address.
38446 The local port is also added if &%incoming_interface%& and
38447 &%outgoing_interface%& are both enabled.
38448 This option is not included in the default setting, because for most ordinary
38449 configurations, the remote port number is always 25 (the SMTP port), and the
38450 local port is a random ephemeral port.
38451 .next
38452 .cindex "log" "process ids in"
38453 .cindex "pid (process id)" "in log lines"
38454 &%pid%&: The current process id is added to every log line, in square brackets,
38455 immediately after the time and date.
38456 .next
38457 .cindex log pipelining
38458 .cindex pipelining "logging outgoing"
38459 &%pipelining%&: A field is added to delivery and accept
38460 log lines when the ESMTP PIPELINING extension was used.
38461 The field is a single "L".
38462
38463 On accept lines, where PIPELINING was offered but not used by the client,
38464 the field has a minus appended.
38465
38466 .cindex "pipelining" "early connection"
38467 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38468 accept "L" fields have a period appended if the feature was
38469 offered but not used, or an asterisk appended if used.
38470 Delivery "L" fields have an asterisk appended if used.
38471
38472 .next
38473 .cindex "log" "queue run"
38474 .cindex "queue runner" "logging"
38475 &%queue_run%&: The start and end of every queue run are logged.
38476 .next
38477 .cindex "log" "queue time"
38478 &%queue_time%&: The amount of time the message has been in the queue on the
38479 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38480 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38481 includes reception time as well as the delivery time for the current address.
38482 This means that it may be longer than the difference between the arrival and
38483 delivery log line times, because the arrival log line is not written until the
38484 message has been successfully received.
38485 If millisecond logging is enabled, short times will be shown with greater
38486 precision, eg. &`QT=1.578s`&.
38487 .next
38488 &%queue_time_overall%&: The amount of time the message has been in the queue on
38489 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38490 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38491 message, so it includes reception time as well as the total delivery time.
38492 .next
38493 .cindex "log" "receive duration"
38494 &%receive_time%&: For each message, the amount of real time it has taken to
38495 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38496 If millisecond logging is enabled, short times will be shown with greater
38497 precision, eg. &`RT=0.204s`&.
38498 .next
38499 .cindex "log" "recipients"
38500 &%received_recipients%&: The recipients of a message are listed in the main log
38501 as soon as the message is received. The list appears at the end of the log line
38502 that is written when a message is received, preceded by the word &"for"&. The
38503 addresses are listed after they have been qualified, but before any rewriting
38504 has taken place.
38505 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38506 in the list.
38507 .next
38508 .cindex "log" "sender reception"
38509 &%received_sender%&: The unrewritten original sender of a message is added to
38510 the end of the log line that records the message's arrival, after the word
38511 &"from"& (before the recipients if &%received_recipients%& is also set).
38512 .next
38513 .cindex "log" "header lines for rejection"
38514 &%rejected_header%&: If a message's header has been received at the time a
38515 rejection is written to the reject log, the complete header is added to the
38516 log. Header logging can be turned off individually for messages that are
38517 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38518 .next
38519 .cindex "log" "retry defer"
38520 &%retry_defer%&: A log line is written if a delivery is deferred because a
38521 retry time has not yet been reached. However, this &"retry time not reached"&
38522 message is always omitted from individual message logs after the first delivery
38523 attempt.
38524 .next
38525 .cindex "log" "return path"
38526 &%return_path_on_delivery%&: The return path that is being transmitted with
38527 the message is included in delivery and bounce lines, using the tag P=.
38528 This is omitted if no delivery actually happens, for example, if routing fails,
38529 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38530 .next
38531 .cindex "log" "sender on delivery"
38532 &%sender_on_delivery%&: The message's sender address is added to every delivery
38533 and bounce line, tagged by F= (for &"from"&).
38534 This is the original sender that was received with the message; it is not
38535 necessarily the same as the outgoing return path.
38536 .next
38537 .cindex "log" "sender verify failure"
38538 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38539 gives details of a sender verification failure is not written. Log lines for
38540 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38541 detail is lost.
38542 .next
38543 .cindex "log" "size rejection"
38544 &%size_reject%&: A log line is written whenever a message is rejected because
38545 it is too big.
38546 .next
38547 .cindex "log" "frozen messages; skipped"
38548 .cindex "frozen messages" "logging skipping"
38549 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38550 queue run because it is frozen or because another process is already delivering
38551 it.
38552 .cindex "&""spool file is locked""&"
38553 The message that is written is &"spool file is locked"&.
38554 .next
38555 .cindex "log" "smtp confirmation"
38556 .cindex "SMTP" "logging confirmation"
38557 .cindex "LMTP" "logging confirmation"
38558 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38559 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38560 A number of MTAs (including Exim) return an identifying string in this
38561 response.
38562 .next
38563 .cindex "log" "SMTP connections"
38564 .cindex "SMTP" "logging connections"
38565 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38566 established or closed, unless the connection is from a host that matches
38567 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38568 only when the closure is unexpected.) This applies to connections from local
38569 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38570 dropped in the middle of a message, a log line is always written, whether or
38571 not this selector is set, but otherwise nothing is written at the start and end
38572 of connections unless this selector is enabled.
38573
38574 For TCP/IP connections to an Exim daemon, the current number of connections is
38575 included in the log message for each new connection, but note that the count is
38576 reset if the daemon is restarted.
38577 Also, because connections are closed (and the closure is logged) in
38578 subprocesses, the count may not include connections that have been closed but
38579 whose termination the daemon has not yet noticed. Thus, while it is possible to
38580 match up the opening and closing of connections in the log, the value of the
38581 logged counts may not be entirely accurate.
38582 .next
38583 .cindex "log" "SMTP transaction; incomplete"
38584 .cindex "SMTP" "logging incomplete transactions"
38585 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38586 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38587 and the message sender plus any accepted recipients are included in the log
38588 line. This can provide evidence of dictionary attacks.
38589 .next
38590 .cindex "log" "non-MAIL SMTP sessions"
38591 .cindex "MAIL" "logging session without"
38592 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38593 connection terminates without having issued a MAIL command. This includes both
38594 the case when the connection is dropped, and the case when QUIT is used. It
38595 does not include cases where the connection is rejected right at the start (by
38596 an ACL, or because there are too many connections, or whatever). These cases
38597 already have their own log lines.
38598
38599 The log line that is written contains the identity of the client in the usual
38600 way, followed by D= and a time, which records the duration of the connection.
38601 If the connection was authenticated, this fact is logged exactly as it is for
38602 an incoming message, with an A= item. If the connection was encrypted, CV=,
38603 DN=, and X= items may appear as they do for an incoming message, controlled by
38604 the same logging options.
38605
38606 Finally, if any SMTP commands were issued during the connection, a C= item
38607 is added to the line, listing the commands that were used. For example,
38608 .code
38609 C=EHLO,QUIT
38610 .endd
38611 shows that the client issued QUIT straight after EHLO. If there were fewer
38612 than 20 commands, they are all listed. If there were more than 20 commands,
38613 the last 20 are listed, preceded by &"..."&. However, with the default
38614 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38615 have been aborted before 20 non-mail commands are processed.
38616 .next
38617 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38618 colon-separated, is appended to the A= item for a message arrival or delivery
38619 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38620 was accepted or used.
38621 .next
38622 .cindex "log" "SMTP protocol error"
38623 .cindex "SMTP" "logging protocol error"
38624 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38625 encountered. Exim does not have perfect detection of all protocol errors
38626 because of transmission delays and the use of pipelining. If PIPELINING has
38627 been advertised to a client, an Exim server assumes that the client will use
38628 it, and therefore it does not count &"expected"& errors (for example, RCPT
38629 received after rejecting MAIL) as protocol errors.
38630 .next
38631 .cindex "SMTP" "logging syntax errors"
38632 .cindex "SMTP" "syntax errors; logging"
38633 .cindex "SMTP" "unknown command; logging"
38634 .cindex "log" "unknown SMTP command"
38635 .cindex "log" "SMTP syntax error"
38636 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38637 encountered. An unrecognized command is treated as a syntax error. For an
38638 external connection, the host identity is given; for an internal connection
38639 using &%-bs%& the sender identification (normally the calling user) is given.
38640 .next
38641 .cindex "log" "subject"
38642 .cindex "subject, logging"
38643 &%subject%&: The subject of the message is added to the arrival log line,
38644 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38645 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38646 specifies whether characters with values greater than 127 should be logged
38647 unchanged, or whether they should be rendered as escape sequences.
38648 .next
38649 .cindex "log" "certificate verification"
38650 .cindex log DANE
38651 .cindex DANE logging
38652 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38653 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38654 verified
38655 using a CA trust anchor,
38656 &`CA=dane`& if using a DNS trust anchor,
38657 and &`CV=no`& if not.
38658 .next
38659 .cindex "log" "TLS cipher"
38660 .cindex "TLS" "logging cipher"
38661 &%tls_cipher%&: When a message is sent or received over an encrypted
38662 connection, the cipher suite used is added to the log line, preceded by X=.
38663 .next
38664 .cindex "log" "TLS peer DN"
38665 .cindex "TLS" "logging peer DN"
38666 &%tls_peerdn%&: When a message is sent or received over an encrypted
38667 connection, and a certificate is supplied by the remote host, the peer DN is
38668 added to the log line, preceded by DN=.
38669 .next
38670 .cindex "log" "TLS resumption"
38671 .cindex "TLS" "logging session resumption"
38672 .new
38673 &%tls_resumption%&: When a message is sent or received over an encrypted
38674 connection and the TLS session resumed one used on a previous TCP connection,
38675 an asterisk is appended to the X= cipher field in the log line.
38676 .wen
38677 .next
38678 .cindex "log" "TLS SNI"
38679 .cindex "TLS" "logging SNI"
38680 &%tls_sni%&: When a message is received over an encrypted connection, and
38681 the remote host provided the Server Name Indication extension, the SNI is
38682 added to the log line, preceded by SNI=.
38683 .next
38684 .cindex "log" "DNS failure in list"
38685 &%unknown_in_list%&: This setting causes a log entry to be written when the
38686 result of a list match is failure because a DNS lookup failed.
38687 .endlist
38688
38689
38690 .section "Message log" "SECID260"
38691 .cindex "message" "log file for"
38692 .cindex "log" "message log; description of"
38693 .cindex "&_msglog_& directory"
38694 .oindex "&%preserve_message_logs%&"
38695 In addition to the general log files, Exim writes a log file for each message
38696 that it handles. The names of these per-message logs are the message ids, and
38697 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38698 message log contains copies of the log lines that apply to the message. This
38699 makes it easier to inspect the status of an individual message without having
38700 to search the main log. A message log is deleted when processing of the message
38701 is complete, unless &%preserve_message_logs%& is set, but this should be used
38702 only with great care because they can fill up your disk very quickly.
38703
38704 On a heavily loaded system, it may be desirable to disable the use of
38705 per-message logs, in order to reduce disk I/O. This can be done by setting the
38706 &%message_logs%& option false.
38707 .ecindex IIDloggen
38708
38709
38710
38711
38712 . ////////////////////////////////////////////////////////////////////////////
38713 . ////////////////////////////////////////////////////////////////////////////
38714
38715 .chapter "Exim utilities" "CHAPutils"
38716 .scindex IIDutils "utilities"
38717 A number of utility scripts and programs are supplied with Exim and are
38718 described in this chapter. There is also the Exim Monitor, which is covered in
38719 the next chapter. The utilities described here are:
38720
38721 .itable none 0 0 3  7* left  15* left  40* left
38722 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38723   "list what Exim processes are doing"
38724 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38725 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38726 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38727 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38728                                                 various criteria"
38729 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38730 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38731   "extract statistics from the log"
38732 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38733   "check address acceptance from given IP"
38734 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38735 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38736 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38737 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38738 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38739 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38740 .endtable
38741
38742 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38743 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38744 &url(https://duncanthrax.net/exilog/) for details.
38745
38746
38747
38748
38749 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38750 .cindex "&'exiwhat'&"
38751 .cindex "process, querying"
38752 .cindex "SIGUSR1"
38753 On operating systems that can restart a system call after receiving a signal
38754 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38755 a line describing what it is doing to the file &_exim-process.info_& in the
38756 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38757 processes it can find, having first emptied the file. It then waits for one
38758 second to allow the Exim processes to react before displaying the results. In
38759 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38760 send the signal to the Exim processes, so it is normally run as root.
38761
38762 &*Warning*&: This is not an efficient process. It is intended for occasional
38763 use by system administrators. It is not sensible, for example, to set up a
38764 script that sends SIGUSR1 signals to Exim processes at short intervals.
38765
38766
38767 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38768 varies in different operating systems. Not only are different options used,
38769 but the format of the output is different. For this reason, there are some
38770 system configuration options that configure exactly how &'exiwhat'& works. If
38771 it doesn't seem to be working for you, check the following compile-time
38772 options:
38773 .display
38774 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38775 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38776 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38777 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38778 .endd
38779 An example of typical output from &'exiwhat'& is
38780 .code
38781 164 daemon: -q1h, listening on port 25
38782 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38783 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38784   [10.19.42.42] (editor@ref.example)
38785 10592 handling incoming call from [192.168.243.242]
38786 10628 accepting a local non-SMTP message
38787 .endd
38788 The first number in the output line is the process number. The third line has
38789 been split here, in order to fit it on the page.
38790
38791
38792
38793 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38794 .cindex "&'exiqgrep'&"
38795 .cindex "queue" "grepping"
38796 This utility is a Perl script contributed by Matt Hubbard. It runs
38797 .code
38798 exim -bpu
38799 .endd
38800 or (in case &*-a*& switch is specified)
38801 .code
38802 exim -bp
38803 .endd
38804 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38805 contain alternate exim configuration the queue management might be using.
38806
38807 to obtain a queue listing, and then greps the output to select messages
38808 that match given criteria. The following selection options are available:
38809
38810 .vlist
38811 .vitem &*-f*&&~<&'regex'&>
38812 Match the sender address using a case-insensitive search. The field that is
38813 tested is enclosed in angle brackets, so you can test for bounce messages with
38814 .code
38815 exiqgrep -f '^<>$'
38816 .endd
38817 .vitem &*-r*&&~<&'regex'&>
38818 Match a recipient address using a case-insensitive search. The field that is
38819 tested is not enclosed in angle brackets.
38820
38821 .vitem &*-s*&&~<&'regex'&>
38822 Match against the size field.
38823
38824 .vitem &*-y*&&~<&'seconds'&>
38825 Match messages that are younger than the given time.
38826
38827 .vitem &*-o*&&~<&'seconds'&>
38828 Match messages that are older than the given time.
38829
38830 .vitem &*-z*&
38831 Match only frozen messages.
38832
38833 .vitem &*-x*&
38834 Match only non-frozen messages.
38835
38836 .vitem &*-G*&&~<&'queuename'&>
38837 Match only messages in the given queue.  Without this, the default queue is searched.
38838 .endlist
38839
38840 The following options control the format of the output:
38841
38842 .vlist
38843 .vitem &*-c*&
38844 Display only the count of matching messages.
38845
38846 .vitem &*-l*&
38847 Long format &-- display the full message information as output by Exim. This is
38848 the default.
38849
38850 .vitem &*-i*&
38851 Display message ids only.
38852
38853 .vitem &*-b*&
38854 Brief format &-- one line per message.
38855
38856 .vitem &*-R*&
38857 Display messages in reverse order.
38858
38859 .vitem &*-a*&
38860 Include delivered recipients in queue listing.
38861 .endlist
38862
38863 There is one more option, &%-h%&, which outputs a list of options.
38864
38865
38866
38867 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38868 .cindex "&'exiqsumm'&"
38869 .cindex "queue" "summary"
38870 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38871 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38872 running a command such as
38873 .code
38874 exim -bp | exiqsumm
38875 .endd
38876 The output consists of one line for each domain that has messages waiting for
38877 it, as in the following example:
38878 .code
38879 3   2322   74m   66m  msn.com.example
38880 .endd
38881 Each line lists the number of pending deliveries for a domain, their total
38882 volume, and the length of time that the oldest and the newest messages have
38883 been waiting. Note that the number of pending deliveries is greater than the
38884 number of messages when messages have more than one recipient.
38885
38886 A summary line is output at the end. By default the output is sorted on the
38887 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38888 the output to be sorted by oldest message and by count of messages,
38889 respectively. There are also three options that split the messages for each
38890 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38891 separates frozen messages, and &%-s%& separates messages according to their
38892 sender.
38893
38894 The output of &'exim -bp'& contains the original addresses in the message, so
38895 this also applies to the output from &'exiqsumm'&. No domains from addresses
38896 generated by aliasing or forwarding are included (unless the &%one_time%&
38897 option of the &(redirect)& router has been used to convert them into &"top
38898 level"& addresses).
38899
38900
38901
38902
38903 .section "Extracting specific information from the log (exigrep)" &&&
38904          "SECTextspeinf"
38905 .cindex "&'exigrep'&"
38906 .cindex "log" "extracts; grepping for"
38907 The &'exigrep'& utility is a Perl script that searches one or more main log
38908 files for entries that match a given pattern. When it finds a match, it
38909 extracts all the log entries for the relevant message, not just those that
38910 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38911 given message, or all mail for a given user, or for a given host, for example.
38912 The input files can be in Exim log format or syslog format.
38913 If a matching log line is not associated with a specific message, it is
38914 included in &'exigrep'&'s output without any additional lines. The usage is:
38915 .display
38916 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38917 .endd
38918 If no log filenames are given on the command line, the standard input is read.
38919
38920 The &%-t%& argument specifies a number of seconds. It adds an additional
38921 condition for message selection. Messages that are complete are shown only if
38922 they spent more than <&'n'&> seconds in the queue.
38923
38924 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38925 makes it case-sensitive. This may give a performance improvement when searching
38926 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38927 option; with &%-I%& they do not. In both cases it is possible to change the
38928 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38929
38930 The &%-l%& option means &"literal"&, that is, treat all characters in the
38931 pattern as standing for themselves. Otherwise the pattern must be a Perl
38932 regular expression.
38933
38934 The &%-v%& option inverts the matching condition. That is, a line is selected
38935 if it does &'not'& match the pattern.
38936
38937 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38938 that are generated as a result/response to a message that &'exigrep'& matched
38939 normally.
38940
38941 Example of &%-M%&:
38942 user_a sends a message to user_b, which generates a bounce back to user_b. If
38943 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38944 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38945 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38946 when searching for &"user_a"& will show both messages since the bounce is
38947 &"related"& to or a &"result"& of the first message that was found by the
38948 search term.
38949
38950 If the location of a &'zcat'& command is known from the definition of
38951 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38952 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38953 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38954 autodetection of some well known compression extensions.
38955
38956
38957 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38958 .cindex "&'exipick'&"
38959 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38960 lists messages from the queue according to a variety of criteria. For details
38961 of &'exipick'&'s facilities, run &'exipick'& with
38962 the &%--help%& option.
38963
38964
38965 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38966 .cindex "log" "cycling local files"
38967 .cindex "cycling logs"
38968 .cindex "&'exicyclog'&"
38969 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38970 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38971 you are using log files with datestamps in their names (see section
38972 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38973 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38974 There are two command line options for &'exicyclog'&:
38975 .ilist
38976 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38977 default that is set when Exim is built. The default default is 10.
38978 .next
38979 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38980 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38981 overriding the script's default, which is to find the setting from Exim's
38982 configuration.
38983 .endlist
38984
38985 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38986 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38987 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38988 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38989 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38990 logs are handled similarly.
38991
38992 If the limit is greater than 99, the script uses 3-digit numbers such as
38993 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38994 to one that is greater, or &'vice versa'&, you will have to fix the names of
38995 any existing log files.
38996
38997 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38998 the end are deleted. All files with numbers greater than 01 are compressed,
38999 using a compression command which is configured by the COMPRESS_COMMAND
39000 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39001 root &%crontab%& entry of the form
39002 .code
39003 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39004 .endd
39005 assuming you have used the name &"exim"& for the Exim user. You can run
39006 &'exicyclog'& as root if you wish, but there is no need.
39007
39008
39009
39010 .section "Mail statistics (eximstats)" "SECTmailstat"
39011 .cindex "statistics"
39012 .cindex "&'eximstats'&"
39013 A Perl script called &'eximstats'& is provided for extracting statistical
39014 information from log files. The output is either plain text, or HTML.
39015 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39016 . --- 404 error and everything else points to that.
39017
39018 The &'eximstats'& script has been hacked about quite a bit over time. The
39019 latest version is the result of some extensive revision by Steve Campbell. A
39020 lot of information is given by default, but there are options for suppressing
39021 various parts of it. Following any options, the arguments to the script are a
39022 list of files, which should be main log files. For example:
39023 .code
39024 eximstats -nr /var/spool/exim/log/mainlog.01
39025 .endd
39026 By default, &'eximstats'& extracts information about the number and volume of
39027 messages received from or delivered to various hosts. The information is sorted
39028 both by message count and by volume, and the top fifty hosts in each category
39029 are listed on the standard output. Similar information, based on email
39030 addresses or domains instead of hosts can be requested by means of various
39031 options. For messages delivered and received locally, similar statistics are
39032 also produced per user.
39033
39034 The output also includes total counts and statistics about delivery errors, and
39035 histograms showing the number of messages received and deliveries made in each
39036 hour of the day. A delivery with more than one address in its envelope (for
39037 example, an SMTP transaction with more than one RCPT command) is counted
39038 as a single delivery by &'eximstats'&.
39039
39040 Though normally more deliveries than receipts are reported (as messages may
39041 have multiple recipients), it is possible for &'eximstats'& to report more
39042 messages received than delivered, even though the queue is empty at the start
39043 and end of the period in question. If an incoming message contains no valid
39044 recipients, no deliveries are recorded for it. A bounce message is handled as
39045 an entirely separate message.
39046
39047 &'eximstats'& always outputs a grand total summary giving the volume and number
39048 of messages received and deliveries made, and the number of hosts involved in
39049 each case. It also outputs the number of messages that were delayed (that is,
39050 not completely delivered at the first attempt), and the number that had at
39051 least one address that failed.
39052
39053 The remainder of the output is in sections that can be independently disabled
39054 or modified by various options. It consists of a summary of deliveries by
39055 transport, histograms of messages received and delivered per time interval
39056 (default per hour), information about the time messages spent in the queue,
39057 a list of relayed messages, lists of the top fifty sending hosts, local
39058 senders, destination hosts, and destination local users by count and by volume,
39059 and a list of delivery errors that occurred.
39060
39061 The relay information lists messages that were actually relayed, that is, they
39062 came from a remote host and were directly delivered to some other remote host,
39063 without being processed (for example, for aliasing or forwarding) locally.
39064
39065 There are quite a few options for &'eximstats'& to control exactly what it
39066 outputs. These are documented in the Perl script itself, and can be extracted
39067 by running the command &(perldoc)& on the script. For example:
39068 .code
39069 perldoc /usr/exim/bin/eximstats
39070 .endd
39071
39072 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39073 .cindex "&'exim_checkaccess'&"
39074 .cindex "policy control" "checking access"
39075 .cindex "checking access"
39076 The &%-bh%& command line argument allows you to run a fake SMTP session with
39077 debugging output, in order to check what Exim is doing when it is applying
39078 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39079 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39080 sometimes you just want to answer the question &"Does this address have
39081 access?"& without bothering with any further details.
39082
39083 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39084 two arguments, an IP address and an email address:
39085 .code
39086 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39087 .endd
39088 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39089 given email address would be accepted in a RCPT command in a TCP/IP
39090 connection from the host with the given IP address. The output of the utility
39091 is either the word &"accepted"&, or the SMTP error response, for example:
39092 .code
39093 Rejected:
39094 550 Relay not permitted
39095 .endd
39096 When running this test, the utility uses &`<>`& as the envelope sender address
39097 for the MAIL command, but you can change this by providing additional
39098 options. These are passed directly to the Exim command. For example, to specify
39099 that the test is to be run with the sender address &'himself@there.example'&
39100 you can use:
39101 .code
39102 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39103                  -f himself@there.example
39104 .endd
39105 Note that these additional Exim command line items must be given after the two
39106 mandatory arguments.
39107
39108 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39109 while running its checks. You can run checks that include callouts by using
39110 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39111
39112
39113
39114 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39115 .cindex "DBM" "building dbm files"
39116 .cindex "building DBM files"
39117 .cindex "&'exim_dbmbuild'&"
39118 .cindex "lower casing"
39119 .cindex "binary zero" "in lookup key"
39120 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39121 the format used by the &(lsearch)& lookup (see section
39122 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39123 names as keys and the remainder of the information as data. The lower-casing
39124 can be prevented by calling the program with the &%-nolc%& option.
39125
39126 A terminating zero is included as part of the key string. This is expected by
39127 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39128 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39129 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39130 files.
39131
39132 The program requires two arguments: the name of the input file (which can be a
39133 single hyphen to indicate the standard input), and the name of the output file.
39134 It creates the output under a temporary name, and then renames it if all went
39135 well.
39136
39137 .cindex "USE_DB"
39138 If the native DB interface is in use (USE_DB is set in a compile-time
39139 configuration file &-- this is common in free versions of Unix) the two
39140 filenames must be different, because in this mode the Berkeley DB functions
39141 create a single output file using exactly the name given. For example,
39142 .code
39143 exim_dbmbuild /etc/aliases /etc/aliases.db
39144 .endd
39145 reads the system alias file and creates a DBM version of it in
39146 &_/etc/aliases.db_&.
39147
39148 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39149 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39150 environment, the suffixes are added to the second argument of
39151 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39152 when the Berkeley functions are used in compatibility mode (though this is not
39153 recommended), because in that case it adds a &_.db_& suffix to the filename.
39154
39155 If a duplicate key is encountered, the program outputs a warning, and when it
39156 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39157 option is used. By default, only the first of a set of duplicates is used &--
39158 this makes it compatible with &(lsearch)& lookups. There is an option
39159 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39160 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39161 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39162 return code is 2.
39163
39164
39165
39166
39167 .section "Finding individual retry times (exinext)" "SECTfinindret"
39168 .cindex "retry" "times"
39169 .cindex "&'exinext'&"
39170 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39171 fish specific information out of the retry database. Given a mail domain (or a
39172 complete address), it looks up the hosts for that domain, and outputs any retry
39173 information for the hosts or for the domain. At present, the retry information
39174 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39175 output. For example:
39176 .code
39177 $ exinext piglet@milne.fict.example
39178 kanga.milne.example:192.168.8.1 error 146: Connection refused
39179   first failed: 21-Feb-1996 14:57:34
39180   last tried:   21-Feb-1996 14:57:34
39181   next try at:  21-Feb-1996 15:02:34
39182 roo.milne.example:192.168.8.3 error 146: Connection refused
39183   first failed: 20-Jan-1996 13:12:08
39184   last tried:   21-Feb-1996 11:42:03
39185   next try at:  21-Feb-1996 19:42:03
39186   past final cutoff time
39187 .endd
39188 You can also give &'exinext'& a local part, without a domain, and it
39189 will give any retry information for that local part in your default domain.
39190 A message id can be used to obtain retry information pertaining to a specific
39191 message. This exists only when an attempt to deliver a message to a remote host
39192 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39193 &'exinext'& is not particularly efficient, but then it is not expected to be
39194 run very often.
39195
39196 The &'exinext'& utility calls Exim to find out information such as the location
39197 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39198 passed on to the &'exim'& commands. The first specifies an alternate Exim
39199 configuration file, and the second sets macros for use within the configuration
39200 file. These features are mainly to help in testing, but might also be useful in
39201 environments where more than one configuration file is in use.
39202
39203
39204
39205 .section "Hints database maintenance" "SECThindatmai"
39206 .cindex "hints database" "maintenance"
39207 .cindex "maintaining Exim's hints database"
39208 Three utility programs are provided for maintaining the DBM files that Exim
39209 uses to contain its delivery hint information. Each program requires two
39210 arguments. The first specifies the name of Exim's spool directory, and the
39211 second is the name of the database it is to operate on. These are as follows:
39212
39213 .ilist
39214 &'retry'&: the database of retry information
39215 .next
39216 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39217 for remote hosts
39218 .next
39219 &'callout'&: the callout cache
39220 .next
39221 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39222 .next
39223 .new
39224 &'tls'&: TLS session resumption data
39225 .wen
39226 .next
39227 &'misc'&: other hints data
39228 .endlist
39229
39230 The &'misc'& database is used for
39231
39232 .ilist
39233 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39234 .next
39235 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39236 &(smtp)& transport)
39237 .next
39238 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39239 in a transport)
39240 .endlist
39241
39242
39243
39244 .section "exim_dumpdb" "SECID261"
39245 .cindex "&'exim_dumpdb'&"
39246 The entire contents of a database are written to the standard output by the
39247 &'exim_dumpdb'& program, which has no options or arguments other than the
39248 spool and database names. For example, to dump the retry database:
39249 .code
39250 exim_dumpdb /var/spool/exim retry
39251 .endd
39252 Two lines of output are produced for each entry:
39253 .code
39254 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39255 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39256 .endd
39257 The first item on the first line is the key of the record. It starts with one
39258 of the letters R, or T, depending on whether it refers to a routing or
39259 transport retry. For a local delivery, the next part is the local address; for
39260 a remote delivery it is the name of the remote host, followed by its failing IP
39261 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39262 transport). If the remote port is not the standard one (port 25), it is added
39263 to the IP address. Then there follows an error code, an additional error code,
39264 and a textual description of the error.
39265
39266 The three times on the second line are the time of first failure, the time of
39267 the last delivery attempt, and the computed time for the next attempt. The line
39268 ends with an asterisk if the cutoff time for the last retry rule has been
39269 exceeded.
39270
39271 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39272 consists of a host name followed by a list of ids for messages that are or were
39273 waiting to be delivered to that host. If there are a very large number for any
39274 one host, continuation records, with a sequence number added to the host name,
39275 may be seen. The data in these records is often out of date, because a message
39276 may be routed to several alternative hosts, and Exim makes no effort to keep
39277 cross-references.
39278
39279
39280
39281 .section "exim_tidydb" "SECID262"
39282 .cindex "&'exim_tidydb'&"
39283 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39284 database. If run with no options, it removes all records that are more than 30
39285 days old. The age is calculated from the date and time that the record was last
39286 updated. Note that, in the case of the retry database, it is &'not'& the time
39287 since the first delivery failure. Information about a host that has been down
39288 for more than 30 days will remain in the database, provided that the record is
39289 updated sufficiently often.
39290
39291 The cutoff date can be altered by means of the &%-t%& option, which must be
39292 followed by a time. For example, to remove all records older than a week from
39293 the retry database:
39294 .code
39295 exim_tidydb -t 7d /var/spool/exim retry
39296 .endd
39297 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39298 message ids. In the former these appear as data in records keyed by host &--
39299 they were messages that were waiting for that host &-- and in the latter they
39300 are the keys for retry information for messages that have suffered certain
39301 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39302 message ids in database records are those of messages that are still on the
39303 queue. Message ids for messages that no longer exist are removed from
39304 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39305 For the &'retry'& database, records whose keys are non-existent message ids are
39306 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39307 whenever it removes information from the database.
39308
39309 Certain records are automatically removed by Exim when they are no longer
39310 needed, but others are not. For example, if all the MX hosts for a domain are
39311 down, a retry record is created for each one. If the primary MX host comes back
39312 first, its record is removed when Exim successfully delivers to it, but the
39313 records for the others remain because Exim has not tried to use those hosts.
39314
39315 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39316 hints databases. You should do this at a quiet time of day, because it requires
39317 a database to be locked (and therefore inaccessible to Exim) while it does its
39318 work. Removing records from a DBM file does not normally make the file smaller,
39319 but all the common DBM libraries are able to re-use the space that is released.
39320 After an initial phase of increasing in size, the databases normally reach a
39321 point at which they no longer get any bigger, as long as they are regularly
39322 tidied.
39323
39324 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39325 databases is likely to keep on increasing.
39326
39327
39328
39329
39330 .section "exim_fixdb" "SECID263"
39331 .cindex "&'exim_fixdb'&"
39332 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39333 Its main use is for testing Exim, but it might also be occasionally useful for
39334 getting round problems in a live system. It has no options, and its interface
39335 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39336 key of a database record can then be entered, and the data for that record is
39337 displayed.
39338
39339 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39340 except the &'retry'& database, that is the only operation that can be carried
39341 out. For the &'retry'& database, each field is output preceded by a number, and
39342 data for individual fields can be changed by typing the field number followed
39343 by new data, for example:
39344 .code
39345 > 4 951102:1000
39346 .endd
39347 resets the time of the next delivery attempt. Time values are given as a
39348 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39349 used as optional separators.
39350
39351
39352
39353
39354 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39355 .cindex "mailbox" "maintenance"
39356 .cindex "&'exim_lock'&"
39357 .cindex "locking mailboxes"
39358 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39359 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39360 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39361 a user agent while investigating a problem. The utility requires the name of
39362 the file as its first argument. If the locking is successful, the second
39363 argument is run as a command (using C's &[system()]& function); if there is no
39364 second argument, the value of the SHELL environment variable is used; if this
39365 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39366 is unlocked and the utility ends. The following options are available:
39367
39368 .vlist
39369 .vitem &%-fcntl%&
39370 Use &[fcntl()]& locking on the open mailbox.
39371
39372 .vitem &%-flock%&
39373 Use &[flock()]& locking on the open mailbox, provided the operating system
39374 supports it.
39375
39376 .vitem &%-interval%&
39377 This must be followed by a number, which is a number of seconds; it sets the
39378 interval to sleep between retries (default 3).
39379
39380 .vitem &%-lockfile%&
39381 Create a lock file before opening the mailbox.
39382
39383 .vitem &%-mbx%&
39384 Lock the mailbox using MBX rules.
39385
39386 .vitem &%-q%&
39387 Suppress verification output.
39388
39389 .vitem &%-retries%&
39390 This must be followed by a number; it sets the number of times to try to get
39391 the lock (default 10).
39392
39393 .vitem &%-restore_time%&
39394 This option causes &%exim_lock%& to restore the modified and read times to the
39395 locked file before exiting. This allows you to access a locked mailbox (for
39396 example, to take a backup copy) without disturbing the times that the user
39397 subsequently sees.
39398
39399 .vitem &%-timeout%&
39400 This must be followed by a number, which is a number of seconds; it sets a
39401 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39402 default), a non-blocking call is used.
39403
39404 .vitem &%-v%&
39405 Generate verbose output.
39406 .endlist
39407
39408 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39409 default is to create a lock file and also to use &[fcntl()]& locking on the
39410 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39411 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39412 requires that the directory containing the file be writeable. Locking by lock
39413 file does not last forever; Exim assumes that a lock file is expired if it is
39414 more than 30 minutes old.
39415
39416 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39417 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39418 to be taken out on the open mailbox, and an exclusive lock on the file
39419 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39420 number of the mailbox file. When the locking is released, if an exclusive lock
39421 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39422
39423 The default output contains verification of the locking that takes place. The
39424 &%-v%& option causes some additional information to be given. The &%-q%& option
39425 suppresses all output except error messages.
39426
39427 A command such as
39428 .code
39429 exim_lock /var/spool/mail/spqr
39430 .endd
39431 runs an interactive shell while the file is locked, whereas
39432 .display
39433 &`exim_lock -q /var/spool/mail/spqr <<End`&
39434 <&'some commands'&>
39435 &`End`&
39436 .endd
39437 runs a specific non-interactive sequence of commands while the file is locked,
39438 suppressing all verification output. A single command can be run by a command
39439 such as
39440 .code
39441 exim_lock -q /var/spool/mail/spqr \
39442   "cp /var/spool/mail/spqr /some/where"
39443 .endd
39444 Note that if a command is supplied, it must be entirely contained within the
39445 second argument &-- hence the quotes.
39446 .ecindex IIDutils
39447
39448
39449 . ////////////////////////////////////////////////////////////////////////////
39450 . ////////////////////////////////////////////////////////////////////////////
39451
39452 .chapter "The Exim monitor" "CHAPeximon"
39453 .scindex IIDeximon "Exim monitor" "description"
39454 .cindex "X-windows"
39455 .cindex "&'eximon'&"
39456 .cindex "Local/eximon.conf"
39457 .cindex "&_exim_monitor/EDITME_&"
39458 The Exim monitor is an application which displays in an X window information
39459 about the state of Exim's queue and what Exim is doing. An admin user can
39460 perform certain operations on messages from this GUI interface; however all
39461 such facilities are also available from the command line, and indeed, the
39462 monitor itself makes use of the command line to perform any actions requested.
39463
39464
39465
39466 .section "Running the monitor" "SECID264"
39467 The monitor is started by running the script called &'eximon'&. This is a shell
39468 script that sets up a number of environment variables, and then runs the
39469 binary called &_eximon.bin_&. The default appearance of the monitor window can
39470 be changed by editing the &_Local/eximon.conf_& file created by editing
39471 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39472 parameters are for.
39473
39474 The parameters that get built into the &'eximon'& script can be overridden for
39475 a particular invocation by setting up environment variables of the same names,
39476 preceded by &`EXIMON_`&. For example, a shell command such as
39477 .code
39478 EXIMON_LOG_DEPTH=400 eximon
39479 .endd
39480 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39481 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39482 overrides the Exim log file configuration. This makes it possible to have
39483 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39484 syslog messages are routed to a file on the local host.
39485
39486 X resources can be used to change the appearance of the window in the normal
39487 way. For example, a resource setting of the form
39488 .code
39489 Eximon*background: gray94
39490 .endd
39491 changes the colour of the background to light grey rather than white. The
39492 stripcharts are drawn with both the data lines and the reference lines in
39493 black. This means that the reference lines are not visible when on top of the
39494 data. However, their colour can be changed by setting a resource called
39495 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39496 For example, if your X server is running Unix, you could set up lighter
39497 reference lines in the stripcharts by obeying
39498 .code
39499 xrdb -merge <<End
39500 Eximon*highlight: gray
39501 End
39502 .endd
39503 .cindex "admin user"
39504 In order to see the contents of messages in the queue, and to operate on them,
39505 &'eximon'& must either be run as root or by an admin user.
39506
39507 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39508 contain X11 resource parameters interpreted by the X11 library.  In addition,
39509 if the first parameter starts with the string "gdb" then it is removed and the
39510 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39511 versioned variants of gdb can be invoked).
39512
39513 The monitor's window is divided into three parts. The first contains one or
39514 more stripcharts and two action buttons, the second contains a &"tail"& of the
39515 main log file, and the third is a display of the queue of messages awaiting
39516 delivery, with two more action buttons. The following sections describe these
39517 different parts of the display.
39518
39519
39520
39521
39522 .section "The stripcharts" "SECID265"
39523 .cindex "stripchart"
39524 The first stripchart is always a count of messages in the queue. Its name can
39525 be configured by setting QUEUE_STRIPCHART_NAME in the
39526 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39527 configuration script by regular expression matches on log file entries, making
39528 it possible to display, for example, counts of messages delivered to certain
39529 hosts or using certain transports. The supplied defaults display counts of
39530 received and delivered messages, and of local and SMTP deliveries. The default
39531 period between stripchart updates is one minute; this can be adjusted by a
39532 parameter in the &_Local/eximon.conf_& file.
39533
39534 The stripchart displays rescale themselves automatically as the value they are
39535 displaying changes. There are always 10 horizontal lines in each chart; the
39536 title string indicates the value of each division when it is greater than one.
39537 For example, &"x2"& means that each division represents a value of 2.
39538
39539 It is also possible to have a stripchart which shows the percentage fullness of
39540 a particular disk partition, which is useful when local deliveries are confined
39541 to a single partition.
39542
39543 .cindex "&%statvfs%& function"
39544 This relies on the availability of the &[statvfs()]& function or equivalent in
39545 the operating system. Most, but not all versions of Unix that support Exim have
39546 this. For this particular stripchart, the top of the chart always represents
39547 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39548 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39549 &_Local/eximon.conf_& file.
39550
39551
39552
39553
39554 .section "Main action buttons" "SECID266"
39555 .cindex "size" "of monitor window"
39556 .cindex "Exim monitor" "window size"
39557 .cindex "window size"
39558 Below the stripcharts there is an action button for quitting the monitor. Next
39559 to this is another button marked &"Size"&. They are placed here so that
39560 shrinking the window to its default minimum size leaves just the queue count
39561 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39562 the window to expand to its maximum size, unless it is already at the maximum,
39563 in which case it is reduced to its minimum.
39564
39565 When expanding to the maximum, if the window cannot be fully seen where it
39566 currently is, it is moved back to where it was the last time it was at full
39567 size. When it is expanding from its minimum size, the old position is
39568 remembered, and next time it is reduced to the minimum it is moved back there.
39569
39570 The idea is that you can keep a reduced window just showing one or two
39571 stripcharts at a convenient place on your screen, easily expand it to show
39572 the full window when required, and just as easily put it back to what it was.
39573 The idea is copied from what the &'twm'& window manager does for its
39574 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39575 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39576
39577 Normally, the monitor starts up with the window at its full size, but it can be
39578 built so that it starts up with the window at its smallest size, by setting
39579 START_SMALL=yes in &_Local/eximon.conf_&.
39580
39581
39582
39583 .section "The log display" "SECID267"
39584 .cindex "log" "tail of; in monitor"
39585 The second section of the window is an area in which a display of the tail of
39586 the main log is maintained.
39587 To save space on the screen, the timestamp on each log line is shortened by
39588 removing the date and, if &%log_timezone%& is set, the timezone.
39589 The log tail is not available when the only destination for logging data is
39590 syslog, unless the syslog lines are routed to a local file whose name is passed
39591 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39592
39593 The log sub-window has a scroll bar at its lefthand side which can be used to
39594 move back to look at earlier text, and the up and down arrow keys also have a
39595 scrolling effect. The amount of log that is kept depends on the setting of
39596 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39597 to use. When this is full, the earlier 50% of data is discarded &-- this is
39598 much more efficient than throwing it away line by line. The sub-window also has
39599 a horizontal scroll bar for accessing the ends of long log lines. This is the
39600 only means of horizontal scrolling; the right and left arrow keys are not
39601 available. Text can be cut from this part of the window using the mouse in the
39602 normal way. The size of this subwindow is controlled by parameters in the
39603 configuration file &_Local/eximon.conf_&.
39604
39605 Searches of the text in the log window can be carried out by means of the ^R
39606 and ^S keystrokes, which default to a reverse and a forward search,
39607 respectively. The search covers only the text that is displayed in the window.
39608 It cannot go further back up the log.
39609
39610 The point from which the search starts is indicated by a caret marker. This is
39611 normally at the end of the text in the window, but can be positioned explicitly
39612 by pointing and clicking with the left mouse button, and is moved automatically
39613 by a successful search. If new text arrives in the window when it is scrolled
39614 back, the caret remains where it is, but if the window is not scrolled back,
39615 the caret is moved to the end of the new text.
39616
39617 Pressing ^R or ^S pops up a window into which the search text can be typed.
39618 There are buttons for selecting forward or reverse searching, for carrying out
39619 the search, and for cancelling. If the &"Search"& button is pressed, the search
39620 happens and the window remains so that further searches can be done. If the
39621 &"Return"& key is pressed, a single search is done and the window is closed. If
39622 ^C is typed the search is cancelled.
39623
39624 The searching facility is implemented using the facilities of the Athena text
39625 widget. By default this pops up a window containing both &"search"& and
39626 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39627 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39628 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39629 provided version of &%TextPop%& when the remaining parts of the text widget
39630 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39631 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39632 on these systems, at the expense of having unwanted items in the search popup
39633 window.
39634
39635
39636
39637 .section "The queue display" "SECID268"
39638 .cindex "queue" "display in monitor"
39639 The bottom section of the monitor window contains a list of all messages that
39640 are in the queue, which includes those currently being received or delivered,
39641 as well as those awaiting delivery. The size of this subwindow is controlled by
39642 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39643 at which it is updated is controlled by another parameter in the same file &--
39644 the default is 5 minutes, since queue scans can be quite expensive. However,
39645 there is an &"Update"& action button just above the display which can be used
39646 to force an update of the queue display at any time.
39647
39648 When a host is down for some time, a lot of pending mail can build up for it,
39649 and this can make it hard to deal with other messages in the queue. To help
39650 with this situation there is a button next to &"Update"& called &"Hide"&. If
39651 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39652 type anything in here and press &"Return"&, the text is added to a chain of
39653 such texts, and if every undelivered address in a message matches at least one
39654 of the texts, the message is not displayed.
39655
39656 If there is an address that does not match any of the texts, all the addresses
39657 are displayed as normal. The matching happens on the ends of addresses so, for
39658 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39659 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39660 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39661 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39662 a hide request is automatically cancelled after one hour.
39663
39664 While the dialogue box is displayed, you can't press any buttons or do anything
39665 else to the monitor window. For this reason, if you want to cut text from the
39666 queue display to use in the dialogue box, you have to do the cutting before
39667 pressing the &"Hide"& button.
39668
39669 The queue display contains, for each unhidden queued message, the length of
39670 time it has been in the queue, the size of the message, the message id, the
39671 message sender, and the first undelivered recipient, all on one line. If it is
39672 a bounce message, the sender is shown as &"<>"&. If there is more than one
39673 recipient to which the message has not yet been delivered, subsequent ones are
39674 listed on additional lines, up to a maximum configured number, following which
39675 an ellipsis is displayed. Recipients that have already received the message are
39676 not shown.
39677
39678 .cindex "frozen messages" "display"
39679 If a message is frozen, an asterisk is displayed at the left-hand side.
39680
39681 The queue display has a vertical scroll bar, and can also be scrolled by means
39682 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39683 The text searching facilities, as described above for the log window, are also
39684 available, but the caret is always moved to the end of the text when the queue
39685 display is updated.
39686
39687
39688
39689 .section "The queue menu" "SECID269"
39690 .cindex "queue" "menu in monitor"
39691 If the &%shift%& key is held down and the left button is clicked when the mouse
39692 pointer is over the text for any message, an action menu pops up, and the first
39693 line of the queue display for the message is highlighted. This does not affect
39694 any selected text.
39695
39696 If you want to use some other event for popping up the menu, you can set the
39697 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39698 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39699 value set in this parameter is a standard X event description. For example, to
39700 run eximon using &%ctrl%& rather than &%shift%& you could use
39701 .code
39702 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39703 .endd
39704 The title of the menu is the message id, and it contains entries which act as
39705 follows:
39706
39707 .ilist
39708 &'message log'&: The contents of the message log for the message are displayed
39709 in a new text window.
39710 .next
39711 &'headers'&: Information from the spool file that contains the envelope
39712 information and headers is displayed in a new text window. See chapter
39713 &<<CHAPspool>>& for a description of the format of spool files.
39714 .next
39715 &'body'&: The contents of the spool file containing the body of the message are
39716 displayed in a new text window. There is a default limit of 20,000 bytes to the
39717 amount of data displayed. This can be changed by setting the BODY_MAX
39718 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39719 .next
39720 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39721 delivery of the message. This causes an automatic thaw if the message is
39722 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39723 a new text window. The delivery is run in a separate process, to avoid holding
39724 up the monitor while the delivery proceeds.
39725 .next
39726 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39727 that the message be frozen.
39728 .next
39729 .cindex "thawing messages"
39730 .cindex "unfreezing messages"
39731 .cindex "frozen messages" "thawing"
39732 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39733 that the message be thawed.
39734 .next
39735 .cindex "delivery" "forcing failure"
39736 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39737 that Exim gives up trying to deliver the message. A bounce message is generated
39738 for any remaining undelivered addresses.
39739 .next
39740 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39741 that the message be deleted from the system without generating a bounce
39742 message.
39743 .next
39744 &'add recipient'&: A dialog box is displayed into which a recipient address can
39745 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39746 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39747 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39748 causes a call to Exim to be made using the &%-Mar%& option to request that an
39749 additional recipient be added to the message, unless the entry box is empty, in
39750 which case no action is taken.
39751 .next
39752 &'mark delivered'&: A dialog box is displayed into which a recipient address
39753 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39754 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39755 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39756 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39757 recipient address as already delivered, unless the entry box is empty, in which
39758 case no action is taken.
39759 .next
39760 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39761 mark all recipient addresses as already delivered.
39762 .next
39763 &'edit sender'&: A dialog box is displayed initialized with the current
39764 sender's address. Pressing RETURN causes a call to Exim to be made using the
39765 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39766 in which case no action is taken. If you want to set an empty sender (as in
39767 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39768 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39769 the address is qualified with that domain.
39770 .endlist
39771
39772 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39773 other cases when a call to Exim is made, if there is any output from Exim (in
39774 particular, if the command fails) a window containing the command and the
39775 output is displayed. Otherwise, the results of the action are normally apparent
39776 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39777 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39778 if no output is generated.
39779
39780 The queue display is automatically updated for actions such as freezing and
39781 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39782 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39783 force an update of the display after one of these actions.
39784
39785 In any text window that is displayed as result of a menu action, the normal
39786 cut-and-paste facility is available, and searching can be carried out using ^R
39787 and ^S, as described above for the log tail window.
39788 .ecindex IIDeximon
39789
39790
39791
39792
39793
39794 . ////////////////////////////////////////////////////////////////////////////
39795 . ////////////////////////////////////////////////////////////////////////////
39796
39797 .chapter "Security considerations" "CHAPsecurity"
39798 .scindex IIDsecurcon "security" "discussion of"
39799 This chapter discusses a number of issues concerned with security, some of
39800 which are also covered in other parts of this manual.
39801
39802 For reasons that this author does not understand, some people have promoted
39803 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39804 existence of this chapter in the documentation. However, the intent of the
39805 chapter is simply to describe the way Exim works in relation to certain
39806 security concerns, not to make any specific claims about the effectiveness of
39807 its security as compared with other MTAs.
39808
39809 What follows is a description of the way Exim is supposed to be. Best efforts
39810 have been made to try to ensure that the code agrees with the theory, but an
39811 absence of bugs can never be guaranteed. Any that are reported will get fixed
39812 as soon as possible.
39813
39814
39815 .section "Building a more &""hardened""& Exim" "SECID286"
39816 .cindex "security" "build-time features"
39817 There are a number of build-time options that can be set in &_Local/Makefile_&
39818 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39819 Exim administrator who does not have the root password, or by someone who has
39820 penetrated the Exim (but not the root) account. These options are as follows:
39821
39822 .ilist
39823 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39824 start of any filenames used with the &%-C%& option. When it is set, these
39825 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39826 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39827 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39828 default setting for &%ALT_CONFIG_PREFIX%&.
39829
39830 If the permitted configuration files are confined to a directory to
39831 which only root has access, this guards against someone who has broken
39832 into the Exim account from running a privileged Exim with an arbitrary
39833 configuration file, and using it to break into other accounts.
39834 .next
39835
39836 If a non-trusted configuration file (i.e. not the default configuration file
39837 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39838 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39839 the next item), then root privilege is retained only if the caller of Exim is
39840 root. This locks out the possibility of testing a configuration using &%-C%&
39841 right through message reception and delivery, even if the caller is root. The
39842 reception works, but by that time, Exim is running as the Exim user, so when
39843 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39844 privilege to be lost. However, root can test reception and delivery using two
39845 separate commands.
39846
39847 .next
39848 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39849 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39850 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39851 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39852 the restrictive side.  Requiring build-time selection of safe macros is onerous
39853 but this option is intended solely as a transition mechanism to permit
39854 previously-working configurations to continue to work after release 4.73.
39855 .next
39856 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39857 is disabled.
39858 .next
39859 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39860 never to be used for any deliveries. This is like the &%never_users%& runtime
39861 option, but it cannot be overridden; the runtime option adds additional users
39862 to the list. The default setting is &"root"&; this prevents a non-root user who
39863 is permitted to modify the runtime file from using Exim as a way to get root.
39864 .endlist
39865
39866
39867
39868 .section "Root privilege" "SECID270"
39869 .cindex "setuid"
39870 .cindex "root privilege"
39871 The Exim binary is normally setuid to root, which means that it gains root
39872 privilege (runs as root) when it starts execution. In some special cases (for
39873 example, when the daemon is not in use and there are no local deliveries), it
39874 may be possible to run Exim setuid to some user other than root. This is
39875 discussed in the next section. However, in most installations, root privilege
39876 is required for two things:
39877
39878 .ilist
39879 To set up a socket connected to the standard SMTP port (25) when initialising
39880 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39881 not required.
39882 .next
39883 To be able to change uid and gid in order to read users' &_.forward_& files and
39884 perform local deliveries as the receiving user or as specified in the
39885 configuration.
39886 .endlist
39887
39888 It is not necessary to be root to do any of the other things Exim does, such as
39889 receiving messages and delivering them externally over SMTP, and it is
39890 obviously more secure if Exim does not run as root except when necessary.
39891 For this reason, a user and group for Exim to use must be defined in
39892 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39893 group"&. Their values can be changed by the runtime configuration, though this
39894 is not recommended. Often a user called &'exim'& is used, but some sites use
39895 &'mail'& or another user name altogether.
39896
39897 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39898 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39899 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39900
39901 After a new Exim process has interpreted its command line options, it changes
39902 uid and gid in the following cases:
39903
39904 .ilist
39905 .oindex "&%-C%&"
39906 .oindex "&%-D%&"
39907 If the &%-C%& option is used to specify an alternate configuration file, or if
39908 the &%-D%& option is used to define macro values for the configuration, and the
39909 calling process is not running as root, the uid and gid are changed to those of
39910 the calling process.
39911 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39912 option may not be used at all.
39913 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39914 can be supplied if the calling process is running as root, the Exim run-time
39915 user or CONFIGURE_OWNER, if defined.
39916 .next
39917 .oindex "&%-be%&"
39918 .oindex "&%-bf%&"
39919 .oindex "&%-bF%&"
39920 If the expansion test option (&%-be%&) or one of the filter testing options
39921 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39922 calling process.
39923 .next
39924 If the process is not a daemon process or a queue runner process or a delivery
39925 process or a process for testing address routing (started with &%-bt%&), the
39926 uid and gid are changed to the Exim user and group. This means that Exim always
39927 runs under its own uid and gid when receiving messages. This also applies when
39928 testing address verification
39929 .oindex "&%-bv%&"
39930 .oindex "&%-bh%&"
39931 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39932 option).
39933 .next
39934 For a daemon, queue runner, delivery, or address testing process, the uid
39935 remains as root at this stage, but the gid is changed to the Exim group.
39936 .endlist
39937
39938 The processes that initially retain root privilege behave as follows:
39939
39940 .ilist
39941 A daemon process changes the gid to the Exim group and the uid to the Exim
39942 user after setting up one or more listening sockets. The &[initgroups()]&
39943 function is called, so that if the Exim user is in any additional groups, they
39944 will be used during message reception.
39945 .next
39946 A queue runner process retains root privilege throughout its execution. Its
39947 job is to fork a controlled sequence of delivery processes.
39948 .next
39949 A delivery process retains root privilege throughout most of its execution,
39950 but any actual deliveries (that is, the transports themselves) are run in
39951 subprocesses which always change to a non-root uid and gid. For local
39952 deliveries this is typically the uid and gid of the owner of the mailbox; for
39953 remote deliveries, the Exim uid and gid are used. Once all the delivery
39954 subprocesses have been run, a delivery process changes to the Exim uid and gid
39955 while doing post-delivery tidying up such as updating the retry database and
39956 generating bounce and warning messages.
39957
39958 While the recipient addresses in a message are being routed, the delivery
39959 process runs as root. However, if a user's filter file has to be processed,
39960 this is done in a subprocess that runs under the individual user's uid and
39961 gid. A system filter is run as root unless &%system_filter_user%& is set.
39962 .next
39963 A process that is testing addresses (the &%-bt%& option) runs as root so that
39964 the routing is done in the same environment as a message delivery.
39965 .endlist
39966
39967
39968
39969
39970 .section "Running Exim without privilege" "SECTrunexiwitpri"
39971 .cindex "privilege, running without"
39972 .cindex "unprivileged running"
39973 .cindex "root privilege" "running without"
39974 Some installations like to run Exim in an unprivileged state for more of its
39975 operation, for added security. Support for this mode of operation is provided
39976 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39977 gid are changed to the Exim user and group at the start of a delivery process
39978 (and also queue runner and address testing processes). This means that address
39979 routing is no longer run as root, and the deliveries themselves cannot change
39980 to any other uid.
39981
39982 .cindex SIGHUP
39983 .cindex "daemon" "restarting"
39984 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39985 that the daemon can still be started in the usual way, and it can respond
39986 correctly to SIGHUP because the re-invocation regains root privilege.
39987
39988 An alternative approach is to make Exim setuid to the Exim user and also setgid
39989 to the Exim group. If you do this, the daemon must be started from a root
39990 process. (Calling Exim from a root process makes it behave in the way it does
39991 when it is setuid root.) However, the daemon cannot restart itself after a
39992 SIGHUP signal because it cannot regain privilege.
39993
39994 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39995 stops Exim from trying to re-invoke itself to do a delivery after a message has
39996 been received. Such a re-invocation is a waste of resources because it has no
39997 effect.
39998
39999 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40000 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40001 to the Exim user seems a clean approach, but there is one complication:
40002
40003 In this style of operation, Exim is running with the real uid and gid set to
40004 those of the calling process, and the effective uid/gid set to Exim's values.
40005 Ideally, any association with the calling process' uid/gid should be dropped,
40006 that is, the real uid/gid should be reset to the effective values so as to
40007 discard any privileges that the caller may have. While some operating systems
40008 have a function that permits this action for a non-root effective uid, quite a
40009 number of them do not. Because of this lack of standardization, Exim does not
40010 address this problem at this time.
40011
40012 For this reason, the recommended approach for &"mostly unprivileged"& running
40013 is to keep the Exim binary setuid to root, and to set
40014 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40015 be used in the most straightforward way.
40016
40017 If you configure Exim not to run delivery processes as root, there are a
40018 number of restrictions on what you can do:
40019
40020 .ilist
40021 You can deliver only as the Exim user/group. You should  explicitly use the
40022 &%user%& and &%group%& options to override routers or local transports that
40023 normally deliver as the recipient. This makes sure that configurations that
40024 work in this mode function the same way in normal mode. Any implicit or
40025 explicit specification of another user causes an error.
40026 .next
40027 Use of &_.forward_& files is severely restricted, such that it is usually
40028 not worthwhile to include them in the configuration.
40029 .next
40030 Users who wish to use &_.forward_& would have to make their home directory and
40031 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40032 and their equivalents in Exim filters, cannot be used. While they could be
40033 enabled in the Exim user's name, that would be insecure and not very useful.
40034 .next
40035 Unless the local user mailboxes are all owned by the Exim user (possible in
40036 some POP3 or IMAP-only environments):
40037
40038 .olist
40039 They must be owned by the Exim group and be writeable by that group. This
40040 implies you must set &%mode%& in the appendfile configuration, as well as the
40041 mode of the mailbox files themselves.
40042 .next
40043 You must set &%no_check_owner%&, since most or all of the files will not be
40044 owned by the Exim user.
40045 .next
40046 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40047 on a newly created mailbox when unprivileged. This also implies that new
40048 mailboxes need to be created manually.
40049 .endlist olist
40050 .endlist ilist
40051
40052
40053 These restrictions severely restrict what can be done in local deliveries.
40054 However, there are no restrictions on remote deliveries. If you are running a
40055 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40056 gives more security at essentially no cost.
40057
40058 If you are using the &%mua_wrapper%& facility (see chapter
40059 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40060
40061
40062
40063
40064 .section "Delivering to local files" "SECID271"
40065 Full details of the checks applied by &(appendfile)& before it writes to a file
40066 are given in chapter &<<CHAPappendfile>>&.
40067
40068
40069
40070 .section "Running local commands" "SECTsecconslocalcmds"
40071 .cindex "security" "local commands"
40072 .cindex "security" "command injection attacks"
40073 There are a number of ways in which an administrator can configure Exim to run
40074 commands based upon received, untrustworthy, data. Further, in some
40075 configurations a user who can control a &_.forward_& file can also arrange to
40076 run commands. Configuration to check includes, but is not limited to:
40077
40078 .ilist
40079 Use of &%use_shell%& in the pipe transport: various forms of shell command
40080 injection may be possible with this option present. It is dangerous and should
40081 be used only with considerable caution. Consider constraints which whitelist
40082 allowed characters in a variable which is to be used in a pipe transport that
40083 has &%use_shell%& enabled.
40084 .next
40085 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40086 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40087 &_.forward_& files in a redirect router. If Exim is running on a central mail
40088 hub to which ordinary users do not have shell access, but home directories are
40089 NFS mounted (for instance) then administrators should review the list of these
40090 forbid options available, and should bear in mind that the options that may
40091 need forbidding can change as new features are added between releases.
40092 .next
40093 The &%${run...}%& expansion item does not use a shell by default, but
40094 administrators can configure use of &_/bin/sh_& as part of the command.
40095 Such invocations should be viewed with prejudicial suspicion.
40096 .next
40097 Administrators who use embedded Perl are advised to explore how Perl's
40098 taint checking might apply to their usage.
40099 .next
40100 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40101 administrators are well advised to view its use with suspicion, in case (for
40102 instance) it allows a local-part to contain embedded Exim directives.
40103 .next
40104 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40105 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40106 each can reference arbitrary lists and files, rather than just being a list
40107 of opaque strings.
40108 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40109 real-world security vulnerabilities caused by its use with untrustworthy data
40110 injected in, for SQL injection attacks.
40111 Consider the use of the &%inlisti%& expansion condition instead.
40112 .endlist
40113
40114
40115
40116
40117 .section "Trust in configuration data" "SECTsecconfdata"
40118 .cindex "security" "data sources"
40119 .cindex "security" "regular expressions"
40120 .cindex "regular expressions" "security"
40121 .cindex "PCRE" "security"
40122 If configuration data for Exim can come from untrustworthy sources, there
40123 are some issues to be aware of:
40124
40125 .ilist
40126 Use of &%${expand...}%& may provide a path for shell injection attacks.
40127 .next
40128 Letting untrusted data provide a regular expression is unwise.
40129 .next
40130 Using &%${match...}%& to apply a fixed regular expression against untrusted
40131 data may result in pathological behaviour within PCRE.  Be aware of what
40132 "backtracking" means and consider options for being more strict with a regular
40133 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40134 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40135 possessive quantifiers or just not using regular expressions against untrusted
40136 data.
40137 .next
40138 It can be important to correctly use &%${quote:...}%&,
40139 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40140 items to ensure that data is correctly constructed.
40141 .next
40142 Some lookups might return multiple results, even though normal usage is only
40143 expected to yield one result.
40144 .endlist
40145
40146
40147
40148
40149 .section "IPv4 source routing" "SECID272"
40150 .cindex "source routing" "in IP packets"
40151 .cindex "IP source routing"
40152 Many operating systems suppress IP source-routed packets in the kernel, but
40153 some cannot be made to do this, so Exim does its own check. It logs incoming
40154 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40155 IPv6. No special checking is currently done.
40156
40157
40158
40159 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40160 Support for these SMTP commands is disabled by default. If required, they can
40161 be enabled by defining suitable ACLs.
40162
40163
40164
40165
40166 .section "Privileged users" "SECID274"
40167 .cindex "trusted users"
40168 .cindex "admin user"
40169 .cindex "privileged user"
40170 .cindex "user" "trusted"
40171 .cindex "user" "admin"
40172 Exim recognizes two sets of users with special privileges. Trusted users are
40173 able to submit new messages to Exim locally, but supply their own sender
40174 addresses and information about a sending host. For other users submitting
40175 local messages, Exim sets up the sender address from the uid, and doesn't
40176 permit a remote host to be specified.
40177
40178 .oindex "&%-f%&"
40179 However, an untrusted user is permitted to use the &%-f%& command line option
40180 in the special form &%-f <>%& to indicate that a delivery failure for the
40181 message should not cause an error report. This affects the message's envelope,
40182 but it does not affect the &'Sender:'& header. Untrusted users may also be
40183 permitted to use specific forms of address with the &%-f%& option by setting
40184 the &%untrusted_set_sender%& option.
40185
40186 Trusted users are used to run processes that receive mail messages from some
40187 other mail domain and pass them on to Exim for delivery either locally, or over
40188 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40189 as any user listed in the &%trusted_users%& configuration option, or under any
40190 group listed in the &%trusted_groups%& option.
40191
40192 Admin users are permitted to do things to the messages on Exim's queue. They
40193 can freeze or thaw messages, cause them to be returned to their senders, remove
40194 them entirely, or modify them in various ways. In addition, admin users can run
40195 the Exim monitor and see all the information it is capable of providing, which
40196 includes the contents of files on the spool.
40197
40198 .oindex "&%-M%&"
40199 .oindex "&%-q%&"
40200 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40201 delivery of messages on its queue is restricted to admin users. This
40202 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40203 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40204 queue is also restricted to admin users. This restriction can be relaxed by
40205 setting &%no_queue_list_requires_admin%&.
40206
40207 Exim recognizes an admin user if the calling process is running as root or as
40208 the Exim user or if any of the groups associated with the calling process is
40209 the Exim group. It is not necessary actually to be running under the Exim
40210 group. However, if admin users who are not root or the Exim user are to access
40211 the contents of files on the spool via the Exim monitor (which runs
40212 unprivileged), Exim must be built to allow group read access to its spool
40213 files.
40214
40215 By default, regular users are trusted to perform basic testing and
40216 introspection commands, as themselves.  This setting can be tightened by
40217 setting the &%commandline_checks_require_admin%& option.
40218 This affects most of the checking options,
40219 such as &%-be%& and anything else &%-b*%&.
40220
40221
40222 .section "Spool files" "SECID275"
40223 .cindex "spool directory" "files"
40224 Exim's spool directory and everything it contains is owned by the Exim user and
40225 set to the Exim group. The mode for spool files is defined in the
40226 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40227 any user who is a member of the Exim group can access these files.
40228
40229
40230
40231 .section "Use of argv[0]" "SECID276"
40232 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40233 of specific strings, Exim assumes certain options. For example, calling Exim
40234 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40235 to calling it with the option &%-bS%&. There are no security implications in
40236 this.
40237
40238
40239
40240 .section "Use of %f formatting" "SECID277"
40241 The only use made of &"%f"& by Exim is in formatting load average values. These
40242 are actually stored in integer variables as 1000 times the load average.
40243 Consequently, their range is limited and so therefore is the length of the
40244 converted output.
40245
40246
40247
40248 .section "Embedded Exim path" "SECID278"
40249 Exim uses its own path name, which is embedded in the code, only when it needs
40250 to re-exec in order to regain root privilege. Therefore, it is not root when it
40251 does so. If some bug allowed the path to get overwritten, it would lead to an
40252 arbitrary program's being run as exim, not as root.
40253
40254
40255
40256 .section "Dynamic module directory" "SECTdynmoddir"
40257 Any dynamically loadable modules must be installed into the directory
40258 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40259 loading it.
40260
40261
40262 .section "Use of sprintf()" "SECID279"
40263 .cindex "&[sprintf()]&"
40264 A large number of occurrences of &"sprintf"& in the code are actually calls to
40265 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40266 The intermediate formatting is done into a large fixed buffer by a function
40267 that runs through the format string itself, and checks the length of each
40268 conversion before performing it, thus preventing buffer overruns.
40269
40270 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40271 the output buffer is known to be sufficiently long to contain the converted
40272 string.
40273
40274
40275
40276 .section "Use of debug_printf() and log_write()" "SECID280"
40277 Arbitrary strings are passed to both these functions, but they do their
40278 formatting by calling the function &'string_vformat()'&, which runs through
40279 the format string itself, and checks the length of each conversion.
40280
40281
40282
40283 .section "Use of strcat() and strcpy()" "SECID281"
40284 These are used only in cases where the output buffer is known to be large
40285 enough to hold the result.
40286 .ecindex IIDsecurcon
40287
40288
40289
40290
40291 . ////////////////////////////////////////////////////////////////////////////
40292 . ////////////////////////////////////////////////////////////////////////////
40293
40294 .chapter "Format of spool files" "CHAPspool"
40295 .scindex IIDforspo1 "format" "spool files"
40296 .scindex IIDforspo2 "spool directory" "format of files"
40297 .scindex IIDforspo3 "spool files" "format of"
40298 .cindex "spool files" "editing"
40299 A message on Exim's queue consists of two files, whose names are the message id
40300 followed by -D and -H, respectively. The data portion of the message is kept in
40301 the -D file on its own. The message's envelope, status, and headers are all
40302 kept in the -H file, whose format is described in this chapter. Each of these
40303 two files contains the final component of its own name as its first line. This
40304 is insurance against disk crashes where the directory is lost but the files
40305 themselves are recoverable.
40306
40307 The file formats may be changed, or new formats added, at any release.
40308 Spool files are not intended as an interface to other programs
40309 and should not be used as such.
40310
40311 Some people are tempted into editing -D files in order to modify messages. You
40312 need to be extremely careful if you do this; it is not recommended and you are
40313 on your own if you do it. Here are some of the pitfalls:
40314
40315 .ilist
40316 You must ensure that Exim does not try to deliver the message while you are
40317 fiddling with it. The safest way is to take out a write lock on the -D file,
40318 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40319 place, the lock will be retained. If you write a new file and rename it, the
40320 lock will be lost at the instant of rename.
40321 .next
40322 .vindex "&$body_linecount$&"
40323 If you change the number of lines in the file, the value of
40324 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40325 cause incomplete transmission of messages or undeliverable messages.
40326 .next
40327 If the message is in MIME format, you must take care not to break it.
40328 .next
40329 If the message is cryptographically signed, any change will invalidate the
40330 signature.
40331 .endlist
40332 All in all, modifying -D files is fraught with danger.
40333
40334 Files whose names end with -J may also be seen in the &_input_& directory (or
40335 its subdirectories when &%split_spool_directory%& is set). These are journal
40336 files, used to record addresses to which the message has been delivered during
40337 the course of a delivery attempt. If there are still undelivered recipients at
40338 the end, the -H file is updated, and the -J file is deleted. If, however, there
40339 is some kind of crash (for example, a power outage) before this happens, the -J
40340 file remains in existence. When Exim next processes the message, it notices the
40341 -J file and uses it to update the -H file before starting the next delivery
40342 attempt.
40343
40344 Files whose names end with -K or .eml may also be seen in the spool.
40345 These are temporaries used for DKIM or malware processing, when that is used.
40346 They should be tidied up by normal operations; any old ones are probably
40347 relics of crashes and can be removed.
40348
40349 .section "Format of the -H file" "SECID282"
40350 .cindex "uid (user id)" "in spool file"
40351 .cindex "gid (group id)" "in spool file"
40352 The second line of the -H file contains the login name for the uid of the
40353 process that called Exim to read the message, followed by the numerical uid and
40354 gid. For a locally generated message, this is normally the user who sent the
40355 message. For a message received over TCP/IP via the daemon, it is
40356 normally the Exim user.
40357
40358 The third line of the file contains the address of the message's sender as
40359 transmitted in the envelope, contained in angle brackets. The sender address is
40360 empty for bounce messages. For incoming SMTP mail, the sender address is given
40361 in the MAIL command. For locally generated mail, the sender address is
40362 created by Exim from the login name of the current user and the configured
40363 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40364 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40365 &"<>"& or an address that matches &%untrusted_set_senders%&.
40366
40367 The fourth line contains two numbers. The first is the time that the message
40368 was received, in the conventional Unix form &-- the number of seconds since the
40369 start of the epoch. The second number is a count of the number of messages
40370 warning of delayed delivery that have been sent to the sender.
40371
40372 There follow a number of lines starting with a hyphen. These can appear in any
40373 order, and are omitted when not relevant:
40374
40375 .vlist
40376 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40377 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40378 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40379 recognized, to provide backward compatibility. In the old format, a line of
40380 this form is present for every ACL variable that is not empty. The number
40381 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40382 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40383 the data string for the variable. The string itself starts at the beginning of
40384 the next line, and is followed by a newline character. It may contain internal
40385 newlines.
40386
40387 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40388 A line of this form is present for every ACL connection variable that is
40389 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40390 The length is the length of the data string for the variable. The string itself
40391 starts at the beginning of the next line, and is followed by a newline
40392 character. It may contain internal newlines.
40393
40394 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40395 A line of this form is present for every ACL message variable that is defined.
40396 Note that there is a space between &%-aclm%& and the rest of the name. The
40397 length is the length of the data string for the variable. The string itself
40398 starts at the beginning of the next line, and is followed by a newline
40399 character. It may contain internal newlines.
40400
40401 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40402 This is present if, when the message was received over SMTP, the value of
40403 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40404
40405 .vitem &%-allow_unqualified_recipient%&
40406 This is present if unqualified recipient addresses are permitted in header
40407 lines (to stop such addresses from being qualified if rewriting occurs at
40408 transport time). Local messages that were input using &%-bnq%& and remote
40409 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40410
40411 .vitem &%-allow_unqualified_sender%&
40412 This is present if unqualified sender addresses are permitted in header lines
40413 (to stop such addresses from being qualified if rewriting occurs at transport
40414 time). Local messages that were input using &%-bnq%& and remote messages from
40415 hosts that match &%sender_unqualified_hosts%& set this flag.
40416
40417 .vitem "&%-auth_id%&&~<&'text'&>"
40418 The id information for a message received on an authenticated SMTP connection
40419 &-- the value of the &$authenticated_id$& variable.
40420
40421 .vitem "&%-auth_sender%&&~<&'address'&>"
40422 The address of an authenticated sender &-- the value of the
40423 &$authenticated_sender$& variable.
40424
40425 .vitem "&%-body_linecount%&&~<&'number'&>"
40426 This records the number of lines in the body of the message, and is
40427 present unless &%-spool_file_wireformat%& is.
40428
40429 .vitem "&%-body_zerocount%&&~<&'number'&>"
40430 This records the number of binary zero bytes in the body of the message, and is
40431 present if the number is greater than zero.
40432
40433 .vitem &%-deliver_firsttime%&
40434 This is written when a new message is first added to the spool. When the spool
40435 file is updated after a deferral, it is omitted.
40436
40437 .vitem "&%-frozen%&&~<&'time'&>"
40438 .cindex "frozen messages" "spool data"
40439 The message is frozen, and the freezing happened at <&'time'&>.
40440
40441 .vitem "&%-helo_name%&&~<&'text'&>"
40442 This records the host name as specified by a remote host in a HELO or EHLO
40443 command.
40444
40445 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40446 This records the IP address of the host from which the message was received and
40447 the remote port number that was used. It is omitted for locally generated
40448 messages.
40449
40450 .vitem "&%-host_auth%&&~<&'text'&>"
40451 If the message was received on an authenticated SMTP connection, this records
40452 the name of the authenticator &-- the value of the
40453 &$sender_host_authenticated$& variable.
40454
40455 .vitem &%-host_lookup_failed%&
40456 This is present if an attempt to look up the sending host's name from its IP
40457 address failed. It corresponds to the &$host_lookup_failed$& variable.
40458
40459 .vitem "&%-host_name%&&~<&'text'&>"
40460 .cindex "reverse DNS lookup"
40461 .cindex "DNS" "reverse lookup"
40462 This records the name of the remote host from which the message was received,
40463 if the host name was looked up from the IP address when the message was being
40464 received. It is not present if no reverse lookup was done.
40465
40466 .vitem "&%-ident%&&~<&'text'&>"
40467 For locally submitted messages, this records the login of the originating user,
40468 unless it was a trusted user and the &%-oMt%& option was used to specify an
40469 ident value. For messages received over TCP/IP, this records the ident string
40470 supplied by the remote host, if any.
40471
40472 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40473 This records the IP address of the local interface and the port number through
40474 which a message was received from a remote host. It is omitted for locally
40475 generated messages.
40476
40477 .vitem &%-local%&
40478 The message is from a local sender.
40479
40480 .vitem &%-localerror%&
40481 The message is a locally-generated bounce message.
40482
40483 .vitem "&%-local_scan%&&~<&'string'&>"
40484 This records the data string that was returned by the &[local_scan()]& function
40485 when the message was received &-- the value of the &$local_scan_data$&
40486 variable. It is omitted if no data was returned.
40487
40488 .vitem &%-manual_thaw%&
40489 The message was frozen but has been thawed manually, that is, by an explicit
40490 Exim command rather than via the auto-thaw process.
40491
40492 .vitem &%-N%&
40493 A testing delivery process was started using the &%-N%& option to suppress any
40494 actual deliveries, but delivery was deferred. At any further delivery attempts,
40495 &%-N%& is assumed.
40496
40497 .vitem &%-received_protocol%&
40498 This records the value of the &$received_protocol$& variable, which contains
40499 the name of the protocol by which the message was received.
40500
40501 .vitem &%-sender_set_untrusted%&
40502 The envelope sender of this message was set by an untrusted local caller (used
40503 to ensure that the caller is displayed in queue listings).
40504
40505 .vitem "&%-spam_score_int%&&~<&'number'&>"
40506 If a message was scanned by SpamAssassin, this is present. It records the value
40507 of &$spam_score_int$&.
40508
40509 .vitem &%-spool_file_wireformat%&
40510 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40511 rather than Unix-format.
40512 The line-ending is CRLF rather than newline.
40513 There is still, however, no leading-dot-stuffing.
40514
40515 .vitem &%-tls_certificate_verified%&
40516 A TLS certificate was received from the client that sent this message, and the
40517 certificate was verified by the server.
40518
40519 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40520 When the message was received over an encrypted connection, this records the
40521 name of the cipher suite that was used.
40522
40523 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40524 When the message was received over an encrypted connection, and a certificate
40525 was received from the client, this records the Distinguished Name from that
40526 certificate.
40527 .endlist
40528
40529 Any of the above may have an extra hyphen prepended, to indicate the the
40530 corresponding data is untrusted.
40531
40532 Following the options there is a list of those addresses to which the message
40533 is not to be delivered. This set of addresses is initialized from the command
40534 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40535 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40536 the address is added to this set. The addresses are kept internally as a
40537 balanced binary tree, and it is a representation of that tree which is written
40538 to the spool file. If an address is expanded via an alias or forward file, the
40539 original address is added to the tree when deliveries to all its child
40540 addresses are complete.
40541
40542 If the tree is empty, there is a single line in the spool file containing just
40543 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40544 Y or N, followed by an address. The address is the value for the node of the
40545 tree, and the letters indicate whether the node has a left branch and/or a
40546 right branch attached to it, respectively. If branches exist, they immediately
40547 follow. Here is an example of a three-node tree:
40548 .code
40549 YY darcy@austen.fict.example
40550 NN alice@wonderland.fict.example
40551 NN editor@thesaurus.ref.example
40552 .endd
40553 After the non-recipients tree, there is a list of the message's recipients.
40554 This is a simple list, preceded by a count. It includes all the original
40555 recipients of the message, including those to whom the message has already been
40556 delivered. In the simplest case, the list contains one address per line. For
40557 example:
40558 .code
40559 4
40560 editor@thesaurus.ref.example
40561 darcy@austen.fict.example
40562 rdo@foundation
40563 alice@wonderland.fict.example
40564 .endd
40565 However, when a child address has been added to the top-level addresses as a
40566 result of the use of the &%one_time%& option on a &(redirect)& router, each
40567 line is of the following form:
40568 .display
40569 <&'top-level address'&> <&'errors_to address'&> &&&
40570   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40571 .endd
40572 The 01 flag bit indicates the presence of the three other fields that follow
40573 the top-level address. Other bits may be used in future to support additional
40574 fields. The <&'parent number'&> is the offset in the recipients list of the
40575 original parent of the &"one time"& address. The first two fields are the
40576 envelope sender that is associated with this address and its length. If the
40577 length is zero, there is no special envelope sender (there are then two space
40578 characters in the line). A non-empty field can arise from a &(redirect)& router
40579 that has an &%errors_to%& setting.
40580
40581
40582 A blank line separates the envelope and status information from the headers
40583 which follow. A header may occupy several lines of the file, and to save effort
40584 when reading it in, each header is preceded by a number and an identifying
40585 character. The number is the number of characters in the header, including any
40586 embedded newlines and the terminating newline. The character is one of the
40587 following:
40588
40589 .table2 50pt
40590 .row <&'blank'&>         "header in which Exim has no special interest"
40591 .row &`B`&               "&'Bcc:'& header"
40592 .row &`C`&               "&'Cc:'& header"
40593 .row &`F`&               "&'From:'& header"
40594 .row &`I`&               "&'Message-id:'& header"
40595 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40596 .row &`R`&               "&'Reply-To:'& header"
40597 .row &`S`&               "&'Sender:'& header"
40598 .row &`T`&               "&'To:'& header"
40599 .row &`*`&               "replaced or deleted header"
40600 .endtable
40601
40602 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40603 purposes. They are not transmitted when the message is delivered. Here is a
40604 typical set of headers:
40605 .code
40606 111P Received: by hobbit.fict.example with local (Exim 4.00)
40607 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40608 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40609 038* X-rewrote-sender: bb@hobbit.fict.example
40610 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40611 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40612 099* To: alice@wonderland.fict.example, rdo@foundation,
40613 darcy@austen.fict.example, editor@thesaurus.ref.example
40614 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40615 darcy@austen.fict.example, editor@thesaurus.ref.example
40616 038  Date: Fri, 11 May 2001 10:28:59 +0100
40617 .endd
40618 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40619 &'To:'& header have been rewritten, the last one because routing expanded the
40620 unqualified domain &'foundation'&.
40621 .ecindex IIDforspo1
40622 .ecindex IIDforspo2
40623 .ecindex IIDforspo3
40624
40625 .section "Format of the -D file" "SECID282a"
40626 The data file is traditionally in Unix-standard format: lines are ended with
40627 an ASCII newline character.
40628 However, when the &%spool_wireformat%& main option is used some -D files
40629 can have an alternate format.
40630 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40631 The -D file lines (not including the first name-component line) are
40632 suitable for direct copying to the wire when transmitting using the
40633 ESMTP CHUNKING option, meaning lower processing overhead.
40634 Lines are terminated with an ASCII CRLF pair.
40635 There is no dot-stuffing (and no dot-termination).
40636
40637 . ////////////////////////////////////////////////////////////////////////////
40638 . ////////////////////////////////////////////////////////////////////////////
40639
40640 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
40641          "DKIM, SPF, SRS and DMARC Support"
40642
40643 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40644 .cindex "DKIM"
40645
40646 DKIM is a mechanism by which messages sent by some entity can be provably
40647 linked to a domain which that entity controls.  It permits reputation to
40648 be tracked on a per-domain basis, rather than merely upon source IP address.
40649 DKIM is documented in RFC 6376.
40650
40651 As DKIM relies on the message being unchanged in transit, messages handled
40652 by a mailing-list (which traditionally adds to the message) will not match
40653 any original DKIM signature.
40654
40655 DKIM support is compiled into Exim by default if TLS support is present.
40656 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40657
40658 Exim's DKIM implementation allows for
40659 .olist
40660 Signing outgoing messages: This function is implemented in the SMTP transport.
40661 It can co-exist with all other Exim features
40662 (including transport filters)
40663 except cutthrough delivery.
40664 .next
40665 Verifying signatures in incoming messages: This is implemented by an additional
40666 ACL (acl_smtp_dkim), which can be called several times per message, with
40667 different signature contexts.
40668 .endlist
40669
40670 In typical Exim style, the verification implementation does not include any
40671 default "policy". Instead it enables you to build your own policy using
40672 Exim's standard controls.
40673
40674 Please note that verification of DKIM signatures in incoming mail is turned
40675 on by default for logging (in the <= line) purposes.
40676
40677 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40678 When set, for each signature in incoming email,
40679 exim will log a line displaying the most important signature details, and the
40680 signature status. Here is an example (with line-breaks added for clarity):
40681 .code
40682 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40683     d=facebookmail.com s=q1-2009b
40684     c=relaxed/relaxed a=rsa-sha1
40685     i=@facebookmail.com t=1252484542 [verification succeeded]
40686 .endd
40687
40688 You might want to turn off DKIM verification processing entirely for internal
40689 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40690 control modifier. This should typically be done in the RCPT ACL, at points
40691 where you accept mail from relay sources (internal hosts or authenticated
40692 senders).
40693
40694
40695 .section "Signing outgoing messages" "SECDKIMSIGN"
40696 .cindex "DKIM" "signing"
40697
40698 For signing to be usable you must have published a DKIM record in DNS.
40699 Note that RFC 8301 (which does not cover EC keys) says:
40700 .code
40701 rsa-sha1 MUST NOT be used for signing or verifying.
40702
40703 Signers MUST use RSA keys of at least 1024 bits for all keys.
40704 Signers SHOULD use RSA keys of at least 2048 bits.
40705 .endd
40706
40707 Note also that the key content (the 'p=' field)
40708 in the DNS record is different between RSA and EC keys;
40709 for the former it is the base64 of the ASN.1 for the RSA public key
40710 (equivalent to the private-key .pem with the header/trailer stripped)
40711 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40712
40713 Signing is enabled by setting private options on the SMTP transport.
40714 These options take (expandable) strings as arguments.
40715
40716 .option dkim_domain smtp string list&!! unset
40717 The domain(s) you want to sign with.
40718 After expansion, this can be a list.
40719 Each element in turn,
40720 lowercased,
40721 is put into the &%$dkim_domain%& expansion variable
40722 while expanding the remaining signing options.
40723 If it is empty after expansion, DKIM signing is not done,
40724 and no error will result even if &%dkim_strict%& is set.
40725
40726 .option dkim_selector smtp string list&!! unset
40727 This sets the key selector string.
40728 After expansion, which can use &$dkim_domain$&, this can be a list.
40729 Each element in turn is put in the expansion
40730 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40731 option along with &%$dkim_domain%&.
40732 If the option is empty after expansion, DKIM signing is not done for this domain,
40733 and no error will result even if &%dkim_strict%& is set.
40734
40735 .option dkim_private_key smtp string&!! unset
40736 This sets the private key to use.
40737 You can use the &%$dkim_domain%& and
40738 &%$dkim_selector%& expansion variables to determine the private key to use.
40739 The result can either
40740 .ilist
40741 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40742 .next
40743 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40744 be a valid Ed25519 private key (same format as above)
40745 .next
40746 start with a slash, in which case it is treated as a file that contains
40747 the private key
40748 .next
40749 be "0", "false" or the empty string, in which case the message will not
40750 be signed. This case will not result in an error, even if &%dkim_strict%&
40751 is set.
40752 .endlist
40753
40754 To generate keys under OpenSSL:
40755 .code
40756 openssl genrsa -out dkim_rsa.private 2048
40757 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40758 .endd
40759 The result file from the first command should be retained, and
40760 this option set to use it.
40761 Take the base-64 lines from the output of the second command, concatenated,
40762 for the DNS TXT record.
40763 See section 3.6 of RFC6376 for the record specification.
40764
40765 Under GnuTLS:
40766 .code
40767 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40768 certtool --load-privkey=dkim_rsa.private --pubkey-info
40769 .endd
40770
40771 Note that RFC 8301 says:
40772 .code
40773 Signers MUST use RSA keys of at least 1024 bits for all keys.
40774 Signers SHOULD use RSA keys of at least 2048 bits.
40775 .endd
40776
40777 EC keys for DKIM are defined by RFC 8463.
40778 They are considerably smaller than RSA keys for equivalent protection.
40779 As they are a recent development, users should consider dual-signing
40780 (by setting a list of selectors, and an expansion for this option)
40781 for some transition period.
40782 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40783 for EC keys.
40784
40785 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40786 .code
40787 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40788 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40789 .endd
40790
40791 To produce the required public key value for a DNS record:
40792 .code
40793 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40794 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40795 .endd
40796
40797 Exim also supports an alternate format
40798 of Ed25519 keys in DNS which was a candidate during development
40799 of the standard, but not adopted.
40800 A future release will probably drop that support.
40801
40802 .option dkim_hash smtp string&!! sha256
40803 Can be set to any one of the supported hash methods, which are:
40804 .ilist
40805 &`sha1`& &-- should not be used, is old and insecure
40806 .next
40807 &`sha256`& &-- the default
40808 .next
40809 &`sha512`& &-- possibly more secure but less well supported
40810 .endlist
40811
40812 Note that RFC 8301 says:
40813 .code
40814 rsa-sha1 MUST NOT be used for signing or verifying.
40815 .endd
40816
40817 .option dkim_identity smtp string&!! unset
40818 If set after expansion, the value is used to set an "i=" tag in
40819 the signing header.  The DKIM standards restrict the permissible
40820 syntax of this optional tag to a mail address, with possibly-empty
40821 local part, an @, and a domain identical to or subdomain of the "d="
40822 tag value.  Note that Exim does not check the value.
40823
40824 .option dkim_canon smtp string&!! unset
40825 This option sets the canonicalization method used when signing a message.
40826 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40827 The option defaults to "relaxed" when unset. Note: the current implementation
40828 only supports signing with the same canonicalization method for both headers and body.
40829
40830 .option dkim_strict smtp string&!! unset
40831 This  option  defines  how  Exim  behaves  when  signing a message that
40832 should be signed fails for some reason.  When the expansion evaluates to
40833 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
40834 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40835 variables here.
40836
40837 .option dkim_sign_headers smtp string&!! "see below"
40838 If set, this option must expand to a colon-separated
40839 list of header names.
40840 Headers with these names, or the absence or such a header, will be included
40841 in the message signature.
40842 When unspecified, the header names listed in RFC4871 will be used,
40843 whether or not each header is present in the message.
40844 The default list is available for the expansion in the macro
40845 &"_DKIM_SIGN_HEADERS"&
40846 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
40847
40848 If a name is repeated, multiple headers by that name (or the absence thereof)
40849 will be signed.  The textually later headers in the headers part of the
40850 message are signed first, if there are multiples.
40851
40852 A name can be prefixed with either an &"="& or a &"+"& character.
40853 If an &"="& prefix is used, all headers that are present with this name
40854 will be signed.
40855 If a &"+"& prefix if used, all headers that are present with this name
40856 will be signed, and one signature added for a missing header with the
40857 name will be appended.
40858
40859 .option dkim_timestamps smtp integer&!! unset
40860 This option controls the inclusion of timestamp information in the signature.
40861 If not set, no such information will be included.
40862 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40863 for the expiry tag
40864 (eg. 1209600 for two weeks);
40865 both creation (t=) and expiry (x=) tags will be included.
40866
40867 RFC 6376 lists these tags as RECOMMENDED.
40868
40869
40870 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40871 .cindex "DKIM" "verification"
40872
40873 Verification of DKIM signatures in SMTP incoming email is done for all
40874 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40875 .cindex DKIM "selecting signature algorithms"
40876 Individual classes of signature algorithm can be ignored by changing
40877 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40878 The &%dkim_verify_minimal%& option can be set to cease verification
40879 processing for a message once the first passing signature is found.
40880
40881 .cindex authentication "expansion item"
40882 Performing verification sets up information used by the
40883 &%authresults%& expansion item.
40884
40885 For most purposes the default option settings suffice and the remainder
40886 of this section can be ignored.
40887
40888 The results of verification are made available to the
40889 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40890 A missing ACL definition defaults to accept.
40891 By default, the ACL is called once for each
40892 syntactically(!) correct signature in the incoming message.
40893 If any ACL call does not accept, the message is not accepted.
40894 If a cutthrough delivery was in progress for the message, that is
40895 summarily dropped (having wasted the transmission effort).
40896
40897 To evaluate the verification result in the ACL
40898 a large number of expansion variables
40899 containing the signature status and its details are set up during the
40900 runtime of the ACL.
40901
40902 Calling the ACL only for existing signatures is not sufficient to build
40903 more advanced policies. For that reason, the main option
40904 &%dkim_verify_signers%&, and an expansion variable
40905 &%$dkim_signers%& exist.
40906
40907 The main option &%dkim_verify_signers%& can be set to a colon-separated
40908 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40909 called. It is expanded when the message has been received. At this point,
40910 the expansion variable &%$dkim_signers%& already contains a colon-separated
40911 list of signer domains and identities for the message. When
40912 &%dkim_verify_signers%& is not specified in the main configuration,
40913 it defaults as:
40914 .code
40915 dkim_verify_signers = $dkim_signers
40916 .endd
40917 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40918 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40919 call the ACL for known domains or identities. This would be achieved as follows:
40920 .code
40921 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40922 .endd
40923 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40924 and "ebay.com", plus all domains and identities that have signatures in the message.
40925 You can also be more creative in constructing your policy. For example:
40926 .code
40927 dkim_verify_signers = $sender_address_domain:$dkim_signers
40928 .endd
40929
40930 If a domain or identity is listed several times in the (expanded) value of
40931 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40932
40933 Note that if the option is set using untrustworthy data
40934 (such as the From: header)
40935 care should be taken to force lowercase for domains
40936 and for the domain part if identities.
40937 The default setting can be regarded as trustworthy in this respect.
40938
40939 If multiple signatures match a domain (or identity), the ACL is called once
40940 for each matching signature.
40941
40942
40943 Inside the DKIM ACL, the following expansion variables are
40944 available (from most to least important):
40945
40946
40947 .vlist
40948 .vitem &%$dkim_cur_signer%&
40949 The signer that is being evaluated in this ACL run. This can be a domain or
40950 an identity. This is one of the list items from the expanded main option
40951 &%dkim_verify_signers%& (see above).
40952
40953 .vitem &%$dkim_verify_status%&
40954 Within the DKIM ACL,
40955 a string describing the general status of the signature. One of
40956 .ilist
40957 &%none%&: There is no signature in the message for the current domain or
40958 identity (as reflected by &%$dkim_cur_signer%&).
40959 .next
40960 &%invalid%&: The signature could not be verified due to a processing error.
40961 More detail is available in &%$dkim_verify_reason%&.
40962 .next
40963 &%fail%&: Verification of the signature failed.  More detail is
40964 available in &%$dkim_verify_reason%&.
40965 .next
40966 &%pass%&: The signature passed verification. It is valid.
40967 .endlist
40968
40969 This variable can be overwritten using an ACL 'set' modifier.
40970 This might, for instance, be done to enforce a policy restriction on
40971 hash-method or key-size:
40972 .code
40973   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40974        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40975        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40976                                   {< {$dkim_key_length}{1024}}}}
40977        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40978        set dkim_verify_status = fail
40979        set dkim_verify_reason = hash too weak or key too short
40980 .endd
40981
40982 So long as a DKIM ACL is defined (it need do no more than accept),
40983 after all the DKIM ACL runs have completed, the value becomes a
40984 colon-separated list of the values after each run.
40985 This is maintained for the mime, prdr and data ACLs.
40986
40987 .vitem &%$dkim_verify_reason%&
40988 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40989 "fail" or "invalid". One of
40990 .ilist
40991 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40992 key for the domain could not be retrieved. This may be a temporary problem.
40993 .next
40994 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40995 record for the domain is syntactically invalid.
40996 .next
40997 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40998 body hash does not match the one specified in the signature header. This
40999 means that the message body was modified in transit.
41000 .next
41001 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41002 could not be verified. This may mean that headers were modified,
41003 re-written or otherwise changed in a way which is incompatible with
41004 DKIM verification. It may of course also mean that the signature is forged.
41005 .endlist
41006
41007 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41008
41009 .vitem &%$dkim_domain%&
41010 The signing domain. IMPORTANT: This variable is only populated if there is
41011 an actual signature in the message for the current domain or identity (as
41012 reflected by &%$dkim_cur_signer%&).
41013
41014 .vitem &%$dkim_identity%&
41015 The signing identity, if present. IMPORTANT: This variable is only populated
41016 if there is an actual signature in the message for the current domain or
41017 identity (as reflected by &%$dkim_cur_signer%&).
41018
41019 .vitem &%$dkim_selector%&
41020 The key record selector string.
41021
41022 .vitem &%$dkim_algo%&
41023 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41024 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41025 may also be 'ed25519-sha256'.
41026 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41027 for EC keys.
41028
41029 Note that RFC 8301 says:
41030 .code
41031 rsa-sha1 MUST NOT be used for signing or verifying.
41032
41033 DKIM signatures identified as having been signed with historic
41034 algorithms (currently, rsa-sha1) have permanently failed evaluation
41035 .endd
41036
41037 To enforce this you must either have a DKIM ACL which checks this variable
41038 and overwrites the &$dkim_verify_status$& variable as discussed above,
41039 or have set the main option &%dkim_verify_hashes%& to exclude
41040 processing of such signatures.
41041
41042 .vitem &%$dkim_canon_body%&
41043 The body canonicalization method. One of 'relaxed' or 'simple'.
41044
41045 .vitem &%$dkim_canon_headers%&
41046 The header canonicalization method. One of 'relaxed' or 'simple'.
41047
41048 .vitem &%$dkim_copiedheaders%&
41049 A transcript of headers and their values which are included in the signature
41050 (copied from the 'z=' tag of the signature).
41051 Note that RFC6376 requires that verification fail if the From: header is
41052 not included in the signature.  Exim does not enforce this; sites wishing
41053 strict enforcement should code the check explicitly.
41054
41055 .vitem &%$dkim_bodylength%&
41056 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41057 limit was set by the signer, "9999999999999" is returned. This makes sure
41058 that this variable always expands to an integer value.
41059 &*Note:*& The presence of the signature tag specifying a signing body length
41060 is one possible route to spoofing of valid DKIM signatures.
41061 A paranoid implementation might wish to regard signature where this variable
41062 shows less than the "no limit" return as being invalid.
41063
41064 .vitem &%$dkim_created%&
41065 UNIX timestamp reflecting the date and time when the signature was created.
41066 When this was not specified by the signer, "0" is returned.
41067
41068 .vitem &%$dkim_expires%&
41069 UNIX timestamp reflecting the date and time when the signer wants the
41070 signature to be treated as "expired". When this was not specified by the
41071 signer, "9999999999999" is returned. This makes it possible to do useful
41072 integer size comparisons against this value.
41073 Note that Exim does not check this value.
41074
41075 .vitem &%$dkim_headernames%&
41076 A colon-separated list of names of headers included in the signature.
41077
41078 .vitem &%$dkim_key_testing%&
41079 "1" if the key record has the "testing" flag set, "0" if not.
41080
41081 .vitem &%$dkim_key_nosubdomains%&
41082 "1" if the key record forbids subdomaining, "0" otherwise.
41083
41084 .vitem &%$dkim_key_srvtype%&
41085 Service type (tag s=) from the key record. Defaults to "*" if not specified
41086 in the key record.
41087
41088 .vitem &%$dkim_key_granularity%&
41089 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41090 in the key record.
41091
41092 .vitem &%$dkim_key_notes%&
41093 Notes from the key record (tag n=).
41094
41095 .vitem &%$dkim_key_length%&
41096 Number of bits in the key.
41097 Valid only once the key is loaded, which is at the time the header signature
41098 is verified, which is after the body hash is.
41099
41100 Note that RFC 8301 says:
41101 .code
41102 Verifiers MUST NOT consider signatures using RSA keys of
41103 less than 1024 bits as valid signatures.
41104 .endd
41105
41106 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41107 option.
41108
41109 .endlist
41110
41111 In addition, two ACL conditions are provided:
41112
41113 .vlist
41114 .vitem &%dkim_signers%&
41115 ACL condition that checks a colon-separated list of domains or identities
41116 for a match against the domain or identity that the ACL is currently verifying
41117 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41118 verb to a group of domains or identities. For example:
41119
41120 .code
41121 # Warn when Mail purportedly from GMail has no gmail signature
41122 warn sender_domains = gmail.com
41123      dkim_signers = gmail.com
41124      dkim_status = none
41125      log_message = GMail sender without gmail.com DKIM signature
41126 .endd
41127
41128 Note that the above does not check for a total lack of DKIM signing;
41129 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41130
41131 .vitem &%dkim_status%&
41132 ACL condition that checks a colon-separated list of possible DKIM verification
41133 results against the actual result of verification. This is typically used
41134 to restrict an ACL verb to a list of verification outcomes, for example:
41135
41136 .code
41137 deny sender_domains = paypal.com:paypal.de
41138      dkim_signers = paypal.com:paypal.de
41139      dkim_status = none:invalid:fail
41140      message = Mail from Paypal with invalid/missing signature
41141 .endd
41142
41143 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41144 see the documentation of the &%$dkim_verify_status%& expansion variable above
41145 for more information of what they mean.
41146 .endlist
41147
41148
41149
41150
41151 .section "SPF (Sender Policy Framework)" SECSPF
41152 .cindex SPF verification
41153
41154 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41155 messages with its domain in the envelope from, documented by RFC 7208.
41156 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41157 the &url(http://openspf.org).
41158 . --- 2019-10-28: still not https, open-spf.org is told to be a
41159 . --- web-archive copy of the now dead openspf.org site
41160 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41161 . --- discussion.
41162
41163 Messages sent by a system not authorised will fail checking of such assertions.
41164 This includes retransmissions done by traditional forwarders.
41165
41166 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41167 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41168 &url(https://www.libspf2.org/).
41169 There is no Exim involvement in the transmission of messages;
41170 publishing certain DNS records is all that is required.
41171
41172 For verification, an ACL condition and an expansion lookup are provided.
41173 .cindex authentication "expansion item"
41174 Performing verification sets up information used by the
41175 &%authresults%& expansion item.
41176
41177
41178 .cindex SPF "ACL condition"
41179 .cindex ACL "spf condition"
41180 The ACL condition "spf" can be used at or after the MAIL ACL.
41181 It takes as an argument a list of strings giving the outcome of the SPF check,
41182 and will succeed for any matching outcome.
41183 Valid strings are:
41184 .vlist
41185 .vitem &%pass%&
41186 The SPF check passed, the sending host is positively verified by SPF.
41187
41188 .vitem &%fail%&
41189 The SPF check failed, the sending host is NOT allowed to send mail for the
41190 domain in the envelope-from address.
41191
41192 .vitem &%softfail%&
41193 The SPF check failed, but the queried domain can't absolutely confirm that this
41194 is a forgery.
41195
41196 .vitem &%none%&
41197 The queried domain does not publish SPF records.
41198
41199 .vitem &%neutral%&
41200 The SPF check returned a "neutral" state.  This means the queried domain has
41201 published a SPF record, but wants to allow outside servers to send mail under
41202 its domain as well.  This should be treated like "none".
41203
41204 .vitem &%permerror%&
41205 This indicates a syntax error in the SPF record of the queried domain.
41206 You may deny messages when this occurs.
41207
41208 .vitem &%temperror%&
41209 This indicates a temporary error during all processing, including Exim's
41210 SPF processing.  You may defer messages when this occurs.
41211 .endlist
41212
41213 You can prefix each string with an exclamation mark to  invert
41214 its meaning,  for example  "!fail" will  match all  results but
41215 "fail".  The  string  list is  evaluated  left-to-right,  in a
41216 short-circuit fashion.
41217
41218 Example:
41219 .code
41220 deny spf = fail
41221      message = $sender_host_address is not allowed to send mail from \
41222                ${if def:sender_address_domain \
41223                     {$sender_address_domain}{$sender_helo_name}}.  \
41224                Please see http://www.open-spf.org/Why;\
41225                identity=${if def:sender_address_domain \
41226                              {$sender_address}{$sender_helo_name}};\
41227                ip=$sender_host_address
41228 .endd
41229
41230 Note: The above mentioned URL may not be as helpful as expected. You are
41231 encouraged to replace the link with a link to a site with more
41232 explanations.
41233
41234 When the spf condition has run, it sets up several expansion
41235 variables:
41236
41237 .cindex SPF "verification variables"
41238 .vlist
41239 .vitem &$spf_header_comment$&
41240 .vindex &$spf_header_comment$&
41241   This contains a human-readable string describing the outcome
41242   of the SPF check. You can add it to a custom header or use
41243   it for logging purposes.
41244
41245 .vitem &$spf_received$&
41246 .vindex &$spf_received$&
41247   This contains a complete Received-SPF: header that can be
41248   added to the message. Please note that according to the SPF
41249   draft, this header must be added at the top of the header
41250   list. Please see section 10 on how you can do this.
41251
41252   Note: in case of "Best-guess" (see below), the convention is
41253   to put this string in a header called X-SPF-Guess: instead.
41254
41255 .vitem &$spf_result$&
41256 .vindex &$spf_result$&
41257   This contains the outcome of the SPF check in string form,
41258   one of pass, fail, softfail, none, neutral, permerror or
41259   temperror.
41260
41261 .vitem &$spf_result_guessed$&
41262 .vindex &$spf_result_guessed$&
41263   This boolean is true only if a best-guess operation was used
41264   and required in order to obtain a result.
41265
41266 .vitem &$spf_smtp_comment$&
41267 .vindex &$spf_smtp_comment$&
41268 .vindex &%spf_smtp_comment_template%&
41269   This contains a string that can be used in a SMTP response
41270   to the calling party. Useful for "fail".
41271   The string is generated by the SPF library from the template configured in the main config
41272   option &%spf_smtp_comment_template%&.
41273 .endlist
41274
41275
41276 .cindex SPF "ACL condition"
41277 .cindex ACL "spf_guess condition"
41278 .cindex SPF "best guess"
41279 In addition to SPF, you can also perform checks for so-called
41280 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41281 SPF, but it is supported by the same framework that enables SPF
41282 capability.
41283 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41284 for a description of what it means.
41285 . --- 2019-10-28: still not https:
41286
41287 To access this feature, simply use the spf_guess condition in place
41288 of the spf one.  For example:
41289
41290 .code
41291 deny spf_guess = fail
41292      message = $sender_host_address doesn't look trustworthy to me
41293 .endd
41294
41295 In case you decide to reject messages based on this check, you
41296 should note that although it uses the same framework, "Best-guess"
41297 is not SPF, and therefore you should not mention SPF at all in your
41298 reject message.
41299
41300 When the spf_guess condition has run, it sets up the same expansion
41301 variables as when spf condition is run, described above.
41302
41303 Additionally, since Best-guess is not standardized, you may redefine
41304 what "Best-guess" means to you by redefining the main configuration
41305 &%spf_guess%& option.
41306 For example, the following:
41307
41308 .code
41309 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41310 .endd
41311
41312 would relax host matching rules to a broader network range.
41313
41314
41315 .cindex SPF "lookup expansion"
41316 .cindex lookup spf
41317 A lookup expansion is also available. It takes an email
41318 address as the key and an IP address
41319 (v4 or v6)
41320 as the database:
41321
41322 .code
41323   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41324 .endd
41325
41326 The lookup will return the same result strings as can appear in
41327 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41328
41329
41330
41331
41332
41333 .section "SRS (Sender Rewriting Scheme)" SECTSRS
41334 .cindex SRS "sender rewriting scheme"
41335
41336 .new
41337 SRS can be used to modify sender addresses when forwarding so that
41338 SPF verification does not object to them.
41339 It operates by encoding the original envelope sender in a new
41340 sender local part and using a domain run by the forwarding site
41341 as the new domain for the sender.  Any DSN message should be returned
41342 to this new sender at the forwarding site, which can extract the
41343 original sender from the coded local part and forward the DSN to
41344 the originator.
41345
41346 This is a way of avoiding the breakage that SPF does to forwarding.
41347 The constructed local-part will be longer than the original,
41348 leading to possible problems with very long addresses.
41349 The changing of the sender address also hinders the tracing of mail
41350 problems.
41351
41352 Exim can be built to include native SRS support.  To do this
41353 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
41354 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
41355 will be defined.
41356 The support is limited to SRS0-encoding; SRS1 is not supported.
41357
41358 .cindex SRS excoding
41359 To encode an address use this expansion item:
41360 .vlist
41361 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
41362 .cindex "&%srs_encode%& expansion item"
41363 .cindex SRS "expansion item"
41364 The first argument should be a secret known and used by all systems
41365 handling the recipient domain for the original message.
41366 There is no need to periodically change this key; a timestamp is also
41367 encoded.
41368 The second argument should be given as the envelope sender address before this
41369 encoding operation.
41370 The third argument should be the recipient domain of the message when
41371 it arrived at this system.
41372 .endlist
41373
41374 .cindex SRS decoding
41375 To decode an address use this expansion condition:
41376 .vlist
41377 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
41378 The first argument should be the recipient local prt as is was received.
41379 The second argument is the site secret.
41380
41381 If the messages is not for an SRS-encoded recipient the condition will
41382 return false.  If it is, the condition will return true and the variable
41383 &$srs_recipient$& will be set to the decoded (original) value.
41384 .endlist
41385
41386 Example usage:
41387 .code
41388   #macro
41389   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
41390   
41391   #routers
41392
41393   outbound:
41394     driver =    dnslookup
41395     # if outbound, and forwarding has been done, use an alternate transport
41396     domains =   ! +my_domains
41397     transport = ${if eq {$local_part@$domain} \
41398                         {$original_local_part@$original_domain} \
41399                      {remote_smtp} {remote_forwarded_smtp}}
41400   
41401   inbound_srs:
41402     driver =    redirect
41403     senders =   :
41404     domains =   +my_domains
41405     # detect inbound bounces which are SRS'd, and decode them
41406     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
41407     data =      $srs_recipient
41408   
41409   inbound_srs_failure:
41410     driver =    redirect
41411     senders =   :
41412     domains =   +my_domains
41413     # detect inbound bounces which look SRS'd but are invalid
41414     condition = ${if inbound_srs {$local_part} {}}
41415     allow_fail
41416     data =      :fail: Invalid SRS recipient address
41417
41418   #... further routers here
41419
41420   
41421   # transport; should look like the non-forward outbound
41422   # one, plus the max_rcpt and return_path options
41423   remote_forwarded_smtp:
41424     driver =              smtp
41425     # modify the envelope from, for mails that we forward
41426     max_rcpt =            1
41427     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
41428 .endd
41429
41430
41431 .wen
41432
41433
41434
41435 .section DMARC SECDMARC
41436 .cindex DMARC verification
41437
41438 DMARC combines feedback from SPF, DKIM, and header From: in order
41439 to attempt to provide better indicators of the authenticity of an
41440 email.  This document does not explain the fundamentals; you
41441 should read and understand how it works by visiting the website at
41442 &url(http://www.dmarc.org/).
41443
41444 If Exim is built with DMARC support,
41445 the libopendmarc library is used.
41446
41447 For building Exim yourself, obtain the library from
41448 &url(http://sourceforge.net/projects/opendmarc/)
41449 to obtain a copy, or find it in your favorite package
41450 repository.  You will need to attend to the local/Makefile feature
41451 SUPPORT_DMARC and the associated LDFLAGS addition.
41452 This description assumes
41453 that headers will be in /usr/local/include, and that the libraries
41454 are in /usr/local/lib.
41455
41456 . subsection
41457
41458 There are three main-configuration options:
41459 .cindex DMARC "configuration options"
41460
41461 The &%dmarc_tld_file%& option
41462 .oindex &%dmarc_tld_file%&
41463 defines the location of a text file of valid
41464 top level domains the opendmarc library uses
41465 during domain parsing. Maintained by Mozilla,
41466 the most current version can be downloaded
41467 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41468 See also the util/renew-opendmarc-tlds.sh script.
41469 The default for the option is unset.
41470 If not set, DMARC processing is disabled.
41471
41472
41473 The &%dmarc_history_file%& option, if set
41474 .oindex &%dmarc_history_file%&
41475 defines the location of a file to log results
41476 of dmarc verification on inbound emails. The
41477 contents are importable by the opendmarc tools
41478 which will manage the data, send out DMARC
41479 reports, and expire the data. Make sure the
41480 directory of this file is writable by the user
41481 exim runs as.
41482 The default is unset.
41483
41484 The &%dmarc_forensic_sender%& option
41485 .oindex &%dmarc_forensic_sender%&
41486 defines an alternate email address to use when sending a
41487 forensic report detailing alignment failures
41488 if a sender domain's dmarc record specifies it
41489 and you have configured Exim to send them.
41490 If set, this is expanded and used for the
41491 From: header line; the address is extracted
41492 from it and used for the envelope from.
41493 If not set (the default), the From: header is expanded from
41494 the dsn_from option, and <> is used for the
41495 envelope from.
41496
41497 . I wish we had subsections...
41498
41499 .cindex DMARC controls
41500 By default, the DMARC processing will run for any remote,
41501 non-authenticated user.  It makes sense to only verify DMARC
41502 status of messages coming from remote, untrusted sources.  You can
41503 use standard conditions such as hosts, senders, etc, to decide that
41504 DMARC verification should *not* be performed for them and disable
41505 DMARC with an ACL control modifier:
41506 .code
41507   control = dmarc_disable_verify
41508 .endd
41509 A DMARC record can also specify a "forensic address", which gives
41510 exim an email address to submit reports about failed alignment.
41511 Exim does not do this by default because in certain conditions it
41512 results in unintended information leakage (what lists a user might
41513 be subscribed to, etc).  You must configure exim to submit forensic
41514 reports to the owner of the domain.  If the DMARC record contains a
41515 forensic address and you specify the control statement below, then
41516 exim will send these forensic emails.  It is also advised that you
41517 configure a &%dmarc_forensic_sender%& because the default sender address
41518 construction might be inadequate.
41519 .code
41520   control = dmarc_enable_forensic
41521 .endd
41522 (AGAIN: You can choose not to send these forensic reports by simply
41523 not putting the dmarc_enable_forensic control line at any point in
41524 your exim config.  If you don't tell exim to send them, it will not
41525 send them.)
41526
41527 There are no options to either control.  Both must appear before
41528 the DATA acl.
41529
41530 . subsection
41531
41532 DMARC checks cam be run on incoming SMTP  messages by using the
41533 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41534 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41535 condition.  Putting this condition in the ACLs is required in order
41536 for a DMARC check to actually occur.  All of the variables are set
41537 up before the DATA ACL, but there is no actual DMARC check that
41538 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41539
41540 The &"dmarc_status"& condition takes a list of strings on its
41541 right-hand side.  These strings describe recommended action based
41542 on the DMARC check.  To understand what the policy recommendations
41543 mean, refer to the DMARC website above.  Valid strings are:
41544 .display
41545 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41546 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41547 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41548 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41549 &'norecord    '& No policy section in the DMARC record for this sender domain.
41550 &'nofrom      '& Unable to determine the domain of the sender.
41551 &'temperror   '& Library error or dns error.
41552 &'off         '& The DMARC check was disabled for this email.
41553 .endd
41554 You can prefix each string with an exclamation mark to invert its
41555 meaning, for example "!accept" will match all results but
41556 "accept".  The string list is evaluated left-to-right in a
41557 short-circuit fashion.  When a string matches the outcome of the
41558 DMARC check, the condition succeeds.  If none of the listed
41559 strings matches the outcome of the DMARC check, the condition
41560 fails.
41561
41562 Of course, you can also use any other lookup method that Exim
41563 supports, including LDAP, Postgres, MySQL, etc, as long as the
41564 result is a list of colon-separated strings.
41565
41566 Performing the check sets up information used by the
41567 &%authresults%& expansion item.
41568
41569 Several expansion variables are set before the DATA ACL is
41570 processed, and you can use them in this ACL.  The following
41571 expansion variables are available:
41572
41573 .vlist
41574 .vitem &$dmarc_status$&
41575 .vindex &$dmarc_status$&
41576 .cindex DMARC result
41577 A one word status indicating what the DMARC library
41578 thinks of the email.  It is a combination of the results of
41579 DMARC record lookup and the SPF/DKIM/DMARC processing results
41580 (if a DMARC record was found).  The actual policy declared
41581 in the DMARC record is in a separate expansion variable.
41582
41583 .vitem &$dmarc_status_text$&
41584 .vindex &$dmarc_status_text$&
41585 Slightly longer, human readable status.
41586
41587 .vitem &$dmarc_used_domain$&
41588 .vindex &$dmarc_used_domain$&
41589 The domain which DMARC used to look up the DMARC policy record.
41590
41591 .vitem &$dmarc_domain_policy$&
41592 .vindex &$dmarc_domain_policy$&
41593 The policy declared in the DMARC record.  Valid values
41594 are "none", "reject" and "quarantine".  It is blank when there
41595 is any error, including no DMARC record.
41596 .endlist
41597
41598 . subsection
41599
41600 By default, Exim's DMARC configuration is intended to be
41601 non-intrusive and conservative.  To facilitate this, Exim will not
41602 create any type of logging files without explicit configuration by
41603 you, the admin.  Nor will Exim send out any emails/reports about
41604 DMARC issues without explicit configuration by you, the admin (other
41605 than typical bounce messages that may come about due to ACL
41606 processing or failure delivery issues).
41607
41608 In order to log statistics suitable to be imported by the opendmarc
41609 tools, you need to:
41610 .ilist
41611 Configure the global option &%dmarc_history_file%&
41612 .next
41613 Configure cron jobs to call the appropriate opendmarc history
41614 import scripts and truncating the dmarc_history_file
41615 .endlist
41616
41617 In order to send forensic reports, you need to:
41618 .ilist
41619 Configure the global option &%dmarc_forensic_sender%&
41620 .next
41621 Configure, somewhere before the DATA ACL, the control option to
41622 enable sending DMARC forensic reports
41623 .endlist
41624
41625 . subsection
41626
41627 Example usage:
41628 .code
41629 (RCPT ACL)
41630   warn    domains        = +local_domains
41631           hosts          = +local_hosts
41632           control        = dmarc_disable_verify
41633
41634   warn    !domains       = +screwed_up_dmarc_records
41635           control        = dmarc_enable_forensic
41636
41637   warn    condition      = (lookup if destined to mailing list)
41638           set acl_m_mailing_list = 1
41639
41640 (DATA ACL)
41641   warn    dmarc_status   = accept : none : off
41642           !authenticated = *
41643           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
41644
41645   warn    dmarc_status   = !accept
41646           !authenticated = *
41647           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
41648
41649   warn    dmarc_status   = quarantine
41650           !authenticated = *
41651           set $acl_m_quarantine = 1
41652           # Do something in a transport with this flag variable
41653
41654   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
41655           condition      = ${if eq{$acl_m_mailing_list}{1}}
41656           message        = Messages from $dmarc_used_domain break mailing lists
41657
41658   deny    dmarc_status   = reject
41659           !authenticated = *
41660           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
41661
41662   warn    add_header     = :at_start:${authresults {$primary_hostname}}
41663 .endd
41664
41665
41666
41667
41668
41669 . ////////////////////////////////////////////////////////////////////////////
41670 . ////////////////////////////////////////////////////////////////////////////
41671
41672 .chapter "Proxies" "CHAPproxies" &&&
41673          "Proxy support"
41674 .cindex "proxy support"
41675 .cindex "proxy" "access via"
41676
41677 A proxy is an intermediate system through which communication is passed.
41678 Proxies may provide a security, availability or load-distribution function.
41679
41680
41681 .section "Inbound proxies" SECTproxyInbound
41682 .cindex proxy inbound
41683 .cindex proxy "server side"
41684 .cindex proxy "Proxy protocol"
41685 .cindex "Proxy protocol" proxy
41686
41687 Exim has support for receiving inbound SMTP connections via a proxy
41688 that uses &"Proxy Protocol"& to speak to it.
41689 To include this support, include &"SUPPORT_PROXY=yes"&
41690 in Local/Makefile.
41691
41692 It was built on the HAProxy specification, found at
41693 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
41694
41695 The purpose of this facility is so that an application load balancer,
41696 such as HAProxy, can sit in front of several Exim servers
41697 to distribute load.
41698 Exim uses the local protocol communication with the proxy to obtain
41699 the remote SMTP system IP address and port information.
41700 There is no logging if a host passes or
41701 fails Proxy Protocol negotiation, but it can easily be determined and
41702 recorded in an ACL (example is below).
41703
41704 Use of a proxy is enabled by setting the &%hosts_proxy%&
41705 main configuration option to a hostlist; connections from these
41706 hosts will use Proxy Protocol.
41707 Exim supports both version 1 and version 2 of the Proxy Protocol and
41708 automatically determines which version is in use.
41709
41710 The Proxy Protocol header is the first data received on a TCP connection
41711 and is inserted before any TLS-on-connect handshake from the client; Exim
41712 negotiates TLS between Exim-as-server and the remote client, not between
41713 Exim and the proxy server.
41714
41715 The following expansion variables are usable
41716 (&"internal"& and &"external"& here refer to the interfaces
41717 of the proxy):
41718 .display
41719 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41720 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41721 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41722 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41723 &'proxy_session            '& boolean: SMTP connection via proxy
41724 .endd
41725 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41726 there was a protocol error.
41727 The variables &$sender_host_address$& and &$sender_host_port$&
41728 will have values for the actual client system, not the proxy.
41729
41730 Since the real connections are all coming from the proxy, and the
41731 per host connection tracking is done before Proxy Protocol is
41732 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41733 handle all of the parallel volume you expect per inbound proxy.
41734 With the option set so high, you lose the ability
41735 to protect your server from many connections from one IP.
41736 In order to prevent your server from overload, you
41737 need to add a per connection ratelimit to your connect ACL.
41738 A possible solution is:
41739 .display
41740   # Set max number of connections per host
41741   LIMIT   = 5
41742   # Or do some kind of IP lookup in a flat file or database
41743   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41744
41745   defer   ratelimit      = LIMIT / 5s / per_conn / strict
41746           message        = Too many connections from this IP right now
41747 .endd
41748
41749
41750
41751 .section "Outbound proxies" SECTproxySOCKS
41752 .cindex proxy outbound
41753 .cindex proxy "client side"
41754 .cindex proxy SOCKS
41755 .cindex SOCKS proxy
41756 Exim has support for sending outbound SMTP via a proxy
41757 using a protocol called SOCKS5 (defined by RFC1928).
41758 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41759 Local/Makefile.
41760
41761 Use of a proxy is enabled by setting the &%socks_proxy%& option
41762 on an smtp transport.
41763 The option value is expanded and should then be a list
41764 (colon-separated by default) of proxy specifiers.
41765 Each proxy specifier is a list
41766 (space-separated by default) where the initial element
41767 is an IP address and any subsequent elements are options.
41768
41769 Options are a string <name>=<value>.
41770 The list of options is in the following table:
41771 .display
41772 &'auth   '& authentication method
41773 &'name   '& authentication username
41774 &'pass   '& authentication password
41775 &'port   '& tcp port
41776 &'tmo    '& connection timeout
41777 &'pri    '& priority
41778 &'weight '& selection bias
41779 .endd
41780
41781 More details on each of these options follows:
41782
41783 .ilist
41784 .cindex authentication "to proxy"
41785 .cindex proxy authentication
41786 &%auth%&: Either &"none"& (default) or &"name"&.
41787 Using &"name"& selects username/password authentication per RFC 1929
41788 for access to the proxy.
41789 Default is &"none"&.
41790 .next
41791 &%name%&: sets the username for the &"name"& authentication method.
41792 Default is empty.
41793 .next
41794 &%pass%&: sets the password for the &"name"& authentication method.
41795 Default is empty.
41796 .next
41797 &%port%&: the TCP port number to use for the connection to the proxy.
41798 Default is 1080.
41799 .next
41800 &%tmo%&: sets a connection timeout in seconds for this proxy.
41801 Default is 5.
41802 .next
41803 &%pri%&: specifies a priority for the proxy within the list,
41804 higher values being tried first.
41805 The default priority is 1.
41806 .next
41807 &%weight%&: specifies a selection bias.
41808 Within a priority set servers are queried in a random fashion,
41809 weighted by this value.
41810 The default value for selection bias is 1.
41811 .endlist
41812
41813 Proxies from the list are tried according to their priority
41814 and weight settings until one responds.  The timeout for the
41815 overall connection applies to the set of proxied attempts.
41816
41817 .section Logging SECTproxyLog
41818 To log the (local) IP of a proxy in the incoming or delivery logline,
41819 add &"+proxy"& to the &%log_selector%& option.
41820 This will add a component tagged with &"PRX="& to the line.
41821
41822 . ////////////////////////////////////////////////////////////////////////////
41823 . ////////////////////////////////////////////////////////////////////////////
41824
41825 .chapter "Internationalisation" "CHAPi18n" &&&
41826          "Internationalisation""
41827 .cindex internationalisation "email address"
41828 .cindex EAI
41829 .cindex i18n
41830 .cindex utf8 "mail name handling"
41831
41832 Exim has support for Internationalised mail names.
41833 To include this it must be built with SUPPORT_I18N and the libidn library.
41834 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41835
41836 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41837 instead of it) then IDNA2008 is supported; this adds an extra library
41838 requirement, upon libidn2.
41839
41840 .section "MTA operations" SECTi18nMTA
41841 .cindex SMTPUTF8 "ESMTP option"
41842 .cindex "ESMTP extensions" SMTPUTF8
41843 The main configuration option &%smtputf8_advertise_hosts%& specifies
41844 a host list.  If this matches the sending host and
41845 accept_8bitmime is true (the default) then the ESMTP option
41846 SMTPUTF8 will be advertised.
41847
41848 If the sender specifies the SMTPUTF8 option on a MAIL command
41849 international handling for the message is enabled and
41850 the expansion variable &$message_smtputf8$& will have value TRUE.
41851
41852 The option &%allow_utf8_domains%& is set to true for this
41853 message. All DNS lookups are converted to a-label form
41854 whatever the setting of &%allow_utf8_domains%&
41855 when Exim is built with SUPPORT_I18N.
41856
41857 Both localparts and domain are maintained as the original
41858 UTF-8 form internally; any comparison or regular-expression use will
41859 require appropriate care.  Filenames created, eg. by
41860 the appendfile transport, will have UTF-8 names.
41861
41862 HELO names sent by the smtp transport will have any UTF-8
41863 components expanded to a-label form,
41864 and any certificate name checks will be done using the a-label
41865 form of the name.
41866
41867 .cindex log protocol
41868 .cindex SMTPUTF8 logging
41869 .cindex i18n logging
41870 Log lines and Received-by: header lines will acquire a "utf8"
41871 prefix on the protocol element, eg. utf8esmtp.
41872
41873 The following expansion operators can be used:
41874 .code
41875 ${utf8_domain_to_alabel:str}
41876 ${utf8_domain_from_alabel:str}
41877 ${utf8_localpart_to_alabel:str}
41878 ${utf8_localpart_from_alabel:str}
41879 .endd
41880
41881 .cindex utf8 "address downconversion"
41882 .cindex i18n "utf8 address downconversion"
41883 The RCPT ACL
41884 may use the following modifier:
41885 .display
41886 control = utf8_downconvert
41887 control = utf8_downconvert/<value>
41888 .endd
41889 This sets a flag requiring that envelope addresses are converted to
41890 a-label form before smtp delivery.
41891 This is usually for use in a Message Submission Agent context,
41892 but could be used for any message.
41893
41894 If a value is appended it may be:
41895 .display
41896 &`1  `& mandatory downconversion
41897 &`0  `& no downconversion
41898 &`-1 `& if SMTPUTF8 not supported by destination host
41899 .endd
41900 If no value is given, 1 is used.
41901
41902 If mua_wrapper is set, the utf8_downconvert control
41903 is initially set to -1.
41904
41905 The smtp transport has an option &%utf8_downconvert%&.
41906 If set it must expand to one of the three values described above,
41907 or an empty string.
41908 If non-empty it overrides value previously set
41909 (due to mua_wrapper or by an ACL control).
41910
41911
41912 There is no explicit support for VRFY and EXPN.
41913 Configurations supporting these should inspect
41914 &$smtp_command_argument$& for an SMTPUTF8 argument.
41915
41916 There is no support for LMTP on Unix sockets.
41917 Using the "lmtp" protocol option on an smtp transport,
41918 for LMTP over TCP, should work as expected.
41919
41920 There is no support for DSN unitext handling,
41921 and no provision for converting logging from or to UTF-8.
41922
41923
41924
41925 .section "MDA operations" SECTi18nMDA
41926 To aid in constructing names suitable for IMAP folders
41927 the following expansion operator can be used:
41928 .code
41929 ${imapfolder {<string>} {<sep>} {<specials>}}
41930 .endd
41931
41932 The string is converted from the charset specified by
41933 the "headers charset" command (in a filter file)
41934 or &%headers_charset%& main configuration option (otherwise),
41935 to the
41936 modified UTF-7 encoding specified by RFC 2060,
41937 with the following exception: All occurrences of <sep>
41938 (which has to be a single character)
41939 are replaced with periods ("."), and all periods and slashes that are not
41940 <sep> and are not in the <specials> string are BASE64 encoded.
41941
41942 The third argument can be omitted, defaulting to an empty string.
41943 The second argument can be omitted, defaulting to "/".
41944
41945 This is the encoding used by Courier for Maildir names on disk, and followed
41946 by many other IMAP servers.
41947
41948 Examples:
41949 .display
41950 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41951 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41952 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41953 .endd
41954
41955 Note that the source charset setting is vital, and also that characters
41956 must be representable in UTF-16.
41957
41958
41959 . ////////////////////////////////////////////////////////////////////////////
41960 . ////////////////////////////////////////////////////////////////////////////
41961
41962 .chapter "Events" "CHAPevents" &&&
41963          "Events"
41964 .cindex events
41965
41966 The events mechanism in Exim can be used to intercept processing at a number
41967 of points.  It was originally invented to give a way to do customised logging
41968 actions (for example, to a database) but can also be used to modify some
41969 processing actions.
41970
41971 Most installations will never need to use Events.
41972 The support can be left out of a build by defining DISABLE_EVENT=yes
41973 in &_Local/Makefile_&.
41974
41975 There are two major classes of events: main and transport.
41976 The main configuration option &%event_action%& controls reception events;
41977 a transport option &%event_action%& controls delivery events.
41978
41979 Both options are a string which is expanded when the event fires.
41980 An example might look like:
41981 .cindex logging custom
41982 .code
41983 event_action = ${if eq {msg:delivery}{$event_name} \
41984 {${lookup pgsql {SELECT * FROM record_Delivery( \
41985     '${quote_pgsql:$sender_address_domain}',\
41986     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41987     '${quote_pgsql:$domain}', \
41988     '${quote_pgsql:${lc:$local_part}}', \
41989     '${quote_pgsql:$host_address}', \
41990     '${quote_pgsql:${lc:$host}}', \
41991     '${quote_pgsql:$message_exim_id}')}} \
41992 } {}}
41993 .endd
41994
41995 Events have names which correspond to the point in process at which they fire.
41996 The name is placed in the variable &$event_name$& and the event action
41997 expansion must check this, as it will be called for every possible event type.
41998
41999 The current list of events is:
42000 .display
42001 &`dane:fail              after    transport  `& per connection
42002 &`msg:complete           after    main       `& per message
42003 &`msg:defer              after    transport  `& per message per delivery try
42004 &`msg:delivery           after    transport  `& per recipient
42005 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
42006 &`msg:rcpt:defer         after    transport  `& per recipient
42007 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
42008 &`msg:fail:delivery      after    transport  `& per recipient
42009 &`msg:fail:internal      after    main       `& per recipient
42010 &`tcp:connect            before   transport  `& per connection
42011 &`tcp:close              after    transport  `& per connection
42012 &`tls:cert               before   both       `& per certificate in verification chain
42013 &`smtp:connect           after    transport  `& per connection
42014 &`smtp:ehlo              after    transport  `& per connection
42015 .endd
42016 New event types may be added in future.
42017
42018 The event name is a colon-separated list, defining the type of
42019 event in a tree of possibilities.  It may be used as a list
42020 or just matched on as a whole.  There will be no spaces in the name.
42021
42022 The second column in the table above describes whether the event fires
42023 before or after the action is associates with.  Those which fire before
42024 can be used to affect that action (more on this below).
42025
42026 The third column in the table above says what section of the configuration
42027 should define the event action.
42028
42029 An additional variable, &$event_data$&, is filled with information varying
42030 with the event type:
42031 .display
42032 &`dane:fail            `& failure reason
42033 &`msg:defer            `& error string
42034 &`msg:delivery         `& smtp confirmation message
42035 &`msg:fail:internal    `& failure reason
42036 &`msg:fail:delivery    `& smtp error message
42037 &`msg:host:defer       `& error string
42038 &`msg:rcpt:host:defer  `& error string
42039 &`msg:rcpt:defer       `& error string
42040 &`tls:cert             `& verification chain depth
42041 &`smtp:connect         `& smtp banner
42042 &`smtp:ehlo            `& smtp ehlo response
42043 .endd
42044
42045 The :defer events populate one extra variable: &$event_defer_errno$&.
42046
42047 For complex operations an ACL expansion can be used in &%event_action%&
42048 however due to the multiple contexts that Exim operates in during
42049 the course of its processing:
42050 .ilist
42051 variables set in transport events will not be visible outside that
42052 transport call
42053 .next
42054 acl_m variables in a server context are lost on a new connection,
42055 and after smtp helo/ehlo/mail/starttls/rset commands
42056 .endlist
42057 Using an ACL expansion with the logwrite modifier can be
42058 a useful way of writing to the main log.
42059
42060 The expansion of the event_action option should normally
42061 return an empty string.  Should it return anything else the
42062 following will be forced:
42063 .display
42064 &`tcp:connect      `&  do not connect
42065 &`tls:cert         `&  refuse verification
42066 &`smtp:connect     `&  close connection
42067 .endd
42068 All other message types ignore the result string, and
42069 no other use is made of it.
42070
42071 For a tcp:connect event, if the connection is being made to a proxy
42072 then the address and port variables will be that of the proxy and not
42073 the target system.
42074
42075 For tls:cert events, if GnuTLS is in use this will trigger only per
42076 chain element received on the connection.
42077 For OpenSSL it will trigger for every chain element including those
42078 loaded locally.
42079
42080 . ////////////////////////////////////////////////////////////////////////////
42081 . ////////////////////////////////////////////////////////////////////////////
42082
42083 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42084          "Adding drivers or lookups"
42085 .cindex "adding drivers"
42086 .cindex "new drivers, adding"
42087 .cindex "drivers" "adding new"
42088 The following actions have to be taken in order to add a new router, transport,
42089 authenticator, or lookup type to Exim:
42090
42091 .olist
42092 Choose a name for the driver or lookup type that does not conflict with any
42093 existing name; I will use &"newdriver"& in what follows.
42094 .next
42095 Add to &_src/EDITME_& the line:
42096 .display
42097 <&'type'&>&`_NEWDRIVER=yes`&
42098 .endd
42099 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42100 code is not to be included in the binary by default, comment this line out. You
42101 should also add any relevant comments about the driver or lookup type.
42102 .next
42103 Add to &_src/config.h.defaults_& the line:
42104 .code
42105 #define <type>_NEWDRIVER
42106 .endd
42107 .next
42108 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42109 and create a table entry as is done for all the other drivers and lookup types.
42110 .next
42111 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42112 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42113 Add your &`NEWDRIVER`& to that list.
42114 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42115 simple form that most lookups have.
42116 .next
42117 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42118 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42119 driver or lookup type and add it to the definition of OBJ.
42120 .next
42121 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42122 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42123 .next
42124 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42125 &_src_&.
42126 .next
42127 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42128 as for other drivers and lookups.
42129 .endlist
42130
42131 Then all you need to do is write the code! A good way to start is to make a
42132 proforma by copying an existing module of the same type, globally changing all
42133 occurrences of the name, and cutting out most of the code. Note that any
42134 options you create must be listed in alphabetical order, because the tables are
42135 searched using a binary chop procedure.
42136
42137 There is a &_README_& file in each of the sub-directories of &_src_& describing
42138 the interface that is expected.
42139
42140
42141
42142
42143 . ////////////////////////////////////////////////////////////////////////////
42144 . ////////////////////////////////////////////////////////////////////////////
42145
42146 . /////////////////////////////////////////////////////////////////////////////
42147 . These lines are processing instructions for the Simple DocBook Processor that
42148 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42149 . PDFs than using xmlto and fop. They will be ignored by all other XML
42150 . processors.
42151 . /////////////////////////////////////////////////////////////////////////////
42152
42153 .literal xml
42154 <?sdop
42155   format="newpage"
42156   foot_right_recto="&chaptertitle;"
42157   foot_right_verso="&chaptertitle;"
42158 ?>
42159 .literal off
42160
42161 .makeindex "Options index"   "option"
42162 .makeindex "Variables index" "variable"
42163 .makeindex "Concept index"   "concept"
42164
42165
42166 . /////////////////////////////////////////////////////////////////////////////
42167 . /////////////////////////////////////////////////////////////////////////////