Docs: change note
[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
1398 .next
1399 If the &%domains%& option is set, the domain of the address must be in the set
1400 of domains that it defines.
1401 .new
1402 .cindex "tainted data" "de-tainting"
1403 A match verifies the variable &$domain$& (which carries tainted data)
1404 and assigns an untainted value to the &$domain_data$& variable.
1405 Such an untainted value is often needed in the transport.
1406 For specifics of the matching operation and the resulting untainted value,
1407 refer to section &<<SECTdomainlist>>&.
1408
1409 When an untainted value is wanted, use this option
1410 rather than the generic &%condition%& option.
1411 .wen
1412
1413 .next
1414 .vindex "&$local_part_prefix$&"
1415 .vindex "&$local_part_prefix_v$&"
1416 .vindex "&$local_part$&"
1417 .vindex "&$local_part_suffix$&"
1418 .vindex "&$local_part_suffix_v$&"
1419 .cindex affix "router precondition"
1420 If the &%local_parts%& option is set, the local part of the address must be in
1421 the set of local parts that it defines.
1422 .new
1423 A match verifies the variable &$local_part$& (which carries tainted data)
1424 and assigns an untainted value to the &$local_part_data$& variable.
1425 Such an untainted value is often needed in the transport.
1426 For specifics of the matching operation and the resulting untainted value,
1427 refer to section &<<SECTlocparlis>>&.
1428
1429 When an untainted value is wanted, use this option
1430 rather than the generic &%condition%& option.
1431 .wen
1432
1433 If &%local_part_prefix%& or
1434 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1435 part before this check. If you want to do precondition tests on local parts
1436 that include affixes, you can do so by using a &%condition%& option (see below)
1437 that uses the variables &$local_part$&, &$local_part_prefix$&,
1438 &$local_part_prefix_v$&, &$local_part_suffix$&
1439 and &$local_part_suffix_v$& as necessary.
1440
1441 .next
1442 .vindex "&$local_user_uid$&"
1443 .vindex "&$local_user_gid$&"
1444 .vindex "&$home$&"
1445 If the &%check_local_user%& option is set, the local part must be the name of
1446 an account on the local host. If this check succeeds, the uid and gid of the
1447 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1448 user's home directory is placed in &$home$&; these values can be used in the
1449 remaining preconditions.
1450
1451 .next
1452 If the &%router_home_directory%& option is set, it is expanded at this point,
1453 because it overrides the value of &$home$&. If this expansion were left till
1454 later, the value of &$home$& as set by &%check_local_user%& would be used in
1455 subsequent tests. Having two different values of &$home$& in the same router
1456 could lead to confusion.
1457
1458 .next
1459 If the &%senders%& option is set, the envelope sender address must be in the
1460 set of addresses that it defines.
1461
1462 .next
1463 If the &%require_files%& option is set, the existence or non-existence of
1464 specified files is tested.
1465
1466 .next
1467 .cindex "customizing" "precondition"
1468 If the &%condition%& option is set, it is evaluated and tested. This option
1469 uses an expanded string to allow you to set up your own custom preconditions.
1470 Expanded strings are described in chapter &<<CHAPexpand>>&.
1471
1472 .new
1473 Note that while using
1474 this option for address matching technically works,
1475 it does not set any de-tainted values.
1476 Such values are often needed, either for router-specific options or
1477 for transport options.
1478 Using the &%domains%& and &%local_parts%& options is usually the most
1479 convenient way to obtain them.
1480 .wen
1481 .endlist
1482
1483
1484 Note that &%require_files%& comes near the end of the list, so you cannot use
1485 it to check for the existence of a file in which to lookup up a domain, local
1486 part, or sender. However, as these options are all expanded, you can use the
1487 &%exists%& expansion condition to make such tests within each condition. The
1488 &%require_files%& option is intended for checking files that the router may be
1489 going to use internally, or which are needed by a specific transport (for
1490 example, &_.procmailrc_&).
1491
1492
1493
1494 .section "Delivery in detail" "SECID18"
1495 .cindex "delivery" "in detail"
1496 When a message is to be delivered, the sequence of events is as follows:
1497
1498 .ilist
1499 If a system-wide filter file is specified, the message is passed to it. The
1500 filter may add recipients to the message, replace the recipients, discard the
1501 message, cause a new message to be generated, or cause the message delivery to
1502 fail. The format of the system filter file is the same as for Exim user filter
1503 files, described in the separate document entitled &'Exim's interfaces to mail
1504 filtering'&.
1505 .cindex "Sieve filter" "not available for system filter"
1506 (&*Note*&: Sieve cannot be used for system filter files.)
1507
1508 Some additional features are available in system filters &-- see chapter
1509 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1510 filter only once per delivery attempt, however many recipients it has. However,
1511 if there are several delivery attempts because one or more addresses could not
1512 be immediately delivered, the system filter is run each time. The filter
1513 condition &%first_delivery%& can be used to detect the first run of the system
1514 filter.
1515 .next
1516 Each recipient address is offered to each configured router, in turn, subject to
1517 its preconditions, until one is able to handle it. If no router can handle the
1518 address, that is, if they all decline, the address is failed. Because routers
1519 can be targeted at particular domains, several locally handled domains can be
1520 processed entirely independently of each other.
1521 .next
1522 .cindex "routing" "loops in"
1523 .cindex "loop" "while routing"
1524 A router that accepts an address may assign it to a local or a remote
1525 transport. However, the transport is not run at this time. Instead, the address
1526 is placed on a list for the particular transport, which will be run later.
1527 Alternatively, the router may generate one or more new addresses (typically
1528 from alias, forward, or filter files). New addresses are fed back into this
1529 process from the top, but in order to avoid loops, a router ignores any address
1530 which has an identically-named ancestor that was processed by itself.
1531 .next
1532 When all the routing has been done, addresses that have been successfully
1533 handled are passed to their assigned transports. When local transports are
1534 doing real local deliveries, they handle only one address at a time, but if a
1535 local transport is being used as a pseudo-remote transport (for example, to
1536 collect batched SMTP messages for transmission by some other means) multiple
1537 addresses can be handled. Remote transports can always handle more than one
1538 address at a time, but can be configured not to do so, or to restrict multiple
1539 addresses to the same domain.
1540 .next
1541 Each local delivery to a file or a pipe runs in a separate process under a
1542 non-privileged uid, and these deliveries are run one at a time. Remote
1543 deliveries also run in separate processes, normally under a uid that is private
1544 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1545 run in parallel. The maximum number of simultaneous remote deliveries for any
1546 one message is set by the &%remote_max_parallel%& option.
1547 The order in which deliveries are done is not defined, except that all local
1548 deliveries happen before any remote deliveries.
1549 .next
1550 .cindex "queue runner"
1551 When it encounters a local delivery during a queue run, Exim checks its retry
1552 database to see if there has been a previous temporary delivery failure for the
1553 address before running the local transport. If there was a previous failure,
1554 Exim does not attempt a new delivery until the retry time for the address is
1555 reached. However, this happens only for delivery attempts that are part of a
1556 queue run. Local deliveries are always attempted when delivery immediately
1557 follows message reception, even if retry times are set for them. This makes for
1558 better behaviour if one particular message is causing problems (for example,
1559 causing quota overflow, or provoking an error in a filter file).
1560 .next
1561 .cindex "delivery" "retry in remote transports"
1562 Remote transports do their own retry handling, since an address may be
1563 deliverable to one of a number of hosts, each of which may have a different
1564 retry time. If there have been previous temporary failures and no host has
1565 reached its retry time, no delivery is attempted, whether in a queue run or
1566 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1567 .next
1568 If there were any permanent errors, a bounce message is returned to an
1569 appropriate address (the sender in the common case), with details of the error
1570 for each failing address. Exim can be configured to send copies of bounce
1571 messages to other addresses.
1572 .next
1573 .cindex "delivery" "deferral"
1574 If one or more addresses suffered a temporary failure, the message is left on
1575 the queue, to be tried again later. Delivery of these addresses is said to be
1576 &'deferred'&.
1577 .next
1578 When all the recipient addresses have either been delivered or bounced,
1579 handling of the message is complete. The spool files and message log are
1580 deleted, though the message log can optionally be preserved if required.
1581 .endlist
1582
1583
1584
1585
1586 .section "Retry mechanism" "SECID19"
1587 .cindex "delivery" "retry mechanism"
1588 .cindex "retry" "description of mechanism"
1589 .cindex "queue runner"
1590 Exim's mechanism for retrying messages that fail to get delivered at the first
1591 attempt is the queue runner process. You must either run an Exim daemon that
1592 uses the &%-q%& option with a time interval to start queue runners at regular
1593 intervals or use some other means (such as &'cron'&) to start them. If you do
1594 not arrange for queue runners to be run, messages that fail temporarily at the
1595 first attempt will remain in your queue forever. A queue runner process works
1596 its way through the queue, one message at a time, trying each delivery that has
1597 passed its retry time.
1598 You can run several queue runners at once.
1599
1600 Exim uses a set of configured rules to determine when next to retry the failing
1601 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1602 should give up trying to deliver to the address, at which point it generates a
1603 bounce message. If no retry rules are set for a particular host, address, and
1604 error combination, no retries are attempted, and temporary errors are treated
1605 as permanent.
1606
1607
1608
1609 .section "Temporary delivery failure" "SECID20"
1610 .cindex "delivery" "temporary failure"
1611 There are many reasons why a message may not be immediately deliverable to a
1612 particular address. Failure to connect to a remote machine (because it, or the
1613 connection to it, is down) is one of the most common. Temporary failures may be
1614 detected during routing as well as during the transport stage of delivery.
1615 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1616 is on a file system where the user is over quota. Exim can be configured to
1617 impose its own quotas on local mailboxes; where system quotas are set they will
1618 also apply.
1619
1620 If a host is unreachable for a period of time, a number of messages may be
1621 waiting for it by the time it recovers, and sending them in a single SMTP
1622 connection is clearly beneficial. Whenever a delivery to a remote host is
1623 deferred,
1624 .cindex "hints database" "deferred deliveries"
1625 Exim makes a note in its hints database, and whenever a successful
1626 SMTP delivery has happened, it looks to see if any other messages are waiting
1627 for the same host. If any are found, they are sent over the same SMTP
1628 connection, subject to a configuration limit as to the maximum number in any
1629 one connection.
1630
1631
1632
1633 .section "Permanent delivery failure" "SECID21"
1634 .cindex "delivery" "permanent failure"
1635 .cindex "bounce message" "when generated"
1636 When a message cannot be delivered to some or all of its intended recipients, a
1637 bounce message is generated. Temporary delivery failures turn into permanent
1638 errors when their timeout expires. All the addresses that fail in a given
1639 delivery attempt are listed in a single message. If the original message has
1640 many recipients, it is possible for some addresses to fail in one delivery
1641 attempt and others to fail subsequently, giving rise to more than one bounce
1642 message. The wording of bounce messages can be customized by the administrator.
1643 See chapter &<<CHAPemsgcust>>& for details.
1644
1645 .cindex "&'X-Failed-Recipients:'& header line"
1646 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1647 failed addresses, for the benefit of programs that try to analyse such messages
1648 automatically.
1649
1650 .cindex "bounce message" "recipient of"
1651 A bounce message is normally sent to the sender of the original message, as
1652 obtained from the message's envelope. For incoming SMTP messages, this is the
1653 address given in the MAIL command. However, when an address is expanded via a
1654 forward or alias file, an alternative address can be specified for delivery
1655 failures of the generated addresses. For a mailing list expansion (see section
1656 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1657 of the list.
1658
1659
1660
1661 .section "Failures to deliver bounce messages" "SECID22"
1662 .cindex "bounce message" "failure to deliver"
1663 If a bounce message (either locally generated or received from a remote host)
1664 itself suffers a permanent delivery failure, the message is left in the queue,
1665 but it is frozen, awaiting the attention of an administrator. There are options
1666 that can be used to make Exim discard such failed messages, or to keep them
1667 for only a short time (see &%timeout_frozen_after%& and
1668 &%ignore_bounce_errors_after%&).
1669
1670
1671
1672
1673
1674 . ////////////////////////////////////////////////////////////////////////////
1675 . ////////////////////////////////////////////////////////////////////////////
1676
1677 .chapter "Building and installing Exim" "CHID3"
1678 .scindex IIDbuex "building Exim"
1679
1680 .section "Unpacking" "SECID23"
1681 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1682 creates a directory with the name of the current release (for example,
1683 &_exim-&version()_&) into which the following files are placed:
1684
1685 .table2 140pt
1686 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1687 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1688   documented"
1689 .irow &_LICENCE_&         "the GNU General Public Licence"
1690 .irow &_Makefile_&        "top-level make file"
1691 .irow &_NOTICE_&          "conditions for the use of Exim"
1692 .irow &_README_&          "list of files, directories and simple build &&&
1693   instructions"
1694 .endtable
1695
1696 Other files whose names begin with &_README_& may also be present. The
1697 following subdirectories are created:
1698
1699 .table2 140pt
1700 .irow &_Local_&           "an empty directory for local configuration files"
1701 .irow &_OS_&              "OS-specific files"
1702 .irow &_doc_&             "documentation files"
1703 .irow &_exim_monitor_&    "source files for the Exim monitor"
1704 .irow &_scripts_&         "scripts used in the build process"
1705 .irow &_src_&             "remaining source files"
1706 .irow &_util_&            "independent utilities"
1707 .endtable
1708
1709 The main utility programs are contained in the &_src_& directory and are built
1710 with the Exim binary. The &_util_& directory contains a few optional scripts
1711 that may be useful to some sites.
1712
1713
1714 .section "Multiple machine architectures and operating systems" "SECID24"
1715 .cindex "building Exim" "multiple OS/architectures"
1716 The building process for Exim is arranged to make it easy to build binaries for
1717 a number of different architectures and operating systems from the same set of
1718 source files. Compilation does not take place in the &_src_& directory.
1719 Instead, a &'build directory'& is created for each architecture and operating
1720 system.
1721 .cindex "symbolic link" "to build directory"
1722 Symbolic links to the sources are installed in this directory, which is where
1723 the actual building takes place. In most cases, Exim can discover the machine
1724 architecture and operating system for itself, but the defaults can be
1725 overridden if necessary.
1726 .cindex compiler requirements
1727 .cindex compiler version
1728 A C99-capable compiler will be required for the build.
1729
1730
1731 .section "PCRE library" "SECTpcre"
1732 .cindex "PCRE library"
1733 Exim no longer has an embedded PCRE library as the vast majority of
1734 modern systems include PCRE as a system library, although you may need to
1735 install the PCRE package or the PCRE development package for your operating
1736 system. If your system has a normal PCRE installation the Exim build
1737 process will need no further configuration. If the library or the
1738 headers are in an unusual location you will need to either set the PCRE_LIBS
1739 and INCLUDE directives appropriately,
1740 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1741 If your operating system has no
1742 PCRE support then you will need to obtain and build the current PCRE
1743 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1744 More information on PCRE is available at &url(https://www.pcre.org/).
1745
1746 .section "DBM libraries" "SECTdb"
1747 .cindex "DBM libraries" "discussion of"
1748 .cindex "hints database" "DBM files used for"
1749 Even if you do not use any DBM files in your configuration, Exim still needs a
1750 DBM library in order to operate, because it uses indexed files for its hints
1751 databases. Unfortunately, there are a number of DBM libraries in existence, and
1752 different operating systems often have different ones installed.
1753
1754 .cindex "Solaris" "DBM library for"
1755 .cindex "IRIX, DBM library for"
1756 .cindex "BSD, DBM library for"
1757 .cindex "Linux, DBM library for"
1758 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1759 Linux distribution, the DBM configuration should happen automatically, and you
1760 may be able to ignore this section. Otherwise, you may have to learn more than
1761 you would like about DBM libraries from what follows.
1762
1763 .cindex "&'ndbm'& DBM library"
1764 Licensed versions of Unix normally contain a library of DBM functions operating
1765 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1766 versions of Unix seem to vary in what they contain as standard. In particular,
1767 some early versions of Linux have no default DBM library, and different
1768 distributors have chosen to bundle different libraries with their packaged
1769 versions. However, the more recent releases seem to have standardized on the
1770 Berkeley DB library.
1771
1772 Different DBM libraries have different conventions for naming the files they
1773 use. When a program opens a file called &_dbmfile_&, there are several
1774 possibilities:
1775
1776 .olist
1777 A traditional &'ndbm'& implementation, such as that supplied as part of
1778 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1779 .next
1780 .cindex "&'gdbm'& DBM library"
1781 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1782 compatibility interface it makes two different hard links to it with names
1783 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1784 filename is used unmodified.
1785 .next
1786 .cindex "Berkeley DB library"
1787 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1788 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1789 programmer exactly the same as the traditional &'ndbm'& implementation.
1790 .next
1791 If the Berkeley package is used in its native mode, it operates on a single
1792 file called &_dbmfile_&; the programmer's interface is somewhat different to
1793 the traditional &'ndbm'& interface.
1794 .next
1795 To complicate things further, there are several very different versions of the
1796 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1797 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1798 Maintenance of some of the earlier releases has ceased. All versions of
1799 Berkeley DB could be obtained from
1800 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1801 page with far newer versions listed.
1802 It is probably wise to plan to move your storage configurations away from
1803 Berkeley DB format, as today there are smaller and simpler alternatives more
1804 suited to Exim's usage model.
1805 .next
1806 .cindex "&'tdb'& DBM library"
1807 Yet another DBM library, called &'tdb'&, is available from
1808 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1809 operates on a single file.
1810 .endlist
1811
1812 .cindex "USE_DB"
1813 .cindex "DBM libraries" "configuration for building"
1814 Exim and its utilities can be compiled to use any of these interfaces. In order
1815 to use any version of the Berkeley DB package in native mode, you must set
1816 USE_DB in an appropriate configuration file (typically
1817 &_Local/Makefile_&). For example:
1818 .code
1819 USE_DB=yes
1820 .endd
1821 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1822 error is diagnosed if you set more than one of these.
1823
1824 At the lowest level, the build-time configuration sets none of these options,
1825 thereby assuming an interface of type (1). However, some operating system
1826 configuration files (for example, those for the BSD operating systems and
1827 Linux) assume type (4) by setting USE_DB as their default, and the
1828 configuration files for Cygwin set USE_GDBM. Anything you set in
1829 &_Local/Makefile_&, however, overrides these system defaults.
1830
1831 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1832 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1833 in one of these lines:
1834 .code
1835 DBMLIB = -ldb
1836 DBMLIB = -ltdb
1837 .endd
1838 Settings like that will work if the DBM library is installed in the standard
1839 place. Sometimes it is not, and the library's header file may also not be in
1840 the default path. You may need to set INCLUDE to specify where the header
1841 file is, and to specify the path to the library more fully in DBMLIB, as in
1842 this example:
1843 .code
1844 INCLUDE=-I/usr/local/include/db-4.1
1845 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1846 .endd
1847 There is further detailed discussion about the various DBM libraries in the
1848 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1849
1850
1851
1852 .section "Pre-building configuration" "SECID25"
1853 .cindex "building Exim" "pre-building configuration"
1854 .cindex "configuration for building Exim"
1855 .cindex "&_Local/Makefile_&"
1856 .cindex "&_src/EDITME_&"
1857 Before building Exim, a local configuration file that specifies options
1858 independent of any operating system has to be created with the name
1859 &_Local/Makefile_&. A template for this file is supplied as the file
1860 &_src/EDITME_&, and it contains full descriptions of all the option settings
1861 therein. These descriptions are therefore not repeated here. If you are
1862 building Exim for the first time, the simplest thing to do is to copy
1863 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1864
1865 There are three settings that you must supply, because Exim will not build
1866 without them. They are the location of the runtime configuration file
1867 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1868 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1869 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1870 a colon-separated list of filenames; Exim uses the first of them that exists.
1871
1872 There are a few other parameters that can be specified either at build time or
1873 at runtime, to enable the same binary to be used on a number of different
1874 machines. However, if the locations of Exim's spool directory and log file
1875 directory (if not within the spool directory) are fixed, it is recommended that
1876 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1877 detected early in Exim's execution (such as a malformed configuration file) can
1878 be logged.
1879
1880 .cindex "content scanning" "specifying at build time"
1881 Exim's interfaces for calling virus and spam scanning software directly from
1882 access control lists are not compiled by default. If you want to include these
1883 facilities, you need to set
1884 .code
1885 WITH_CONTENT_SCAN=yes
1886 .endd
1887 in your &_Local/Makefile_&. For details of the facilities themselves, see
1888 chapter &<<CHAPexiscan>>&.
1889
1890
1891 .cindex "&_Local/eximon.conf_&"
1892 .cindex "&_exim_monitor/EDITME_&"
1893 If you are going to build the Exim monitor, a similar configuration process is
1894 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1895 your installation and saved under the name &_Local/eximon.conf_&. If you are
1896 happy with the default settings described in &_exim_monitor/EDITME_&,
1897 &_Local/eximon.conf_& can be empty, but it must exist.
1898
1899 This is all the configuration that is needed in straightforward cases for known
1900 operating systems. However, the building process is set up so that it is easy
1901 to override options that are set by default or by operating-system-specific
1902 configuration files, for example, to change the C compiler, which
1903 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1904 do this.
1905
1906
1907
1908 .section "Support for iconv()" "SECID26"
1909 .cindex "&[iconv()]& support"
1910 .cindex "RFC 2047"
1911 The contents of header lines in messages may be encoded according to the rules
1912 described RFC 2047. This makes it possible to transmit characters that are not
1913 in the ASCII character set, and to label them as being in a particular
1914 character set. When Exim is inspecting header lines by means of the &%$h_%&
1915 mechanism, it decodes them, and translates them into a specified character set
1916 (default is set at build time). The translation is possible only if the operating system
1917 supports the &[iconv()]& function.
1918
1919 However, some of the operating systems that supply &[iconv()]& do not support
1920 very many conversions. The GNU &%libiconv%& library (available from
1921 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1922 systems to remedy this deficiency, as well as on systems that do not supply
1923 &[iconv()]& at all. After installing &%libiconv%&, you should add
1924 .code
1925 HAVE_ICONV=yes
1926 .endd
1927 to your &_Local/Makefile_& and rebuild Exim.
1928
1929
1930
1931 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1932 .cindex "TLS" "including support for TLS"
1933 .cindex "encryption" "including support for"
1934 .cindex "OpenSSL" "building Exim with"
1935 .cindex "GnuTLS" "building Exim with"
1936 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1937 command as per RFC 2487. It can also support clients that expect to
1938 start a TLS session immediately on connection to a non-standard port (see the
1939 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1940 line option).
1941
1942 If you want to build Exim with TLS support, you must first install either the
1943 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1944 implementing SSL.
1945
1946 If you do not want TLS support you should set
1947 .code
1948 DISABLE_TLS=yes
1949 .endd
1950 in &_Local/Makefile_&.
1951
1952 If OpenSSL is installed, you should set
1953 .code
1954 USE_OPENSL=yes
1955 TLS_LIBS=-lssl -lcrypto
1956 .endd
1957 in &_Local/Makefile_&. You may also need to specify the locations of the
1958 OpenSSL library and include files. For example:
1959 .code
1960 USE_OPENSSL=yes
1961 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1962 TLS_INCLUDE=-I/usr/local/openssl/include/
1963 .endd
1964 .cindex "pkg-config" "OpenSSL"
1965 If you have &'pkg-config'& available, then instead you can just use:
1966 .code
1967 USE_OPENSSL=yes
1968 USE_OPENSSL_PC=openssl
1969 .endd
1970 .cindex "USE_GNUTLS"
1971 If GnuTLS is installed, you should set
1972 .code
1973 USE_GNUTLS=yes
1974 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1975 .endd
1976 in &_Local/Makefile_&, and again you may need to specify the locations of the
1977 library and include files. For example:
1978 .code
1979 USE_GNUTLS=yes
1980 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1981 TLS_INCLUDE=-I/usr/gnu/include
1982 .endd
1983 .cindex "pkg-config" "GnuTLS"
1984 If you have &'pkg-config'& available, then instead you can just use:
1985 .code
1986 USE_GNUTLS=yes
1987 USE_GNUTLS_PC=gnutls
1988 .endd
1989
1990 You do not need to set TLS_INCLUDE if the relevant directory is already
1991 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1992 given in chapter &<<CHAPTLS>>&.
1993
1994
1995
1996
1997 .section "Use of tcpwrappers" "SECID27"
1998
1999 .cindex "tcpwrappers, building Exim to support"
2000 .cindex "USE_TCP_WRAPPERS"
2001 .cindex "TCP_WRAPPERS_DAEMON_NAME"
2002 .cindex "tcp_wrappers_daemon_name"
2003 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
2004 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
2005 alternative to Exim's own checking facilities for installations that are
2006 already making use of &'tcpwrappers'& for other purposes. To do this, you
2007 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
2008 &_tcpd.h_& to be available at compile time, and also ensure that the library
2009 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
2010 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
2011 you might have
2012 .code
2013 USE_TCP_WRAPPERS=yes
2014 CFLAGS=-O -I/usr/local/include
2015 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
2016 .endd
2017 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
2018 files is &"exim"&. For example, the line
2019 .code
2020 exim : LOCAL  192.168.1.  .friendly.domain.example
2021 .endd
2022 in your &_/etc/hosts.allow_& file allows connections from the local host, from
2023 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
2024 All other connections are denied. The daemon name used by &'tcpwrappers'&
2025 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
2026 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
2027 configure file. Consult the &'tcpwrappers'& documentation for
2028 further details.
2029
2030
2031 .section "Including support for IPv6" "SECID28"
2032 .cindex "IPv6" "including support for"
2033 Exim contains code for use on systems that have IPv6 support. Setting
2034 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
2035 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2036 where the IPv6 support is not fully integrated into the normal include and
2037 library files.
2038
2039 Two different types of DNS record for handling IPv6 addresses have been
2040 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2041 currently seen as the mainstream. Another record type called A6 was proposed
2042 as better than AAAA because it had more flexibility. However, it was felt to be
2043 over-complex, and its status was reduced to &"experimental"&.
2044 Exim used to
2045 have a compile option for including A6 record support but this has now been
2046 withdrawn.
2047
2048
2049
2050 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2051 .cindex "lookup modules"
2052 .cindex "dynamic modules"
2053 .cindex ".so building"
2054 On some platforms, Exim supports not compiling all lookup types directly into
2055 the main binary, instead putting some into external modules which can be loaded
2056 on demand.
2057 This permits packagers to build Exim with support for lookups with extensive
2058 library dependencies without requiring all users to install all of those
2059 dependencies.
2060 Most, but not all, lookup types can be built this way.
2061
2062 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2063 installed; Exim will only load modules from that directory, as a security
2064 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2065 for your OS; see &_OS/Makefile-Linux_& for an example.
2066 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2067 see &_src/EDITME_& for details.
2068
2069 Then, for each module to be loaded dynamically, define the relevant
2070 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2071 For example, this will build in lsearch but load sqlite and mysql support
2072 on demand:
2073 .code
2074 LOOKUP_LSEARCH=yes
2075 LOOKUP_SQLITE=2
2076 LOOKUP_MYSQL=2
2077 .endd
2078
2079
2080 .section "The building process" "SECID29"
2081 .cindex "build directory"
2082 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2083 created, run &'make'& at the top level. It determines the architecture and
2084 operating system types, and creates a build directory if one does not exist.
2085 For example, on a Sun system running Solaris 8, the directory
2086 &_build-SunOS5-5.8-sparc_& is created.
2087 .cindex "symbolic link" "to source files"
2088 Symbolic links to relevant source files are installed in the build directory.
2089
2090 If this is the first time &'make'& has been run, it calls a script that builds
2091 a make file inside the build directory, using the configuration files from the
2092 &_Local_& directory. The new make file is then passed to another instance of
2093 &'make'&. This does the real work, building a number of utility scripts, and
2094 then compiling and linking the binaries for the Exim monitor (if configured), a
2095 number of utility programs, and finally Exim itself. The command &`make
2096 makefile`& can be used to force a rebuild of the make file in the build
2097 directory, should this ever be necessary.
2098
2099 If you have problems building Exim, check for any comments there may be in the
2100 &_README_& file concerning your operating system, and also take a look at the
2101 FAQ, where some common problems are covered.
2102
2103
2104
2105 .section 'Output from &"make"&' "SECID283"
2106 The output produced by the &'make'& process for compile lines is often very
2107 unreadable, because these lines can be very long. For this reason, the normal
2108 output is suppressed by default, and instead output similar to that which
2109 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2110 each module that is being compiled or linked. However, it is still possible to
2111 get the full output, by calling &'make'& like this:
2112 .code
2113 FULLECHO='' make -e
2114 .endd
2115 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2116 command reflection in &'make'&. When you ask for the full output, it is
2117 given in addition to the short output.
2118
2119
2120
2121 .section "Overriding build-time options for Exim" "SECToverride"
2122 .cindex "build-time options, overriding"
2123 The main make file that is created at the beginning of the building process
2124 consists of the concatenation of a number of files which set configuration
2125 values, followed by a fixed set of &'make'& instructions. If a value is set
2126 more than once, the last setting overrides any previous ones. This provides a
2127 convenient way of overriding defaults. The files that are concatenated are, in
2128 order:
2129 .display
2130 &_OS/Makefile-Default_&
2131 &_OS/Makefile-_&<&'ostype'&>
2132 &_Local/Makefile_&
2133 &_Local/Makefile-_&<&'ostype'&>
2134 &_Local/Makefile-_&<&'archtype'&>
2135 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2136 &_OS/Makefile-Base_&
2137 .endd
2138 .cindex "&_Local/Makefile_&"
2139 .cindex "building Exim" "operating system type"
2140 .cindex "building Exim" "architecture type"
2141 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2142 architecture type. &_Local/Makefile_& is required to exist, and the building
2143 process fails if it is absent. The other three &_Local_& files are optional,
2144 and are often not needed.
2145
2146 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2147 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2148 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2149 values are used, thereby providing a means of forcing particular settings.
2150 Otherwise, the scripts try to get values from the &%uname%& command. If this
2151 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2152 of &'ad hoc'& transformations are then applied, to produce the standard names
2153 that Exim expects. You can run these scripts directly from the shell in order
2154 to find out what values are being used on your system.
2155
2156
2157 &_OS/Makefile-Default_& contains comments about the variables that are set
2158 therein. Some (but not all) are mentioned below. If there is something that
2159 needs changing, review the contents of this file and the contents of the make
2160 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2161 default values are.
2162
2163
2164 .cindex "building Exim" "overriding default settings"
2165 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2166 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2167 need to change the original files. Instead, you should make the changes by
2168 putting the new values in an appropriate &_Local_& file. For example,
2169 .cindex "Tru64-Unix build-time settings"
2170 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2171 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2172 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2173 called with the option &%-std1%&, to make it recognize some of the features of
2174 Standard C that Exim uses. (Most other compilers recognize Standard C by
2175 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2176 containing the lines
2177 .code
2178 CC=cc
2179 CFLAGS=-std1
2180 .endd
2181 If you are compiling for just one operating system, it may be easier to put
2182 these lines directly into &_Local/Makefile_&.
2183
2184 Keeping all your local configuration settings separate from the distributed
2185 files makes it easy to transfer them to new versions of Exim simply by copying
2186 the contents of the &_Local_& directory.
2187
2188
2189 .cindex "NIS lookup type" "including support for"
2190 .cindex "NIS+ lookup type" "including support for"
2191 .cindex "LDAP" "including support for"
2192 .cindex "lookup" "inclusion in binary"
2193 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2194 lookup, but not all systems have these components installed, so the default is
2195 not to include the relevant code in the binary. All the different kinds of file
2196 and database lookup that Exim supports are implemented as separate code modules
2197 which are included only if the relevant compile-time options are set. In the
2198 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2199 .code
2200 LOOKUP_LDAP=yes
2201 LOOKUP_NIS=yes
2202 LOOKUP_NISPLUS=yes
2203 .endd
2204 and similar settings apply to the other lookup types. They are all listed in
2205 &_src/EDITME_&. In many cases the relevant include files and interface
2206 libraries need to be installed before compiling Exim.
2207 .cindex "cdb" "including support for"
2208 However, there are some optional lookup types (such as cdb) for which
2209 the code is entirely contained within Exim, and no external include
2210 files or libraries are required. When a lookup type is not included in the
2211 binary, attempts to configure Exim to use it cause runtime configuration
2212 errors.
2213
2214 .cindex "pkg-config" "lookups"
2215 .cindex "pkg-config" "authenticators"
2216 Many systems now use a tool called &'pkg-config'& to encapsulate information
2217 about how to compile against a library; Exim has some initial support for
2218 being able to use pkg-config for lookups and authenticators.  For any given
2219 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2220 variable with the &`_PC`& suffix in the name and assign as the value the
2221 name of the package to be queried.  The results of querying via the
2222 &'pkg-config'& command will be added to the appropriate Makefile variables
2223 with &`+=`& directives, so your version of &'make'& will need to support that
2224 syntax.  For instance:
2225 .code
2226 LOOKUP_SQLITE=yes
2227 LOOKUP_SQLITE_PC=sqlite3
2228 AUTH_GSASL=yes
2229 AUTH_GSASL_PC=libgsasl
2230 AUTH_HEIMDAL_GSSAPI=yes
2231 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2232 .endd
2233
2234 .cindex "Perl" "including support for"
2235 Exim can be linked with an embedded Perl interpreter, allowing Perl
2236 subroutines to be called during string expansion. To enable this facility,
2237 .code
2238 EXIM_PERL=perl.o
2239 .endd
2240 must be defined in &_Local/Makefile_&. Details of this facility are given in
2241 chapter &<<CHAPperl>>&.
2242
2243 .cindex "X11 libraries, location of"
2244 The location of the X11 libraries is something that varies a lot between
2245 operating systems, and there may be different versions of X11 to cope
2246 with. Exim itself makes no use of X11, but if you are compiling the Exim
2247 monitor, the X11 libraries must be available.
2248 The following three variables are set in &_OS/Makefile-Default_&:
2249 .code
2250 X11=/usr/X11R6
2251 XINCLUDE=-I$(X11)/include
2252 XLFLAGS=-L$(X11)/lib
2253 .endd
2254 These are overridden in some of the operating-system configuration files. For
2255 example, in &_OS/Makefile-SunOS5_& there is
2256 .code
2257 X11=/usr/openwin
2258 XINCLUDE=-I$(X11)/include
2259 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2260 .endd
2261 If you need to override the default setting for your operating system, place a
2262 definition of all three of these variables into your
2263 &_Local/Makefile-<ostype>_& file.
2264
2265 .cindex "EXTRALIBS"
2266 If you need to add any extra libraries to the link steps, these can be put in a
2267 variable called EXTRALIBS, which appears in all the link commands, but by
2268 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2269 command for linking the main Exim binary, and not for any associated utilities.
2270
2271 .cindex "DBM libraries" "configuration for building"
2272 There is also DBMLIB, which appears in the link commands for binaries that
2273 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2274 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2275 binary, and which can be used, for example, to include additional X11
2276 libraries.
2277
2278 .cindex "configuration file" "editing"
2279 The make file copes with rebuilding Exim correctly if any of the configuration
2280 files are edited. However, if an optional configuration file is deleted, it is
2281 necessary to touch the associated non-optional file (that is,
2282 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2283
2284
2285 .section "OS-specific header files" "SECID30"
2286 .cindex "&_os.h_&"
2287 .cindex "building Exim" "OS-specific C header files"
2288 The &_OS_& directory contains a number of files with names of the form
2289 &_os.h-<ostype>_&. These are system-specific C header files that should not
2290 normally need to be changed. There is a list of macro settings that are
2291 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2292 are porting Exim to a new operating system.
2293
2294
2295
2296 .section "Overriding build-time options for the monitor" "SECID31"
2297 .cindex "building Eximon"
2298 A similar process is used for overriding things when building the Exim monitor,
2299 where the files that are involved are
2300 .display
2301 &_OS/eximon.conf-Default_&
2302 &_OS/eximon.conf-_&<&'ostype'&>
2303 &_Local/eximon.conf_&
2304 &_Local/eximon.conf-_&<&'ostype'&>
2305 &_Local/eximon.conf-_&<&'archtype'&>
2306 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2307 .endd
2308 .cindex "&_Local/eximon.conf_&"
2309 As with Exim itself, the final three files need not exist, and in this case the
2310 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2311 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2312 variables of the same name, preceded by EXIMON_. For example, setting
2313 EXIMON_LOG_DEPTH in the environment overrides the value of
2314 LOG_DEPTH at runtime.
2315 .ecindex IIDbuex
2316
2317
2318 .section "Installing Exim binaries and scripts" "SECID32"
2319 .cindex "installing Exim"
2320 .cindex "BIN_DIRECTORY"
2321 The command &`make install`& runs the &(exim_install)& script with no
2322 arguments. The script copies binaries and utility scripts into the directory
2323 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2324 .cindex "setuid" "installing Exim with"
2325 The install script copies files only if they are newer than the files they are
2326 going to replace. The Exim binary is required to be owned by root and have the
2327 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2328 install`& as root so that it can set up the Exim binary in this way. However, in
2329 some special situations (for example, if a host is doing no local deliveries)
2330 it may be possible to run Exim without making the binary setuid root (see
2331 chapter &<<CHAPsecurity>>& for details).
2332
2333 .cindex "CONFIGURE_FILE"
2334 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2335 in &_Local/Makefile_&. If this names a single file, and the file does not
2336 exist, the default configuration file &_src/configure.default_& is copied there
2337 by the installation script. If a runtime configuration file already exists, it
2338 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2339 alternative files, no default is installed.
2340
2341 .cindex "system aliases file"
2342 .cindex "&_/etc/aliases_&"
2343 One change is made to the default configuration file when it is installed: the
2344 default configuration contains a router that references a system aliases file.
2345 The path to this file is set to the value specified by
2346 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2347 If the system aliases file does not exist, the installation script creates it,
2348 and outputs a comment to the user.
2349
2350 The created file contains no aliases, but it does contain comments about the
2351 aliases a site should normally have. Mail aliases have traditionally been
2352 kept in &_/etc/aliases_&. However, some operating systems are now using
2353 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2354 Exim's configuration if necessary.
2355
2356 The default configuration uses the local host's name as the only local domain,
2357 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2358 running as the local user. System aliases and &_.forward_& files in users' home
2359 directories are supported, but no NIS or NIS+ support is configured. Domains
2360 other than the name of the local host are routed using the DNS, with delivery
2361 over SMTP.
2362
2363 It is possible to install Exim for special purposes (such as building a binary
2364 distribution) in a private part of the file system. You can do this by a
2365 command such as
2366 .code
2367 make DESTDIR=/some/directory/ install
2368 .endd
2369 This has the effect of pre-pending the specified directory to all the file
2370 paths, except the name of the system aliases file that appears in the default
2371 configuration. (If a default alias file is created, its name &'is'& modified.)
2372 For backwards compatibility, ROOT is used if DESTDIR is not set,
2373 but this usage is deprecated.
2374
2375 .cindex "installing Exim" "what is not installed"
2376 Running &'make install'& does not copy the Exim 4 conversion script
2377 &'convert4r4'&. You will probably run this only once if you are
2378 upgrading from Exim 3. None of the documentation files in the &_doc_&
2379 directory are copied, except for the info files when you have set
2380 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2381
2382 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2383 to their names. The Exim binary itself, however, is handled differently. It is
2384 installed under a name that includes the version number and the compile number,
2385 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2386 called &_exim_& to point to the binary. If you are updating a previous version
2387 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2388 from the directory (as seen by other processes).
2389
2390 .cindex "installing Exim" "testing the script"
2391 If you want to see what the &'make install'& will do before running it for
2392 real, you can pass the &%-n%& option to the installation script by this
2393 command:
2394 .code
2395 make INSTALL_ARG=-n install
2396 .endd
2397 The contents of the variable INSTALL_ARG are passed to the installation
2398 script. You do not need to be root to run this test. Alternatively, you can run
2399 the installation script directly, but this must be from within the build
2400 directory. For example, from the top-level Exim directory you could use this
2401 command:
2402 .code
2403 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2404 .endd
2405 .cindex "installing Exim" "install script options"
2406 There are two other options that can be supplied to the installation script.
2407
2408 .ilist
2409 &%-no_chown%& bypasses the call to change the owner of the installed binary
2410 to root, and the call to make it a setuid binary.
2411 .next
2412 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2413 installed binary.
2414 .endlist
2415
2416 INSTALL_ARG can be used to pass these options to the script. For example:
2417 .code
2418 make INSTALL_ARG=-no_symlink install
2419 .endd
2420 The installation script can also be given arguments specifying which files are
2421 to be copied. For example, to install just the Exim binary, and nothing else,
2422 without creating the symbolic link, you could use:
2423 .code
2424 make INSTALL_ARG='-no_symlink exim' install
2425 .endd
2426
2427
2428
2429 .section "Installing info documentation" "SECTinsinfdoc"
2430 .cindex "installing Exim" "&'info'& documentation"
2431 Not all systems use the GNU &'info'& system for documentation, and for this
2432 reason, the Texinfo source of Exim's documentation is not included in the main
2433 distribution. Instead it is available separately from the FTP site (see section
2434 &<<SECTavail>>&).
2435
2436 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2437 source of the documentation is found in the source tree, running &`make
2438 install`& automatically builds the info files and installs them.
2439
2440
2441
2442 .section "Setting up the spool directory" "SECID33"
2443 .cindex "spool directory" "creating"
2444 When it starts up, Exim tries to create its spool directory if it does not
2445 exist. The Exim uid and gid are used for the owner and group of the spool
2446 directory. Sub-directories are automatically created in the spool directory as
2447 necessary.
2448
2449
2450
2451
2452 .section "Testing" "SECID34"
2453 .cindex "testing" "installation"
2454 Having installed Exim, you can check that the runtime configuration file is
2455 syntactically valid by running the following command, which assumes that the
2456 Exim binary directory is within your PATH environment variable:
2457 .code
2458 exim -bV
2459 .endd
2460 If there are any errors in the configuration file, Exim outputs error messages.
2461 Otherwise it outputs the version number and build date,
2462 the DBM library that is being used, and information about which drivers and
2463 other optional code modules are included in the binary.
2464 Some simple routing tests can be done by using the address testing option. For
2465 example,
2466 .display
2467 &`exim -bt`& <&'local username'&>
2468 .endd
2469 should verify that it recognizes a local mailbox, and
2470 .display
2471 &`exim -bt`& <&'remote address'&>
2472 .endd
2473 a remote one. Then try getting it to deliver mail, both locally and remotely.
2474 This can be done by passing messages directly to Exim, without going through a
2475 user agent. For example:
2476 .code
2477 exim -v postmaster@your.domain.example
2478 From: user@your.domain.example
2479 To: postmaster@your.domain.example
2480 Subject: Testing Exim
2481
2482 This is a test message.
2483 ^D
2484 .endd
2485 The &%-v%& option causes Exim to output some verification of what it is doing.
2486 In this case you should see copies of three log lines, one for the message's
2487 arrival, one for its delivery, and one containing &"Completed"&.
2488
2489 .cindex "delivery" "problems with"
2490 If you encounter problems, look at Exim's log files (&'mainlog'& and
2491 &'paniclog'&) to see if there is any relevant information there. Another source
2492 of information is running Exim with debugging turned on, by specifying the
2493 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2494 with debugging turned on by a command of the form
2495 .display
2496 &`exim -d -M`& <&'exim-message-id'&>
2497 .endd
2498 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2499 produces rather a lot of output, but you can cut this down to specific areas.
2500 For example, if you use &%-d-all+route%& only the debugging information
2501 relevant to routing is included. (See the &%-d%& option in chapter
2502 &<<CHAPcommandline>>& for more details.)
2503
2504 .cindex '&"sticky"& bit'
2505 .cindex "lock files"
2506 One specific problem that has shown up on some sites is the inability to do
2507 local deliveries into a shared mailbox directory, because it does not have the
2508 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2509 writing to a mailbox file, and if it cannot create the lock file, the delivery
2510 is deferred. You can get round this either by setting the &"sticky bit"& on the
2511 directory, or by setting a specific group for local deliveries and allowing
2512 that group to create files in the directory (see the comments above the
2513 &(local_delivery)& transport in the default configuration file). Another
2514 approach is to configure Exim not to use lock files, but just to rely on
2515 &[fcntl()]& locking instead. However, you should do this only if all user
2516 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2517 see chapter &<<CHAPappendfile>>&.
2518
2519 One thing that cannot be tested on a system that is already running an MTA is
2520 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2521 &%-oX%& option can be used to run an Exim daemon that listens on some other
2522 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2523 &'exim_checkaccess'& utility can be used to check out policy controls on
2524 incoming SMTP mail.
2525
2526 Testing a new version on a system that is already running Exim can most easily
2527 be done by building a binary with a different CONFIGURE_FILE setting. From
2528 within the runtime configuration, all other file and directory names
2529 that Exim uses can be altered, in order to keep it entirely clear of the
2530 production version.
2531
2532
2533 .section "Replacing another MTA with Exim" "SECID35"
2534 .cindex "replacing another MTA"
2535 Building and installing Exim for the first time does not of itself put it in
2536 general use. The name by which the system's MTA is called by mail user agents
2537 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2538 operating system), and it is necessary to make this name point to the &'exim'&
2539 binary in order to get the user agents to pass messages to Exim. This is
2540 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2541 or &_/usr/lib/sendmail_&
2542 .cindex "symbolic link" "to &'exim'& binary"
2543 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2544 privilege and executable status from the old MTA. It is then necessary to stop
2545 and restart the mailer daemon, if one is running.
2546
2547 .cindex "FreeBSD, MTA indirection"
2548 .cindex "&_/etc/mail/mailer.conf_&"
2549 Some operating systems have introduced alternative ways of switching MTAs. For
2550 example, if you are running FreeBSD, you need to edit the file
2551 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2552 described. A typical example of the contents of this file for running Exim is
2553 as follows:
2554 .code
2555 sendmail            /usr/exim/bin/exim
2556 send-mail           /usr/exim/bin/exim
2557 mailq               /usr/exim/bin/exim -bp
2558 newaliases          /usr/bin/true
2559 .endd
2560 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2561 your Exim installation is &"live"&. Check it by sending a message from your
2562 favourite user agent.
2563
2564 You should consider what to tell your users about the change of MTA. Exim may
2565 have different capabilities to what was previously running, and there are
2566 various operational differences such as the text of messages produced by
2567 command line options and in bounce messages. If you allow your users to make
2568 use of Exim's filtering capabilities, you should make the document entitled
2569 &'Exim's interface to mail filtering'& available to them.
2570
2571
2572
2573 .section "Upgrading Exim" "SECID36"
2574 .cindex "upgrading Exim"
2575 If you are already running Exim on your host, building and installing a new
2576 version automatically makes it available to MUAs, or any other programs that
2577 call the MTA directly. However, if you are running an Exim daemon, you do need
2578 .cindex restart "on HUP signal"
2579 .cindex signal "HUP, to restart"
2580 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2581 new binary. You do not need to stop processing mail in order to install a new
2582 version of Exim. The install script does not modify an existing runtime
2583 configuration file.
2584
2585
2586
2587
2588 .section "Stopping the Exim daemon on Solaris" "SECID37"
2589 .cindex "Solaris" "stopping Exim on"
2590 The standard command for stopping the mailer daemon on Solaris is
2591 .code
2592 /etc/init.d/sendmail stop
2593 .endd
2594 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2595 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2596 for the text &"sendmail"&; this is not present because the actual program name
2597 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2598 solution is to replace the line that finds the process id with something like
2599 .code
2600 pid=`cat /var/spool/exim/exim-daemon.pid`
2601 .endd
2602 to obtain the daemon's pid directly from the file that Exim saves it in.
2603
2604 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2605 still be received from local processes, and if automatic delivery is configured
2606 (the normal case), deliveries will still occur.
2607
2608
2609
2610
2611 . ////////////////////////////////////////////////////////////////////////////
2612 . ////////////////////////////////////////////////////////////////////////////
2613
2614 .chapter "The Exim command line" "CHAPcommandline"
2615 .scindex IIDclo1 "command line" "options"
2616 .scindex IIDclo2 "options" "command line"
2617 Exim's command line takes the standard Unix form of a sequence of options,
2618 each starting with a hyphen character, followed by a number of arguments. The
2619 options are compatible with the main options of Sendmail, and there are also
2620 some additional options, some of which are compatible with Smail 3. Certain
2621 combinations of options do not make sense, and provoke an error if used.
2622 The form of the arguments depends on which options are set.
2623
2624
2625 .section "Setting options by program name" "SECID38"
2626 .cindex "&'mailq'&"
2627 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2628 were present before any other options.
2629 The &%-bp%& option requests a listing of the contents of the mail queue on the
2630 standard output.
2631 This feature is for compatibility with some systems that contain a command of
2632 that name in one of the standard libraries, symbolically linked to
2633 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2634
2635 .cindex "&'rsmtp'&"
2636 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2637 were present before any other options, for compatibility with Smail. The
2638 &%-bS%& option is used for reading in a number of messages in batched SMTP
2639 format.
2640
2641 .cindex "&'rmail'&"
2642 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2643 &%-oee%& options were present before any other options, for compatibility with
2644 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2645
2646 .cindex "&'runq'&"
2647 .cindex "queue runner"
2648 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2649 were present before any other options, for compatibility with Smail. The &%-q%&
2650 option causes a single queue runner process to be started.
2651
2652 .cindex "&'newaliases'&"
2653 .cindex "alias file" "building"
2654 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2655 If Exim is called under the name &'newaliases'& it behaves as if the option
2656 &%-bi%& were present before any other options, for compatibility with Sendmail.
2657 This option is used for rebuilding Sendmail's alias file. Exim does not have
2658 the concept of a single alias file, but can be configured to run a given
2659 command if called with the &%-bi%& option.
2660
2661
2662 .section "Trusted and admin users" "SECTtrustedadmin"
2663 Some Exim options are available only to &'trusted users'& and others are
2664 available only to &'admin users'&. In the description below, the phrases &"Exim
2665 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2666 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2667 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2668
2669 .ilist
2670 .cindex "trusted users" "definition of"
2671 .cindex "user" "trusted definition of"
2672 The trusted users are root, the Exim user, any user listed in the
2673 &%trusted_users%& configuration option, and any user whose current group or any
2674 supplementary group is one of those listed in the &%trusted_groups%&
2675 configuration option. Note that the Exim group is not automatically trusted.
2676
2677 .cindex '&"From"& line'
2678 .cindex "envelope from"
2679 .cindex "envelope sender"
2680 Trusted users are always permitted to use the &%-f%& option or a leading
2681 &"From&~"& line to specify the envelope sender of a message that is passed to
2682 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2683 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2684 users to set envelope senders.
2685
2686 .cindex "&'From:'& header line"
2687 .cindex "&'Sender:'& header line"
2688 .cindex "header lines" "From:"
2689 .cindex "header lines" "Sender:"
2690 For a trusted user, there is never any check on the contents of the &'From:'&
2691 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2692 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2693
2694 Trusted users may also specify a host name, host address, interface address,
2695 protocol name, ident value, and authentication data when submitting a message
2696 locally. Thus, they are able to insert messages into Exim's queue locally that
2697 have the characteristics of messages received from a remote host. Untrusted
2698 users may in some circumstances use &%-f%&, but can never set the other values
2699 that are available to trusted users.
2700 .next
2701 .cindex "user" "admin definition of"
2702 .cindex "admin user" "definition of"
2703 The admin users are root, the Exim user, and any user that is a member of the
2704 Exim group or of any group listed in the &%admin_groups%& configuration option.
2705 The current group does not have to be one of these groups.
2706
2707 Admin users are permitted to list the queue, and to carry out certain
2708 operations on messages, for example, to force delivery failures. It is also
2709 necessary to be an admin user in order to see the full information provided by
2710 the Exim monitor, and full debugging output.
2711
2712 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2713 Exim to attempt delivery of messages on its queue is restricted to admin users.
2714 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2715 option false (that is, specifying &%no_prod_requires_admin%&).
2716
2717 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2718 is restricted to admin users unless &%queue_list_requires_admin%& is set
2719 false.
2720 .endlist
2721
2722
2723 &*Warning*&: If you configure your system so that admin users are able to
2724 edit Exim's configuration file, you are giving those users an easy way of
2725 getting root. There is further discussion of this issue at the start of chapter
2726 &<<CHAPconf>>&.
2727
2728
2729
2730
2731 .section "Command line options" "SECID39"
2732 Exim's command line options are described in alphabetical order below. If none
2733 of the options that specifies a specific action (such as starting the daemon or
2734 a queue runner, or testing an address, or receiving a message in a specific
2735 format, or listing the queue) are present, and there is at least one argument
2736 on the command line, &%-bm%& (accept a local message on the standard input,
2737 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2738 outputs a brief message about itself and exits.
2739
2740 . ////////////////////////////////////////////////////////////////////////////
2741 . Insert a stylized XML comment here, to identify the start of the command line
2742 . options. This is for the benefit of the Perl script that automatically
2743 . creates a man page for the options.
2744 . ////////////////////////////////////////////////////////////////////////////
2745
2746 .literal xml
2747 <!-- === Start of command line options === -->
2748 .literal off
2749
2750
2751 .vlist
2752 .vitem &%--%&
2753 .oindex "--"
2754 .cindex "options" "command line; terminating"
2755 This is a pseudo-option whose only purpose is to terminate the options and
2756 therefore to cause subsequent command line items to be treated as arguments
2757 rather than options, even if they begin with hyphens.
2758
2759 .vitem &%--help%&
2760 .oindex "&%--help%&"
2761 This option causes Exim to output a few sentences stating what it is.
2762 The same output is generated if the Exim binary is called with no options and
2763 no arguments.
2764
2765 .vitem &%--version%&
2766 .oindex "&%--version%&"
2767 This option is an alias for &%-bV%& and causes version information to be
2768 displayed.
2769
2770 .vitem &%-Ac%& &&&
2771        &%-Am%&
2772 .oindex "&%-Ac%&"
2773 .oindex "&%-Am%&"
2774 These options are used by Sendmail for selecting configuration files and are
2775 ignored by Exim.
2776
2777 .vitem &%-B%&<&'type'&>
2778 .oindex "&%-B%&"
2779 .cindex "8-bit characters"
2780 .cindex "Sendmail compatibility" "8-bit characters"
2781 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2782 clean; it ignores this option.
2783
2784 .vitem &%-bd%&
2785 .oindex "&%-bd%&"
2786 .cindex "daemon"
2787 .cindex "SMTP" "listener"
2788 .cindex "queue runner"
2789 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2790 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2791 that the daemon should also initiate periodic queue runs.
2792
2793 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2794 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2795 disconnect from the controlling terminal. When running this way, it can be
2796 stopped by pressing ctrl-C.
2797
2798 By default, Exim listens for incoming connections to the standard SMTP port on
2799 all the host's running interfaces. However, it is possible to listen on other
2800 ports, on multiple ports, and only on specific interfaces. Chapter
2801 &<<CHAPinterfaces>>& contains a description of the options that control this.
2802
2803 When a listening daemon
2804 .cindex "daemon" "process id (pid)"
2805 .cindex "pid (process id)" "of daemon"
2806 is started without the use of &%-oX%& (that is, without overriding the normal
2807 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2808 in Exim's spool directory. This location can be overridden by setting
2809 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2810 running as root.
2811
2812 When &%-oX%& is used on the command line to start a listening daemon, the
2813 process id is not written to the normal pid file path. However, &%-oP%& can be
2814 used to specify a path on the command line if a pid file is required.
2815
2816 The SIGHUP signal
2817 .cindex "SIGHUP"
2818 .cindex restart "on HUP signal"
2819 .cindex signal "HUP, to restart"
2820 .cindex "daemon" "restarting"
2821 .cindex signal "to reload configuration"
2822 .cindex daemon "reload configuration"
2823 .cindex reload configuration
2824 can be used to cause the daemon to re-execute itself. This should be done
2825 whenever Exim's configuration file, or any file that is incorporated into it by
2826 means of the &%.include%& facility, is changed, and also whenever a new version
2827 of Exim is installed. It is not necessary to do this when other files that are
2828 referenced from the configuration (for example, alias files) are changed,
2829 because these are reread each time they are used.
2830
2831 .vitem &%-bdf%&
2832 .oindex "&%-bdf%&"
2833 This option has the same effect as &%-bd%& except that it never disconnects
2834 from the controlling terminal, even when no debugging is specified.
2835
2836 .vitem &%-be%&
2837 .oindex "&%-be%&"
2838 .cindex "testing" "string expansion"
2839 .cindex "expansion" "testing"
2840 Run Exim in expansion testing mode. Exim discards its root privilege, to
2841 prevent ordinary users from using this mode to read otherwise inaccessible
2842 files. If no arguments are given, Exim runs interactively, prompting for lines
2843 of data. Otherwise, it processes each argument in turn.
2844
2845 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2846 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2847 used without command line arguments. If successful, it uses the &[readline()]&
2848 function, which provides extensive line-editing facilities, for reading the
2849 test data. A line history is supported.
2850
2851 Long expansion expressions can be split over several lines by using backslash
2852 continuations. As in Exim's runtime configuration, white space at the start of
2853 continuation lines is ignored. Each argument or data line is passed through the
2854 string expansion mechanism, and the result is output. Variable values from the
2855 configuration file (for example, &$qualify_domain$&) are available, but no
2856 message-specific values (such as &$message_exim_id$&) are set, because no message
2857 is being processed (but see &%-bem%& and &%-Mset%&).
2858
2859 &*Note*&: If you use this mechanism to test lookups, and you change the data
2860 files or databases you are using, you must exit and restart Exim before trying
2861 the same lookup again. Otherwise, because each Exim process caches the results
2862 of lookups, you will just get the same result as before.
2863
2864 Macro processing is done on lines before string-expansion: new macros can be
2865 defined and macros will be expanded.
2866 Because macros in the config file are often used for secrets, those are only
2867 available to admin users.
2868
2869 .vitem &%-bem%&&~<&'filename'&>
2870 .oindex "&%-bem%&"
2871 .cindex "testing" "string expansion"
2872 .cindex "expansion" "testing"
2873 This option operates like &%-be%& except that it must be followed by the name
2874 of a file. For example:
2875 .code
2876 exim -bem /tmp/testmessage
2877 .endd
2878 The file is read as a message (as if receiving a locally-submitted non-SMTP
2879 message) before any of the test expansions are done. Thus, message-specific
2880 variables such as &$message_size$& and &$header_from:$& are available. However,
2881 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2882 recipients are read from the headers in the normal way, and are shown in the
2883 &$recipients$& variable. Note that recipients cannot be given on the command
2884 line, because further arguments are taken as strings to expand (just like
2885 &%-be%&).
2886
2887 .vitem &%-bF%&&~<&'filename'&>
2888 .oindex "&%-bF%&"
2889 .cindex "system filter" "testing"
2890 .cindex "testing" "system filter"
2891 This option is the same as &%-bf%& except that it assumes that the filter being
2892 tested is a system filter. The additional commands that are available only in
2893 system filters are recognized.
2894
2895 .vitem &%-bf%&&~<&'filename'&>
2896 .oindex "&%-bf%&"
2897 .cindex "filter" "testing"
2898 .cindex "testing" "filter file"
2899 .cindex "forward file" "testing"
2900 .cindex "testing" "forward file"
2901 .cindex "Sieve filter" "testing"
2902 This option runs Exim in user filter testing mode; the file is the filter file
2903 to be tested, and a test message must be supplied on the standard input. If
2904 there are no message-dependent tests in the filter, an empty file can be
2905 supplied.
2906
2907 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2908 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2909 filter and a user filter in the same run. For example:
2910 .code
2911 exim -bF /system/filter -bf /user/filter </test/message
2912 .endd
2913 This is helpful when the system filter adds header lines or sets filter
2914 variables that are used by the user filter.
2915
2916 If the test filter file does not begin with one of the special lines
2917 .code
2918 # Exim filter
2919 # Sieve filter
2920 .endd
2921 it is taken to be a normal &_.forward_& file, and is tested for validity under
2922 that interpretation. See sections &<<SECTitenonfilred>>& to
2923 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2924 redirection lists.
2925
2926 The result of an Exim command that uses &%-bf%&, provided no errors are
2927 detected, is a list of the actions that Exim would try to take if presented
2928 with the message for real. More details of filter testing are given in the
2929 separate document entitled &'Exim's interfaces to mail filtering'&.
2930
2931 When testing a filter file,
2932 .cindex "&""From""& line"
2933 .cindex "envelope from"
2934 .cindex "envelope sender"
2935 .oindex "&%-f%&" "for filter testing"
2936 the envelope sender can be set by the &%-f%& option,
2937 or by a &"From&~"& line at the start of the test message. Various parameters
2938 that would normally be taken from the envelope recipient address of the message
2939 can be set by means of additional command line options (see the next four
2940 options).
2941
2942 .vitem &%-bfd%&&~<&'domain'&>
2943 .oindex "&%-bfd%&"
2944 .vindex "&$qualify_domain$&"
2945 This sets the domain of the recipient address when a filter file is being
2946 tested by means of the &%-bf%& option. The default is the value of
2947 &$qualify_domain$&.
2948
2949 .vitem &%-bfl%&&~<&'local&~part'&>
2950 .oindex "&%-bfl%&"
2951 This sets the local part of the recipient address when a filter file is being
2952 tested by means of the &%-bf%& option. The default is the username of the
2953 process that calls Exim. A local part should be specified with any prefix or
2954 suffix stripped, because that is how it appears to the filter when a message is
2955 actually being delivered.
2956
2957 .vitem &%-bfp%&&~<&'prefix'&>
2958 .oindex "&%-bfp%&"
2959 .cindex affix "filter testing"
2960 This sets the prefix of the local part of the recipient address when a filter
2961 file is being tested by means of the &%-bf%& option. The default is an empty
2962 prefix.
2963
2964 .vitem &%-bfs%&&~<&'suffix'&>
2965 .oindex "&%-bfs%&"
2966 .cindex affix "filter testing"
2967 This sets the suffix of the local part of the recipient address when a filter
2968 file is being tested by means of the &%-bf%& option. The default is an empty
2969 suffix.
2970
2971 .vitem &%-bh%&&~<&'IP&~address'&>
2972 .oindex "&%-bh%&"
2973 .cindex "testing" "incoming SMTP"
2974 .cindex "SMTP" "testing incoming"
2975 .cindex "testing" "relay control"
2976 .cindex "relaying" "testing configuration"
2977 .cindex "policy control" "testing"
2978 .cindex "debugging" "&%-bh%& option"
2979 This option runs a fake SMTP session as if from the given IP address, using the
2980 standard input and output. The IP address may include a port number at the end,
2981 after a full stop. For example:
2982 .code
2983 exim -bh 10.9.8.7.1234
2984 exim -bh fe80::a00:20ff:fe86:a061.5678
2985 .endd
2986 When an IPv6 address is given, it is converted into canonical form. In the case
2987 of the second example above, the value of &$sender_host_address$& after
2988 conversion to the canonical form is
2989 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2990
2991 Comments as to what is going on are written to the standard error file. These
2992 include lines beginning with &"LOG"& for anything that would have been logged.
2993 This facility is provided for testing configuration options for incoming
2994 messages, to make sure they implement the required policy. For example, you can
2995 test your relay controls using &%-bh%&.
2996
2997 &*Warning 1*&:
2998 .cindex "RFC 1413"
2999 You can test features of the configuration that rely on ident (RFC 1413)
3000 information by using the &%-oMt%& option. However, Exim cannot actually perform
3001 an ident callout when testing using &%-bh%& because there is no incoming SMTP
3002 connection.
3003
3004 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
3005 are also skipped when testing using &%-bh%&. If you want these callouts to
3006 occur, use &%-bhc%& instead.
3007
3008 Messages supplied during the testing session are discarded, and nothing is
3009 written to any of the real log files. There may be pauses when DNS (and other)
3010 lookups are taking place, and of course these may time out. The &%-oMi%& option
3011 can be used to specify a specific IP interface and port if this is important,
3012 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
3013 session were authenticated.
3014
3015 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3016 output just states whether a given recipient address from a given host is
3017 acceptable or not. See section &<<SECTcheckaccess>>&.
3018
3019 Features such as authentication and encryption, where the client input is not
3020 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3021 specialized SMTP test program such as
3022 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3023
3024 .vitem &%-bhc%&&~<&'IP&~address'&>
3025 .oindex "&%-bhc%&"
3026 This option operates in the same way as &%-bh%&, except that address
3027 verification callouts are performed if required. This includes consulting and
3028 updating the callout cache database.
3029
3030 .vitem &%-bi%&
3031 .oindex "&%-bi%&"
3032 .cindex "alias file" "building"
3033 .cindex "building alias file"
3034 .cindex "Sendmail compatibility" "&%-bi%& option"
3035 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3036 Exim does not have the concept of a single alias file, and so it cannot mimic
3037 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3038 tend to appear in various scripts such as NIS make files, so the option must be
3039 recognized.
3040
3041 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3042 configuration option is run, under the uid and gid of the caller of Exim. If
3043 the &%-oA%& option is used, its value is passed to the command as an argument.
3044 The command set by &%bi_command%& may not contain arguments. The command can
3045 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3046 if this is required. If the &%bi_command%& option is not set, calling Exim with
3047 &%-bi%& is a no-op.
3048
3049 . // Keep :help first, then the rest in alphabetical order
3050 .vitem &%-bI:help%&
3051 .oindex "&%-bI:help%&"
3052 .cindex "querying exim information"
3053 We shall provide various options starting &`-bI:`& for querying Exim for
3054 information.  The output of many of these will be intended for machine
3055 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3056 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3057 options shall cause Exim to exit after producing the requested output.
3058
3059 .vitem &%-bI:dscp%&
3060 .oindex "&%-bI:dscp%&"
3061 .cindex "DSCP" "values"
3062 This option causes Exim to emit an alphabetically sorted list of all
3063 recognised DSCP names.
3064
3065 .vitem &%-bI:sieve%&
3066 .oindex "&%-bI:sieve%&"
3067 .cindex "Sieve filter" "capabilities"
3068 This option causes Exim to emit an alphabetically sorted list of all supported
3069 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3070 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3071 &`SIEVE`& capability response line.  As the precise list may depend upon
3072 compile-time build options, which this option will adapt to, this is the only
3073 way to guarantee a correct response.
3074
3075 .vitem &%-bm%&
3076 .oindex "&%-bm%&"
3077 .cindex "local message reception"
3078 This option runs an Exim receiving process that accepts an incoming,
3079 locally-generated message on the standard input. The recipients are given as the
3080 command arguments (except when &%-t%& is also present &-- see below). Each
3081 argument can be a comma-separated list of RFC 2822 addresses. This is the
3082 default option for selecting the overall action of an Exim call; it is assumed
3083 if no other conflicting option is present.
3084
3085 If any addresses in the message are unqualified (have no domain), they are
3086 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3087 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3088 suppressing this for special cases.
3089
3090 Policy checks on the contents of local messages can be enforced by means of
3091 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3092
3093 .cindex "return code" "for &%-bm%&"
3094 The return code is zero if the message is successfully accepted. Otherwise, the
3095 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3096
3097 The format
3098 .cindex "message" "format"
3099 .cindex "format" "message"
3100 .cindex "&""From""& line"
3101 .cindex "UUCP" "&""From""& line"
3102 .cindex "Sendmail compatibility" "&""From""& line"
3103 of the message must be as defined in RFC 2822, except that, for
3104 compatibility with Sendmail and Smail, a line in one of the forms
3105 .code
3106 From sender Fri Jan  5 12:55 GMT 1997
3107 From sender Fri, 5 Jan 97 12:55:01
3108 .endd
3109 (with the weekday optional, and possibly with additional text after the date)
3110 is permitted to appear at the start of the message. There appears to be no
3111 authoritative specification of the format of this line. Exim recognizes it by
3112 matching against the regular expression defined by the &%uucp_from_pattern%&
3113 option, which can be changed if necessary.
3114
3115 .oindex "&%-f%&" "overriding &""From""& line"
3116 The specified sender is treated as if it were given as the argument to the
3117 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3118 preference to the address taken from the message. The caller of Exim must be a
3119 trusted user for the sender of a message to be set in this way.
3120
3121 .vitem &%-bmalware%&&~<&'filename'&>
3122 .oindex "&%-bmalware%&"
3123 .cindex "testing", "malware"
3124 .cindex "malware scan test"
3125 This debugging option causes Exim to scan the given file or directory
3126 (depending on the used scanner interface),
3127 using the malware scanning framework.  The option of &%av_scanner%& influences
3128 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3129 the expansion should have defaults which apply to this invocation.  ACLs are
3130 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3131 will never be populated and &%-bmalware%& will fail.
3132
3133 Exim will have changed working directory before resolving the filename, so
3134 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3135 user when it tries to open the file, rather than as the invoking user.
3136 This option requires admin privileges.
3137
3138 The &%-bmalware%& option will not be extended to be more generally useful,
3139 there are better tools for file-scanning.  This option exists to help
3140 administrators verify their Exim and AV scanner configuration.
3141
3142 .vitem &%-bnq%&
3143 .oindex "&%-bnq%&"
3144 .cindex "address qualification, suppressing"
3145 By default, Exim automatically qualifies unqualified addresses (those
3146 without domains) that appear in messages that are submitted locally (that
3147 is, not over TCP/IP). This qualification applies both to addresses in
3148 envelopes, and addresses in header lines. Sender addresses are qualified using
3149 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3150 defaults to the value of &%qualify_domain%&).
3151
3152 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3153 being used to re-submit messages that originally came from remote hosts after
3154 content scanning, you probably do not want to qualify unqualified addresses in
3155 header lines. (Such lines will be present only if you have not enabled a header
3156 syntax check in the appropriate ACL.)
3157
3158 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3159 messages that originate on the local host. When this is used, unqualified
3160 addresses in the envelope provoke errors (causing message rejection) and
3161 unqualified addresses in header lines are left alone.
3162
3163
3164 .vitem &%-bP%&
3165 .oindex "&%-bP%&"
3166 .cindex "configuration options" "extracting"
3167 .cindex "options" "configuration &-- extracting"
3168 If this option is given with no arguments, it causes the values of all Exim's
3169 main configuration options to be written to the standard output. The values
3170 of one or more specific options can be requested by giving their names as
3171 arguments, for example:
3172 .code
3173 exim -bP qualify_domain hold_domains
3174 .endd
3175 .cindex "hiding configuration option values"
3176 .cindex "configuration options" "hiding value of"
3177 .cindex "options" "hiding value of"
3178 However, any option setting that is preceded by the word &"hide"& in the
3179 configuration file is not shown in full, except to an admin user. For other
3180 users, the output is as in this example:
3181 .code
3182 mysql_servers = <value not displayable>
3183 .endd
3184 If &%config%& is given as an argument, the config is
3185 output, as it was parsed, any include file resolved, any comment removed.
3186
3187 If &%config_file%& is given as an argument, the name of the runtime
3188 configuration file is output. (&%configure_file%& works too, for
3189 backward compatibility.)
3190 If a list of configuration files was supplied, the value that is output here
3191 is the name of the file that was actually used.
3192
3193 .cindex "options" "hiding name of"
3194 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3195 name will not be output.
3196
3197 .cindex "daemon" "process id (pid)"
3198 .cindex "pid (process id)" "of daemon"
3199 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3200 directories where log files and daemon pid files are written are output,
3201 respectively. If these values are unset, log files are written in a
3202 sub-directory of the spool directory called &%log%&, and the pid file is
3203 written directly into the spool directory.
3204
3205 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3206 .code
3207 exim -bP +local_domains
3208 .endd
3209 it searches for a matching named list of any type (domain, host, address, or
3210 local part) and outputs what it finds.
3211
3212 .cindex "options" "router &-- extracting"
3213 .cindex "options" "transport &-- extracting"
3214 .cindex "options" "authenticator &-- extracting"
3215 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3216 followed by the name of an appropriate driver instance, the option settings for
3217 that driver are output. For example:
3218 .code
3219 exim -bP transport local_delivery
3220 .endd
3221 The generic driver options are output first, followed by the driver's private
3222 options. A list of the names of drivers of a particular type can be obtained by
3223 using one of the words &%router_list%&, &%transport_list%&, or
3224 &%authenticator_list%&, and a complete list of all drivers with their option
3225 settings can be obtained by using &%routers%&, &%transports%&, or
3226 &%authenticators%&.
3227
3228 .cindex "environment"
3229 If &%environment%& is given as an argument, the set of environment
3230 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3231 variables.
3232
3233 .cindex "options" "macro &-- extracting"
3234 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3235 are available, similarly to the drivers.  Because macros are sometimes used
3236 for storing passwords, this option is restricted.
3237 The output format is one item per line.
3238 For the "-bP macro <name>" form, if no such macro is found
3239 the exit status will be nonzero.
3240
3241 .vitem &%-bp%&
3242 .oindex "&%-bp%&"
3243 .cindex "queue" "listing messages in"
3244 .cindex "listing" "messages in the queue"
3245 This option requests a listing of the contents of the mail queue on the
3246 standard output. If the &%-bp%& option is followed by a list of message ids,
3247 just those messages are listed. By default, this option can be used only by an
3248 admin user. However, the &%queue_list_requires_admin%& option can be set false
3249 to allow any user to see the queue.
3250
3251 Each message in the queue is displayed as in the following example:
3252 .code
3253 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3254           red.king@looking-glass.fict.example
3255           <other addresses>
3256 .endd
3257 .cindex "message" "size in queue listing"
3258 .cindex "size" "of message"
3259 The first line contains the length of time the message has been in the queue
3260 (in this case 25 minutes), the size of the message (2.9K), the unique local
3261 identifier for the message, and the message sender, as contained in the
3262 envelope. For bounce messages, the sender address is empty, and appears as
3263 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3264 the default sender address, the user's login name is shown in parentheses
3265 before the sender address.
3266
3267 .cindex "frozen messages" "in queue listing"
3268 If the message is frozen (attempts to deliver it are suspended) then the text
3269 &"*** frozen ***"& is displayed at the end of this line.
3270
3271 The recipients of the message (taken from the envelope, not the headers) are
3272 displayed on subsequent lines. Those addresses to which the message has already
3273 been delivered are marked with the letter D. If an original address gets
3274 expanded into several addresses via an alias or forward file, the original is
3275 displayed with a D only when deliveries for all of its child addresses are
3276 complete.
3277
3278
3279 .vitem &%-bpa%&
3280 .oindex "&%-bpa%&"
3281 This option operates like &%-bp%&, but in addition it shows delivered addresses
3282 that were generated from the original top level address(es) in each message by
3283 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3284 of just &"D"&.
3285
3286
3287 .vitem &%-bpc%&
3288 .oindex "&%-bpc%&"
3289 .cindex "queue" "count of messages on"
3290 This option counts the number of messages in the queue, and writes the total
3291 to the standard output. It is restricted to admin users, unless
3292 &%queue_list_requires_admin%& is set false.
3293
3294
3295 .vitem &%-bpr%&
3296 .oindex "&%-bpr%&"
3297 This option operates like &%-bp%&, but the output is not sorted into
3298 chronological order of message arrival. This can speed it up when there are
3299 lots of messages in the queue, and is particularly useful if the output is
3300 going to be post-processed in a way that doesn't need the sorting.
3301
3302 .vitem &%-bpra%&
3303 .oindex "&%-bpra%&"
3304 This option is a combination of &%-bpr%& and &%-bpa%&.
3305
3306 .vitem &%-bpru%&
3307 .oindex "&%-bpru%&"
3308 This option is a combination of &%-bpr%& and &%-bpu%&.
3309
3310
3311 .vitem &%-bpu%&
3312 .oindex "&%-bpu%&"
3313 This option operates like &%-bp%& but shows only undelivered top-level
3314 addresses for each message displayed. Addresses generated by aliasing or
3315 forwarding are not shown, unless the message was deferred after processing by a
3316 router with the &%one_time%& option set.
3317
3318
3319 .vitem &%-brt%&
3320 .oindex "&%-brt%&"
3321 .cindex "testing" "retry configuration"
3322 .cindex "retry" "configuration testing"
3323 This option is for testing retry rules, and it must be followed by up to three
3324 arguments. It causes Exim to look for a retry rule that matches the values
3325 and to write it to the standard output. For example:
3326 .code
3327 exim -brt bach.comp.mus.example
3328 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3329 .endd
3330 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3331 argument, which is required, can be a complete address in the form
3332 &'local_part@domain'&, or it can be just a domain name. If the second argument
3333 contains a dot, it is interpreted as an optional second domain name; if no
3334 retry rule is found for the first argument, the second is tried. This ties in
3335 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3336 rule is found that matches the host, one that matches the mail domain is
3337 sought. Finally, an argument that is the name of a specific delivery error, as
3338 used in setting up retry rules, can be given. For example:
3339 .code
3340 exim -brt haydn.comp.mus.example quota_3d
3341 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3342 .endd
3343
3344 .vitem &%-brw%&
3345 .oindex "&%-brw%&"
3346 .cindex "testing" "rewriting"
3347 .cindex "rewriting" "testing"
3348 This option is for testing address rewriting rules, and it must be followed by
3349 a single argument, consisting of either a local part without a domain, or a
3350 complete address with a fully qualified domain. Exim outputs how this address
3351 would be rewritten for each possible place it might appear. See chapter
3352 &<<CHAPrewrite>>& for further details.
3353
3354 .vitem &%-bS%&
3355 .oindex "&%-bS%&"
3356 .cindex "SMTP" "batched incoming"
3357 .cindex "batched SMTP input"
3358 This option is used for batched SMTP input, which is an alternative interface
3359 for non-interactive local message submission. A number of messages can be
3360 submitted in a single run. However, despite its name, this is not really SMTP
3361 input. Exim reads each message's envelope from SMTP commands on the standard
3362 input, but generates no responses. If the caller is trusted, or
3363 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3364 believed; otherwise the sender is always the caller of Exim.
3365
3366 The message itself is read from the standard input, in SMTP format (leading
3367 dots doubled), terminated by a line containing just a single dot. An error is
3368 provoked if the terminating dot is missing. A further message may then follow.
3369
3370 As for other local message submissions, the contents of incoming batch SMTP
3371 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3372 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3373 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3374
3375 Some other SMTP commands are recognized in the input. HELO and EHLO act
3376 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3377 QUIT quits, ignoring the rest of the standard input.
3378
3379 .cindex "return code" "for &%-bS%&"
3380 If any error is encountered, reports are written to the standard output and
3381 error streams, and Exim gives up immediately. The return code is 0 if no error
3382 was detected; it is 1 if one or more messages were accepted before the error
3383 was detected; otherwise it is 2.
3384
3385 More details of input using batched SMTP are given in section
3386 &<<SECTincomingbatchedSMTP>>&.
3387
3388 .vitem &%-bs%&
3389 .oindex "&%-bs%&"
3390 .cindex "SMTP" "local input"
3391 .cindex "local SMTP input"
3392 This option causes Exim to accept one or more messages by reading SMTP commands
3393 on the standard input, and producing SMTP replies on the standard output. SMTP
3394 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3395 Some user agents use this interface as a way of passing locally-generated
3396 messages to the MTA.
3397
3398 In
3399 .cindex "sender" "source of"
3400 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3401 set, the senders of messages are taken from the SMTP MAIL commands.
3402 Otherwise the content of these commands is ignored and the sender is set up as
3403 the calling user. Unqualified addresses are automatically qualified using
3404 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3405 &%-bnq%& option is used.
3406
3407 .cindex "inetd"
3408 The
3409 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3410 using a listening daemon. Exim can distinguish the two cases by checking
3411 whether the standard input is a TCP/IP socket. When Exim is called from
3412 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3413 above concerning senders and qualification do not apply. In this situation,
3414 Exim behaves in exactly the same way as it does when receiving a message via
3415 the listening daemon.
3416
3417 .vitem &%-bt%&
3418 .oindex "&%-bt%&"
3419 .cindex "testing" "addresses"
3420 .cindex "address" "testing"
3421 This option runs Exim in address testing mode, in which each argument is taken
3422 as a recipient address to be tested for deliverability. The results are
3423 written to the standard output. If a test fails, and the caller is not an admin
3424 user, no details of the failure are output, because these might contain
3425 sensitive information such as usernames and passwords for database lookups.
3426
3427 If no arguments are given, Exim runs in an interactive manner, prompting with a
3428 right angle bracket for addresses to be tested.
3429
3430 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3431 &[readline()]& function, because it is running as &'root'& and there are
3432 security issues.
3433
3434 Each address is handled as if it were the recipient address of a message
3435 (compare the &%-bv%& option). It is passed to the routers and the result is
3436 written to the standard output. However, any router that has
3437 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3438 genuine routing tests if your first router passes everything to a scanner
3439 program.
3440
3441 .cindex "return code" "for &%-bt%&"
3442 The return code is 2 if any address failed outright; it is 1 if no address
3443 failed outright but at least one could not be resolved for some reason. Return
3444 code 0 is given only when all addresses succeed.
3445
3446 .cindex "duplicate addresses"
3447 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3448 addresses after routing is complete, so that only one delivery takes place.
3449 This does not happen when testing with &%-bt%&; the full results of routing are
3450 always shown.
3451
3452 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3453 routers in the configuration makes any tests on the sender address of a
3454 message,
3455 .oindex "&%-f%&" "for address testing"
3456 you can use the &%-f%& option to set an appropriate sender when running
3457 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3458 default qualifying domain. However, if you have set up (for example) routers
3459 whose behaviour depends on the contents of an incoming message, you cannot test
3460 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3461 doing such tests.
3462
3463 .vitem &%-bV%&
3464 .oindex "&%-bV%&"
3465 .cindex "version number of Exim"
3466 This option causes Exim to write the current version number, compilation
3467 number, and compilation date of the &'exim'& binary to the standard output.
3468 It also lists the DBM library that is being used, the optional modules (such as
3469 specific lookup types), the drivers that are included in the binary, and the
3470 name of the runtime configuration file that is in use.
3471
3472 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3473 configuration file. However, this is a static check only. It cannot check
3474 values that are to be expanded. For example, although a misspelt ACL verb is
3475 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3476 alone to discover (for example) all the typos in the configuration; some
3477 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3478 dynamic testing facilities.
3479
3480 .vitem &%-bv%&
3481 .oindex "&%-bv%&"
3482 .cindex "verifying address" "using &%-bv%&"
3483 .cindex "address" "verification"
3484 This option runs Exim in address verification mode, in which each argument is
3485 taken as a recipient address to be verified by the routers. (This does
3486 not involve any verification callouts). During normal operation, verification
3487 happens mostly as a consequence processing a &%verify%& condition in an ACL
3488 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3489 including callouts, see the &%-bh%& and &%-bhc%& options.
3490
3491 If verification fails, and the caller is not an admin user, no details of the
3492 failure are output, because these might contain sensitive information such as
3493 usernames and passwords for database lookups.
3494
3495 If no arguments are given, Exim runs in an interactive manner, prompting with a
3496 right angle bracket for addresses to be verified.
3497
3498 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3499 &[readline()]& function, because it is running as &'exim'& and there are
3500 security issues.
3501
3502 Verification differs from address testing (the &%-bt%& option) in that routers
3503 that have &%no_verify%& set are skipped, and if the address is accepted by a
3504 router that has &%fail_verify%& set, verification fails. The address is
3505 verified as a recipient if &%-bv%& is used; to test verification for a sender
3506 address, &%-bvs%& should be used.
3507
3508 If the &%-v%& option is not set, the output consists of a single line for each
3509 address, stating whether it was verified or not, and giving a reason in the
3510 latter case. Without &%-v%&, generating more than one address by redirection
3511 causes verification to end successfully, without considering the generated
3512 addresses. However, if just one address is generated, processing continues,
3513 and the generated address must verify successfully for the overall verification
3514 to succeed.
3515
3516 When &%-v%& is set, more details are given of how the address has been handled,
3517 and in the case of address redirection, all the generated addresses are also
3518 considered. Verification may succeed for some and fail for others.
3519
3520 The
3521 .cindex "return code" "for &%-bv%&"
3522 return code is 2 if any address failed outright; it is 1 if no address
3523 failed outright but at least one could not be resolved for some reason. Return
3524 code 0 is given only when all addresses succeed.
3525
3526 If any of the routers in the configuration makes any tests on the sender
3527 address of a message, you should use the &%-f%& option to set an appropriate
3528 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3529 calling user at the default qualifying domain.
3530
3531 .vitem &%-bvs%&
3532 .oindex "&%-bvs%&"
3533 This option acts like &%-bv%&, but verifies the address as a sender rather
3534 than a recipient address. This affects any rewriting and qualification that
3535 might happen.
3536
3537 .vitem &%-bw%&
3538 .oindex "&%-bw%&"
3539 .cindex "daemon"
3540 .cindex "inetd"
3541 .cindex "inetd" "wait mode"
3542 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3543 similarly to the &%-bd%& option.  All port specifications on the command-line
3544 and in the configuration file are ignored.  Queue-running may not be specified.
3545
3546 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3547 listening for connections.  This permits the system to start up and have
3548 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3549 each port only when the first connection is received.
3550
3551 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3552 which the daemon will exit, which should cause inetd to listen once more.
3553
3554 .vitem &%-C%&&~<&'filelist'&>
3555 .oindex "&%-C%&"
3556 .cindex "configuration file" "alternate"
3557 .cindex "CONFIGURE_FILE"
3558 .cindex "alternate configuration file"
3559 This option causes Exim to find the runtime configuration file from the given
3560 list instead of from the list specified by the CONFIGURE_FILE
3561 compile-time setting. Usually, the list will consist of just a single filename,
3562 but it can be a colon-separated list of names. In this case, the first
3563 file that exists is used. Failure to open an existing file stops Exim from
3564 proceeding any further along the list, and an error is generated.
3565
3566 When this option is used by a caller other than root, and the list is different
3567 from the compiled-in list, Exim gives up its root privilege immediately, and
3568 runs with the real and effective uid and gid set to those of the caller.
3569 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3570 file contains a list of full pathnames, one per line, for configuration files
3571 which are trusted. Root privilege is retained for any configuration file so
3572 listed, as long as the caller is the Exim user (or the user specified in the
3573 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3574 not writeable by inappropriate users or groups.
3575
3576 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3577 configuration using &%-C%& right through message reception and delivery,
3578 even if the caller is root. The reception works, but by that time, Exim is
3579 running as the Exim user, so when it re-executes to regain privilege for the
3580 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3581 test reception and delivery using two separate commands (one to put a message
3582 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3583
3584 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3585 prefix string with which any file named in a &%-C%& command line option
3586 must start. In addition, the filename must not contain the sequence &`/../`&.
3587 However, if the value of the &%-C%& option is identical to the value of
3588 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3589 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3590 unset, any filename can be used with &%-C%&.
3591
3592 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3593 to a directory to which only root has access. This prevents someone who has
3594 broken into the Exim account from running a privileged Exim with an arbitrary
3595 configuration file.
3596
3597 The &%-C%& facility is useful for ensuring that configuration files are
3598 syntactically correct, but cannot be used for test deliveries, unless the
3599 caller is privileged, or unless it is an exotic configuration that does not
3600 require privilege. No check is made on the owner or group of the files
3601 specified by this option.
3602
3603
3604 .vitem &%-D%&<&'macro'&>=<&'value'&>
3605 .oindex "&%-D%&"
3606 .cindex "macro" "setting on command line"
3607 This option can be used to override macro definitions in the configuration file
3608 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3609 unprivileged caller, it causes Exim to give up its root privilege.
3610 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3611 completely disabled, and its use causes an immediate error exit.
3612
3613 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3614 colon-separated list of macros which are considered safe and, if &%-D%& only
3615 supplies macros from this list, and the values are acceptable, then Exim will
3616 not give up root privilege if the caller is root, the Exim run-time user, or
3617 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3618 to be removed in the future.  Acceptable values for the macros satisfy the
3619 regexp: &`^[A-Za-z0-9_/.-]*$`&
3620
3621 The entire option (including equals sign if present) must all be within one
3622 command line item. &%-D%& can be used to set the value of a macro to the empty
3623 string, in which case the equals sign is optional. These two commands are
3624 synonymous:
3625 .code
3626 exim -DABC  ...
3627 exim -DABC= ...
3628 .endd
3629 To include spaces in a macro definition item, quotes must be used. If you use
3630 quotes, spaces are permitted around the macro name and the equals sign. For
3631 example:
3632 .code
3633 exim '-D ABC = something' ...
3634 .endd
3635 &%-D%& may be repeated up to 10 times on a command line.
3636 Only macro names up to 22 letters long can be set.
3637
3638
3639 .vitem &%-d%&<&'debug&~options'&>
3640 .oindex "&%-d%&"
3641 .cindex "debugging" "list of selectors"
3642 .cindex "debugging" "&%-d%& option"
3643 This option causes debugging information to be written to the standard
3644 error stream. It is restricted to admin users because debugging output may show
3645 database queries that contain password information. Also, the details of users'
3646 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3647 writes an error message to the standard error stream and exits with a non-zero
3648 return code.
3649
3650 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3651 standard debugging data is output. This can be reduced, or increased to include
3652 some more rarely needed information, by directly following &%-d%& with a string
3653 made up of names preceded by plus or minus characters. These add or remove sets
3654 of debugging data, respectively. For example, &%-d+filter%& adds filter
3655 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3656 no spaces are allowed in the debug setting. The available debugging categories
3657 are:
3658 .display
3659 &`acl            `& ACL interpretation
3660 &`auth           `& authenticators
3661 &`deliver        `& general delivery logic
3662 &`dns            `& DNS lookups (see also resolver)
3663 &`dnsbl          `& DNS black list (aka RBL) code
3664 &`exec           `& arguments for &[execv()]& calls
3665 &`expand         `& detailed debugging for string expansions
3666 &`filter         `& filter handling
3667 &`hints_lookup   `& hints data lookups
3668 &`host_lookup    `& all types of name-to-IP address handling
3669 &`ident          `& ident lookup
3670 &`interface      `& lists of local interfaces
3671 &`lists          `& matching things in lists
3672 &`load           `& system load checks
3673 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3674                     &<<CHAPlocalscan>>&)
3675 &`lookup         `& general lookup code and all lookups
3676 &`memory         `& memory handling
3677 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3678 &`pid            `& modifier: add pid to debug output lines
3679 &`process_info   `& setting info for the process log
3680 &`queue_run      `& queue runs
3681 &`receive        `& general message reception logic
3682 &`resolver       `& turn on the DNS resolver's debugging output
3683 &`retry          `& retry handling
3684 &`rewrite        `& address rewriting
3685 &`route          `& address routing
3686 &`timestamp      `& modifier: add timestamp to debug output lines
3687 &`tls            `& TLS logic
3688 &`transport      `& transports
3689 &`uid            `& changes of uid/gid and looking up uid/gid
3690 &`verify         `& address verification logic
3691 &`all            `& almost all of the above (see below), and also &%-v%&
3692 .endd
3693 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3694 for &`-all`&. The reason for this is that &`+all`& is something that people
3695 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3696 is included, an awful lot of output that is very rarely of interest is
3697 generated, so it now has to be explicitly requested. However, &`-all`& does
3698 turn everything off.
3699
3700 .cindex "resolver, debugging output"
3701 .cindex "DNS resolver, debugging output"
3702 The &`resolver`& option produces output only if the DNS resolver was compiled
3703 with DEBUG enabled. This is not the case in some operating systems. Also,
3704 unfortunately, debugging output from the DNS resolver is written to stdout
3705 rather than stderr.
3706
3707 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3708 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3709 However, the &`pid`& selector is forced when debugging is turned on for a
3710 daemon, which then passes it on to any re-executed Exims. Exim also
3711 automatically adds the pid to debug lines when several remote deliveries are
3712 run in parallel.
3713
3714 The &`timestamp`& selector causes the current time to be inserted at the start
3715 of all debug output lines. This can be useful when trying to track down delays
3716 in processing.
3717
3718 .cindex debugging "UTF-8 in"
3719 .cindex UTF-8 "in debug output"
3720 The &`noutf8`& selector disables the use of
3721 UTF-8 line-drawing characters to group related information.
3722 When disabled. ascii-art is used instead.
3723 Using the &`+all`& option does not set this modifier,
3724
3725 If the &%debug_print%& option is set in any driver, it produces output whenever
3726 any debugging is selected, or if &%-v%& is used.
3727
3728 .vitem &%-dd%&<&'debug&~options'&>
3729 .oindex "&%-dd%&"
3730 This option behaves exactly like &%-d%& except when used on a command that
3731 starts a daemon process. In that case, debugging is turned off for the
3732 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3733 behaviour of the daemon without creating as much output as full debugging does.
3734
3735 .vitem &%-dropcr%&
3736 .oindex "&%-dropcr%&"
3737 This is an obsolete option that is now a no-op. It used to affect the way Exim
3738 handled CR and LF characters in incoming messages. What happens now is
3739 described in section &<<SECTlineendings>>&.
3740
3741 .vitem &%-E%&
3742 .oindex "&%-E%&"
3743 .cindex "bounce message" "generating"
3744 This option specifies that an incoming message is a locally-generated delivery
3745 failure report. It is used internally by Exim when handling delivery failures
3746 and is not intended for external use. Its only effect is to stop Exim
3747 generating certain messages to the postmaster, as otherwise message cascades
3748 could occur in some situations. As part of the same option, a message id may
3749 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3750 new message contains the id, following &"R="&, as a cross-reference.
3751
3752 .vitem &%-e%&&'x'&
3753 .oindex "&%-e%&&'x'&"
3754 There are a number of Sendmail options starting with &%-oe%& which seem to be
3755 called by various programs without the leading &%o%& in the option. For
3756 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3757 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3758
3759 .vitem &%-F%&&~<&'string'&>
3760 .oindex "&%-F%&"
3761 .cindex "sender" "name"
3762 .cindex "name" "of sender"
3763 This option sets the sender's full name for use when a locally-generated
3764 message is being accepted. In the absence of this option, the user's &'gecos'&
3765 entry from the password data is used. As users are generally permitted to alter
3766 their &'gecos'& entries, no security considerations are involved. White space
3767 between &%-F%& and the <&'string'&> is optional.
3768
3769 .vitem &%-f%&&~<&'address'&>
3770 .oindex "&%-f%&"
3771 .cindex "sender" "address"
3772 .cindex "address" "sender"
3773 .cindex "trusted users"
3774 .cindex "envelope from"
3775 .cindex "envelope sender"
3776 .cindex "user" "trusted"
3777 This option sets the address of the envelope sender of a locally-generated
3778 message (also known as the return path). The option can normally be used only
3779 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3780 users to use it.
3781
3782 Processes running as root or the Exim user are always trusted. Other
3783 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3784 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3785 of a local message is set to the caller's login name at the default qualify
3786 domain.
3787
3788 There is one exception to the restriction on the use of &%-f%&: an empty sender
3789 can be specified by any user, trusted or not, to create a message that can
3790 never provoke a bounce. An empty sender can be specified either as an empty
3791 string, or as a pair of angle brackets with nothing between them, as in these
3792 examples of shell commands:
3793 .code
3794 exim -f '<>' user@domain
3795 exim -f "" user@domain
3796 .endd
3797 In addition, the use of &%-f%& is not restricted when testing a filter file
3798 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3799 &%-bv%& options.
3800
3801 Allowing untrusted users to change the sender address does not of itself make
3802 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3803 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3804 though this can be overridden by setting &%no_local_from_check%&.
3805
3806 White
3807 .cindex "&""From""& line"
3808 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3809 given as two arguments or one combined argument). The sender of a
3810 locally-generated message can also be set (when permitted) by an initial
3811 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3812 if &%-f%& is also present, it overrides &"From&~"&.
3813
3814 .vitem &%-G%&
3815 .oindex "&%-G%&"
3816 .cindex "submission fixups, suppressing (command-line)"
3817 This option is equivalent to an ACL applying:
3818 .code
3819 control = suppress_local_fixups
3820 .endd
3821 for every message received.  Note that Sendmail will complain about such
3822 bad formatting, where Exim silently just does not fix it up.  This may change
3823 in future.
3824
3825 As this affects audit information, the caller must be a trusted user to use
3826 this option.
3827
3828 .vitem &%-h%&&~<&'number'&>
3829 .oindex "&%-h%&"
3830 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3831 This option is accepted for compatibility with Sendmail, but has no effect. (In
3832 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3833 headers.)
3834
3835 .vitem &%-i%&
3836 .oindex "&%-i%&"
3837 .cindex "Solaris" "&'mail'& command"
3838 .cindex "dot" "in incoming non-SMTP message"
3839 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3840 line by itself should not terminate an incoming, non-SMTP message. I can find
3841 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3842 command in Solaris 2.4 uses it. See also &%-ti%&.
3843
3844 .vitem &%-L%&&~<&'tag'&>
3845 .oindex "&%-L%&"
3846 .cindex "syslog" "process name; set with flag"
3847 This option is equivalent to setting &%syslog_processname%& in the config
3848 file and setting &%log_file_path%& to &`syslog`&.
3849 Its use is restricted to administrators.  The configuration file has to be
3850 read and parsed, to determine access rights, before this is set and takes
3851 effect, so early configuration file errors will not honour this flag.
3852
3853 The tag should not be longer than 32 characters.
3854
3855 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3856 .oindex "&%-M%&"
3857 .cindex "forcing delivery"
3858 .cindex "delivery" "forcing attempt"
3859 .cindex "frozen messages" "forcing delivery"
3860 This option requests Exim to run a delivery attempt on each message in turn. If
3861 any of the messages are frozen, they are automatically thawed before the
3862 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3863 and &%hold_domains%& are ignored.
3864
3865 Retry
3866 .cindex "hints database" "overriding retry hints"
3867 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3868 the normal retry time has not yet been reached. This option requires the caller
3869 to be an admin user. However, there is an option called &%prod_requires_admin%&
3870 which can be set false to relax this restriction (and also the same requirement
3871 for the &%-q%&, &%-R%&, and &%-S%& options).
3872
3873 The deliveries happen synchronously, that is, the original Exim process does
3874 not terminate until all the delivery attempts have finished. No output is
3875 produced unless there is a serious error. If you want to see what is happening,
3876 use the &%-v%& option as well, or inspect Exim's main log.
3877
3878 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3879 .oindex "&%-Mar%&"
3880 .cindex "message" "adding recipients"
3881 .cindex "recipient" "adding"
3882 This option requests Exim to add the addresses to the list of recipients of the
3883 message (&"ar"& for &"add recipients"&). The first argument must be a message
3884 id, and the remaining ones must be email addresses. However, if the message is
3885 active (in the middle of a delivery attempt), it is not altered. This option
3886 can be used only by an admin user.
3887
3888 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3889         &~<&'host&~IP'&>&&&
3890         &~<&'sequence&~number'&>&&&
3891         &~<&'message&~id'&>"
3892 .oindex "&%-MC%&"
3893 .cindex "SMTP" "passed connection"
3894 .cindex "SMTP" "multiple deliveries"
3895 .cindex "multiple SMTP deliveries"
3896 This option is not intended for use by external callers. It is used internally
3897 by Exim to invoke another instance of itself to deliver a waiting message using
3898 an existing SMTP connection, which is passed as the standard input. Details are
3899 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3900 must be root or the Exim user in order to use it.
3901
3902 .vitem &%-MCA%&
3903 .oindex "&%-MCA%&"
3904 This option is not intended for use by external callers. It is used internally
3905 by Exim in conjunction with the &%-MC%& option. It signifies that the
3906 connection to the remote host has been authenticated.
3907
3908 .vitem &%-MCD%&
3909 .oindex "&%-MCD%&"
3910 This option is not intended for use by external callers. It is used internally
3911 by Exim in conjunction with the &%-MC%& option. It signifies that the
3912 remote host supports the ESMTP &_DSN_& extension.
3913
3914 .vitem &%-MCd%&
3915 .oindex "&%-MCd%&"
3916 This option is not intended for use by external callers. It is used internally
3917 by Exim in conjunction with the &%-d%& option
3918 to pass on an information string on the purpose of the process.
3919
3920 .vitem &%-MCG%&&~<&'queue&~name'&>
3921 .oindex "&%-MCG%&"
3922 This option is not intended for use by external callers. It is used internally
3923 by Exim in conjunction with the &%-MC%& option. It signifies that an
3924 alternate queue is used, named by the following argument.
3925
3926 .vitem &%-MCK%&
3927 .oindex "&%-MCK%&"
3928 This option is not intended for use by external callers. It is used internally
3929 by Exim in conjunction with the &%-MC%& option. It signifies that a
3930 remote host supports the ESMTP &_CHUNKING_& extension.
3931
3932 .vitem &%-MCP%&
3933 .oindex "&%-MCP%&"
3934 This option is not intended for use by external callers. It is used internally
3935 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3936 which Exim is connected supports pipelining.
3937
3938 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3939 .oindex "&%-MCQ%&"
3940 This option is not intended for use by external callers. It is used internally
3941 by Exim in conjunction with the &%-MC%& option when the original delivery was
3942 started by a queue runner. It passes on the process id of the queue runner,
3943 together with the file descriptor number of an open pipe. Closure of the pipe
3944 signals the final completion of the sequence of processes that are passing
3945 messages through the same SMTP connection.
3946
3947 .new
3948 .vitem &%-MCq%&&~<&'recipient&~address'&>&~<&'size'&>
3949 .oindex "&%-MCq%&"
3950 This option is not intended for use by external callers. It is used internally
3951 by Exim to implement quota checking for local users.
3952 .wen
3953
3954 .vitem &%-MCS%&
3955 .oindex "&%-MCS%&"
3956 This option is not intended for use by external callers. It is used internally
3957 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3958 ESMTP SIZE option should be used on messages delivered down the existing
3959 connection.
3960
3961 .vitem &%-MCT%&
3962 .oindex "&%-MCT%&"
3963 This option is not intended for use by external callers. It is used internally
3964 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3965 host to which Exim is connected supports TLS encryption.
3966
3967 .new
3968 .vitem &%-MCr%&&~<&'SNI'&> &&&
3969        &%-MCs%&&~<&'SNI'&>
3970 .oindex "&%-MCs%&"
3971 .oindex "&%-MCr%&"
3972 These options are not intended for use by external callers. It is used internally
3973 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
3974 a TLS Server Name Indication was sent as part of the channel establishment.
3975 The argument gives the SNI string.
3976 The "r" variant indicates a DANE-verified connection.
3977 .wen
3978
3979 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3980 .oindex "&%-MCt%&"
3981 This option is not intended for use by external callers. It is used internally
3982 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3983 connection is being proxied by a parent process for handling TLS encryption.
3984 The arguments give the local address and port being proxied, and the TLS cipher.
3985
3986 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3987 .oindex "&%-Mc%&"
3988 .cindex "hints database" "not overridden by &%-Mc%&"
3989 .cindex "delivery" "manually started &-- not forced"
3990 This option requests Exim to run a delivery attempt on each message, in turn,
3991 but unlike the &%-M%& option, it does check for retry hints, and respects any
3992 that are found. This option is not very useful to external callers. It is
3993 provided mainly for internal use by Exim when it needs to re-invoke itself in
3994 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3995 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3996 respects retry times and other options such as &%hold_domains%& that are
3997 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3998 If you want to run a specific delivery as if in a queue run, you should use
3999 &%-q%& with a message id argument. A distinction between queue run deliveries
4000 and other deliveries is made in one or two places.
4001
4002 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
4003 .oindex "&%-Mes%&"
4004 .cindex "message" "changing sender"
4005 .cindex "sender" "changing"
4006 This option requests Exim to change the sender address in the message to the
4007 given address, which must be a fully qualified address or &"<>"& (&"es"& for
4008 &"edit sender"&). There must be exactly two arguments. The first argument must
4009 be a message id, and the second one an email address. However, if the message
4010 is active (in the middle of a delivery attempt), its status is not altered.
4011 This option can be used only by an admin user.
4012
4013 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4014 .oindex "&%-Mf%&"
4015 .cindex "freezing messages"
4016 .cindex "message" "manually freezing"
4017 This option requests Exim to mark each listed message as &"frozen"&. This
4018 prevents any delivery attempts taking place until the message is &"thawed"&,
4019 either manually or as a result of the &%auto_thaw%& configuration option.
4020 However, if any of the messages are active (in the middle of a delivery
4021 attempt), their status is not altered. This option can be used only by an admin
4022 user.
4023
4024 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4025 .oindex "&%-Mg%&"
4026 .cindex "giving up on messages"
4027 .cindex "message" "abandoning delivery attempts"
4028 .cindex "delivery" "abandoning further attempts"
4029 This option requests Exim to give up trying to deliver the listed messages,
4030 including any that are frozen. However, if any of the messages are active,
4031 their status is not altered. For non-bounce messages, a delivery error message
4032 is sent to the sender, containing the text &"cancelled by administrator"&.
4033 Bounce messages are just discarded. This option can be used only by an admin
4034 user.
4035
4036 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
4037 .oindex "&%-MG%&"
4038 .cindex queue named
4039 .cindex "named queues" "moving messages"
4040 .cindex "queue" "moving messages"
4041 This option requests that each listed message be moved from its current
4042 queue to the given named queue.
4043 The destination queue name argument is required, but can be an empty
4044 string to define the default queue.
4045 If the messages are not currently located in the default queue,
4046 a &%-qG<name>%& option will be required to define the source queue.
4047
4048 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4049 .oindex "&%-Mmad%&"
4050 .cindex "delivery" "cancelling all"
4051 This option requests Exim to mark all the recipient addresses in the messages
4052 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
4053 message is active (in the middle of a delivery attempt), its status is not
4054 altered. This option can be used only by an admin user.
4055
4056 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4057 .oindex "&%-Mmd%&"
4058 .cindex "delivery" "cancelling by address"
4059 .cindex "recipient" "removing"
4060 .cindex "removing recipients"
4061 This option requests Exim to mark the given addresses as already delivered
4062 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4063 the remaining ones must be email addresses. These are matched to recipient
4064 addresses in the message in a case-sensitive manner. If the message is active
4065 (in the middle of a delivery attempt), its status is not altered. This option
4066 can be used only by an admin user.
4067
4068 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4069 .oindex "&%-Mrm%&"
4070 .cindex "removing messages"
4071 .cindex "abandoning mail"
4072 .cindex "message" "manually discarding"
4073 This option requests Exim to remove the given messages from the queue. No
4074 bounce messages are sent; each message is simply forgotten. However, if any of
4075 the messages are active, their status is not altered. This option can be used
4076 only by an admin user or by the user who originally caused the message to be
4077 placed in the queue.
4078
4079 . .new
4080 . .vitem &%-MS%&
4081 . .oindex "&%-MS%&"
4082 . .cindex REQUIRETLS
4083 . This option is used to request REQUIRETLS processing on the message.
4084 . It is used internally by Exim in conjunction with -E when generating
4085 . a bounce message.
4086 . .wen
4087
4088 .vitem &%-Mset%&&~<&'message&~id'&>
4089 .oindex "&%-Mset%&"
4090 .cindex "testing" "string expansion"
4091 .cindex "expansion" "testing"
4092 This option is useful only in conjunction with &%-be%& (that is, when testing
4093 string expansions). Exim loads the given message from its spool before doing
4094 the test expansions, thus setting message-specific variables such as
4095 &$message_size$& and the header variables. The &$recipients$& variable is made
4096 available. This feature is provided to make it easier to test expansions that
4097 make use of these variables. However, this option can be used only by an admin
4098 user. See also &%-bem%&.
4099
4100 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4101 .oindex "&%-Mt%&"
4102 .cindex "thawing messages"
4103 .cindex "unfreezing messages"
4104 .cindex "frozen messages" "thawing"
4105 .cindex "message" "thawing frozen"
4106 This option requests Exim to &"thaw"& any of the listed messages that are
4107 &"frozen"&, so that delivery attempts can resume. However, if any of the
4108 messages are active, their status is not altered. This option can be used only
4109 by an admin user.
4110
4111 .vitem &%-Mvb%&&~<&'message&~id'&>
4112 .oindex "&%-Mvb%&"
4113 .cindex "listing" "message body"
4114 .cindex "message" "listing body of"
4115 This option causes the contents of the message body (-D) spool file to be
4116 written to the standard output. This option can be used only by an admin user.
4117
4118 .vitem &%-Mvc%&&~<&'message&~id'&>
4119 .oindex "&%-Mvc%&"
4120 .cindex "message" "listing in RFC 2822 format"
4121 .cindex "listing" "message in RFC 2822 format"
4122 This option causes a copy of the complete message (header lines plus body) to
4123 be written to the standard output in RFC 2822 format. This option can be used
4124 only by an admin user.
4125
4126 .vitem &%-Mvh%&&~<&'message&~id'&>
4127 .oindex "&%-Mvh%&"
4128 .cindex "listing" "message headers"
4129 .cindex "header lines" "listing"
4130 .cindex "message" "listing header lines"
4131 This option causes the contents of the message headers (-H) spool file to be
4132 written to the standard output. This option can be used only by an admin user.
4133
4134 .vitem &%-Mvl%&&~<&'message&~id'&>
4135 .oindex "&%-Mvl%&"
4136 .cindex "listing" "message log"
4137 .cindex "message" "listing message log"
4138 This option causes the contents of the message log spool file to be written to
4139 the standard output. This option can be used only by an admin user.
4140
4141 .vitem &%-m%&
4142 .oindex "&%-m%&"
4143 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4144 treats it that way too.
4145
4146 .vitem &%-N%&
4147 .oindex "&%-N%&"
4148 .cindex "debugging" "&%-N%& option"
4149 .cindex "debugging" "suppressing delivery"
4150 This is a debugging option that inhibits delivery of a message at the transport
4151 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4152 it just doesn't actually transport the message, but instead behaves as if it
4153 had successfully done so. However, it does not make any updates to the retry
4154 database, and the log entries for deliveries are flagged with &"*>"& rather
4155 than &"=>"&.
4156
4157 Because &%-N%& discards any message to which it applies, only root or the Exim
4158 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4159 words, an ordinary user can use it only when supplying an incoming message to
4160 which it will apply. Although transportation never fails when &%-N%& is set, an
4161 address may be deferred because of a configuration problem on a transport, or a
4162 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4163 the message, and applies to any subsequent delivery attempts that may happen
4164 for that message.
4165
4166 .vitem &%-n%&
4167 .oindex "&%-n%&"
4168 This option is interpreted by Sendmail to mean &"no aliasing"&.
4169 For normal modes of operation, it is ignored by Exim.
4170 When combined with &%-bP%& it makes the output more terse (suppresses
4171 option names, environment values and config pretty printing).
4172
4173 .vitem &%-O%&&~<&'data'&>
4174 .oindex "&%-O%&"
4175 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4176 Exim.
4177
4178 .vitem &%-oA%&&~<&'file&~name'&>
4179 .oindex "&%-oA%&"
4180 .cindex "Sendmail compatibility" "&%-oA%& option"
4181 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4182 alternative alias filename. Exim handles &%-bi%& differently; see the
4183 description above.
4184
4185 .vitem &%-oB%&&~<&'n'&>
4186 .oindex "&%-oB%&"
4187 .cindex "SMTP" "passed connection"
4188 .cindex "SMTP" "multiple deliveries"
4189 .cindex "multiple SMTP deliveries"
4190 This is a debugging option which limits the maximum number of messages that can
4191 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4192 transport. If <&'n'&> is omitted, the limit is set to 1.
4193
4194 .vitem &%-odb%&
4195 .oindex "&%-odb%&"
4196 .cindex "background delivery"
4197 .cindex "delivery" "in the background"
4198 This option applies to all modes in which Exim accepts incoming messages,
4199 including the listening daemon. It requests &"background"& delivery of such
4200 messages, which means that the accepting process automatically starts a
4201 delivery process for each message received, but does not wait for the delivery
4202 processes to finish.
4203
4204 When all the messages have been received, the reception process exits,
4205 leaving the delivery processes to finish in their own time. The standard output
4206 and error streams are closed at the start of each delivery process.
4207 This is the default action if none of the &%-od%& options are present.
4208
4209 If one of the queueing options in the configuration file
4210 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4211 overrides it if &%queue_only_override%& is set true, which is the default
4212 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4213
4214 .vitem &%-odf%&
4215 .oindex "&%-odf%&"
4216 .cindex "foreground delivery"
4217 .cindex "delivery" "in the foreground"
4218 This option requests &"foreground"& (synchronous) delivery when Exim has
4219 accepted a locally-generated message. (For the daemon it is exactly the same as
4220 &%-odb%&.) A delivery process is automatically started to deliver the message,
4221 and Exim waits for it to complete before proceeding.
4222
4223 The original Exim reception process does not finish until the delivery
4224 process for the final message has ended. The standard error stream is left open
4225 during deliveries.
4226
4227 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4228 false and one of the queueing options in the configuration file is in effect.
4229
4230 If there is a temporary delivery error during foreground delivery, the
4231 message is left in the queue for later delivery, and the original reception
4232 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4233 restricted configuration that never queues messages.
4234
4235
4236 .vitem &%-odi%&
4237 .oindex "&%-odi%&"
4238 This option is synonymous with &%-odf%&. It is provided for compatibility with
4239 Sendmail.
4240
4241 .vitem &%-odq%&
4242 .oindex "&%-odq%&"
4243 .cindex "non-immediate delivery"
4244 .cindex "delivery" "suppressing immediate"
4245 .cindex "queueing incoming messages"
4246 This option applies to all modes in which Exim accepts incoming messages,
4247 including the listening daemon. It specifies that the accepting process should
4248 not automatically start a delivery process for each message received. Messages
4249 are placed in the queue, and remain there until a subsequent queue runner
4250 process encounters them. There are several configuration options (such as
4251 &%queue_only%&) that can be used to queue incoming messages under certain
4252 conditions. This option overrides all of them and also &%-odqs%&. It always
4253 forces queueing.
4254
4255 .vitem &%-odqs%&
4256 .oindex "&%-odqs%&"
4257 .cindex "SMTP" "delaying delivery"
4258 .cindex "first pass routing"
4259 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4260 However, like &%-odb%& and &%-odi%&, this option has no effect if
4261 &%queue_only_override%& is false and one of the queueing options in the
4262 configuration file is in effect.
4263
4264 When &%-odqs%& does operate, a delivery process is started for each incoming
4265 message, in the background by default, but in the foreground if &%-odi%& is
4266 also present. The recipient addresses are routed, and local deliveries are done
4267 in the normal way. However, if any SMTP deliveries are required, they are not
4268 done at this time, so the message remains in the queue until a subsequent queue
4269 runner process encounters it. Because routing was done, Exim knows which
4270 messages are waiting for which hosts, and so a number of messages for the same
4271 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4272 configuration option has the same effect for specific domains. See also the
4273 &%-qq%& option.
4274
4275 .vitem &%-oee%&
4276 .oindex "&%-oee%&"
4277 .cindex "error" "reporting"
4278 If an error is detected while a non-SMTP message is being received (for
4279 example, a malformed address), the error is reported to the sender in a mail
4280 message.
4281
4282 .cindex "return code" "for &%-oee%&"
4283 Provided
4284 this error message is successfully sent, the Exim receiving process
4285 exits with a return code of zero. If not, the return code is 2 if the problem
4286 is that the original message has no recipients, or 1 for any other error.
4287 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4288
4289 .vitem &%-oem%&
4290 .oindex "&%-oem%&"
4291 .cindex "error" "reporting"
4292 .cindex "return code" "for &%-oem%&"
4293 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4294 return code, whether or not the error message was successfully sent.
4295 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4296
4297 .vitem &%-oep%&
4298 .oindex "&%-oep%&"
4299 .cindex "error" "reporting"
4300 If an error is detected while a non-SMTP message is being received, the
4301 error is reported by writing a message to the standard error file (stderr).
4302 .cindex "return code" "for &%-oep%&"
4303 The return code is 1 for all errors.
4304
4305 .vitem &%-oeq%&
4306 .oindex "&%-oeq%&"
4307 .cindex "error" "reporting"
4308 This option is supported for compatibility with Sendmail, but has the same
4309 effect as &%-oep%&.
4310
4311 .vitem &%-oew%&
4312 .oindex "&%-oew%&"
4313 .cindex "error" "reporting"
4314 This option is supported for compatibility with Sendmail, but has the same
4315 effect as &%-oem%&.
4316
4317 .vitem &%-oi%&
4318 .oindex "&%-oi%&"
4319 .cindex "dot" "in incoming non-SMTP message"
4320 This option, which has the same effect as &%-i%&, specifies that a dot on a
4321 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4322 single dot does terminate, though Exim does no special processing for other
4323 lines that start with a dot. This option is set by default if Exim is called as
4324 &'rmail'&. See also &%-ti%&.
4325
4326 .vitem &%-oitrue%&
4327 .oindex "&%-oitrue%&"
4328 This option is treated as synonymous with &%-oi%&.
4329
4330 .vitem &%-oMa%&&~<&'host&~address'&>
4331 .oindex "&%-oMa%&"
4332 .cindex "sender" "host address, specifying for local message"
4333 A number of options starting with &%-oM%& can be used to set values associated
4334 with remote hosts on locally-submitted messages (that is, messages not received
4335 over TCP/IP). These options can be used by any caller in conjunction with the
4336 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4337 other circumstances, they are ignored unless the caller is trusted.
4338
4339 The &%-oMa%& option sets the sender host address. This may include a port
4340 number at the end, after a full stop (period). For example:
4341 .code
4342 exim -bs -oMa 10.9.8.7.1234
4343 .endd
4344 An alternative syntax is to enclose the IP address in square brackets,
4345 followed by a colon and the port number:
4346 .code
4347 exim -bs -oMa [10.9.8.7]:1234
4348 .endd
4349 The IP address is placed in the &$sender_host_address$& variable, and the
4350 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4351 are present on the command line, the sender host IP address is taken from
4352 whichever one is last.
4353
4354 .vitem &%-oMaa%&&~<&'name'&>
4355 .oindex "&%-oMaa%&"
4356 .cindex "authentication" "name, specifying for local message"
4357 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4358 option sets the value of &$sender_host_authenticated$& (the authenticator
4359 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4360 This option can be used with &%-bh%& and &%-bs%& to set up an
4361 authenticated SMTP session without actually using the SMTP AUTH command.
4362
4363 .vitem &%-oMai%&&~<&'string'&>
4364 .oindex "&%-oMai%&"
4365 .cindex "authentication" "id, specifying for local message"
4366 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4367 option sets the value of &$authenticated_id$& (the id that was authenticated).
4368 This overrides the default value (the caller's login id, except with &%-bh%&,
4369 where there is no default) for messages from local sources. See chapter
4370 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4371
4372 .vitem &%-oMas%&&~<&'address'&>
4373 .oindex "&%-oMas%&"
4374 .cindex "authentication" "sender, specifying for local message"
4375 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4376 option sets the authenticated sender value in &$authenticated_sender$&. It
4377 overrides the sender address that is created from the caller's login id for
4378 messages from local sources, except when &%-bh%& is used, when there is no
4379 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4380 specified on a MAIL command overrides this value. See chapter
4381 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4382
4383 .vitem &%-oMi%&&~<&'interface&~address'&>
4384 .oindex "&%-oMi%&"
4385 .cindex "interface" "address, specifying for local message"
4386 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4387 option sets the IP interface address value. A port number may be included,
4388 using the same syntax as for &%-oMa%&. The interface address is placed in
4389 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4390
4391 .vitem &%-oMm%&&~<&'message&~reference'&>
4392 .oindex "&%-oMm%&"
4393 .cindex "message reference" "message reference, specifying for local message"
4394 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4395 option sets the message reference, e.g. message-id, and is logged during
4396 delivery. This is useful when some kind of audit trail is required to tie
4397 messages together. The format of the message reference is checked and will
4398 abort if the format is invalid. The option will only be accepted if exim is
4399 running in trusted mode, not as any regular user.
4400
4401 The best example of a message reference is when Exim sends a bounce message.
4402 The message reference is the message-id of the original message for which Exim
4403 is sending the bounce.
4404
4405 .vitem &%-oMr%&&~<&'protocol&~name'&>
4406 .oindex "&%-oMr%&"
4407 .cindex "protocol, specifying for local message"
4408 .vindex "&$received_protocol$&"
4409 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4410 option sets the received protocol value that is stored in
4411 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4412 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4413 SMTP protocol names (see the description of &$received_protocol$& in section
4414 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4415 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4416 be set by &%-oMr%&. Repeated use of this option is not supported.
4417
4418 .vitem &%-oMs%&&~<&'host&~name'&>
4419 .oindex "&%-oMs%&"
4420 .cindex "sender" "host name, specifying for local message"
4421 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4422 option sets the sender host name in &$sender_host_name$&. When this option is
4423 present, Exim does not attempt to look up a host name from an IP address; it
4424 uses the name it is given.
4425
4426 .vitem &%-oMt%&&~<&'ident&~string'&>
4427 .oindex "&%-oMt%&"
4428 .cindex "sender" "ident string, specifying for local message"
4429 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4430 option sets the sender ident value in &$sender_ident$&. The default setting for
4431 local callers is the login id of the calling process, except when &%-bh%& is
4432 used, when there is no default.
4433
4434 .vitem &%-om%&
4435 .oindex "&%-om%&"
4436 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4437 In Sendmail, this option means &"me too"&, indicating that the sender of a
4438 message should receive a copy of the message if the sender appears in an alias
4439 expansion. Exim always does this, so the option does nothing.
4440
4441 .vitem &%-oo%&
4442 .oindex "&%-oo%&"
4443 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4444 This option is ignored. In Sendmail it specifies &"old style headers"&,
4445 whatever that means.
4446
4447 .vitem &%-oP%&&~<&'path'&>
4448 .oindex "&%-oP%&"
4449 .cindex "pid (process id)" "of daemon"
4450 .cindex "daemon" "process id (pid)"
4451 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4452 value. The option specifies the file to which the process id of the daemon is
4453 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4454 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4455 because in those cases, the normal pid file is not used.
4456
4457 .vitem &%-oPX%&
4458 .oindex "&%-oPX%&"
4459 .cindex "pid (process id)" "of daemon"
4460 .cindex "daemon" "process id (pid)"
4461 This option is not intended for general use.
4462 The daemon uses it when terminating due to a SIGTEM, possibly in
4463 combination with &%-oP%&&~<&'path'&>.
4464 It causes the pid file to be removed.
4465
4466 .vitem &%-or%&&~<&'time'&>
4467 .oindex "&%-or%&"
4468 .cindex "timeout" "for non-SMTP input"
4469 This option sets a timeout value for incoming non-SMTP messages. If it is not
4470 set, Exim will wait forever for the standard input. The value can also be set
4471 by the &%receive_timeout%& option. The format used for specifying times is
4472 described in section &<<SECTtimeformat>>&.
4473
4474 .vitem &%-os%&&~<&'time'&>
4475 .oindex "&%-os%&"
4476 .cindex "timeout" "for SMTP input"
4477 .cindex "SMTP" "input timeout"
4478 This option sets a timeout value for incoming SMTP messages. The timeout
4479 applies to each SMTP command and block of data. The value can also be set by
4480 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4481 for specifying times is described in section &<<SECTtimeformat>>&.
4482
4483 .vitem &%-ov%&
4484 .oindex "&%-ov%&"
4485 This option has exactly the same effect as &%-v%&.
4486
4487 .vitem &%-oX%&&~<&'number&~or&~string'&>
4488 .oindex "&%-oX%&"
4489 .cindex "TCP/IP" "setting listening ports"
4490 .cindex "TCP/IP" "setting listening interfaces"
4491 .cindex "port" "receiving TCP/IP"
4492 This option is relevant only when the &%-bd%& (start listening daemon) option
4493 is also given. It controls which ports and interfaces the daemon uses. Details
4494 of the syntax, and how it interacts with configuration file options, are given
4495 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4496 file is written unless &%-oP%& is also present to specify a pid filename.
4497
4498 .new
4499 .vitem &%-oY%&
4500 .oindex &%-oY%&
4501 .cindex "daemon notifier socket"
4502 This option controls the creation of an inter-process communications endpoint
4503 by the Exim daemon.
4504 It is only relevant when the &%-bd%& (start listening daemon) option is also
4505 given.
4506 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4507 option is also present.
4508 If this option is given then the socket will not be created.  This could be
4509 required if the system is running multiple daemons.
4510
4511 The socket is currently used for
4512 .ilist
4513 fast ramp-up of queue runner processes
4514 .next
4515 obtaining a current queue size
4516 .endlist
4517 .wen
4518
4519 .vitem &%-pd%&
4520 .oindex "&%-pd%&"
4521 .cindex "Perl" "starting the interpreter"
4522 This option applies when an embedded Perl interpreter is linked with Exim (see
4523 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4524 option, forcing the starting of the interpreter to be delayed until it is
4525 needed.
4526
4527 .vitem &%-ps%&
4528 .oindex "&%-ps%&"
4529 .cindex "Perl" "starting the interpreter"
4530 This option applies when an embedded Perl interpreter is linked with Exim (see
4531 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4532 option, forcing the starting of the interpreter to occur as soon as Exim is
4533 started.
4534
4535 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4536 .oindex "&%-p%&"
4537 For compatibility with Sendmail, this option is equivalent to
4538 .display
4539 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4540 .endd
4541 It sets the incoming protocol and host name (for trusted callers). The
4542 host name and its colon can be omitted when only the protocol is to be set.
4543 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4544 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4545 or &`s`& using this option (but that does not seem a real limitation).
4546 Repeated use of this option is not supported.
4547
4548 .vitem &%-q%&
4549 .oindex "&%-q%&"
4550 .cindex "queue runner" "starting manually"
4551 This option is normally restricted to admin users. However, there is a
4552 configuration option called &%prod_requires_admin%& which can be set false to
4553 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4554 and &%-S%& options).
4555
4556 .cindex "queue runner" "description of operation"
4557 If other commandline options do not specify an action,
4558 the &%-q%& option starts one queue runner process. This scans the queue of
4559 waiting messages, and runs a delivery process for each one in turn. It waits
4560 for each delivery process to finish before starting the next one. A delivery
4561 process may not actually do any deliveries if the retry times for the addresses
4562 have not been reached. Use &%-qf%& (see below) if you want to override this.
4563
4564 If
4565 .cindex "SMTP" "passed connection"
4566 .cindex "SMTP" "multiple deliveries"
4567 .cindex "multiple SMTP deliveries"
4568 the delivery process spawns other processes to deliver other messages down
4569 passed SMTP connections, the queue runner waits for these to finish before
4570 proceeding.
4571
4572 When all the queued messages have been considered, the original queue runner
4573 process terminates. In other words, a single pass is made over the waiting
4574 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4575 this to be repeated periodically.
4576
4577 Exim processes the waiting messages in an unpredictable order. It isn't very
4578 random, but it is likely to be different each time, which is all that matters.
4579 If one particular message screws up a remote MTA, other messages to the same
4580 MTA have a chance of getting through if they get tried first.
4581
4582 It is possible to cause the messages to be processed in lexical message id
4583 order, which is essentially the order in which they arrived, by setting the
4584 &%queue_run_in_order%& option, but this is not recommended for normal use.
4585
4586 .vitem &%-q%&<&'qflags'&>
4587 The &%-q%& option may be followed by one or more flag letters that change its
4588 behaviour. They are all optional, but if more than one is present, they must
4589 appear in the correct order. Each flag is described in a separate item below.
4590
4591 .vitem &%-qq...%&
4592 .oindex "&%-qq%&"
4593 .cindex "queue" "double scanning"
4594 .cindex "queue" "routing"
4595 .cindex "routing" "whole queue before delivery"
4596 .cindex "first pass routing"
4597 .cindex "queue runner" "two phase"
4598 An option starting with &%-qq%& requests a two-stage queue run. In the first
4599 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4600 every domain. Addresses are routed, local deliveries happen, but no remote
4601 transports are run.
4602
4603 Performance will be best if the &%queue_run_in_order%& option is false.
4604 If that is so and the &%queue_fast_ramp%& option is true then
4605 in the first phase of the run,
4606 once a threshold number of messages are routed for a given host,
4607 a delivery process is forked in parallel with the rest of the scan.
4608
4609 .cindex "hints database" "remembering routing"
4610 The hints database that remembers which messages are waiting for specific hosts
4611 is updated, as if delivery to those hosts had been deferred. After this is
4612 complete, a second, normal queue scan happens, with routing and delivery taking
4613 place as normal. Messages that are routed to the same host should mostly be
4614 delivered down a single SMTP
4615 .cindex "SMTP" "passed connection"
4616 .cindex "SMTP" "multiple deliveries"
4617 .cindex "multiple SMTP deliveries"
4618 connection because of the hints that were set up during the first queue scan.
4619 This option may be useful for hosts that are connected to the Internet
4620 intermittently.
4621
4622 .vitem &%-q[q]i...%&
4623 .oindex "&%-qi%&"
4624 .cindex "queue" "initial delivery"
4625 If the &'i'& flag is present, the queue runner runs delivery processes only for
4626 those messages that haven't previously been tried. (&'i'& stands for &"initial
4627 delivery"&.) This can be helpful if you are putting messages in the queue using
4628 &%-odq%& and want a queue runner just to process the new messages.
4629
4630 .vitem &%-q[q][i]f...%&
4631 .oindex "&%-qf%&"
4632 .cindex "queue" "forcing delivery"
4633 .cindex "delivery" "forcing in queue run"
4634 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4635 message, whereas without &'f'& only those non-frozen addresses that have passed
4636 their retry times are tried.
4637
4638 .vitem &%-q[q][i]ff...%&
4639 .oindex "&%-qff%&"
4640 .cindex "frozen messages" "forcing delivery"
4641 If &'ff'& is present, a delivery attempt is forced for every message, whether
4642 frozen or not.
4643
4644 .vitem &%-q[q][i][f[f]]l%&
4645 .oindex "&%-ql%&"
4646 .cindex "queue" "local deliveries only"
4647 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4648 be done. If a message requires any remote deliveries, it remains in the queue
4649 for later delivery.
4650
4651 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4652 .oindex "&%-qG%&"
4653 .cindex queue named
4654 .cindex "named queues"  "deliver from"
4655 .cindex "queue" "delivering specific messages"
4656 If the &'G'& flag and a name is present, the queue runner operates on the
4657 queue with the given name rather than the default queue.
4658 The name should not contain a &'/'& character.
4659 For a periodic queue run (see below)
4660 append to the name a slash and a time value.
4661
4662 If other commandline options specify an action, a &'-qG<name>'& option
4663 will specify a queue to operate on.
4664 For example:
4665 .code
4666 exim -bp -qGquarantine
4667 mailq -qGquarantine
4668 exim -qGoffpeak -Rf @special.domain.example
4669 .endd
4670
4671 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4672 When scanning the queue, Exim can be made to skip over messages whose ids are
4673 lexically less than a given value by following the &%-q%& option with a
4674 starting message id. For example:
4675 .code
4676 exim -q 0t5C6f-0000c8-00
4677 .endd
4678 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4679 second message id is given, messages whose ids are lexically greater than it
4680 are also skipped. If the same id is given twice, for example,
4681 .code
4682 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4683 .endd
4684 just one delivery process is started, for that message. This differs from
4685 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4686 that it counts as a delivery from a queue run. Note that the selection
4687 mechanism does not affect the order in which the messages are scanned. There
4688 are also other ways of selecting specific sets of messages for delivery in a
4689 queue run &-- see &%-R%& and &%-S%&.
4690
4691 .vitem &%-q%&<&'qflags'&><&'time'&>
4692 .cindex "queue runner" "starting periodically"
4693 .cindex "periodic queue running"
4694 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4695 starting a queue runner process at intervals specified by the given time value
4696 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4697 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4698 single daemon process handles both functions. A common way of starting up a
4699 combined daemon at system boot time is to use a command such as
4700 .code
4701 /usr/exim/bin/exim -bd -q30m
4702 .endd
4703 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4704 process every 30 minutes.
4705
4706 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4707 pid file is written unless one is explicitly requested by the &%-oP%& option.
4708
4709 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4710 .oindex "&%-qR%&"
4711 This option is synonymous with &%-R%&. It is provided for Sendmail
4712 compatibility.
4713
4714 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4715 .oindex "&%-qS%&"
4716 This option is synonymous with &%-S%&.
4717
4718 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4719 .oindex "&%-R%&"
4720 .cindex "queue runner" "for specific recipients"
4721 .cindex "delivery" "to given domain"
4722 .cindex "domain" "delivery to"
4723 The <&'rsflags'&> may be empty, in which case the white space before the string
4724 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4725 which are the possible values for <&'rsflags'&>. White space is required if
4726 <&'rsflags'&> is not empty.
4727
4728 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4729 perform a single queue run, except that, when scanning the messages on the
4730 queue, Exim processes only those that have at least one undelivered recipient
4731 address containing the given string, which is checked in a case-independent
4732 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4733 regular expression; otherwise it is a literal string.
4734
4735 If you want to do periodic queue runs for messages with specific recipients,
4736 you can combine &%-R%& with &%-q%& and a time value. For example:
4737 .code
4738 exim -q25m -R @special.domain.example
4739 .endd
4740 This example does a queue run for messages with recipients in the given domain
4741 every 25 minutes. Any additional flags that are specified with &%-q%& are
4742 applied to each queue run.
4743
4744 Once a message is selected for delivery by this mechanism, all its addresses
4745 are processed. For the first selected message, Exim overrides any retry
4746 information and forces a delivery attempt for each undelivered address. This
4747 means that if delivery of any address in the first message is successful, any
4748 existing retry information is deleted, and so delivery attempts for that
4749 address in subsequently selected messages (which are processed without forcing)
4750 will run. However, if delivery of any address does not succeed, the retry
4751 information is updated, and in subsequently selected messages, the failing
4752 address will be skipped.
4753
4754 .cindex "frozen messages" "forcing delivery"
4755 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4756 all selected messages, not just the first; frozen messages are included when
4757 &'ff'& is present.
4758
4759 The &%-R%& option makes it straightforward to initiate delivery of all messages
4760 to a given domain after a host has been down for some time. When the SMTP
4761 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4762 effect is to run Exim with the &%-R%& option, but it can be configured to run
4763 an arbitrary command instead.
4764
4765 .vitem &%-r%&
4766 .oindex "&%-r%&"
4767 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4768
4769 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4770 .oindex "&%-S%&"
4771 .cindex "delivery" "from given sender"
4772 .cindex "queue runner" "for specific senders"
4773 This option acts like &%-R%& except that it checks the string against each
4774 message's sender instead of against the recipients. If &%-R%& is also set, both
4775 conditions must be met for a message to be selected. If either of the options
4776 has &'f'& or &'ff'& in its flags, the associated action is taken.
4777
4778 .vitem &%-Tqt%&&~<&'times'&>
4779 .oindex "&%-Tqt%&"
4780 This is an option that is exclusively for use by the Exim testing suite. It is not
4781 recognized when Exim is run normally. It allows for the setting up of explicit
4782 &"queue times"& so that various warning/retry features can be tested.
4783
4784 .vitem &%-t%&
4785 .oindex "&%-t%&"
4786 .cindex "recipient" "extracting from header lines"
4787 .cindex "&'Bcc:'& header line"
4788 .cindex "&'Cc:'& header line"
4789 .cindex "&'To:'& header line"
4790 When Exim is receiving a locally-generated, non-SMTP message on its standard
4791 input, the &%-t%& option causes the recipients of the message to be obtained
4792 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4793 from the command arguments. The addresses are extracted before any rewriting
4794 takes place and the &'Bcc:'& header line, if present, is then removed.
4795
4796 .cindex "Sendmail compatibility" "&%-t%& option"
4797 If the command has any arguments, they specify addresses to which the message
4798 is &'not'& to be delivered. That is, the argument addresses are removed from
4799 the recipients list obtained from the headers. This is compatible with Smail 3
4800 and in accordance with the documented behaviour of several versions of
4801 Sendmail, as described in man pages on a number of operating systems (e.g.
4802 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4803 argument addresses to those obtained from the headers, and the O'Reilly
4804 Sendmail book documents it that way. Exim can be made to add argument addresses
4805 instead of subtracting them by setting the option
4806 &%extract_addresses_remove_arguments%& false.
4807
4808 .cindex "&%Resent-%& header lines" "with &%-t%&"
4809 If there are any &%Resent-%& header lines in the message, Exim extracts
4810 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4811 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4812 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4813 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4814
4815 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4816 message is resent several times). The RFC also specifies that they should be
4817 added at the front of the message, and separated by &'Received:'& lines. It is
4818 not at all clear how &%-t%& should operate in the present of multiple sets,
4819 nor indeed exactly what constitutes a &"set"&.
4820 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4821 are often added at the end of the header, and if a message is resent more than
4822 once, it is common for the original set of &%Resent-%& headers to be renamed as
4823 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4824
4825 .vitem &%-ti%&
4826 .oindex "&%-ti%&"
4827 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4828 compatibility with Sendmail.
4829
4830 .vitem &%-tls-on-connect%&
4831 .oindex "&%-tls-on-connect%&"
4832 .cindex "TLS" "use without STARTTLS"
4833 .cindex "TLS" "automatic start"
4834 This option is available when Exim is compiled with TLS support. It forces all
4835 incoming SMTP connections to behave as if the incoming port is listed in the
4836 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4837 &<<CHAPTLS>>& for further details.
4838
4839
4840 .vitem &%-U%&
4841 .oindex "&%-U%&"
4842 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4843 Sendmail uses this option for &"initial message submission"&, and its
4844 documentation states that in future releases, it may complain about
4845 syntactically invalid messages rather than fixing them when this flag is not
4846 set. Exim ignores this option.
4847
4848 .vitem &%-v%&
4849 .oindex "&%-v%&"
4850 This option causes Exim to write information to the standard error stream,
4851 describing what it is doing. In particular, it shows the log lines for
4852 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4853 dialogue is shown. Some of the log lines shown may not actually be written to
4854 the log if the setting of &%log_selector%& discards them. Any relevant
4855 selectors are shown with each log line. If none are shown, the logging is
4856 unconditional.
4857
4858 .vitem &%-x%&
4859 .oindex "&%-x%&"
4860 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4861 National Language Support extended characters in the body of the mail item"&).
4862 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4863 this option.
4864
4865 .vitem &%-X%&&~<&'logfile'&>
4866 .oindex "&%-X%&"
4867 This option is interpreted by Sendmail to cause debug information to be sent
4868 to the named file.  It is ignored by Exim.
4869
4870 .vitem &%-z%&&~<&'log-line'&>
4871 .oindex "&%-z%&"
4872 This option writes its argument to Exim's logfile.
4873 Use is restricted to administrators; the intent is for operational notes.
4874 Quotes should be used to maintain a multi-word item as a single argument,
4875 under most shells.
4876 .endlist
4877
4878 .ecindex IIDclo1
4879 .ecindex IIDclo2
4880
4881
4882 . ////////////////////////////////////////////////////////////////////////////
4883 . Insert a stylized DocBook comment here, to identify the end of the command
4884 . line options. This is for the benefit of the Perl script that automatically
4885 . creates a man page for the options.
4886 . ////////////////////////////////////////////////////////////////////////////
4887
4888 .literal xml
4889 <!-- === End of command line options === -->
4890 .literal off
4891
4892
4893
4894
4895
4896 . ////////////////////////////////////////////////////////////////////////////
4897 . ////////////////////////////////////////////////////////////////////////////
4898
4899
4900 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4901          "The runtime configuration file"
4902
4903 .cindex "runtime configuration"
4904 .cindex "configuration file" "general description"
4905 .cindex "CONFIGURE_FILE"
4906 .cindex "configuration file" "errors in"
4907 .cindex "error" "in configuration file"
4908 .cindex "return code" "for bad configuration"
4909 Exim uses a single runtime configuration file that is read whenever an Exim
4910 binary is executed. Note that in normal operation, this happens frequently,
4911 because Exim is designed to operate in a distributed manner, without central
4912 control.
4913
4914 If a syntax error is detected while reading the configuration file, Exim
4915 writes a message on the standard error, and exits with a non-zero return code.
4916 The message is also written to the panic log. &*Note*&: Only simple syntax
4917 errors can be detected at this time. The values of any expanded options are
4918 not checked until the expansion happens, even when the expansion does not
4919 actually alter the string.
4920
4921 The name of the configuration file is compiled into the binary for security
4922 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4923 most configurations, this specifies a single file. However, it is permitted to
4924 give a colon-separated list of filenames, in which case Exim uses the first
4925 existing file in the list.
4926
4927 .cindex "EXIM_USER"
4928 .cindex "EXIM_GROUP"
4929 .cindex "CONFIGURE_OWNER"
4930 .cindex "CONFIGURE_GROUP"
4931 .cindex "configuration file" "ownership"
4932 .cindex "ownership" "configuration file"
4933 The runtime configuration file must be owned by root or by the user that is
4934 specified at compile time by the CONFIGURE_OWNER option (if set). The
4935 configuration file must not be world-writeable, or group-writeable unless its
4936 group is the root group or the one specified at compile time by the
4937 CONFIGURE_GROUP option.
4938
4939 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4940 to root, anybody who is able to edit the runtime configuration file has an
4941 easy way to run commands as root. If you specify a user or group in the
4942 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4943 who are members of that group will trivially be able to obtain root privileges.
4944
4945 Up to Exim version 4.72, the runtime configuration file was also permitted to
4946 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4947 since it offered a simple privilege escalation for any attacker who managed to
4948 compromise the Exim user account.
4949
4950 A default configuration file, which will work correctly in simple situations,
4951 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4952 defines just one filename, the installation process copies the default
4953 configuration to a new file of that name if it did not previously exist. If
4954 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4955 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4956 configuration.
4957
4958
4959
4960 .section "Using a different configuration file" "SECID40"
4961 .cindex "configuration file" "alternate"
4962 A one-off alternate configuration can be specified by the &%-C%& command line
4963 option, which may specify a single file or a list of files. However, when
4964 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4965 unless the argument for &%-C%& is identical to the built-in value from
4966 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4967 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4968 is useful mainly for checking the syntax of configuration files before
4969 installing them. No owner or group checks are done on a configuration file
4970 specified by &%-C%&, if root privilege has been dropped.
4971
4972 Even the Exim user is not trusted to specify an arbitrary configuration file
4973 with the &%-C%& option to be used with root privileges, unless that file is
4974 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4975 testing a configuration using &%-C%& right through message reception and
4976 delivery, even if the caller is root. The reception works, but by that time,
4977 Exim is running as the Exim user, so when it re-execs to regain privilege for
4978 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4979 can test reception and delivery using two separate commands (one to put a
4980 message in the queue, using &%-odq%&, and another to do the delivery, using
4981 &%-M%&).
4982
4983 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4984 prefix string with which any file named in a &%-C%& command line option must
4985 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4986 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4987 filename can be used with &%-C%&.
4988
4989 One-off changes to a configuration can be specified by the &%-D%& command line
4990 option, which defines and overrides values for macros used inside the
4991 configuration file. However, like &%-C%&, the use of this option by a
4992 non-privileged user causes Exim to discard its root privilege.
4993 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4994 completely disabled, and its use causes an immediate error exit.
4995
4996 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4997 to declare certain macro names trusted, such that root privilege will not
4998 necessarily be discarded.
4999 WHITELIST_D_MACROS defines a colon-separated list of macros which are
5000 considered safe and, if &%-D%& only supplies macros from this list, and the
5001 values are acceptable, then Exim will not give up root privilege if the caller
5002 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
5003 transition mechanism and is expected to be removed in the future.  Acceptable
5004 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
5005
5006 Some sites may wish to use the same Exim binary on different machines that
5007 share a file system, but to use different configuration files on each machine.
5008 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
5009 looks for a file whose name is the configuration filename followed by a dot
5010 and the machine's node name, as obtained from the &[uname()]& function. If this
5011 file does not exist, the standard name is tried. This processing occurs for
5012 each filename in the list given by CONFIGURE_FILE or &%-C%&.
5013
5014 In some esoteric situations different versions of Exim may be run under
5015 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
5016 help with this. See the comments in &_src/EDITME_& for details.
5017
5018
5019
5020 .section "Configuration file format" "SECTconffilfor"
5021 .cindex "configuration file" "format of"
5022 .cindex "format" "configuration file"
5023 Exim's configuration file is divided into a number of different parts. General
5024 option settings must always appear at the start of the file. The other parts
5025 are all optional, and may appear in any order. Each part other than the first
5026 is introduced by the word &"begin"& followed by at least one literal
5027 space, and the name of the part. The optional parts are:
5028
5029 .ilist
5030 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
5031 &<<CHAPACL>>&).
5032 .next
5033 .cindex "AUTH" "configuration"
5034 &'authenticators'&: Configuration settings for the authenticator drivers. These
5035 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
5036 .next
5037 &'routers'&: Configuration settings for the router drivers. Routers process
5038 addresses and determine how the message is to be delivered (see chapters
5039 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
5040 .next
5041 &'transports'&: Configuration settings for the transport drivers. Transports
5042 define mechanisms for copying messages to destinations (see chapters
5043 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
5044 .next
5045 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
5046 If there is no retry section, or if it is empty (that is, no retry rules are
5047 defined), Exim will not retry deliveries. In this situation, temporary errors
5048 are treated the same as permanent errors. Retry rules are discussed in chapter
5049 &<<CHAPretry>>&.
5050 .next
5051 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
5052 when new addresses are generated during delivery. Rewriting is discussed in
5053 chapter &<<CHAPrewrite>>&.
5054 .next
5055 &'local_scan'&: Private options for the &[local_scan()]& function. If you
5056 want to use this feature, you must set
5057 .code
5058 LOCAL_SCAN_HAS_OPTIONS=yes
5059 .endd
5060 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
5061 facility are given in chapter &<<CHAPlocalscan>>&.
5062 .endlist
5063
5064 .cindex "configuration file" "leading white space in"
5065 .cindex "configuration file" "trailing white space in"
5066 .cindex "white space" "in configuration file"
5067 Leading and trailing white space in configuration lines is always ignored.
5068
5069 Blank lines in the file, and lines starting with a # character (ignoring
5070 leading white space) are treated as comments and are ignored. &*Note*&: A
5071 # character other than at the beginning of a line is not treated specially,
5072 and does not introduce a comment.
5073
5074 Any non-comment line can be continued by ending it with a backslash. Note that
5075 the general rule for white space means that trailing white space after the
5076 backslash and leading white space at the start of continuation
5077 lines is ignored. Comment lines beginning with # (but not empty lines) may
5078 appear in the middle of a sequence of continuation lines.
5079
5080 A convenient way to create a configuration file is to start from the
5081 default, which is supplied in &_src/configure.default_&, and add, delete, or
5082 change settings as required.
5083
5084 The ACLs, retry rules, and rewriting rules have their own syntax which is
5085 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5086 respectively. The other parts of the configuration file have some syntactic
5087 items in common, and these are described below, from section &<<SECTcos>>&
5088 onwards. Before that, the inclusion, macro, and conditional facilities are
5089 described.
5090
5091
5092
5093 .section "File inclusions in the configuration file" "SECID41"
5094 .cindex "inclusions in configuration file"
5095 .cindex "configuration file" "including other files"
5096 .cindex "&`.include`& in configuration file"
5097 .cindex "&`.include_if_exists`& in configuration file"
5098 You can include other files inside Exim's runtime configuration file by
5099 using this syntax:
5100 .display
5101 &`.include`& <&'filename'&>
5102 &`.include_if_exists`& <&'filename'&>
5103 .endd
5104 on a line by itself. Double quotes round the filename are optional. If you use
5105 the first form, a configuration error occurs if the file does not exist; the
5106 second form does nothing for non-existent files.
5107 The first form allows a relative name. It is resolved relative to
5108 the directory of the including file. For the second form an absolute filename
5109 is required.
5110
5111 Includes may be nested to any depth, but remember that Exim reads its
5112 configuration file often, so it is a good idea to keep them to a minimum.
5113 If you change the contents of an included file, you must HUP the daemon,
5114 because an included file is read only when the configuration itself is read.
5115
5116 The processing of inclusions happens early, at a physical line level, so, like
5117 comment lines, an inclusion can be used in the middle of an option setting,
5118 for example:
5119 .code
5120 hosts_lookup = a.b.c \
5121                .include /some/file
5122 .endd
5123 Include processing happens after macro processing (see below). Its effect is to
5124 process the lines of the included file as if they occurred inline where the
5125 inclusion appears.
5126
5127
5128
5129 .section "Macros in the configuration file" "SECTmacrodefs"
5130 .cindex "macro" "description of"
5131 .cindex "configuration file" "macros"
5132 If a line in the main part of the configuration (that is, before the first
5133 &"begin"& line) begins with an upper case letter, it is taken as a macro
5134 definition, and must be of the form
5135 .display
5136 <&'name'&> = <&'rest of line'&>
5137 .endd
5138 The name must consist of letters, digits, and underscores, and need not all be
5139 in upper case, though that is recommended. The rest of the line, including any
5140 continuations, is the replacement text, and has leading and trailing white
5141 space removed. Quotes are not removed. The replacement text can never end with
5142 a backslash character, but this doesn't seem to be a serious limitation.
5143
5144 Macros may also be defined between router, transport, authenticator, or ACL
5145 definitions. They may not, however, be defined within an individual driver or
5146 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5147
5148 .section "Macro substitution" "SECID42"
5149 Once a macro is defined, all subsequent lines in the file (and any included
5150 files) are scanned for the macro name; if there are several macros, the line is
5151 scanned for each, in turn, in the order in which the macros are defined. The
5152 replacement text is not re-scanned for the current macro, though it is scanned
5153 for subsequently defined macros. For this reason, a macro name may not contain
5154 the name of a previously defined macro as a substring. You could, for example,
5155 define
5156 .display
5157 &`ABCD_XYZ = `&<&'something'&>
5158 &`ABCD = `&<&'something else'&>
5159 .endd
5160 but putting the definitions in the opposite order would provoke a configuration
5161 error. Macro expansion is applied to individual physical lines from the file,
5162 before checking for line continuation or file inclusion (see above). If a line
5163 consists solely of a macro name, and the expansion of the macro is empty, the
5164 line is ignored. A macro at the start of a line may turn the line into a
5165 comment line or a &`.include`& line.
5166
5167
5168 .section "Redefining macros" "SECID43"
5169 Once defined, the value of a macro can be redefined later in the configuration
5170 (or in an included file). Redefinition is specified by using &'=='& instead of
5171 &'='&. For example:
5172 .code
5173 MAC =  initial value
5174 ...
5175 MAC == updated value
5176 .endd
5177 Redefinition does not alter the order in which the macros are applied to the
5178 subsequent lines of the configuration file. It is still the same order in which
5179 the macros were originally defined. All that changes is the macro's value.
5180 Redefinition makes it possible to accumulate values. For example:
5181 .code
5182 MAC =  initial value
5183 ...
5184 MAC == MAC and something added
5185 .endd
5186 This can be helpful in situations where the configuration file is built
5187 from a number of other files.
5188
5189 .section "Overriding macro values" "SECID44"
5190 The values set for macros in the configuration file can be overridden by the
5191 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5192 used, unless called by root or the Exim user. A definition on the command line
5193 using the &%-D%& option causes all definitions and redefinitions within the
5194 file to be ignored.
5195
5196
5197
5198 .section "Example of macro usage" "SECID45"
5199 As an example of macro usage, consider a configuration where aliases are looked
5200 up in a MySQL database. It helps to keep the file less cluttered if long
5201 strings such as SQL statements are defined separately as macros, for example:
5202 .code
5203 ALIAS_QUERY = select mailbox from user where \
5204               login='${quote_mysql:$local_part}';
5205 .endd
5206 This can then be used in a &(redirect)& router setting like this:
5207 .code
5208 data = ${lookup mysql{ALIAS_QUERY}}
5209 .endd
5210 In earlier versions of Exim macros were sometimes used for domain, host, or
5211 address lists. In Exim 4 these are handled better by named lists &-- see
5212 section &<<SECTnamedlists>>&.
5213
5214
5215 .section "Builtin macros" "SECTbuiltinmacros"
5216 Exim defines some macros depending on facilities available, which may
5217 differ due to build-time definitions and from one release to another.
5218 All of these macros start with an underscore.
5219 They can be used to conditionally include parts of a configuration
5220 (see below).
5221
5222 The following classes of macros are defined:
5223 .display
5224 &` _HAVE_*                    `&  build-time defines
5225 &` _DRIVER_ROUTER_*           `&  router drivers
5226 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5227 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5228 &` _LOG_*                     `&  log_selector values
5229 &` _OPT_MAIN_*                `&  main config options
5230 &` _OPT_ROUTERS_*             `&  generic router options
5231 &` _OPT_TRANSPORTS_*          `&  generic transport options
5232 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5233 &` _OPT_ROUTER_*_*            `&  private router options
5234 &` _OPT_TRANSPORT_*_*         `&  private transport options
5235 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5236 .endd
5237
5238 Use an &"exim -bP macros"& command to get the list of macros.
5239
5240
5241 .section "Conditional skips in the configuration file" "SECID46"
5242 .cindex "configuration file" "conditional skips"
5243 .cindex "&`.ifdef`&"
5244 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5245 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5246 portions of the configuration file. The processing happens whenever the file is
5247 read (that is, when an Exim binary starts to run).
5248
5249 The implementation is very simple. Instances of the first four directives must
5250 be followed by text that includes the names of one or macros. The condition
5251 that is tested is whether or not any macro substitution has taken place in the
5252 line. Thus:
5253 .code
5254 .ifdef AAA
5255 message_size_limit = 50M
5256 .else
5257 message_size_limit = 100M
5258 .endif
5259 .endd
5260 sets a message size limit of 50M if the macro &`AAA`& is defined
5261 (or &`A`& or &`AA`&), and 100M
5262 otherwise. If there is more than one macro named on the line, the condition
5263 is true if any of them are defined. That is, it is an &"or"& condition. To
5264 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5265
5266 Although you can use a macro expansion to generate one of these directives,
5267 it is not very useful, because the condition &"there was a macro substitution
5268 in this line"& will always be true.
5269
5270 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5271 to clarify complicated nestings.
5272
5273
5274
5275 .section "Common option syntax" "SECTcos"
5276 .cindex "common option syntax"
5277 .cindex "syntax of common options"
5278 .cindex "configuration file" "common option syntax"
5279 For the main set of options, driver options, and &[local_scan()]& options,
5280 each setting is on a line by itself, and starts with a name consisting of
5281 lower-case letters and underscores. Many options require a data value, and in
5282 these cases the name must be followed by an equals sign (with optional white
5283 space) and then the value. For example:
5284 .code
5285 qualify_domain = mydomain.example.com
5286 .endd
5287 .cindex "hiding configuration option values"
5288 .cindex "configuration options" "hiding value of"
5289 .cindex "options" "hiding value of"
5290 Some option settings may contain sensitive data, for example, passwords for
5291 accessing databases. To stop non-admin users from using the &%-bP%& command
5292 line option to read these values, you can precede the option settings with the
5293 word &"hide"&. For example:
5294 .code
5295 hide mysql_servers = localhost/users/admin/secret-password
5296 .endd
5297 For non-admin users, such options are displayed like this:
5298 .code
5299 mysql_servers = <value not displayable>
5300 .endd
5301 If &"hide"& is used on a driver option, it hides the value of that option on
5302 all instances of the same driver.
5303
5304 The following sections describe the syntax used for the different data types
5305 that are found in option settings.
5306
5307
5308 .section "Boolean options" "SECID47"
5309 .cindex "format" "boolean"
5310 .cindex "boolean configuration values"
5311 .oindex "&%no_%&&'xxx'&"
5312 .oindex "&%not_%&&'xxx'&"
5313 Options whose type is given as boolean are on/off switches. There are two
5314 different ways of specifying such options: with and without a data value. If
5315 the option name is specified on its own without data, the switch is turned on;
5316 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5317 boolean options may be followed by an equals sign and one of the words
5318 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5319 the following two settings have exactly the same effect:
5320 .code
5321 queue_only
5322 queue_only = true
5323 .endd
5324 The following two lines also have the same (opposite) effect:
5325 .code
5326 no_queue_only
5327 queue_only = false
5328 .endd
5329 You can use whichever syntax you prefer.
5330
5331
5332
5333
5334 .section "Integer values" "SECID48"
5335 .cindex "integer configuration values"
5336 .cindex "format" "integer"
5337 If an option's type is given as &"integer"&, the value can be given in decimal,
5338 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5339 number is assumed. Otherwise, it is treated as an octal number unless it starts
5340 with the characters &"0x"&, in which case the remainder is interpreted as a
5341 hexadecimal number.
5342
5343 If an integer value is followed by the letter K, it is multiplied by 1024; if
5344 it is followed by the letter M, it is multiplied by 1024x1024;
5345 if by the letter G, 1024x1024x1024.
5346 When the values
5347 of integer option settings are output, values which are an exact multiple of
5348 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5349 and M. The printing style is independent of the actual input format that was
5350 used.
5351
5352
5353 .section "Octal integer values" "SECID49"
5354 .cindex "integer format"
5355 .cindex "format" "octal integer"
5356 If an option's type is given as &"octal integer"&, its value is always
5357 interpreted as an octal number, whether or not it starts with the digit zero.
5358 Such options are always output in octal.
5359
5360
5361 .section "Fixed point numbers" "SECID50"
5362 .cindex "fixed point configuration values"
5363 .cindex "format" "fixed point"
5364 If an option's type is given as &"fixed-point"&, its value must be a decimal
5365 integer, optionally followed by a decimal point and up to three further digits.
5366
5367
5368
5369 .section "Time intervals" "SECTtimeformat"
5370 .cindex "time interval" "specifying in configuration"
5371 .cindex "format" "time interval"
5372 A time interval is specified as a sequence of numbers, each followed by one of
5373 the following letters, with no intervening white space:
5374
5375 .table2 30pt
5376 .irow &%s%& seconds
5377 .irow &%m%& minutes
5378 .irow &%h%& hours
5379 .irow &%d%& days
5380 .irow &%w%& weeks
5381 .endtable
5382
5383 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5384 intervals are output in the same format. Exim does not restrict the values; it
5385 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5386
5387
5388
5389 .section "String values" "SECTstrings"
5390 .cindex "string" "format of configuration values"
5391 .cindex "format" "string"
5392 If an option's type is specified as &"string"&, the value can be specified with
5393 or without double-quotes. If it does not start with a double-quote, the value
5394 consists of the remainder of the line plus any continuation lines, starting at
5395 the first character after any leading white space, with trailing white space
5396 removed, and with no interpretation of the characters in the string. Because
5397 Exim removes comment lines (those beginning with #) at an early stage, they can
5398 appear in the middle of a multi-line string. The following two settings are
5399 therefore equivalent:
5400 .code
5401 trusted_users = uucp:mail
5402 trusted_users = uucp:\
5403                 # This comment line is ignored
5404                 mail
5405 .endd
5406 .cindex "string" "quoted"
5407 .cindex "escape characters in quoted strings"
5408 If a string does start with a double-quote, it must end with a closing
5409 double-quote, and any backslash characters other than those used for line
5410 continuation are interpreted as escape characters, as follows:
5411
5412 .table2 100pt
5413 .irow &`\\`&                     "single backslash"
5414 .irow &`\n`&                     "newline"
5415 .irow &`\r`&                     "carriage return"
5416 .irow &`\t`&                     "tab"
5417 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5418 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5419                                    character"
5420 .endtable
5421
5422 If a backslash is followed by some other character, including a double-quote
5423 character, that character replaces the pair.
5424
5425 Quoting is necessary only if you want to make use of the backslash escapes to
5426 insert special characters, or if you need to specify a value with leading or
5427 trailing spaces. These cases are rare, so quoting is almost never needed in
5428 current versions of Exim. In versions of Exim before 3.14, quoting was required
5429 in order to continue lines, so you may come across older configuration files
5430 and examples that apparently quote unnecessarily.
5431
5432
5433 .section "Expanded strings" "SECID51"
5434 .cindex "expansion" "definition of"
5435 Some strings in the configuration file are subjected to &'string expansion'&,
5436 by which means various parts of the string may be changed according to the
5437 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5438 is as just described; in particular, the handling of backslashes in quoted
5439 strings is done as part of the input process, before expansion takes place.
5440 However, backslash is also an escape character for the expander, so any
5441 backslashes that are required for that reason must be doubled if they are
5442 within a quoted configuration string.
5443
5444
5445 .section "User and group names" "SECID52"
5446 .cindex "user name" "format of"
5447 .cindex "format" "user name"
5448 .cindex "groups" "name format"
5449 .cindex "format" "group name"
5450 User and group names are specified as strings, using the syntax described
5451 above, but the strings are interpreted specially. A user or group name must
5452 either consist entirely of digits, or be a name that can be looked up using the
5453 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5454
5455
5456 .section "List construction" "SECTlistconstruct"
5457 .cindex "list" "syntax of in configuration"
5458 .cindex "format" "list item in configuration"
5459 .cindex "string" "list, definition of"
5460 The data for some configuration options is a list of items, with colon as the
5461 default separator. Many of these options are shown with type &"string list"& in
5462 the descriptions later in this document. Others are listed as &"domain list"&,
5463 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5464 are all the same; however, those other than &"string list"& are subject to
5465 particular kinds of interpretation, as described in chapter
5466 &<<CHAPdomhosaddlists>>&.
5467
5468 In all these cases, the entire list is treated as a single string as far as the
5469 input syntax is concerned. The &%trusted_users%& setting in section
5470 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5471 in a list, it must be entered as two colons. Leading and trailing white space
5472 on each item in a list is ignored. This makes it possible to include items that
5473 start with a colon, and in particular, certain forms of IPv6 address. For
5474 example, the list
5475 .code
5476 local_interfaces = 127.0.0.1 : ::::1
5477 .endd
5478 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5479
5480 &*Note*&: Although leading and trailing white space is ignored in individual
5481 list items, it is not ignored when parsing the list. The space after the first
5482 colon in the example above is necessary. If it were not there, the list would
5483 be interpreted as the two items 127.0.0.1:: and 1.
5484
5485 .section "Changing list separators" "SECTlistsepchange"
5486 .cindex "list separator" "changing"
5487 .cindex "IPv6" "addresses in lists"
5488 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5489 introduced to allow the separator character to be changed. If a list begins
5490 with a left angle bracket, followed by any punctuation character, that
5491 character is used instead of colon as the list separator. For example, the list
5492 above can be rewritten to use a semicolon separator like this:
5493 .code
5494 local_interfaces = <; 127.0.0.1 ; ::1
5495 .endd
5496 This facility applies to all lists, with the exception of the list in
5497 &%log_file_path%&. It is recommended that the use of non-colon separators be
5498 confined to circumstances where they really are needed.
5499
5500 .cindex "list separator" "newline as"
5501 .cindex "newline" "as list separator"
5502 It is also possible to use newline and other control characters (those with
5503 code values less than 32, plus DEL) as separators in lists. Such separators
5504 must be provided literally at the time the list is processed. For options that
5505 are string-expanded, you can write the separator using a normal escape
5506 sequence. This will be processed by the expander before the string is
5507 interpreted as a list. For example, if a newline-separated list of domains is
5508 generated by a lookup, you can process it directly by a line such as this:
5509 .code
5510 domains = <\n ${lookup mysql{.....}}
5511 .endd
5512 This avoids having to change the list separator in such data. You are unlikely
5513 to want to use a control character as a separator in an option that is not
5514 expanded, because the value is literal text. However, it can be done by giving
5515 the value in quotes. For example:
5516 .code
5517 local_interfaces = "<\n 127.0.0.1 \n ::1"
5518 .endd
5519 Unlike printing character separators, which can be included in list items by
5520 doubling, it is not possible to include a control character as data when it is
5521 set as the separator. Two such characters in succession are interpreted as
5522 enclosing an empty list item.
5523
5524
5525
5526 .section "Empty items in lists" "SECTempitelis"
5527 .cindex "list" "empty item in"
5528 An empty item at the end of a list is always ignored. In other words, trailing
5529 separator characters are ignored. Thus, the list in
5530 .code
5531 senders = user@domain :
5532 .endd
5533 contains only a single item. If you want to include an empty string as one item
5534 in a list, it must not be the last item. For example, this list contains three
5535 items, the second of which is empty:
5536 .code
5537 senders = user1@domain : : user2@domain
5538 .endd
5539 &*Note*&: There must be white space between the two colons, as otherwise they
5540 are interpreted as representing a single colon data character (and the list
5541 would then contain just one item). If you want to specify a list that contains
5542 just one, empty item, you can do it as in this example:
5543 .code
5544 senders = :
5545 .endd
5546 In this case, the first item is empty, and the second is discarded because it
5547 is at the end of the list.
5548
5549
5550
5551
5552 .section "Format of driver configurations" "SECTfordricon"
5553 .cindex "drivers" "configuration format"
5554 There are separate parts in the configuration for defining routers, transports,
5555 and authenticators. In each part, you are defining a number of driver
5556 instances, each with its own set of options. Each driver instance is defined by
5557 a sequence of lines like this:
5558 .display
5559 <&'instance name'&>:
5560   <&'option'&>
5561   ...
5562   <&'option'&>
5563 .endd
5564 In the following example, the instance name is &(localuser)&, and it is
5565 followed by three options settings:
5566 .code
5567 localuser:
5568   driver = accept
5569   check_local_user
5570   transport = local_delivery
5571 .endd
5572 For each driver instance, you specify which Exim code module it uses &-- by the
5573 setting of the &%driver%& option &-- and (optionally) some configuration
5574 settings. For example, in the case of transports, if you want a transport to
5575 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5576 a local file you would use the &(appendfile)& driver. Each of the drivers is
5577 described in detail in its own separate chapter later in this manual.
5578
5579 You can have several routers, transports, or authenticators that are based on
5580 the same underlying driver (each must have a different instance name).
5581
5582 The order in which routers are defined is important, because addresses are
5583 passed to individual routers one by one, in order. The order in which
5584 transports are defined does not matter at all. The order in which
5585 authenticators are defined is used only when Exim, as a client, is searching
5586 them to find one that matches an authentication mechanism offered by the
5587 server.
5588
5589 .cindex "generic options"
5590 .cindex "options" "generic &-- definition of"
5591 Within a driver instance definition, there are two kinds of option: &'generic'&
5592 and &'private'&. The generic options are those that apply to all drivers of the
5593 same type (that is, all routers, all transports or all authenticators). The
5594 &%driver%& option is a generic option that must appear in every definition.
5595 .cindex "private options"
5596 The private options are special for each driver, and none need appear, because
5597 they all have default values.
5598
5599 The options may appear in any order, except that the &%driver%& option must
5600 precede any private options, since these depend on the particular driver. For
5601 this reason, it is recommended that &%driver%& always be the first option.
5602
5603 Driver instance names, which are used for reference in log entries and
5604 elsewhere, can be any sequence of letters, digits, and underscores (starting
5605 with a letter) and must be unique among drivers of the same type. A router and
5606 a transport (for example) can each have the same name, but no two router
5607 instances can have the same name. The name of a driver instance should not be
5608 confused with the name of the underlying driver module. For example, the
5609 configuration lines:
5610 .code
5611 remote_smtp:
5612   driver = smtp
5613 .endd
5614 create an instance of the &(smtp)& transport driver whose name is
5615 &(remote_smtp)&. The same driver code can be used more than once, with
5616 different instance names and different option settings each time. A second
5617 instance of the &(smtp)& transport, with different options, might be defined
5618 thus:
5619 .code
5620 special_smtp:
5621   driver = smtp
5622   port = 1234
5623   command_timeout = 10s
5624 .endd
5625 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5626 these transport instances from routers, and these names would appear in log
5627 lines.
5628
5629 Comment lines may be present in the middle of driver specifications. The full
5630 list of option settings for any particular driver instance, including all the
5631 defaulted values, can be extracted by making use of the &%-bP%& command line
5632 option.
5633
5634
5635
5636
5637
5638
5639 . ////////////////////////////////////////////////////////////////////////////
5640 . ////////////////////////////////////////////////////////////////////////////
5641
5642 .chapter "The default configuration file" "CHAPdefconfil"
5643 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5644 .cindex "default" "configuration file &""walk through""&"
5645 The default configuration file supplied with Exim as &_src/configure.default_&
5646 is sufficient for a host with simple mail requirements. As an introduction to
5647 the way Exim is configured, this chapter &"walks through"& the default
5648 configuration, giving brief explanations of the settings. Detailed descriptions
5649 of the options are given in subsequent chapters. The default configuration file
5650 itself contains extensive comments about ways you might want to modify the
5651 initial settings. However, note that there are many options that are not
5652 mentioned at all in the default configuration.
5653
5654
5655
5656 .section "Macros" "SECTdefconfmacros"
5657 All macros should be defined before any options.
5658
5659 One macro is specified, but commented out, in the default configuration:
5660 .code
5661 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5662 .endd
5663 If all off-site mail is expected to be delivered to a "smarthost", then set the
5664 hostname here and uncomment the macro.  This will affect which router is used
5665 later on.  If this is left commented out, then Exim will perform direct-to-MX
5666 deliveries using a &(dnslookup)& router.
5667
5668 In addition to macros defined here, Exim includes a number of built-in macros
5669 to enable configuration to be guarded by a binary built with support for a
5670 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5671
5672
5673 .section "Main configuration settings" "SECTdefconfmain"
5674 The main (global) configuration option settings section must always come first
5675 in the file, after the macros.
5676 The first thing you'll see in the file, after some initial comments, is the line
5677 .code
5678 # primary_hostname =
5679 .endd
5680 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5681 to know the official, fully qualified name of your host, and this is where you
5682 can specify it. However, in most cases you do not need to set this option. When
5683 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5684
5685 The first three non-comment configuration lines are as follows:
5686 .code
5687 domainlist local_domains    = @
5688 domainlist relay_to_domains =
5689 hostlist   relay_from_hosts = 127.0.0.1
5690 .endd
5691 These are not, in fact, option settings. They are definitions of two named
5692 domain lists and one named host list. Exim allows you to give names to lists of
5693 domains, hosts, and email addresses, in order to make it easier to manage the
5694 configuration file (see section &<<SECTnamedlists>>&).
5695
5696 The first line defines a domain list called &'local_domains'&; this is used
5697 later in the configuration to identify domains that are to be delivered
5698 on the local host.
5699
5700 .cindex "@ in a domain list"
5701 There is just one item in this list, the string &"@"&. This is a special form
5702 of entry which means &"the name of the local host"&. Thus, if the local host is
5703 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5704 be delivered locally. Because the local host's name is referenced indirectly,
5705 the same configuration file can be used on different hosts.
5706
5707 The second line defines a domain list called &'relay_to_domains'&, but the
5708 list itself is empty. Later in the configuration we will come to the part that
5709 controls mail relaying through the local host; it allows relaying to any
5710 domains in this list. By default, therefore, no relaying on the basis of a mail
5711 domain is permitted.
5712
5713 The third line defines a host list called &'relay_from_hosts'&. This list is
5714 used later in the configuration to permit relaying from any host or IP address
5715 that matches the list. The default contains just the IP address of the IPv4
5716 loopback interface, which means that processes on the local host are able to
5717 submit mail for relaying by sending it over TCP/IP to that interface. No other
5718 hosts are permitted to submit messages for relaying.
5719
5720 Just to be sure there's no misunderstanding: at this point in the configuration
5721 we aren't actually setting up any controls. We are just defining some domains
5722 and hosts that will be used in the controls that are specified later.
5723
5724 The next two configuration lines are genuine option settings:
5725 .code
5726 acl_smtp_rcpt = acl_check_rcpt
5727 acl_smtp_data = acl_check_data
5728 .endd
5729 These options specify &'Access Control Lists'& (ACLs) that are to be used
5730 during an incoming SMTP session for every recipient of a message (every RCPT
5731 command), and after the contents of the message have been received,
5732 respectively. The names of the lists are &'acl_check_rcpt'& and
5733 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5734 section of the configuration. The RCPT ACL controls which recipients are
5735 accepted for an incoming message &-- if a configuration does not provide an ACL
5736 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5737 contents of a message to be checked.
5738
5739 Two commented-out option settings are next:
5740 .code
5741 # av_scanner = clamd:/tmp/clamd
5742 # spamd_address = 127.0.0.1 783
5743 .endd
5744 These are example settings that can be used when Exim is compiled with the
5745 content-scanning extension. The first specifies the interface to the virus
5746 scanner, and the second specifies the interface to SpamAssassin. Further
5747 details are given in chapter &<<CHAPexiscan>>&.
5748
5749 Three more commented-out option settings follow:
5750 .code
5751 # tls_advertise_hosts = *
5752 # tls_certificate = /etc/ssl/exim.crt
5753 # tls_privatekey = /etc/ssl/exim.pem
5754 .endd
5755 These are example settings that can be used when Exim is compiled with
5756 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5757 first one specifies the list of clients that are allowed to use TLS when
5758 connecting to this server; in this case, the wildcard means all clients. The
5759 other options specify where Exim should find its TLS certificate and private
5760 key, which together prove the server's identity to any clients that connect.
5761 More details are given in chapter &<<CHAPTLS>>&.
5762
5763 Another two commented-out option settings follow:
5764 .code
5765 # daemon_smtp_ports = 25 : 465 : 587
5766 # tls_on_connect_ports = 465
5767 .endd
5768 .cindex "port" "465 and 587"
5769 .cindex "port" "for message submission"
5770 .cindex "message" "submission, ports for"
5771 .cindex "submissions protocol"
5772 .cindex "smtps protocol"
5773 .cindex "ssmtp protocol"
5774 .cindex "SMTP" "submissions protocol"
5775 .cindex "SMTP" "ssmtp protocol"
5776 .cindex "SMTP" "smtps protocol"
5777 These options provide better support for roaming users who wish to use this
5778 server for message submission. They are not much use unless you have turned on
5779 TLS (as described in the previous paragraph) and authentication (about which
5780 more in section &<<SECTdefconfauth>>&).
5781 Mail submission from mail clients (MUAs) should be separate from inbound mail
5782 to your domain (MX delivery) for various good reasons (eg, ability to impose
5783 much saner TLS protocol and ciphersuite requirements without unintended
5784 consequences).
5785 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5786 which uses STARTTLS, so this is the &"submission"& port.
5787 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5788 which should be used in preference to 587.
5789 You should also consider deploying SRV records to help clients find
5790 these ports.
5791 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5792
5793 Two more commented-out options settings follow:
5794 .code
5795 # qualify_domain =
5796 # qualify_recipient =
5797 .endd
5798 The first of these specifies a domain that Exim uses when it constructs a
5799 complete email address from a local login name. This is often needed when Exim
5800 receives a message from a local process. If you do not set &%qualify_domain%&,
5801 the value of &%primary_hostname%& is used. If you set both of these options,
5802 you can have different qualification domains for sender and recipient
5803 addresses. If you set only the first one, its value is used in both cases.
5804
5805 .cindex "domain literal" "recognizing format"
5806 The following line must be uncommented if you want Exim to recognize
5807 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5808 (an IP address within square brackets) instead of a named domain.
5809 .code
5810 # allow_domain_literals
5811 .endd
5812 The RFCs still require this form, but many people think that in the modern
5813 Internet it makes little sense to permit mail to be sent to specific hosts by
5814 quoting their IP addresses. This ancient format has been used by people who
5815 try to abuse hosts by using them for unwanted relaying. However, some
5816 people believe there are circumstances (for example, messages addressed to
5817 &'postmaster'&) where domain literals are still useful.
5818
5819 The next configuration line is a kind of trigger guard:
5820 .code
5821 never_users = root
5822 .endd
5823 It specifies that no delivery must ever be run as the root user. The normal
5824 convention is to set up &'root'& as an alias for the system administrator. This
5825 setting is a guard against slips in the configuration.
5826 The list of users specified by &%never_users%& is not, however, the complete
5827 list; the build-time configuration in &_Local/Makefile_& has an option called
5828 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5829 contents of &%never_users%& are added to this list. By default
5830 FIXED_NEVER_USERS also specifies root.
5831
5832 When a remote host connects to Exim in order to send mail, the only information
5833 Exim has about the host's identity is its IP address. The next configuration
5834 line,
5835 .code
5836 host_lookup = *
5837 .endd
5838 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5839 in order to get a host name. This improves the quality of the logging
5840 information, but if you feel it is too expensive, you can remove it entirely,
5841 or restrict the lookup to hosts on &"nearby"& networks.
5842 Note that it is not always possible to find a host name from an IP address,
5843 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5844 unreachable.
5845
5846 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5847 1413 (hence their names):
5848 .code
5849 rfc1413_hosts = *
5850 rfc1413_query_timeout = 0s
5851 .endd
5852 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5853 Few hosts offer RFC1413 service these days; calls have to be
5854 terminated by a timeout and this needlessly delays the startup
5855 of an incoming SMTP connection.
5856 If you have hosts for which you trust RFC1413 and need this
5857 information, you can change this.
5858
5859 This line enables an efficiency SMTP option.  It is negotiated by clients
5860 and not expected to cause problems but can be disabled if needed.
5861 .code
5862 prdr_enable = true
5863 .endd
5864
5865 When Exim receives messages over SMTP connections, it expects all addresses to
5866 be fully qualified with a domain, as required by the SMTP definition. However,
5867 if you are running a server to which simple clients submit messages, you may
5868 find that they send unqualified addresses. The two commented-out options:
5869 .code
5870 # sender_unqualified_hosts =
5871 # recipient_unqualified_hosts =
5872 .endd
5873 show how you can specify hosts that are permitted to send unqualified sender
5874 and recipient addresses, respectively.
5875
5876 The &%log_selector%& option is used to increase the detail of logging
5877 over the default:
5878 .code
5879 log_selector = +smtp_protocol_error +smtp_syntax_error \
5880                +tls_certificate_verified
5881 .endd
5882
5883 The &%percent_hack_domains%& option is also commented out:
5884 .code
5885 # percent_hack_domains =
5886 .endd
5887 It provides a list of domains for which the &"percent hack"& is to operate.
5888 This is an almost obsolete form of explicit email routing. If you do not know
5889 anything about it, you can safely ignore this topic.
5890
5891 The next two settings in the main part of the default configuration are
5892 concerned with messages that have been &"frozen"& on Exim's queue. When a
5893 message is frozen, Exim no longer continues to try to deliver it. Freezing
5894 occurs when a bounce message encounters a permanent failure because the sender
5895 address of the original message that caused the bounce is invalid, so the
5896 bounce cannot be delivered. This is probably the most common case, but there
5897 are also other conditions that cause freezing, and frozen messages are not
5898 always bounce messages.
5899 .code
5900 ignore_bounce_errors_after = 2d
5901 timeout_frozen_after = 7d
5902 .endd
5903 The first of these options specifies that failing bounce messages are to be
5904 discarded after 2 days in the queue. The second specifies that any frozen
5905 message (whether a bounce message or not) is to be timed out (and discarded)
5906 after a week. In this configuration, the first setting ensures that no failing
5907 bounce message ever lasts a week.
5908
5909 Exim queues it's messages in a spool directory. If you expect to have
5910 large queues, you may consider using this option. It splits the spool
5911 directory into subdirectories to avoid file system degradation from
5912 many files in a single directory, resulting in better performance.
5913 Manual manipulation of queued messages becomes more complex (though fortunately
5914 not often needed).
5915 .code
5916 # split_spool_directory = true
5917 .endd
5918
5919 In an ideal world everybody follows the standards. For non-ASCII
5920 messages RFC 2047 is a standard, allowing a maximum line length of 76
5921 characters. Exim adheres that standard and won't process messages which
5922 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5923 In particular, the Exim maintainers have had multiple reports of
5924 problems from Russian administrators of issues until they disable this
5925 check, because of some popular, yet buggy, mail composition software.
5926 .code
5927 # check_rfc2047_length = false
5928 .endd
5929
5930 If you need to be strictly RFC compliant you may wish to disable the
5931 8BITMIME advertisement. Use this, if you exchange mails with systems
5932 that are not 8-bit clean.
5933 .code
5934 # accept_8bitmime = false
5935 .endd
5936
5937 Libraries you use may depend on specific environment settings.  This
5938 imposes a security risk (e.g. PATH). There are two lists:
5939 &%keep_environment%& for the variables to import as they are, and
5940 &%add_environment%& for variables we want to set to a fixed value.
5941 Note that TZ is handled separately, by the $%timezone%$ runtime
5942 option and by the TIMEZONE_DEFAULT buildtime option.
5943 .code
5944 # keep_environment = ^LDAP
5945 # add_environment = PATH=/usr/bin::/bin
5946 .endd
5947
5948
5949 .section "ACL configuration" "SECID54"
5950 .cindex "default" "ACLs"
5951 .cindex "&ACL;" "default configuration"
5952 In the default configuration, the ACL section follows the main configuration.
5953 It starts with the line
5954 .code
5955 begin acl
5956 .endd
5957 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5958 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5959 and &%acl_smtp_data%& above.
5960
5961 .cindex "RCPT" "ACL for"
5962 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5963 RCPT command specifies one of the message's recipients. The ACL statements
5964 are considered in order, until the recipient address is either accepted or
5965 rejected. The RCPT command is then accepted or rejected, according to the
5966 result of the ACL processing.
5967 .code
5968 acl_check_rcpt:
5969 .endd
5970 This line, consisting of a name terminated by a colon, marks the start of the
5971 ACL, and names it.
5972 .code
5973 accept  hosts = :
5974 .endd
5975 This ACL statement accepts the recipient if the sending host matches the list.
5976 But what does that strange list mean? It doesn't actually contain any host
5977 names or IP addresses. The presence of the colon puts an empty item in the
5978 list; Exim matches this only if the incoming message did not come from a remote
5979 host, because in that case, the remote hostname is empty. The colon is
5980 important. Without it, the list itself is empty, and can never match anything.
5981
5982 What this statement is doing is to accept unconditionally all recipients in
5983 messages that are submitted by SMTP from local processes using the standard
5984 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5985 manner.
5986 .code
5987 deny    domains       = +local_domains
5988         local_parts   = ^[.] : ^.*[@%!/|]
5989         message       = Restricted characters in address
5990
5991 deny    domains       = !+local_domains
5992         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5993         message       = Restricted characters in address
5994 .endd
5995 These statements are concerned with local parts that contain any of the
5996 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5997 Although these characters are entirely legal in local parts (in the case of
5998 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5999 in Internet mail addresses.
6000
6001 The first three have in the past been associated with explicitly routed
6002 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
6003 option). Addresses containing these characters are regularly tried by spammers
6004 in an attempt to bypass relaying restrictions, and also by open relay testing
6005 programs. Unless you really need them it is safest to reject these characters
6006 at this early stage. This configuration is heavy-handed in rejecting these
6007 characters for all messages it accepts from remote hosts. This is a deliberate
6008 policy of being as safe as possible.
6009
6010 The first rule above is stricter, and is applied to messages that are addressed
6011 to one of the local domains handled by this host. This is implemented by the
6012 first condition, which restricts it to domains that are listed in the
6013 &'local_domains'& domain list. The &"+"& character is used to indicate a
6014 reference to a named list. In this configuration, there is just one domain in
6015 &'local_domains'&, but in general there may be many.
6016
6017 The second condition on the first statement uses two regular expressions to
6018 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
6019 or &"|"&. If you have local accounts that include these characters, you will
6020 have to modify this rule.
6021
6022 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
6023 allows them because they have been encountered in practice. (Consider the
6024 common convention of local parts constructed as
6025 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
6026 the author of Exim, who has no second initial.) However, a local part starting
6027 with a dot or containing &"/../"& can cause trouble if it is used as part of a
6028 filename (for example, for a mailing list). This is also true for local parts
6029 that contain slashes. A pipe symbol can also be troublesome if the local part
6030 is incorporated unthinkingly into a shell command line.
6031
6032 The second rule above applies to all other domains, and is less strict. This
6033 allows your own users to send outgoing messages to sites that use slashes
6034 and vertical bars in their local parts. It blocks local parts that begin
6035 with a dot, slash, or vertical bar, but allows these characters within the
6036 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
6037 and &"!"& is blocked, as before. The motivation here is to prevent your users
6038 (or your users' viruses) from mounting certain kinds of attack on remote sites.
6039 .code
6040 accept  local_parts   = postmaster
6041         domains       = +local_domains
6042 .endd
6043 This statement, which has two conditions, accepts an incoming address if the
6044 local part is &'postmaster'& and the domain is one of those listed in the
6045 &'local_domains'& domain list. The &"+"& character is used to indicate a
6046 reference to a named list. In this configuration, there is just one domain in
6047 &'local_domains'&, but in general there may be many.
6048
6049 The presence of this statement means that mail to postmaster is never blocked
6050 by any of the subsequent tests. This can be helpful while sorting out problems
6051 in cases where the subsequent tests are incorrectly denying access.
6052 .code
6053 require verify        = sender
6054 .endd
6055 This statement requires the sender address to be verified before any subsequent
6056 ACL statement can be used. If verification fails, the incoming recipient
6057 address is refused. Verification consists of trying to route the address, to
6058 see if a bounce message could be delivered to it. In the case of remote
6059 addresses, basic verification checks only the domain, but &'callouts'& can be
6060 used for more verification if required. Section &<<SECTaddressverification>>&
6061 discusses the details of address verification.
6062 .code
6063 accept  hosts         = +relay_from_hosts
6064         control       = submission
6065 .endd
6066 This statement accepts the address if the message is coming from one of the
6067 hosts that are defined as being allowed to relay through this host. Recipient
6068 verification is omitted here, because in many cases the clients are dumb MUAs
6069 that do not cope well with SMTP error responses. For the same reason, the
6070 second line specifies &"submission mode"& for messages that are accepted. This
6071 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6072 messages that are deficient in some way, for example, because they lack a
6073 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6074 probably add recipient verification here, and disable submission mode.
6075 .code
6076 accept  authenticated = *
6077         control       = submission
6078 .endd
6079 This statement accepts the address if the client host has authenticated itself.
6080 Submission mode is again specified, on the grounds that such messages are most
6081 likely to come from MUAs. The default configuration does not define any
6082 authenticators, though it does include some nearly complete commented-out
6083 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6084 fact authenticate until you complete the authenticator definitions.
6085 .code
6086 require message = relay not permitted
6087         domains = +local_domains : +relay_to_domains
6088 .endd
6089 This statement rejects the address if its domain is neither a local domain nor
6090 one of the domains for which this host is a relay.
6091 .code
6092 require verify = recipient
6093 .endd
6094 This statement requires the recipient address to be verified; if verification
6095 fails, the address is rejected.
6096 .code
6097 # deny    dnslists    = black.list.example
6098 #         message     = rejected because $sender_host_address \
6099 #                       is in a black list at $dnslist_domain\n\
6100 #                       $dnslist_text
6101 #
6102 # warn    dnslists    = black.list.example
6103 #         add_header  = X-Warning: $sender_host_address is in \
6104 #                       a black list at $dnslist_domain
6105 #         log_message = found in $dnslist_domain
6106 .endd
6107 These commented-out lines are examples of how you could configure Exim to check
6108 sending hosts against a DNS black list. The first statement rejects messages
6109 from blacklisted hosts, whereas the second just inserts a warning header
6110 line.
6111 .code
6112 # require verify = csa
6113 .endd
6114 This commented-out line is an example of how you could turn on client SMTP
6115 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6116 records.
6117 .code
6118 accept
6119 .endd
6120 The final statement in the first ACL unconditionally accepts any recipient
6121 address that has successfully passed all the previous tests.
6122 .code
6123 acl_check_data:
6124 .endd
6125 This line marks the start of the second ACL, and names it. Most of the contents
6126 of this ACL are commented out:
6127 .code
6128 # deny    malware   = *
6129 #         message   = This message contains a virus \
6130 #                     ($malware_name).
6131 .endd
6132 These lines are examples of how to arrange for messages to be scanned for
6133 viruses when Exim has been compiled with the content-scanning extension, and a
6134 suitable virus scanner is installed. If the message is found to contain a
6135 virus, it is rejected with the given custom error message.
6136 .code
6137 # warn    spam      = nobody
6138 #         message   = X-Spam_score: $spam_score\n\
6139 #                     X-Spam_score_int: $spam_score_int\n\
6140 #                     X-Spam_bar: $spam_bar\n\
6141 #                     X-Spam_report: $spam_report
6142 .endd
6143 These lines are an example of how to arrange for messages to be scanned by
6144 SpamAssassin when Exim has been compiled with the content-scanning extension,
6145 and SpamAssassin has been installed. The SpamAssassin check is run with
6146 &`nobody`& as its user parameter, and the results are added to the message as a
6147 series of extra header line. In this case, the message is not rejected,
6148 whatever the spam score.
6149 .code
6150 accept
6151 .endd
6152 This final line in the DATA ACL accepts the message unconditionally.
6153
6154
6155 .section "Router configuration" "SECID55"
6156 .cindex "default" "routers"
6157 .cindex "routers" "default"
6158 The router configuration comes next in the default configuration, introduced
6159 by the line
6160 .code
6161 begin routers
6162 .endd
6163 Routers are the modules in Exim that make decisions about where to send
6164 messages. An address is passed to each router, in turn, until it is either
6165 accepted, or failed. This means that the order in which you define the routers
6166 matters. Each router is fully described in its own chapter later in this
6167 manual. Here we give only brief overviews.
6168 .code
6169 # domain_literal:
6170 #   driver = ipliteral
6171 #   domains = !+local_domains
6172 #   transport = remote_smtp
6173 .endd
6174 .cindex "domain literal" "default router"
6175 This router is commented out because the majority of sites do not want to
6176 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6177 you uncomment this router, you also need to uncomment the setting of
6178 &%allow_domain_literals%& in the main part of the configuration.
6179
6180 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6181 macro has been defined, per
6182 .code
6183 .ifdef ROUTER_SMARTHOST
6184 smarthost:
6185 #...
6186 .else
6187 dnslookup:
6188 #...
6189 .endif
6190 .endd
6191
6192 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6193 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6194 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6195 skip these routers because of the &%domains%& option.
6196
6197 .code
6198 smarthost:
6199   driver = manualroute
6200   domains = ! +local_domains
6201   transport = smarthost_smtp
6202   route_data = ROUTER_SMARTHOST
6203   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6204   no_more
6205 .endd
6206 This router only handles mail which is not to any local domains; this is
6207 specified by the line
6208 .code
6209 domains = ! +local_domains
6210 .endd
6211 The &%domains%& option lists the domains to which this router applies, but the
6212 exclamation mark is a negation sign, so the router is used only for domains
6213 that are not in the domain list called &'local_domains'& (which was defined at
6214 the start of the configuration). The plus sign before &'local_domains'&
6215 indicates that it is referring to a named list. Addresses in other domains are
6216 passed on to the following routers.
6217
6218 The name of the router driver is &(manualroute)& because we are manually
6219 specifying how mail should be routed onwards, instead of using DNS MX.
6220 While the name of this router instance is arbitrary, the &%driver%& option must
6221 be one of the driver modules that is in the Exim binary.
6222
6223 With no pre-conditions other than &%domains%&, all mail for non-local domains
6224 will be handled by this router, and the &%no_more%& setting will ensure that no
6225 other routers will be used for messages matching the pre-conditions.  See
6226 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6227 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6228 and the macro supplies the value; the address is then queued for the
6229 &(smarthost_smtp)& transport.
6230
6231 .code
6232 dnslookup:
6233   driver = dnslookup
6234   domains = ! +local_domains
6235   transport = remote_smtp
6236   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6237   no_more
6238 .endd
6239 The &%domains%& option behaves as per smarthost, above.
6240
6241 The name of the router driver is &(dnslookup)&,
6242 and is specified by the &%driver%& option. Do not be confused by the fact that
6243 the name of this router instance is the same as the name of the driver. The
6244 instance name is arbitrary, but the name set in the &%driver%& option must be
6245 one of the driver modules that is in the Exim binary.
6246
6247 The &(dnslookup)& router routes addresses by looking up their domains in the
6248 DNS in order to obtain a list of hosts to which the address is routed. If the
6249 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6250 specified by the &%transport%& option. If the router does not find the domain
6251 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6252 the address fails and is bounced.
6253
6254 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6255 be entirely ignored. This option is present because a number of cases have been
6256 encountered where MX records in the DNS point to host names
6257 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6258 Completely ignoring these IP addresses causes Exim to fail to route the
6259 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6260 continue to try to deliver the message periodically until the address timed
6261 out.
6262 .code
6263 system_aliases:
6264   driver = redirect
6265   allow_fail
6266   allow_defer
6267   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6268 # user = exim
6269   file_transport = address_file
6270   pipe_transport = address_pipe
6271 .endd
6272 Control reaches this and subsequent routers only for addresses in the local
6273 domains. This router checks to see whether the local part is defined as an
6274 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6275 data that it looks up from that file. If no data is found for the local part,
6276 the value of the &%data%& option is empty, causing the address to be passed to
6277 the next router.
6278
6279 &_/etc/aliases_& is a conventional name for the system aliases file that is
6280 often used. That is why it is referenced by from the default configuration
6281 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6282 &_Local/Makefile_& before building Exim.
6283 .code
6284 userforward:
6285   driver = redirect
6286   check_local_user
6287 # local_part_suffix = +* : -*
6288 # local_part_suffix_optional
6289   file = $home/.forward
6290 # allow_filter
6291   no_verify
6292   no_expn
6293   check_ancestor
6294   file_transport = address_file
6295   pipe_transport = address_pipe
6296   reply_transport = address_reply
6297 .endd
6298 This is the most complicated router in the default configuration. It is another
6299 redirection router, but this time it is looking for forwarding data set up by
6300 individual users. The &%check_local_user%& setting specifies a check that the
6301 local part of the address is the login name of a local user. If it is not, the
6302 router is skipped. The two commented options that follow &%check_local_user%&,
6303 namely:
6304 .code
6305 # local_part_suffix = +* : -*
6306 # local_part_suffix_optional
6307 .endd
6308 .vindex "&$local_part_suffix$&"
6309 show how you can specify the recognition of local part suffixes. If the first
6310 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6311 by any sequence of characters, is removed from the local part and placed in the
6312 variable &$local_part_suffix$&. The second suffix option specifies that the
6313 presence of a suffix in the local part is optional. When a suffix is present,
6314 the check for a local login uses the local part with the suffix removed.
6315
6316 When a local user account is found, the file called &_.forward_& in the user's
6317 home directory is consulted. If it does not exist, or is empty, the router
6318 declines. Otherwise, the contents of &_.forward_& are interpreted as
6319 redirection data (see chapter &<<CHAPredirect>>& for more details).
6320
6321 .cindex "Sieve filter" "enabling in default router"
6322 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6323 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6324 is commented out by default), the contents of the file are interpreted as a set
6325 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6326 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6327 separate document entitled &'Exim's interfaces to mail filtering'&.
6328
6329 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6330 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6331 There are two reasons for doing this:
6332
6333 .olist
6334 Whether or not a local user has a &_.forward_& file is not really relevant when
6335 checking an address for validity; it makes sense not to waste resources doing
6336 unnecessary work.
6337 .next
6338 More importantly, when Exim is verifying addresses or handling an EXPN
6339 command during an SMTP session, it is running as the Exim user, not as root.
6340 The group is the Exim group, and no additional groups are set up.
6341 It may therefore not be possible for Exim to read users' &_.forward_& files at
6342 this time.
6343 .endlist
6344
6345 The setting of &%check_ancestor%& prevents the router from generating a new
6346 address that is the same as any previous address that was redirected. (This
6347 works round a problem concerning a bad interaction between aliasing and
6348 forwarding &-- see section &<<SECTredlocmai>>&).
6349
6350 The final three option settings specify the transports that are to be used when
6351 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6352 auto-reply, respectively. For example, if a &_.forward_& file contains
6353 .code
6354 a.nother@elsewhere.example, /home/spqr/archive
6355 .endd
6356 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6357 transport.
6358 .code
6359 localuser:
6360   driver = accept
6361   check_local_user
6362 # local_part_suffix = +* : -*
6363 # local_part_suffix_optional
6364   transport = local_delivery
6365 .endd
6366 The final router sets up delivery into local mailboxes, provided that the local
6367 part is the name of a local login, by accepting the address and assigning it to
6368 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6369 routers, so the address is bounced. The commented suffix settings fulfil the
6370 same purpose as they do for the &(userforward)& router.
6371
6372
6373 .section "Transport configuration" "SECID56"
6374 .cindex "default" "transports"
6375 .cindex "transports" "default"
6376 Transports define mechanisms for actually delivering messages. They operate
6377 only when referenced from routers, so the order in which they are defined does
6378 not matter. The transports section of the configuration starts with
6379 .code
6380 begin transports
6381 .endd
6382 Two remote transports and four local transports are defined.
6383 .code
6384 remote_smtp:
6385   driver = smtp
6386   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6387 .ifdef _HAVE_PRDR
6388   hosts_try_prdr = *
6389 .endif
6390 .endd
6391 This transport is used for delivering messages over SMTP connections.
6392 The list of remote hosts comes from the router.
6393 The &%message_size_limit%& usage is a hack to avoid sending on messages
6394 with over-long lines.
6395
6396 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6397 negotiated between client and server and not expected to cause problems
6398 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6399 use of the &%hosts_try_prdr%& configuration option.
6400
6401 The other remote transport is used when delivering to a specific smarthost
6402 with whom there must be some kind of existing relationship, instead of the
6403 usual federated system.
6404
6405 .code
6406 smarthost_smtp:
6407   driver = smtp
6408   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6409   multi_domain
6410   #
6411 .ifdef _HAVE_TLS
6412   # Comment out any of these which you have to, then file a Support
6413   # request with your smarthost provider to get things fixed:
6414   hosts_require_tls = *
6415   tls_verify_hosts = *
6416   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6417   # have to comment it out then this will at least log whether you succeed
6418   # or not:
6419   tls_try_verify_hosts = *
6420   #
6421   # The SNI name should match the name which we'll expect to verify;
6422   # many mail systems don't use SNI and this doesn't matter, but if it does,
6423   # we need to send a name which the remote site will recognize.
6424   # This _should_ be the name which the smarthost operators specified as
6425   # the hostname for sending your mail to.
6426   tls_sni = ROUTER_SMARTHOST
6427   #
6428 .ifdef _HAVE_OPENSSL
6429   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6430 .endif
6431 .ifdef _HAVE_GNUTLS
6432   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6433 .endif
6434 .endif
6435 .ifdef _HAVE_PRDR
6436   hosts_try_prdr = *
6437 .endif
6438 .endd
6439 After the same &%message_size_limit%& hack, we then specify that this Transport
6440 can handle messages to multiple domains in one run.  The assumption here is
6441 that you're routing all non-local mail to the same place and that place is
6442 happy to take all messages from you as quickly as possible.
6443 All other options depend upon built-in macros; if Exim was built without TLS support
6444 then no other options are defined.
6445 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6446 and versions using the &%tls_require_ciphers%& option, where the value to be
6447 used depends upon the library providing TLS.
6448 Beyond that, the options adopt the stance that you should have TLS support available
6449 from your smarthost on today's Internet, so we turn on requiring TLS for the
6450 mail to be delivered, and requiring that the certificate be valid, and match
6451 the expected hostname.  The &%tls_sni%& option can be used by service providers
6452 to select an appropriate certificate to present to you and here we re-use the
6453 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6454 You want to specify the hostname which you'll expect to validate for, and that
6455 should not be subject to insecure tampering via DNS results.
6456
6457 For the &%hosts_try_prdr%& option see the previous transport.
6458
6459 All other options are defaulted.
6460 .code
6461 local_delivery:
6462   driver = appendfile
6463   file = /var/mail/$local_part_data
6464   delivery_date_add
6465   envelope_to_add
6466   return_path_add
6467 # group = mail
6468 # mode = 0660
6469 .endd
6470 This &(appendfile)& transport is used for local delivery to user mailboxes in
6471 traditional BSD mailbox format.
6472
6473 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6474 as it is provided by a potential bad actor.
6475 Instead we use &$local_part_data$&,
6476 the result of looking up &$local_part$& in the user database
6477 (done by using &%check_local_user%& in the the router).
6478
6479 By default &(appendfile)& runs under the uid and gid of the
6480 local user, which requires the sticky bit to be set on the &_/var/mail_&
6481 directory. Some systems use the alternative approach of running mail deliveries
6482 under a particular group instead of using the sticky bit. The commented options
6483 show how this can be done.
6484
6485 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6486 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6487 similarly-named options above.
6488 .code
6489 address_pipe:
6490   driver = pipe
6491   return_output
6492 .endd
6493 This transport is used for handling deliveries to pipes that are generated by
6494 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6495 option specifies that any output on stdout or stderr generated by the pipe is to
6496 be returned to the sender.
6497 .code
6498 address_file:
6499   driver = appendfile
6500   delivery_date_add
6501   envelope_to_add
6502   return_path_add
6503 .endd
6504 This transport is used for handling deliveries to files that are generated by
6505 redirection. The name of the file is not specified in this instance of
6506 &(appendfile)&, because it comes from the &(redirect)& router.
6507 .code
6508 address_reply:
6509   driver = autoreply
6510 .endd
6511 This transport is used for handling automatic replies generated by users'
6512 filter files.
6513
6514
6515
6516 .section "Default retry rule" "SECID57"
6517 .cindex "retry" "default rule"
6518 .cindex "default" "retry rule"
6519 The retry section of the configuration file contains rules which affect the way
6520 Exim retries deliveries that cannot be completed at the first attempt. It is
6521 introduced by the line
6522 .code
6523 begin retry
6524 .endd
6525 In the default configuration, there is just one rule, which applies to all
6526 errors:
6527 .code
6528 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6529 .endd
6530 This causes any temporarily failing address to be retried every 15 minutes for
6531 2 hours, then at intervals starting at one hour and increasing by a factor of
6532 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6533 is not delivered after 4 days of temporary failure, it is bounced. The time is
6534 measured from first failure, not from the time the message was received.
6535
6536 If the retry section is removed from the configuration, or is empty (that is,
6537 if no retry rules are defined), Exim will not retry deliveries. This turns
6538 temporary errors into permanent errors.
6539
6540
6541 .section "Rewriting configuration" "SECID58"
6542 The rewriting section of the configuration, introduced by
6543 .code
6544 begin rewrite
6545 .endd
6546 contains rules for rewriting addresses in messages as they arrive. There are no
6547 rewriting rules in the default configuration file.
6548
6549
6550
6551 .section "Authenticators configuration" "SECTdefconfauth"
6552 .cindex "AUTH" "configuration"
6553 The authenticators section of the configuration, introduced by
6554 .code
6555 begin authenticators
6556 .endd
6557 defines mechanisms for the use of the SMTP AUTH command. The default
6558 configuration file contains two commented-out example authenticators
6559 which support plaintext username/password authentication using the
6560 standard PLAIN mechanism and the traditional but non-standard LOGIN
6561 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6562 to support most MUA software.
6563
6564 The example PLAIN authenticator looks like this:
6565 .code
6566 #PLAIN:
6567 #  driver                  = plaintext
6568 #  server_set_id           = $auth2
6569 #  server_prompts          = :
6570 #  server_condition        = Authentication is not yet configured
6571 #  server_advertise_condition = ${if def:tls_in_cipher }
6572 .endd
6573 And the example LOGIN authenticator looks like this:
6574 .code
6575 #LOGIN:
6576 #  driver                  = plaintext
6577 #  server_set_id           = $auth1
6578 #  server_prompts          = <| Username: | Password:
6579 #  server_condition        = Authentication is not yet configured
6580 #  server_advertise_condition = ${if def:tls_in_cipher }
6581 .endd
6582
6583 The &%server_set_id%& option makes Exim remember the authenticated username
6584 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6585 &%server_prompts%& option configures the &(plaintext)& authenticator so
6586 that it implements the details of the specific authentication mechanism,
6587 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6588 when Exim offers authentication to clients; in the examples, this is only
6589 when TLS or SSL has been started, so to enable the authenticators you also
6590 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6591
6592 The &%server_condition%& setting defines how to verify that the username and
6593 password are correct. In the examples it just produces an error message.
6594 To make the authenticators work, you can use a string expansion
6595 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6596
6597 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6598 usercode and password are in different positions.
6599 Chapter &<<CHAPplaintext>>& covers both.
6600
6601 .ecindex IIDconfiwal
6602
6603
6604
6605 . ////////////////////////////////////////////////////////////////////////////
6606 . ////////////////////////////////////////////////////////////////////////////
6607
6608 .chapter "Regular expressions" "CHAPregexp"
6609
6610 .cindex "regular expressions" "library"
6611 .cindex "PCRE"
6612 Exim supports the use of regular expressions in many of its options. It
6613 uses the PCRE regular expression library; this provides regular expression
6614 matching that is compatible with Perl 5. The syntax and semantics of
6615 regular expressions is discussed in
6616 online Perl manpages, in
6617 many Perl reference books, and also in
6618 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6619 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6620 . --- the http: URL here redirects to another page with the ISBN in the URL
6621 . --- where trying to use https: just redirects back to http:, so sticking
6622 . --- to the old URL for now.  2018-09-07.
6623
6624 The documentation for the syntax and semantics of the regular expressions that
6625 are supported by PCRE is included in the PCRE distribution, and no further
6626 description is included here. The PCRE functions are called from Exim using
6627 the default option settings (that is, with no PCRE options set), except that
6628 the PCRE_CASELESS option is set when the matching is required to be
6629 case-insensitive.
6630
6631 In most cases, when a regular expression is required in an Exim configuration,
6632 it has to start with a circumflex, in order to distinguish it from plain text
6633 or an &"ends with"& wildcard. In this example of a configuration setting, the
6634 second item in the colon-separated list is a regular expression.
6635 .code
6636 domains = a.b.c : ^\\d{3} : *.y.z : ...
6637 .endd
6638 The doubling of the backslash is required because of string expansion that
6639 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6640 of this issue, and a way of avoiding the need for doubling backslashes. The
6641 regular expression that is eventually used in this example contains just one
6642 backslash. The circumflex is included in the regular expression, and has the
6643 normal effect of &"anchoring"& it to the start of the string that is being
6644 matched.
6645
6646 There are, however, two cases where a circumflex is not required for the
6647 recognition of a regular expression: these are the &%match%& condition in a
6648 string expansion, and the &%matches%& condition in an Exim filter file. In
6649 these cases, the relevant string is always treated as a regular expression; if
6650 it does not start with a circumflex, the expression is not anchored, and can
6651 match anywhere in the subject string.
6652
6653 In all cases, if you want a regular expression to match at the end of a string,
6654 you must code the $ metacharacter to indicate this. For example:
6655 .code
6656 domains = ^\\d{3}\\.example
6657 .endd
6658 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6659 You need to use:
6660 .code
6661 domains = ^\\d{3}\\.example\$
6662 .endd
6663 if you want &'example'& to be the top-level domain. The backslash before the
6664 $ is needed because string expansion also interprets dollar characters.
6665
6666
6667
6668 . ////////////////////////////////////////////////////////////////////////////
6669 . ////////////////////////////////////////////////////////////////////////////
6670
6671 .chapter "File and database lookups" "CHAPfdlookup"
6672 .scindex IIDfidalo1 "file" "lookups"
6673 .scindex IIDfidalo2 "database" "lookups"
6674 .cindex "lookup" "description of"
6675 Exim can be configured to look up data in files or databases as it processes
6676 messages. Two different kinds of syntax are used:
6677
6678 .olist
6679 A string that is to be expanded may contain explicit lookup requests. These
6680 cause parts of the string to be replaced by data that is obtained from the
6681 lookup. Lookups of this type are conditional expansion items. Different results
6682 can be defined for the cases of lookup success and failure. See chapter
6683 &<<CHAPexpand>>&, where string expansions are described in detail.
6684 The key for the lookup is &*specified*& as part of the string expansion.
6685 .next
6686 Lists of domains, hosts, and email addresses can contain lookup requests as a
6687 way of avoiding excessively long linear lists. In this case, the data that is
6688 returned by the lookup is often (but not always) discarded; whether the lookup
6689 succeeds or fails is what really counts. These kinds of list are described in
6690 chapter &<<CHAPdomhosaddlists>>&.
6691 The key for the lookup is &*implicit*&,
6692 given by the context in which the list is expanded.
6693 .endlist
6694
6695 String expansions, lists, and lookups interact with each other in such a way
6696 that there is no order in which to describe any one of them that does not
6697 involve references to the others. Each of these three chapters makes more sense
6698 if you have read the other two first. If you are reading this for the first
6699 time, be aware that some of it will make a lot more sense after you have read
6700 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6701
6702 .section "Examples of different lookup syntax" "SECID60"
6703 It is easy to confuse the two different kinds of lookup, especially as the
6704 lists that may contain the second kind are always expanded before being
6705 processed as lists. Therefore, they may also contain lookups of the first kind.
6706 Be careful to distinguish between the following two examples:
6707 .code
6708 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6709 domains = lsearch;/some/file
6710 .endd
6711 The first uses a string expansion, the result of which must be a domain list.
6712 No strings have been specified for a successful or a failing lookup; the
6713 defaults in this case are the looked-up data and an empty string, respectively.
6714 The expansion takes place before the string is processed as a list, and the
6715 file that is searched could contain lines like this:
6716 .code
6717 192.168.3.4: domain1:domain2:...
6718 192.168.1.9: domain3:domain4:...
6719 .endd
6720 When the lookup succeeds, the result of the expansion is a list of domains (and
6721 possibly other types of item that are allowed in domain lists).
6722 .cindex "tainted data" "de-tainting"
6723 The result of the expansion is not tainted.
6724
6725 In the second example, the lookup is a single item in a domain list. It causes
6726 Exim to use a lookup to see if the domain that is being processed can be found
6727 in the file.
6728 The file could contains lines like this:
6729 .code
6730 domain1:
6731 domain2:
6732 .endd
6733 Any data that follows the keys is not relevant when checking that the domain
6734 matches the list item.
6735
6736 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6737 Consider a file containing lines like this:
6738 .code
6739 192.168.5.6: lsearch;/another/file
6740 .endd
6741 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6742 first &%domains%& setting above generates the second setting, which therefore
6743 causes a second lookup to occur.
6744
6745 .new
6746 The lookup type may optionally be followed by a comma
6747 and a comma-separated list of options.
6748 Each option is a &"name=value"& pair.
6749 Whether an option is meaningful depends on the lookup type.
6750
6751 All lookups support the option &"cache=no_rd"&.
6752 If this is given then the cache that Exim manages for lookup results
6753 is not checked before doing the lookup.
6754 The result of the lookup is still written to the cache.
6755 .wen
6756
6757 The rest of this chapter describes the different lookup types that are
6758 available. Any of them can be used in any part of the configuration where a
6759 lookup is permitted.
6760
6761
6762 .section "Lookup types" "SECID61"
6763 .cindex "lookup" "types of"
6764 .cindex "single-key lookup" "definition of"
6765 Two different types of data lookup are implemented:
6766
6767 .ilist
6768 The &'single-key'& type requires the specification of a file in which to look,
6769 and a single key to search for. The key must be a non-empty string for the
6770 lookup to succeed. The lookup type determines how the file is searched.
6771 .cindex "tainted data" "single-key lookups"
6772 The file string may not be tainted
6773
6774 .cindex "tainted data" "de-tainting"
6775 All single-key lookups support the option &"ret=key"&.
6776 If this is given and the lookup
6777 (either underlying implementation or cached value)
6778 returns data, the result is replaced with a non-tainted
6779 version of the lookup key.
6780 .cindex "tainted data" "de-tainting"
6781 .next
6782 .cindex "query-style lookup" "definition of"
6783 The &'query-style'& type accepts a generalized database query. No particular
6784 key value is assumed by Exim for query-style lookups. You can use whichever
6785 Exim variables you need to construct the database query.
6786 .endlist
6787
6788 The code for each lookup type is in a separate source file that is included in
6789 the binary of Exim only if the corresponding compile-time option is set. The
6790 default settings in &_src/EDITME_& are:
6791 .code
6792 LOOKUP_DBM=yes
6793 LOOKUP_LSEARCH=yes
6794 .endd
6795 which means that only linear searching and DBM lookups are included by default.
6796 For some types of lookup (e.g. SQL databases), you need to install appropriate
6797 libraries and header files before building Exim.
6798
6799
6800
6801
6802 .section "Single-key lookup types" "SECTsinglekeylookups"
6803 .cindex "lookup" "single-key types"
6804 .cindex "single-key lookup" "list of types"
6805 The following single-key lookup types are implemented:
6806
6807 .ilist
6808 .cindex "cdb" "description of"
6809 .cindex "lookup" "cdb"
6810 .cindex "binary zero" "in lookup key"
6811 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6812 string without a terminating binary zero. The cdb format is designed for
6813 indexed files that are read frequently and never updated, except by total
6814 re-creation. As such, it is particularly suitable for large files containing
6815 aliases or other indexed data referenced by an MTA. Information about cdb and
6816 tools for building the files can be found in several places:
6817 .display
6818 &url(https://cr.yp.to/cdb.html)
6819 &url(https://www.corpit.ru/mjt/tinycdb.html)
6820 &url(https://packages.debian.org/stable/utils/freecdb)
6821 &url(https://github.com/philpennock/cdbtools) (in Go)
6822 .endd
6823 A cdb distribution is not needed in order to build Exim with cdb support,
6824 because the code for reading cdb files is included directly in Exim itself.
6825 However, no means of building or testing cdb files is provided with Exim, so
6826 you need to obtain a cdb distribution in order to do this.
6827 .next
6828 .cindex "DBM" "lookup type"
6829 .cindex "lookup" "dbm"
6830 .cindex "binary zero" "in lookup key"
6831 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6832 DBM file by looking up the record with the given key. A terminating binary
6833 zero is included in the key that is passed to the DBM library. See section
6834 &<<SECTdb>>& for a discussion of DBM libraries.
6835
6836 .cindex "Berkeley DB library" "file format"
6837 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6838 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6839 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6840 the DB_UNKNOWN option. This enables it to handle any of the types of database
6841 that the library supports, and can be useful for accessing DBM files created by
6842 other applications. (For earlier DB versions, DB_HASH is always used.)
6843 .next
6844 .cindex "lookup" "dbmjz"
6845 .cindex "lookup" "dbm &-- embedded NULs"
6846 .cindex "sasldb2"
6847 .cindex "dbmjz lookup type"
6848 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6849 interpreted as an Exim list; the elements of the list are joined together with
6850 ASCII NUL characters to form the lookup key.  An example usage would be to
6851 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6852 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6853 &(cram_md5)& authenticator.
6854 .next
6855 .cindex "lookup" "dbmnz"
6856 .cindex "lookup" "dbm &-- terminating zero"
6857 .cindex "binary zero" "in lookup key"
6858 .cindex "Courier"
6859 .cindex "&_/etc/userdbshadow.dat_&"
6860 .cindex "dbmnz lookup type"
6861 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6862 is not included in the key that is passed to the DBM library. You may need this
6863 if you want to look up data in files that are created by or shared with some
6864 other application that does not use terminating zeros. For example, you need to
6865 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6866 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6867 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6868 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6869 .next
6870 .cindex "lookup" "dsearch"
6871 .cindex "dsearch lookup type"
6872 &(dsearch)&: The given file must be an
6873 absolute
6874 directory path; this is searched for an entry
6875 whose name is the key by calling the &[lstat()]& function.
6876 The key may not
6877 contain any forward slash characters.
6878 If &[lstat()]& succeeds then so does the lookup.
6879 .cindex "tainted data" "dsearch result"
6880 The result is regarded as untainted.
6881
6882 Options for the lookup can be given by appending them after the word "dsearch",
6883 separated by a comma.  Options, if present, are a comma-separated list having
6884 each element starting with a tag name and an equals.
6885
6886 Two options are supported, for the return value and for filtering match
6887 candidates.
6888 The "ret" option requests an alternate result value of
6889 the entire path for the entry. Example:
6890 .code
6891 ${lookup {passwd} dsearch,ret=full {/etc}}
6892 .endd
6893 The default result is just the requested entry.
6894 The "filter" option requests that only directory entries of a given type
6895 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6896 not matching "." or ".."). Example:
6897 .code
6898 ${lookup {passwd} dsearch,filter=file {/etc}}
6899 .endd
6900 The default matching is for any entry type, including directories
6901 and symlinks.
6902
6903 An example of how this
6904 lookup can be used to support virtual domains is given in section
6905 &<<SECTvirtualdomains>>&.
6906 .next
6907 .cindex "lookup" "iplsearch"
6908 .cindex "iplsearch lookup type"
6909 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6910 terminated by a colon or white space or the end of the line. The keys in the
6911 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6912 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6913 being interpreted as a key terminator. For example:
6914 .code
6915 1.2.3.4:           data for 1.2.3.4
6916 192.168.0.0/16:    data for 192.168.0.0/16
6917 "abcd::cdab":      data for abcd::cdab
6918 "abcd:abcd::/32"   data for abcd:abcd::/32
6919 .endd
6920 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6921 file is searched linearly, using the CIDR masks where present, until a matching
6922 key is found. The first key that matches is used; there is no attempt to find a
6923 &"best"& match. Apart from the way the keys are matched, the processing for
6924 &(iplsearch)& is the same as for &(lsearch)&.
6925
6926 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6927 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6928 lookup types support only literal keys.
6929
6930 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6931 the implicit key is the host's IP address rather than its name (see section
6932 &<<SECThoslispatsikey>>&).
6933
6934 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6935 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6936 notation before executing the lookup.)
6937
6938 .new
6939 One option is supported, "ret=full", to request the return of the entire line
6940 rather than omitting the key porttion.
6941 Note however that the key portion will have been de-quoted.
6942 .wen
6943
6944 .next
6945 .cindex lookup json
6946 .cindex json "lookup type"
6947 .cindex JSON expansions
6948 &(json)&: The given file is a text file with a JSON structure.
6949 An element of the structure is extracted, defined by the search key.
6950 The key is a list of subelement selectors
6951 (colon-separated by default but changeable in the usual way)
6952 which are applied in turn to select smaller and smaller portions
6953 of the JSON structure.
6954 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6955 nunbered array element is selected.
6956 Otherwise it must apply to a JSON object; the named element is selected.
6957 The final resulting element can be a simple JSON type or a JSON object
6958 or array; for the latter two a string-representation of the JSON
6959 is returned.
6960 For elements of type string, the returned value is de-quoted.
6961
6962
6963 .new
6964 .next
6965 .cindex LMDB
6966 .cindex lookup lmdb
6967 .cindex database lmdb
6968 &(lmdb)&: The given file is an LMDB database.
6969 LMDB is a memory-mapped key-value store,
6970 with API modeled loosely on that of BerkeleyDB.
6971 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6972 for the feature set and operation modes.
6973
6974 Exim provides read-only access via the LMDB C library.
6975 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6976 or your operating system package repository.
6977 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6978
6979 You will need to separately create the LMDB database file,
6980 possibly using the &"mdb_load"& utility.
6981 .wen
6982
6983
6984 .next
6985 .cindex "linear search"
6986 .cindex "lookup" "lsearch"
6987 .cindex "lsearch lookup type"
6988 .cindex "case sensitivity" "in lsearch lookup"
6989 &(lsearch)&: The given file is a text file that is searched linearly for a
6990 line beginning with the search key, terminated by a colon or white space or the
6991 end of the line. The search is case-insensitive; that is, upper and lower case
6992 letters are treated as the same. The first occurrence of the key that is found
6993 in the file is used.
6994
6995 White space between the key and the colon is permitted. The remainder of the
6996 line, with leading and trailing white space removed, is the data. This can be
6997 continued onto subsequent lines by starting them with any amount of white
6998 space, but only a single space character is included in the data at such a
6999 junction. If the data begins with a colon, the key must be terminated by a
7000 colon, for example:
7001 .code
7002 baduser:  :fail:
7003 .endd
7004 Empty lines and lines beginning with # are ignored, even if they occur in the
7005 middle of an item. This is the traditional textual format of alias files. Note
7006 that the keys in an &(lsearch)& file are literal strings. There is no
7007 wildcarding of any kind.
7008
7009 .cindex "lookup" "lsearch &-- colons in keys"
7010 .cindex "white space" "in lsearch key"
7011 In most &(lsearch)& files, keys are not required to contain colons or #
7012 characters, or white space. However, if you need this feature, it is available.
7013 If a key begins with a doublequote character, it is terminated only by a
7014 matching quote (or end of line), and the normal escaping rules apply to its
7015 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
7016 quoted keys (exactly as for unquoted keys). There is no special handling of
7017 quotes for the data part of an &(lsearch)& line.
7018
7019 .next
7020 .cindex "NIS lookup type"
7021 .cindex "lookup" "NIS"
7022 .cindex "binary zero" "in lookup key"
7023 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
7024 the given key, without a terminating binary zero. There is a variant called
7025 &(nis0)& which does include the terminating binary zero in the key. This is
7026 reportedly needed for Sun-style alias files. Exim does not recognize NIS
7027 aliases; the full map names must be used.
7028
7029 .next
7030 .cindex "wildlsearch lookup type"
7031 .cindex "lookup" "wildlsearch"
7032 .cindex "nwildlsearch lookup type"
7033 .cindex "lookup" "nwildlsearch"
7034 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
7035 &(lsearch)&, but instead of being interpreted as a literal string, each key in
7036 the file may be wildcarded. The difference between these two lookup types is
7037 that for &(wildlsearch)&, each key in the file is string-expanded before being
7038 used, whereas for &(nwildlsearch)&, no expansion takes place.
7039
7040 .cindex "case sensitivity" "in (n)wildlsearch lookup"
7041 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
7042 file that are regular expressions can be made case-sensitive by the use of
7043 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
7044
7045 . ==== As this is a nested list, any displays it contains must be indented
7046 . ==== as otherwise they are too far to the left.
7047
7048 .olist
7049 The string may begin with an asterisk to mean &"ends with"&. For example:
7050 .code
7051     *.a.b.c       data for anything.a.b.c
7052     *fish         data for anythingfish
7053 .endd
7054 .next
7055 The string may begin with a circumflex to indicate a regular expression. For
7056 example, for &(wildlsearch)&:
7057 .code
7058     ^\N\d+\.a\.b\N    data for <digits>.a.b
7059 .endd
7060 Note the use of &`\N`& to disable expansion of the contents of the regular
7061 expression. If you are using &(nwildlsearch)&, where the keys are not
7062 string-expanded, the equivalent entry is:
7063 .code
7064     ^\d+\.a\.b        data for <digits>.a.b
7065 .endd
7066 The case-insensitive flag is set at the start of compiling the regular
7067 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7068 For example, to make the entire pattern case-sensitive:
7069 .code
7070     ^(?-i)\d+\.a\.b        data for <digits>.a.b
7071 .endd
7072
7073 If the regular expression contains white space or colon characters, you must
7074 either quote it (see &(lsearch)& above), or represent these characters in other
7075 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7076 colon. This may be easier than quoting, because if you quote, you have to
7077 escape all the backslashes inside the quotes.
7078
7079 &*Note*&: It is not possible to capture substrings in a regular expression
7080 match for later use, because the results of all lookups are cached. If a lookup
7081 is repeated, the result is taken from the cache, and no actual pattern matching
7082 takes place. The values of all the numeric variables are unset after a
7083 &((n)wildlsearch)& match.
7084
7085 .next
7086 Although I cannot see it being of much use, the general matching function that
7087 is used to implement &((n)wildlsearch)& means that the string may begin with a
7088 lookup name terminated by a semicolon, and followed by lookup data. For
7089 example:
7090 .code
7091     cdb;/some/file  data for keys that match the file
7092 .endd
7093 The data that is obtained from the nested lookup is discarded.
7094 .endlist olist
7095
7096 Keys that do not match any of these patterns are interpreted literally. The
7097 continuation rules for the data are the same as for &(lsearch)&, and keys may
7098 be followed by optional colons.
7099
7100 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7101 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7102 lookup types support only literal keys.
7103
7104 .next
7105 .cindex "spf lookup type"
7106 .cindex "lookup" "spf"
7107 &(spf)&: If Exim is built with SPF support, manual lookups can be done
7108 (as opposed to the standard ACL condition method).
7109 For details see section &<<SECSPF>>&.
7110 .endlist ilist
7111
7112
7113 .section "Query-style lookup types" "SECTquerystylelookups"
7114 .cindex "lookup" "query-style types"
7115 .cindex "query-style lookup" "list of types"
7116 The supported query-style lookup types are listed below. Further details about
7117 many of them are given in later sections.
7118
7119 .ilist
7120 .cindex "DNS" "as a lookup type"
7121 .cindex "lookup" "DNS"
7122 &(dnsdb)&: This does a DNS search for one or more records whose domain names
7123 are given in the supplied query. The resulting data is the contents of the
7124 records. See section &<<SECTdnsdb>>&.
7125 .next
7126 .cindex "InterBase lookup type"
7127 .cindex "lookup" "InterBase"
7128 &(ibase)&: This does a lookup in an InterBase database.
7129 .next
7130 .cindex "LDAP" "lookup type"
7131 .cindex "lookup" "LDAP"
7132 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7133 returns attributes from a single entry. There is a variant called &(ldapm)&
7134 that permits values from multiple entries to be returned. A third variant
7135 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7136 any attribute values. See section &<<SECTldap>>&.
7137 .next
7138 .cindex "MySQL" "lookup type"
7139 .cindex "lookup" "MySQL"
7140 &(mysql)&: The format of the query is an SQL statement that is passed to a
7141 MySQL database. See section &<<SECTsql>>&.
7142 .next
7143 .cindex "NIS+ lookup type"
7144 .cindex "lookup" "NIS+"
7145 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7146 the field to be returned. See section &<<SECTnisplus>>&.
7147 .next
7148 .cindex "Oracle" "lookup type"
7149 .cindex "lookup" "Oracle"
7150 &(oracle)&: The format of the query is an SQL statement that is passed to an
7151 Oracle database. See section &<<SECTsql>>&.
7152 .next
7153 .cindex "lookup" "passwd"
7154 .cindex "passwd lookup type"
7155 .cindex "&_/etc/passwd_&"
7156 &(passwd)& is a query-style lookup with queries that are just user names. The
7157 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7158 success, the result string is the same as you would get from an &(lsearch)&
7159 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7160 password value. For example:
7161 .code
7162 *:42:42:King Rat:/home/kr:/bin/bash
7163 .endd
7164 .next
7165 .cindex "PostgreSQL lookup type"
7166 .cindex "lookup" "PostgreSQL"
7167 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7168 PostgreSQL database. See section &<<SECTsql>>&.
7169
7170 .next
7171 .cindex "Redis lookup type"
7172 .cindex lookup Redis
7173 &(redis)&: The format of the query is either a simple get or simple set,
7174 passed to a Redis database. See section &<<SECTsql>>&.
7175
7176 .next
7177 .cindex "sqlite lookup type"
7178 .cindex "lookup" "sqlite"
7179 &(sqlite)&: The format of the query is
7180 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7181
7182 .next
7183 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7184 not likely to be useful in normal operation.
7185 .next
7186 .cindex "whoson lookup type"
7187 .cindex "lookup" "whoson"
7188 . --- still http:-only, 2018-09-07
7189 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7190 allows a server to check whether a particular (dynamically allocated) IP
7191 address is currently allocated to a known (trusted) user and, optionally, to
7192 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7193 at one time for &"POP before SMTP"& authentication, but that approach has been
7194 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7195 &"POP before SMTP"& checking using ACL statements such as
7196 .code
7197 require condition = \
7198   ${lookup whoson {$sender_host_address}{yes}{no}}
7199 .endd
7200 The query consists of a single IP address. The value returned is the name of
7201 the authenticated user, which is stored in the variable &$value$&. However, in
7202 this example, the data in &$value$& is not used; the result of the lookup is
7203 one of the fixed strings &"yes"& or &"no"&.
7204 .endlist
7205
7206
7207
7208 .section "Temporary errors in lookups" "SECID63"
7209 .cindex "lookup" "temporary error in"
7210 Lookup functions can return temporary error codes if the lookup cannot be
7211 completed. For example, an SQL or LDAP database might be unavailable. For this
7212 reason, it is not advisable to use a lookup that might do this for critical
7213 options such as a list of local domains.
7214
7215 When a lookup cannot be completed in a router or transport, delivery
7216 of the message (to the relevant address) is deferred, as for any other
7217 temporary error. In other circumstances Exim may assume the lookup has failed,
7218 or may give up altogether.
7219
7220
7221
7222 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7223 .cindex "wildcard lookups"
7224 .cindex "lookup" "default values"
7225 .cindex "lookup" "wildcard"
7226 .cindex "lookup" "* added to type"
7227 .cindex "default" "in single-key lookups"
7228 In this context, a &"default value"& is a value specified by the administrator
7229 that is to be used if a lookup fails.
7230
7231 &*Note:*& This section applies only to single-key lookups. For query-style
7232 lookups, the facilities of the query language must be used. An attempt to
7233 specify a default for a query-style lookup provokes an error.
7234
7235 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7236 and the initial lookup fails, the key &"*"& is looked up in the file to
7237 provide a default value. See also the section on partial matching below.
7238
7239 .cindex "*@ with single-key lookup"
7240 .cindex "lookup" "*@ added to type"
7241 .cindex "alias file" "per-domain default"
7242 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7243 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7244 character, a second lookup is done with everything before the last @ replaced
7245 by *. This makes it possible to provide per-domain defaults in alias files
7246 that include the domains in the keys. If the second lookup fails (or doesn't
7247 take place because there is no @ in the key), &"*"& is looked up.
7248 For example, a &(redirect)& router might contain:
7249 .code
7250 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7251 .endd
7252 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7253 looks up these keys, in this order:
7254 .code
7255 jane@eyre.example
7256 *@eyre.example
7257 *
7258 .endd
7259 The data is taken from whichever key it finds first. &*Note*&: In an
7260 &(lsearch)& file, this does not mean the first of these keys in the file. A
7261 complete scan is done for each key, and only if it is not found at all does
7262 Exim move on to try the next key.
7263
7264
7265
7266 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7267 .cindex "partial matching"
7268 .cindex "wildcard lookups"
7269 .cindex "lookup" "partial matching"
7270 .cindex "lookup" "wildcard"
7271 .cindex "asterisk" "in search type"
7272 The normal operation of a single-key lookup is to search the file for an exact
7273 match with the given key. However, in a number of situations where domains are
7274 being looked up, it is useful to be able to do partial matching. In this case,
7275 information in the file that has a key starting with &"*."& is matched by any
7276 domain that ends with the components that follow the full stop. For example, if
7277 a key in a DBM file is
7278 .code
7279 *.dates.fict.example
7280 .endd
7281 then when partial matching is enabled this is matched by (amongst others)
7282 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7283 by &'dates.fict.example'&, if that does not appear as a separate key in the
7284 file.
7285
7286 &*Note*&: Partial matching is not available for query-style lookups. It is
7287 also not available for any lookup items in address lists (see section
7288 &<<SECTaddresslist>>&).
7289
7290 Partial matching is implemented by doing a series of separate lookups using
7291 keys constructed by modifying the original subject key. This means that it can
7292 be used with any of the single-key lookup types, provided that
7293 partial matching keys
7294 beginning with a special prefix (default &"*."&) are included in the data file.
7295 Keys in the file that do not begin with the prefix are matched only by
7296 unmodified subject keys when partial matching is in use.
7297
7298 Partial matching is requested by adding the string &"partial-"& to the front of
7299 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7300 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7301 is added at the start of the subject key, and it is looked up again. If that
7302 fails, further lookups are tried with dot-separated components removed from the
7303 start of the subject key, one-by-one, and &"*."& added on the front of what
7304 remains.
7305
7306 A minimum number of two non-* components are required. This can be adjusted
7307 by including a number before the hyphen in the search type. For example,
7308 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7309 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7310 subject key is &'2250.dates.fict.example'& then the following keys are looked
7311 up when the minimum number of non-* components is two:
7312 .code
7313 2250.dates.fict.example
7314 *.2250.dates.fict.example
7315 *.dates.fict.example
7316 *.fict.example
7317 .endd
7318 As soon as one key in the sequence is successfully looked up, the lookup
7319 finishes.
7320
7321 .cindex "lookup" "partial matching &-- changing prefix"
7322 .cindex "prefix" "for partial matching"
7323 The use of &"*."& as the partial matching prefix is a default that can be
7324 changed. The motivation for this feature is to allow Exim to operate with file
7325 formats that are used by other MTAs. A different prefix can be supplied in
7326 parentheses instead of the hyphen after &"partial"&. For example:
7327 .code
7328 domains = partial(.)lsearch;/some/file
7329 .endd
7330 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7331 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7332 components is unchanged). The prefix may consist of any punctuation characters
7333 other than a closing parenthesis. It may be empty, for example:
7334 .code
7335 domains = partial1()cdb;/some/file
7336 .endd
7337 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7338 &`a.b.c`&, &`b.c`&, and &`c`&.
7339
7340 If &"partial0"& is specified, what happens at the end (when the lookup with
7341 just one non-wild component has failed, and the original key is shortened right
7342 down to the null string) depends on the prefix:
7343
7344 .ilist
7345 If the prefix has zero length, the whole lookup fails.
7346 .next
7347 If the prefix has length 1, a lookup for just the prefix is done. For
7348 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7349 .next
7350 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7351 remainder is looked up. With the default prefix, therefore, the final lookup is
7352 for &"*"& on its own.
7353 .next
7354 Otherwise, the whole prefix is looked up.
7355 .endlist
7356
7357
7358 If the search type ends in &"*"& or &"*@"& (see section
7359 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7360 this implies happens after all partial lookups have failed. If &"partial0"& is
7361 specified, adding &"*"& to the search type has no effect with the default
7362 prefix, because the &"*"& key is already included in the sequence of partial
7363 lookups. However, there might be a use for lookup types such as
7364 &"partial0(.)lsearch*"&.
7365
7366 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7367 in domain lists and the like. Partial matching works only in terms of
7368 dot-separated components; a key such as &`*fict.example`&
7369 in a database file is useless, because the asterisk in a partial matching
7370 subject key is always followed by a dot.
7371
7372
7373
7374
7375 .section "Lookup caching" "SECID64"
7376 .cindex "lookup" "caching"
7377 .cindex "caching" "lookup data"
7378 Exim caches all lookup results in order to avoid needless repetition of
7379 lookups. However, because (apart from the daemon) Exim operates as a collection
7380 of independent, short-lived processes, this caching applies only within a
7381 single Exim process. There is no inter-process lookup caching facility.
7382
7383 For single-key lookups, Exim keeps the relevant files open in case there is
7384 another lookup that needs them. In some types of configuration this can lead to
7385 many files being kept open for messages with many recipients. To avoid hitting
7386 the operating system limit on the number of simultaneously open files, Exim
7387 closes the least recently used file when it needs to open more files than its
7388 own internal limit, which can be changed via the &%lookup_open_max%& option.
7389
7390 The single-key lookup files are closed and the lookup caches are flushed at
7391 strategic points during delivery &-- for example, after all routing is
7392 complete.
7393
7394
7395
7396
7397 .section "Quoting lookup data" "SECID65"
7398 .cindex "lookup" "quoting"
7399 .cindex "quoting" "in lookups"
7400 When data from an incoming message is included in a query-style lookup, there
7401 is the possibility of special characters in the data messing up the syntax of
7402 the query. For example, a NIS+ query that contains
7403 .code
7404 [name=$local_part]
7405 .endd
7406 will be broken if the local part happens to contain a closing square bracket.
7407 For NIS+, data can be enclosed in double quotes like this:
7408 .code
7409 [name="$local_part"]
7410 .endd
7411 but this still leaves the problem of a double quote in the data. The rule for
7412 NIS+ is that double quotes must be doubled. Other lookup types have different
7413 rules, and to cope with the differing requirements, an expansion operator
7414 of the following form is provided:
7415 .code
7416 ${quote_<lookup-type>:<string>}
7417 .endd
7418 For example, the safest way to write the NIS+ query is
7419 .code
7420 [name="${quote_nisplus:$local_part}"]
7421 .endd
7422 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7423 operator can be used for all lookup types, but has no effect for single-key
7424 lookups, since no quoting is ever needed in their key strings.
7425
7426
7427
7428
7429 .section "More about dnsdb" "SECTdnsdb"
7430 .cindex "dnsdb lookup"
7431 .cindex "lookup" "dnsdb"
7432 .cindex "DNS" "as a lookup type"
7433 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7434 of a record type and a domain name, separated by an equals sign. For example,
7435 an expansion string could contain:
7436 .code
7437 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7438 .endd
7439 If the lookup succeeds, the result is placed in &$value$&, which in this case
7440 is used on its own as the result. If the lookup does not succeed, the
7441 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7442 &<<SECTforexpfai>>& for an explanation of what this means.
7443
7444 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7445 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7446 If no type is given, TXT is assumed.
7447
7448 For any record type, if multiple records are found, the data is returned as a
7449 concatenation, with newline as the default separator. The order, of course,
7450 depends on the DNS resolver. You can specify a different separator character
7451 between multiple records by putting a right angle-bracket followed immediately
7452 by the new separator at the start of the query. For example:
7453 .code
7454 ${lookup dnsdb{>: a=host1.example}}
7455 .endd
7456 It is permitted to specify a space as the separator character. Further
7457 white space is ignored.
7458 For lookup types that return multiple fields per record,
7459 an alternate field separator can be specified using a comma after the main
7460 separator character, followed immediately by the field separator.
7461
7462 .cindex "PTR record" "in &(dnsdb)& lookup"
7463 When the type is PTR,
7464 the data can be an IP address, written as normal; inversion and the addition of
7465 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7466 .code
7467 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7468 .endd
7469 If the data for a PTR record is not a syntactically valid IP address, it is not
7470 altered and nothing is added.
7471
7472 .cindex "MX record" "in &(dnsdb)& lookup"
7473 .cindex "SRV record" "in &(dnsdb)& lookup"
7474 For an MX lookup, both the preference value and the host name are returned for
7475 each record, separated by a space. For an SRV lookup, the priority, weight,
7476 port, and host name are returned for each record, separated by spaces.
7477 The field separator can be modified as above.
7478
7479 .cindex "TXT record" "in &(dnsdb)& lookup"
7480 .cindex "SPF record" "in &(dnsdb)& lookup"
7481 For TXT records with multiple items of data, only the first item is returned,
7482 unless a field separator is specified.
7483 To concatenate items without a separator, use a semicolon instead.
7484 For SPF records the
7485 default behaviour is to concatenate multiple items without using a separator.
7486 .code
7487 ${lookup dnsdb{>\n,: txt=a.b.example}}
7488 ${lookup dnsdb{>\n; txt=a.b.example}}
7489 ${lookup dnsdb{spf=example.org}}
7490 .endd
7491 It is permitted to specify a space as the separator character. Further
7492 white space is ignored.
7493
7494 .cindex "SOA record" "in &(dnsdb)& lookup"
7495 For an SOA lookup, while no result is obtained the lookup is redone with
7496 successively more leading components dropped from the given domain.
7497 Only the primary-nameserver field is returned unless a field separator is
7498 specified.
7499 .code
7500 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7501 .endd
7502
7503 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7504 .cindex "dnsdb modifiers"
7505 .cindex "modifiers" "dnsdb"
7506 .cindex "options" "dnsdb"
7507 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7508 each followed by a comma,
7509 that may appear before the record type.
7510
7511 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7512 temporary DNS error for any of them, the behaviour is controlled by
7513 a defer-option modifier.
7514 The possible keywords are
7515 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7516 With &"strict"& behaviour, any temporary DNS error causes the
7517 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7518 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7519 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7520 error causes the whole lookup to defer only if none of the other lookups
7521 succeed. The default is &"lax"&, so the following lookups are equivalent:
7522 .code
7523 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7524 ${lookup dnsdb{a=one.host.com:two.host.com}}
7525 .endd
7526 Thus, in the default case, as long as at least one of the DNS lookups
7527 yields some data, the lookup succeeds.
7528
7529 .cindex "DNSSEC" "dns lookup"
7530 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7531 The possible keywords are
7532 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7533 With &"strict"& or &"lax"& DNSSEC information is requested
7534 with the lookup.
7535 With &"strict"& a response from the DNS resolver that
7536 is not labelled as authenticated data
7537 is treated as equivalent to a temporary DNS error.
7538 The default is &"lax"&.
7539
7540 See also the &$lookup_dnssec_authenticated$& variable.
7541
7542 .cindex timeout "dns lookup"
7543 .cindex "DNS" timeout
7544 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7545 The form is &"retrans_VAL"& where VAL is an Exim time specification
7546 (e.g. &"5s"&).
7547 The default value is set by the main configuration option &%dns_retrans%&.
7548
7549 Retries for the dnsdb lookup can be controlled by a retry modifier.
7550 The form if &"retry_VAL"& where VAL is an integer.
7551 The default count is set by the main configuration option &%dns_retry%&.
7552
7553 .cindex caching "of dns lookup"
7554 .cindex TTL "of dns lookup"
7555 .cindex DNS TTL
7556 Dnsdb lookup results are cached within a single process (and its children).
7557 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7558 value of the set of returned DNS records.
7559
7560
7561 .section "Pseudo dnsdb record types" "SECID66"
7562 .cindex "MX record" "in &(dnsdb)& lookup"
7563 By default, both the preference value and the host name are returned for
7564 each MX record, separated by a space. If you want only host names, you can use
7565 the pseudo-type MXH:
7566 .code
7567 ${lookup dnsdb{mxh=a.b.example}}
7568 .endd
7569 In this case, the preference values are omitted, and just the host names are
7570 returned.
7571
7572 .cindex "name server for enclosing domain"
7573 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7574 records on the given domain, but if none are found, it removes the first
7575 component of the domain name, and tries again. This process continues until NS
7576 records are found or there are no more components left (or there is a DNS
7577 error). In other words, it may return the name servers for a top-level domain,
7578 but it never returns the root name servers. If there are no NS records for the
7579 top-level domain, the lookup fails. Consider these examples:
7580 .code
7581 ${lookup dnsdb{zns=xxx.quercite.com}}
7582 ${lookup dnsdb{zns=xxx.edu}}
7583 .endd
7584 Assuming that in each case there are no NS records for the full domain name,
7585 the first returns the name servers for &%quercite.com%&, and the second returns
7586 the name servers for &%edu%&.
7587
7588 You should be careful about how you use this lookup because, unless the
7589 top-level domain does not exist, the lookup always returns some host names. The
7590 sort of use to which this might be put is for seeing if the name servers for a
7591 given domain are on a blacklist. You can probably assume that the name servers
7592 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7593 such a list.
7594
7595 .cindex "CSA" "in &(dnsdb)& lookup"
7596 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7597 records according to the CSA rules, which are described in section
7598 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7599 not sufficient because of the extra parent domain search behaviour of CSA. The
7600 result of a successful lookup such as:
7601 .code
7602 ${lookup dnsdb {csa=$sender_helo_name}}
7603 .endd
7604 has two space-separated fields: an authorization code and a target host name.
7605 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7606 authorization required but absent, or &"?"& for unknown.
7607
7608 .cindex "A+" "in &(dnsdb)& lookup"
7609 The pseudo-type A+ performs an AAAA
7610 and then an A lookup.  All results are returned; defer processing
7611 (see below) is handled separately for each lookup.  Example:
7612 .code
7613 ${lookup dnsdb {>; a+=$sender_helo_name}}
7614 .endd
7615
7616
7617 .section "Multiple dnsdb lookups" "SECID67"
7618 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7619 However, you can specify a list of domains or IP addresses in a single
7620 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7621 the default separator, but with the ability to change this. For example:
7622 .code
7623 ${lookup dnsdb{one.domain.com:two.domain.com}}
7624 ${lookup dnsdb{a=one.host.com:two.host.com}}
7625 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7626 .endd
7627 In order to retain backwards compatibility, there is one special case: if
7628 the lookup type is PTR and no change of separator is specified, Exim looks
7629 to see if the rest of the string is precisely one IPv6 address. In this
7630 case, it does not treat it as a list.
7631
7632 The data from each lookup is concatenated, with newline separators by default,
7633 in the same way that multiple DNS records for a single item are handled. A
7634 different separator can be specified, as described above.
7635
7636
7637
7638
7639 .section "More about LDAP" "SECTldap"
7640 .cindex "LDAP" "lookup, more about"
7641 .cindex "lookup" "LDAP"
7642 .cindex "Solaris" "LDAP"
7643 The original LDAP implementation came from the University of Michigan; this has
7644 become &"Open LDAP"&, and there are now two different releases. Another
7645 implementation comes from Netscape, and Solaris 7 and subsequent releases
7646 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7647 the lookup function level, their error handling is different. For this reason
7648 it is necessary to set a compile-time variable when building Exim with LDAP, to
7649 indicate which LDAP library is in use. One of the following should appear in
7650 your &_Local/Makefile_&:
7651 .code
7652 LDAP_LIB_TYPE=UMICHIGAN
7653 LDAP_LIB_TYPE=OPENLDAP1
7654 LDAP_LIB_TYPE=OPENLDAP2
7655 LDAP_LIB_TYPE=NETSCAPE
7656 LDAP_LIB_TYPE=SOLARIS
7657 .endd
7658 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7659 same interface as the University of Michigan version.
7660
7661 There are three LDAP lookup types in Exim. These behave slightly differently in
7662 the way they handle the results of a query:
7663
7664 .ilist
7665 &(ldap)& requires the result to contain just one entry; if there are more, it
7666 gives an error.
7667 .next
7668 &(ldapdn)& also requires the result to contain just one entry, but it is the
7669 Distinguished Name that is returned rather than any attribute values.
7670 .next
7671 &(ldapm)& permits the result to contain more than one entry; the attributes
7672 from all of them are returned.
7673 .endlist
7674
7675
7676 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7677 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7678 the data returned by a successful lookup is described in the next section.
7679 First we explain how LDAP queries are coded.
7680
7681
7682 .section "Format of LDAP queries" "SECTforldaque"
7683 .cindex "LDAP" "query format"
7684 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7685 the configuration of a &(redirect)& router one might have this setting:
7686 .code
7687 data = ${lookup ldap \
7688   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7689   c=UK?mailbox?base?}}
7690 .endd
7691 .cindex "LDAP" "with TLS"
7692 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7693 secure (encrypted) LDAP connections. The second of these ensures that an
7694 encrypted TLS connection is used.
7695
7696 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7697 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7698 See the &%ldap_start_tls%& option.
7699
7700 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7701 controlled. Every part of the TLS configuration can be configured by settings in
7702 &_exim.conf_&. Depending on the version of the client libraries installed on
7703 your system, some of the initialization may have required setting options in
7704 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7705 certificates. This revealed a nuance where the current UID that exim was
7706 running as could affect which config files it read. With Exim 4.83, these
7707 methods become optional, only taking effect if not specifically set in
7708 &_exim.conf_&.
7709
7710
7711 .section "LDAP quoting" "SECID68"
7712 .cindex "LDAP" "quoting"
7713 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7714 and the second because the LDAP query is represented as a URL. Furthermore,
7715 within an LDAP query, two different kinds of quoting are required. For this
7716 reason, there are two different LDAP-specific quoting operators.
7717
7718 The &%quote_ldap%& operator is designed for use on strings that are part of
7719 filter specifications. Conceptually, it first does the following conversions on
7720 the string:
7721 .code
7722 *   =>   \2A
7723 (   =>   \28
7724 )   =>   \29
7725 \   =>   \5C
7726 .endd
7727 in accordance with RFC 2254. The resulting string is then quoted according
7728 to the rules for URLs, that is, all non-alphanumeric characters except
7729 .code
7730 ! $ ' - . _ ( ) * +
7731 .endd
7732 are converted to their hex values, preceded by a percent sign. For example:
7733 .code
7734 ${quote_ldap: a(bc)*, a<yz>; }
7735 .endd
7736 yields
7737 .code
7738 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7739 .endd
7740 Removing the URL quoting, this is (with a leading and a trailing space):
7741 .code
7742 a\28bc\29\2A, a<yz>;
7743 .endd
7744 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7745 base DN specifications in queries. Conceptually, it first converts the string
7746 by inserting a backslash in front of any of the following characters:
7747 .code
7748 , + " \ < > ;
7749 .endd
7750 It also inserts a backslash before any leading spaces or # characters, and
7751 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7752 is then quoted according to the rules for URLs. For example:
7753 .code
7754 ${quote_ldap_dn: a(bc)*, a<yz>; }
7755 .endd
7756 yields
7757 .code
7758 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7759 .endd
7760 Removing the URL quoting, this is (with a trailing space):
7761 .code
7762 \ a(bc)*\, a\<yz\>\;\
7763 .endd
7764 There are some further comments about quoting in the section on LDAP
7765 authentication below.
7766
7767
7768 .section "LDAP connections" "SECID69"
7769 .cindex "LDAP" "connections"
7770 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7771 is in use, via a Unix domain socket. The example given above does not specify
7772 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7773 by starting it with
7774 .code
7775 ldap://<hostname>:<port>/...
7776 .endd
7777 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7778 used. When no server is specified in a query, a list of default servers is
7779 taken from the &%ldap_default_servers%& configuration option. This supplies a
7780 colon-separated list of servers which are tried in turn until one successfully
7781 handles a query, or there is a serious error. Successful handling either
7782 returns the requested data, or indicates that it does not exist. Serious errors
7783 are syntactical, or multiple values when only a single value is expected.
7784 Errors which cause the next server to be tried are connection failures, bind
7785 failures, and timeouts.
7786
7787 For each server name in the list, a port number can be given. The standard way
7788 of specifying a host and port is to use a colon separator (RFC 1738). Because
7789 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7790 doubled. For example
7791 .code
7792 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7793 .endd
7794 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7795 to the LDAP library with no server name, and the library's default (normally
7796 the local host) is used.
7797
7798 If you are using the OpenLDAP library, you can connect to an LDAP server using
7799 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7800 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7801 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7802 not available.
7803
7804 For this type of connection, instead of a host name for the server, a pathname
7805 for the socket is required, and the port number is not relevant. The pathname
7806 can be specified either as an item in &%ldap_default_servers%&, or inline in
7807 the query. In the former case, you can have settings such as
7808 .code
7809 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7810 .endd
7811 When the pathname is given in the query, you have to escape the slashes as
7812 &`%2F`& to fit in with the LDAP URL syntax. For example:
7813 .code
7814 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7815 .endd
7816 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7817 a pathname, it uses the Unix domain socket code, even if the query actually
7818 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7819 socket connection. This behaviour means that you can use a setting of
7820 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7821 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7822 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7823 backup host.
7824
7825 If an explicit &`ldapi`& type is given in a query when a host name is
7826 specified, an error is diagnosed. However, if there are more items in
7827 &%ldap_default_servers%&, they are tried. In other words:
7828
7829 .ilist
7830 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7831 interface.
7832 .next
7833 Using &`ldapi`& with a host name causes an error.
7834 .endlist
7835
7836
7837 Using &`ldapi`& with no host or path in the query, and no setting of
7838 &%ldap_default_servers%&, does whatever the library does by default.
7839
7840
7841
7842 .section "LDAP authentication and control information" "SECID70"
7843 .cindex "LDAP" "authentication"
7844 The LDAP URL syntax provides no way of passing authentication and other control
7845 information to the server. To make this possible, the URL in an LDAP query may
7846 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7847 spaces. If a value contains spaces it must be enclosed in double quotes, and
7848 when double quotes are used, backslash is interpreted in the usual way inside
7849 them. The following names are recognized:
7850 .display
7851 &`DEREFERENCE`&  set the dereferencing parameter
7852 &`NETTIME    `&  set a timeout for a network operation
7853 &`USER       `&  set the DN, for authenticating the LDAP bind
7854 &`PASS       `&  set the password, likewise
7855 &`REFERRALS  `&  set the referrals parameter
7856 &`SERVERS    `&  set alternate server list for this query only
7857 &`SIZE       `&  set the limit for the number of entries returned
7858 &`TIME       `&  set the maximum waiting time for a query
7859 .endd
7860 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7861 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7862 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7863 library from trying to follow referrals issued by the LDAP server.
7864
7865 .cindex LDAP timeout
7866 .cindex timeout "LDAP lookup"
7867 The name CONNECT is an obsolete name for NETTIME, retained for
7868 backwards compatibility. This timeout (specified as a number of seconds) is
7869 enforced from the client end for operations that can be carried out over a
7870 network. Specifically, it applies to network connections and calls to the
7871 &'ldap_result()'& function. If the value is greater than zero, it is used if
7872 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7873 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7874 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7875 Netscape SDK; for OpenLDAP no action is taken.
7876
7877 The TIME parameter (also a number of seconds) is passed to the server to
7878 set a server-side limit on the time taken to complete a search.
7879
7880 The SERVERS parameter allows you to specify an alternate list of ldap servers
7881 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7882 default list of ldap servers, and a single lookup can specify a single ldap
7883 server to use.  But when you need to do a lookup with a list of servers that is
7884 different than the default list (maybe different order, maybe a completely
7885 different set of servers), the SERVERS parameter allows you to specify this
7886 alternate list (colon-separated).
7887
7888 Here is an example of an LDAP query in an Exim lookup that uses some of these
7889 values. This is a single line, folded to fit on the page:
7890 .code
7891 ${lookup ldap
7892   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7893   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7894   {$value}fail}
7895 .endd
7896 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7897 any of the auxiliary data. Exim configuration settings that include lookups
7898 which contain password information should be preceded by &"hide"& to prevent
7899 non-admin users from using the &%-bP%& option to see their values.
7900
7901 The auxiliary data items may be given in any order. The default is no
7902 connection timeout (the system timeout is used), no user or password, no limit
7903 on the number of entries returned, and no time limit on queries.
7904
7905 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7906 removes any URL quoting that it may contain before passing it LDAP. Apparently
7907 some libraries do this for themselves, but some do not. Removing the URL
7908 quoting has two advantages:
7909
7910 .ilist
7911 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7912 DNs as with DNs inside actual queries.
7913 .next
7914 It permits spaces inside USER= DNs.
7915 .endlist
7916
7917 For example, a setting such as
7918 .code
7919 USER=cn=${quote_ldap_dn:$1}
7920 .endd
7921 should work even if &$1$& contains spaces.
7922
7923 Expanded data for the PASS= value should be quoted using the &%quote%&
7924 expansion operator, rather than the LDAP quote operators. The only reason this
7925 field needs quoting is to ensure that it conforms to the Exim syntax, which
7926 does not allow unquoted spaces. For example:
7927 .code
7928 PASS=${quote:$3}
7929 .endd
7930 The LDAP authentication mechanism can be used to check passwords as part of
7931 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7932 &<<CHAPexpand>>&.
7933
7934
7935
7936 .section "Format of data returned by LDAP" "SECID71"
7937 .cindex "LDAP" "returned data formats"
7938 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7939 as a sequence of values, for example
7940 .code
7941 cn=manager,o=University of Cambridge,c=UK
7942 .endd
7943 The &(ldap)& lookup type generates an error if more than one entry matches the
7944 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7945 the result between the data from different entries. It is possible for multiple
7946 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7947 you know that whatever values are returned all came from a single entry in the
7948 directory.
7949
7950 In the common case where you specify a single attribute in your LDAP query, the
7951 result is not quoted, and does not contain the attribute name. If the attribute
7952 has multiple values, they are separated by commas. Any comma that is
7953 part of an attribute's value is doubled.
7954
7955 If you specify multiple attributes, the result contains space-separated, quoted
7956 strings, each preceded by the attribute name and an equals sign. Within the
7957 quotes, the quote character, backslash, and newline are escaped with
7958 backslashes, and commas are used to separate multiple values for the attribute.
7959 Any commas in attribute values are doubled
7960 (permitting treatment of the values as a comma-separated list).
7961 Apart from the escaping, the string within quotes takes the same form as the
7962 output when a single attribute is requested. Specifying no attributes is the
7963 same as specifying all of an entry's attributes.
7964
7965 Here are some examples of the output format. The first line of each pair is an
7966 LDAP query, and the second is the data that is returned. The attribute called
7967 &%attr1%& has two values, one of them with an embedded comma, whereas
7968 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7969 (they have SUP &%attr%& in their schema definitions).
7970
7971 .code
7972 ldap:///o=base?attr1?sub?(uid=fred)
7973 value1.1,value1,,2
7974
7975 ldap:///o=base?attr2?sub?(uid=fred)
7976 value two
7977
7978 ldap:///o=base?attr?sub?(uid=fred)
7979 value1.1,value1,,2,value two
7980
7981 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7982 attr1="value1.1,value1,,2" attr2="value two"
7983
7984 ldap:///o=base??sub?(uid=fred)
7985 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7986 .endd
7987 You can
7988 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7989 results of LDAP lookups.
7990 The &%extract%& operator in string expansions can be used to pick out
7991 individual fields from data that consists of &'key'&=&'value'& pairs.
7992 The &%listextract%& operator should be used to pick out individual values
7993 of attributes, even when only a single value is expected.
7994 The doubling of embedded commas allows you to use the returned data as a
7995 comma separated list (using the "<," syntax for changing the input list separator).
7996
7997
7998
7999
8000 .section "More about NIS+" "SECTnisplus"
8001 .cindex "NIS+ lookup type"
8002 .cindex "lookup" "NIS+"
8003 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
8004 and field name. If this is given, the result of a successful query is the
8005 contents of the named field; otherwise the result consists of a concatenation
8006 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
8007 values containing spaces are quoted. For example, the query
8008 .code
8009 [name=mg1456],passwd.org_dir
8010 .endd
8011 might return the string
8012 .code
8013 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
8014 home=/home/mg1456 shell=/bin/bash shadow=""
8015 .endd
8016 (split over two lines here to fit on the page), whereas
8017 .code
8018 [name=mg1456],passwd.org_dir:gcos
8019 .endd
8020 would just return
8021 .code
8022 Martin Guerre
8023 .endd
8024 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
8025 for the given indexed key. The effect of the &%quote_nisplus%& expansion
8026 operator is to double any quote characters within the text.
8027
8028
8029
8030 .section "SQL lookups" "SECTsql"
8031 .cindex "SQL lookup types"
8032 .cindex "MySQL" "lookup type"
8033 .cindex "PostgreSQL lookup type"
8034 .cindex "lookup" "MySQL"
8035 .cindex "lookup" "PostgreSQL"
8036 .cindex "Oracle" "lookup type"
8037 .cindex "lookup" "Oracle"
8038 .cindex "InterBase lookup type"
8039 .cindex "lookup" "InterBase"
8040 .cindex "Redis lookup type"
8041 .cindex lookup Redis
8042 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
8043 and SQLite
8044 databases. Queries for these databases contain SQL statements, so an example
8045 might be
8046 .code
8047 ${lookup mysql{select mailbox from users where id='userx'}\
8048   {$value}fail}
8049 .endd
8050 If the result of the query contains more than one field, the data for each
8051 field in the row is returned, preceded by its name, so the result of
8052 .code
8053 ${lookup pgsql{select home,name from users where id='userx'}\
8054   {$value}}
8055 .endd
8056 might be
8057 .code
8058 home=/home/userx name="Mister X"
8059 .endd
8060 Empty values and values containing spaces are double quoted, with embedded
8061 quotes escaped by a backslash. If the result of the query contains just one
8062 field, the value is passed back verbatim, without a field name, for example:
8063 .code
8064 Mister X
8065 .endd
8066 If the result of the query yields more than one row, it is all concatenated,
8067 with a newline between the data for each row.
8068
8069
8070 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
8071 .cindex "MySQL" "lookup type"
8072 .cindex "PostgreSQL lookup type"
8073 .cindex "lookup" "MySQL"
8074 .cindex "lookup" "PostgreSQL"
8075 .cindex "Oracle" "lookup type"
8076 .cindex "lookup" "Oracle"
8077 .cindex "InterBase lookup type"
8078 .cindex "lookup" "InterBase"
8079 .cindex "Redis lookup type"
8080 .cindex lookup Redis
8081 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8082 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8083 or &%redis_servers%&
8084 option (as appropriate) must be set to a colon-separated list of server
8085 information.
8086 .oindex &%mysql_servers%&
8087 .oindex &%pgsql_servers%&
8088 .oindex &%oracle_servers%&
8089 .oindex &%ibase_servers%&
8090 .oindex &%redis_servers%&
8091 (For MySQL and PostgreSQL, the global option need not be set if all
8092 queries contain their own server information &-- see section
8093 &<<SECTspeserque>>&.)
8094 For all but Redis
8095 each item in the list is a slash-separated list of four
8096 items: host name, database name, user name, and password. In the case of
8097 Oracle, the host name field is used for the &"service name"&, and the database
8098 name field is not used and should be empty. For example:
8099 .code
8100 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8101 .endd
8102 Because password data is sensitive, you should always precede the setting with
8103 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8104 option. Here is an example where two MySQL servers are listed:
8105 .code
8106 hide mysql_servers = localhost/users/root/secret:\
8107                      otherhost/users/root/othersecret
8108 .endd
8109 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8110 because this is a colon-separated list, the colon has to be doubled. For each
8111 query, these parameter groups are tried in order until a connection is made and
8112 a query is successfully processed. The result of a query may be that no data is
8113 found, but that is still a successful query. In other words, the list of
8114 servers provides a backup facility, not a list of different places to look.
8115
8116 For Redis the global option need not be specified if all queries contain their
8117 own server information &-- see section &<<SECTspeserque>>&.
8118 If specified, the option must be set to a colon-separated list of server
8119 information.
8120 Each item in the list is a slash-separated list of three items:
8121 host, database number, and password.
8122 .olist
8123 The host is required and may be either an IPv4 address and optional
8124 port number (separated by a colon, which needs doubling due to the
8125 higher-level list), or a Unix socket pathname enclosed in parentheses
8126 .next
8127 The database number is optional; if present that number is selected in the backend
8128 .next
8129 The password is optional; if present it is used to authenticate to the backend
8130 .endlist
8131
8132 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8133 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8134 respectively, and the characters single-quote, double-quote, and backslash
8135 itself are escaped with backslashes.
8136
8137 The &%quote_redis%& expansion operator
8138 escapes whitespace and backslash characters with a backslash.
8139
8140 .section "Specifying the server in the query" "SECTspeserque"
8141 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8142 it is possible to specify a list of servers with an individual query. This is
8143 done by appending a comma-separated option to the query type:
8144 .display
8145 &`,servers=`&&'server1:server2:server3:...'&
8146 .endd
8147 Each item in the list may take one of two forms:
8148 .olist
8149 If it contains no slashes it is assumed to be just a host name. The appropriate
8150 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8151 of the same name, and the remaining parameters (database, user, password) are
8152 taken from there.
8153 .next
8154 If it contains any slashes, it is taken as a complete parameter set.
8155 .endlist
8156 The list of servers is used in exactly the same way as the global list.
8157 Once a connection to a server has happened and a query has been
8158 successfully executed, processing of the lookup ceases.
8159
8160 This feature is intended for use in master/slave situations where updates
8161 are occurring and you want to update the master rather than a slave. If the
8162 master is in the list as a backup for reading, you might have a global setting
8163 like this:
8164 .code
8165 mysql_servers = slave1/db/name/pw:\
8166                 slave2/db/name/pw:\
8167                 master/db/name/pw
8168 .endd
8169 In an updating lookup, you could then write:
8170 .code
8171 ${lookup mysql,servers=master {UPDATE ...} }
8172 .endd
8173 That query would then be sent only to the master server. If, on the other hand,
8174 the master is not to be used for reading, and so is not present in the global
8175 option, you can still update it by a query of this form:
8176 .code
8177 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8178 .endd
8179
8180 An older syntax places the servers specification before the query,
8181 semicolon separated:
8182 .code
8183 ${lookup mysql{servers=master; UPDATE ...} }
8184 .endd
8185 The new version avoids potential issues with tainted
8186 arguments in the query, for explicit expansion.
8187 &*Note*&: server specifications in list-style lookups are still problematic.
8188
8189
8190 .section "Special MySQL features" "SECID73"
8191 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8192 causes a connection to the server on the local host by means of a Unix domain
8193 socket. An alternate socket can be specified in parentheses.
8194 An option group name for MySQL option files can be specified in square brackets;
8195 the default value is &"exim"&.
8196 The full syntax of each item in &%mysql_servers%& is:
8197 .display
8198 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8199   <&'database'&>/<&'user'&>/<&'password'&>
8200 .endd
8201 Any of the four sub-parts of the first field can be omitted. For normal use on
8202 the local host it can be left blank or set to just &"localhost"&.
8203
8204 No database need be supplied &-- but if it is absent here, it must be given in
8205 the queries.
8206
8207 If a MySQL query is issued that does not request any data (an insert, update,
8208 or delete command), the result of the lookup is the number of rows affected.
8209
8210 &*Warning*&: This can be misleading. If an update does not actually change
8211 anything (for example, setting a field to the value it already has), the result
8212 is zero because no rows are affected.
8213
8214
8215 .section "Special PostgreSQL features" "SECID74"
8216 PostgreSQL lookups can also use Unix domain socket connections to the database.
8217 This is usually faster and costs less CPU time than a TCP/IP connection.
8218 However it can be used only if the mail server runs on the same machine as the
8219 database server. A configuration line for PostgreSQL via Unix domain sockets
8220 looks like this:
8221 .code
8222 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8223 .endd
8224 In other words, instead of supplying a host name, a path to the socket is
8225 given. The path name is enclosed in parentheses so that its slashes aren't
8226 visually confused with the delimiters for the other server parameters.
8227
8228 If a PostgreSQL query is issued that does not request any data (an insert,
8229 update, or delete command), the result of the lookup is the number of rows
8230 affected.
8231
8232 .section "More about SQLite" "SECTsqlite"
8233 .cindex "lookup" "SQLite"
8234 .cindex "sqlite lookup type"
8235 SQLite is different to the other SQL lookups because a filename is required in
8236 addition to the SQL query. An SQLite database is a single file, and there is no
8237 daemon as in the other SQL databases.
8238
8239 .new
8240 .oindex &%sqlite_dbfile%&
8241 There are two ways of
8242 specifying the file.
8243 The first is is by using the &%sqlite_dbfile%& main option.
8244 The second, which allows separate files for each query,
8245 is to use an option appended, comma-separated, to the &"sqlite"&
8246 lookup type word.  The option is the word &"file"&, then an equals,
8247 then the filename.
8248 The filename in this case cannot contain whitespace or open-brace charachters.
8249 .wen
8250
8251 A deprecated method is available, prefixing the query with the filename
8252 separated by white space.
8253 This means that
8254 .cindex "tainted data" "sqlite file"
8255 the query cannot use any tainted values, as that taints
8256 the entire query including the filename - resulting in a refusal to open
8257 the file.
8258
8259 In all the above cases the filename must be an absolute path.
8260
8261 Here is a lookup expansion example:
8262 .code
8263 sqlite_dbfile = /some/thing/sqlitedb
8264 ...
8265 ${lookup sqlite {select name from aliases where id='userx';}}
8266 .endd
8267 In a list, the syntax is similar. For example:
8268 .code
8269 domainlist relay_to_domains = sqlite;\
8270    select * from relays where ip='$sender_host_address';
8271 .endd
8272 The only character affected by the &%quote_sqlite%& operator is a single
8273 quote, which it doubles.
8274
8275 .cindex timeout SQLite
8276 .cindex sqlite "lookup timeout"
8277 The SQLite library handles multiple simultaneous accesses to the database
8278 internally. Multiple readers are permitted, but only one process can
8279 update at once. Attempts to access the database while it is being updated
8280 are rejected after a timeout period, during which the SQLite library
8281 waits for the lock to be released. In Exim, the default timeout is set
8282 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8283 option.
8284
8285 .section "More about Redis" "SECTredis"
8286 .cindex "lookup" "Redis"
8287 .cindex "redis lookup type"
8288 Redis is a non-SQL database. Commands are simple get and set.
8289 Examples:
8290 .code
8291 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8292 ${lookup redis{get keyname}}
8293 .endd
8294
8295 As of release 4.91, "lightweight" support for Redis Cluster is available.
8296 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8297 of which must be reachable from the running exim instance. If the cluster has
8298 master/slave replication, the list must contain all the master and slave
8299 servers.
8300
8301 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8302 immediately follow the redirection but treats the response as a DEFER, moving on
8303 to the next server in the &%redis_servers%& list until the correct server is
8304 reached.
8305
8306 .ecindex IIDfidalo1
8307 .ecindex IIDfidalo2
8308
8309
8310 . ////////////////////////////////////////////////////////////////////////////
8311 . ////////////////////////////////////////////////////////////////////////////
8312
8313 .chapter "Domain, host, address, and local part lists" &&&
8314          "CHAPdomhosaddlists" &&&
8315          "Domain, host, and address lists"
8316 .scindex IIDdohoadli "lists of domains; hosts; etc."
8317 A number of Exim configuration options contain lists of domains, hosts,
8318 email addresses, or local parts. For example, the &%hold_domains%& option
8319 contains a list of domains whose delivery is currently suspended. These lists
8320 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8321 arguments to expansion conditions such as &%match_domain%&.
8322
8323 Each item in one of these lists is a pattern to be matched against a domain,
8324 host, email address, or local part, respectively. In the sections below, the
8325 different types of pattern for each case are described, but first we cover some
8326 general facilities that apply to all four kinds of list.
8327
8328 Note that other parts of Exim use a &'string list'& which does not
8329 support all the complexity available in
8330 domain, host, address and local part lists.
8331
8332
8333
8334 .section "Expansion of lists" "SECTlistexpand"
8335 .cindex "expansion" "of lists"
8336 Each list is expanded as a single string before it is used.
8337
8338 &'Exception: the router headers_remove option, where list-item
8339 splitting is done before string-expansion.'&
8340
8341 The result of
8342 expansion must be a list, possibly containing empty items, which is split up
8343 into separate items for matching. By default, colon is the separator character,
8344 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8345 &<<SECTempitelis>>& for details of the list syntax; the second of these
8346 discusses the way to specify empty list items.
8347
8348
8349 If the string expansion is forced to fail, Exim behaves as if the item it is
8350 testing (domain, host, address, or local part) is not in the list. Other
8351 expansion failures cause temporary errors.
8352
8353 If an item in a list is a regular expression, backslashes, dollars and possibly
8354 other special characters in the expression must be protected against
8355 misinterpretation by the string expander. The easiest way to do this is to use
8356 the &`\N`& expansion feature to indicate that the contents of the regular
8357 expression should not be expanded. For example, in an ACL you might have:
8358 .code
8359 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8360                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8361 .endd
8362 The first item is a regular expression that is protected from expansion by
8363 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8364 senders based on the receiving domain.
8365
8366
8367
8368
8369 .section "Negated items in lists" "SECID76"
8370 .cindex "list" "negation"
8371 .cindex "negation" "in lists"
8372 Items in a list may be positive or negative. Negative items are indicated by a
8373 leading exclamation mark, which may be followed by optional white space. A list
8374 defines a set of items (domains, etc). When Exim processes one of these lists,
8375 it is trying to find out whether a domain, host, address, or local part
8376 (respectively) is in the set that is defined by the list. It works like this:
8377
8378 The list is scanned from left to right. If a positive item is matched, the
8379 subject that is being checked is in the set; if a negative item is matched, the
8380 subject is not in the set. If the end of the list is reached without the
8381 subject having matched any of the patterns, it is in the set if the last item
8382 was a negative one, but not if it was a positive one. For example, the list in
8383 .code
8384 domainlist relay_to_domains = !a.b.c : *.b.c
8385 .endd
8386 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8387 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8388 list is positive. However, if the setting were
8389 .code
8390 domainlist relay_to_domains = !a.b.c
8391 .endd
8392 then all domains other than &'a.b.c'& would match because the last item in the
8393 list is negative. In other words, a list that ends with a negative item behaves
8394 as if it had an extra item &`:*`& on the end.
8395
8396 Another way of thinking about positive and negative items in lists is to read
8397 the connector as &"or"& after a positive item and as &"and"& after a negative
8398 item.
8399
8400
8401
8402 .section "File names in lists" "SECTfilnamlis"
8403 .cindex "list" "filename in"
8404 If an item in a domain, host, address, or local part list is an absolute
8405 filename (beginning with a slash character), each line of the file is read and
8406 processed as if it were an independent item in the list, except that further
8407 filenames are not allowed,
8408 and no expansion of the data from the file takes place.
8409 Empty lines in the file are ignored, and the file may also contain comment
8410 lines:
8411
8412 .ilist
8413 For domain and host lists, if a # character appears anywhere in a line of the
8414 file, it and all following characters are ignored.
8415 .next
8416 Because local parts may legitimately contain # characters, a comment in an
8417 address list or local part list file is recognized only if # is preceded by
8418 white space or the start of the line. For example:
8419 .code
8420 not#comment@x.y.z   # but this is a comment
8421 .endd
8422 .endlist
8423
8424 Putting a filename in a list has the same effect as inserting each line of the
8425 file as an item in the list (blank lines and comments excepted). However, there
8426 is one important difference: the file is read each time the list is processed,
8427 so if its contents vary over time, Exim's behaviour changes.
8428
8429 If a filename is preceded by an exclamation mark, the sense of any match
8430 within the file is inverted. For example, if
8431 .code
8432 hold_domains = !/etc/nohold-domains
8433 .endd
8434 and the file contains the lines
8435 .code
8436 !a.b.c
8437 *.b.c
8438 .endd
8439 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8440 any domain matching &`*.b.c`& is not.
8441
8442
8443
8444 .section "An lsearch file is not an out-of-line list" "SECID77"
8445 As will be described in the sections that follow, lookups can be used in lists
8446 to provide indexed methods of checking list membership. There has been some
8447 confusion about the way &(lsearch)& lookups work in lists. Because
8448 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8449 sometimes thought that it is allowed to contain wild cards and other kinds of
8450 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8451 always fixed strings, just as for any other single-key lookup type.
8452
8453 If you want to use a file to contain wild-card patterns that form part of a
8454 list, just give the filename on its own, without a search type, as described
8455 in the previous section. You could also use the &(wildlsearch)& or
8456 &(nwildlsearch)&, but there is no advantage in doing this.
8457
8458
8459
8460
8461 .section "Results of list checking" SECTlistresults
8462 The primary result of doing a list check is a truth value.
8463 In some contexts additional information is stored
8464 about the list element that matched:
8465 .vlist
8466 .vitem hosts
8467 A &%hosts%& ACL condition
8468 will store a result in the &$host_data$& variable.
8469 .vitem local_parts
8470 A &%local_parts%& router option or &%local_parts%& ACL condition
8471 will store a result in the &$local_part_data$& variable.
8472 .vitem domains
8473 .new
8474 A &%domains%& router option or &%domains%& ACL condition
8475 will store a result in the &$domain_data$& variable
8476 .wen
8477 .vitem senders
8478 A &%senders%& router option or &%senders%& ACL condition
8479 will store a result in the &$sender_data$& variable.
8480 .vitem recipients
8481 A &%recipients%& ACL condition
8482 will store a result in the &$recipient_data$& variable.
8483 .endlist
8484
8485 The detail of the additional information depends on the
8486 type of match and is given below as the &*value*& information.
8487
8488
8489
8490
8491 .section "Named lists" "SECTnamedlists"
8492 .cindex "named lists"
8493 .cindex "list" "named"
8494 A list of domains, hosts, email addresses, or local parts can be given a name
8495 which is then used to refer to the list elsewhere in the configuration. This is
8496 particularly convenient if the same list is required in several different
8497 places. It also allows lists to be given meaningful names, which can improve
8498 the readability of the configuration. For example, it is conventional to define
8499 a domain list called &'local_domains'& for all the domains that are handled
8500 locally on a host, using a configuration line such as
8501 .code
8502 domainlist local_domains = localhost:my.dom.example
8503 .endd
8504 Named lists are referenced by giving their name preceded by a plus sign, so,
8505 for example, a router that is intended to handle local domains would be
8506 configured with the line
8507 .code
8508 domains = +local_domains
8509 .endd
8510 The first router in a configuration is often one that handles all domains
8511 except the local ones, using a configuration with a negated item like this:
8512 .code
8513 dnslookup:
8514   driver = dnslookup
8515   domains = ! +local_domains
8516   transport = remote_smtp
8517   no_more
8518 .endd
8519 The four kinds of named list are created by configuration lines starting with
8520 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8521 respectively. Then there follows the name that you are defining, followed by an
8522 equals sign and the list itself. For example:
8523 .code
8524 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8525 addresslist bad_senders = cdb;/etc/badsenders
8526 .endd
8527 A named list may refer to other named lists:
8528 .code
8529 domainlist  dom1 = first.example : second.example
8530 domainlist  dom2 = +dom1 : third.example
8531 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8532 .endd
8533 &*Warning*&: If the last item in a referenced list is a negative one, the
8534 effect may not be what you intended, because the negation does not propagate
8535 out to the higher level. For example, consider:
8536 .code
8537 domainlist  dom1 = !a.b
8538 domainlist  dom2 = +dom1 : *.b
8539 .endd
8540 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8541 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8542 means it matches the second list as well. The effect is not the same as
8543 .code
8544 domainlist  dom2 = !a.b : *.b
8545 .endd
8546 where &'x.y'& does not match. It's best to avoid negation altogether in
8547 referenced lists if you can.
8548
8549 .cindex "hiding named list values"
8550 .cindex "named lists" "hiding value of"
8551 Some named list definitions may contain sensitive data, for example, passwords for
8552 accessing databases. To stop non-admin users from using the &%-bP%& command
8553 line option to read these values, you can precede the definition with the
8554 word &"hide"&. For example:
8555 .code
8556 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8557 .endd
8558
8559
8560 Named lists may have a performance advantage. When Exim is routing an
8561 address or checking an incoming message, it caches the result of tests on named
8562 lists. So, if you have a setting such as
8563 .code
8564 domains = +local_domains
8565 .endd
8566 on several of your routers
8567 or in several ACL statements,
8568 the actual test is done only for the first one. However, the caching works only
8569 if there are no expansions within the list itself or any sublists that it
8570 references. In other words, caching happens only for lists that are known to be
8571 the same each time they are referenced.
8572
8573 By default, there may be up to 16 named lists of each type. This limit can be
8574 extended by changing a compile-time variable. The use of domain and host lists
8575 is recommended for concepts such as local domains, relay domains, and relay
8576 hosts. The default configuration is set up like this.
8577
8578
8579
8580 .section "Named lists compared with macros" "SECID78"
8581 .cindex "list" "named compared with macro"
8582 .cindex "macro" "compared with named list"
8583 At first sight, named lists might seem to be no different from macros in the
8584 configuration file. However, macros are just textual substitutions. If you
8585 write
8586 .code
8587 ALIST = host1 : host2
8588 auth_advertise_hosts = !ALIST
8589 .endd
8590 it probably won't do what you want, because that is exactly the same as
8591 .code
8592 auth_advertise_hosts = !host1 : host2
8593 .endd
8594 Notice that the second host name is not negated. However, if you use a host
8595 list, and write
8596 .code
8597 hostlist alist = host1 : host2
8598 auth_advertise_hosts = ! +alist
8599 .endd
8600 the negation applies to the whole list, and so that is equivalent to
8601 .code
8602 auth_advertise_hosts = !host1 : !host2
8603 .endd
8604
8605
8606 .section "Named list caching" "SECID79"
8607 .cindex "list" "caching of named"
8608 .cindex "caching" "named lists"
8609 While processing a message, Exim caches the result of checking a named list if
8610 it is sure that the list is the same each time. In practice, this means that
8611 the cache operates only if the list contains no $ characters, which guarantees
8612 that it will not change when it is expanded. Sometimes, however, you may have
8613 an expanded list that you know will be the same each time within a given
8614 message. For example:
8615 .code
8616 domainlist special_domains = \
8617            ${lookup{$sender_host_address}cdb{/some/file}}
8618 .endd
8619 This provides a list of domains that depends only on the sending host's IP
8620 address. If this domain list is referenced a number of times (for example,
8621 in several ACL lines, or in several routers) the result of the check is not
8622 cached by default, because Exim does not know that it is going to be the
8623 same list each time.
8624
8625 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8626 cache the result anyway. For example:
8627 .code
8628 domainlist_cache special_domains = ${lookup{...
8629 .endd
8630 If you do this, you should be absolutely sure that caching is going to do
8631 the right thing in all cases. When in doubt, leave it out.
8632
8633
8634
8635 .section "Domain lists" "SECTdomainlist"
8636 .cindex "domain list" "patterns for"
8637 .cindex "list" "domain list"
8638 Domain lists contain patterns that are to be matched against a mail domain.
8639 The following types of item may appear in domain lists:
8640
8641 .ilist
8642 .cindex "primary host name"
8643 .cindex "host name" "matched in domain list"
8644 .oindex "&%primary_hostname%&"
8645 .cindex "domain list" "matching primary host name"
8646 .cindex "@ in a domain list"
8647 If a pattern consists of a single @ character, it matches the local host name,
8648 as set by the &%primary_hostname%& option (or defaulted). This makes it
8649 possible to use the same configuration file on several different hosts that
8650 differ only in their names.
8651
8652 The value for a match will be the primary host name.
8653
8654
8655 .next
8656 .cindex "@[] in a domain list"
8657 .cindex "domain list" "matching local IP interfaces"
8658 .cindex "domain literal"
8659 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8660 in square brackets (as in an email address that contains a domain literal), but
8661 only if that IP address is recognized as local for email routing purposes. The
8662 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8663 control which of a host's several IP addresses are treated as local.
8664 In today's Internet, the use of domain literals is controversial;
8665 see the &%allow_domain_literals%& main option.
8666
8667 The value for a match will be the string &`@[]`&.
8668
8669
8670 .next
8671 .cindex "@mx_any"
8672 .cindex "@mx_primary"
8673 .cindex "@mx_secondary"
8674 .cindex "domain list" "matching MX pointers to local host"
8675 If a pattern consists of the string &`@mx_any`& it matches any domain that
8676 has an MX record pointing to the local host or to any host that is listed in
8677 .oindex "&%hosts_treat_as_local%&"
8678 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8679 are similar, except that the first matches only when a primary MX target is the
8680 local host, and the second only when no primary MX target is the local host,
8681 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8682 preference value &-- there may of course be more than one of them.
8683
8684 The MX lookup that takes place when matching a pattern of this type is
8685 performed with the resolver options for widening names turned off. Thus, for
8686 example, a single-component domain will &'not'& be expanded by adding the
8687 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8688 options of the &(dnslookup)& router for a discussion of domain widening.
8689
8690 Sometimes you may want to ignore certain IP addresses when using one of these
8691 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8692 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8693 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8694 on a router). For example:
8695 .code
8696 domains = @mx_any/ignore=127.0.0.1
8697 .endd
8698 This example matches any domain that has an MX record pointing to one of
8699 the local host's IP addresses other than 127.0.0.1.
8700
8701 The list of IP addresses is in fact processed by the same code that processes
8702 host lists, so it may contain CIDR-coded network specifications and it may also
8703 contain negative items.
8704
8705 Because the list of IP addresses is a sublist within a domain list, you have to
8706 be careful about delimiters if there is more than one address. Like any other
8707 list, the default delimiter can be changed. Thus, you might have:
8708 .code
8709 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8710           an.other.domain : ...
8711 .endd
8712 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8713 involved, it is easiest to change the delimiter for the main list as well:
8714 .code
8715 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8716           an.other.domain ? ...
8717 .endd
8718 The value for a match will be the list element string (starting &`@mx_`&).
8719
8720
8721 .next
8722 .cindex "asterisk" "in domain list"
8723 .cindex "domain list" "asterisk in"
8724 .cindex "domain list" "matching &""ends with""&"
8725 If a pattern starts with an asterisk, the remaining characters of the pattern
8726 are compared with the terminating characters of the domain. The use of &"*"& in
8727 domain lists differs from its use in partial matching lookups. In a domain
8728 list, the character following the asterisk need not be a dot, whereas partial
8729 matching works only in terms of dot-separated components. For example, a domain
8730 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8731 &'cipher.key.ex'&.
8732
8733 The value for a match will be the list element string (starting with the asterisk).
8734 Additionally, &$0$& will be set to the matched string
8735 and &$1$& to the variable portion which the asterisk matched.
8736
8737 .next
8738 .cindex "regular expressions" "in domain list"
8739 .cindex "domain list" "matching regular expression"
8740 If a pattern starts with a circumflex character, it is treated as a regular
8741 expression, and matched against the domain using a regular expression matching
8742 function. The circumflex is treated as part of the regular expression.
8743 Email domains are case-independent, so this regular expression match is by
8744 default case-independent, but you can make it case-dependent by starting it
8745 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8746 are given in chapter &<<CHAPregexp>>&.
8747
8748 &*Warning*&: Because domain lists are expanded before being processed, you
8749 must escape any backslash and dollar characters in the regular expression, or
8750 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8751 it is not to be expanded (unless you really do want to build a regular
8752 expression by expansion, of course).
8753
8754 The value for a match will be the list element string (starting with the circumflex).
8755 Additionally, &$0$& will be set to the string matching the regular expression,
8756 and &$1$& (onwards) to any submatches identified by parentheses.
8757
8758
8759
8760 .next
8761 .cindex "lookup" "in domain list"
8762 .cindex "domain list" "matching by lookup"
8763 If a pattern starts with the name of a single-key lookup type followed by a
8764 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8765 must be a filename in a suitable format for the lookup type. For example, for
8766 &"cdb;"& it must be an absolute path:
8767 .code
8768 domains = cdb;/etc/mail/local_domains.cdb
8769 .endd
8770 The appropriate type of lookup is done on the file using the domain name as the
8771 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8772 only in whether or not the key is present in the file. However, when a lookup
8773 is used for the &%domains%& option on a router
8774 or a &%domains%& condition in an ACL statement, the value is preserved in the
8775 &$domain_data$& variable and can be referred to in other router options or
8776 other statements in the same ACL.
8777 .cindex "tainted data" "de-tainting"
8778 The value will be untainted.
8779
8780
8781 .next
8782 Any of the single-key lookup type names may be preceded by
8783 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8784 .code
8785 domains = partial-dbm;/partial/domains
8786 .endd
8787 This causes partial matching logic to be invoked; a description of how this
8788 works is given in section &<<SECTpartiallookup>>&.
8789
8790 .next
8791 .cindex "asterisk" "in lookup type"
8792 Any of the single-key lookup types may be followed by an asterisk. This causes
8793 a default lookup for a key consisting of a single asterisk to be done if the
8794 original lookup fails. This is not a useful feature when using a domain list to
8795 select particular domains (because any domain would match), but it might have
8796 value if the result of the lookup is being used via the &$domain_data$&
8797 expansion variable.
8798
8799 .next
8800 If the pattern starts with the name of a query-style lookup type followed by a
8801 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8802 pattern must be an appropriate query for the lookup type, as described in
8803 chapter &<<CHAPfdlookup>>&. For example:
8804 .code
8805 hold_domains = mysql;select domain from holdlist \
8806   where domain = '${quote_mysql:$domain}';
8807 .endd
8808 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8809 example, it doesn't matter what field you select). Exim is interested only in
8810 whether or not the query succeeds. However, when a lookup is used for the
8811 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8812 variable and can be referred to in other options.
8813 .cindex "tainted data" "de-tainting"
8814 The value will be untainted.
8815
8816 .next
8817 If the pattern starts with the name of a lookup type
8818 of either kind (single-key or query-style) it may be
8819 followed by a comma and options,
8820 The options are lookup-type specific and consist of a comma-separated list.
8821 Each item starts with a tag and and equals "=".
8822
8823 .next
8824 .cindex "domain list" "matching literal domain name"
8825 If none of the above cases apply, a caseless textual comparison is made
8826 between the pattern and the domain.
8827
8828 The value for a match will be the list element string.
8829 .cindex "tainted data" "de-tainting"
8830 Note that this is commonly untainted
8831 (depending on the way the list was created).
8832 Specifically, explicit text in the configuration file in not tainted.
8833 This is a useful way of obtaining an untainted equivalent to
8834 the domain, for later operations.
8835
8836 However if the list (including one-element lists)
8837 is created by expanding a variable containing tainted data,
8838 it is tainted and so will the match value be.
8839 .endlist
8840
8841
8842 Here is an example that uses several different kinds of pattern:
8843 .code
8844 domainlist funny_domains = \
8845   @ : \
8846   lib.unseen.edu : \
8847   *.foundation.fict.example : \
8848   \N^[1-2]\d{3}\.fict\.example$\N : \
8849   partial-dbm;/opt/data/penguin/book : \
8850   nis;domains.byname : \
8851   nisplus;[name=$domain,status=local],domains.org_dir
8852 .endd
8853 There are obvious processing trade-offs among the various matching modes. Using
8854 an asterisk is faster than a regular expression, and listing a few names
8855 explicitly probably is too. The use of a file or database lookup is expensive,
8856 but may be the only option if hundreds of names are required. Because the
8857 patterns are tested in order, it makes sense to put the most commonly matched
8858 patterns earlier.
8859
8860
8861
8862 .section "Host lists" "SECThostlist"
8863 .cindex "host list" "patterns in"
8864 .cindex "list" "host list"
8865 Host lists are used to control what remote hosts are allowed to do. For
8866 example, some hosts may be allowed to use the local host as a relay, and some
8867 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8868 two different ways, by name or by IP address. In a host list, some types of
8869 pattern are matched to a host name, and some are matched to an IP address.
8870 You need to be particularly careful with this when single-key lookups are
8871 involved, to ensure that the right value is being used as the key.
8872
8873
8874 .section "Special host list patterns" "SECID80"
8875 .cindex "empty item in hosts list"
8876 .cindex "host list" "empty string in"
8877 If a host list item is the empty string, it matches only when no remote host is
8878 involved. This is the case when a message is being received from a local
8879 process using SMTP on the standard input, that is, when a TCP/IP connection is
8880 not used.
8881
8882 .cindex "asterisk" "in host list"
8883 The special pattern &"*"& in a host list matches any host or no host. Neither
8884 the IP address nor the name is actually inspected.
8885
8886
8887
8888 .section "Host list patterns that match by IP address" "SECThoslispatip"
8889 .cindex "host list" "matching IP addresses"
8890 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8891 the incoming address actually appears in the IPv6 host as
8892 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8893 list, it is converted into a traditional IPv4 address first. (Not all operating
8894 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8895 concerns.)
8896
8897 The following types of pattern in a host list check the remote host by
8898 inspecting its IP address:
8899
8900 .ilist
8901 If the pattern is a plain domain name (not a regular expression, not starting
8902 with *, not a lookup of any kind), Exim calls the operating system function
8903 to find the associated IP address(es). Exim uses the newer
8904 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8905 This typically causes a forward DNS lookup of the name. The result is compared
8906 with the IP address of the subject host.
8907
8908 If there is a temporary problem (such as a DNS timeout) with the host name
8909 lookup, a temporary error occurs. For example, if the list is being used in an
8910 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8911 temporary SMTP error code. If no IP address can be found for the host name,
8912 what happens is described in section &<<SECTbehipnot>>& below.
8913
8914 .next
8915 .cindex "@ in a host list"
8916 If the pattern is &"@"&, the primary host name is substituted and used as a
8917 domain name, as just described.
8918
8919 .next
8920 If the pattern is an IP address, it is matched against the IP address of the
8921 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8922 IPv6 addresses can be given in colon-separated format, but the colons have to
8923 be doubled so as not to be taken as item separators when the default list
8924 separator is used. IPv6 addresses are recognized even when Exim is compiled
8925 without IPv6 support. This means that if they appear in a host list on an
8926 IPv4-only host, Exim will not treat them as host names. They are just addresses
8927 that can never match a client host.
8928
8929 .next
8930 .cindex "@[] in a host list"
8931 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8932 the local host. For example, if the local host is an IPv4 host with one
8933 interface address 10.45.23.56, these two ACL statements have the same effect:
8934 .code
8935 accept hosts = 127.0.0.1 : 10.45.23.56
8936 accept hosts = @[]
8937 .endd
8938 .next
8939 .cindex "CIDR notation"
8940 If the pattern is an IP address followed by a slash and a mask length (for
8941 example 10.11.42.0/24), it is matched against the IP address of the subject
8942 host under the given mask. This allows, an entire network of hosts to be
8943 included (or excluded) by a single item. The mask uses CIDR notation; it
8944 specifies the number of address bits that must match, starting from the most
8945 significant end of the address.
8946
8947 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8948 of a range of addresses. It is the number of bits in the network portion of the
8949 address. The above example specifies a 24-bit netmask, so it matches all 256
8950 addresses in the 10.11.42.0 network. An item such as
8951 .code
8952 192.168.23.236/31
8953 .endd
8954 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8955 32 for an IPv4 address is the same as no mask at all; just a single address
8956 matches.
8957
8958 Here is another example which shows an IPv4 and an IPv6 network:
8959 .code
8960 recipient_unqualified_hosts = 192.168.0.0/16: \
8961                               3ffe::ffff::836f::::/48
8962 .endd
8963 The doubling of list separator characters applies only when these items
8964 appear inline in a host list. It is not required when indirecting via a file.
8965 For example:
8966 .code
8967 recipient_unqualified_hosts = /opt/exim/unqualnets
8968 .endd
8969 could make use of a file containing
8970 .code
8971 172.16.0.0/12
8972 3ffe:ffff:836f::/48
8973 .endd
8974 to have exactly the same effect as the previous example. When listing IPv6
8975 addresses inline, it is usually more convenient to use the facility for
8976 changing separator characters. This list contains the same two networks:
8977 .code
8978 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8979                                  3ffe:ffff:836f::/48
8980 .endd
8981 The separator is changed to semicolon by the leading &"<;"& at the start of the
8982 list.
8983 .endlist
8984
8985
8986
8987 .section "Host list patterns for single-key lookups by host address" &&&
8988          "SECThoslispatsikey"
8989 .cindex "host list" "lookup of IP address"
8990 When a host is to be identified by a single-key lookup of its complete IP
8991 address, the pattern takes this form:
8992 .display
8993 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8994 .endd
8995 For example:
8996 .code
8997 hosts_lookup = net-cdb;/hosts-by-ip.db
8998 .endd
8999 The text form of the IP address of the subject host is used as the lookup key.
9000 IPv6 addresses are converted to an unabbreviated form, using lower case
9001 letters, with dots as separators because colon is the key terminator in
9002 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
9003 quoting the keys, but this is a facility that was added later.] The data
9004 returned by the lookup is not used.
9005
9006 .cindex "IP address" "masking"
9007 .cindex "host list" "masked IP address"
9008 Single-key lookups can also be performed using masked IP addresses, using
9009 patterns of this form:
9010 .display
9011 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9012 .endd
9013 For example:
9014 .code
9015 net24-dbm;/networks.db
9016 .endd
9017 The IP address of the subject host is masked using <&'number'&> as the mask
9018 length. A textual string is constructed from the masked value, followed by the
9019 mask, and this is used as the lookup key. For example, if the host's IP address
9020 is 192.168.34.6, the key that is looked up for the above example is
9021 &"192.168.34.0/24"&.
9022
9023 When an IPv6 address is converted to a string, dots are normally used instead
9024 of colons, so that keys in &(lsearch)& files need not contain colons (which
9025 terminate &(lsearch)& keys). This was implemented some time before the ability
9026 to quote keys was made available in &(lsearch)& files. However, the more
9027 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9028 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9029 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9030 converted using colons and not dots.
9031 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9032 addresses are always used.
9033 The latter are converted to IPv4 addresses, in dotted-quad form.
9034
9035 Ideally, it would be nice to tidy up this anomalous situation by changing to
9036 colons in all cases, given that quoting is now available for &(lsearch)&.
9037 However, this would be an incompatible change that might break some existing
9038 configurations.
9039
9040 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9041 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9042 the former case the key strings include the mask value, whereas in the latter
9043 case the IP address is used on its own.
9044
9045
9046
9047 .section "Host list patterns that match by host name" "SECThoslispatnam"
9048 .cindex "host" "lookup failures"
9049 .cindex "unknown host name"
9050 .cindex "host list" "matching host name"
9051 There are several types of pattern that require Exim to know the name of the
9052 remote host. These are either wildcard patterns or lookups by name. (If a
9053 complete hostname is given without any wildcarding, it is used to find an IP
9054 address to match against, as described in section &<<SECThoslispatip>>&
9055 above.)
9056
9057 If the remote host name is not already known when Exim encounters one of these
9058 patterns, it has to be found from the IP address.
9059 Although many sites on the Internet are conscientious about maintaining reverse
9060 DNS data for their hosts, there are also many that do not do this.
9061 Consequently, a name cannot always be found, and this may lead to unwanted
9062 effects. Take care when configuring host lists with wildcarded name patterns.
9063 Consider what will happen if a name cannot be found.
9064
9065 Because of the problems of determining host names from IP addresses, matching
9066 against host names is not as common as matching against IP addresses.
9067
9068 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9069 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9070 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9071 are done can be changed by setting the &%host_lookup_order%& option. For
9072 security, once Exim has found one or more names, it looks up the IP addresses
9073 for these names and compares them with the IP address that it started with.
9074 Only those names whose IP addresses match are accepted. Any other names are
9075 discarded. If no names are left, Exim behaves as if the host name cannot be
9076 found. In the most common case there is only one name and one IP address.
9077
9078 There are some options that control what happens if a host name cannot be
9079 found. These are described in section &<<SECTbehipnot>>& below.
9080
9081 .cindex "host" "alias for"
9082 .cindex "alias for host"
9083 As a result of aliasing, hosts may have more than one name. When processing any
9084 of the following types of pattern, all the host's names are checked:
9085
9086 .ilist
9087 .cindex "asterisk" "in host list"
9088 If a pattern starts with &"*"& the remainder of the item must match the end of
9089 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9090 &'.b.c'&. This special simple form is provided because this is a very common
9091 requirement. Other kinds of wildcarding require the use of a regular
9092 expression.
9093 .next
9094 .cindex "regular expressions" "in host list"
9095 .cindex "host list" "regular expression in"
9096 If the item starts with &"^"& it is taken to be a regular expression which is
9097 matched against the host name. Host names are case-independent, so this regular
9098 expression match is by default case-independent, but you can make it
9099 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9100 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9101 example,
9102 .code
9103 ^(a|b)\.c\.d$
9104 .endd
9105 is a regular expression that matches either of the two hosts &'a.c.d'& or
9106 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9107 that backslash and dollar characters are not misinterpreted as part of the
9108 string expansion. The simplest way to do this is to use &`\N`& to mark that
9109 part of the string as non-expandable. For example:
9110 .code
9111 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9112 .endd
9113 &*Warning*&: If you want to match a complete host name, you must include the
9114 &`$`& terminating metacharacter in the regular expression, as in the above
9115 example. Without it, a match at the start of the host name is all that is
9116 required.
9117 .endlist
9118
9119
9120
9121
9122 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9123 .cindex "host" "lookup failures, permanent"
9124 While processing a host list, Exim may need to look up an IP address from a
9125 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9126 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9127 behaviour when it fails to find the information it is seeking is the same.
9128
9129 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9130 apply to temporary DNS errors, whose handling is described in the next section.
9131
9132 .cindex "&`+include_unknown`&"
9133 .cindex "&`+ignore_unknown`&"
9134 Exim parses a host list from left to right. If it encounters a permanent
9135 lookup failure in any item in the host list before it has found a match,
9136 Exim treats it as a failure and the default behavior is as if the host
9137 does not match the list. This may not always be what you want to happen.
9138 To change Exim's behaviour, the special items &`+include_unknown`& or
9139 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9140 not recognized in an indirected file).
9141
9142 .ilist
9143 If any item that follows &`+include_unknown`& requires information that
9144 cannot found, Exim behaves as if the host does match the list. For example,
9145 .code
9146 host_reject_connection = +include_unknown:*.enemy.ex
9147 .endd
9148 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9149 any hosts whose name it cannot find.
9150
9151 .next
9152 If any item that follows &`+ignore_unknown`& requires information that cannot
9153 be found, Exim ignores that item and proceeds to the rest of the list. For
9154 example:
9155 .code
9156 accept hosts = +ignore_unknown : friend.example : \
9157                192.168.4.5
9158 .endd
9159 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9160 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9161 name can be found for 192.168.4.5, it is rejected.
9162 .endlist
9163
9164 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9165 list. The effect of each one lasts until the next, or until the end of the
9166 list.
9167
9168 .section "Mixing wildcarded host names and addresses in host lists" &&&
9169          "SECTmixwilhos"
9170 .cindex "host list" "mixing names and addresses in"
9171
9172 This section explains the host/ip processing logic with the same concepts
9173 as the previous section, but specifically addresses what happens when a
9174 wildcarded hostname is one of the items in the hostlist.
9175
9176 .ilist
9177 If you have name lookups or wildcarded host names and
9178 IP addresses in the same host list, you should normally put the IP
9179 addresses first. For example, in an ACL you could have:
9180 .code
9181 accept hosts = 10.9.8.7 : *.friend.example
9182 .endd
9183 The reason you normally would order it this way lies in the
9184 left-to-right way that Exim processes lists.  It can test IP addresses
9185 without doing any DNS lookups, but when it reaches an item that requires
9186 a host name, it fails if it cannot find a host name to compare with the
9187 pattern. If the above list is given in the opposite order, the
9188 &%accept%& statement fails for a host whose name cannot be found, even
9189 if its IP address is 10.9.8.7.
9190
9191 .next
9192 If you really do want to do the name check first, and still recognize the IP
9193 address, you can rewrite the ACL like this:
9194 .code
9195 accept hosts = *.friend.example
9196 accept hosts = 10.9.8.7
9197 .endd
9198 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9199 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9200 &`+ignore_unknown`&, which was discussed in depth in the first example in
9201 this section.
9202 .endlist
9203
9204
9205 .section "Temporary DNS errors when looking up host information" &&&
9206          "SECTtemdnserr"
9207 .cindex "host" "lookup failures, temporary"
9208 .cindex "&`+include_defer`&"
9209 .cindex "&`+ignore_defer`&"
9210 A temporary DNS lookup failure normally causes a defer action (except when
9211 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9212 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9213 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9214 section. These options should be used with care, probably only in non-critical
9215 host lists such as whitelists.
9216
9217
9218
9219 .section "Host list patterns for single-key lookups by host name" &&&
9220          "SECThoslispatnamsk"
9221 .cindex "unknown host name"
9222 .cindex "host list" "matching host name"
9223 If a pattern is of the form
9224 .display
9225 <&'single-key-search-type'&>;<&'search-data'&>
9226 .endd
9227 for example
9228 .code
9229 dbm;/host/accept/list
9230 .endd
9231 a single-key lookup is performed, using the host name as its key. If the
9232 lookup succeeds, the host matches the item. The actual data that is looked up
9233 is not used.
9234
9235 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9236 keys in the file, not IP addresses. If you want to do lookups based on IP
9237 addresses, you must precede the search type with &"net-"& (see section
9238 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9239 two items in the same list, one doing an address lookup and one doing a name
9240 lookup, both using the same file.
9241
9242
9243
9244 .section "Host list patterns for query-style lookups" "SECID81"
9245 If a pattern is of the form
9246 .display
9247 <&'query-style-search-type'&>;<&'query'&>
9248 .endd
9249 the query is obeyed, and if it succeeds, the host matches the item. The actual
9250 data that is looked up is not used. The variables &$sender_host_address$& and
9251 &$sender_host_name$& can be used in the query. For example:
9252 .code
9253 hosts_lookup = pgsql;\
9254   select ip from hostlist where ip='$sender_host_address'
9255 .endd
9256 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9257 can use the &%sg%& expansion item to change this if you need to. If you want to
9258 use masked IP addresses in database queries, you can use the &%mask%& expansion
9259 operator.
9260
9261 If the query contains a reference to &$sender_host_name$&, Exim automatically
9262 looks up the host name if it has not already done so. (See section
9263 &<<SECThoslispatnam>>& for comments on finding host names.)
9264
9265 Historical note: prior to release 4.30, Exim would always attempt to find a
9266 host name before running the query, unless the search type was preceded by
9267 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9268 still recognized for query-style lookups, but its presence or absence has no
9269 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9270 See section &<<SECThoslispatsikey>>&.)
9271
9272
9273
9274
9275
9276 .section "Address lists" "SECTaddresslist"
9277 .cindex "list" "address list"
9278 .cindex "address list" "empty item"
9279 .cindex "address list" "patterns"
9280 Address lists contain patterns that are matched against mail addresses. There
9281 is one special case to be considered: the sender address of a bounce message is
9282 always empty. You can test for this by providing an empty item in an address
9283 list. For example, you can set up a router to process bounce messages by
9284 using this option setting:
9285 .code
9286 senders = :
9287 .endd
9288 The presence of the colon creates an empty item. If you do not provide any
9289 data, the list is empty and matches nothing. The empty sender can also be
9290 detected by a regular expression that matches an empty string,
9291 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9292
9293 Non-empty items in an address list can be straightforward email addresses. For
9294 example:
9295 .code
9296 senders = jbc@askone.example : hs@anacreon.example
9297 .endd
9298 A certain amount of wildcarding is permitted. If a pattern contains an @
9299 character, but is not a regular expression and does not begin with a
9300 semicolon-terminated lookup type (described below), the local part of the
9301 subject address is compared with the local part of the pattern, which may start
9302 with an asterisk. If the local parts match, the domain is checked in exactly
9303 the same way as for a pattern in a domain list. For example, the domain can be
9304 wildcarded, refer to a named list, or be a lookup:
9305 .code
9306 deny senders = *@*.spamming.site:\
9307                *@+hostile_domains:\
9308                bozo@partial-lsearch;/list/of/dodgy/sites:\
9309                *@dbm;/bad/domains.db
9310 .endd
9311 .cindex "local part" "starting with !"
9312 .cindex "address list" "local part starting with !"
9313 If a local part that begins with an exclamation mark is required, it has to be
9314 specified using a regular expression, because otherwise the exclamation mark is
9315 treated as a sign of negation, as is standard in lists.
9316
9317 If a non-empty pattern that is not a regular expression or a lookup does not
9318 contain an @ character, it is matched against the domain part of the subject
9319 address. The only two formats that are recognized this way are a literal
9320 domain, or a domain pattern that starts with *. In both these cases, the effect
9321 is the same as if &`*@`& preceded the pattern. For example:
9322 .code
9323 deny senders = enemy.domain : *.enemy.domain
9324 .endd
9325
9326 The following kinds of more complicated address list pattern can match any
9327 address, including the empty address that is characteristic of bounce message
9328 senders:
9329
9330 .ilist
9331 .cindex "regular expressions" "in address list"
9332 .cindex "address list" "regular expression in"
9333 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9334 done against the complete address, with the pattern as the regular expression.
9335 You must take care that backslash and dollar characters are not misinterpreted
9336 as part of the string expansion. The simplest way to do this is to use &`\N`&
9337 to mark that part of the string as non-expandable. For example:
9338 .code
9339 deny senders = \N^.*this.*@example\.com$\N : \
9340                \N^\d{8}.+@spamhaus.example$\N : ...
9341 .endd
9342 The &`\N`& sequences are removed by the expansion, so these items do indeed
9343 start with &"^"& by the time they are being interpreted as address patterns.
9344
9345 .next
9346 .cindex "address list" "lookup for complete address"
9347 Complete addresses can be looked up by using a pattern that starts with a
9348 lookup type terminated by a semicolon, followed by the data for the lookup. For
9349 example:
9350 .code
9351 deny senders = cdb;/etc/blocked.senders : \
9352   mysql;select address from blocked where \
9353   address='${quote_mysql:$sender_address}'
9354 .endd
9355 Both query-style and single-key lookup types can be used. For a single-key
9356 lookup type, Exim uses the complete address as the key. However, empty keys are
9357 not supported for single-key lookups, so a match against the empty address
9358 always fails. This restriction does not apply to query-style lookups.
9359
9360 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9361 cannot be used, and is ignored if specified, with an entry being written to the
9362 panic log.
9363 .cindex "*@ with single-key lookup"
9364 However, you can configure lookup defaults, as described in section
9365 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9366 default. For example, with this lookup:
9367 .code
9368 accept senders = lsearch*@;/some/file
9369 .endd
9370 the file could contains lines like this:
9371 .code
9372 user1@domain1.example
9373 *@domain2.example
9374 .endd
9375 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9376 that are tried is:
9377 .code
9378 nimrod@jaeger.example
9379 *@jaeger.example
9380 *
9381 .endd
9382 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9383 would mean that every address matches, thus rendering the test useless.
9384
9385 &*Warning 2*&: Do not confuse these two kinds of item:
9386 .code
9387 deny recipients = dbm*@;/some/file
9388 deny recipients = *@dbm;/some/file
9389 .endd
9390 The first does a whole address lookup, with defaulting, as just described,
9391 because it starts with a lookup type. The second matches the local part and
9392 domain independently, as described in a bullet point below.
9393 .endlist
9394
9395
9396 The following kinds of address list pattern can match only non-empty addresses.
9397 If the subject address is empty, a match against any of these pattern types
9398 always fails.
9399
9400
9401 .ilist
9402 .cindex "@@ with single-key lookup"
9403 .cindex "address list" "@@ lookup type"
9404 .cindex "address list" "split local part and domain"
9405 If a pattern starts with &"@@"& followed by a single-key lookup item
9406 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9407 split into a local part and a domain. The domain is looked up in the file. If
9408 it is not found, there is no match. If it is found, the data that is looked up
9409 from the file is treated as a colon-separated list of local part patterns, each
9410 of which is matched against the subject local part in turn.
9411
9412 .cindex "asterisk" "in address list"
9413 The lookup may be a partial one, and/or one involving a search for a default
9414 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9415 patterns that are looked up can be regular expressions or begin with &"*"&, or
9416 even be further lookups. They may also be independently negated. For example,
9417 with
9418 .code
9419 deny senders = @@dbm;/etc/reject-by-domain
9420 .endd
9421 the data from which the DBM file is built could contain lines like
9422 .code
9423 baddomain.com:  !postmaster : *
9424 .endd
9425 to reject all senders except &%postmaster%& from that domain.
9426
9427 .cindex "local part" "starting with !"
9428 If a local part that actually begins with an exclamation mark is required, it
9429 has to be specified using a regular expression. In &(lsearch)& files, an entry
9430 may be split over several lines by indenting the second and subsequent lines,
9431 but the separating colon must still be included at line breaks. White space
9432 surrounding the colons is ignored. For example:
9433 .code
9434 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9435   spammer3 : spammer4
9436 .endd
9437 As in all colon-separated lists in Exim, a colon can be included in an item by
9438 doubling.
9439
9440 If the last item in the list starts with a right angle-bracket, the remainder
9441 of the item is taken as a new key to look up in order to obtain a continuation
9442 list of local parts. The new key can be any sequence of characters. Thus one
9443 might have entries like
9444 .code
9445 aol.com: spammer1 : spammer 2 : >*
9446 xyz.com: spammer3 : >*
9447 *:       ^\d{8}$
9448 .endd
9449 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9450 local parts for all domains, in addition to the specific local parts listed for
9451 each domain. Of course, using this feature costs another lookup each time a
9452 chain is followed, but the effort needed to maintain the data is reduced.
9453
9454 .cindex "loop" "in lookups"
9455 It is possible to construct loops using this facility, and in order to catch
9456 them, the chains may be no more than fifty items long.
9457
9458 .next
9459 The @@<&'lookup'&> style of item can also be used with a query-style
9460 lookup, but in this case, the chaining facility is not available. The lookup
9461 can only return a single list of local parts.
9462 .endlist
9463
9464 &*Warning*&: There is an important difference between the address list items
9465 in these two examples:
9466 .code
9467 senders = +my_list
9468 senders = *@+my_list
9469 .endd
9470 In the first one, &`my_list`& is a named address list, whereas in the second
9471 example it is a named domain list.
9472
9473
9474
9475
9476 .section "Case of letters in address lists" "SECTcasletadd"
9477 .cindex "case of local parts"
9478 .cindex "address list" "case forcing"
9479 .cindex "case forcing in address lists"
9480 Domains in email addresses are always handled caselessly, but for local parts
9481 case may be significant on some systems (see &%caseful_local_part%& for how
9482 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9483 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9484 blocking lists should be done in a case-independent manner. Since most address
9485 lists in Exim are used for this kind of control, Exim attempts to do this by
9486 default.
9487
9488 The domain portion of an address is always lowercased before matching it to an
9489 address list. The local part is lowercased by default, and any string
9490 comparisons that take place are done caselessly. This means that the data in
9491 the address list itself, in files included as plain filenames, and in any file
9492 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9493 keys in files that are looked up by a search type other than &(lsearch)& (which
9494 works caselessly) must be in lower case, because these lookups are not
9495 case-independent.
9496
9497 .cindex "&`+caseful`&"
9498 To allow for the possibility of caseful address list matching, if an item in
9499 an address list is the string &"+caseful"&, the original case of the local
9500 part is restored for any comparisons that follow, and string comparisons are no
9501 longer case-independent. This does not affect the domain, which remains in
9502 lower case. However, although independent matches on the domain alone are still
9503 performed caselessly, regular expressions that match against an entire address
9504 become case-sensitive after &"+caseful"& has been seen.
9505
9506
9507
9508 .section "Local part lists" "SECTlocparlis"
9509 .cindex "list" "local part list"
9510 .cindex "local part" "list"
9511 These behave in the same way as domain and host lists, with the following
9512 changes:
9513
9514 Case-sensitivity in local part lists is handled in the same way as for address
9515 lists, as just described. The &"+caseful"& item can be used if required. In a
9516 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9517 set false, the subject is lowercased and the matching is initially
9518 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9519 matching in the local part list, but not elsewhere in the router. If
9520 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9521 option is case-sensitive from the start.
9522
9523 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9524 comments are handled in the same way as address lists &-- they are recognized
9525 only if the # is preceded by white space or the start of the line.
9526 Otherwise, local part lists are matched in the same way as domain lists, except
9527 that the special items that refer to the local host (&`@`&, &`@[]`&,
9528 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9529 Refer to section &<<SECTdomainlist>>& for details of the other available item
9530 types.
9531 .ecindex IIDdohoadli
9532
9533
9534
9535
9536 . ////////////////////////////////////////////////////////////////////////////
9537 . ////////////////////////////////////////////////////////////////////////////
9538
9539 .chapter "String expansions" "CHAPexpand"
9540 .scindex IIDstrexp "expansion" "of strings"
9541 Many strings in Exim's runtime configuration are expanded before use. Some of
9542 them are expanded every time they are used; others are expanded only once.
9543
9544 When a string is being expanded it is copied verbatim from left to right except
9545 .cindex expansion "string concatenation"
9546 when a dollar or backslash character is encountered. A dollar specifies the
9547 start of a portion of the string that is interpreted and replaced as described
9548 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9549 escape character, as described in the following section.
9550
9551 Whether a string is expanded depends upon the context.  Usually this is solely
9552 dependent upon the option for which a value is sought; in this documentation,
9553 options for which string expansion is performed are marked with &dagger; after
9554 the data type.  ACL rules always expand strings.  A couple of expansion
9555 conditions do not expand some of the brace-delimited branches, for security
9556 reasons,
9557 .cindex "tainted data" expansion
9558 .cindex "tainted data" definition
9559 .cindex expansion "tainted data"
9560 and expansion of data deriving from the sender (&"tainted data"&)
9561 .new
9562 is not permitted (including acessing a file using a tainted name).
9563 .wen
9564
9565 .new
9566 Common ways of obtaining untainted equivalents of variables with
9567 tainted values
9568 .cindex "tainted data" "de-tainting"
9569 come down to using the tainted value as a lookup key in a trusted database.
9570 This database could be the filesystem structure,
9571 or the password file,
9572 or accessed via a DBMS.
9573 Specific methods are indexed under &"de-tainting"&.
9574 .wen
9575
9576
9577
9578 .section "Literal text in expanded strings" "SECTlittext"
9579 .cindex "expansion" "including literal text"
9580 An uninterpreted dollar can be included in an expanded string by putting a
9581 backslash in front of it. A backslash can be used to prevent any special
9582 character being treated specially in an expansion, including backslash itself.
9583 If the string appears in quotes in the configuration file, two backslashes are
9584 required because the quotes themselves cause interpretation of backslashes when
9585 the string is read in (see section &<<SECTstrings>>&).
9586
9587 .cindex "expansion" "non-expandable substrings"
9588 A portion of the string can specified as non-expandable by placing it between
9589 two occurrences of &`\N`&. This is particularly useful for protecting regular
9590 expressions, which often contain backslashes and dollar signs. For example:
9591 .code
9592 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9593 .endd
9594 On encountering the first &`\N`&, the expander copies subsequent characters
9595 without interpretation until it reaches the next &`\N`& or the end of the
9596 string.
9597
9598
9599
9600 .section "Character escape sequences in expanded strings" "SECID82"
9601 .cindex "expansion" "escape sequences"
9602 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9603 expanded string is recognized as an escape sequence for the character newline,
9604 carriage return, or tab, respectively. A backslash followed by up to three
9605 octal digits is recognized as an octal encoding for a single character, and a
9606 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9607 encoding.
9608
9609 These escape sequences are also recognized in quoted strings when they are read
9610 in. Their interpretation in expansions as well is useful for unquoted strings,
9611 and for other cases such as looked-up strings that are then expanded.
9612
9613
9614 .section "Testing string expansions" "SECID83"
9615 .cindex "expansion" "testing"
9616 .cindex "testing" "string expansion"
9617 .oindex "&%-be%&"
9618 Many expansions can be tested by calling Exim with the &%-be%& option. This
9619 takes the command arguments, or lines from the standard input if there are no
9620 arguments, runs them through the string expansion code, and writes the results
9621 to the standard output. Variables based on configuration values are set up, but
9622 since no message is being processed, variables such as &$local_part$& have no
9623 value. Nevertheless the &%-be%& option can be useful for checking out file and
9624 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9625 and &%nhash%&.
9626
9627 Exim gives up its root privilege when it is called with the &%-be%& option, and
9628 instead runs under the uid and gid it was called with, to prevent users from
9629 using &%-be%& for reading files to which they do not have access.
9630
9631 .oindex "&%-bem%&"
9632 If you want to test expansions that include variables whose values are taken
9633 from a message, there are two other options that can be used. The &%-bem%&
9634 option is like &%-be%& except that it is followed by a filename. The file is
9635 read as a message before doing the test expansions. For example:
9636 .code
9637 exim -bem /tmp/test.message '$h_subject:'
9638 .endd
9639 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9640 Exim message identifier. For example:
9641 .code
9642 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9643 .endd
9644 This loads the message from Exim's spool before doing the test expansions, and
9645 is therefore restricted to admin users.
9646
9647
9648 .section "Forced expansion failure" "SECTforexpfai"
9649 .cindex "expansion" "forced failure"
9650 A number of expansions that are described in the following section have
9651 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9652 (which are sometimes called &"curly brackets"&). Which of the two strings is
9653 used depends on some condition that is evaluated as part of the expansion. If,
9654 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9655 the entire string expansion fails in a way that can be detected by the code
9656 that requested the expansion. This is called &"forced expansion failure"&, and
9657 its consequences depend on the circumstances. In some cases it is no different
9658 from any other expansion failure, but in others a different action may be
9659 taken. Such variations are mentioned in the documentation of the option that is
9660 being expanded.
9661
9662
9663
9664
9665 .section "Expansion items" "SECTexpansionitems"
9666 The following items are recognized in expanded strings. White space may be used
9667 between sub-items that are keywords or substrings enclosed in braces inside an
9668 outer set of braces, to improve readability. &*Warning*&: Within braces,
9669 white space is significant.
9670
9671 .vlist
9672 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9673 .cindex "expansion" "variables"
9674 Substitute the contents of the named variable, for example:
9675 .code
9676 $local_part
9677 ${domain}
9678 .endd
9679 The second form can be used to separate the name from subsequent alphanumeric
9680 characters. This form (using braces) is available only for variables; it does
9681 &'not'& apply to message headers. The names of the variables are given in
9682 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9683 given, the expansion fails.
9684
9685 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9686 .cindex "expansion" "operators"
9687 The string is first itself expanded, and then the operation specified by
9688 <&'op'&> is applied to it. For example:
9689 .code
9690 ${lc:$local_part}
9691 .endd
9692 The string starts with the first character after the colon, which may be
9693 leading white space. A list of operators is given in section &<<SECTexpop>>&
9694 below. The operator notation is used for simple expansion items that have just
9695 one argument, because it reduces the number of braces and therefore makes the
9696 string easier to understand.
9697
9698 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9699 This item inserts &"basic"& header lines. It is described with the &%header%&
9700 expansion item below.
9701
9702
9703 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9704 .cindex "expansion" "calling an acl"
9705 .cindex "&%acl%&" "call from expansion"
9706 The name and zero to nine argument strings are first expanded separately.  The expanded
9707 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9708 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9709 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9710 and may use the variables; if another acl expansion is used the values
9711 are restored after it returns.  If the ACL sets
9712 a value using a "message =" modifier and returns accept or deny, the value becomes
9713 the result of the expansion.
9714 If no message is set and the ACL returns accept or deny
9715 the expansion result is an empty string.
9716 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9717
9718
9719 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9720 .cindex authentication "results header"
9721 .cindex headers "authentication-results:"
9722 .cindex authentication "expansion item"
9723 This item returns a string suitable for insertion as an
9724 &'Authentication-Results:'&
9725 header line.
9726 The given <&'authserv-id'&> is included in the result; typically this
9727 will be a domain name identifying the system performing the authentications.
9728 Methods that might be present in the result include:
9729 .code
9730 none
9731 iprev
9732 auth
9733 spf
9734 dkim
9735 .endd
9736
9737 Example use (as an ACL modifier):
9738 .code
9739       add_header = :at_start:${authresults {$primary_hostname}}
9740 .endd
9741 This is safe even if no authentication results are available.
9742
9743
9744 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9745        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9746 .cindex "expansion" "extracting certificate fields"
9747 .cindex "&%certextract%&" "certificate fields"
9748 .cindex "certificate" "extracting fields"
9749 The <&'certificate'&> must be a variable of type certificate.
9750 The field name is expanded and used to retrieve the relevant field from
9751 the certificate.  Supported fields are:
9752 .display
9753 &`version        `&
9754 &`serial_number  `&
9755 &`subject        `& RFC4514 DN
9756 &`issuer         `& RFC4514 DN
9757 &`notbefore      `& time
9758 &`notafter       `& time
9759 &`sig_algorithm  `&
9760 &`signature      `&
9761 &`subj_altname   `& tagged list
9762 &`ocsp_uri       `& list
9763 &`crl_uri        `& list
9764 .endd
9765 If the field is found,
9766 <&'string2'&> is expanded, and replaces the whole item;
9767 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9768 variable &$value$& contains the value that has been extracted. Afterwards, it
9769 is restored to any previous value it might have had.
9770
9771 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9772 key is not found. If {<&'string2'&>} is also omitted, the value that was
9773 extracted is used.
9774
9775 Some field names take optional modifiers, appended and separated by commas.
9776
9777 The field selectors marked as "RFC4514" above
9778 output a Distinguished Name string which is
9779 not quite
9780 parseable by Exim as a comma-separated tagged list
9781 (the exceptions being elements containing commas).
9782 RDN elements of a single type may be selected by
9783 a modifier of the type label; if so the expansion
9784 result is a list (newline-separated by default).
9785 The separator may be changed by another modifier of
9786 a right angle-bracket followed immediately by the new separator.
9787 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9788
9789 The field selectors marked as "time" above
9790 take an optional modifier of "int"
9791 for which the result is the number of seconds since epoch.
9792 Otherwise the result is a human-readable string
9793 in the timezone selected by the main "timezone" option.
9794
9795 The field selectors marked as "list" above return a list,
9796 newline-separated by default,
9797 (embedded separator characters in elements are doubled).
9798 The separator may be changed by a modifier of
9799 a right angle-bracket followed immediately by the new separator.
9800
9801 The field selectors marked as "tagged" above
9802 prefix each list element with a type string and an equals sign.
9803 Elements of only one type may be selected by a modifier
9804 which is one of "dns", "uri" or "mail";
9805 if so the element tags are omitted.
9806
9807 If not otherwise noted field values are presented in human-readable form.
9808
9809 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9810        {*&<&'arg'&>&*}...}*&"
9811 .cindex &%dlfunc%&
9812 This expansion dynamically loads and then calls a locally-written C function.
9813 This functionality is available only if Exim is compiled with
9814 .code
9815 EXPAND_DLFUNC=yes
9816 .endd
9817 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9818 object so that it doesn't reload the same object file in the same Exim process
9819 (but of course Exim does start new processes frequently).
9820
9821 There may be from zero to eight arguments to the function.
9822
9823 When compiling
9824 a local function that is to be called in this way,
9825 first &_DLFUNC_IMPL_& should be defined,
9826 and second &_local_scan.h_& should be included.
9827 The Exim variables and functions that are defined by that API
9828 are also available for dynamically loaded functions. The function itself
9829 must have the following type:
9830 .code
9831 int dlfunction(uschar **yield, int argc, uschar *argv[])
9832 .endd
9833 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9834 function should return one of the following values:
9835
9836 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9837 into the expanded string that is being built.
9838
9839 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9840 from &'yield'&, if it is set.
9841
9842 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9843 taken from &'yield'& if it is set.
9844
9845 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9846
9847 When compiling a function that is to be used in this way with gcc,
9848 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9849 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9850
9851
9852 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9853 .cindex "expansion" "extracting value from environment"
9854 .cindex "environment" "values from"
9855 The key is first expanded separately, and leading and trailing white space
9856 removed.
9857 This is then searched for as a name in the environment.
9858 If a variable is found then its value is placed in &$value$&
9859 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9860
9861 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9862 appear, for example:
9863 .code
9864 ${env{USER}{$value} fail }
9865 .endd
9866 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9867 {<&'string1'&>} must be present for &"fail"& to be recognized.
9868
9869 If {<&'string2'&>} is omitted an empty string is substituted on
9870 search failure.
9871 If {<&'string1'&>} is omitted the search result is substituted on
9872 search success.
9873
9874 The environment is adjusted by the &%keep_environment%& and
9875 &%add_environment%& main section options.
9876
9877
9878 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9879        {*&<&'string3'&>&*}}*&"
9880 .cindex "expansion" "extracting substrings by key"
9881 .cindex "&%extract%&" "substrings by key"
9882 The key and <&'string1'&> are first expanded separately. Leading and trailing
9883 white space is removed from the key (but not from any of the strings). The key
9884 must not be empty and must not consist entirely of digits.
9885 The expanded <&'string1'&> must be of the form:
9886 .display
9887 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9888 .endd
9889 .vindex "&$value$&"
9890 where the equals signs and spaces (but not both) are optional. If any of the
9891 values contain white space, they must be enclosed in double quotes, and any
9892 values that are enclosed in double quotes are subject to escape processing as
9893 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9894 for the value that corresponds to the key. The search is case-insensitive. If
9895 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9896 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9897 variable &$value$& contains the value that has been extracted. Afterwards, it
9898 is restored to any previous value it might have had.
9899
9900 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9901 key is not found. If {<&'string2'&>} is also omitted, the value that was
9902 extracted is used. Thus, for example, these two expansions are identical, and
9903 yield &"2001"&:
9904 .code
9905 ${extract{gid}{uid=1984 gid=2001}}
9906 ${extract{gid}{uid=1984 gid=2001}{$value}}
9907 .endd
9908 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9909 appear, for example:
9910 .code
9911 ${extract{Z}{A=... B=...}{$value} fail }
9912 .endd
9913 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9914 {<&'string2'&>} must be present for &"fail"& to be recognized.
9915
9916 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9917        {*&<&'string3'&>&*}}*&" &&&
9918        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9919        {*&<&'string3'&>&*}}*&"
9920 .cindex "expansion" "extracting from JSON object"
9921 .cindex JSON expansions
9922 The key and <&'string1'&> are first expanded separately. Leading and trailing
9923 white space is removed from the key (but not from any of the strings). The key
9924 must not be empty and must not consist entirely of digits.
9925 The expanded <&'string1'&> must be of the form:
9926 .display
9927 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9928 .endd
9929 .vindex "&$value$&"
9930 The braces, commas and colons, and the quoting of the member name are required;
9931 the spaces are optional.
9932 Matching of the key against the member names is done case-sensitively.
9933 For the &"json"& variant,
9934 if a returned value is a JSON string, it retains its leading and
9935 trailing quotes.
9936 For the &"jsons"& variant, which is intended for use with JSON strings, the
9937 leading and trailing quotes are removed from the returned value.
9938 . XXX should be a UTF-8 compare
9939
9940 The results of matching are handled as above.
9941
9942
9943 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9944         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9945 .cindex "expansion" "extracting substrings by number"
9946 .cindex "&%extract%&" "substrings by number"
9947 The <&'number'&> argument must consist entirely of decimal digits,
9948 apart from leading and trailing white space, which is ignored.
9949 This is what distinguishes this form of &%extract%& from the previous kind. It
9950 behaves in the same way, except that, instead of extracting a named field, it
9951 extracts from <&'string1'&> the field whose number is given as the first
9952 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9953 <&'string3'&> as before.
9954
9955 The fields in the string are separated by any one of the characters in the
9956 separator string. These may include space or tab characters.
9957 The first field is numbered one. If the number is negative, the fields are
9958 counted from the end of the string, with the rightmost one numbered -1. If the
9959 number given is zero, the entire string is returned. If the modulus of the
9960 number is greater than the number of fields in the string, the result is the
9961 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9962 provided. For example:
9963 .code
9964 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9965 .endd
9966 yields &"42"&, and
9967 .code
9968 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9969 .endd
9970 yields &"99"&. Two successive separators mean that the field between them is
9971 empty (for example, the fifth field above).
9972
9973
9974 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9975         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9976        "&*${extract jsons{*&<&'number'&>&*}}&&&
9977         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9978 .cindex "expansion" "extracting from JSON array"
9979 .cindex JSON expansions
9980 The <&'number'&> argument must consist entirely of decimal digits,
9981 apart from leading and trailing white space, which is ignored.
9982
9983 Field selection and result handling is as above;
9984 there is no choice of field separator.
9985 For the &"json"& variant,
9986 if a returned value is a JSON string, it retains its leading and
9987 trailing quotes.
9988 For the &"jsons"& variant, which is intended for use with JSON strings, the
9989 leading and trailing quotes are removed from the returned value.
9990
9991
9992 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9993 .cindex "list" "selecting by condition"
9994 .cindex "expansion" "selecting from list by condition"
9995 .vindex "&$item$&"
9996 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9997 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9998 For each item
9999 in this list, its value is place in &$item$&, and then the condition is
10000 evaluated. If the condition is true, &$item$& is added to the output as an
10001 item in a new list; if the condition is false, the item is discarded. The
10002 separator used for the output list is the same as the one used for the
10003 input, but a separator setting is not included in the output. For example:
10004 .code
10005 ${filter{a:b:c}{!eq{$item}{b}}}
10006 .endd
10007 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
10008 to what it was before. See also the &%map%& and &%reduce%& expansion items.
10009
10010
10011 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10012 .cindex "hash function" "textual"
10013 .cindex "expansion" "textual hash"
10014 This is a textual hashing function, and was the first to be implemented in
10015 early versions of Exim. In current releases, there are other hashing functions
10016 (numeric, MD5, and SHA-1), which are described below.
10017
10018 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10019 <&'n'&>. If you are using fixed values for these numbers, that is, if
10020 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10021 use the simpler operator notation that avoids some of the braces:
10022 .code
10023 ${hash_<n>_<m>:<string>}
10024 .endd
10025 The second number is optional (in both notations). If <&'n'&> is greater than
10026 or equal to the length of the string, the expansion item returns the string.
10027 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10028 function to the string. The new string consists of characters taken from the
10029 first <&'m'&> characters of the string
10030 .code
10031 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10032 .endd
10033 If <&'m'&> is not present the value 26 is used, so that only lower case
10034 letters appear. For example:
10035 .display
10036 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10037 &`$hash{5}{monty}}           `&   yields  &`monty`&
10038 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10039 .endd
10040
10041 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10042         &*$h_*&<&'header&~name'&>&*:*&" &&&
10043        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10044         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10045        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10046         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10047        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10048         &*$rh_*&<&'header&~name'&>&*:*&"
10049 .cindex "expansion" "header insertion"
10050 .vindex "&$header_$&"
10051 .vindex "&$bheader_$&"
10052 .vindex "&$lheader_$&"
10053 .vindex "&$rheader_$&"
10054 .cindex "header lines" "in expansion strings"
10055 .cindex "header lines" "character sets"
10056 .cindex "header lines" "decoding"
10057 Substitute the contents of the named message header line, for example
10058 .code
10059 $header_reply-to:
10060 .endd
10061 The newline that terminates a header line is not included in the expansion, but
10062 internal newlines (caused by splitting the header line over several physical
10063 lines) may be present.
10064
10065 The difference between the four pairs of expansions is in the way
10066 the data in the header line is interpreted.
10067
10068 .ilist
10069 .cindex "white space" "in header lines"
10070 &%rheader%& gives the original &"raw"& content of the header line, with no
10071 processing at all, and without the removal of leading and trailing white space.
10072
10073 .next
10074 .cindex "list" "of header lines"
10075 &%lheader%& gives a colon-separated list, one element per header when there
10076 are multiple headers with a given name.
10077 Any embedded colon characters within an element are doubled, so normal Exim
10078 list-processing facilities can be used.
10079 The terminating newline of each element is removed; in other respects
10080 the content is &"raw"&.
10081
10082 .next
10083 .cindex "base64 encoding" "in header lines"
10084 &%bheader%& removes leading and trailing white space, and then decodes base64
10085 or quoted-printable MIME &"words"& within the header text, but does no
10086 character set translation. If decoding of what looks superficially like a MIME
10087 &"word"& fails, the raw string is returned. If decoding
10088 .cindex "binary zero" "in header line"
10089 produces a binary zero character, it is replaced by a question mark &-- this is
10090 what Exim does for binary zeros that are actually received in header lines.
10091
10092 .next
10093 &%header%& tries to translate the string as decoded by &%bheader%& to a
10094 standard character set. This is an attempt to produce the same string as would
10095 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10096 returned. Translation is attempted only on operating systems that support the
10097 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10098 a system Makefile or in &_Local/Makefile_&.
10099 .endlist ilist
10100
10101 In a filter file, the target character set for &%header%& can be specified by a
10102 command of the following form:
10103 .code
10104 headers charset "UTF-8"
10105 .endd
10106 This command affects all references to &$h_$& (or &$header_$&) expansions in
10107 subsequently obeyed filter commands. In the absence of this command, the target
10108 character set in a filter is taken from the setting of the &%headers_charset%&
10109 option in the runtime configuration. The value of this option defaults to the
10110 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10111 ISO-8859-1.
10112
10113 Header names follow the syntax of RFC 2822, which states that they may contain
10114 any printing characters except space and colon. Consequently, curly brackets
10115 &'do not'& terminate header names, and should not be used to enclose them as
10116 if they were variables. Attempting to do so causes a syntax error.
10117
10118 Only header lines that are common to all copies of a message are visible to
10119 this mechanism. These are the original header lines that are received with the
10120 message, and any that are added by an ACL statement or by a system
10121 filter. Header lines that are added to a particular copy of a message by a
10122 router or transport are not accessible.
10123
10124 For incoming SMTP messages, no header lines are visible in
10125 ACLs that are obeyed before the data phase completes,
10126 because the header structure is not set up until the message is received.
10127 They are visible in DKIM, PRDR and DATA ACLs.
10128 Header lines that are added in a RCPT ACL (for example)
10129 are saved until the message's incoming header lines are available, at which
10130 point they are added.
10131 When any of the above ACLs ar
10132 running, however, header lines added by earlier ACLs are visible.
10133
10134 Upper case and lower case letters are synonymous in header names. If the
10135 following character is white space, the terminating colon may be omitted, but
10136 this is not recommended, because you may then forget it when it is needed. When
10137 white space terminates the header name, this white space is included in the
10138 expanded string.  If the message does not contain the given header, the
10139 expansion item is replaced by an empty string. (See the &%def%& condition in
10140 section &<<SECTexpcond>>& for a means of testing for the existence of a
10141 header.)
10142
10143 If there is more than one header with the same name, they are all concatenated
10144 to form the substitution string, up to a maximum length of 64K. Unless
10145 &%rheader%& is being used, leading and trailing white space is removed from
10146 each header before concatenation, and a completely empty header is ignored. A
10147 newline character is then inserted between non-empty headers, but there is no
10148 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10149 those headers that contain lists of addresses, a comma is also inserted at the
10150 junctions between headers. This does not happen for the &%rheader%& expansion.
10151
10152 .cindex "tainted data" "message headers"
10153 When the headers are from an incoming message,
10154 the result of expanding any of these variables is tainted.
10155
10156
10157 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10158 .cindex "expansion" "hmac hashing"
10159 .cindex &%hmac%&
10160 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10161 shared secret and some text into a message authentication code, as specified in
10162 RFC 2104. This differs from &`${md5:secret_text...}`& or
10163 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10164 cryptographic hash, allowing for authentication that is not possible with MD5
10165 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10166 present. For example:
10167 .code
10168 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10169 .endd
10170 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10171 produces:
10172 .code
10173 dd97e3ba5d1a61b5006108f8c8252953
10174 .endd
10175 As an example of how this might be used, you might put in the main part of
10176 an Exim configuration:
10177 .code
10178 SPAMSCAN_SECRET=cohgheeLei2thahw
10179 .endd
10180 In a router or a transport you could then have:
10181 .code
10182 headers_add = \
10183   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10184   ${hmac{md5}{SPAMSCAN_SECRET}\
10185   {${primary_hostname},${message_exim_id},$h_message-id:}}
10186 .endd
10187 Then given a message, you can check where it was scanned by looking at the
10188 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10189 this header line is authentic by recomputing the authentication code from the
10190 host name, message ID and the &'Message-id:'& header line. This can be done
10191 using Exim's &%-be%& option, or by other means, for example, by using the
10192 &'hmac_md5_hex()'& function in Perl.
10193
10194
10195 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10196 .cindex "expansion" "conditional"
10197 .cindex "&%if%&, expansion item"
10198 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10199 item; otherwise <&'string2'&> is used. The available conditions are described
10200 in section &<<SECTexpcond>>& below. For example:
10201 .code
10202 ${if eq {$local_part}{postmaster} {yes}{no} }
10203 .endd
10204 The second string need not be present; if it is not and the condition is not
10205 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10206 be present instead of the second string (without any curly brackets). In this
10207 case, the expansion is forced to fail if the condition is not true (see section
10208 &<<SECTforexpfai>>&).
10209
10210 If both strings are omitted, the result is the string &`true`& if the condition
10211 is true, and the empty string if the condition is false. This makes it less
10212 cumbersome to write custom ACL and router conditions. For example, instead of
10213 .code
10214 condition = ${if >{$acl_m4}{3}{true}{false}}
10215 .endd
10216 you can use
10217 .code
10218 condition = ${if >{$acl_m4}{3}}
10219 .endd
10220
10221
10222
10223 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10224 .cindex expansion "imap folder"
10225 .cindex "&%imapfolder%& expansion item"
10226 This item converts a (possibly multilevel, or with non-ASCII characters)
10227 folder specification to a Maildir name for filesystem use.
10228 For information on internationalisation support see &<<SECTi18nMDA>>&.
10229
10230
10231
10232 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10233 .cindex "expansion" "string truncation"
10234 .cindex "&%length%& expansion item"
10235 The &%length%& item is used to extract the initial portion of a string. Both
10236 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10237 you are using a fixed value for the number, that is, if <&'string1'&> does not
10238 change when expanded, you can use the simpler operator notation that avoids
10239 some of the braces:
10240 .code
10241 ${length_<n>:<string>}
10242 .endd
10243 The result of this item is either the first <&'n'&> bytes or the whole
10244 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10245 &%strlen%&, which gives the length of a string.
10246 All measurement is done in bytes and is not UTF-8 aware.
10247
10248
10249 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10250         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10251 .cindex "expansion" "extracting list elements by number"
10252 .cindex "&%listextract%&" "extract list elements by number"
10253 .cindex "list" "extracting elements by number"
10254 The <&'number'&> argument must consist entirely of decimal digits,
10255 apart from an optional leading minus,
10256 and leading and trailing white space (which is ignored).
10257
10258 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10259 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10260
10261 The first field of the list is numbered one.
10262 If the number is negative, the fields are
10263 counted from the end of the list, with the rightmost one numbered -1.
10264 The numbered element of the list is extracted and placed in &$value$&,
10265 then <&'string2'&> is expanded as the result.
10266
10267 If the modulus of the
10268 number is zero or greater than the number of fields in the string,
10269 the result is the expansion of <&'string3'&>.
10270
10271 For example:
10272 .code
10273 ${listextract{2}{x:42:99}}
10274 .endd
10275 yields &"42"&, and
10276 .code
10277 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10278 .endd
10279 yields &"result: 42"&.
10280
10281 If {<&'string3'&>} is omitted, an empty string is used for string3.
10282 If {<&'string2'&>} is also omitted, the value that was
10283 extracted is used.
10284 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10285
10286
10287 .new
10288 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10289 .cindex quoting "for list"
10290 .cindex list quoting
10291 This item doubles any occurrence of the separator character
10292 in the given string.
10293 An empty string is replaced with a single space.
10294 This converts the string into a safe form for use as a list element,
10295 in a list using the given separator.
10296 .wen
10297
10298
10299 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10300         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10301        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10302         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10303 .cindex "expansion" "lookup in"
10304 .cindex "file" "lookups"
10305 .cindex "lookup" "in expanded string"
10306 The two forms of lookup item specify data lookups in files and databases, as
10307 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10308 lookups, and the second is used for query-style lookups. The <&'key'&>,
10309 <&'file'&>, and <&'query'&> strings are expanded before use.
10310
10311 If there is any white space in a lookup item which is part of a filter command,
10312 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10313 other place where white space is significant, the lookup item must be enclosed
10314 in double quotes. The use of data lookups in users' filter files may be locked
10315 out by the system administrator.
10316
10317 .vindex "&$value$&"
10318 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10319 During its expansion, the variable &$value$& contains the data returned by the
10320 lookup. Afterwards it reverts to the value it had previously (at the outer
10321 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10322 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10323 string on failure. If <&'string2'&> is provided, it can itself be a nested
10324 lookup, thus providing a mechanism for looking up a default value when the
10325 original lookup fails.
10326
10327 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10328 data for the outer lookup while the parameters of the second lookup are
10329 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10330 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10331 appear, and in this case, if the lookup fails, the entire expansion is forced
10332 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10333 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10334 successful lookup, and nothing in the case of failure.
10335
10336 For single-key lookups, the string &"partial"& is permitted to precede the
10337 search type in order to do partial matching, and * or *@ may follow a search
10338 type to request default lookups if the key does not match (see sections
10339 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10340
10341 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10342 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10343 and non-wild parts of the key during the expansion of the replacement text.
10344 They return to their previous values at the end of the lookup item.
10345
10346 This example looks up the postmaster alias in the conventional alias file:
10347 .code
10348 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10349 .endd
10350 This example uses NIS+ to look up the full name of the user corresponding to
10351 the local part of an address, forcing the expansion to fail if it is not found:
10352 .code
10353 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10354   {$value}fail}
10355 .endd
10356
10357
10358 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10359 .cindex "expansion" "list creation"
10360 .vindex "&$item$&"
10361 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10362 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10363 For each item
10364 in this list, its value is place in &$item$&, and then <&'string2'&> is
10365 expanded and added to the output as an item in a new list. The separator used
10366 for the output list is the same as the one used for the input, but a separator
10367 setting is not included in the output. For example:
10368 .code
10369 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10370 .endd
10371 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10372 value of &$item$& is restored to what it was before. See also the &%filter%&
10373 and &%reduce%& expansion items.
10374
10375 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10376 .cindex "expansion" "numeric hash"
10377 .cindex "hash function" "numeric"
10378 The three strings are expanded; the first two must yield numbers. Call them
10379 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10380 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10381 can use the simpler operator notation that avoids some of the braces:
10382 .code
10383 ${nhash_<n>_<m>:<string>}
10384 .endd
10385 The second number is optional (in both notations). If there is only one number,
10386 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10387 processed by a div/mod hash function that returns two numbers, separated by a
10388 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10389 example,
10390 .code
10391 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10392 .endd
10393 returns the string &"6/33"&.
10394
10395
10396
10397 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10398 .cindex "Perl" "use in expanded string"
10399 .cindex "expansion" "calling Perl from"
10400 This item is available only if Exim has been built to include an embedded Perl
10401 interpreter. The subroutine name and the arguments are first separately
10402 expanded, and then the Perl subroutine is called with those arguments. No
10403 additional arguments need be given; the maximum number permitted, including the
10404 name of the subroutine, is nine.
10405
10406 The return value of the subroutine is inserted into the expanded string, unless
10407 the return value is &%undef%&. In that case, the expansion fails in the same
10408 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10409 Whatever you return is evaluated in a scalar context. For example, if you
10410 return the name of a Perl vector, the return value is the size of the vector,
10411 not its contents.
10412
10413 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10414 with the error message that was passed to &%die%&. More details of the embedded
10415 Perl facility are given in chapter &<<CHAPperl>>&.
10416
10417 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10418 out the use of this expansion item in filter files.
10419
10420
10421 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10422 .cindex "&%prvs%& expansion item"
10423 The first argument is a complete email address and the second is secret
10424 keystring. The third argument, specifying a key number, is optional. If absent,
10425 it defaults to 0. The result of the expansion is a prvs-signed email address,
10426 to be typically used with the &%return_path%& option on an &(smtp)& transport
10427 as part of a bounce address tag validation (BATV) scheme. For more discussion
10428 and an example, see section &<<SECTverifyPRVS>>&.
10429
10430 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10431         {*&<&'string'&>&*}}*&"
10432 .cindex "&%prvscheck%& expansion item"
10433 This expansion item is the complement of the &%prvs%& item. It is used for
10434 checking prvs-signed addresses. If the expansion of the first argument does not
10435 yield a syntactically valid prvs-signed address, the whole item expands to the
10436 empty string. When the first argument does expand to a syntactically valid
10437 prvs-signed address, the second argument is expanded, with the prvs-decoded
10438 version of the address and the key number extracted from the address in the
10439 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10440
10441 These two variables can be used in the expansion of the second argument to
10442 retrieve the secret. The validity of the prvs-signed address is then checked
10443 against the secret. The result is stored in the variable &$prvscheck_result$&,
10444 which is empty for failure or &"1"& for success.
10445
10446 The third argument is optional; if it is missing, it defaults to an empty
10447 string. This argument is now expanded. If the result is an empty string, the
10448 result of the expansion is the decoded version of the address. This is the case
10449 whether or not the signature was valid. Otherwise, the result of the expansion
10450 is the expansion of the third argument.
10451
10452 All three variables can be used in the expansion of the third argument.
10453 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10454 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10455
10456 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10457 .cindex "expansion" "inserting an entire file"
10458 .cindex "file" "inserting into expansion"
10459 .cindex "&%readfile%& expansion item"
10460 The filename and end-of-line string are first expanded separately. The file is
10461 then read, and its contents replace the entire item. All newline characters in
10462 the file are replaced by the end-of-line string if it is present. Otherwise,
10463 newlines are left in the string.
10464 String expansion is not applied to the contents of the file. If you want this,
10465 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10466 the string expansion fails.
10467
10468 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10469 locks out the use of this expansion item in filter files.
10470
10471
10472
10473 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10474         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10475 .cindex "expansion" "inserting from a socket"
10476 .cindex "socket, use of in expansion"
10477 .cindex "&%readsocket%& expansion item"
10478 This item inserts data from a Unix domain or TCP socket into the expanded
10479 string. The minimal way of using it uses just two arguments, as in these
10480 examples:
10481 .code
10482 ${readsocket{/socket/name}{request string}}
10483 ${readsocket{inet:some.host:1234}{request string}}
10484 .endd
10485 For a Unix domain socket, the first substring must be the path to the socket.
10486 For an Internet socket, the first substring must contain &`inet:`& followed by
10487 a host name or IP address, followed by a colon and a port, which can be a
10488 number or the name of a TCP port in &_/etc/services_&. An IP address may
10489 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10490 example:
10491 .code
10492 ${readsocket{inet:[::1]:1234}{request string}}
10493 .endd
10494 Only a single host name may be given, but if looking it up yields more than
10495 one IP address, they are each tried in turn until a connection is made. For
10496 both kinds of socket, Exim makes a connection, writes the request string
10497 unless it is an empty string; and no terminating NUL is ever sent)
10498 and reads from the socket until an end-of-file
10499 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10500 extend what can be done. Firstly, you can vary the timeout. For example:
10501 .code
10502 ${readsocket{/socket/name}{request string}{3s}}
10503 .endd
10504
10505 The third argument is a list of options, of which the first element is the timeout
10506 and must be present if any options are given.
10507 Further elements are options of form &'name=value'&.
10508 Example:
10509 .code
10510 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10511 .endd
10512
10513 The following option names are recognised:
10514 .ilist
10515 &*cache*&
10516 Defines if the result data can be cached for use by a later identical
10517 request in the same process.
10518 Values are &"yes"& or &"no"& (the default).
10519 If not, all cached results for this connection specification
10520 will be invalidated.
10521
10522 .next
10523 &*shutdown*&
10524 Defines whether or not a write-shutdown is done on the connection after
10525 sending the request. Values are &"yes"& (the default) or &"no"&
10526 (preferred, eg. by some webservers).
10527
10528 .next
10529 &*tls*&
10530 Controls the use of TLS on the connection.
10531 Values are &"yes"& or &"no"& (the default).
10532 If it is enabled, a shutdown as descripbed above is never done.
10533 .endlist
10534
10535
10536 A fourth argument allows you to change any newlines that are in the data
10537 that is read, in the same way as for &%readfile%& (see above). This example
10538 turns them into spaces:
10539 .code
10540 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10541 .endd
10542 As with all expansions, the substrings are expanded before the processing
10543 happens. Errors in these sub-expansions cause the expansion to fail. In
10544 addition, the following errors can occur:
10545
10546 .ilist
10547 Failure to create a socket file descriptor;
10548 .next
10549 Failure to connect the socket;
10550 .next
10551 Failure to write the request string;
10552 .next
10553 Timeout on reading from the socket.
10554 .endlist
10555
10556 By default, any of these errors causes the expansion to fail. However, if
10557 you supply a fifth substring, it is expanded and used when any of the above
10558 errors occurs. For example:
10559 .code
10560 ${readsocket{/socket/name}{request string}{3s}{\n}\
10561   {socket failure}}
10562 .endd
10563 You can test for the existence of a Unix domain socket by wrapping this
10564 expansion in &`${if exists`&, but there is a race condition between that test
10565 and the actual opening of the socket, so it is safer to use the fifth argument
10566 if you want to be absolutely sure of avoiding an expansion error for a
10567 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10568
10569 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10570 locks out the use of this expansion item in filter files.
10571
10572
10573 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10574 .cindex "expansion" "reducing a list to a scalar"
10575 .cindex "list" "reducing to a scalar"
10576 .vindex "&$value$&"
10577 .vindex "&$item$&"
10578 This operation reduces a list to a single, scalar string. After expansion,
10579 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10580 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10581 Then <&'string2'&> is expanded and
10582 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10583 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10584 them. The result of that expansion is assigned to &$value$& before the next
10585 iteration. When the end of the list is reached, the final value of &$value$& is
10586 added to the expansion output. The &%reduce%& expansion item can be used in a
10587 number of ways. For example, to add up a list of numbers:
10588 .code
10589 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10590 .endd
10591 The result of that expansion would be &`6`&. The maximum of a list of numbers
10592 can be found:
10593 .code
10594 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10595 .endd
10596 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10597 restored to what they were before. See also the &%filter%& and &%map%&
10598 expansion items.
10599
10600 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10601 This item inserts &"raw"& header lines. It is described with the &%header%&
10602 expansion item in section &<<SECTexpansionitems>>& above.
10603
10604 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10605         {*&<&'string2'&>&*}}*&"
10606 .cindex "expansion" "running a command"
10607 .cindex "&%run%& expansion item"
10608 The command and its arguments are first expanded as one string. The string is
10609 split apart into individual arguments by spaces, and then the command is run
10610 in a separate process, but under the same uid and gid.  As in other command
10611 executions from Exim, a shell is not used by default. If the command requires
10612 a shell, you must explicitly code it.
10613
10614 Since the arguments are split by spaces, when there is a variable expansion
10615 which has an empty result, it will cause the situation that the argument will
10616 simply be omitted when the program is actually executed by Exim. If the
10617 script/program requires a specific number of arguments and the expanded
10618 variable could possibly result in this empty expansion, the variable must be
10619 quoted. This is more difficult if the expanded variable itself could result
10620 in a string containing quotes, because it would interfere with the quotes
10621 around the command arguments. A possible guard against this is to wrap the
10622 variable in the &%sg%& operator to change any quote marks to some other
10623 character.
10624
10625 The standard input for the command exists, but is empty. The standard output
10626 and standard error are set to the same file descriptor.
10627 .cindex "return code" "from &%run%& expansion"
10628 .vindex "&$value$&"
10629 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10630 and replaces the entire item; during this expansion, the standard output/error
10631 from the command is in the variable &$value$&. If the command fails,
10632 <&'string2'&>, if present, is expanded and used. Once again, during the
10633 expansion, the standard output/error from the command is in the variable
10634 &$value$&.
10635
10636 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10637 can be the word &"fail"& (not in braces) to force expansion failure if the
10638 command does not succeed. If both strings are omitted, the result is contents
10639 of the standard output/error on success, and nothing on failure.
10640
10641 .vindex "&$run_in_acl$&"
10642 The standard output/error of the command is put in the variable &$value$&.
10643 In this ACL example, the output of a command is logged for the admin to
10644 troubleshoot:
10645 .code
10646 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10647       log_message  = Output of id: $value
10648 .endd
10649 If the command requires shell idioms, such as the > redirect operator, the
10650 shell must be invoked directly, such as with:
10651 .code
10652 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10653 .endd
10654
10655 .vindex "&$runrc$&"
10656 The return code from the command is put in the variable &$runrc$&, and this
10657 remains set afterwards, so in a filter file you can do things like this:
10658 .code
10659 if "${run{x y z}{}}$runrc" is 1 then ...
10660   elif $runrc is 2 then ...
10661   ...
10662 endif
10663 .endd
10664 If execution of the command fails (for example, the command does not exist),
10665 the return code is 127 &-- the same code that shells use for non-existent
10666 commands.
10667
10668 &*Warning*&: In a router or transport, you cannot assume the order in which
10669 option values are expanded, except for those preconditions whose order of
10670 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10671 by the expansion of one option, and use it in another.
10672
10673 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10674 out the use of this expansion item in filter files.
10675
10676
10677 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10678 .cindex "expansion" "string substitution"
10679 .cindex "&%sg%& expansion item"
10680 This item works like Perl's substitution operator (s) with the global (/g)
10681 option; hence its name. However, unlike the Perl equivalent, Exim does not
10682 modify the subject string; instead it returns the modified string for insertion
10683 into the overall expansion. The item takes three arguments: the subject string,
10684 a regular expression, and a substitution string. For example:
10685 .code
10686 ${sg{abcdefabcdef}{abc}{xyz}}
10687 .endd
10688 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10689 if any $, } or \ characters are required in the regular expression or in the
10690 substitution string, they have to be escaped. For example:
10691 .code
10692 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10693 .endd
10694 yields &"defabc"&, and
10695 .code
10696 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10697 .endd
10698 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10699 the regular expression from string expansion.
10700
10701 The regular expression is compiled in 8-bit mode, working against bytes
10702 rather than any Unicode-aware character handling.
10703
10704
10705 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10706 .cindex sorting "a list"
10707 .cindex list sorting
10708 .cindex expansion "list sorting"
10709 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10710 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10711 The <&'comparator'&> argument is interpreted as the operator
10712 of a two-argument expansion condition.
10713 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10714 The comparison should return true when applied to two values
10715 if the first value should sort before the second value.
10716 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10717 the element being placed in &$item$&,
10718 to give values for comparison.
10719
10720 The item result is a sorted list,
10721 with the original list separator,
10722 of the list elements (in full) of the original.
10723
10724 Examples:
10725 .code
10726 ${sort{3:2:1:4}{<}{$item}}
10727 .endd
10728 sorts a list of numbers, and
10729 .code
10730 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10731 .endd
10732 will sort an MX lookup into priority order.
10733
10734
10735
10736 .new
10737 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10738 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10739 .wen
10740
10741
10742
10743 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10744 .cindex "&%substr%& expansion item"
10745 .cindex "substring extraction"
10746 .cindex "expansion" "substring extraction"
10747 The three strings are expanded; the first two must yield numbers. Call them
10748 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10749 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10750 can use the simpler operator notation that avoids some of the braces:
10751 .code
10752 ${substr_<n>_<m>:<string>}
10753 .endd
10754 The second number is optional (in both notations).
10755 If it is absent in the simpler format, the preceding underscore must also be
10756 omitted.
10757
10758 The &%substr%& item can be used to extract more general substrings than
10759 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10760 length required. For example
10761 .code
10762 ${substr{3}{2}{$local_part}}
10763 .endd
10764 If the starting offset is greater than the string length the result is the
10765 null string; if the length plus starting offset is greater than the string
10766 length, the result is the right-hand part of the string, starting from the
10767 given offset. The first byte (character) in the string has offset zero.
10768
10769 The &%substr%& expansion item can take negative offset values to count
10770 from the right-hand end of its operand. The last byte (character) is offset -1,
10771 the second-last is offset -2, and so on. Thus, for example,
10772 .code
10773 ${substr{-5}{2}{1234567}}
10774 .endd
10775 yields &"34"&. If the absolute value of a negative offset is greater than the
10776 length of the string, the substring starts at the beginning of the string, and
10777 the length is reduced by the amount of overshoot. Thus, for example,
10778 .code
10779 ${substr{-5}{2}{12}}
10780 .endd
10781 yields an empty string, but
10782 .code
10783 ${substr{-3}{2}{12}}
10784 .endd
10785 yields &"1"&.
10786
10787 When the second number is omitted from &%substr%&, the remainder of the string
10788 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10789 string preceding the offset point are taken. For example, an offset of -1 and
10790 no length, as in these semantically identical examples:
10791 .code
10792 ${substr_-1:abcde}
10793 ${substr{-1}{abcde}}
10794 .endd
10795 yields all but the last character of the string, that is, &"abcd"&.
10796
10797 All measurement is done in bytes and is not UTF-8 aware.
10798
10799
10800
10801 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10802         {*&<&'replacements'&>&*}}*&"
10803 .cindex "expansion" "character translation"
10804 .cindex "&%tr%& expansion item"
10805 This item does single-character (in bytes) translation on its subject string. The second
10806 argument is a list of characters to be translated in the subject string. Each
10807 matching character is replaced by the corresponding character from the
10808 replacement list. For example
10809 .code
10810 ${tr{abcdea}{ac}{13}}
10811 .endd
10812 yields &`1b3de1`&. If there are duplicates in the second character string, the
10813 last occurrence is used. If the third string is shorter than the second, its
10814 last character is replicated. However, if it is empty, no translation takes
10815 place.
10816
10817 All character handling is done in bytes and is not UTF-8 aware.
10818
10819 .endlist
10820
10821
10822
10823 .section "Expansion operators" "SECTexpop"
10824 .cindex "expansion" "operators"
10825 For expansion items that perform transformations on a single argument string,
10826 the &"operator"& notation is used because it is simpler and uses fewer braces.
10827 The substring is first expanded before the operation is applied to it. The
10828 following operations can be performed:
10829
10830 .vlist
10831 .vitem &*${address:*&<&'string'&>&*}*&
10832 .cindex "expansion" "RFC 2822 address handling"
10833 .cindex "&%address%& expansion item"
10834 The string is interpreted as an RFC 2822 address, as it might appear in a
10835 header line, and the effective address is extracted from it. If the string does
10836 not parse successfully, the result is empty.
10837
10838 The parsing correctly handles SMTPUTF8 Unicode in the string.
10839
10840
10841 .vitem &*${addresses:*&<&'string'&>&*}*&
10842 .cindex "expansion" "RFC 2822 address handling"
10843 .cindex "&%addresses%& expansion item"
10844 The string (after expansion) is interpreted as a list of addresses in RFC
10845 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10846 operative address (&'local-part@domain'&) is extracted from each item, and the
10847 result of the expansion is a colon-separated list, with appropriate
10848 doubling of colons should any happen to be present in the email addresses.
10849 Syntactically invalid RFC2822 address items are omitted from the output.
10850
10851 It is possible to specify a character other than colon for the output
10852 separator by starting the string with > followed by the new separator
10853 character. For example:
10854 .code
10855 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10856 .endd
10857 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10858 first, so if the expanded string starts with >, it may change the output
10859 separator unintentionally. This can be avoided by setting the output
10860 separator explicitly:
10861 .code
10862 ${addresses:>:$h_from:}
10863 .endd
10864
10865 Compare the &%address%& (singular)
10866 expansion item, which extracts the working address from a single RFC2822
10867 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10868 processing lists.
10869
10870 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10871 a strict interpretation of header line formatting.  Exim parses the bare,
10872 unquoted portion of an email address and if it finds a comma, treats it as an
10873 email address separator. For the example header line:
10874 .code
10875 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10876 .endd
10877 The first example below demonstrates that Q-encoded email addresses are parsed
10878 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10879 It does not see the comma because it's still encoded as "=2C".  The second
10880 example below is passed the contents of &`$header_from:`&, meaning it gets
10881 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10882 The third example shows that the presence of a comma is skipped when it is
10883 quoted.  The fourth example shows SMTPUTF8 handling.
10884 .code
10885 # exim -be '${addresses:From: \
10886 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10887 user@example.com
10888 # exim -be '${addresses:From: Last, First <user@example.com>}'
10889 Last:user@example.com
10890 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10891 user@example.com
10892 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10893 フィリップ@example.jp
10894 .endd
10895
10896 .vitem &*${base32:*&<&'digits'&>&*}*&
10897 .cindex "&%base32%& expansion item"
10898 .cindex "expansion" "conversion to base 32"
10899 The string must consist entirely of decimal digits. The number is converted to
10900 base 32 and output as a (empty, for zero) string of characters.
10901 Only lowercase letters are used.
10902
10903 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10904 .cindex "&%base32d%& expansion item"
10905 .cindex "expansion" "conversion to base 32"
10906 The string must consist entirely of base-32 digits.
10907 The number is converted to decimal and output as a string.
10908
10909 .vitem &*${base62:*&<&'digits'&>&*}*&
10910 .cindex "&%base62%& expansion item"
10911 .cindex "expansion" "conversion to base 62"
10912 The string must consist entirely of decimal digits. The number is converted to
10913 base 62 and output as a string of six characters, including leading zeros. In
10914 the few operating environments where Exim uses base 36 instead of base 62 for
10915 its message identifiers (because those systems do not have case-sensitive
10916 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10917 to be absolutely clear: this is &'not'& base64 encoding.
10918
10919 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10920 .cindex "&%base62d%& expansion item"
10921 .cindex "expansion" "conversion to base 62"
10922 The string must consist entirely of base-62 digits, or, in operating
10923 environments where Exim uses base 36 instead of base 62 for its message
10924 identifiers, base-36 digits. The number is converted to decimal and output as a
10925 string.
10926
10927 .vitem &*${base64:*&<&'string'&>&*}*&
10928 .cindex "expansion" "base64 encoding"
10929 .cindex "base64 encoding" "in string expansion"
10930 .cindex "&%base64%& expansion item"
10931 .cindex certificate "base64 of DER"
10932 This operator converts a string into one that is base64 encoded.
10933
10934 If the string is a single variable of type certificate,
10935 returns the base64 encoding of the DER form of the certificate.
10936
10937
10938 .vitem &*${base64d:*&<&'string'&>&*}*&
10939 .cindex "expansion" "base64 decoding"
10940 .cindex "base64 decoding" "in string expansion"
10941 .cindex "&%base64d%& expansion item"
10942 This operator converts a base64-encoded string into the un-coded form.
10943
10944
10945 .vitem &*${domain:*&<&'string'&>&*}*&
10946 .cindex "domain" "extraction"
10947 .cindex "expansion" "domain extraction"
10948 The string is interpreted as an RFC 2822 address and the domain is extracted
10949 from it. If the string does not parse successfully, the result is empty.
10950
10951
10952 .vitem &*${escape:*&<&'string'&>&*}*&
10953 .cindex "expansion" "escaping non-printing characters"
10954 .cindex "&%escape%& expansion item"
10955 If the string contains any non-printing characters, they are converted to
10956 escape sequences starting with a backslash. Whether characters with the most
10957 significant bit set (so-called &"8-bit characters"&) count as printing or not
10958 is controlled by the &%print_topbitchars%& option.
10959
10960 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10961 .cindex "expansion" "escaping 8-bit characters"
10962 .cindex "&%escape8bit%& expansion item"
10963 If the string contains and characters with the most significant bit set,
10964 they are converted to escape sequences starting with a backslash.
10965 Backslashes and DEL characters are also converted.
10966
10967
10968 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10969 .cindex "expansion" "expression evaluation"
10970 .cindex "expansion" "arithmetic expression"
10971 .cindex "&%eval%& expansion item"
10972 These items supports simple arithmetic and bitwise logical operations in
10973 expansion strings. The string (after expansion) must be a conventional
10974 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10975 logical operators, and parentheses. All operations are carried out using
10976 integer arithmetic. The operator priorities are as follows (the same as in the
10977 C programming language):
10978 .table2 70pt 300pt
10979 .irow &'highest:'& "not (~), negate (-)"
10980 .irow ""   "multiply (*), divide (/), remainder (%)"
10981 .irow ""   "plus (+), minus (-)"
10982 .irow ""   "shift-left (<<), shift-right (>>)"
10983 .irow ""   "and (&&)"
10984 .irow ""   "xor (^)"
10985 .irow &'lowest:'&  "or (|)"
10986 .endtable
10987 Binary operators with the same priority are evaluated from left to right. White
10988 space is permitted before or after operators.
10989
10990 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10991 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10992 decimal, even if they start with a leading zero; hexadecimal numbers are not
10993 permitted. This can be useful when processing numbers extracted from dates or
10994 times, which often do have leading zeros.
10995
10996 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10997 or 1024*1024*1024,
10998 respectively. Negative numbers are supported. The result of the computation is
10999 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11000
11001 .display
11002 &`${eval:1+1}            `&  yields 2
11003 &`${eval:1+2*3}          `&  yields 7
11004 &`${eval:(1+2)*3}        `&  yields 9
11005 &`${eval:2+42%5}         `&  yields 4
11006 &`${eval:0xc&amp;5}          `&  yields 4
11007 &`${eval:0xc|5}          `&  yields 13
11008 &`${eval:0xc^5}          `&  yields 9
11009 &`${eval:0xc>>1}         `&  yields 6
11010 &`${eval:0xc<<1}         `&  yields 24
11011 &`${eval:~255&amp;0x1234}    `&  yields 4608
11012 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11013 .endd
11014
11015 As a more realistic example, in an ACL you might have
11016 .code
11017 deny   condition =                    \
11018          ${if and {                   \
11019            {>{$rcpt_count}{10}}       \
11020            {                          \
11021            <                          \
11022              {$recipients_count}      \
11023              {${eval:$rcpt_count/2}}  \
11024            }                          \
11025          }{yes}{no}}
11026        message = Too many bad recipients
11027 .endd
11028 The condition is true if there have been more than 10 RCPT commands and
11029 fewer than half of them have resulted in a valid recipient.
11030
11031
11032 .vitem &*${expand:*&<&'string'&>&*}*&
11033 .cindex "expansion" "re-expansion of substring"
11034 The &%expand%& operator causes a string to be expanded for a second time. For
11035 example,
11036 .code
11037 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11038 .endd
11039 first looks up a string in a file while expanding the operand for &%expand%&,
11040 and then re-expands what it has found.
11041
11042
11043 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11044 .cindex "Unicode"
11045 .cindex "UTF-8" "conversion from"
11046 .cindex "expansion" "UTF-8 conversion"
11047 .cindex "&%from_utf8%& expansion item"
11048 The world is slowly moving towards Unicode, although there are no standards for
11049 email yet. However, other applications (including some databases) are starting
11050 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11051 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11052 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11053 the result is an undefined sequence of bytes.
11054
11055 Unicode code points with values less than 256 are compatible with ASCII and
11056 ISO-8859-1 (also known as Latin-1).
11057 For example, character 169 is the copyright symbol in both cases, though the
11058 way it is encoded is different. In UTF-8, more than one byte is needed for
11059 characters with code values greater than 127, whereas ISO-8859-1 is a
11060 single-byte encoding (but thereby limited to 256 characters). This makes
11061 translation from UTF-8 to ISO-8859-1 straightforward.
11062
11063
11064 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11065 .cindex "hash function" "textual"
11066 .cindex "expansion" "textual hash"
11067 The &%hash%& operator is a simpler interface to the hashing function that can
11068 be used when the two parameters are fixed numbers (as opposed to strings that
11069 change when expanded). The effect is the same as
11070 .code
11071 ${hash{<n>}{<m>}{<string>}}
11072 .endd
11073 See the description of the general &%hash%& item above for details. The
11074 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11075
11076
11077
11078 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11079 .cindex "base64 encoding" "conversion from hex"
11080 .cindex "expansion" "hex to base64"
11081 .cindex "&%hex2b64%& expansion item"
11082 This operator converts a hex string into one that is base64 encoded. This can
11083 be useful for processing the output of the various hashing functions.
11084
11085
11086
11087 .vitem &*${hexquote:*&<&'string'&>&*}*&
11088 .cindex "quoting" "hex-encoded unprintable characters"
11089 .cindex "&%hexquote%& expansion item"
11090 This operator converts non-printable characters in a string into a hex
11091 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11092 as is, and other byte values are converted to &`\xNN`&, for example, a
11093 byte value 127 is converted to &`\x7f`&.
11094
11095
11096 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11097 .cindex "&%ipv6denorm%& expansion item"
11098 .cindex "IP address" normalisation
11099 This expands an IPv6 address to a full eight-element colon-separated set
11100 of hex digits including leading zeroes.
11101 A trailing ipv4-style dotted-decimal set is converted to hex.
11102 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11103
11104 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11105 .cindex "&%ipv6norm%& expansion item"
11106 .cindex "IP address" normalisation
11107 .cindex "IP address" "canonical form"
11108 This converts an IPv6 address to canonical form.
11109 Leading zeroes of groups are omitted, and the longest
11110 set of zero-valued groups is replaced with a double colon.
11111 A trailing ipv4-style dotted-decimal set is converted to hex.
11112 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11113
11114
11115 .vitem &*${lc:*&<&'string'&>&*}*&
11116 .cindex "case forcing in strings"
11117 .cindex "string" "case forcing"
11118 .cindex "lower casing"
11119 .cindex "expansion" "case forcing"
11120 .cindex "&%lc%& expansion item"
11121 This forces the letters in the string into lower-case, for example:
11122 .code
11123 ${lc:$local_part}
11124 .endd
11125 Case is defined per the system C locale.
11126
11127 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11128 .cindex "expansion" "string truncation"
11129 .cindex "&%length%& expansion item"
11130 The &%length%& operator is a simpler interface to the &%length%& function that
11131 can be used when the parameter is a fixed number (as opposed to a string that
11132 changes when expanded). The effect is the same as
11133 .code
11134 ${length{<number>}{<string>}}
11135 .endd
11136 See the description of the general &%length%& item above for details. Note that
11137 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11138 when &%length%& is used as an operator.
11139 All measurement is done in bytes and is not UTF-8 aware.
11140
11141
11142 .vitem &*${listcount:*&<&'string'&>&*}*&
11143 .cindex "expansion" "list item count"
11144 .cindex "list" "item count"
11145 .cindex "list" "count of items"
11146 .cindex "&%listcount%& expansion item"
11147 The string is interpreted as a list and the number of items is returned.
11148
11149
11150 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11151 .cindex "expansion" "named list"
11152 .cindex "&%listnamed%& expansion item"
11153 The name is interpreted as a named list and the content of the list is returned,
11154 expanding any referenced lists, re-quoting as needed for colon-separation.
11155 If the optional type is given it must be one of "a", "d", "h" or "l"
11156 and selects address-, domain-, host- or localpart- lists to search among respectively.
11157 Otherwise all types are searched in an undefined order and the first
11158 matching list is returned.
11159
11160
11161 .vitem &*${local_part:*&<&'string'&>&*}*&
11162 .cindex "expansion" "local part extraction"
11163 .cindex "&%local_part%& expansion item"
11164 The string is interpreted as an RFC 2822 address and the local part is
11165 extracted from it. If the string does not parse successfully, the result is
11166 empty.
11167 The parsing correctly handles SMTPUTF8 Unicode in the string.
11168
11169
11170 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11171 .cindex "masked IP address"
11172 .cindex "IP address" "masking"
11173 .cindex "CIDR notation"
11174 .cindex "expansion" "IP address masking"
11175 .cindex "&%mask%& expansion item"
11176 If the form of the string to be operated on is not an IP address followed by a
11177 slash and an integer (that is, a network address in CIDR notation), the
11178 expansion fails. Otherwise, this operator converts the IP address to binary,
11179 masks off the least significant bits according to the bit count, and converts
11180 the result back to text, with mask appended. For example,
11181 .code
11182 ${mask:10.111.131.206/28}
11183 .endd
11184 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11185 be mostly used for looking up masked addresses in files, the result for an IPv6
11186 address uses dots to separate components instead of colons, because colon
11187 terminates a key string in lsearch files. So, for example,
11188 .code
11189 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11190 .endd
11191 returns the string
11192 .code
11193 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11194 .endd
11195 Letters in IPv6 addresses are always output in lower case.
11196
11197
11198 .vitem &*${md5:*&<&'string'&>&*}*&
11199 .cindex "MD5 hash"
11200 .cindex "expansion" "MD5 hash"
11201 .cindex certificate fingerprint
11202 .cindex "&%md5%& expansion item"
11203 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11204 as a 32-digit hexadecimal number, in which any letters are in lower case.
11205
11206 If the string is a single variable of type certificate,
11207 returns the MD5 hash fingerprint of the certificate.
11208
11209
11210 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11211 .cindex "expansion" "numeric hash"
11212 .cindex "hash function" "numeric"
11213 The &%nhash%& operator is a simpler interface to the numeric hashing function
11214 that can be used when the two parameters are fixed numbers (as opposed to
11215 strings that change when expanded). The effect is the same as
11216 .code
11217 ${nhash{<n>}{<m>}{<string>}}
11218 .endd
11219 See the description of the general &%nhash%& item above for details.
11220
11221
11222 .vitem &*${quote:*&<&'string'&>&*}*&
11223 .cindex "quoting" "in string expansions"
11224 .cindex "expansion" "quoting"
11225 .cindex "&%quote%& expansion item"
11226 The &%quote%& operator puts its argument into double quotes if it
11227 is an empty string or
11228 contains anything other than letters, digits, underscores, dots, and hyphens.
11229 Any occurrences of double quotes and backslashes are escaped with a backslash.
11230 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11231 respectively For example,
11232 .code
11233 ${quote:ab"*"cd}
11234 .endd
11235 becomes
11236 .code
11237 "ab\"*\"cd"
11238 .endd
11239 The place where this is useful is when the argument is a substitution from a
11240 variable or a message header.
11241
11242 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11243 .cindex "&%quote_local_part%& expansion item"
11244 This operator is like &%quote%&, except that it quotes the string only if
11245 required to do so by the rules of RFC 2822 for quoting local parts. For
11246 example, a plus sign would not cause quoting (but it would for &%quote%&).
11247 If you are creating a new email address from the contents of &$local_part$&
11248 (or any other unknown data), you should always use this operator.
11249
11250 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11251 will likely use the quoting form.
11252 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11253
11254
11255 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11256 .cindex "quoting" "lookup-specific"
11257 This operator applies lookup-specific quoting rules to the string. Each
11258 query-style lookup type has its own quoting rules which are described with
11259 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11260 .code
11261 ${quote_ldap:two * two}
11262 .endd
11263 returns
11264 .code
11265 two%20%5C2A%20two
11266 .endd
11267 For single-key lookup types, no quoting is ever necessary and this operator
11268 yields an unchanged string.
11269
11270
11271 .vitem &*${randint:*&<&'n'&>&*}*&
11272 .cindex "random number"
11273 This operator returns a somewhat random number which is less than the
11274 supplied number and is at least 0.  The quality of this randomness depends
11275 on how Exim was built; the values are not suitable for keying material.
11276 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11277 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11278 for versions of GnuTLS with that function.
11279 Otherwise, the implementation may be arc4random(), random() seeded by
11280 srandomdev() or srandom(), or a custom implementation even weaker than
11281 random().
11282
11283
11284 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11285 .cindex "expansion" "IP address"
11286 This operator reverses an IP address; for IPv4 addresses, the result is in
11287 dotted-quad decimal form, while for IPv6 addresses the result is in
11288 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11289 for DNS.  For example,
11290 .code
11291 ${reverse_ip:192.0.2.4}
11292 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11293 .endd
11294 returns
11295 .code
11296 4.2.0.192
11297 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
11298 .endd
11299
11300
11301 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11302 .cindex "expansion" "RFC 2047"
11303 .cindex "RFC 2047" "expansion operator"
11304 .cindex "&%rfc2047%& expansion item"
11305 This operator encodes text according to the rules of RFC 2047. This is an
11306 encoding that is used in header lines to encode non-ASCII characters. It is
11307 assumed that the input string is in the encoding specified by the
11308 &%headers_charset%& option, which gets its default at build time. If the string
11309 contains only characters in the range 33&--126, and no instances of the
11310 characters
11311 .code
11312 ? = ( ) < > @ , ; : \ " . [ ] _
11313 .endd
11314 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11315 string, using as many &"encoded words"& as necessary to encode all the
11316 characters.
11317
11318
11319 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11320 .cindex "expansion" "RFC 2047"
11321 .cindex "RFC 2047" "decoding"
11322 .cindex "&%rfc2047d%& expansion item"
11323 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11324 bytes are replaced by question marks. Characters are converted into the
11325 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11326 not recognized unless &%check_rfc2047_length%& is set false.
11327
11328 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11329 access a header line, RFC 2047 decoding is done automatically. You do not need
11330 to use this operator as well.
11331
11332
11333
11334 .vitem &*${rxquote:*&<&'string'&>&*}*&
11335 .cindex "quoting" "in regular expressions"
11336 .cindex "regular expressions" "quoting"
11337 .cindex "&%rxquote%& expansion item"
11338 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11339 characters in its argument. This is useful when substituting the values of
11340 variables or headers inside regular expressions.
11341
11342
11343 .vitem &*${sha1:*&<&'string'&>&*}*&
11344 .cindex "SHA-1 hash"
11345 .cindex "expansion" "SHA-1 hashing"
11346 .cindex certificate fingerprint
11347 .cindex "&%sha1%& expansion item"
11348 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11349 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11350
11351 If the string is a single variable of type certificate,
11352 returns the SHA-1 hash fingerprint of the certificate.
11353
11354
11355 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11356        &*${sha2:*&<&'string'&>&*}*& &&&
11357        &*${sha2_<n>:*&<&'string'&>&*}*&
11358 .cindex "SHA-256 hash"
11359 .cindex "SHA-2 hash"
11360 .cindex certificate fingerprint
11361 .cindex "expansion" "SHA-256 hashing"
11362 .cindex "&%sha256%& expansion item"
11363 .cindex "&%sha2%& expansion item"
11364 The &%sha256%& operator computes the SHA-256 hash value of the string
11365 and returns
11366 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11367
11368 If the string is a single variable of type certificate,
11369 returns the SHA-256 hash fingerprint of the certificate.
11370
11371 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11372 (except for certificates, which are not supported).
11373 Finally, if an underbar
11374 and a number is appended it specifies the output length, selecting a
11375 member of the SHA-2 family of hash functions.
11376 Values of 256, 384 and 512 are accepted, with 256 being the default.
11377
11378
11379 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11380        &*${sha3_<n>:*&<&'string'&>&*}*&
11381 .cindex "SHA3 hash"
11382 .cindex "expansion" "SHA3 hashing"
11383 .cindex "&%sha3%& expansion item"
11384 The &%sha3%& operator computes the SHA3-256 hash value of the string
11385 and returns
11386 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11387
11388 If a number is appended, separated by an underbar, it specifies
11389 the output length.  Values of 224, 256, 384 and 512 are accepted;
11390 with 256 being the default.
11391
11392 The &%sha3%& expansion item is only supported if Exim has been
11393 compiled with GnuTLS 3.5.0 or later,
11394 or OpenSSL 1.1.1 or later.
11395 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11396
11397
11398 .vitem &*${stat:*&<&'string'&>&*}*&
11399 .cindex "expansion" "statting a file"
11400 .cindex "file" "extracting characteristics"
11401 .cindex "&%stat%& expansion item"
11402 The string, after expansion, must be a file path. A call to the &[stat()]&
11403 function is made for this path. If &[stat()]& fails, an error occurs and the
11404 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11405 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11406 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11407 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11408 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11409 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11410 can extract individual fields using the &%extract%& expansion item.
11411
11412 The use of the &%stat%& expansion in users' filter files can be locked out by
11413 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11414 systems for files larger than 2GB.
11415
11416 .vitem &*${str2b64:*&<&'string'&>&*}*&
11417 .cindex "&%str2b64%& expansion item"
11418 Now deprecated, a synonym for the &%base64%& expansion operator.
11419
11420
11421
11422 .vitem &*${strlen:*&<&'string'&>&*}*&
11423 .cindex "expansion" "string length"
11424 .cindex "string" "length in expansion"
11425 .cindex "&%strlen%& expansion item"
11426 The item is replace by the length of the expanded string, expressed as a
11427 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11428 All measurement is done in bytes and is not UTF-8 aware.
11429
11430
11431 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11432 .cindex "&%substr%& expansion item"
11433 .cindex "substring extraction"
11434 .cindex "expansion" "substring expansion"
11435 The &%substr%& operator is a simpler interface to the &%substr%& function that
11436 can be used when the two parameters are fixed numbers (as opposed to strings
11437 that change when expanded). The effect is the same as
11438 .code
11439 ${substr{<start>}{<length>}{<string>}}
11440 .endd
11441 See the description of the general &%substr%& item above for details. The
11442 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11443 All measurement is done in bytes and is not UTF-8 aware.
11444
11445 .vitem &*${time_eval:*&<&'string'&>&*}*&
11446 .cindex "&%time_eval%& expansion item"
11447 .cindex "time interval" "decoding"
11448 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11449 seconds.
11450
11451 .vitem &*${time_interval:*&<&'string'&>&*}*&
11452 .cindex "&%time_interval%& expansion item"
11453 .cindex "time interval" "formatting"
11454 The argument (after sub-expansion) must be a sequence of decimal digits that
11455 represents an interval of time as a number of seconds. It is converted into a
11456 number of larger units and output in Exim's normal time format, for example,
11457 &`1w3d4h2m6s`&.
11458
11459 .vitem &*${uc:*&<&'string'&>&*}*&
11460 .cindex "case forcing in strings"
11461 .cindex "string" "case forcing"
11462 .cindex "upper casing"
11463 .cindex "expansion" "case forcing"
11464 .cindex "&%uc%& expansion item"
11465 This forces the letters in the string into upper-case.
11466 Case is defined per the system C locale.
11467
11468 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11469 .cindex "correction of invalid utf-8 sequences in strings"
11470 .cindex "utf-8" "utf-8 sequences"
11471 .cindex "incorrect utf-8"
11472 .cindex "expansion" "utf-8 forcing"
11473 .cindex "&%utf8clean%& expansion item"
11474 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11475 In versions of Exim before 4.92, this did not correctly do so for a truncated
11476 final codepoint's encoding, and the character would be silently dropped.
11477 If you must handle detection of this scenario across both sets of Exim behavior,
11478 the complexity will depend upon the task.
11479 For instance, to detect if the first character is multibyte and a 1-byte
11480 extraction can be successfully used as a path component (as is common for
11481 dividing up delivery folders), you might use:
11482 .code
11483 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11484 .endd
11485 (which will false-positive if the first character of the local part is a
11486 literal question mark).
11487
11488 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11489        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11490        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11491        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11492 .cindex expansion UTF-8
11493 .cindex UTF-8 expansion
11494 .cindex EAI
11495 .cindex internationalisation
11496 .cindex "&%utf8_domain_to_alabel%& expansion item"
11497 .cindex "&%utf8_domain_from_alabel%& expansion item"
11498 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11499 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11500 These convert EAI mail name components between UTF-8 and a-label forms.
11501 For information on internationalisation support see &<<SECTi18nMTA>>&.
11502 .endlist
11503
11504
11505
11506
11507
11508
11509 .section "Expansion conditions" "SECTexpcond"
11510 .scindex IIDexpcond "expansion" "conditions"
11511 The following conditions are available for testing by the &%${if%& construct
11512 while expanding strings:
11513
11514 .vlist
11515 .vitem &*!*&<&'condition'&>
11516 .cindex "expansion" "negating a condition"
11517 .cindex "negation" "in expansion condition"
11518 Preceding any condition with an exclamation mark negates the result of the
11519 condition.
11520
11521 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11522 .cindex "numeric comparison"
11523 .cindex "expansion" "numeric comparison"
11524 There are a number of symbolic operators for doing numeric comparisons. They
11525 are:
11526 .display
11527 &`=   `&   equal
11528 &`==  `&   equal
11529 &`>   `&   greater
11530 &`>=  `&   greater or equal
11531 &`<   `&   less
11532 &`<=  `&   less or equal
11533 .endd
11534 For example:
11535 .code
11536 ${if >{$message_size}{10M} ...
11537 .endd
11538 Note that the general negation operator provides for inequality testing. The
11539 two strings must take the form of optionally signed decimal integers,
11540 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11541 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11542 As a special case, the numerical value of an empty string is taken as
11543 zero.
11544
11545 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11546 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11547 10M, not if 10M is larger than &$message_size$&.
11548
11549
11550 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11551         {*&<&'arg2'&>&*}...}*&
11552 .cindex "expansion" "calling an acl"
11553 .cindex "&%acl%&" "expansion condition"
11554 The name and zero to nine argument strings are first expanded separately.  The expanded
11555 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11556 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11557 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11558 and may use the variables; if another acl expansion is used the values
11559 are restored after it returns.  If the ACL sets
11560 a value using a "message =" modifier the variable $value becomes
11561 the result of the expansion, otherwise it is empty.
11562 If the ACL returns accept the condition is true; if deny, false.
11563 If the ACL returns defer the result is a forced-fail.
11564
11565 .vitem &*bool&~{*&<&'string'&>&*}*&
11566 .cindex "expansion" "boolean parsing"
11567 .cindex "&%bool%& expansion condition"
11568 This condition turns a string holding a true or false representation into
11569 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11570 (case-insensitively); also integer numbers map to true if non-zero,
11571 false if zero.
11572 An empty string is treated as false.
11573 Leading and trailing whitespace is ignored;
11574 thus a string consisting only of whitespace is false.
11575 All other string values will result in expansion failure.
11576
11577 When combined with ACL variables, this expansion condition will let you
11578 make decisions in one place and act on those decisions in another place.
11579 For example:
11580 .code
11581 ${if bool{$acl_m_privileged_sender} ...
11582 .endd
11583
11584
11585 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11586 .cindex "expansion" "boolean parsing"
11587 .cindex "&%bool_lax%& expansion condition"
11588 Like &%bool%&, this condition turns a string into a boolean state.  But
11589 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11590 loose definition that the Router &%condition%& option uses.  The empty string
11591 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11592 true.  Leading and trailing whitespace is ignored.
11593
11594 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11595
11596 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11597 .cindex "expansion" "encrypted comparison"
11598 .cindex "encrypted strings, comparing"
11599 .cindex "&%crypteq%& expansion condition"
11600 This condition is included in the Exim binary if it is built to support any
11601 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11602 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11603 included in the binary.
11604
11605 The &%crypteq%& condition has two arguments. The first is encrypted and
11606 compared against the second, which is already encrypted. The second string may
11607 be in the LDAP form for storing encrypted strings, which starts with the
11608 encryption type in curly brackets, followed by the data. If the second string
11609 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11610 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11611 Typically this will be a field from a password file. An example of an encrypted
11612 string in LDAP form is:
11613 .code
11614 {md5}CY9rzUYh03PK3k6DJie09g==
11615 .endd
11616 If such a string appears directly in an expansion, the curly brackets have to
11617 be quoted, because they are part of the expansion syntax. For example:
11618 .code
11619 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11620 .endd
11621 The following encryption types (whose names are matched case-independently) are
11622 supported:
11623
11624 .ilist
11625 .cindex "MD5 hash"
11626 .cindex "base64 encoding" "in encrypted password"
11627 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11628 printable characters to compare with the remainder of the second string. If the
11629 length of the comparison string is 24, Exim assumes that it is base64 encoded
11630 (as in the above example). If the length is 32, Exim assumes that it is a
11631 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11632 comparison fails.
11633
11634 .next
11635 .cindex "SHA-1 hash"
11636 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11637 printable characters to compare with the remainder of the second string. If the
11638 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11639 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11640 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11641
11642 .next
11643 .cindex "&[crypt()]&"
11644 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11645 only the first eight characters of the password. However, in modern operating
11646 systems this is no longer true, and in many cases the entire password is used,
11647 whatever its length.
11648
11649 .next
11650 .cindex "&[crypt16()]&"
11651 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11652 use up to 16 characters of the password in some operating systems. Again, in
11653 modern operating systems, more characters may be used.
11654 .endlist
11655 Exim has its own version of &[crypt16()]&, which is just a double call to
11656 &[crypt()]&. For operating systems that have their own version, setting
11657 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11658 operating system version instead of its own. This option is set by default in
11659 the OS-dependent &_Makefile_& for those operating systems that are known to
11660 support &[crypt16()]&.
11661
11662 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11663 it was not using the same algorithm as some operating systems' versions. It
11664 turns out that as well as &[crypt16()]& there is a function called
11665 &[bigcrypt()]& in some operating systems. This may or may not use the same
11666 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11667
11668 However, since there is now a move away from the traditional &[crypt()]&
11669 functions towards using SHA1 and other algorithms, tidying up this area of
11670 Exim is seen as very low priority.
11671
11672 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11673 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11674 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11675 default is &`{crypt}`&. Whatever the default, you can always use either
11676 function by specifying it explicitly in curly brackets.
11677
11678 .vitem &*def:*&<&'variable&~name'&>
11679 .cindex "expansion" "checking for empty variable"
11680 .cindex "&%def%& expansion condition"
11681 The &%def%& condition must be followed by the name of one of the expansion
11682 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11683 variable does not contain the empty string. For example:
11684 .code
11685 ${if def:sender_ident {from $sender_ident}}
11686 .endd
11687 Note that the variable name is given without a leading &%$%& character. If the
11688 variable does not exist, the expansion fails.
11689
11690 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11691         &~&*def:h_*&<&'header&~name'&>&*:*&"
11692 .cindex "expansion" "checking header line existence"
11693 This condition is true if a message is being processed and the named header
11694 exists in the message. For example,
11695 .code
11696 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11697 .endd
11698 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11699 the header name must be terminated by a colon if white space does not follow.
11700
11701 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11702        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11703 .cindex "string" "comparison"
11704 .cindex "expansion" "string comparison"
11705 .cindex "&%eq%& expansion condition"
11706 .cindex "&%eqi%& expansion condition"
11707 The two substrings are first expanded. The condition is true if the two
11708 resulting strings are identical. For &%eq%& the comparison includes the case of
11709 letters, whereas for &%eqi%& the comparison is case-independent, where
11710 case is defined per the system C locale.
11711
11712 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11713 .cindex "expansion" "file existence test"
11714 .cindex "file" "existence test"
11715 .cindex "&%exists%&, expansion condition"
11716 The substring is first expanded and then interpreted as an absolute path. The
11717 condition is true if the named file (or directory) exists. The existence test
11718 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11719 users' filter files may be locked out by the system administrator.
11720
11721 .new
11722 &*Note:*& Testing a path using this condition is not a sufficient way of
11723 de-tainting it.
11724 .wen
11725
11726 .vitem &*first_delivery*&
11727 .cindex "delivery" "first"
11728 .cindex "first delivery"
11729 .cindex "expansion" "first delivery test"
11730 .cindex "&%first_delivery%& expansion condition"
11731 This condition, which has no data, is true during a message's first delivery
11732 attempt. It is false during any subsequent delivery attempts.
11733
11734
11735 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11736        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11737 .cindex "list" "iterative conditions"
11738 .cindex "expansion" "&*forall*& condition"
11739 .cindex "expansion" "&*forany*& condition"
11740 .vindex "&$item$&"
11741 These conditions iterate over a list. The first argument is expanded to form
11742 the list. By default, the list separator is a colon, but it can be changed by
11743 the normal method (&<<SECTlistsepchange>>&).
11744 The second argument is interpreted as a condition that is to
11745 be applied to each item in the list in turn. During the interpretation of the
11746 condition, the current list item is placed in a variable called &$item$&.
11747 .ilist
11748 For &*forany*&, interpretation stops if the condition is true for any item, and
11749 the result of the whole condition is true. If the condition is false for all
11750 items in the list, the overall condition is false.
11751 .next
11752 For &*forall*&, interpretation stops if the condition is false for any item,
11753 and the result of the whole condition is false. If the condition is true for
11754 all items in the list, the overall condition is true.
11755 .endlist
11756 Note that negation of &*forany*& means that the condition must be false for all
11757 items for the overall condition to succeed, and negation of &*forall*& means
11758 that the condition must be false for at least one item. In this example, the
11759 list separator is changed to a comma:
11760 .code
11761 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11762 .endd
11763 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11764 being processed, to enable these expansion items to be nested.
11765
11766 To scan a named list, expand it with the &*listnamed*& operator.
11767
11768 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11769        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11770        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11771        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11772 .cindex JSON "iterative conditions"
11773 .cindex JSON expansions
11774 .cindex expansion "&*forall_json*& condition"
11775 .cindex expansion "&*forany_json*& condition"
11776 .cindex expansion "&*forall_jsons*& condition"
11777 .cindex expansion "&*forany_jsons*& condition"
11778 As for the above, except that the first argument must, after expansion,
11779 be a JSON array.
11780 The array separator is not changeable.
11781 For the &"jsons"& variants the elements are expected to be JSON strings
11782 and have their quotes removed before the evaluation of the condition.
11783
11784
11785
11786 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11787        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11788 .cindex "string" "comparison"
11789 .cindex "expansion" "string comparison"
11790 .cindex "&%ge%& expansion condition"
11791 .cindex "&%gei%& expansion condition"
11792 The two substrings are first expanded. The condition is true if the first
11793 string is lexically greater than or equal to the second string. For &%ge%& the
11794 comparison includes the case of letters, whereas for &%gei%& the comparison is
11795 case-independent.
11796 Case and collation order are defined per the system C locale.
11797
11798 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11799        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11800 .cindex "string" "comparison"
11801 .cindex "expansion" "string comparison"
11802 .cindex "&%gt%& expansion condition"
11803 .cindex "&%gti%& expansion condition"
11804 The two substrings are first expanded. The condition is true if the first
11805 string is lexically greater than the second string. For &%gt%& the comparison
11806 includes the case of letters, whereas for &%gti%& the comparison is
11807 case-independent.
11808 Case and collation order are defined per the system C locale.
11809
11810
11811 .new
11812 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11813 SRS decode.  See SECT &<<SECTSRS>>& for details.
11814 .wen
11815
11816
11817 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11818        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11819 .cindex "string" "comparison"
11820 .cindex "list" "iterative conditions"
11821 Both strings are expanded; the second string is treated as a list of simple
11822 strings; if the first string is a member of the second, then the condition
11823 is true.
11824 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11825
11826 These are simpler to use versions of the more powerful &*forany*& condition.
11827 Examples, and the &*forany*& equivalents:
11828 .code
11829 ${if inlist{needle}{foo:needle:bar}}
11830   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11831 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11832   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11833 .endd
11834
11835 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11836        &*isip4&~{*&<&'string'&>&*}*& &&&
11837        &*isip6&~{*&<&'string'&>&*}*&
11838 .cindex "IP address" "testing string format"
11839 .cindex "string" "testing for IP address"
11840 .cindex "&%isip%& expansion condition"
11841 .cindex "&%isip4%& expansion condition"
11842 .cindex "&%isip6%& expansion condition"
11843 The substring is first expanded, and then tested to see if it has the form of
11844 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11845 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11846
11847 For an IPv4 address, the test is for four dot-separated components, each of
11848 which consists of from one to three digits. For an IPv6 address, up to eight
11849 colon-separated components are permitted, each containing from one to four
11850 hexadecimal digits. There may be fewer than eight components if an empty
11851 component (adjacent colons) is present. Only one empty component is permitted.
11852
11853 &*Note*&: The checks used to be just on the form of the address; actual numerical
11854 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11855 check.
11856 This is no longer the case.
11857
11858 The main use of these tests is to distinguish between IP addresses and
11859 host names, or between IPv4 and IPv6 addresses. For example, you could use
11860 .code
11861 ${if isip4{$sender_host_address}...
11862 .endd
11863 to test which IP version an incoming SMTP connection is using.
11864
11865 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11866 .cindex "LDAP" "use for authentication"
11867 .cindex "expansion" "LDAP authentication test"
11868 .cindex "&%ldapauth%& expansion condition"
11869 This condition supports user authentication using LDAP. See section
11870 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11871 queries. For this use, the query must contain a user name and password. The
11872 query itself is not used, and can be empty. The condition is true if the
11873 password is not empty, and the user name and password are accepted by the LDAP
11874 server. An empty password is rejected without calling LDAP because LDAP binds
11875 with an empty password are considered anonymous regardless of the username, and
11876 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11877 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11878 this can be used.
11879
11880
11881 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11882        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11883 .cindex "string" "comparison"
11884 .cindex "expansion" "string comparison"
11885 .cindex "&%le%& expansion condition"
11886 .cindex "&%lei%& expansion condition"
11887 The two substrings are first expanded. The condition is true if the first
11888 string is lexically less than or equal to the second string. For &%le%& the
11889 comparison includes the case of letters, whereas for &%lei%& the comparison is
11890 case-independent.
11891 Case and collation order are defined per the system C locale.
11892
11893 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11894        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11895 .cindex "string" "comparison"
11896 .cindex "expansion" "string comparison"
11897 .cindex "&%lt%& expansion condition"
11898 .cindex "&%lti%& expansion condition"
11899 The two substrings are first expanded. The condition is true if the first
11900 string is lexically less than the second string. For &%lt%& the comparison
11901 includes the case of letters, whereas for &%lti%& the comparison is
11902 case-independent.
11903 Case and collation order are defined per the system C locale.
11904
11905
11906 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11907 .cindex "expansion" "regular expression comparison"
11908 .cindex "regular expressions" "match in expanded string"
11909 .cindex "&%match%& expansion condition"
11910 The two substrings are first expanded. The second is then treated as a regular
11911 expression and applied to the first. Because of the pre-expansion, if the
11912 regular expression contains dollar, or backslash characters, they must be
11913 escaped. Care must also be taken if the regular expression contains braces
11914 (curly brackets). A closing brace must be escaped so that it is not taken as a
11915 premature termination of <&'string2'&>. The easiest approach is to use the
11916 &`\N`& feature to disable expansion of the regular expression.
11917 For example,
11918 .code
11919 ${if match {$local_part}{\N^\d{3}\N} ...
11920 .endd
11921 If the whole expansion string is in double quotes, further escaping of
11922 backslashes is also required.
11923
11924 The condition is true if the regular expression match succeeds.
11925 The regular expression is not required to begin with a circumflex
11926 metacharacter, but if there is no circumflex, the expression is not anchored,
11927 and it may match anywhere in the subject, not just at the start. If you want
11928 the pattern to match at the end of the subject, you must include the &`$`&
11929 metacharacter at an appropriate point.
11930 All character handling is done in bytes and is not UTF-8 aware,
11931 but we might change this in a future Exim release.
11932
11933 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11934 At the start of an &%if%& expansion the values of the numeric variable
11935 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11936 succeeds causes them to be reset to the substrings of that condition and they
11937 will have these values during the expansion of the success string. At the end
11938 of the &%if%& expansion, the previous values are restored. After testing a
11939 combination of conditions using &%or%&, the subsequent values of the numeric
11940 variables are those of the condition that succeeded.
11941
11942 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11943 .cindex "&%match_address%& expansion condition"
11944 See &*match_local_part*&.
11945
11946 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11947 .cindex "&%match_domain%& expansion condition"
11948 See &*match_local_part*&.
11949
11950 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11951 .cindex "&%match_ip%& expansion condition"
11952 This condition matches an IP address to a list of IP address patterns. It must
11953 be followed by two argument strings. The first (after expansion) must be an IP
11954 address or an empty string. The second (not expanded) is a restricted host
11955 list that can match only an IP address, not a host name. For example:
11956 .code
11957 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11958 .endd
11959 The specific types of host list item that are permitted in the list are:
11960
11961 .ilist
11962 An IP address, optionally with a CIDR mask.
11963 .next
11964 A single asterisk, which matches any IP address.
11965 .next
11966 An empty item, which matches only if the IP address is empty. This could be
11967 useful for testing for a locally submitted message or one from specific hosts
11968 in a single test such as
11969 . ==== As this is a nested list, any displays it contains must be indented
11970 . ==== as otherwise they are too far to the left. This comment applies to
11971 . ==== the use of xmlto plus fop. There's no problem when formatting with
11972 . ==== sdop, with or without the extra indent.
11973 .code
11974   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11975 .endd
11976 where the first item in the list is the empty string.
11977 .next
11978 The item @[] matches any of the local host's interface addresses.
11979 .next
11980 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11981 even if &`net-`& is not specified. There is never any attempt to turn the IP
11982 address into a host name. The most common type of linear search for
11983 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11984 masks. For example:
11985 .code
11986   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11987 .endd
11988 It is of course possible to use other kinds of lookup, and in such a case, you
11989 do need to specify the &`net-`& prefix if you want to specify a specific
11990 address mask, for example:
11991 .code
11992   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11993 .endd
11994 However, unless you are combining a &%match_ip%& condition with others, it is
11995 just as easy to use the fact that a lookup is itself a condition, and write:
11996 .code
11997   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11998 .endd
11999 .endlist ilist
12000
12001 Note that <&'string2'&> is not itself subject to string expansion, unless
12002 Exim was built with the EXPAND_LISTMATCH_RHS option.
12003
12004 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12005
12006 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12007 .cindex "domain list" "in expansion condition"
12008 .cindex "address list" "in expansion condition"
12009 .cindex "local part" "list, in expansion condition"
12010 .cindex "&%match_local_part%& expansion condition"
12011 This condition, together with &%match_address%& and &%match_domain%&, make it
12012 possible to test domain, address, and local part lists within expansions. Each
12013 condition requires two arguments: an item and a list to match. A trivial
12014 example is:
12015 .code
12016 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12017 .endd
12018 In each case, the second argument may contain any of the allowable items for a
12019 list of the appropriate type. Also, because the second argument
12020 is a standard form of list, it is possible to refer to a named list.
12021 Thus, you can use conditions like this:
12022 .code
12023 ${if match_domain{$domain}{+local_domains}{...
12024 .endd
12025 .cindex "&`+caseful`&"
12026 For address lists, the matching starts off caselessly, but the &`+caseful`&
12027 item can be used, as in all address lists, to cause subsequent items to
12028 have their local parts matched casefully. Domains are always matched
12029 caselessly.
12030
12031 Note that <&'string2'&> is not itself subject to string expansion, unless
12032 Exim was built with the EXPAND_LISTMATCH_RHS option.
12033
12034 &*Note*&: Host lists are &'not'& supported in this way. This is because
12035 hosts have two identities: a name and an IP address, and it is not clear
12036 how to specify cleanly how such a test would work. However, IP addresses can be
12037 matched using &%match_ip%&.
12038
12039 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12040 .cindex "PAM authentication"
12041 .cindex "AUTH" "with PAM"
12042 .cindex "Solaris" "PAM support"
12043 .cindex "expansion" "PAM authentication test"
12044 .cindex "&%pam%& expansion condition"
12045 &'Pluggable Authentication Modules'&
12046 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12047 available in the latest releases of Solaris and in some GNU/Linux
12048 distributions. The Exim support, which is intended for use in conjunction with
12049 the SMTP AUTH command, is available only if Exim is compiled with
12050 .code
12051 SUPPORT_PAM=yes
12052 .endd
12053 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12054 in some releases of GNU/Linux &%-ldl%& is also needed.
12055
12056 The argument string is first expanded, and the result must be a
12057 colon-separated list of strings. Leading and trailing white space is ignored.
12058 The PAM module is initialized with the service name &"exim"& and the user name
12059 taken from the first item in the colon-separated data string (<&'string1'&>).
12060 The remaining items in the data string are passed over in response to requests
12061 from the authentication function. In the simple case there will only be one
12062 request, for a password, so the data consists of just two strings.
12063
12064 There can be problems if any of the strings are permitted to contain colon
12065 characters. In the usual way, these have to be doubled to avoid being taken as
12066 separators.
12067 The &%listquote%& expansion item can be used for this.
12068 For example, the configuration
12069 of a LOGIN authenticator might contain this setting:
12070 .code
12071 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12072 .endd
12073 In some operating systems, PAM authentication can be done only from a process
12074 running as root. Since Exim is running as the Exim user when receiving
12075 messages, this means that PAM cannot be used directly in those systems.
12076 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12077
12078
12079 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12080 .cindex "&'pwcheck'& daemon"
12081 .cindex "Cyrus"
12082 .cindex "expansion" "&'pwcheck'& authentication test"
12083 .cindex "&%pwcheck%& expansion condition"
12084 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12085 This is one way of making it possible for passwords to be checked by a process
12086 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12087 deprecated. Its replacement is &'saslauthd'& (see below).
12088
12089 The pwcheck support is not included in Exim by default. You need to specify
12090 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12091 building Exim. For example:
12092 .code
12093 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12094 .endd
12095 You do not need to install the full Cyrus software suite in order to use
12096 the pwcheck daemon. You can compile and install just the daemon alone
12097 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12098 access to the &_/var/pwcheck_& directory.
12099
12100 The &%pwcheck%& condition takes one argument, which must be the user name and
12101 password, separated by a colon. For example, in a LOGIN authenticator
12102 configuration, you might have this:
12103 .code
12104 server_condition = ${if pwcheck{$auth1:$auth2}}
12105 .endd
12106 Again, for a PLAIN authenticator configuration, this would be:
12107 .code
12108 server_condition = ${if pwcheck{$auth2:$auth3}}
12109 .endd
12110 .vitem &*queue_running*&
12111 .cindex "queue runner" "detecting when delivering from"
12112 .cindex "expansion" "queue runner test"
12113 .cindex "&%queue_running%& expansion condition"
12114 This condition, which has no data, is true during delivery attempts that are
12115 initiated by queue runner processes, and false otherwise.
12116
12117
12118 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12119 .cindex "Radius"
12120 .cindex "expansion" "Radius authentication"
12121 .cindex "&%radius%& expansion condition"
12122 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12123 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12124 the Radius client configuration file in order to build Exim with Radius
12125 support.
12126
12127 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12128 library, using the original API. If you are using release 0.4.0 or later of
12129 this library, you need to set
12130 .code
12131 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12132 .endd
12133 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12134 &%libradius%& library that comes with FreeBSD. To do this, set
12135 .code
12136 RADIUS_LIB_TYPE=RADLIB
12137 .endd
12138 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12139 You may also have to supply a suitable setting in EXTRALIBS so that the
12140 Radius library can be found when Exim is linked.
12141
12142 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12143 Radius client library, which calls the Radius server. The condition is true if
12144 the authentication is successful. For example:
12145 .code
12146 server_condition = ${if radius{<arguments>}}
12147 .endd
12148
12149
12150 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12151         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12152 .cindex "&'saslauthd'& daemon"
12153 .cindex "Cyrus"
12154 .cindex "expansion" "&'saslauthd'& authentication test"
12155 .cindex "&%saslauthd%& expansion condition"
12156 This condition supports user authentication using the Cyrus &'saslauthd'&
12157 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12158 Using this daemon is one way of making it possible for passwords to be checked
12159 by a process that is not running as root.
12160
12161 The saslauthd support is not included in Exim by default. You need to specify
12162 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12163 building Exim. For example:
12164 .code
12165 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12166 .endd
12167 You do not need to install the full Cyrus software suite in order to use
12168 the saslauthd daemon. You can compile and install just the daemon alone
12169 from the Cyrus SASL library.
12170
12171 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12172 two are mandatory. For example:
12173 .code
12174 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12175 .endd
12176 The service and the realm are optional (which is why the arguments are enclosed
12177 in their own set of braces). For details of the meaning of the service and
12178 realm, and how to run the daemon, consult the Cyrus documentation.
12179 .endlist vlist
12180
12181
12182
12183 .section "Combining expansion conditions" "SECID84"
12184 .cindex "expansion" "combining conditions"
12185 Several conditions can be tested at once by combining them using the &%and%&
12186 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12187 conditions on their own, and precede their lists of sub-conditions. Each
12188 sub-condition must be enclosed in braces within the overall braces that contain
12189 the list. No repetition of &%if%& is used.
12190
12191
12192 .vlist
12193 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12194 .cindex "&""or""& expansion condition"
12195 .cindex "expansion" "&""or""& of conditions"
12196 The sub-conditions are evaluated from left to right. The condition is true if
12197 any one of the sub-conditions is true.
12198 For example,
12199 .code
12200 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12201 .endd
12202 When a true sub-condition is found, the following ones are parsed but not
12203 evaluated. If there are several &"match"& sub-conditions the values of the
12204 numeric variables afterwards are taken from the first one that succeeds.
12205
12206 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12207 .cindex "&""and""& expansion condition"
12208 .cindex "expansion" "&""and""& of conditions"
12209 The sub-conditions are evaluated from left to right. The condition is true if
12210 all of the sub-conditions are true. If there are several &"match"&
12211 sub-conditions, the values of the numeric variables afterwards are taken from
12212 the last one. When a false sub-condition is found, the following ones are
12213 parsed but not evaluated.
12214 .endlist
12215 .ecindex IIDexpcond
12216
12217
12218
12219
12220 .section "Expansion variables" "SECTexpvar"
12221 .cindex "expansion" "variables, list of"
12222 This section contains an alphabetical list of all the expansion variables. Some
12223 of them are available only when Exim is compiled with specific options such as
12224 support for TLS or the content scanning extension.
12225
12226 .vlist
12227 .vitem "&$0$&, &$1$&, etc"
12228 .cindex "numerical variables (&$1$& &$2$& etc)"
12229 When a &%match%& expansion condition succeeds, these variables contain the
12230 captured substrings identified by the regular expression during subsequent
12231 processing of the success string of the containing &%if%& expansion item.
12232 In the expansion condition case
12233 they do not retain their values afterwards; in fact, their previous
12234 values are restored at the end of processing an &%if%& item. The numerical
12235 variables may also be set externally by some other matching process which
12236 precedes the expansion of the string. For example, the commands available in
12237 Exim filter files include an &%if%& command with its own regular expression
12238 matching condition.
12239
12240 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12241 Within an acl condition, expansion condition or expansion item
12242 any arguments are copied to these variables,
12243 any unused variables being made empty.
12244
12245 .vitem "&$acl_c...$&"
12246 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12247 can be given any name that starts with &$acl_c$& and is at least six characters
12248 long, but the sixth character must be either a digit or an underscore. For
12249 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12250 variables persist throughout the lifetime of an SMTP connection. They can be
12251 used to pass information between ACLs and between different invocations of the
12252 same ACL. When a message is received, the values of these variables are saved
12253 with the message, and can be accessed by filters, routers, and transports
12254 during subsequent delivery.
12255
12256 .vitem "&$acl_m...$&"
12257 These variables are like the &$acl_c...$& variables, except that their values
12258 are reset after a message has been received. Thus, if several messages are
12259 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12260 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12261 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12262 message is received, the values of these variables are saved with the message,
12263 and can be accessed by filters, routers, and transports during subsequent
12264 delivery.
12265
12266 .vitem &$acl_narg$&
12267 Within an acl condition, expansion condition or expansion item
12268 this variable has the number of arguments.
12269
12270 .vitem &$acl_verify_message$&
12271 .vindex "&$acl_verify_message$&"
12272 After an address verification has failed, this variable contains the failure
12273 message. It retains its value for use in subsequent modifiers. The message can
12274 be preserved by coding like this:
12275 .code
12276 warn !verify = sender
12277      set acl_m0 = $acl_verify_message
12278 .endd
12279 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12280 &%log_message%& modifiers, to include information about the verification
12281 failure.
12282
12283 .vitem &$address_data$&
12284 .vindex "&$address_data$&"
12285 This variable is set by means of the &%address_data%& option in routers. The
12286 value then remains with the address while it is processed by subsequent routers
12287 and eventually a transport. If the transport is handling multiple addresses,
12288 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12289 for more details. &*Note*&: The contents of &$address_data$& are visible in
12290 user filter files.
12291
12292 If &$address_data$& is set when the routers are called from an ACL to verify
12293 a recipient address, the final value is still in the variable for subsequent
12294 conditions and modifiers of the ACL statement. If routing the address caused it
12295 to be redirected to just one address, the child address is also routed as part
12296 of the verification, and in this case the final value of &$address_data$& is
12297 from the child's routing.
12298
12299 If &$address_data$& is set when the routers are called from an ACL to verify a
12300 sender address, the final value is also preserved, but this time in
12301 &$sender_address_data$&, to distinguish it from data from a recipient
12302 address.
12303
12304 In both cases (recipient and sender verification), the value does not persist
12305 after the end of the current ACL statement. If you want to preserve
12306 these values for longer, you can save them in ACL variables.
12307
12308 .vitem &$address_file$&
12309 .vindex "&$address_file$&"
12310 When, as a result of aliasing, forwarding, or filtering, a message is directed
12311 to a specific file, this variable holds the name of the file when the transport
12312 is running. At other times, the variable is empty. For example, using the
12313 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12314 .code
12315 /home/r2d2/savemail
12316 .endd
12317 then when the &(address_file)& transport is running, &$address_file$&
12318 contains the text string &`/home/r2d2/savemail`&.
12319 .cindex "Sieve filter" "value of &$address_file$&"
12320 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12321 then up to the transport configuration to generate an appropriate absolute path
12322 to the relevant file.
12323
12324 .vitem &$address_pipe$&
12325 .vindex "&$address_pipe$&"
12326 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12327 this variable holds the pipe command when the transport is running.
12328
12329 .vitem "&$auth1$& &-- &$auth3$&"
12330 .vindex "&$auth1$&, &$auth2$&, etc"
12331 These variables are used in SMTP authenticators (see chapters
12332 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12333
12334 .vitem &$authenticated_id$&
12335 .cindex "authentication" "id"
12336 .vindex "&$authenticated_id$&"
12337 When a server successfully authenticates a client it may be configured to
12338 preserve some of the authentication information in the variable
12339 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12340 user/password authenticator configuration might preserve the user name for use
12341 in the routers. Note that this is not the same information that is saved in
12342 &$sender_host_authenticated$&.
12343
12344 When a message is submitted locally (that is, not over a TCP connection)
12345 the value of &$authenticated_id$& is normally the login name of the calling
12346 process. However, a trusted user can override this by means of the &%-oMai%&
12347 command line option.
12348 This second case also sets up information used by the
12349 &$authresults$& expansion item.
12350
12351 .vitem &$authenticated_fail_id$&
12352 .cindex "authentication" "fail" "id"
12353 .vindex "&$authenticated_fail_id$&"
12354 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12355 will contain the failed authentication id. If more than one authentication
12356 id is attempted, it will contain only the last one. The variable is
12357 available for processing in the ACL's, generally the quit or notquit ACL.
12358 A message to a local recipient could still be accepted without requiring
12359 authentication, which means this variable could also be visible in all of
12360 the ACL's as well.
12361
12362
12363 .vitem &$authenticated_sender$&
12364 .cindex "sender" "authenticated"
12365 .cindex "authentication" "sender"
12366 .cindex "AUTH" "on MAIL command"
12367 .vindex "&$authenticated_sender$&"
12368 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12369 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12370 described in section &<<SECTauthparamail>>&. Unless the data is the string
12371 &"<>"&, it is set as the authenticated sender of the message, and the value is
12372 available during delivery in the &$authenticated_sender$& variable. If the
12373 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12374
12375 .vindex "&$qualify_domain$&"
12376 When a message is submitted locally (that is, not over a TCP connection), the
12377 value of &$authenticated_sender$& is an address constructed from the login
12378 name of the calling process and &$qualify_domain$&, except that a trusted user
12379 can override this by means of the &%-oMas%& command line option.
12380
12381
12382 .vitem &$authentication_failed$&
12383 .cindex "authentication" "failure"
12384 .vindex "&$authentication_failed$&"
12385 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12386 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12387 possible to distinguish between &"did not try to authenticate"&
12388 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12389 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12390 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12391 negative response to an AUTH command, including (for example) an attempt to use
12392 an undefined mechanism.
12393
12394 .vitem &$av_failed$&
12395 .cindex "content scanning" "AV scanner failure"
12396 This variable is available when Exim is compiled with the content-scanning
12397 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12398 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12399 the ACL malware condition.
12400
12401 .vitem &$body_linecount$&
12402 .cindex "message body" "line count"
12403 .cindex "body of message" "line count"
12404 .vindex "&$body_linecount$&"
12405 When a message is being received or delivered, this variable contains the
12406 number of lines in the message's body. See also &$message_linecount$&.
12407
12408 .vitem &$body_zerocount$&
12409 .cindex "message body" "binary zero count"
12410 .cindex "body of message" "binary zero count"
12411 .cindex "binary zero" "in message body"
12412 .vindex "&$body_zerocount$&"
12413 When a message is being received or delivered, this variable contains the
12414 number of binary zero bytes (ASCII NULs) in the message's body.
12415
12416 .vitem &$bounce_recipient$&
12417 .vindex "&$bounce_recipient$&"
12418 This is set to the recipient address of a bounce message while Exim is creating
12419 it. It is useful if a customized bounce message text file is in use (see
12420 chapter &<<CHAPemsgcust>>&).
12421
12422 .vitem &$bounce_return_size_limit$&
12423 .vindex "&$bounce_return_size_limit$&"
12424 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12425 up to a multiple of 1000. It is useful when a customized error message text
12426 file is in use (see chapter &<<CHAPemsgcust>>&).
12427
12428 .vitem &$caller_gid$&
12429 .cindex "gid (group id)" "caller"
12430 .vindex "&$caller_gid$&"
12431 The real group id under which the process that called Exim was running. This is
12432 not the same as the group id of the originator of a message (see
12433 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12434 incarnation normally contains the Exim gid.
12435
12436 .vitem &$caller_uid$&
12437 .cindex "uid (user id)" "caller"
12438 .vindex "&$caller_uid$&"
12439 The real user id under which the process that called Exim was running. This is
12440 not the same as the user id of the originator of a message (see
12441 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12442 incarnation normally contains the Exim uid.
12443
12444 .vitem &$callout_address$&
12445 .vindex "&$callout_address$&"
12446 After a callout for verification, spamd or malware daemon service, the
12447 address that was connected to.
12448
12449 .vitem &$compile_number$&
12450 .vindex "&$compile_number$&"
12451 The building process for Exim keeps a count of the number
12452 of times it has been compiled. This serves to distinguish different
12453 compilations of the same version of Exim.
12454
12455 .vitem &$config_dir$&
12456 .vindex "&$config_dir$&"
12457 The directory name of the main configuration file. That is, the content of
12458 &$config_file$& with the last component stripped. The value does not
12459 contain the trailing slash. If &$config_file$& does not contain a slash,
12460 &$config_dir$& is ".".
12461
12462 .vitem &$config_file$&
12463 .vindex "&$config_file$&"
12464 The name of the main configuration file Exim is using.
12465
12466 .vitem &$dkim_verify_status$&
12467 Results of DKIM verification.
12468 For details see section &<<SECDKIMVFY>>&.
12469
12470 .vitem &$dkim_cur_signer$& &&&
12471        &$dkim_verify_reason$& &&&
12472        &$dkim_domain$& &&&
12473        &$dkim_identity$& &&&
12474        &$dkim_selector$& &&&
12475        &$dkim_algo$& &&&
12476        &$dkim_canon_body$& &&&
12477        &$dkim_canon_headers$& &&&
12478        &$dkim_copiedheaders$& &&&
12479        &$dkim_bodylength$& &&&
12480        &$dkim_created$& &&&
12481        &$dkim_expires$& &&&
12482        &$dkim_headernames$& &&&
12483        &$dkim_key_testing$& &&&
12484        &$dkim_key_nosubdomains$& &&&
12485        &$dkim_key_srvtype$& &&&
12486        &$dkim_key_granularity$& &&&
12487        &$dkim_key_notes$& &&&
12488        &$dkim_key_length$&
12489 These variables are only available within the DKIM ACL.
12490 For details see section &<<SECDKIMVFY>>&.
12491
12492 .vitem &$dkim_signers$&
12493 .vindex &$dkim_signers$&
12494 When a message has been received this variable contains
12495 a colon-separated list of signer domains and identities for the message.
12496 For details see section &<<SECDKIMVFY>>&.
12497
12498 .vitem &$dmarc_domain_policy$& &&&
12499        &$dmarc_status$& &&&
12500        &$dmarc_status_text$& &&&
12501        &$dmarc_used_domains$&
12502 Results of DMARC verification.
12503 For details see section &<<SECDMARC>>&.
12504
12505 .vitem &$dnslist_domain$& &&&
12506        &$dnslist_matched$& &&&
12507        &$dnslist_text$& &&&
12508        &$dnslist_value$&
12509 .vindex "&$dnslist_domain$&"
12510 .vindex "&$dnslist_matched$&"
12511 .vindex "&$dnslist_text$&"
12512 .vindex "&$dnslist_value$&"
12513 .cindex "black list (DNS)"
12514 When a DNS (black) list lookup succeeds, these variables are set to contain
12515 the following data from the lookup: the list's domain name, the key that was
12516 looked up, the contents of any associated TXT record, and the value from the
12517 main A record. See section &<<SECID204>>& for more details.
12518
12519 .vitem &$domain$&
12520 .vindex "&$domain$&"
12521 When an address is being routed, or delivered on its own, this variable
12522 contains the domain. Uppercase letters in the domain are converted into lower
12523 case for &$domain$&.
12524
12525 Global address rewriting happens when a message is received, so the value of
12526 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12527 is set during user filtering, but not during system filtering, because a
12528 message may have many recipients and the system filter is called just once.
12529
12530 When more than one address is being delivered at once (for example, several
12531 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12532 have the same domain. Transports can be restricted to handling only one domain
12533 at a time if the value of &$domain$& is required at transport time &-- this is
12534 the default for local transports. For further details of the environment in
12535 which local transports are run, see chapter &<<CHAPenvironment>>&.
12536
12537 .oindex "&%delay_warning_condition%&"
12538 At the end of a delivery, if all deferred addresses have the same domain, it is
12539 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12540
12541 The &$domain$& variable is also used in some other circumstances:
12542
12543 .ilist
12544 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12545 the recipient address. The domain of the &'sender'& address is in
12546 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12547 normally set during the running of the MAIL ACL. However, if the sender address
12548 is verified with a callout during the MAIL ACL, the sender domain is placed in
12549 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12550 the &(smtp)& transport.
12551
12552 .next
12553 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12554 &$domain$& contains the domain portion of the address that is being rewritten;
12555 it can be used in the expansion of the replacement address, for example, to
12556 rewrite domains by file lookup.
12557
12558 .next
12559 With one important exception, whenever a domain list is being scanned,
12560 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12561 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12562 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12563 that, in a RCPT ACL, the sender domain list can be dependent on the
12564 recipient domain (which is what is in &$domain$& at this time).
12565
12566 .next
12567 .cindex "ETRN" "value of &$domain$&"
12568 .oindex "&%smtp_etrn_command%&"
12569 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12570 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12571 .endlist
12572
12573 .cindex "tainted data"
12574 If the origin of the data is an incoming message,
12575 the result of expanding this variable is tainted and may not
12576 be further expanded or used as a filename.
12577 When an untainted version is needed, one should be obtained from
12578 looking up the value in a local (therefore trusted) database.
12579 Often &$domain_data$& is usable in this role.
12580
12581
12582 .vitem &$domain_data$&
12583 .vindex "&$domain_data$&"
12584 When the &%domains%& condition on a router
12585 .new
12586 or an ACL
12587 matches a domain
12588 against a list, the match value is copied to &$domain_data$&.
12589 This is an enhancement over previous versions of Exim, when it only
12590 applied to the data read by a lookup.
12591 For details on match values see section &<<SECTlistresults>>& et. al.
12592 .wen
12593
12594 If the router routes the
12595 address to a transport, the value is available in that transport. If the
12596 transport is handling multiple addresses, the value from the first address is
12597 used.
12598
12599 &$domain_data$& set in an ACL is available during
12600 the rest of the ACL statement.
12601
12602 .vitem &$exim_gid$&
12603 .vindex "&$exim_gid$&"
12604 This variable contains the numerical value of the Exim group id.
12605
12606 .vitem &$exim_path$&
12607 .vindex "&$exim_path$&"
12608 This variable contains the path to the Exim binary.
12609
12610 .vitem &$exim_uid$&
12611 .vindex "&$exim_uid$&"
12612 This variable contains the numerical value of the Exim user id.
12613
12614 .vitem &$exim_version$&
12615 .vindex "&$exim_version$&"
12616 This variable contains the version string of the Exim build.
12617 The first character is a major version number, currently 4.
12618 Then after a dot, the next group of digits is a minor version number.
12619 There may be other characters following the minor version.
12620 This value may be overridden by the &%exim_version%& main config option.
12621
12622 .vitem &$header_$&<&'name'&>
12623 This is not strictly an expansion variable. It is expansion syntax for
12624 inserting the message header line with the given name. Note that the name must
12625 be terminated by colon or white space, because it may contain a wide variety of
12626 characters. Note also that braces must &'not'& be used.
12627 See the full description in section &<<SECTexpansionitems>>& above.
12628
12629 .vitem &$headers_added$&
12630 .vindex "&$headers_added$&"
12631 Within an ACL this variable contains the headers added so far by
12632 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12633 The headers are a newline-separated list.
12634
12635 .vitem &$home$&
12636 .vindex "&$home$&"
12637 When the &%check_local_user%& option is set for a router, the user's home
12638 directory is placed in &$home$& when the check succeeds. In particular, this
12639 means it is set during the running of users' filter files. A router may also
12640 explicitly set a home directory for use by a transport; this can be overridden
12641 by a setting on the transport itself.
12642
12643 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12644 of the environment variable HOME, which is subject to the
12645 &%keep_environment%& and &%add_environment%& main config options.
12646
12647 .vitem &$host$&
12648 .vindex "&$host$&"
12649 If a router assigns an address to a transport (any transport), and passes a
12650 list of hosts with the address, the value of &$host$& when the transport starts
12651 to run is the name of the first host on the list. Note that this applies both
12652 to local and remote transports.
12653
12654 .cindex "transport" "filter"
12655 .cindex "filter" "transport filter"
12656 For the &(smtp)& transport, if there is more than one host, the value of
12657 &$host$& changes as the transport works its way through the list. In
12658 particular, when the &(smtp)& transport is expanding its options for encryption
12659 using TLS, or for specifying a transport filter (see chapter
12660 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12661 is connected.
12662
12663 When used in the client part of an authenticator configuration (see chapter
12664 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12665 client is connected.
12666
12667
12668 .vitem &$host_address$&
12669 .vindex "&$host_address$&"
12670 This variable is set to the remote host's IP address whenever &$host$& is set
12671 for a remote connection. It is also set to the IP address that is being checked
12672 when the &%ignore_target_hosts%& option is being processed.
12673
12674 .vitem &$host_data$&
12675 .vindex "&$host_data$&"
12676 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12677 result of the lookup is made available in the &$host_data$& variable. This
12678 allows you, for example, to do things like this:
12679 .code
12680 deny  hosts = net-lsearch;/some/file
12681       message = $host_data
12682 .endd
12683 .vitem &$host_lookup_deferred$&
12684 .cindex "host name" "lookup, failure of"
12685 .vindex "&$host_lookup_deferred$&"
12686 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12687 message comes from a remote host and there is an attempt to look up the host's
12688 name from its IP address, and the attempt is not successful, one of these
12689 variables is set to &"1"&.
12690
12691 .ilist
12692 If the lookup receives a definite negative response (for example, a DNS lookup
12693 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12694
12695 .next
12696 If there is any kind of problem during the lookup, such that Exim cannot
12697 tell whether or not the host name is defined (for example, a timeout for a DNS
12698 lookup), &$host_lookup_deferred$& is set to &"1"&.
12699 .endlist ilist
12700
12701 Looking up a host's name from its IP address consists of more than just a
12702 single reverse lookup. Exim checks that a forward lookup of at least one of the
12703 names it receives from a reverse lookup yields the original IP address. If this
12704 is not the case, Exim does not accept the looked up name(s), and
12705 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12706 IP address (for example, the existence of a PTR record in the DNS) is not
12707 sufficient on its own for the success of a host name lookup. If the reverse
12708 lookup succeeds, but there is a lookup problem such as a timeout when checking
12709 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12710 &"1"&. See also &$sender_host_name$&.
12711
12712 .cindex authentication "expansion item"
12713 Performing these checks sets up information used by the
12714 &%authresults%& expansion item.
12715
12716
12717 .vitem &$host_lookup_failed$&
12718 .vindex "&$host_lookup_failed$&"
12719 See &$host_lookup_deferred$&.
12720
12721 .vitem &$host_port$&
12722 .vindex "&$host_port$&"
12723 This variable is set to the remote host's TCP port whenever &$host$& is set
12724 for an outbound connection.
12725
12726 .vitem &$initial_cwd$&
12727 .vindex "&$initial_cwd$&
12728 This variable contains the full path name of the initial working
12729 directory of the current Exim process. This may differ from the current
12730 working directory, as Exim changes this to "/" during early startup, and
12731 to &$spool_directory$& later.
12732
12733 .vitem &$inode$&
12734 .vindex "&$inode$&"
12735 The only time this variable is set is while expanding the &%directory_file%&
12736 option in the &(appendfile)& transport. The variable contains the inode number
12737 of the temporary file which is about to be renamed. It can be used to construct
12738 a unique name for the file.
12739
12740 .vitem &$interface_address$&
12741 .vindex "&$interface_address$&"
12742 This is an obsolete name for &$received_ip_address$&.
12743
12744 .vitem &$interface_port$&
12745 .vindex "&$interface_port$&"
12746 This is an obsolete name for &$received_port$&.
12747
12748 .vitem &$item$&
12749 .vindex "&$item$&"
12750 This variable is used during the expansion of &*forall*& and &*forany*&
12751 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12752 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12753 empty.
12754
12755 .vitem &$ldap_dn$&
12756 .vindex "&$ldap_dn$&"
12757 This variable, which is available only when Exim is compiled with LDAP support,
12758 contains the DN from the last entry in the most recently successful LDAP
12759 lookup.
12760
12761 .vitem &$load_average$&
12762 .vindex "&$load_average$&"
12763 This variable contains the system load average, multiplied by 1000 so that it
12764 is an integer. For example, if the load average is 0.21, the value of the
12765 variable is 210. The value is recomputed every time the variable is referenced.
12766
12767 .vitem &$local_part$&
12768 .vindex "&$local_part$&"
12769 When an address is being routed, or delivered on its own, this
12770 variable contains the local part. When a number of addresses are being
12771 delivered together (for example, multiple RCPT commands in an SMTP
12772 session), &$local_part$& is not set.
12773
12774 Global address rewriting happens when a message is received, so the value of
12775 &$local_part$& during routing and delivery is the value after rewriting.
12776 &$local_part$& is set during user filtering, but not during system filtering,
12777 because a message may have many recipients and the system filter is called just
12778 once.
12779
12780 .cindex "tainted data"
12781 If the origin of the data is an incoming message,
12782 the result of expanding this variable is tainted and
12783 may not be further expanded or used as a filename.
12784
12785 &*Warning*&: the content of this variable is usually provided by a potential
12786 attacker.
12787 Consider carefully the implications of using it unvalidated as a name
12788 for file access.
12789 This presents issues for users' &_.forward_& and filter files.
12790 For traditional full user accounts, use &%check_local_users%& and the
12791 &$local_part_data$& variable rather than this one.
12792 For virtual users, store a suitable pathname component in the database
12793 which is used for account name validation, and use that retrieved value
12794 rather than this variable.
12795 Often &$local_part_data$& is usable in this role.
12796 If needed, use a router &%address_data%& or &%set%& option for
12797 the retrieved data.
12798
12799 When a message is being delivered to a file, pipe, or autoreply transport as a
12800 result of aliasing or forwarding, &$local_part$& is set to the local part of
12801 the parent address, not to the filename or command (see &$address_file$& and
12802 &$address_pipe$&).
12803
12804 When an ACL is running for a RCPT command, &$local_part$& contains the
12805 local part of the recipient address.
12806
12807 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12808 &$local_part$& contains the local part of the address that is being rewritten;
12809 it can be used in the expansion of the replacement address, for example.
12810
12811 In all cases, all quoting is removed from the local part. For example, for both
12812 the addresses
12813 .code
12814 "abc:xyz"@test.example
12815 abc\:xyz@test.example
12816 .endd
12817 the value of &$local_part$& is
12818 .code
12819 abc:xyz
12820 .endd
12821 If you use &$local_part$& to create another address, you should always wrap it
12822 inside a quoting operator. For example, in a &(redirect)& router you could
12823 have:
12824 .code
12825 data = ${quote_local_part:$local_part}@new.domain.example
12826 .endd
12827 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12828 to process local parts in a case-dependent manner in a router, you can set the
12829 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12830
12831 .vitem &$local_part_data$&
12832 .vindex "&$local_part_data$&"
12833 When the &%local_parts%& condition on a router or ACL
12834 matches a local part list
12835 .new
12836 the match value is copied to &$local_part_data$&.
12837 This is an enhancement over previous versions of Exim, when it only
12838 applied to the data read by a lookup.
12839 For details on match values see section &<<SECTlistresults>>& et. al.
12840 .wen
12841
12842 The &%check_local_user%& router option also sets this variable.
12843
12844 .vindex &$local_part_prefix$& &&&
12845         &$local_part_prefix_v$& &&&
12846         &$local_part_suffix$& &&&
12847         &$local_part_suffix_v$&
12848 .cindex affix variables
12849 If a local part prefix or suffix has been recognized, it is not included in the
12850 value of &$local_part$& during routing and subsequent delivery. The values of
12851 any prefix or suffix are in &$local_part_prefix$& and
12852 &$local_part_suffix$&, respectively.
12853 .cindex "tainted data"
12854 If the specification did not include a wildcard then
12855 the affix variable value is not tainted.
12856
12857 If the affix specification included a wildcard then the portion of
12858 the affix matched by the wildcard is in
12859 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12860 and both the whole and varying values are tainted.
12861
12862 .vitem &$local_scan_data$&
12863 .vindex "&$local_scan_data$&"
12864 This variable contains the text returned by the &[local_scan()]& function when
12865 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12866
12867 .vitem &$local_user_gid$&
12868 .vindex "&$local_user_gid$&"
12869 See &$local_user_uid$&.
12870
12871 .vitem &$local_user_uid$&
12872 .vindex "&$local_user_uid$&"
12873 This variable and &$local_user_gid$& are set to the uid and gid after the
12874 &%check_local_user%& router precondition succeeds. This means that their values
12875 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12876 and &%condition%&), for the &%address_data%& expansion, and for any
12877 router-specific expansions. At all other times, the values in these variables
12878 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12879
12880 .vitem &$localhost_number$&
12881 .vindex "&$localhost_number$&"
12882 This contains the expanded value of the
12883 &%localhost_number%& option. The expansion happens after the main options have
12884 been read.
12885
12886 .vitem &$log_inodes$&
12887 .vindex "&$log_inodes$&"
12888 The number of free inodes in the disk partition where Exim's
12889 log files are being written. The value is recalculated whenever the variable is
12890 referenced. If the relevant file system does not have the concept of inodes,
12891 the value of is -1. See also the &%check_log_inodes%& option.
12892
12893 .vitem &$log_space$&
12894 .vindex "&$log_space$&"
12895 The amount of free space (as a number of kilobytes) in the disk
12896 partition where Exim's log files are being written. The value is recalculated
12897 whenever the variable is referenced. If the operating system does not have the
12898 ability to find the amount of free space (only true for experimental systems),
12899 the space value is -1. See also the &%check_log_space%& option.
12900
12901
12902 .vitem &$lookup_dnssec_authenticated$&
12903 .vindex "&$lookup_dnssec_authenticated$&"
12904 This variable is set after a DNS lookup done by
12905 a dnsdb lookup expansion, dnslookup router or smtp transport.
12906 .cindex "DNS" "DNSSEC"
12907 It will be empty if &(DNSSEC)& was not requested,
12908 &"no"& if the result was not labelled as authenticated data
12909 and &"yes"& if it was.
12910 Results that are labelled as authoritative answer that match
12911 the &%dns_trust_aa%& configuration variable count also
12912 as authenticated data.
12913
12914 .vitem &$mailstore_basename$&
12915 .vindex "&$mailstore_basename$&"
12916 This variable is set only when doing deliveries in &"mailstore"& format in the
12917 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12918 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12919 contains the basename of the files that are being written, that is, the name
12920 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12921 variable is empty.
12922
12923 .vitem &$malware_name$&
12924 .vindex "&$malware_name$&"
12925 This variable is available when Exim is compiled with the
12926 content-scanning extension. It is set to the name of the virus that was found
12927 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12928
12929 .vitem &$max_received_linelength$&
12930 .vindex "&$max_received_linelength$&"
12931 .cindex "maximum" "line length"
12932 .cindex "line length" "maximum"
12933 This variable contains the number of bytes in the longest line that was
12934 received as part of the message, not counting the line termination
12935 character(s).
12936 It is not valid if the &%spool_files_wireformat%& option is used.
12937
12938 .vitem &$message_age$&
12939 .cindex "message" "age of"
12940 .vindex "&$message_age$&"
12941 This variable is set at the start of a delivery attempt to contain the number
12942 of seconds since the message was received. It does not change during a single
12943 delivery attempt.
12944
12945 .vitem &$message_body$&
12946 .cindex "body of message" "expansion variable"
12947 .cindex "message body" "in expansion"
12948 .cindex "binary zero" "in message body"
12949 .vindex "&$message_body$&"
12950 .oindex "&%message_body_visible%&"
12951 This variable contains the initial portion of a message's body while it is
12952 being delivered, and is intended mainly for use in filter files. The maximum
12953 number of characters of the body that are put into the variable is set by the
12954 &%message_body_visible%& configuration option; the default is 500.
12955
12956 .oindex "&%message_body_newlines%&"
12957 By default, newlines are converted into spaces in &$message_body$&, to make it
12958 easier to search for phrases that might be split over a line break. However,
12959 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12960 zeros are always converted into spaces.
12961
12962 .vitem &$message_body_end$&
12963 .cindex "body of message" "expansion variable"
12964 .cindex "message body" "in expansion"
12965 .vindex "&$message_body_end$&"
12966 This variable contains the final portion of a message's
12967 body while it is being delivered. The format and maximum size are as for
12968 &$message_body$&.
12969
12970 .vitem &$message_body_size$&
12971 .cindex "body of message" "size"
12972 .cindex "message body" "size"
12973 .vindex "&$message_body_size$&"
12974 When a message is being delivered, this variable contains the size of the body
12975 in bytes. The count starts from the character after the blank line that
12976 separates the body from the header. Newlines are included in the count. See
12977 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12978
12979 If the spool file is wireformat
12980 (see the &%spool_files_wireformat%& main option)
12981 the CRLF line-terminators are included in the count.
12982
12983 .vitem &$message_exim_id$&
12984 .vindex "&$message_exim_id$&"
12985 When a message is being received or delivered, this variable contains the
12986 unique message id that is generated and used by Exim to identify the message.
12987 An id is not created for a message until after its header has been successfully
12988 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12989 line; it is the local id that Exim assigns to the message, for example:
12990 &`1BXTIK-0001yO-VA`&.
12991
12992 .vitem &$message_headers$&
12993 .vindex &$message_headers$&
12994 This variable contains a concatenation of all the header lines when a message
12995 is being processed, except for lines added by routers or transports. The header
12996 lines are separated by newline characters. Their contents are decoded in the
12997 same way as a header line that is inserted by &%bheader%&.
12998
12999 .vitem &$message_headers_raw$&
13000 .vindex &$message_headers_raw$&
13001 This variable is like &$message_headers$& except that no processing of the
13002 contents of header lines is done.
13003
13004 .vitem &$message_id$&
13005 This is an old name for &$message_exim_id$&. It is now deprecated.
13006
13007 .vitem &$message_linecount$&
13008 .vindex "&$message_linecount$&"
13009 This variable contains the total number of lines in the header and body of the
13010 message. Compare &$body_linecount$&, which is the count for the body only.
13011 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13012 number of lines received. Before delivery happens (that is, before filters,
13013 routers, and transports run) the count is increased to include the
13014 &'Received:'& header line that Exim standardly adds, and also any other header
13015 lines that are added by ACLs. The blank line that separates the message header
13016 from the body is not counted.
13017
13018 As with the special case of &$message_size$&, during the expansion of the
13019 appendfile transport's maildir_tag option in maildir format, the value of
13020 &$message_linecount$& is the precise size of the number of newlines in the
13021 file that has been written (minus one for the blank line between the
13022 header and the body).
13023
13024 Here is an example of the use of this variable in a DATA ACL:
13025 .code
13026 deny condition = \
13027       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13028      message   = Too many lines in message header
13029 .endd
13030 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13031 message has not yet been received.
13032
13033 This variable is not valid if the &%spool_files_wireformat%& option is used.
13034
13035 .vitem &$message_size$&
13036 .cindex "size" "of message"
13037 .cindex "message" "size"
13038 .vindex "&$message_size$&"
13039 When a message is being processed, this variable contains its size in bytes. In
13040 most cases, the size includes those headers that were received with the
13041 message, but not those (such as &'Envelope-to:'&) that are added to individual
13042 deliveries as they are written. However, there is one special case: during the
13043 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13044 doing a delivery in maildir format, the value of &$message_size$& is the
13045 precise size of the file that has been written. See also
13046 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13047
13048 .cindex "RCPT" "value of &$message_size$&"
13049 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13050 contains the size supplied on the MAIL command, or -1 if no size was given. The
13051 value may not, of course, be truthful.
13052
13053 .vitem &$mime_$&&'xxx'&
13054 A number of variables whose names start with &$mime$& are
13055 available when Exim is compiled with the content-scanning extension. For
13056 details, see section &<<SECTscanmimepart>>&.
13057
13058 .vitem "&$n0$& &-- &$n9$&"
13059 These variables are counters that can be incremented by means
13060 of the &%add%& command in filter files.
13061
13062 .vitem &$original_domain$&
13063 .vindex "&$domain$&"
13064 .vindex "&$original_domain$&"
13065 When a top-level address is being processed for delivery, this contains the
13066 same value as &$domain$&. However, if a &"child"& address (for example,
13067 generated by an alias, forward, or filter file) is being processed, this
13068 variable contains the domain of the original address (lower cased). This
13069 differs from &$parent_domain$& only when there is more than one level of
13070 aliasing or forwarding. When more than one address is being delivered in a
13071 single transport run, &$original_domain$& is not set.
13072
13073 If a new address is created by means of a &%deliver%& command in a system
13074 filter, it is set up with an artificial &"parent"& address. This has the local
13075 part &'system-filter'& and the default qualify domain.
13076
13077 .vitem &$original_local_part$&
13078 .vindex "&$local_part$&"
13079 .vindex "&$original_local_part$&"
13080 When a top-level address is being processed for delivery, this contains the
13081 same value as &$local_part$&, unless a prefix or suffix was removed from the
13082 local part, because &$original_local_part$& always contains the full local
13083 part. When a &"child"& address (for example, generated by an alias, forward, or
13084 filter file) is being processed, this variable contains the full local part of
13085 the original address.
13086
13087 If the router that did the redirection processed the local part
13088 case-insensitively, the value in &$original_local_part$& is in lower case.
13089 This variable differs from &$parent_local_part$& only when there is more than
13090 one level of aliasing or forwarding. When more than one address is being
13091 delivered in a single transport run, &$original_local_part$& is not set.
13092
13093 If a new address is created by means of a &%deliver%& command in a system
13094 filter, it is set up with an artificial &"parent"& address. This has the local
13095 part &'system-filter'& and the default qualify domain.
13096
13097 .vitem &$originator_gid$&
13098 .cindex "gid (group id)" "of originating user"
13099 .cindex "sender" "gid"
13100 .vindex "&$caller_gid$&"
13101 .vindex "&$originator_gid$&"
13102 This variable contains the value of &$caller_gid$& that was set when the
13103 message was received. For messages received via the command line, this is the
13104 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13105 normally the gid of the Exim user.
13106
13107 .vitem &$originator_uid$&
13108 .cindex "uid (user id)" "of originating user"
13109 .cindex "sender" "uid"
13110 .vindex "&$caller_uid$&"
13111 .vindex "&$originator_uid$&"
13112 The value of &$caller_uid$& that was set when the message was received. For
13113 messages received via the command line, this is the uid of the sending user.
13114 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13115 user.
13116
13117 .vitem &$parent_domain$&
13118 .vindex "&$parent_domain$&"
13119 This variable is similar to &$original_domain$& (see
13120 above), except that it refers to the immediately preceding parent address.
13121
13122 .vitem &$parent_local_part$&
13123 .vindex "&$parent_local_part$&"
13124 This variable is similar to &$original_local_part$&
13125 (see above), except that it refers to the immediately preceding parent address.
13126
13127 .vitem &$pid$&
13128 .cindex "pid (process id)" "of current process"
13129 .vindex "&$pid$&"
13130 This variable contains the current process id.
13131
13132 .vitem &$pipe_addresses$&
13133 .cindex "filter" "transport filter"
13134 .cindex "transport" "filter"
13135 .vindex "&$pipe_addresses$&"
13136 This is not an expansion variable, but is mentioned here because the string
13137 &`$pipe_addresses`& is handled specially in the command specification for the
13138 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13139 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13140 It cannot be used in general expansion strings, and provokes an &"unknown
13141 variable"& error if encountered.
13142
13143 .vitem &$primary_hostname$&
13144 .vindex "&$primary_hostname$&"
13145 This variable contains the value set by &%primary_hostname%& in the
13146 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13147 a single-component name, Exim calls &[gethostbyname()]& (or
13148 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13149 qualified host name. See also &$smtp_active_hostname$&.
13150
13151
13152 .vitem &$proxy_external_address$& &&&
13153        &$proxy_external_port$& &&&
13154        &$proxy_local_address$& &&&
13155        &$proxy_local_port$& &&&
13156        &$proxy_session$&
13157 These variables are only available when built with Proxy Protocol
13158 or SOCKS5 support.
13159 For details see chapter &<<SECTproxyInbound>>&.
13160
13161 .vitem &$prdr_requested$&
13162 .cindex "PRDR" "variable for"
13163 This variable is set to &"yes"& if PRDR was requested by the client for the
13164 current message, otherwise &"no"&.
13165
13166 .vitem &$prvscheck_address$&
13167 This variable is used in conjunction with the &%prvscheck%& expansion item,
13168 which is described in sections &<<SECTexpansionitems>>& and
13169 &<<SECTverifyPRVS>>&.
13170
13171 .vitem &$prvscheck_keynum$&
13172 This variable is used in conjunction with the &%prvscheck%& expansion item,
13173 which is described in sections &<<SECTexpansionitems>>& and
13174 &<<SECTverifyPRVS>>&.
13175
13176 .vitem &$prvscheck_result$&
13177 This variable is used in conjunction with the &%prvscheck%& expansion item,
13178 which is described in sections &<<SECTexpansionitems>>& and
13179 &<<SECTverifyPRVS>>&.
13180
13181 .vitem &$qualify_domain$&
13182 .vindex "&$qualify_domain$&"
13183 The value set for the &%qualify_domain%& option in the configuration file.
13184
13185 .vitem &$qualify_recipient$&
13186 .vindex "&$qualify_recipient$&"
13187 The value set for the &%qualify_recipient%& option in the configuration file,
13188 or if not set, the value of &$qualify_domain$&.
13189
13190 .vitem &$queue_name$&
13191 .vindex &$queue_name$&
13192 .cindex "named queues" variable
13193 .cindex queues named
13194 The name of the spool queue in use; empty for the default queue.
13195
13196 .vitem &$queue_size$&
13197 .vindex "&$queue_size$&"
13198 .cindex "queue" "size of"
13199 .cindex "spool" "number of messages"
13200 This variable contains the number of messages queued.
13201 It is evaluated on demand, but no more often than once every minute.
13202 If there is no daemon notifier socket open, the value will be
13203 an empty string.
13204
13205 .vitem &$r_...$&
13206 .vindex &$r_...$&
13207 .cindex router variables
13208 Values can be placed in these variables by the &%set%& option of a router.
13209 They can be given any name that starts with &$r_$&.
13210 The values persist for the address being handled through subsequent routers
13211 and the eventual transport.
13212
13213 .vitem &$rcpt_count$&
13214 .vindex "&$rcpt_count$&"
13215 When a message is being received by SMTP, this variable contains the number of
13216 RCPT commands received for the current message. If this variable is used in a
13217 RCPT ACL, its value includes the current command.
13218
13219 .vitem &$rcpt_defer_count$&
13220 .vindex "&$rcpt_defer_count$&"
13221 .cindex "4&'xx'& responses" "count of"
13222 When a message is being received by SMTP, this variable contains the number of
13223 RCPT commands in the current message that have previously been rejected with a
13224 temporary (4&'xx'&) response.
13225
13226 .vitem &$rcpt_fail_count$&
13227 .vindex "&$rcpt_fail_count$&"
13228 When a message is being received by SMTP, this variable contains the number of
13229 RCPT commands in the current message that have previously been rejected with a
13230 permanent (5&'xx'&) response.
13231
13232 .vitem &$received_count$&
13233 .vindex "&$received_count$&"
13234 This variable contains the number of &'Received:'& header lines in the message,
13235 including the one added by Exim (so its value is always greater than zero). It
13236 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13237 delivering.
13238
13239 .vitem &$received_for$&
13240 .vindex "&$received_for$&"
13241 If there is only a single recipient address in an incoming message, this
13242 variable contains that address when the &'Received:'& header line is being
13243 built. The value is copied after recipient rewriting has happened, but before
13244 the &[local_scan()]& function is run.
13245
13246 .vitem &$received_ip_address$&
13247 .vindex "&$received_ip_address$&"
13248 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13249 variable is set to the address of the local IP interface, and &$received_port$&
13250 is set to the local port number. (The remote IP address and port are in
13251 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13252 the port value is -1 unless it has been set using the &%-oMi%& command line
13253 option.
13254
13255 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13256 could be used, for example, to make the filename for a TLS certificate depend
13257 on which interface and/or port is being used for the incoming connection. The
13258 values of &$received_ip_address$& and &$received_port$& are saved with any
13259 messages that are received, thus making these variables available at delivery
13260 time.
13261 For outbound connections see &$sending_ip_address$&.
13262
13263 .vitem &$received_port$&
13264 .vindex "&$received_port$&"
13265 See &$received_ip_address$&.
13266
13267 .vitem &$received_protocol$&
13268 .vindex "&$received_protocol$&"
13269 When a message is being processed, this variable contains the name of the
13270 protocol by which it was received. Most of the names used by Exim are defined
13271 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13272 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13273 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13274 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13275 connection and the client was successfully authenticated.
13276
13277 Exim uses the protocol name &"smtps"& for the case when encryption is
13278 automatically set up on connection without the use of STARTTLS (see
13279 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13280 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13281 where the client initially uses EHLO, sets up an encrypted connection using
13282 STARTTLS, and then uses HELO afterwards.
13283
13284 The &%-oMr%& option provides a way of specifying a custom protocol name for
13285 messages that are injected locally by trusted callers. This is commonly used to
13286 identify messages that are being re-injected after some kind of scanning.
13287
13288 .vitem &$received_time$&
13289 .vindex "&$received_time$&"
13290 This variable contains the date and time when the current message was received,
13291 as a number of seconds since the start of the Unix epoch.
13292
13293 .vitem &$recipient_data$&
13294 .vindex "&$recipient_data$&"
13295 This variable is set after an indexing lookup success in an ACL &%recipients%&
13296 condition. It contains the data from the lookup, and the value remains set
13297 until the next &%recipients%& test. Thus, you can do things like this:
13298 .display
13299 &`require recipients  = cdb*@;/some/file`&
13300 &`deny    `&&'some further test involving'& &`$recipient_data`&
13301 .endd
13302 &*Warning*&: This variable is set only when a lookup is used as an indexing
13303 method in the address list, using the semicolon syntax as in the example above.
13304 The variable is not set for a lookup that is used as part of the string
13305 expansion that all such lists undergo before being interpreted.
13306
13307 .vitem &$recipient_verify_failure$&
13308 .vindex "&$recipient_verify_failure$&"
13309 In an ACL, when a recipient verification fails, this variable contains
13310 information about the failure. It is set to one of the following words:
13311
13312 .ilist
13313 &"qualify"&: The address was unqualified (no domain), and the message
13314 was neither local nor came from an exempted host.
13315
13316 .next
13317 &"route"&: Routing failed.
13318
13319 .next
13320 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13321 or before the MAIL command (that is, on initial connection, HELO, or
13322 MAIL).
13323
13324 .next
13325 &"recipient"&: The RCPT command in a callout was rejected.
13326 .next
13327
13328 &"postmaster"&: The postmaster check in a callout was rejected.
13329 .endlist
13330
13331 The main use of this variable is expected to be to distinguish between
13332 rejections of MAIL and rejections of RCPT.
13333
13334 .vitem &$recipients$&
13335 .vindex "&$recipients$&"
13336 This variable contains a list of envelope recipients for a message. A comma and
13337 a space separate the addresses in the replacement text. However, the variable
13338 is not generally available, to prevent exposure of Bcc recipients in
13339 unprivileged users' filter files. You can use &$recipients$& only in these
13340 cases:
13341
13342 .olist
13343 In a system filter file.
13344 .next
13345 In the ACLs associated with the DATA command and with non-SMTP messages, that
13346 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13347 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13348 &%acl_not_smtp_mime%&.
13349 .next
13350 From within a &[local_scan()]& function.
13351 .endlist
13352
13353
13354 .vitem &$recipients_count$&
13355 .vindex "&$recipients_count$&"
13356 When a message is being processed, this variable contains the number of
13357 envelope recipients that came with the message. Duplicates are not excluded
13358 from the count. While a message is being received over SMTP, the number
13359 increases for each accepted recipient. It can be referenced in an ACL.
13360
13361
13362 .vitem &$regex_match_string$&
13363 .vindex "&$regex_match_string$&"
13364 This variable is set to contain the matching regular expression after a
13365 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13366
13367 .vitem "&$regex1$&, &$regex2$&, etc"
13368 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13369 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13370 these variables contain the
13371 captured substrings identified by the regular expression.
13372
13373
13374 .vitem &$reply_address$&
13375 .vindex "&$reply_address$&"
13376 When a message is being processed, this variable contains the contents of the
13377 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13378 contents of the &'From:'& header line. Apart from the removal of leading
13379 white space, the value is not processed in any way. In particular, no RFC 2047
13380 decoding or character code translation takes place.
13381
13382 .vitem &$return_path$&
13383 .vindex "&$return_path$&"
13384 When a message is being delivered, this variable contains the return path &--
13385 the sender field that will be sent as part of the envelope. It is not enclosed
13386 in <> characters. At the start of routing an address, &$return_path$& has the
13387 same value as &$sender_address$&, but if, for example, an incoming message to a
13388 mailing list has been expanded by a router which specifies a different address
13389 for bounce messages, &$return_path$& subsequently contains the new bounce
13390 address, whereas &$sender_address$& always contains the original sender address
13391 that was received with the message. In other words, &$sender_address$& contains
13392 the incoming envelope sender, and &$return_path$& contains the outgoing
13393 envelope sender.
13394
13395 .vitem &$return_size_limit$&
13396 .vindex "&$return_size_limit$&"
13397 This is an obsolete name for &$bounce_return_size_limit$&.
13398
13399 .vitem &$router_name$&
13400 .cindex "router" "name"
13401 .cindex "name" "of router"
13402 .vindex "&$router_name$&"
13403 During the running of a router this variable contains its name.
13404
13405 .vitem &$runrc$&
13406 .cindex "return code" "from &%run%& expansion"
13407 .vindex "&$runrc$&"
13408 This variable contains the return code from a command that is run by the
13409 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13410 assume the order in which option values are expanded, except for those
13411 preconditions whose order of testing is documented. Therefore, you cannot
13412 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13413 another.
13414
13415 .vitem &$self_hostname$&
13416 .oindex "&%self%&" "value of host name"
13417 .vindex "&$self_hostname$&"
13418 When an address is routed to a supposedly remote host that turns out to be the
13419 local host, what happens is controlled by the &%self%& generic router option.
13420 One of its values causes the address to be passed to another router. When this
13421 happens, &$self_hostname$& is set to the name of the local host that the
13422 original router encountered. In other circumstances its contents are null.
13423
13424 .vitem &$sender_address$&
13425 .vindex "&$sender_address$&"
13426 When a message is being processed, this variable contains the sender's address
13427 that was received in the message's envelope. The case of letters in the address
13428 is retained, in both the local part and the domain. For bounce messages, the
13429 value of this variable is the empty string. See also &$return_path$&.
13430
13431 .vitem &$sender_address_data$&
13432 .vindex "&$address_data$&"
13433 .vindex "&$sender_address_data$&"
13434 If &$address_data$& is set when the routers are called from an ACL to verify a
13435 sender address, the final value is preserved in &$sender_address_data$&, to
13436 distinguish it from data from a recipient address. The value does not persist
13437 after the end of the current ACL statement. If you want to preserve it for
13438 longer, you can save it in an ACL variable.
13439
13440 .vitem &$sender_address_domain$&
13441 .vindex "&$sender_address_domain$&"
13442 The domain portion of &$sender_address$&.
13443
13444 .vitem &$sender_address_local_part$&
13445 .vindex "&$sender_address_local_part$&"
13446 The local part portion of &$sender_address$&.
13447
13448 .vitem &$sender_data$&
13449 .vindex "&$sender_data$&"
13450 This variable is set after a lookup success in an ACL &%senders%& condition or
13451 in a router &%senders%& option. It contains the data from the lookup, and the
13452 value remains set until the next &%senders%& test. Thus, you can do things like
13453 this:
13454 .display
13455 &`require senders      = cdb*@;/some/file`&
13456 &`deny    `&&'some further test involving'& &`$sender_data`&
13457 .endd
13458 &*Warning*&: This variable is set only when a lookup is used as an indexing
13459 method in the address list, using the semicolon syntax as in the example above.
13460 The variable is not set for a lookup that is used as part of the string
13461 expansion that all such lists undergo before being interpreted.
13462
13463 .vitem &$sender_fullhost$&
13464 .vindex "&$sender_fullhost$&"
13465 When a message is received from a remote host, this variable contains the host
13466 name and IP address in a single string. It ends with the IP address in square
13467 brackets, followed by a colon and a port number if the logging of ports is
13468 enabled. The format of the rest of the string depends on whether the host
13469 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13470 looking up its IP address. (Looking up the IP address can be forced by the
13471 &%host_lookup%& option, independent of verification.) A plain host name at the
13472 start of the string is a verified host name; if this is not present,
13473 verification either failed or was not requested. A host name in parentheses is
13474 the argument of a HELO or EHLO command. This is omitted if it is identical to
13475 the verified host name or to the host's IP address in square brackets.
13476
13477 .vitem &$sender_helo_dnssec$&
13478 .vindex "&$sender_helo_dnssec$&"
13479 This boolean variable is true if a successful HELO verification was
13480 .cindex "DNS" "DNSSEC"
13481 done using DNS information the resolver library stated was authenticated data.
13482
13483 .vitem &$sender_helo_name$&
13484 .vindex "&$sender_helo_name$&"
13485 When a message is received from a remote host that has issued a HELO or EHLO
13486 command, the argument of that command is placed in this variable. It is also
13487 set if HELO or EHLO is used when a message is received using SMTP locally via
13488 the &%-bs%& or &%-bS%& options.
13489
13490 .vitem &$sender_host_address$&
13491 .vindex "&$sender_host_address$&"
13492 When a message is received from a remote host using SMTP,
13493 this variable contains that
13494 host's IP address. For locally non-SMTP submitted messages, it is empty.
13495
13496 .vitem &$sender_host_authenticated$&
13497 .vindex "&$sender_host_authenticated$&"
13498 This variable contains the name (not the public name) of the authenticator
13499 driver that successfully authenticated the client from which the message was
13500 received. It is empty if there was no successful authentication. See also
13501 &$authenticated_id$&.
13502
13503 .vitem &$sender_host_dnssec$&
13504 .vindex "&$sender_host_dnssec$&"
13505 If an attempt to populate &$sender_host_name$& has been made
13506 (by reference, &%hosts_lookup%& or
13507 otherwise) then this boolean will have been set true if, and only if, the
13508 resolver library states that both
13509 the reverse and forward DNS were authenticated data.  At all
13510 other times, this variable is false.
13511
13512 .cindex "DNS" "DNSSEC"
13513 It is likely that you will need to coerce DNSSEC support on in the resolver
13514 library, by setting:
13515 .code
13516 dns_dnssec_ok = 1
13517 .endd
13518
13519 In addition, on Linux with glibc 2.31 or newer the resolver library will
13520 default to stripping out a successful validation status.
13521 This will break a previously working Exim installation.
13522 Provided that you do trust the resolver (ie, is on localhost) you can tell
13523 glibc to pass through any successful validation with a new option in
13524 &_/etc/resolv.conf_&:
13525 .code
13526 options trust-ad
13527 .endd
13528
13529 Exim does not perform DNSSEC validation itself, instead leaving that to a
13530 validating resolver (e.g. unbound, or bind with suitable configuration).
13531
13532 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13533 mechanism in the list, then this variable will be false.
13534
13535 This requires that your system resolver library support EDNS0 (and that
13536 DNSSEC flags exist in the system headers).  If the resolver silently drops
13537 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13538 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13539
13540
13541 .vitem &$sender_host_name$&
13542 .vindex "&$sender_host_name$&"
13543 When a message is received from a remote host, this variable contains the
13544 host's name as obtained by looking up its IP address. For messages received by
13545 other means, this variable is empty.
13546
13547 .vindex "&$host_lookup_failed$&"
13548 If the host name has not previously been looked up, a reference to
13549 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13550 A looked up name is accepted only if it leads back to the original IP address
13551 via a forward lookup. If either the reverse or the forward lookup fails to find
13552 any data, or if the forward lookup does not yield the original IP address,
13553 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13554
13555 .vindex "&$host_lookup_deferred$&"
13556 However, if either of the lookups cannot be completed (for example, there is a
13557 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13558 &$host_lookup_failed$& remains set to &"0"&.
13559
13560 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13561 host name again if there is a subsequent reference to &$sender_host_name$&
13562 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13563 is set to &"1"&.
13564
13565 Exim does not automatically look up every calling host's name. If you want
13566 maximum efficiency, you should arrange your configuration so that it avoids
13567 these lookups altogether. The lookup happens only if one or more of the
13568 following are true:
13569
13570 .ilist
13571 A string containing &$sender_host_name$& is expanded.
13572 .next
13573 The calling host matches the list in &%host_lookup%&. In the default
13574 configuration, this option is set to *, so it must be changed if lookups are
13575 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13576 .next
13577 Exim needs the host name in order to test an item in a host list. The items
13578 that require this are described in sections &<<SECThoslispatnam>>& and
13579 &<<SECThoslispatnamsk>>&.
13580 .next
13581 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13582 In this case, the host name is required to compare with the name quoted in any
13583 EHLO or HELO commands that the client issues.
13584 .next
13585 The remote host issues a EHLO or HELO command that quotes one of the
13586 domains in &%helo_lookup_domains%&. The default value of this option is
13587 . ==== As this is a nested list, any displays it contains must be indented
13588 . ==== as otherwise they are too far to the left.
13589 .code
13590   helo_lookup_domains = @ : @[]
13591 .endd
13592 which causes a lookup if a remote host (incorrectly) gives the server's name or
13593 IP address in an EHLO or HELO command.
13594 .endlist
13595
13596
13597 .vitem &$sender_host_port$&
13598 .vindex "&$sender_host_port$&"
13599 When a message is received from a remote host, this variable contains the port
13600 number that was used on the remote host.
13601
13602 .vitem &$sender_ident$&
13603 .vindex "&$sender_ident$&"
13604 When a message is received from a remote host, this variable contains the
13605 identification received in response to an RFC 1413 request. When a message has
13606 been received locally, this variable contains the login name of the user that
13607 called Exim.
13608
13609 .vitem &$sender_rate_$&&'xxx'&
13610 A number of variables whose names begin &$sender_rate_$& are set as part of the
13611 &%ratelimit%& ACL condition. Details are given in section
13612 &<<SECTratelimiting>>&.
13613
13614 .vitem &$sender_rcvhost$&
13615 .cindex "DNS" "reverse lookup"
13616 .cindex "reverse DNS lookup"
13617 .vindex "&$sender_rcvhost$&"
13618 This is provided specifically for use in &'Received:'& headers. It starts with
13619 either the verified host name (as obtained from a reverse DNS lookup) or, if
13620 there is no verified host name, the IP address in square brackets. After that
13621 there may be text in parentheses. When the first item is a verified host name,
13622 the first thing in the parentheses is the IP address in square brackets,
13623 followed by a colon and a port number if port logging is enabled. When the
13624 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13625 the parentheses.
13626
13627 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13628 was used and its argument was not identical to the real host name or IP
13629 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13630 all three items are present in the parentheses, a newline and tab are inserted
13631 into the string, to improve the formatting of the &'Received:'& header.
13632
13633 .vitem &$sender_verify_failure$&
13634 .vindex "&$sender_verify_failure$&"
13635 In an ACL, when a sender verification fails, this variable contains information
13636 about the failure. The details are the same as for
13637 &$recipient_verify_failure$&.
13638
13639 .vitem &$sending_ip_address$&
13640 .vindex "&$sending_ip_address$&"
13641 This variable is set whenever an outgoing SMTP connection to another host has
13642 been set up. It contains the IP address of the local interface that is being
13643 used. This is useful if a host that has more than one IP address wants to take
13644 on different personalities depending on which one is being used. For incoming
13645 connections, see &$received_ip_address$&.
13646
13647 .vitem &$sending_port$&
13648 .vindex "&$sending_port$&"
13649 This variable is set whenever an outgoing SMTP connection to another host has
13650 been set up. It contains the local port that is being used. For incoming
13651 connections, see &$received_port$&.
13652
13653 .vitem &$smtp_active_hostname$&
13654 .vindex "&$smtp_active_hostname$&"
13655 During an incoming SMTP session, this variable contains the value of the active
13656 host name, as specified by the &%smtp_active_hostname%& option. The value of
13657 &$smtp_active_hostname$& is saved with any message that is received, so its
13658 value can be consulted during routing and delivery.
13659
13660 .vitem &$smtp_command$&
13661 .vindex "&$smtp_command$&"
13662 During the processing of an incoming SMTP command, this variable contains the
13663 entire command. This makes it possible to distinguish between HELO and EHLO in
13664 the HELO ACL, and also to distinguish between commands such as these:
13665 .code
13666 MAIL FROM:<>
13667 MAIL FROM: <>
13668 .endd
13669 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13670 command, the address in &$smtp_command$& is the original address before any
13671 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13672 the address after SMTP-time rewriting.
13673
13674 .vitem &$smtp_command_argument$&
13675 .cindex "SMTP" "command, argument for"
13676 .vindex "&$smtp_command_argument$&"
13677 While an ACL is running to check an SMTP command, this variable contains the
13678 argument, that is, the text that follows the command name, with leading white
13679 space removed. Following the introduction of &$smtp_command$&, this variable is
13680 somewhat redundant, but is retained for backwards compatibility.
13681
13682 .vitem &$smtp_command_history$&
13683 .cindex SMTP "command history"
13684 .vindex "&$smtp_command_history$&"
13685 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13686 received, in time-order left to right.  Only a limited number of commands
13687 are remembered.
13688
13689 .vitem &$smtp_count_at_connection_start$&
13690 .vindex "&$smtp_count_at_connection_start$&"
13691 This variable is set greater than zero only in processes spawned by the Exim
13692 daemon for handling incoming SMTP connections. The name is deliberately long,
13693 in order to emphasize what the contents are. When the daemon accepts a new
13694 connection, it increments this variable. A copy of the variable is passed to
13695 the child process that handles the connection, but its value is fixed, and
13696 never changes. It is only an approximation of how many incoming connections
13697 there actually are, because many other connections may come and go while a
13698 single connection is being processed. When a child process terminates, the
13699 daemon decrements its copy of the variable.
13700
13701 .vitem "&$sn0$& &-- &$sn9$&"
13702 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13703 that were current at the end of the system filter file. This allows a system
13704 filter file to set values that can be tested in users' filter files. For
13705 example, a system filter could set a value indicating how likely it is that a
13706 message is junk mail.
13707
13708 .vitem &$spam_score$& &&&
13709        &$spam_score_int$& &&&
13710        &$spam_bar$& &&&
13711        &$spam_report$& &&&
13712        &$spam_action$&
13713 A number of variables whose names start with &$spam$& are available when Exim
13714 is compiled with the content-scanning extension. For details, see section
13715 &<<SECTscanspamass>>&.
13716
13717 .vitem &$spf_header_comment$& &&&
13718        &$spf_received$& &&&
13719        &$spf_result$& &&&
13720        &$spf_result_guessed$& &&&
13721        &$spf_smtp_comment$&
13722 These variables are only available if Exim is built with SPF support.
13723 For details see section &<<SECSPF>>&.
13724
13725 .vitem &$spool_directory$&
13726 .vindex "&$spool_directory$&"
13727 The name of Exim's spool directory.
13728
13729 .vitem &$spool_inodes$&
13730 .vindex "&$spool_inodes$&"
13731 The number of free inodes in the disk partition where Exim's spool files are
13732 being written. The value is recalculated whenever the variable is referenced.
13733 If the relevant file system does not have the concept of inodes, the value of
13734 is -1. See also the &%check_spool_inodes%& option.
13735
13736 .vitem &$spool_space$&
13737 .vindex "&$spool_space$&"
13738 The amount of free space (as a number of kilobytes) in the disk partition where
13739 Exim's spool files are being written. The value is recalculated whenever the
13740 variable is referenced. If the operating system does not have the ability to
13741 find the amount of free space (only true for experimental systems), the space
13742 value is -1. For example, to check in an ACL that there is at least 50
13743 megabytes free on the spool, you could write:
13744 .code
13745 condition = ${if > {$spool_space}{50000}}
13746 .endd
13747 See also the &%check_spool_space%& option.
13748
13749
13750 .vitem &$thisaddress$&
13751 .vindex "&$thisaddress$&"
13752 This variable is set only during the processing of the &%foranyaddress%&
13753 command in a filter file. Its use is explained in the description of that
13754 command, which can be found in the separate document entitled &'Exim's
13755 interfaces to mail filtering'&.
13756
13757 .vitem &$tls_in_bits$&
13758 .vindex "&$tls_in_bits$&"
13759 Contains an approximation of the TLS cipher's bit-strength
13760 on the inbound connection; the meaning of
13761 this depends upon the TLS implementation used.
13762 If TLS has not been negotiated, the value will be 0.
13763 The value of this is automatically fed into the Cyrus SASL authenticator
13764 when acting as a server, to specify the "external SSF" (a SASL term).
13765
13766 The deprecated &$tls_bits$& variable refers to the inbound side
13767 except when used in the context of an outbound SMTP delivery, when it refers to
13768 the outbound.
13769
13770 .vitem &$tls_out_bits$&
13771 .vindex "&$tls_out_bits$&"
13772 Contains an approximation of the TLS cipher's bit-strength
13773 on an outbound SMTP connection; the meaning of
13774 this depends upon the TLS implementation used.
13775 If TLS has not been negotiated, the value will be 0.
13776
13777 .vitem &$tls_in_ourcert$&
13778 .vindex "&$tls_in_ourcert$&"
13779 .cindex certificate variables
13780 This variable refers to the certificate presented to the peer of an
13781 inbound connection when the message was received.
13782 It is only useful as the argument of a
13783 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13784 or a &%def%& condition.
13785
13786 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13787 when a list of more than one
13788 file is used for &%tls_certificate%&, this variable is not reliable.
13789 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13790
13791 .vitem &$tls_in_peercert$&
13792 .vindex "&$tls_in_peercert$&"
13793 This variable refers to the certificate presented by the peer of an
13794 inbound connection when the message was received.
13795 It is only useful as the argument of a
13796 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13797 or a &%def%& condition.
13798 If certificate verification fails it may refer to a failing chain element
13799 which is not the leaf.
13800
13801 .vitem &$tls_out_ourcert$&
13802 .vindex "&$tls_out_ourcert$&"
13803 This variable refers to the certificate presented to the peer of an
13804 outbound connection.  It is only useful as the argument of a
13805 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13806 or a &%def%& condition.
13807
13808 .vitem &$tls_out_peercert$&
13809 .vindex "&$tls_out_peercert$&"
13810 This variable refers to the certificate presented by the peer of an
13811 outbound connection.  It is only useful as the argument of a
13812 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13813 or a &%def%& condition.
13814 If certificate verification fails it may refer to a failing chain element
13815 which is not the leaf.
13816
13817 .vitem &$tls_in_certificate_verified$&
13818 .vindex "&$tls_in_certificate_verified$&"
13819 This variable is set to &"1"& if a TLS certificate was verified when the
13820 message was received, and &"0"& otherwise.
13821
13822 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13823 except when used in the context of an outbound SMTP delivery, when it refers to
13824 the outbound.
13825
13826 .vitem &$tls_out_certificate_verified$&
13827 .vindex "&$tls_out_certificate_verified$&"
13828 This variable is set to &"1"& if a TLS certificate was verified when an
13829 outbound SMTP connection was made,
13830 and &"0"& otherwise.
13831
13832 .vitem &$tls_in_cipher$&
13833 .vindex "&$tls_in_cipher$&"
13834 .vindex "&$tls_cipher$&"
13835 When a message is received from a remote host over an encrypted SMTP
13836 connection, this variable is set to the cipher suite that was negotiated, for
13837 example DES-CBC3-SHA. In other circumstances, in particular, for message
13838 received over unencrypted connections, the variable is empty. Testing
13839 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13840 non-encrypted connections during ACL processing.
13841
13842 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13843 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13844 becomes the same as &$tls_out_cipher$&.
13845
13846 .vitem &$tls_in_cipher_std$&
13847 .vindex "&$tls_in_cipher_std$&"
13848 As above, but returning the RFC standard name for the cipher suite.
13849
13850 .vitem &$tls_out_cipher$&
13851 .vindex "&$tls_out_cipher$&"
13852 This variable is
13853 cleared before any outgoing SMTP connection is made,
13854 and then set to the outgoing cipher suite if one is negotiated. See chapter
13855 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13856 details of the &(smtp)& transport.
13857
13858 .vitem &$tls_out_cipher_std$&
13859 .vindex "&$tls_out_cipher_std$&"
13860 As above, but returning the RFC standard name for the cipher suite.
13861
13862 .vitem &$tls_out_dane$&
13863 .vindex &$tls_out_dane$&
13864 DANE active status.  See section &<<SECDANE>>&.
13865
13866 .vitem &$tls_in_ocsp$&
13867 .vindex "&$tls_in_ocsp$&"
13868 When a message is received from a remote client connection
13869 the result of any OCSP request from the client is encoded in this variable:
13870 .code
13871 0 OCSP proof was not requested (default value)
13872 1 No response to request
13873 2 Response not verified
13874 3 Verification failed
13875 4 Verification succeeded
13876 .endd
13877
13878 .vitem &$tls_out_ocsp$&
13879 .vindex "&$tls_out_ocsp$&"
13880 When a message is sent to a remote host connection
13881 the result of any OCSP request made is encoded in this variable.
13882 See &$tls_in_ocsp$& for values.
13883
13884 .vitem &$tls_in_peerdn$&
13885 .vindex "&$tls_in_peerdn$&"
13886 .vindex "&$tls_peerdn$&"
13887 .cindex certificate "extracting fields"
13888 When a message is received from a remote host over an encrypted SMTP
13889 connection, and Exim is configured to request a certificate from the client,
13890 the value of the Distinguished Name of the certificate is made available in the
13891 &$tls_in_peerdn$& during subsequent processing.
13892 If certificate verification fails it may refer to a failing chain element
13893 which is not the leaf.
13894
13895 The deprecated &$tls_peerdn$& variable refers to the inbound side
13896 except when used in the context of an outbound SMTP delivery, when it refers to
13897 the outbound.
13898
13899 .vitem &$tls_out_peerdn$&
13900 .vindex "&$tls_out_peerdn$&"
13901 When a message is being delivered to a remote host over an encrypted SMTP
13902 connection, and Exim is configured to request a certificate from the server,
13903 the value of the Distinguished Name of the certificate is made available in the
13904 &$tls_out_peerdn$& during subsequent processing.
13905 If certificate verification fails it may refer to a failing chain element
13906 which is not the leaf.
13907
13908
13909 .new
13910 .vitem &$tls_in_resumption$& &&&
13911        &$tls_out_resumption$&
13912 .vindex &$tls_in_resumption$&
13913 .vindex &$tls_out_resumption$&
13914 .cindex TLS resumption
13915 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13916 .wen
13917
13918
13919 .vitem &$tls_in_sni$&
13920 .vindex "&$tls_in_sni$&"
13921 .vindex "&$tls_sni$&"
13922 .cindex "TLS" "Server Name Indication"
13923 .cindex "TLS" SNI
13924 .cindex SNI "observability on server"
13925 When a TLS session is being established, if the client sends the Server
13926 Name Indication extension, the value will be placed in this variable.
13927 If the variable appears in &%tls_certificate%& then this option and
13928 some others, described in &<<SECTtlssni>>&,
13929 will be re-expanded early in the TLS session, to permit
13930 a different certificate to be presented (and optionally a different key to be
13931 used) to the client, based upon the value of the SNI extension.
13932
13933 The deprecated &$tls_sni$& variable refers to the inbound side
13934 except when used in the context of an outbound SMTP delivery, when it refers to
13935 the outbound.
13936
13937 .vitem &$tls_out_sni$&
13938 .vindex "&$tls_out_sni$&"
13939 .cindex "TLS" "Server Name Indication"
13940 .cindex "TLS" SNI
13941 .cindex SNI "observability in client"
13942 During outbound
13943 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13944 the transport.
13945
13946 .vitem &$tls_out_tlsa_usage$&
13947 .vindex &$tls_out_tlsa_usage$&
13948 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13949
13950 .vitem &$tls_in_ver$&
13951 .vindex "&$tls_in_ver$&"
13952 When a message is received from a remote host over an encrypted SMTP connection
13953 this variable is set to the protocol version, eg &'TLS1.2'&.
13954
13955 .vitem &$tls_out_ver$&
13956 .vindex "&$tls_out_ver$&"
13957 When a message is being delivered to a remote host over an encrypted SMTP connection
13958 this variable is set to the protocol version.
13959
13960
13961 .vitem &$tod_bsdinbox$&
13962 .vindex "&$tod_bsdinbox$&"
13963 The time of day and the date, in the format required for BSD-style mailbox
13964 files, for example: Thu Oct 17 17:14:09 1995.
13965
13966 .vitem &$tod_epoch$&
13967 .vindex "&$tod_epoch$&"
13968 The time and date as a number of seconds since the start of the Unix epoch.
13969
13970 .vitem &$tod_epoch_l$&
13971 .vindex "&$tod_epoch_l$&"
13972 The time and date as a number of microseconds since the start of the Unix epoch.
13973
13974 .vitem &$tod_full$&
13975 .vindex "&$tod_full$&"
13976 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13977 +0100. The timezone is always given as a numerical offset from UTC, with
13978 positive values used for timezones that are ahead (east) of UTC, and negative
13979 values for those that are behind (west).
13980
13981 .vitem &$tod_log$&
13982 .vindex "&$tod_log$&"
13983 The time and date in the format used for writing Exim's log files, for example:
13984 1995-10-12 15:32:29, but without a timezone.
13985
13986 .vitem &$tod_logfile$&
13987 .vindex "&$tod_logfile$&"
13988 This variable contains the date in the format yyyymmdd. This is the format that
13989 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13990 flag.
13991
13992 .vitem &$tod_zone$&
13993 .vindex "&$tod_zone$&"
13994 This variable contains the numerical value of the local timezone, for example:
13995 -0500.
13996
13997 .vitem &$tod_zulu$&
13998 .vindex "&$tod_zulu$&"
13999 This variable contains the UTC date and time in &"Zulu"& format, as specified
14000 by ISO 8601, for example: 20030221154023Z.
14001
14002 .vitem &$transport_name$&
14003 .cindex "transport" "name"
14004 .cindex "name" "of transport"
14005 .vindex "&$transport_name$&"
14006 During the running of a transport, this variable contains its name.
14007
14008 .vitem &$value$&
14009 .vindex "&$value$&"
14010 This variable contains the result of an expansion lookup, extraction operation,
14011 or external command, as described above. It is also used during a
14012 &*reduce*& expansion.
14013
14014 .vitem &$verify_mode$&
14015 .vindex "&$verify_mode$&"
14016 While a router or transport is being run in verify mode or for cutthrough delivery,
14017 contains "S" for sender-verification or "R" for recipient-verification.
14018 Otherwise, empty.
14019
14020 .vitem &$version_number$&
14021 .vindex "&$version_number$&"
14022 The version number of Exim. Same as &$exim_version$&, may be overridden
14023 by the &%exim_version%& main config option.
14024
14025 .vitem &$warn_message_delay$&
14026 .vindex "&$warn_message_delay$&"
14027 This variable is set only during the creation of a message warning about a
14028 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14029
14030 .vitem &$warn_message_recipients$&
14031 .vindex "&$warn_message_recipients$&"
14032 This variable is set only during the creation of a message warning about a
14033 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14034 .endlist
14035 .ecindex IIDstrexp
14036
14037
14038
14039 . ////////////////////////////////////////////////////////////////////////////
14040 . ////////////////////////////////////////////////////////////////////////////
14041
14042 .chapter "Embedded Perl" "CHAPperl"
14043 .scindex IIDperl "Perl" "calling from Exim"
14044 Exim can be built to include an embedded Perl interpreter. When this is done,
14045 Perl subroutines can be called as part of the string expansion process. To make
14046 use of the Perl support, you need version 5.004 or later of Perl installed on
14047 your system. To include the embedded interpreter in the Exim binary, include
14048 the line
14049 .code
14050 EXIM_PERL = perl.o
14051 .endd
14052 in your &_Local/Makefile_& and then build Exim in the normal way.
14053
14054
14055 .section "Setting up so Perl can be used" "SECID85"
14056 .oindex "&%perl_startup%&"
14057 Access to Perl subroutines is via a global configuration option called
14058 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14059 no &%perl_startup%& option in the Exim configuration file then no Perl
14060 interpreter is started and there is almost no overhead for Exim (since none of
14061 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14062 option then the associated value is taken to be Perl code which is executed in
14063 a newly created Perl interpreter.
14064
14065 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14066 need backslashes before any characters to escape special meanings. The option
14067 should usually be something like
14068 .code
14069 perl_startup = do '/etc/exim.pl'
14070 .endd
14071 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14072 use from Exim. Exim can be configured either to start up a Perl interpreter as
14073 soon as it is entered, or to wait until the first time it is needed. Starting
14074 the interpreter at the beginning ensures that it is done while Exim still has
14075 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14076 fact used in a particular run. Also, note that this does not mean that Exim is
14077 necessarily running as root when Perl is called at a later time. By default,
14078 the interpreter is started only when it is needed, but this can be changed in
14079 two ways:
14080
14081 .ilist
14082 .oindex "&%perl_at_start%&"
14083 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14084 a startup when Exim is entered.
14085 .next
14086 The command line option &%-ps%& also requests a startup when Exim is entered,
14087 overriding the setting of &%perl_at_start%&.
14088 .endlist
14089
14090 There is also a command line option &%-pd%& (for delay) which suppresses the
14091 initial startup, even if &%perl_at_start%& is set.
14092
14093 .ilist
14094 .oindex "&%perl_taintmode%&"
14095 .cindex "Perl" "taintmode"
14096 To provide more security executing Perl code via the embedded Perl
14097 interpreter, the &%perl_taintmode%& option can be set. This enables the
14098 taint mode of the Perl interpreter. You are encouraged to set this
14099 option to a true value. To avoid breaking existing installations, it
14100 defaults to false.
14101
14102 .new
14103 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14104 .wen
14105
14106
14107 .section "Calling Perl subroutines" "SECID86"
14108 When the configuration file includes a &%perl_startup%& option you can make use
14109 of the string expansion item to call the Perl subroutines that are defined
14110 by the &%perl_startup%& code. The operator is used in any of the following
14111 forms:
14112 .code
14113 ${perl{foo}}
14114 ${perl{foo}{argument}}
14115 ${perl{foo}{argument1}{argument2} ... }
14116 .endd
14117 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14118 arguments may be passed. Passing more than this results in an expansion failure
14119 with an error message of the form
14120 .code
14121 Too many arguments passed to Perl subroutine "foo" (max is 8)
14122 .endd
14123 The return value of the Perl subroutine is evaluated in a scalar context before
14124 it is passed back to Exim to be inserted into the expanded string. If the
14125 return value is &'undef'&, the expansion is forced to fail in the same way as
14126 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14127 by obeying Perl's &%die%& function, the expansion fails with the error message
14128 that was passed to &%die%&.
14129
14130
14131 .section "Calling Exim functions from Perl" "SECID87"
14132 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14133 is available to call back into Exim's string expansion function. For example,
14134 the Perl code
14135 .code
14136 my $lp = Exim::expand_string('$local_part');
14137 .endd
14138 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14139 Note those are single quotes and not double quotes to protect against
14140 &$local_part$& being interpolated as a Perl variable.
14141
14142 If the string expansion is forced to fail by a &"fail"& item, the result of
14143 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14144 expansion string, the Perl call from the original expansion string fails with
14145 an appropriate error message, in the same way as if &%die%& were used.
14146
14147 .cindex "debugging" "from embedded Perl"
14148 .cindex "log" "writing from embedded Perl"
14149 Two other Exim functions are available for use from within Perl code.
14150 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14151 debugging is enabled. If you want a newline at the end, you must supply it.
14152 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14153 timestamp. In this case, you should not supply a terminating newline.
14154
14155
14156 .section "Use of standard output and error by Perl" "SECID88"
14157 .cindex "Perl" "standard output and error"
14158 You should not write to the standard error or output streams from within your
14159 Perl code, as it is not defined how these are set up. In versions of Exim
14160 before 4.50, it is possible for the standard output or error to refer to the
14161 SMTP connection during message reception via the daemon. Writing to this stream
14162 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14163 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14164 avoided, but the output is lost.
14165
14166 .cindex "Perl" "use of &%warn%&"
14167 The Perl &%warn%& statement writes to the standard error stream by default.
14168 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14169 you have no control. When Exim starts up the Perl interpreter, it arranges for
14170 output from the &%warn%& statement to be written to the Exim main log. You can
14171 change this by including appropriate Perl magic somewhere in your Perl code.
14172 For example, to discard &%warn%& output completely, you need this:
14173 .code
14174 $SIG{__WARN__} = sub { };
14175 .endd
14176 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14177 example, the code for the subroutine is empty, so it does nothing, but you can
14178 include any Perl code that you like. The text of the &%warn%& message is passed
14179 as the first subroutine argument.
14180 .ecindex IIDperl
14181
14182
14183 . ////////////////////////////////////////////////////////////////////////////
14184 . ////////////////////////////////////////////////////////////////////////////
14185
14186 .chapter "Starting the daemon and the use of network interfaces" &&&
14187          "CHAPinterfaces" &&&
14188          "Starting the daemon"
14189 .cindex "daemon" "starting"
14190 .cindex "interface" "listening"
14191 .cindex "network interface"
14192 .cindex "interface" "network"
14193 .cindex "IP address" "for listening"
14194 .cindex "daemon" "listening IP addresses"
14195 .cindex "TCP/IP" "setting listening interfaces"
14196 .cindex "TCP/IP" "setting listening ports"
14197 A host that is connected to a TCP/IP network may have one or more physical
14198 hardware network interfaces. Each of these interfaces may be configured as one
14199 or more &"logical"& interfaces, which are the entities that a program actually
14200 works with. Each of these logical interfaces is associated with an IP address.
14201 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14202 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14203 knowledge about the host's interfaces for use in three different circumstances:
14204
14205 .olist
14206 When a listening daemon is started, Exim needs to know which interfaces
14207 and ports to listen on.
14208 .next
14209 When Exim is routing an address, it needs to know which IP addresses
14210 are associated with local interfaces. This is required for the correct
14211 processing of MX lists by removing the local host and others with the
14212 same or higher priority values. Also, Exim needs to detect cases
14213 when an address is routed to an IP address that in fact belongs to the
14214 local host. Unless the &%self%& router option or the &%allow_localhost%&
14215 option of the smtp transport is set (as appropriate), this is treated
14216 as an error situation.
14217 .next
14218 When Exim connects to a remote host, it may need to know which interface to use
14219 for the outgoing connection.
14220 .endlist
14221
14222
14223 Exim's default behaviour is likely to be appropriate in the vast majority
14224 of cases. If your host has only one interface, and you want all its IP
14225 addresses to be treated in the same way, and you are using only the
14226 standard SMTP port, you should not need to take any special action. The
14227 rest of this chapter does not apply to you.
14228
14229 In a more complicated situation you may want to listen only on certain
14230 interfaces, or on different ports, and for this reason there are a number of
14231 options that can be used to influence Exim's behaviour. The rest of this
14232 chapter describes how they operate.
14233
14234 When a message is received over TCP/IP, the interface and port that were
14235 actually used are set in &$received_ip_address$& and &$received_port$&.
14236
14237
14238
14239 .section "Starting a listening daemon" "SECID89"
14240 When a listening daemon is started (by means of the &%-bd%& command line
14241 option), the interfaces and ports on which it listens are controlled by the
14242 following options:
14243
14244 .ilist
14245 &%daemon_smtp_ports%& contains a list of default ports
14246 or service names.
14247 (For backward compatibility, this option can also be specified in the singular.)
14248 .next
14249 &%local_interfaces%& contains list of interface IP addresses on which to
14250 listen. Each item may optionally also specify a port.
14251 .endlist
14252
14253 The default list separator in both cases is a colon, but this can be changed as
14254 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14255 it is usually best to change the separator to avoid having to double all the
14256 colons. For example:
14257 .code
14258 local_interfaces = <; 127.0.0.1 ; \
14259                       192.168.23.65 ; \
14260                       ::1 ; \
14261                       3ffe:ffff:836f::fe86:a061
14262 .endd
14263 There are two different formats for specifying a port along with an IP address
14264 in &%local_interfaces%&:
14265
14266 .olist
14267 The port is added onto the address with a dot separator. For example, to listen
14268 on port 1234 on two different IP addresses:
14269 .code
14270 local_interfaces = <; 192.168.23.65.1234 ; \
14271                       3ffe:ffff:836f::fe86:a061.1234
14272 .endd
14273 .next
14274 The IP address is enclosed in square brackets, and the port is added
14275 with a colon separator, for example:
14276 .code
14277 local_interfaces = <; [192.168.23.65]:1234 ; \
14278                       [3ffe:ffff:836f::fe86:a061]:1234
14279 .endd
14280 .endlist
14281
14282 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14283 default setting contains just one port:
14284 .code
14285 daemon_smtp_ports = smtp
14286 .endd
14287 If more than one port is listed, each interface that does not have its own port
14288 specified listens on all of them. Ports that are listed in
14289 &%daemon_smtp_ports%& can be identified either by name (defined in
14290 &_/etc/services_&) or by number. However, when ports are given with individual
14291 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14292
14293
14294
14295 .section "Special IP listening addresses" "SECID90"
14296 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14297 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14298 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14299 instead of setting up separate listening sockets for each interface. The
14300 default value of &%local_interfaces%& is
14301 .code
14302 local_interfaces = 0.0.0.0
14303 .endd
14304 when Exim is built without IPv6 support; otherwise it is:
14305 .code
14306 local_interfaces = <; ::0 ; 0.0.0.0
14307 .endd
14308 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14309
14310
14311
14312 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14313 The &%-oX%& command line option can be used to override the values of
14314 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14315 instance. Another way of doing this would be to use macros and the &%-D%&
14316 option. However, &%-oX%& can be used by any admin user, whereas modification of
14317 the runtime configuration by &%-D%& is allowed only when the caller is root or
14318 exim.
14319
14320 The value of &%-oX%& is a list of items. The default colon separator can be
14321 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14322 If there are any items that do not
14323 contain dots or colons (that is, are not IP addresses), the value of
14324 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14325 items that do contain dots or colons, the value of &%local_interfaces%& is
14326 replaced by those items. Thus, for example,
14327 .code
14328 -oX 1225
14329 .endd
14330 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14331 whereas
14332 .code
14333 -oX 192.168.34.5.1125
14334 .endd
14335 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14336 (However, since &%local_interfaces%& now contains no items without ports, the
14337 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14338
14339
14340
14341 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14342 .cindex "submissions protocol"
14343 .cindex "ssmtp protocol"
14344 .cindex "smtps protocol"
14345 .cindex "SMTP" "ssmtp protocol"
14346 .cindex "SMTP" "smtps protocol"
14347 Exim supports the use of TLS-on-connect, used by mail clients in the
14348 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14349 For some years, IETF Standards Track documents only blessed the
14350 STARTTLS-based Submission service (port 587) while common practice was to support
14351 the same feature set on port 465, but using TLS-on-connect.
14352 If your installation needs to provide service to mail clients
14353 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14354 the 465 TCP ports.
14355
14356 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14357 service names, connections to those ports must first establish TLS, before
14358 proceeding to the application layer use of the SMTP protocol.
14359
14360 The common use of this option is expected to be
14361 .code
14362 tls_on_connect_ports = 465
14363 .endd
14364 per RFC 8314.
14365 There is also a command line option &%-tls-on-connect%&, which forces all ports
14366 to behave in this way when a daemon is started.
14367
14368 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14369 daemon to listen on those ports. You must still specify them in
14370 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14371 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14372 connections via the daemon.)
14373
14374
14375
14376
14377 .section "IPv6 address scopes" "SECID92"
14378 .cindex "IPv6" "address scopes"
14379 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14380 can, in principle, have the same link-local IPv6 address on different
14381 interfaces. Thus, additional information is needed, over and above the IP
14382 address, to distinguish individual interfaces. A convention of using a
14383 percent sign followed by something (often the interface name) has been
14384 adopted in some cases, leading to addresses like this:
14385 .code
14386 fe80::202:b3ff:fe03:45c1%eth0
14387 .endd
14388 To accommodate this usage, a percent sign followed by an arbitrary string is
14389 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14390 to convert a textual IPv6 address for actual use. This function recognizes the
14391 percent convention in operating systems that support it, and it processes the
14392 address appropriately. Unfortunately, some older libraries have problems with
14393 &[getaddrinfo()]&. If
14394 .code
14395 IPV6_USE_INET_PTON=yes
14396 .endd
14397 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14398 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14399 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14400 function.) Of course, this means that the additional functionality of
14401 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14402
14403 .section "Disabling IPv6" "SECID93"
14404 .cindex "IPv6" "disabling"
14405 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14406 run on a host whose kernel does not support IPv6. The binary will fall back to
14407 using IPv4, but it may waste resources looking up AAAA records, and trying to
14408 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14409 .oindex "&%disable_ipv6%&"
14410 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14411 activities take place. AAAA records are never looked up, and any IPv6 addresses
14412 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14413 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14414 to handle IPv6 literal addresses.
14415
14416 On the other hand, when IPv6 is in use, there may be times when you want to
14417 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14418 option to globally suppress the lookup of AAAA records for specified domains,
14419 and you can use the &%ignore_target_hosts%& generic router option to ignore
14420 IPv6 addresses in an individual router.
14421
14422
14423
14424 .section "Examples of starting a listening daemon" "SECID94"
14425 The default case in an IPv6 environment is
14426 .code
14427 daemon_smtp_ports = smtp
14428 local_interfaces = <; ::0 ; 0.0.0.0
14429 .endd
14430 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14431 Either one or two sockets may be used, depending on the characteristics of
14432 the TCP/IP stack. (This is complicated and messy; for more information,
14433 read the comments in the &_daemon.c_& source file.)
14434
14435 To specify listening on ports 25 and 26 on all interfaces:
14436 .code
14437 daemon_smtp_ports = 25 : 26
14438 .endd
14439 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14440 .code
14441 local_interfaces = <; ::0.25     ; ::0.26 \
14442                       0.0.0.0.25 ; 0.0.0.0.26
14443 .endd
14444 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14445 IPv4 loopback address only:
14446 .code
14447 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14448 .endd
14449 To specify listening on the default port on specific interfaces only:
14450 .code
14451 local_interfaces = 10.0.0.67 : 192.168.34.67
14452 .endd
14453 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14454
14455
14456
14457 .section "Recognizing the local host" "SECTreclocipadd"
14458 The &%local_interfaces%& option is also used when Exim needs to determine
14459 whether or not an IP address refers to the local host. That is, the IP
14460 addresses of all the interfaces on which a daemon is listening are always
14461 treated as local.
14462
14463 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14464 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14465 available interfaces from the operating system, and extracts the relevant
14466 (that is, IPv4 or IPv6) addresses to use for checking.
14467
14468 Some systems set up large numbers of virtual interfaces in order to provide
14469 many virtual web servers. In this situation, you may want to listen for
14470 email on only a few of the available interfaces, but nevertheless treat all
14471 interfaces as local when routing. You can do this by setting
14472 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14473 &"all"& wildcard values. These addresses are recognized as local, but are not
14474 used for listening. Consider this example:
14475 .code
14476 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14477                       192.168.53.235 ; \
14478                       3ffe:2101:12:1:a00:20ff:fe86:a061
14479
14480 extra_local_interfaces = <; ::0 ; 0.0.0.0
14481 .endd
14482 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14483 address, but all available interface addresses are treated as local when
14484 Exim is routing.
14485
14486 In some environments the local host name may be in an MX list, but with an IP
14487 address that is not assigned to any local interface. In other cases it may be
14488 desirable to treat other host names as if they referred to the local host. Both
14489 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14490 This contains host names rather than IP addresses. When a host is referenced
14491 during routing, either via an MX record or directly, it is treated as the local
14492 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14493 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14494
14495
14496
14497 .section "Delivering to a remote host" "SECID95"
14498 Delivery to a remote host is handled by the smtp transport. By default, it
14499 allows the system's TCP/IP functions to choose which interface to use (if
14500 there is more than one) when connecting to a remote host. However, the
14501 &%interface%& option can be set to specify which interface is used. See the
14502 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14503 details.
14504
14505
14506
14507
14508 . ////////////////////////////////////////////////////////////////////////////
14509 . ////////////////////////////////////////////////////////////////////////////
14510
14511 .chapter "Main configuration" "CHAPmainconfig"
14512 .scindex IIDconfima "configuration file" "main section"
14513 .scindex IIDmaiconf "main configuration"
14514 The first part of the runtime configuration file contains three types of item:
14515
14516 .ilist
14517 Macro definitions: These lines start with an upper case letter. See section
14518 &<<SECTmacrodefs>>& for details of macro processing.
14519 .next
14520 Named list definitions: These lines start with one of the words &"domainlist"&,
14521 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14522 section &<<SECTnamedlists>>&.
14523 .next
14524 Main configuration settings: Each setting occupies one line of the file
14525 (with possible continuations). If any setting is preceded by the word
14526 &"hide"&, the &%-bP%& command line option displays its value to admin users
14527 only. See section &<<SECTcos>>& for a description of the syntax of these option
14528 settings.
14529 .endlist
14530
14531 This chapter specifies all the main configuration options, along with their
14532 types and default values. For ease of finding a particular option, they appear
14533 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14534 are now so many options, they are first listed briefly in functional groups, as
14535 an aid to finding the name of the option you are looking for. Some options are
14536 listed in more than one group.
14537
14538 .section "Miscellaneous" "SECID96"
14539 .table2
14540 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14541 .row &%debug_store%&                 "do extra internal checks"
14542 .row &%disable_ipv6%&                "do no IPv6 processing"
14543 .row &%keep_malformed%&              "for broken files &-- should not happen"
14544 .row &%localhost_number%&            "for unique message ids in clusters"
14545 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14546 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14547 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14548 .row &%print_topbitchars%&           "top-bit characters are printing"
14549 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14550 .row &%timezone%&                    "force time zone"
14551 .endtable
14552
14553
14554 .section "Exim parameters" "SECID97"
14555 .table2
14556 .row &%exim_group%&                  "override compiled-in value"
14557 .row &%exim_path%&                   "override compiled-in value"
14558 .row &%exim_user%&                   "override compiled-in value"
14559 .row &%primary_hostname%&            "default from &[uname()]&"
14560 .row &%split_spool_directory%&       "use multiple directories"
14561 .row &%spool_directory%&             "override compiled-in value"
14562 .endtable
14563
14564
14565
14566 .section "Privilege controls" "SECID98"
14567 .table2
14568 .row &%admin_groups%&                "groups that are Exim admin users"
14569 .row &%commandline_checks_require_admin%& "require admin for various checks"
14570 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14571 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14572 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14573 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14574 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14575 .row &%never_users%&                 "do not run deliveries as these"
14576 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14577 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14578 .row &%trusted_groups%&              "groups that are trusted"
14579 .row &%trusted_users%&               "users that are trusted"
14580 .endtable
14581
14582
14583
14584 .section "Logging" "SECID99"
14585 .table2
14586 .row &%event_action%&                "custom logging"
14587 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14588 .row &%log_file_path%&               "override compiled-in value"
14589 .row &%log_selector%&                "set/unset optional logging"
14590 .row &%log_timezone%&                "add timezone to log lines"
14591 .row &%message_logs%&                "create per-message logs"
14592 .row &%preserve_message_logs%&       "after message completion"
14593 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14594 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14595 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14596 .row &%syslog_facility%&             "set syslog &""facility""& field"
14597 .row &%syslog_pid%&                  "pid in syslog lines"
14598 .row &%syslog_processname%&          "set syslog &""ident""& field"
14599 .row &%syslog_timestamp%&            "timestamp syslog lines"
14600 .row &%write_rejectlog%&             "control use of message log"
14601 .endtable
14602
14603
14604
14605 .section "Frozen messages" "SECID100"
14606 .table2
14607 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14608 .row &%freeze_tell%&                 "send message when freezing"
14609 .row &%move_frozen_messages%&        "to another directory"
14610 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14611 .endtable
14612
14613
14614
14615 .section "Data lookups" "SECID101"
14616 .table2
14617 .row &%ibase_servers%&               "InterBase servers"
14618 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14619 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14620 .row &%ldap_cert_file%&              "client cert file for LDAP"
14621 .row &%ldap_cert_key%&               "client key file for LDAP"
14622 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14623 .row &%ldap_default_servers%&        "used if no server in query"
14624 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14625 .row &%ldap_start_tls%&              "require TLS within LDAP"
14626 .row &%ldap_version%&                "set protocol version"
14627 .row &%lookup_open_max%&             "lookup files held open"
14628 .row &%mysql_servers%&               "default MySQL servers"
14629 .row &%oracle_servers%&              "Oracle servers"
14630 .row &%pgsql_servers%&               "default PostgreSQL servers"
14631 .row &%sqlite_lock_timeout%&         "as it says"
14632 .endtable
14633
14634
14635
14636 .section "Message ids" "SECID102"
14637 .table2
14638 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14639 .row &%message_id_header_text%&      "ditto"
14640 .endtable
14641
14642
14643
14644 .section "Embedded Perl Startup" "SECID103"
14645 .table2
14646 .row &%perl_at_start%&               "always start the interpreter"
14647 .row &%perl_startup%&                "code to obey when starting Perl"
14648 .row &%perl_taintmode%&              "enable taint mode in Perl"
14649 .endtable
14650
14651
14652
14653 .section "Daemon" "SECID104"
14654 .table2
14655 .row &%daemon_smtp_ports%&           "default ports"
14656 .row &%daemon_startup_retries%&      "number of times to retry"
14657 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14658 .row &%extra_local_interfaces%&      "not necessarily listened on"
14659 .row &%local_interfaces%&            "on which to listen, with optional ports"
14660 .row &%notifier_socket%&             "override compiled-in value"
14661 .row &%pid_file_path%&               "override compiled-in value"
14662 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14663 .endtable
14664
14665
14666
14667 .section "Resource control" "SECID105"
14668 .table2
14669 .row &%check_log_inodes%&            "before accepting a message"
14670 .row &%check_log_space%&             "before accepting a message"
14671 .row &%check_spool_inodes%&          "before accepting a message"
14672 .row &%check_spool_space%&           "before accepting a message"
14673 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14674 .row &%queue_only_load%&             "queue incoming if load high"
14675 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14676 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14677 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14678 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14679 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14680 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14681 .row &%smtp_accept_max_per_connection%& "messages per connection"
14682 .row &%smtp_accept_max_per_host%&    "connections from one host"
14683 .row &%smtp_accept_queue%&           "queue mail if more connections"
14684 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14685                                            connection"
14686 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14687 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14688 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14689 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14690 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14691 .endtable
14692
14693
14694
14695 .section "Policy controls" "SECID106"
14696 .table2
14697 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14698 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14699 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14700 .row &%acl_smtp_auth%&               "ACL for AUTH"
14701 .row &%acl_smtp_connect%&            "ACL for connection"
14702 .row &%acl_smtp_data%&               "ACL for DATA"
14703 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14704 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14705 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14706 .row &%acl_smtp_expn%&               "ACL for EXPN"
14707 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14708 .row &%acl_smtp_mail%&               "ACL for MAIL"
14709 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14710 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14711 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14712 .row &%acl_smtp_predata%&            "ACL for start of data"
14713 .row &%acl_smtp_quit%&               "ACL for QUIT"
14714 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14715 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14716 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14717 .row &%av_scanner%&                  "specify virus scanner"
14718 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14719                                       words""&"
14720 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14721 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14722 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14723 .row &%header_maxsize%&              "total size of message header"
14724 .row &%header_line_maxsize%&         "individual header line limit"
14725 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14726 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14727 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14728 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14729 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14730 .row &%host_lookup%&                 "host name looked up for these hosts"
14731 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14732 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14733 .row &%host_reject_connection%&      "reject connection from these hosts"
14734 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14735 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14736 .row &%message_size_limit%&          "for all messages"
14737 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14738 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14739 .row &%spamd_address%&               "set interface to SpamAssassin"
14740 .row &%strict_acl_vars%&             "object to unset ACL variables"
14741 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14742 .endtable
14743
14744
14745
14746 .section "Callout cache" "SECID107"
14747 .table2
14748 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14749                                          item"
14750 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14751                                          item"
14752 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14753 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14754 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14755 .endtable
14756
14757
14758
14759 .section "TLS" "SECID108"
14760 .table2
14761 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14762 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14763 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14764 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14765 .row &%tls_certificate%&             "location of server certificate"
14766 .row &%tls_crl%&                     "certificate revocation list"
14767 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14768 .row &%tls_dhparam%&                 "DH parameters for server"
14769 .row &%tls_eccurve%&                 "EC curve selection for server"
14770 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14771 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14772 .row &%tls_privatekey%&              "location of server private key"
14773 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14774 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14775 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14776 .row &%tls_verify_certificates%&     "expected client certificates"
14777 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14778 .endtable
14779
14780
14781
14782 .section "Local user handling" "SECID109"
14783 .table2
14784 .row &%finduser_retries%&            "useful in NIS environments"
14785 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14786 .row &%gecos_pattern%&               "ditto"
14787 .row &%max_username_length%&         "for systems that truncate"
14788 .row &%unknown_login%&               "used when no login name found"
14789 .row &%unknown_username%&            "ditto"
14790 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14791 .row &%uucp_from_sender%&            "ditto"
14792 .endtable
14793
14794
14795
14796 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14797 .table2
14798 .row &%header_maxsize%&              "total size of message header"
14799 .row &%header_line_maxsize%&         "individual header line limit"
14800 .row &%message_size_limit%&          "applies to all messages"
14801 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14802 .row &%received_header_text%&        "expanded to make &'Received:'&"
14803 .row &%received_headers_max%&        "for mail loop detection"
14804 .row &%recipients_max%&              "limit per message"
14805 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14806 .endtable
14807
14808
14809
14810
14811 .section "Non-SMTP incoming messages" "SECID111"
14812 .table2
14813 .row &%receive_timeout%&             "for non-SMTP messages"
14814 .endtable
14815
14816
14817
14818
14819
14820 .section "Incoming SMTP messages" "SECID112"
14821 See also the &'Policy controls'& section above.
14822
14823 .table2
14824 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14825 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14826 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14827 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14828 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14829 .row &%dmarc_history_file%&          "DMARC results log"
14830 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14831 .row &%host_lookup%&                 "host name looked up for these hosts"
14832 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14833 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14834 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14835 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14836 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14837 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14838 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14839 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14840 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14841 .row &%smtp_accept_max_per_connection%& "messages per connection"
14842 .row &%smtp_accept_max_per_host%&    "connections from one host"
14843 .row &%smtp_accept_queue%&           "queue mail if more connections"
14844 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14845                                            connection"
14846 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14847 .row &%smtp_active_hostname%&        "host name to use in messages"
14848 .row &%smtp_banner%&                 "text for welcome banner"
14849 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14850 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14851 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14852 .row &%smtp_etrn_command%&           "what to run for ETRN"
14853 .row &%smtp_etrn_serialize%&         "only one at once"
14854 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14855 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14856 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14857 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14858 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14859 .row &%smtp_receive_timeout%&        "per command or data line"
14860 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14861 .row &%smtp_return_error_details%&   "give detail on rejections"
14862 .endtable
14863
14864
14865
14866 .section "SMTP extensions" "SECID113"
14867 .table2
14868 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14869 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14870 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14871 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14872 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14873 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14874 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14875 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14876 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14877 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14878 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14879 .endtable
14880
14881
14882
14883 .section "Processing messages" "SECID114"
14884 .table2
14885 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14886 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14887 .row &%allow_utf8_domains%&          "in addresses"
14888 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14889                                       words""&"
14890 .row &%delivery_date_remove%&        "from incoming messages"
14891 .row &%envelope_to_remove%&          "from incoming messages"
14892 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14893 .row &%headers_charset%&             "default for translations"
14894 .row &%qualify_domain%&              "default for senders"
14895 .row &%qualify_recipient%&           "default for recipients"
14896 .row &%return_path_remove%&          "from incoming messages"
14897 .row &%strip_excess_angle_brackets%& "in addresses"
14898 .row &%strip_trailing_dot%&          "at end of addresses"
14899 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14900 .endtable
14901
14902
14903
14904 .section "System filter" "SECID115"
14905 .table2
14906 .row &%system_filter%&               "locate system filter"
14907 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14908                                             directory"
14909 .row &%system_filter_file_transport%& "transport for delivery to a file"
14910 .row &%system_filter_group%&         "group for filter running"
14911 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14912 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14913 .row &%system_filter_user%&          "user for filter running"
14914 .endtable
14915
14916
14917
14918 .section "Routing and delivery" "SECID116"
14919 .table2
14920 .row &%disable_ipv6%&                "do no IPv6 processing"
14921 .row &%dns_again_means_nonexist%&    "for broken domains"
14922 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14923 .row &%dns_dnssec_ok%&               "parameter for resolver"
14924 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14925 .row &%dns_retrans%&                 "parameter for resolver"
14926 .row &%dns_retry%&                   "parameter for resolver"
14927 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14928 .row &%dns_use_edns0%&               "parameter for resolver"
14929 .row &%hold_domains%&                "hold delivery for these domains"
14930 .row &%local_interfaces%&            "for routing checks"
14931 .row &%queue_domains%&               "no immediate delivery for these"
14932 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14933 .row &%queue_only%&                  "no immediate delivery at all"
14934 .row &%queue_only_file%&             "no immediate delivery if file exists"
14935 .row &%queue_only_load%&             "no immediate delivery if load is high"
14936 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14937 .row &%queue_only_override%&         "allow command line to override"
14938 .row &%queue_run_in_order%&          "order of arrival"
14939 .row &%queue_run_max%&               "of simultaneous queue runners"
14940 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14941 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14942 .row &%remote_sort_domains%&         "order of remote deliveries"
14943 .row &%retry_data_expire%&           "timeout for retry data"
14944 .row &%retry_interval_max%&          "safety net for retry rules"
14945 .endtable
14946
14947
14948
14949 .section "Bounce and warning messages" "SECID117"
14950 .table2
14951 .row &%bounce_message_file%&         "content of bounce"
14952 .row &%bounce_message_text%&         "content of bounce"
14953 .row &%bounce_return_body%&          "include body if returning message"
14954 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14955 .row &%bounce_return_message%&       "include original message in bounce"
14956 .row &%bounce_return_size_limit%&    "limit on returned message"
14957 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14958 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14959 .row &%errors_copy%&                 "copy bounce messages"
14960 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14961 .row &%delay_warning%&               "time schedule"
14962 .row &%delay_warning_condition%&     "condition for warning messages"
14963 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14964 .row &%smtp_return_error_details%&   "give detail on rejections"
14965 .row &%warn_message_file%&           "content of warning message"
14966 .endtable
14967
14968
14969
14970 .section "Alphabetical list of main options" "SECTalomo"
14971 Those options that undergo string expansion before use are marked with
14972 &dagger;.
14973
14974 .option accept_8bitmime main boolean true
14975 .cindex "8BITMIME"
14976 .cindex "8-bit characters"
14977 .cindex "log" "selectors"
14978 .cindex "log" "8BITMIME"
14979 .cindex "ESMTP extensions" 8BITMIME
14980 This option causes Exim to send 8BITMIME in its response to an SMTP
14981 EHLO command, and to accept the BODY= parameter on MAIL commands.
14982 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14983 takes no steps to do anything special with messages received by this route.
14984
14985 Historically Exim kept this option off by default, but the maintainers
14986 feel that in today's Internet, this causes more problems than it solves.
14987 It now defaults to true.
14988 A more detailed analysis of the issues is provided by Dan Bernstein:
14989 .display
14990 &url(https://cr.yp.to/smtp/8bitmime.html)
14991 .endd
14992
14993 To log received 8BITMIME status use
14994 .code
14995 log_selector = +8bitmime
14996 .endd
14997
14998 .option acl_not_smtp main string&!! unset
14999 .cindex "&ACL;" "for non-SMTP messages"
15000 .cindex "non-SMTP messages" "ACLs for"
15001 This option defines the ACL that is run when a non-SMTP message has been
15002 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15003 further details.
15004
15005 .option acl_not_smtp_mime main string&!! unset
15006 This option defines the ACL that is run for individual MIME parts of non-SMTP
15007 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15008 SMTP messages.
15009
15010 .option acl_not_smtp_start main string&!! unset
15011 .cindex "&ACL;" "at start of non-SMTP message"
15012 .cindex "non-SMTP messages" "ACLs for"
15013 This option defines the ACL that is run before Exim starts reading a
15014 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15015
15016 .option acl_smtp_auth main string&!! unset
15017 .cindex "&ACL;" "setting up for SMTP commands"
15018 .cindex "AUTH" "ACL for"
15019 This option defines the ACL that is run when an SMTP AUTH command is
15020 received. See chapter &<<CHAPACL>>& for further details.
15021
15022 .option acl_smtp_connect main string&!! unset
15023 .cindex "&ACL;" "on SMTP connection"
15024 This option defines the ACL that is run when an SMTP connection is received.
15025 See chapter &<<CHAPACL>>& for further details.
15026
15027 .option acl_smtp_data main string&!! unset
15028 .cindex "DATA" "ACL for"
15029 This option defines the ACL that is run after an SMTP DATA command has been
15030 processed and the message itself has been received, but before the final
15031 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15032
15033 .option acl_smtp_data_prdr main string&!! accept
15034 .cindex "PRDR" "ACL for"
15035 .cindex "DATA" "PRDR ACL for"
15036 .cindex "&ACL;" "PRDR-related"
15037 .cindex "&ACL;" "per-user data processing"
15038 This option defines the ACL that,
15039 if the PRDR feature has been negotiated,
15040 is run for each recipient after an SMTP DATA command has been
15041 processed and the message itself has been received, but before the
15042 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15043
15044 .option acl_smtp_dkim main string&!! unset
15045 .cindex DKIM "ACL for"
15046 This option defines the ACL that is run for each DKIM signature
15047 (by default, or as specified in the dkim_verify_signers option)
15048 of a received message.
15049 See section &<<SECDKIMVFY>>& for further details.
15050
15051 .option acl_smtp_etrn main string&!! unset
15052 .cindex "ETRN" "ACL for"
15053 This option defines the ACL that is run when an SMTP ETRN command is
15054 received. See chapter &<<CHAPACL>>& for further details.
15055
15056 .option acl_smtp_expn main string&!! unset
15057 .cindex "EXPN" "ACL for"
15058 This option defines the ACL that is run when an SMTP EXPN command is
15059 received. See chapter &<<CHAPACL>>& for further details.
15060
15061 .option acl_smtp_helo main string&!! unset
15062 .cindex "EHLO" "ACL for"
15063 .cindex "HELO" "ACL for"
15064 This option defines the ACL that is run when an SMTP EHLO or HELO
15065 command is received. See chapter &<<CHAPACL>>& for further details.
15066
15067
15068 .option acl_smtp_mail main string&!! unset
15069 .cindex "MAIL" "ACL for"
15070 This option defines the ACL that is run when an SMTP MAIL command is
15071 received. See chapter &<<CHAPACL>>& for further details.
15072
15073 .option acl_smtp_mailauth main string&!! unset
15074 .cindex "AUTH" "on MAIL command"
15075 This option defines the ACL that is run when there is an AUTH parameter on
15076 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15077 &<<CHAPSMTPAUTH>>& for details of authentication.
15078
15079 .option acl_smtp_mime main string&!! unset
15080 .cindex "MIME content scanning" "ACL for"
15081 This option is available when Exim is built with the content-scanning
15082 extension. It defines the ACL that is run for each MIME part in a message. See
15083 section &<<SECTscanmimepart>>& for details.
15084
15085 .option acl_smtp_notquit main string&!! unset
15086 .cindex "not-QUIT, ACL for"
15087 This option defines the ACL that is run when an SMTP session
15088 ends without a QUIT command being received.
15089 See chapter &<<CHAPACL>>& for further details.
15090
15091 .option acl_smtp_predata main string&!! unset
15092 This option defines the ACL that is run when an SMTP DATA command is
15093 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15094 further details.
15095
15096 .option acl_smtp_quit main string&!! unset
15097 .cindex "QUIT, ACL for"
15098 This option defines the ACL that is run when an SMTP QUIT command is
15099 received. See chapter &<<CHAPACL>>& for further details.
15100
15101 .option acl_smtp_rcpt main string&!! unset
15102 .cindex "RCPT" "ACL for"
15103 This option defines the ACL that is run when an SMTP RCPT command is
15104 received. See chapter &<<CHAPACL>>& for further details.
15105
15106 .option acl_smtp_starttls main string&!! unset
15107 .cindex "STARTTLS, ACL for"
15108 This option defines the ACL that is run when an SMTP STARTTLS command is
15109 received. See chapter &<<CHAPACL>>& for further details.
15110
15111 .option acl_smtp_vrfy main string&!! unset
15112 .cindex "VRFY" "ACL for"
15113 This option defines the ACL that is run when an SMTP VRFY command is
15114 received. See chapter &<<CHAPACL>>& for further details.
15115
15116 .option add_environment main "string list" empty
15117 .cindex "environment" "set values"
15118 This option adds individual environment variables that the
15119 currently linked libraries and programs in child processes may use.
15120 Each list element should be of the form &"name=value"&.
15121
15122 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15123
15124 .option admin_groups main "string list&!!" unset
15125 .cindex "admin user"
15126 This option is expanded just once, at the start of Exim's processing. If the
15127 current group or any of the supplementary groups of an Exim caller is in this
15128 colon-separated list, the caller has admin privileges. If all your system
15129 programmers are in a specific group, for example, you can give them all Exim
15130 admin privileges by putting that group in &%admin_groups%&. However, this does
15131 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15132 To permit this, you have to add individuals to the Exim group.
15133
15134 .option allow_domain_literals main boolean false
15135 .cindex "domain literal"
15136 If this option is set, the RFC 2822 domain literal format is permitted in
15137 email addresses. The option is not set by default, because the domain literal
15138 format is not normally required these days, and few people know about it. It
15139 has, however, been exploited by mail abusers.
15140
15141 Unfortunately, it seems that some DNS black list maintainers are using this
15142 format to report black listing to postmasters. If you want to accept messages
15143 addressed to your hosts by IP address, you need to set
15144 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15145 domains (defined in the named domain list &%local_domains%& in the default
15146 configuration). This &"magic string"& matches the domain literal form of all
15147 the local host's IP addresses.
15148
15149
15150 .option allow_mx_to_ip main boolean false
15151 .cindex "MX record" "pointing to IP address"
15152 It appears that more and more DNS zone administrators are breaking the rules
15153 and putting domain names that look like IP addresses on the right hand side of
15154 MX records. Exim follows the rules and rejects this, giving an error message
15155 that explains the misconfiguration. However, some other MTAs support this
15156 practice, so to avoid &"Why can't Exim do this?"& complaints,
15157 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15158 recommended, except when you have no other choice.
15159
15160 .option allow_utf8_domains main boolean false
15161 .cindex "domain" "UTF-8 characters in"
15162 .cindex "UTF-8" "in domain name"
15163 Lots of discussion is going on about internationalized domain names. One
15164 camp is strongly in favour of just using UTF-8 characters, and it seems
15165 that at least two other MTAs permit this.
15166 This option allows Exim users to experiment if they wish.
15167
15168 If it is set true, Exim's domain parsing function allows valid
15169 UTF-8 multicharacters to appear in domain name components, in addition to
15170 letters, digits, and hyphens.
15171
15172 If Exim is built with internationalization support
15173 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15174 this option can be left as default.
15175 Without that,
15176 if you want to look up such domain names in the DNS, you must also
15177 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15178 suitable setting is:
15179 .code
15180 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15181   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15182 .endd
15183 Alternatively, you can just disable this feature by setting
15184 .code
15185 dns_check_names_pattern =
15186 .endd
15187 That is, set the option to an empty string so that no check is done.
15188
15189
15190 .option auth_advertise_hosts main "host list&!!" *
15191 .cindex "authentication" "advertising"
15192 .cindex "AUTH" "advertising"
15193 .cindex "ESMTP extensions" AUTH
15194 If any server authentication mechanisms are configured, Exim advertises them in
15195 response to an EHLO command only if the calling host matches this list.
15196 Otherwise, Exim does not advertise AUTH.
15197 Exim does not accept AUTH commands from clients to which it has not
15198 advertised the availability of AUTH. The advertising of individual
15199 authentication mechanisms can be controlled by the use of the
15200 &%server_advertise_condition%& generic authenticator option on the individual
15201 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15202
15203 Certain mail clients (for example, Netscape) require the user to provide a name
15204 and password for authentication if AUTH is advertised, even though it may
15205 not be needed (the host may accept messages from hosts on its local LAN without
15206 authentication, for example). The &%auth_advertise_hosts%& option can be used
15207 to make these clients more friendly by excluding them from the set of hosts to
15208 which Exim advertises AUTH.
15209
15210 .cindex "AUTH" "advertising when encrypted"
15211 If you want to advertise the availability of AUTH only when the connection
15212 is encrypted using TLS, you can make use of the fact that the value of this
15213 option is expanded, with a setting like this:
15214 .code
15215 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15216 .endd
15217 .vindex "&$tls_in_cipher$&"
15218 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15219 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15220 expansion is *, which matches all hosts.
15221
15222
15223 .option auto_thaw main time 0s
15224 .cindex "thawing messages"
15225 .cindex "unfreezing messages"
15226 If this option is set to a time greater than zero, a queue runner will try a
15227 new delivery attempt on any frozen message, other than a bounce message, if
15228 this much time has passed since it was frozen. This may result in the message
15229 being re-frozen if nothing has changed since the last attempt. It is a way of
15230 saying &"keep on trying, even though there are big problems"&.
15231
15232 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15233 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15234 thought to be very useful any more, and its use should probably be avoided.
15235
15236
15237 .option av_scanner main string "see below"
15238 This option is available if Exim is built with the content-scanning extension.
15239 It specifies which anti-virus scanner to use. The default value is:
15240 .code
15241 sophie:/var/run/sophie
15242 .endd
15243 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15244 before use. See section &<<SECTscanvirus>>& for further details.
15245
15246
15247 .option bi_command main string unset
15248 .oindex "&%-bi%&"
15249 This option supplies the name of a command that is run when Exim is called with
15250 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15251 just the command name, it is not a complete command line. If an argument is
15252 required, it must come from the &%-oA%& command line option.
15253
15254
15255 .option bounce_message_file main string&!! unset
15256 .cindex "bounce message" "customizing"
15257 .cindex "customizing" "bounce message"
15258 This option defines a template file containing paragraphs of text to be used
15259 for constructing bounce messages.  Details of the file's contents are given in
15260 chapter &<<CHAPemsgcust>>&.
15261 .cindex bounce_message_file "tainted data"
15262 The option is expanded to give the file path, which must be
15263 absolute and untainted.
15264 See also &%warn_message_file%&.
15265
15266
15267 .option bounce_message_text main string unset
15268 When this option is set, its contents are included in the default bounce
15269 message immediately after &"This message was created automatically by mail
15270 delivery software."& It is not used if &%bounce_message_file%& is set.
15271
15272 .option bounce_return_body main boolean true
15273 .cindex "bounce message" "including body"
15274 This option controls whether the body of an incoming message is included in a
15275 bounce message when &%bounce_return_message%& is true. The default setting
15276 causes the entire message, both header and body, to be returned (subject to the
15277 value of &%bounce_return_size_limit%&). If this option is false, only the
15278 message header is included. In the case of a non-SMTP message containing an
15279 error that is detected during reception, only those header lines preceding the
15280 point at which the error was detected are returned.
15281 .cindex "bounce message" "including original"
15282
15283 .option bounce_return_linesize_limit main integer 998
15284 .cindex "size" "of bounce lines, limit"
15285 .cindex "bounce message" "line length limit"
15286 .cindex "limit" "bounce message line length"
15287 This option sets a limit in bytes on the line length of messages
15288 that are returned to senders due to delivery problems,
15289 when &%bounce_return_message%& is true.
15290 The default value corresponds to RFC limits.
15291 If the message being returned has lines longer than this value it is
15292 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15293
15294 The option also applies to bounces returned when an error is detected
15295 during reception of a message.
15296 In this case lines from the original are truncated.
15297
15298 The option does not apply to messages generated by an &(autoreply)& transport.
15299
15300
15301 .option bounce_return_message main boolean true
15302 If this option is set false, none of the original message is included in
15303 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15304 &%bounce_return_body%&.
15305
15306
15307 .option bounce_return_size_limit main integer 100K
15308 .cindex "size" "of bounce, limit"
15309 .cindex "bounce message" "size limit"
15310 .cindex "limit" "bounce message size"
15311 This option sets a limit in bytes on the size of messages that are returned to
15312 senders as part of bounce messages when &%bounce_return_message%& is true. The
15313 limit should be less than the value of the global &%message_size_limit%& and of
15314 any &%message_size_limit%& settings on transports, to allow for the bounce text
15315 that Exim generates. If this option is set to zero there is no limit.
15316
15317 When the body of any message that is to be included in a bounce message is
15318 greater than the limit, it is truncated, and a comment pointing this out is
15319 added at the top. The actual cutoff may be greater than the value given, owing
15320 to the use of buffering for transferring the message in chunks (typically 8K in
15321 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15322 messages.
15323
15324 .option bounce_sender_authentication main string unset
15325 .cindex "bounce message" "sender authentication"
15326 .cindex "authentication" "bounce message"
15327 .cindex "AUTH" "on bounce message"
15328 This option provides an authenticated sender address that is sent with any
15329 bounce messages generated by Exim that are sent over an authenticated SMTP
15330 connection. A typical setting might be:
15331 .code
15332 bounce_sender_authentication = mailer-daemon@my.domain.example
15333 .endd
15334 which would cause bounce messages to be sent using the SMTP command:
15335 .code
15336 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15337 .endd
15338 The value of &%bounce_sender_authentication%& must always be a complete email
15339 address.
15340
15341 .option callout_domain_negative_expire main time 3h
15342 .cindex "caching" "callout timeouts"
15343 .cindex "callout" "caching timeouts"
15344 This option specifies the expiry time for negative callout cache data for a
15345 domain. See section &<<SECTcallver>>& for details of callout verification, and
15346 section &<<SECTcallvercache>>& for details of the caching.
15347
15348
15349 .option callout_domain_positive_expire main time 7d
15350 This option specifies the expiry time for positive callout cache data for a
15351 domain. See section &<<SECTcallver>>& for details of callout verification, and
15352 section &<<SECTcallvercache>>& for details of the caching.
15353
15354
15355 .option callout_negative_expire main time 2h
15356 This option specifies the expiry time for negative callout cache data for an
15357 address. See section &<<SECTcallver>>& for details of callout verification, and
15358 section &<<SECTcallvercache>>& for details of the caching.
15359
15360
15361 .option callout_positive_expire main time 24h
15362 This option specifies the expiry time for positive callout cache data for an
15363 address. See section &<<SECTcallver>>& for details of callout verification, and
15364 section &<<SECTcallvercache>>& for details of the caching.
15365
15366
15367 .option callout_random_local_part main string&!! "see below"
15368 This option defines the &"random"& local part that can be used as part of
15369 callout verification. The default value is
15370 .code
15371 $primary_hostname-$tod_epoch-testing
15372 .endd
15373 See section &<<CALLaddparcall>>& for details of how this value is used.
15374
15375
15376 .option check_log_inodes main integer 100
15377 See &%check_spool_space%& below.
15378
15379
15380 .option check_log_space main integer 10M
15381 See &%check_spool_space%& below.
15382
15383 .oindex "&%check_rfc2047_length%&"
15384 .cindex "RFC 2047" "disabling length check"
15385 .option check_rfc2047_length main boolean true
15386 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15387 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15388 word; strings to be encoded that exceed this length are supposed to use
15389 multiple encoded words. By default, Exim does not recognize encoded words that
15390 exceed the maximum length. However, it seems that some software, in violation
15391 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15392 set false, Exim recognizes encoded words of any length.
15393
15394
15395 .option check_spool_inodes main integer 100
15396 See &%check_spool_space%& below.
15397
15398
15399 .option check_spool_space main integer 10M
15400 .cindex "checking disk space"
15401 .cindex "disk space, checking"
15402 .cindex "spool directory" "checking space"
15403 The four &%check_...%& options allow for checking of disk resources before a
15404 message is accepted.
15405
15406 .vindex "&$log_inodes$&"
15407 .vindex "&$log_space$&"
15408 .vindex "&$spool_inodes$&"
15409 .vindex "&$spool_space$&"
15410 When any of these options are nonzero, they apply to all incoming messages. If you
15411 want to apply different checks to different kinds of message, you can do so by
15412 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15413 &$spool_space$& in an ACL with appropriate additional conditions.
15414
15415
15416 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15417 either value is greater than zero, for example:
15418 .code
15419 check_spool_space = 100M
15420 check_spool_inodes = 100
15421 .endd
15422 The spool partition is the one that contains the directory defined by
15423 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15424 transit.
15425
15426 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15427 files are written if either is greater than zero. These should be set only if
15428 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15429
15430 If there is less space or fewer inodes than requested, Exim refuses to accept
15431 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15432 error response to the MAIL command. If ESMTP is in use and there was a
15433 SIZE parameter on the MAIL command, its value is added to the
15434 &%check_spool_space%& value, and the check is performed even if
15435 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15436
15437 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15438 number of kilobytes (though specified in bytes).
15439 If a non-multiple of 1024 is specified, it is rounded up.
15440
15441 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15442 failure a message is written to stderr and Exim exits with a non-zero code, as
15443 it obviously cannot send an error message of any kind.
15444
15445 There is a slight performance penalty for these checks.
15446 Versions of Exim preceding 4.88 had these disabled by default;
15447 high-rate installations confident they will never run out of resources
15448 may wish to deliberately disable them.
15449
15450 .option chunking_advertise_hosts main "host list&!!" *
15451 .cindex CHUNKING advertisement
15452 .cindex "RFC 3030" "CHUNKING"
15453 .cindex "ESMTP extensions" CHUNKING
15454 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15455 these hosts.
15456 Hosts may use the BDAT command as an alternate to DATA.
15457
15458 .option commandline_checks_require_admin main boolean &`false`&
15459 .cindex "restricting access to features"
15460 This option restricts various basic checking features to require an
15461 administrative user.
15462 This affects most of the &%-b*%& options, such as &%-be%&.
15463
15464 .option debug_store main boolean &`false`&
15465 .cindex debugging "memory corruption"
15466 .cindex memory debugging
15467 This option, when true, enables extra checking in Exim's internal memory
15468 management.  For use when a memory corruption issue is being investigated,
15469 it should normally be left as default.
15470
15471 .option daemon_smtp_ports main string &`smtp`&
15472 .cindex "port" "for daemon"
15473 .cindex "TCP/IP" "setting listening ports"
15474 This option specifies one or more default SMTP ports on which the Exim daemon
15475 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15476 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15477
15478 .option daemon_startup_retries main integer 9
15479 .cindex "daemon startup, retrying"
15480 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15481 the daemon at startup when it cannot immediately bind a listening socket
15482 (typically because the socket is already in use): &%daemon_startup_retries%&
15483 defines the number of retries after the first failure, and
15484 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15485
15486 .option daemon_startup_sleep main time 30s
15487 See &%daemon_startup_retries%&.
15488
15489 .option delay_warning main "time list" 24h
15490 .cindex "warning of delay"
15491 .cindex "delay warning, specifying"
15492 .cindex "queue" "delay warning"
15493 When a message is delayed, Exim sends a warning message to the sender at
15494 intervals specified by this option. The data is a colon-separated list of times
15495 after which to send warning messages. If the value of the option is an empty
15496 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15497 message has been in the queue for longer than the last time, the last interval
15498 between the times is used to compute subsequent warning times. For example,
15499 with
15500 .code
15501 delay_warning = 4h:8h:24h
15502 .endd
15503 the first message is sent after 4 hours, the second after 8 hours, and
15504 the third one after 24 hours. After that, messages are sent every 16 hours,
15505 because that is the interval between the last two times on the list. If you set
15506 just one time, it specifies the repeat interval. For example, with:
15507 .code
15508 delay_warning = 6h
15509 .endd
15510 messages are repeated every six hours. To stop warnings after a given time, set
15511 a very large time at the end of the list. For example:
15512 .code
15513 delay_warning = 2h:12h:99d
15514 .endd
15515 Note that the option is only evaluated at the time a delivery attempt fails,
15516 which depends on retry and queue-runner configuration.
15517 Typically retries will be configured more frequently than warning messages.
15518
15519 .option delay_warning_condition main string&!! "see below"
15520 .vindex "&$domain$&"
15521 The string is expanded at the time a warning message might be sent. If all the
15522 deferred addresses have the same domain, it is set in &$domain$& during the
15523 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15524 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15525 &"false"& (the comparison being done caselessly) then the warning message is
15526 not sent. The default is:
15527 .code
15528 delay_warning_condition = ${if or {\
15529   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15530   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15531   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15532   } {no}{yes}}
15533 .endd
15534 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15535 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15536 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15537 &"auto-replied"& in an &'Auto-Submitted:'& header.
15538
15539 .option deliver_drop_privilege main boolean false
15540 .cindex "unprivileged delivery"
15541 .cindex "delivery" "unprivileged"
15542 If this option is set true, Exim drops its root privilege at the start of a
15543 delivery process, and runs as the Exim user throughout. This severely restricts
15544 the kinds of local delivery that are possible, but is viable in certain types
15545 of configuration. There is a discussion about the use of root privilege in
15546 chapter &<<CHAPsecurity>>&.
15547
15548 .option deliver_queue_load_max main fixed-point unset
15549 .cindex "load average"
15550 .cindex "queue runner" "abandoning"
15551 When this option is set, a queue run is abandoned if the system load average
15552 becomes greater than the value of the option. The option has no effect on
15553 ancient operating systems on which Exim cannot determine the load average.
15554 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15555
15556
15557 .option delivery_date_remove main boolean true
15558 .cindex "&'Delivery-date:'& header line"
15559 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15560 message when it is delivered, in exactly the same way as &'Return-path:'& is
15561 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15562 should not be present in incoming messages, and this option causes them to be
15563 removed at the time the message is received, to avoid any problems that might
15564 occur when a delivered message is subsequently sent on to some other recipient.
15565
15566 .option disable_fsync main boolean false
15567 .cindex "&[fsync()]&, disabling"
15568 This option is available only if Exim was built with the compile-time option
15569 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15570 a runtime configuration generates an &"unknown option"& error. You should not
15571 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15572 really, really, really understand what you are doing. &'No pre-compiled
15573 distributions of Exim should ever make this option available.'&
15574
15575 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15576 updated files' data to be written to disc before continuing. Unexpected events
15577 such as crashes and power outages may cause data to be lost or scrambled.
15578 Here be Dragons. &*Beware.*&
15579
15580
15581 .option disable_ipv6 main boolean false
15582 .cindex "IPv6" "disabling"
15583 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15584 activities take place. AAAA records are never looked up, and any IPv6 addresses
15585 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15586 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15587 to handle IPv6 literal addresses.
15588
15589
15590 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15591 .cindex DKIM "selecting signature algorithms"
15592 This option gives a list of hash types which are acceptable in signatures,
15593 and an order of processing.
15594 Signatures with algorithms not in the list will be ignored.
15595
15596 Acceptable values include:
15597 .code
15598 sha1
15599 sha256
15600 sha512
15601 .endd
15602
15603 Note that the acceptance of sha1 violates RFC 8301.
15604
15605 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15606 This option gives a list of key types which are acceptable in signatures,
15607 and an order of processing.
15608 Signatures with algorithms not in the list will be ignored.
15609
15610
15611 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15612 This option gives a list of key sizes which are acceptable in signatures.
15613 The list is keyed by the algorithm type for the key; the values are in bits.
15614 Signatures with keys smaller than given by this option will fail verification.
15615
15616 The default enforces the RFC 8301 minimum key size for RSA signatures.
15617
15618 .option dkim_verify_minimal main boolean false
15619 If set to true, verification of signatures will terminate after the
15620 first success.
15621
15622 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15623 .cindex DKIM "controlling calls to the ACL"
15624 This option gives a list of DKIM domains for which the DKIM ACL is run.
15625 It is expanded after the message is received; by default it runs
15626 the ACL once for each signature in the message.
15627 See section &<<SECDKIMVFY>>&.
15628
15629
15630 .option dmarc_forensic_sender main string&!! unset
15631 .option dmarc_history_file main string unset
15632 .option dmarc_tld_file main string unset
15633 .cindex DMARC "main section options"
15634 These options control DMARC processing.
15635 See section &<<SECDMARC>>& for details.
15636
15637
15638 .option dns_again_means_nonexist main "domain list&!!" unset
15639 .cindex "DNS" "&""try again""& response; overriding"
15640 DNS lookups give a &"try again"& response for the DNS errors
15641 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15642 keep trying to deliver a message, or to give repeated temporary errors to
15643 incoming mail. Sometimes the effect is caused by a badly set up name server and
15644 may persist for a long time. If a domain which exhibits this problem matches
15645 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15646 This option should be used with care. You can make it apply to reverse lookups
15647 by a setting such as this:
15648 .code
15649 dns_again_means_nonexist = *.in-addr.arpa
15650 .endd
15651 This option applies to all DNS lookups that Exim does. It also applies when the
15652 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15653 since these are most likely to be caused by DNS lookup problems. The
15654 &(dnslookup)& router has some options of its own for controlling what happens
15655 when lookups for MX or SRV records give temporary errors. These more specific
15656 options are applied after this global option.
15657
15658 .option dns_check_names_pattern main string "see below"
15659 .cindex "DNS" "pre-check of name syntax"
15660 When this option is set to a non-empty string, it causes Exim to check domain
15661 names for characters that are not allowed in host names before handing them to
15662 the DNS resolver, because some resolvers give temporary errors for names that
15663 contain unusual characters. If a domain name contains any unwanted characters,
15664 a &"not found"& result is forced, and the resolver is not called. The check is
15665 done by matching the domain name against a regular expression, which is the
15666 value of this option. The default pattern is
15667 .code
15668 dns_check_names_pattern = \
15669   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15670 .endd
15671 which permits only letters, digits, slashes, and hyphens in components, but
15672 they must start and end with a letter or digit. Slashes are not, in fact,
15673 permitted in host names, but they are found in certain NS records (which can be
15674 accessed in Exim by using a &%dnsdb%& lookup). If you set
15675 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15676 empty string.
15677
15678 .option dns_csa_search_limit main integer 5
15679 This option controls the depth of parental searching for CSA SRV records in the
15680 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15681
15682 .option dns_csa_use_reverse main boolean true
15683 This option controls whether or not an IP address, given as a CSA domain, is
15684 reversed and looked up in the reverse DNS, as described in more detail in
15685 section &<<SECTverifyCSA>>&.
15686
15687 .option dns_cname_loops main integer 1
15688 .cindex DNS "CNAME following"
15689 This option controls the following of CNAME chains, needed if the resolver does
15690 not do it internally.
15691 As of 2018 most should, and the default can be left.
15692 If you have an ancient one, a value of 10 is likely needed.
15693
15694 The default value of one CNAME-follow is needed
15695 thanks to the observed return for an MX request,
15696 given no MX presence but a CNAME to an A, of the CNAME.
15697
15698
15699 .option dns_dnssec_ok main integer -1
15700 .cindex "DNS" "resolver options"
15701 .cindex "DNS" "DNSSEC"
15702 If this option is set to a non-negative number then Exim will initialise the
15703 DNS resolver library to either use or not use DNSSEC, overriding the system
15704 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15705
15706 If the resolver library does not support DNSSEC then this option has no effect.
15707
15708 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15709 will default to stripping out a successful validation status.
15710 This will break a previously working Exim installation.
15711 Provided that you do trust the resolver (ie, is on localhost) you can tell
15712 glibc to pass through any successful validation with a new option in
15713 &_/etc/resolv.conf_&:
15714 .code
15715 options trust-ad
15716 .endd
15717
15718
15719 .option dns_ipv4_lookup main "domain list&!!" unset
15720 .cindex "IPv6" "DNS lookup for AAAA records"
15721 .cindex "DNS" "IPv6 lookup for AAAA records"
15722 .cindex DNS "IPv6 disabling"
15723 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15724 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15725 (A records) when trying to find IP addresses for hosts, unless the host's
15726 domain matches this list.
15727
15728 This is a fudge to help with name servers that give big delays or otherwise do
15729 not work for the AAAA record type. In due course, when the world's name
15730 servers have all been upgraded, there should be no need for this option.
15731 Note that all lookups, including those done for verification, are affected;
15732 this will result in verify failure for IPv6 connections or ones using names
15733 only valid for IPv6 addresses.
15734
15735
15736 .option dns_retrans main time 0s
15737 .cindex "DNS" "resolver options"
15738 .cindex timeout "dns lookup"
15739 .cindex "DNS" timeout
15740 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15741 retransmission and retry parameters for DNS lookups. Values of zero (the
15742 defaults) leave the system default settings unchanged. The first value is the
15743 time between retries, and the second is the number of retries. It isn't
15744 totally clear exactly how these settings affect the total time a DNS lookup may
15745 take. I haven't found any documentation about timeouts on DNS lookups; these
15746 parameter values are available in the external resolver interface structure,
15747 but nowhere does it seem to describe how they are used or what you might want
15748 to set in them.
15749 See also the &%slow_lookup_log%& option.
15750
15751
15752 .option dns_retry main integer 0
15753 See &%dns_retrans%& above.
15754
15755
15756 .option dns_trust_aa main "domain list&!!" unset
15757 .cindex "DNS" "resolver options"
15758 .cindex "DNS" "DNSSEC"
15759 If this option is set then lookup results marked with the AA bit
15760 (Authoritative Answer) are trusted the same way as if they were
15761 DNSSEC-verified. The authority section's name of the answer must
15762 match with this expanded domain list.
15763
15764 Use this option only if you talk directly to a resolver that is
15765 authoritative for some zones and does not set the AD (Authentic Data)
15766 bit in the answer. Some DNS servers may have an configuration option to
15767 mark the answers from their own zones as verified (they set the AD bit).
15768 Others do not have this option. It is considered as poor practice using
15769 a resolver that is an authoritative server for some zones.
15770
15771 Use this option only if you really have to (e.g. if you want
15772 to use DANE for remote delivery to a server that is listed in the DNS
15773 zones that your resolver is authoritative for).
15774
15775 If the DNS answer packet has the AA bit set and contains resource record
15776 in the answer section, the name of the first NS record appearing in the
15777 authority section is compared against the list. If the answer packet is
15778 authoritative but the answer section is empty, the name of the first SOA
15779 record in the authoritative section is used instead.
15780
15781 .cindex "DNS" "resolver options"
15782 .option dns_use_edns0 main integer -1
15783 .cindex "DNS" "resolver options"
15784 .cindex "DNS" "EDNS0"
15785 .cindex "DNS" "OpenBSD
15786 If this option is set to a non-negative number then Exim will initialise the
15787 DNS resolver library to either use or not use EDNS0 extensions, overriding
15788 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15789 on.
15790
15791 If the resolver library does not support EDNS0 then this option has no effect.
15792
15793 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15794 means that DNSSEC will not work with Exim on that platform either, unless Exim
15795 is linked against an alternative DNS client library.
15796
15797
15798 .option drop_cr main boolean false
15799 This is an obsolete option that is now a no-op. It used to affect the way Exim
15800 handled CR and LF characters in incoming messages. What happens now is
15801 described in section &<<SECTlineendings>>&.
15802
15803 .option dsn_advertise_hosts main "host list&!!" unset
15804 .cindex "bounce messages" "success"
15805 .cindex "DSN" "success"
15806 .cindex "Delivery Status Notification" "success"
15807 .cindex "ESMTP extensions" DSN
15808 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15809 and accepted from, these hosts.
15810 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15811 and RET and ORCPT options on MAIL FROM commands.
15812 A NOTIFY=SUCCESS option requests success-DSN messages.
15813 A NOTIFY= option with no argument requests that no delay or failure DSNs
15814 are sent.
15815 &*Note*&: Supplying success-DSN messages has been criticised
15816 on privacy grounds; it can leak details of internal forwarding.
15817
15818 .option dsn_from main "string&!!" "see below"
15819 .cindex "&'From:'& header line" "in bounces"
15820 .cindex "bounce messages" "&'From:'& line, specifying"
15821 This option can be used to vary the contents of &'From:'& header lines in
15822 bounces and other automatically generated messages (&"Delivery Status
15823 Notifications"& &-- hence the name of the option). The default setting is:
15824 .code
15825 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15826 .endd
15827 The value is expanded every time it is needed. If the expansion fails, a
15828 panic is logged, and the default value is used.
15829
15830 .option envelope_to_remove main boolean true
15831 .cindex "&'Envelope-to:'& header line"
15832 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15833 message when it is delivered, in exactly the same way as &'Return-path:'& is
15834 handled. &'Envelope-to:'& records the original recipient address from the
15835 message's envelope that caused the delivery to happen. Such headers should not
15836 be present in incoming messages, and this option causes them to be removed at
15837 the time the message is received, to avoid any problems that might occur when a
15838 delivered message is subsequently sent on to some other recipient.
15839
15840
15841 .option errors_copy main "string list&!!" unset
15842 .cindex "bounce message" "copy to other address"
15843 .cindex "copy of bounce message"
15844 Setting this option causes Exim to send bcc copies of bounce messages that it
15845 generates to other addresses. &*Note*&: This does not apply to bounce messages
15846 coming from elsewhere. The value of the option is a colon-separated list of
15847 items. Each item consists of a pattern, terminated by white space, followed by
15848 a comma-separated list of email addresses. If a pattern contains spaces, it
15849 must be enclosed in double quotes.
15850
15851 Each pattern is processed in the same way as a single item in an address list
15852 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15853 the bounce message, the message is copied to the addresses on the list. The
15854 items are scanned in order, and once a matching one is found, no further items
15855 are examined. For example:
15856 .code
15857 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15858               rqps@mydomain   hostmaster@mydomain.example,\
15859                               postmaster@mydomain.example
15860 .endd
15861 .vindex "&$domain$&"
15862 .vindex "&$local_part$&"
15863 The address list is expanded before use. The expansion variables &$local_part$&
15864 and &$domain$& are set from the original recipient of the error message, and if
15865 there was any wildcard matching in the pattern, the expansion
15866 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15867 variables &$0$&, &$1$&, etc. are set in the normal way.
15868
15869
15870 .option errors_reply_to main string unset
15871 .cindex "bounce message" "&'Reply-to:'& in"
15872 By default, Exim's bounce and delivery warning messages contain the header line
15873 .display
15874 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15875 .endd
15876 .oindex &%quota_warn_message%&
15877 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15878 A warning message that is generated by the &%quota_warn_message%& option in an
15879 &(appendfile)& transport may contain its own &'From:'& header line that
15880 overrides the default.
15881
15882 Experience shows that people reply to bounce messages. If the
15883 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15884 and warning messages. For example:
15885 .code
15886 errors_reply_to = postmaster@my.domain.example
15887 .endd
15888 The value of the option is not expanded. It must specify a valid RFC 2822
15889 address. However, if a warning message that is generated by the
15890 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15891 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15892 not used.
15893
15894
15895 .option event_action main string&!! unset
15896 .cindex events
15897 This option declares a string to be expanded for Exim's events mechanism.
15898 For details see chapter &<<CHAPevents>>&.
15899
15900
15901 .option exim_group main string "compile-time configured"
15902 .cindex "gid (group id)" "Exim's own"
15903 .cindex "Exim group"
15904 This option changes the gid under which Exim runs when it gives up root
15905 privilege. The default value is compiled into the binary. The value of this
15906 option is used only when &%exim_user%& is also set. Unless it consists entirely
15907 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15908 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15909 security issues.
15910
15911
15912 .option exim_path main string "see below"
15913 .cindex "Exim binary, path name"
15914 This option specifies the path name of the Exim binary, which is used when Exim
15915 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15916 the directory configured at compile time by the BIN_DIRECTORY setting. It
15917 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15918 other place.
15919 &*Warning*&: Do not use a macro to define the value of this option, because
15920 you will break those Exim utilities that scan the configuration file to find
15921 where the binary is. (They then use the &%-bP%& option to extract option
15922 settings such as the value of &%spool_directory%&.)
15923
15924
15925 .option exim_user main string "compile-time configured"
15926 .cindex "uid (user id)" "Exim's own"
15927 .cindex "Exim user"
15928 This option changes the uid under which Exim runs when it gives up root
15929 privilege. The default value is compiled into the binary. Ownership of the run
15930 time configuration file and the use of the &%-C%& and &%-D%& command line
15931 options is checked against the values in the binary, not what is set here.
15932
15933 Unless it consists entirely of digits, the string is looked up using
15934 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15935 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15936 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15937
15938
15939 .option exim_version main string "current version"
15940 .cindex "Exim version"
15941 .cindex customizing "version number"
15942 .cindex "version number of Exim" override
15943 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15944 various places.  Use with care; this may fool stupid security scanners.
15945
15946
15947 .option extra_local_interfaces main "string list" unset
15948 This option defines network interfaces that are to be considered local when
15949 routing, but which are not used for listening by the daemon. See section
15950 &<<SECTreclocipadd>>& for details.
15951
15952
15953 . Allow this long option name to split; give it unsplit as a fifth argument
15954 . for the automatic .oindex that is generated by .option.
15955
15956 .option "extract_addresses_remove_arguments" main boolean true &&&
15957          extract_addresses_remove_arguments
15958 .oindex "&%-t%&"
15959 .cindex "command line" "addresses with &%-t%&"
15960 .cindex "Sendmail compatibility" "&%-t%& option"
15961 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15962 are present on the command line when the &%-t%& option is used to build an
15963 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15964 line addresses are removed from the recipients list. This is also how Smail
15965 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15966 command line addresses are added to those obtained from the header lines. When
15967 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15968 argument headers. If it is set false, Exim adds rather than removes argument
15969 addresses.
15970
15971
15972 .option finduser_retries main integer 0
15973 .cindex "NIS, retrying user lookups"
15974 On systems running NIS or other schemes in which user and group information is
15975 distributed from a remote system, there can be times when &[getpwnam()]& and
15976 related functions fail, even when given valid data, because things time out.
15977 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15978 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15979 many extra times to find a user or a group, waiting for one second between
15980 retries.
15981
15982 .cindex "&_/etc/passwd_&" "multiple reading of"
15983 You should not set this option greater than zero if your user information is in
15984 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15985 search the file multiple times for non-existent users, and also cause delay.
15986
15987
15988
15989 .option freeze_tell main "string list, comma separated" unset
15990 .cindex "freezing messages" "sending a message when freezing"
15991 On encountering certain errors, or when configured to do so in a system filter,
15992 ACL, or special router, Exim freezes a message. This means that no further
15993 delivery attempts take place until an administrator thaws the message, or the
15994 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15995 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15996 warning message whenever it freezes something, unless the message it is
15997 freezing is a locally-generated bounce message. (Without this exception there
15998 is the possibility of looping.) The warning message is sent to the addresses
15999 supplied as the comma-separated value of this option. If several of the
16000 message's addresses cause freezing, only a single message is sent. If the
16001 freezing was automatic, the reason(s) for freezing can be found in the message
16002 log. If you configure freezing in a filter or ACL, you must arrange for any
16003 logging that you require.
16004
16005
16006 .option gecos_name main string&!! unset
16007 .cindex "HP-UX"
16008 .cindex "&""gecos""& field, parsing"
16009 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16010 password file to hold other information in addition to users' real names. Exim
16011 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16012 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16013 of the field are used unchanged, except that, if an ampersand is encountered,
16014 it is replaced by the user's login name with the first character forced to
16015 upper case, since this is a convention that is observed on many systems.
16016
16017 When these options are set, &%gecos_pattern%& is treated as a regular
16018 expression that is to be applied to the field (again with && replaced by the
16019 login name), and if it matches, &%gecos_name%& is expanded and used as the
16020 user's name.
16021
16022 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16023 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16024 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16025 name terminates at the first comma, the following can be used:
16026 .code
16027 gecos_pattern = ([^,]*)
16028 gecos_name = $1
16029 .endd
16030
16031 .option gecos_pattern main string unset
16032 See &%gecos_name%& above.
16033
16034
16035 .option gnutls_compat_mode main boolean unset
16036 This option controls whether GnuTLS is used in compatibility mode in an Exim
16037 server. This reduces security slightly, but improves interworking with older
16038 implementations of TLS.
16039
16040
16041 .option gnutls_allow_auto_pkcs11 main boolean unset
16042 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16043 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16044
16045 See
16046 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16047 for documentation.
16048
16049
16050
16051 .option headers_charset main string "see below"
16052 This option sets a default character set for translating from encoded MIME
16053 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16054 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16055 ultimate default is ISO-8859-1. For more details see the description of header
16056 insertions in section &<<SECTexpansionitems>>&.
16057
16058
16059
16060 .option header_maxsize main integer "see below"
16061 .cindex "header section" "maximum size of"
16062 .cindex "limit" "size of message header section"
16063 This option controls the overall maximum size of a message's header
16064 section. The default is the value of HEADER_MAXSIZE in
16065 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16066 sections are rejected.
16067
16068
16069 .option header_line_maxsize main integer 0
16070 .cindex "header lines" "maximum size of"
16071 .cindex "limit" "size of one header line"
16072 This option limits the length of any individual header line in a message, after
16073 all the continuations have been joined together. Messages with individual
16074 header lines that are longer than the limit are rejected. The default value of
16075 zero means &"no limit"&.
16076
16077
16078
16079
16080 .option helo_accept_junk_hosts main "host list&!!" unset
16081 .cindex "HELO" "accepting junk data"
16082 .cindex "EHLO" "accepting junk data"
16083 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16084 mail, and gives an error response for invalid data. Unfortunately, there are
16085 some SMTP clients that send syntactic junk. They can be accommodated by setting
16086 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16087 if you want to do semantic checking.
16088 See also &%helo_allow_chars%& for a way of extending the permitted character
16089 set.
16090
16091
16092 .option helo_allow_chars main string unset
16093 .cindex "HELO" "underscores in"
16094 .cindex "EHLO" "underscores in"
16095 .cindex "underscore in EHLO/HELO"
16096 This option can be set to a string of rogue characters that are permitted in
16097 all EHLO and HELO names in addition to the standard letters, digits,
16098 hyphens, and dots. If you really must allow underscores, you can set
16099 .code
16100 helo_allow_chars = _
16101 .endd
16102 Note that the value is one string, not a list.
16103
16104
16105 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16106 .cindex "HELO" "forcing reverse lookup"
16107 .cindex "EHLO" "forcing reverse lookup"
16108 If the domain given by a client in a HELO or EHLO command matches this
16109 list, a reverse lookup is done in order to establish the host's true name. The
16110 default forces a lookup if the client host gives the server's name or any of
16111 its IP addresses (in brackets), something that broken clients have been seen to
16112 do.
16113
16114
16115 .option helo_try_verify_hosts main "host list&!!" unset
16116 .cindex "HELO verifying" "optional"
16117 .cindex "EHLO" "verifying, optional"
16118 By default, Exim just checks the syntax of HELO and EHLO commands (see
16119 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16120 to do more extensive checking of the data supplied by these commands. The ACL
16121 condition &`verify = helo`& is provided to make this possible.
16122 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16123 to force the check to occur. From release 4.53 onwards, this is no longer
16124 necessary. If the check has not been done before &`verify = helo`& is
16125 encountered, it is done at that time. Consequently, this option is obsolete.
16126 Its specification is retained here for backwards compatibility.
16127
16128 When an EHLO or HELO command is received, if the calling host matches
16129 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16130 EHLO command either:
16131
16132 .ilist
16133 is an IP literal matching the calling address of the host, or
16134 .next
16135 .cindex "DNS" "reverse lookup"
16136 .cindex "reverse DNS lookup"
16137 matches the host name that Exim obtains by doing a reverse lookup of the
16138 calling host address, or
16139 .next
16140 when looked up in DNS yields the calling host address.
16141 .endlist
16142
16143 However, the EHLO or HELO command is not rejected if any of the checks
16144 fail. Processing continues, but the result of the check is remembered, and can
16145 be detected later in an ACL by the &`verify = helo`& condition.
16146
16147 If DNS was used for successful verification, the variable
16148 .cindex "DNS" "DNSSEC"
16149 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16150
16151 .option helo_verify_hosts main "host list&!!" unset
16152 .cindex "HELO verifying" "mandatory"
16153 .cindex "EHLO" "verifying, mandatory"
16154 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16155 backwards compatibility. For hosts that match this option, Exim checks the host
16156 name given in the HELO or EHLO in the same way as for
16157 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16158 rejected with a 550 error, and entries are written to the main and reject logs.
16159 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16160 error.
16161
16162 .option hold_domains main "domain list&!!" unset
16163 .cindex "domain" "delaying delivery"
16164 .cindex "delivery" "delaying certain domains"
16165 This option allows mail for particular domains to be held in the queue
16166 manually. The option is overridden if a message delivery is forced with the
16167 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16168 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16169 item in &%hold_domains%&, no routing or delivery for that address is done, and
16170 it is deferred every time the message is looked at.
16171
16172 This option is intended as a temporary operational measure for delaying the
16173 delivery of mail while some problem is being sorted out, or some new
16174 configuration tested. If you just want to delay the processing of some
16175 domains until a queue run occurs, you should use &%queue_domains%& or
16176 &%queue_smtp_domains%&, not &%hold_domains%&.
16177
16178 A setting of &%hold_domains%& does not override Exim's code for removing
16179 messages from the queue if they have been there longer than the longest retry
16180 time in any retry rule. If you want to hold messages for longer than the normal
16181 retry times, insert a dummy retry rule with a long retry time.
16182
16183
16184 .option host_lookup main "host list&!!" unset
16185 .cindex "host name" "lookup, forcing"
16186 Exim does not look up the name of a calling host from its IP address unless it
16187 is required to compare against some host list, or the host matches
16188 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16189 option (which normally contains IP addresses rather than host names). The
16190 default configuration file contains
16191 .code
16192 host_lookup = *
16193 .endd
16194 which causes a lookup to happen for all hosts. If the expense of these lookups
16195 is felt to be too great, the setting can be changed or removed.
16196
16197 After a successful reverse lookup, Exim does a forward lookup on the name it
16198 has obtained, to verify that it yields the IP address that it started with. If
16199 this check fails, Exim behaves as if the name lookup failed.
16200
16201 .vindex "&$host_lookup_failed$&"
16202 .vindex "&$sender_host_name$&"
16203 After any kind of failure, the host name (in &$sender_host_name$&) remains
16204 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16205 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16206 &`verify = reverse_host_lookup`& in ACLs.
16207
16208
16209 .option host_lookup_order main "string list" &`bydns:byaddr`&
16210 This option specifies the order of different lookup methods when Exim is trying
16211 to find a host name from an IP address. The default is to do a DNS lookup
16212 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16213 if that fails. You can change the order of these lookups, or omit one entirely,
16214 if you want.
16215
16216 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16217 multiple PTR records in the DNS and the IP address is not listed in
16218 &_/etc/hosts_&. Different operating systems give different results in this
16219 case. That is why the default tries a DNS lookup first.
16220
16221
16222
16223 .option host_reject_connection main "host list&!!" unset
16224 .cindex "host" "rejecting connections from"
16225 If this option is set, incoming SMTP calls from the hosts listed are rejected
16226 as soon as the connection is made.
16227 This option is obsolete, and retained only for backward compatibility, because
16228 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16229 connections immediately.
16230
16231 The ability to give an immediate rejection (either by this option or using an
16232 ACL) is provided for use in unusual cases. Many hosts will just try again,
16233 sometimes without much delay. Normally, it is better to use an ACL to reject
16234 incoming messages at a later stage, such as after RCPT commands. See
16235 chapter &<<CHAPACL>>&.
16236
16237
16238 .option hosts_connection_nolog main "host list&!!" unset
16239 .cindex "host" "not logging connections from"
16240 This option defines a list of hosts for which connection logging does not
16241 happen, even though the &%smtp_connection%& log selector is set. For example,
16242 you might want not to log SMTP connections from local processes, or from
16243 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16244 the daemon; you should therefore strive to restrict its value to a short inline
16245 list of IP addresses and networks. To disable logging SMTP connections from
16246 local processes, you must create a host list with an empty item. For example:
16247 .code
16248 hosts_connection_nolog = :
16249 .endd
16250 If the &%smtp_connection%& log selector is not set, this option has no effect.
16251
16252
16253
16254 .option hosts_proxy main "host list&!!" unset
16255 .cindex proxy "proxy protocol"
16256 This option enables use of Proxy Protocol proxies for incoming
16257 connections.  For details see section &<<SECTproxyInbound>>&.
16258
16259
16260 .option hosts_treat_as_local main "domain list&!!" unset
16261 .cindex "local host" "domains treated as"
16262 .cindex "host" "treated as local"
16263 If this option is set, any host names that match the domain list are treated as
16264 if they were the local host when Exim is scanning host lists obtained from MX
16265 records
16266 or other sources. Note that the value of this option is a domain list, not a
16267 host list, because it is always used to check host names, not IP addresses.
16268
16269 This option also applies when Exim is matching the special items
16270 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16271 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16272 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16273 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16274 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16275 interfaces and recognizing the local host.
16276
16277
16278 .option ibase_servers main "string list" unset
16279 .cindex "InterBase" "server list"
16280 This option provides a list of InterBase servers and associated connection data,
16281 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16282 The option is available only if Exim has been built with InterBase support.
16283
16284
16285
16286 .option ignore_bounce_errors_after main time 10w
16287 .cindex "bounce message" "discarding"
16288 .cindex "discarding bounce message"
16289 This option affects the processing of bounce messages that cannot be delivered,
16290 that is, those that suffer a permanent delivery failure. (Bounce messages that
16291 suffer temporary delivery failures are of course retried in the usual way.)
16292
16293 After a permanent delivery failure, bounce messages are frozen,
16294 because there is no sender to whom they can be returned. When a frozen bounce
16295 message has been in the queue for more than the given time, it is unfrozen at
16296 the next queue run, and a further delivery is attempted. If delivery fails
16297 again, the bounce message is discarded. This makes it possible to keep failed
16298 bounce messages around for a shorter time than the normal maximum retry time
16299 for frozen messages. For example,
16300 .code
16301 ignore_bounce_errors_after = 12h
16302 .endd
16303 retries failed bounce message deliveries after 12 hours, discarding any further
16304 failures. If the value of this option is set to a zero time period, bounce
16305 failures are discarded immediately. Setting a very long time (as in the default
16306 value) has the effect of disabling this option. For ways of automatically
16307 dealing with other kinds of frozen message, see &%auto_thaw%& and
16308 &%timeout_frozen_after%&.
16309
16310
16311 .option ignore_fromline_hosts main "host list&!!" unset
16312 .cindex "&""From""& line"
16313 .cindex "UUCP" "&""From""& line"
16314 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16315 the headers of a message. By default this is treated as the start of the
16316 message's body, which means that any following headers are not recognized as
16317 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16318 match those hosts that insist on sending it. If the sender is actually a local
16319 process rather than a remote host, and is using &%-bs%& to inject the messages,
16320 &%ignore_fromline_local%& must be set to achieve this effect.
16321
16322
16323 .option ignore_fromline_local main boolean false
16324 See &%ignore_fromline_hosts%& above.
16325
16326 .option keep_environment main "string list" unset
16327 .cindex "environment" "values from"
16328 This option contains a string list of environment variables to keep.
16329 You have to trust these variables or you have to be sure that
16330 these variables do not impose any security risk. Keep in mind that
16331 during the startup phase Exim is running with an effective UID 0 in most
16332 installations. As the default value is an empty list, the default
16333 environment for using libraries, running embedded Perl code, or running
16334 external binaries is empty, and does not not even contain PATH or HOME.
16335
16336 Actually the list is interpreted as a list of patterns
16337 (&<<SECTlistexpand>>&), except that it is not expanded first.
16338
16339 WARNING: Macro substitution is still done first, so having a macro
16340 FOO and having FOO_HOME in your &%keep_environment%& option may have
16341 unexpected results. You may work around this using a regular expression
16342 that does not match the macro name: ^[F]OO_HOME$.
16343
16344 Current versions of Exim issue a warning during startup if you do not mention
16345 &%keep_environment%& in your runtime configuration file and if your
16346 current environment is not empty. Future versions may not issue that warning
16347 anymore.
16348
16349 See the &%add_environment%& main config option for a way to set
16350 environment variables to a fixed value.  The environment for &(pipe)&
16351 transports is handled separately, see section &<<SECTpipeenv>>& for
16352 details.
16353
16354
16355 .option keep_malformed main time 4d
16356 This option specifies the length of time to keep messages whose spool files
16357 have been corrupted in some way. This should, of course, never happen. At the
16358 next attempt to deliver such a message, it gets removed. The incident is
16359 logged.
16360
16361
16362 .option ldap_ca_cert_dir main string unset
16363 .cindex "LDAP", "TLS CA certificate directory"
16364 .cindex certificate "directory for LDAP"
16365 This option indicates which directory contains CA certificates for verifying
16366 a TLS certificate presented by an LDAP server.
16367 While Exim does not provide a default value, your SSL library may.
16368 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16369 and constrained to be a directory.
16370
16371
16372 .option ldap_ca_cert_file main string unset
16373 .cindex "LDAP", "TLS CA certificate file"
16374 .cindex certificate "file for LDAP"
16375 This option indicates which file contains CA certificates for verifying
16376 a TLS certificate presented by an LDAP server.
16377 While Exim does not provide a default value, your SSL library may.
16378 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16379 and constrained to be a file.
16380
16381
16382 .option ldap_cert_file main string unset
16383 .cindex "LDAP" "TLS client certificate file"
16384 .cindex certificate "file for LDAP"
16385 This option indicates which file contains an TLS client certificate which
16386 Exim should present to the LDAP server during TLS negotiation.
16387 Should be used together with &%ldap_cert_key%&.
16388
16389
16390 .option ldap_cert_key main string unset
16391 .cindex "LDAP" "TLS client key file"
16392 .cindex certificate "key for LDAP"
16393 This option indicates which file contains the secret/private key to use
16394 to prove identity to the LDAP server during TLS negotiation.
16395 Should be used together with &%ldap_cert_file%&, which contains the
16396 identity to be proven.
16397
16398
16399 .option ldap_cipher_suite main string unset
16400 .cindex "LDAP" "TLS cipher suite"
16401 This controls the TLS cipher-suite negotiation during TLS negotiation with
16402 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16403 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16404
16405
16406 .option ldap_default_servers main "string list" unset
16407 .cindex "LDAP" "default servers"
16408 This option provides a list of LDAP servers which are tried in turn when an
16409 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16410 details of LDAP queries. This option is available only when Exim has been built
16411 with LDAP support.
16412
16413
16414 .option ldap_require_cert main string unset.
16415 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16416 This should be one of the values "hard", "demand", "allow", "try" or "never".
16417 A value other than one of these is interpreted as "never".
16418 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16419 Although Exim does not set a default, the LDAP library probably defaults
16420 to hard/demand.
16421
16422
16423 .option ldap_start_tls main boolean false
16424 .cindex "LDAP" "whether or not to negotiate TLS"
16425 If set, Exim will attempt to negotiate TLS with the LDAP server when
16426 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16427 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16428 of SSL-on-connect.
16429 In the event of failure to negotiate TLS, the action taken is controlled
16430 by &%ldap_require_cert%&.
16431 This option is ignored for &`ldapi`& connections.
16432
16433
16434 .option ldap_version main integer unset
16435 .cindex "LDAP" "protocol version, forcing"
16436 This option can be used to force Exim to set a specific protocol version for
16437 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16438 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16439 the LDAP headers; otherwise it is 2. This option is available only when Exim
16440 has been built with LDAP support.
16441
16442
16443
16444 .option local_from_check main boolean true
16445 .cindex "&'Sender:'& header line" "disabling addition of"
16446 .cindex "&'From:'& header line" "disabling checking of"
16447 When a message is submitted locally (that is, not over a TCP/IP connection) by
16448 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16449 checks that the &'From:'& header line matches the login of the calling user and
16450 the domain specified by &%qualify_domain%&.
16451
16452 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16453 locally submitted message is automatically qualified by Exim, unless the
16454 &%-bnq%& command line option is used.
16455
16456 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16457 on the local part. If the &'From:'& header line does not match, Exim adds a
16458 &'Sender:'& header with an address constructed from the calling user's login
16459 and the default qualify domain.
16460
16461 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16462 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16463 &'Sender:'& header lines supplied by untrusted users, you must also set
16464 &%local_sender_retain%& to be true.
16465
16466 .cindex "envelope from"
16467 .cindex "envelope sender"
16468 These options affect only the header lines in the message. The envelope sender
16469 is still forced to be the login id at the qualify domain unless
16470 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16471
16472 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16473 request similar header line checking. See section &<<SECTthesenhea>>&, which
16474 has more details about &'Sender:'& processing.
16475
16476
16477
16478
16479 .option local_from_prefix main string unset
16480 When Exim checks the &'From:'& header line of locally submitted messages for
16481 matching the login id (see &%local_from_check%& above), it can be configured to
16482 ignore certain prefixes and suffixes in the local part of the address. This is
16483 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16484 appropriate lists, in the same form as the &%local_part_prefix%& and
16485 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16486 example, if
16487 .code
16488 local_from_prefix = *-
16489 .endd
16490 is set, a &'From:'& line containing
16491 .code
16492 From: anything-user@your.domain.example
16493 .endd
16494 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16495 matches the actual sender address that is constructed from the login name and
16496 qualify domain.
16497
16498
16499 .option local_from_suffix main string unset
16500 See &%local_from_prefix%& above.
16501
16502
16503 .option local_interfaces main "string list" "see below"
16504 This option controls which network interfaces are used by the daemon for
16505 listening; they are also used to identify the local host when routing. Chapter
16506 &<<CHAPinterfaces>>& contains a full description of this option and the related
16507 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16508 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16509 &%local_interfaces%& is
16510 .code
16511 local_interfaces = 0.0.0.0
16512 .endd
16513 when Exim is built without IPv6 support; otherwise it is
16514 .code
16515 local_interfaces = <; ::0 ; 0.0.0.0
16516 .endd
16517
16518 .option local_scan_timeout main time 5m
16519 .cindex "timeout" "for &[local_scan()]& function"
16520 .cindex "&[local_scan()]& function" "timeout"
16521 This timeout applies to the &[local_scan()]& function (see chapter
16522 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16523 the incoming message is rejected with a temporary error if it is an SMTP
16524 message. For a non-SMTP message, the message is dropped and Exim ends with a
16525 non-zero code. The incident is logged on the main and reject logs.
16526
16527
16528
16529 .option local_sender_retain main boolean false
16530 .cindex "&'Sender:'& header line" "retaining from local submission"
16531 When a message is submitted locally (that is, not over a TCP/IP connection) by
16532 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16533 do not want this to happen, you must set &%local_sender_retain%&, and you must
16534 also set &%local_from_check%& to be false (Exim will complain if you do not).
16535 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16536 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16537
16538
16539
16540
16541 .option localhost_number main string&!! unset
16542 .cindex "host" "locally unique number for"
16543 .cindex "message ids" "with multiple hosts"
16544 .vindex "&$localhost_number$&"
16545 Exim's message ids are normally unique only within the local host. If
16546 uniqueness among a set of hosts is required, each host must set a different
16547 value for the &%localhost_number%& option. The string is expanded immediately
16548 after reading the configuration file (so that a number can be computed from the
16549 host name, for example) and the result of the expansion must be a number in the
16550 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16551 systems). This is available in subsequent string expansions via the variable
16552 &$localhost_number$&. When &%localhost_number is set%&, the final two
16553 characters of the message id, instead of just being a fractional part of the
16554 time, are computed from the time and the local host number as described in
16555 section &<<SECTmessiden>>&.
16556
16557
16558
16559 .option log_file_path main "string list&!!" "set at compile time"
16560 .cindex "log" "file path for"
16561 This option sets the path which is used to determine the names of Exim's log
16562 files, or indicates that logging is to be to syslog, or both. It is expanded
16563 when Exim is entered, so it can, for example, contain a reference to the host
16564 name. If no specific path is set for the log files at compile or runtime,
16565 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16566 they are written in a sub-directory called &_log_& in Exim's spool directory.
16567 A path must start with a slash.
16568 To send to syslog, use the word &"syslog"&.
16569 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16570 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16571 used. If this string is fixed at your installation (contains no expansion
16572 variables) it is recommended that you do not set this option in the
16573 configuration file, but instead supply the path using LOG_FILE_PATH in
16574 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16575 early on &-- in particular, failure to read the configuration file.
16576
16577
16578 .option log_selector main string unset
16579 .cindex "log" "selectors"
16580 This option can be used to reduce or increase the number of things that Exim
16581 writes to its log files. Its argument is made up of names preceded by plus or
16582 minus characters. For example:
16583 .code
16584 log_selector = +arguments -retry_defer
16585 .endd
16586 A list of possible names and what they control is given in the chapter on
16587 logging, in section &<<SECTlogselector>>&.
16588
16589
16590 .option log_timezone main boolean false
16591 .cindex "log" "timezone for entries"
16592 .vindex "&$tod_log$&"
16593 .vindex "&$tod_zone$&"
16594 By default, the timestamps on log lines are in local time without the
16595 timezone. This means that if your timezone changes twice a year, the timestamps
16596 in log lines are ambiguous for an hour when the clocks go back. One way of
16597 avoiding this problem is to set the timezone to UTC. An alternative is to set
16598 &%log_timezone%& true. This turns on the addition of the timezone offset to
16599 timestamps in log lines. Turning on this option can add quite a lot to the size
16600 of log files because each line is extended by 6 characters. Note that the
16601 &$tod_log$& variable contains the log timestamp without the zone, but there is
16602 another variable called &$tod_zone$& that contains just the timezone offset.
16603
16604
16605 .option lookup_open_max main integer 25
16606 .cindex "too many open files"
16607 .cindex "open files, too many"
16608 .cindex "file" "too many open"
16609 .cindex "lookup" "maximum open files"
16610 .cindex "limit" "open files for lookups"
16611 This option limits the number of simultaneously open files for single-key
16612 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16613 Exim normally keeps these files open during routing, because often the same
16614 file is required several times. If the limit is reached, Exim closes the least
16615 recently used file. Note that if you are using the &'ndbm'& library, it
16616 actually opens two files for each logical DBM database, though it still counts
16617 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16618 open files"& errors with NDBM, you need to reduce the value of
16619 &%lookup_open_max%&.
16620
16621
16622 .option max_username_length main integer 0
16623 .cindex "length of login name"
16624 .cindex "user name" "maximum length"
16625 .cindex "limit" "user name length"
16626 Some operating systems are broken in that they truncate long arguments to
16627 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16628 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16629 an argument that is longer behaves as if &[getpwnam()]& failed.
16630
16631
16632 .option message_body_newlines main bool false
16633 .cindex "message body" "newlines in variables"
16634 .cindex "newline" "in message body variables"
16635 .vindex "&$message_body$&"
16636 .vindex "&$message_body_end$&"
16637 By default, newlines in the message body are replaced by spaces when setting
16638 the &$message_body$& and &$message_body_end$& expansion variables. If this
16639 option is set true, this no longer happens.
16640
16641
16642 .option message_body_visible main integer 500
16643 .cindex "body of message" "visible size"
16644 .cindex "message body" "visible size"
16645 .vindex "&$message_body$&"
16646 .vindex "&$message_body_end$&"
16647 This option specifies how much of a message's body is to be included in the
16648 &$message_body$& and &$message_body_end$& expansion variables.
16649
16650
16651 .option message_id_header_domain main string&!! unset
16652 .cindex "&'Message-ID:'& header line"
16653 If this option is set, the string is expanded and used as the right hand side
16654 (domain) of the &'Message-ID:'& header that Exim creates if a
16655 locally-originated incoming message does not have one. &"Locally-originated"&
16656 means &"not received over TCP/IP."&
16657 Otherwise, the primary host name is used.
16658 Only letters, digits, dot and hyphen are accepted; any other characters are
16659 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16660 empty string, the option is ignored.
16661
16662
16663 .option message_id_header_text main string&!! unset
16664 If this variable is set, the string is expanded and used to augment the text of
16665 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16666 message does not have one. The text of this header is required by RFC 2822 to
16667 take the form of an address. By default, Exim uses its internal message id as
16668 the local part, and the primary host name as the domain. If this option is set,
16669 it is expanded, and provided the expansion is not forced to fail, and does not
16670 yield an empty string, the result is inserted into the header immediately
16671 before the @, separated from the internal message id by a dot. Any characters
16672 that are illegal in an address are automatically converted into hyphens. This
16673 means that variables such as &$tod_log$& can be used, because the spaces and
16674 colons will become hyphens.
16675
16676
16677 .option message_logs main boolean true
16678 .cindex "message logs" "disabling"
16679 .cindex "log" "message log; disabling"
16680 If this option is turned off, per-message log files are not created in the
16681 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16682 Exim, by reducing the number of files involved in handling a message from a
16683 minimum of four (header spool file, body spool file, delivery journal, and
16684 per-message log) to three. The other major I/O activity is Exim's main log,
16685 which is not affected by this option.
16686
16687
16688 .option message_size_limit main string&!! 50M
16689 .cindex "message" "size limit"
16690 .cindex "limit" "message size"
16691 .cindex "size" "of message, limit"
16692 This option limits the maximum size of message that Exim will process. The
16693 value is expanded for each incoming connection so, for example, it can be made
16694 to depend on the IP address of the remote host for messages arriving via
16695 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16696 optionally followed by K or M.
16697
16698 .cindex "SIZE" "ESMTP extension, advertising"
16699 .cindex "ESMTP extensions" SIZE
16700 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16701 service extension keyword.
16702
16703 &*Note*&: This limit cannot be made to depend on a message's sender or any
16704 other properties of an individual message, because it has to be advertised in
16705 the server's response to EHLO. String expansion failure causes a temporary
16706 error. A value of zero means no limit, but its use is not recommended. See also
16707 &%bounce_return_size_limit%&.
16708
16709 Incoming SMTP messages are failed with a 552 error if the limit is
16710 exceeded; locally-generated messages either get a stderr message or a delivery
16711 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16712 an oversized message is logged in both the main and the reject logs. See also
16713 the generic transport option &%message_size_limit%&, which limits the size of
16714 message that an individual transport can process.
16715
16716 If you use a virus-scanner and set this option to to a value larger than the
16717 maximum size that your virus-scanner is configured to support, you may get
16718 failures triggered by large mails.  The right size to configure for the
16719 virus-scanner depends upon what data is passed and the options in use but it's
16720 probably safest to just set it to a little larger than this value.  E.g., with a
16721 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16722 some problems may result.
16723
16724 A value of 0 will disable size limit checking; Exim will still advertise the
16725 SIZE extension in an EHLO response, but without a limit, so as to permit
16726 SMTP clients to still indicate the message size along with the MAIL verb.
16727
16728
16729 .option move_frozen_messages main boolean false
16730 .cindex "frozen messages" "moving"
16731 This option, which is available only if Exim has been built with the setting
16732 .code
16733 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16734 .endd
16735 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16736 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16737 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16738 standard utilities for handling such moved messages, and they do not show up in
16739 lists generated by &%-bp%& or by the Exim monitor.
16740
16741
16742 .option mua_wrapper main boolean false
16743 Setting this option true causes Exim to run in a very restrictive mode in which
16744 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16745 contains a full description of this facility.
16746
16747
16748
16749 .option mysql_servers main "string list" unset
16750 .cindex "MySQL" "server list"
16751 This option provides a list of MySQL servers and associated connection data, to
16752 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16753 option is available only if Exim has been built with MySQL support.
16754
16755
16756 .option never_users main "string list&!!" unset
16757 This option is expanded just once, at the start of Exim's processing. Local
16758 message deliveries are normally run in processes that are setuid to the
16759 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16760 It is usually desirable to prevent any deliveries from running as root, as a
16761 safety precaution.
16762
16763 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16764 list of users that must not be used for local deliveries. This list is fixed in
16765 the binary and cannot be overridden by the configuration file. By default, it
16766 contains just the single user name &"root"&. The &%never_users%& runtime option
16767 can be used to add more users to the fixed list.
16768
16769 If a message is to be delivered as one of the users on the fixed list or the
16770 &%never_users%& list, an error occurs, and delivery is deferred. A common
16771 example is
16772 .code
16773 never_users = root:daemon:bin
16774 .endd
16775 Including root is redundant if it is also on the fixed list, but it does no
16776 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16777 transport driver.
16778
16779
16780 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16781 This option gives the name for a unix-domain socket on which the daemon
16782 listens for work and information-requests.
16783 Only installations running multiple daemons sharing a spool directory
16784 should need to modify the default.
16785
16786 The option is expanded before use.
16787 If the platform supports Linux-style abstract socket names, the result
16788 is used with a nul byte prefixed.
16789 Otherwise,
16790 .new "if nonempty,"
16791 it should be a full path name and use a directory accessible
16792 to Exim.
16793
16794 .new
16795 If this option is set as empty,
16796 or the command line &%-oY%& option is used, or
16797 .wen
16798 the command line uses a &%-oX%& option and does not use &%-oP%&,
16799 then a notifier socket is not created.
16800
16801
16802 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16803 .cindex "OpenSSL "compatibility options"
16804 This option allows an administrator to adjust the SSL options applied
16805 by OpenSSL to connections.  It is given as a space-separated list of items,
16806 each one to be +added or -subtracted from the current value.
16807
16808 This option is only available if Exim is built against OpenSSL.  The values
16809 available for this option vary according to the age of your OpenSSL install.
16810 The &"all"& value controls a subset of flags which are available, typically
16811 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16812 list the values known on your system and Exim should support all the
16813 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16814 names lose the leading &"SSL_OP_"& and are lower-cased.
16815
16816 Note that adjusting the options can have severe impact upon the security of
16817 SSL as used by Exim.  It is possible to disable safety checks and shoot
16818 yourself in the foot in various unpleasant ways.  This option should not be
16819 adjusted lightly.  An unrecognised item will be detected at startup, by
16820 invoking Exim with the &%-bV%& flag.
16821
16822 The option affects Exim operating both as a server and as a client.
16823
16824 Historical note: prior to release 4.80, Exim defaulted this value to
16825 "+dont_insert_empty_fragments", which may still be needed for compatibility
16826 with some clients, but which lowers security by increasing exposure to
16827 some now infamous attacks.
16828
16829 Examples:
16830 .code
16831 # Make both old MS and old Eudora happy:
16832 openssl_options = -all +microsoft_big_sslv3_buffer \
16833                        +dont_insert_empty_fragments
16834
16835 # Disable older protocol versions:
16836 openssl_options = +no_sslv2 +no_sslv3
16837 .endd
16838
16839 Possible options may include:
16840 .ilist
16841 &`all`&
16842 .next
16843 &`allow_unsafe_legacy_renegotiation`&
16844 .next
16845 &`cipher_server_preference`&
16846 .next
16847 &`dont_insert_empty_fragments`&
16848 .next
16849 &`ephemeral_rsa`&
16850 .next
16851 &`legacy_server_connect`&
16852 .next
16853 &`microsoft_big_sslv3_buffer`&
16854 .next
16855 &`microsoft_sess_id_bug`&
16856 .next
16857 &`msie_sslv2_rsa_padding`&
16858 .next
16859 &`netscape_challenge_bug`&
16860 .next
16861 &`netscape_reuse_cipher_change_bug`&
16862 .next
16863 &`no_compression`&
16864 .next
16865 &`no_session_resumption_on_renegotiation`&
16866 .next
16867 &`no_sslv2`&
16868 .next
16869 &`no_sslv3`&
16870 .next
16871 &`no_ticket`&
16872 .next
16873 &`no_tlsv1`&
16874 .next
16875 &`no_tlsv1_1`&
16876 .next
16877 &`no_tlsv1_2`&
16878 .next
16879 &`safari_ecdhe_ecdsa_bug`&
16880 .next
16881 &`single_dh_use`&
16882 .next
16883 &`single_ecdh_use`&
16884 .next
16885 &`ssleay_080_client_dh_bug`&
16886 .next
16887 &`sslref2_reuse_cert_type_bug`&
16888 .next
16889 &`tls_block_padding_bug`&
16890 .next
16891 &`tls_d5_bug`&
16892 .next
16893 &`tls_rollback_bug`&
16894 .endlist
16895
16896 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16897 all clients connecting using the MacOS SecureTransport TLS facility prior
16898 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16899 to negotiate TLS then this option value might help, provided that your OpenSSL
16900 release is new enough to contain this work-around.  This may be a situation
16901 where you have to upgrade OpenSSL to get buggy clients working.
16902
16903
16904 .option oracle_servers main "string list" unset
16905 .cindex "Oracle" "server list"
16906 This option provides a list of Oracle servers and associated connection data,
16907 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16908 The option is available only if Exim has been built with Oracle support.
16909
16910
16911 .option percent_hack_domains main "domain list&!!" unset
16912 .cindex "&""percent hack""&"
16913 .cindex "source routing" "in email address"
16914 .cindex "address" "source-routed"
16915 The &"percent hack"& is the convention whereby a local part containing a
16916 percent sign is re-interpreted as a new email address, with the percent
16917 replaced by @. This is sometimes called &"source routing"&, though that term is
16918 also applied to RFC 2822 addresses that begin with an @ character. If this
16919 option is set, Exim implements the percent facility for those domains listed,
16920 but no others. This happens before an incoming SMTP address is tested against
16921 an ACL.
16922
16923 &*Warning*&: The &"percent hack"& has often been abused by people who are
16924 trying to get round relaying restrictions. For this reason, it is best avoided
16925 if at all possible. Unfortunately, a number of less security-conscious MTAs
16926 implement it unconditionally. If you are running Exim on a gateway host, and
16927 routing mail through to internal MTAs without processing the local parts, it is
16928 a good idea to reject recipient addresses with percent characters in their
16929 local parts. Exim's default configuration does this.
16930
16931
16932 .option perl_at_start main boolean false
16933 .cindex "Perl"
16934 This option is available only when Exim is built with an embedded Perl
16935 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16936
16937
16938 .option perl_startup main string unset
16939 .cindex "Perl"
16940 This option is available only when Exim is built with an embedded Perl
16941 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16942
16943 .option perl_taintmode main boolean false
16944 .cindex "Perl"
16945 This option enables the taint mode of the embedded Perl interpreter.
16946
16947
16948 .option pgsql_servers main "string list" unset
16949 .cindex "PostgreSQL lookup type" "server list"
16950 This option provides a list of PostgreSQL servers and associated connection
16951 data, to be used in conjunction with &(pgsql)& lookups (see section
16952 &<<SECID72>>&). The option is available only if Exim has been built with
16953 PostgreSQL support.
16954
16955
16956 .option pid_file_path main string&!! "set at compile time"
16957 .cindex "daemon" "pid file path"
16958 .cindex "pid file, path for"
16959 This option sets the name of the file to which the Exim daemon writes its
16960 process id. The string is expanded, so it can contain, for example, references
16961 to the host name:
16962 .code
16963 pid_file_path = /var/log/$primary_hostname/exim.pid
16964 .endd
16965 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16966 spool directory.
16967 The value set by the option can be overridden by the &%-oP%& command line
16968 option. A pid file is not written if a &"non-standard"& daemon is run by means
16969 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16970
16971
16972 .option pipelining_advertise_hosts main "host list&!!" *
16973 .cindex "PIPELINING" "suppressing advertising"
16974 .cindex "ESMTP extensions" PIPELINING
16975 This option can be used to suppress the advertisement of the SMTP
16976 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16977 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16978 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16979 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16980 that clients will use it; &"out of order"& commands that are &"expected"& do
16981 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16982
16983 .option pipelining_connect_advertise_hosts main "host list&!!" *
16984 .cindex "pipelining" "early connection"
16985 .cindex "pipelining" PIPE_CONNECT
16986 .cindex "ESMTP extensions" PIPE_CONNECT
16987 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16988 this option controls which hosts the facility is advertised to
16989 and from which pipeline early-connection (before MAIL) SMTP
16990 commands are acceptable.
16991 When used, the pipelining saves on roundtrip times.
16992
16993 See also the &%hosts_pipe_connect%& smtp transport option.
16994
16995 .new
16996 The SMTP service extension keyword advertised is &"PIPE_CONNECT"&.
16997 .wen
16998
16999
17000 .option prdr_enable main boolean false
17001 .cindex "PRDR" "enabling on server"
17002 .cindex "ESMTP extensions" PRDR
17003 This option can be used to enable the Per-Recipient Data Response extension
17004 to SMTP, defined by Eric Hall.
17005 If the option is set, PRDR is advertised by Exim when operating as a server.
17006 If the client requests PRDR, and more than one recipient, for a message
17007 an additional ACL is called for each recipient after the message content
17008 is received.  See section &<<SECTPRDRACL>>&.
17009
17010 .option preserve_message_logs main boolean false
17011 .cindex "message logs" "preserving"
17012 If this option is set, message log files are not deleted when messages are
17013 completed. Instead, they are moved to a sub-directory of the spool directory
17014 called &_msglog.OLD_&, where they remain available for statistical or debugging
17015 purposes. This is a dangerous option to set on systems with any appreciable
17016 volume of mail. Use with care!
17017
17018
17019 .option primary_hostname main string "see below"
17020 .cindex "name" "of local host"
17021 .cindex "host" "name of local"
17022 .cindex "local host" "name of"
17023 .vindex "&$primary_hostname$&"
17024 This specifies the name of the current host. It is used in the default EHLO or
17025 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17026 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17027 The value is also used by default in some SMTP response messages from an Exim
17028 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17029
17030 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17031 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17032 contains only one component, Exim passes it to &[gethostbyname()]& (or
17033 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17034 version. The variable &$primary_hostname$& contains the host name, whether set
17035 explicitly by this option, or defaulted.
17036
17037
17038 .option print_topbitchars main boolean false
17039 .cindex "printing characters"
17040 .cindex "8-bit characters"
17041 By default, Exim considers only those characters whose codes lie in the range
17042 32&--126 to be printing characters. In a number of circumstances (for example,
17043 when writing log entries) non-printing characters are converted into escape
17044 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17045 is set, code values of 128 and above are also considered to be printing
17046 characters.
17047
17048 This option also affects the header syntax checks performed by the
17049 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17050 the user's full name when constructing From: and Sender: addresses (as
17051 described in section &<<SECTconstr>>&). Setting this option can cause
17052 Exim to generate eight bit message headers that do not conform to the
17053 standards.
17054
17055
17056 .option process_log_path main string unset
17057 .cindex "process log path"
17058 .cindex "log" "process log"
17059 .cindex "&'exiwhat'&"
17060 This option sets the name of the file to which an Exim process writes its
17061 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17062 utility script. If this option is unset, the file called &_exim-process.info_&
17063 in Exim's spool directory is used. The ability to specify the name explicitly
17064 can be useful in environments where two different Exims are running, using
17065 different spool directories.
17066
17067
17068 .option prod_requires_admin main boolean true
17069 .cindex "restricting access to features"
17070 .oindex "&%-M%&"
17071 .oindex "&%-R%&"
17072 .oindex "&%-q%&"
17073 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17074 admin user unless &%prod_requires_admin%& is set false. See also
17075 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17076
17077
17078 .new
17079 .option proxy_protocol_timeout main time 3s
17080 .cindex proxy "proxy protocol"
17081 This option sets the timeout for proxy protocol negotiation.
17082 For details see section &<<SECTproxyInbound>>&.
17083 .wen
17084
17085
17086 .option qualify_domain main string "see below"
17087 .cindex "domain" "for qualifying addresses"
17088 .cindex "address" "qualification"
17089 This option specifies the domain name that is added to any envelope sender
17090 addresses that do not have a domain qualification. It also applies to
17091 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17092 are accepted by default only for locally-generated messages. Qualification is
17093 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17094 locally-generated messages, unless the &%-bnq%& command line option is used.
17095
17096 Messages from external sources must always contain fully qualified addresses,
17097 unless the sending host matches &%sender_unqualified_hosts%& or
17098 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17099 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17100 necessary. Internally, Exim always works with fully qualified envelope
17101 addresses. If &%qualify_domain%& is not set, it defaults to the
17102 &%primary_hostname%& value.
17103
17104
17105 .option qualify_recipient main string "see below"
17106 This option allows you to specify a different domain for qualifying recipient
17107 addresses to the one that is used for senders. See &%qualify_domain%& above.
17108
17109
17110
17111 .option queue_domains main "domain list&!!" unset
17112 .cindex "domain" "specifying non-immediate delivery"
17113 .cindex "queueing incoming messages"
17114 .cindex "message" "queueing certain domains"
17115 This option lists domains for which immediate delivery is not required.
17116 A delivery process is started whenever a message is received, but only those
17117 domains that do not match are processed. All other deliveries wait until the
17118 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17119
17120
17121 .new
17122 .option queue_fast_ramp main boolean false
17123 .cindex "queue runner" "two phase"
17124 .cindex "queue" "double scanning"
17125 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17126 command line, may start parallel delivery processes during their first
17127 phase.  This will be done when a threshold number of messages have been
17128 routed for a single host.
17129 .wen
17130
17131
17132 .option queue_list_requires_admin main boolean true
17133 .cindex "restricting access to features"
17134 .oindex "&%-bp%&"
17135 The &%-bp%& command-line option, which lists the messages that are on the
17136 queue, requires the caller to be an admin user unless
17137 &%queue_list_requires_admin%& is set false.
17138 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17139
17140
17141 .option queue_only main boolean false
17142 .cindex "queueing incoming messages"
17143 .cindex "message" "queueing unconditionally"
17144 If &%queue_only%& is set, a delivery process is not automatically started
17145 whenever a message is received. Instead, the message waits in the queue for the
17146 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17147 delivered immediately when certain conditions (such as heavy load) occur.
17148
17149 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17150 and &%-odi%& command line options override &%queue_only%& unless
17151 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17152 &%queue_only_load%&, and &%smtp_accept_queue%&.
17153
17154
17155 .option queue_only_file main string unset
17156 .cindex "queueing incoming messages"
17157 .cindex "message" "queueing by file existence"
17158 This option can be set to a colon-separated list of absolute path names, each
17159 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17160 it tests for the existence of each listed path using a call to &[stat()]&. For
17161 each path that exists, the corresponding queueing option is set.
17162 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17163 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17164 .code
17165 queue_only_file = smtp/some/file
17166 .endd
17167 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17168 &_/some/file_& exists.
17169
17170
17171 .option queue_only_load main fixed-point unset
17172 .cindex "load average"
17173 .cindex "queueing incoming messages"
17174 .cindex "message" "queueing by load"
17175 If the system load average is higher than this value, incoming messages from
17176 all sources are queued, and no automatic deliveries are started. If this
17177 happens during local or remote SMTP input, all subsequent messages received on
17178 the same SMTP connection are queued by default, whatever happens to the load in
17179 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17180 false.
17181
17182 Deliveries will subsequently be performed by queue runner processes. This
17183 option has no effect on ancient operating systems on which Exim cannot
17184 determine the load average. See also &%deliver_queue_load_max%& and
17185 &%smtp_load_reserve%&.
17186
17187
17188 .option queue_only_load_latch main boolean true
17189 .cindex "load average" "re-evaluating per message"
17190 When this option is true (the default), once one message has been queued
17191 because the load average is higher than the value set by &%queue_only_load%&,
17192 all subsequent messages received on the same SMTP connection are also queued.
17193 This is a deliberate choice; even though the load average may fall below the
17194 threshold, it doesn't seem right to deliver later messages on the same
17195 connection when not delivering earlier ones. However, there are special
17196 circumstances such as very long-lived connections from scanning appliances
17197 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17198 should be set false. This causes the value of the load average to be
17199 re-evaluated for each message.
17200
17201
17202 .option queue_only_override main boolean true
17203 .cindex "queueing incoming messages"
17204 When this option is true, the &%-od%&&'x'& command line options override the
17205 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17206 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17207 to override; they are accepted, but ignored.
17208
17209
17210 .option queue_run_in_order main boolean false
17211 .cindex "queue runner" "processing messages in order"
17212 If this option is set, queue runs happen in order of message arrival instead of
17213 in an arbitrary order. For this to happen, a complete list of the entire queue
17214 must be set up before the deliveries start. When the queue is all held in a
17215 single directory (the default), a single list is created for both the ordered
17216 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17217 single list is not created when &%queue_run_in_order%& is false. In this case,
17218 the sub-directories are processed one at a time (in a random order), and this
17219 avoids setting up one huge list for the whole queue. Thus, setting
17220 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17221 when the queue is large, because of the extra work in setting up the single,
17222 large list. In most situations, &%queue_run_in_order%& should not be set.
17223
17224
17225
17226 .option queue_run_max main integer&!! 5
17227 .cindex "queue runner" "maximum number of"
17228 This controls the maximum number of queue runner processes that an Exim daemon
17229 can run simultaneously. This does not mean that it starts them all at once,
17230 but rather that if the maximum number are still running when the time comes to
17231 start another one, it refrains from starting another one. This can happen with
17232 very large queues and/or very sluggish deliveries. This option does not,
17233 however, interlock with other processes, so additional queue runners can be
17234 started by other means, or by killing and restarting the daemon.
17235
17236 Setting this option to zero does not suppress queue runs; rather, it disables
17237 the limit, allowing any number of simultaneous queue runner processes to be
17238 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17239 the daemon's command line.
17240
17241 .cindex queues named
17242 .cindex "named queues" "resource limit"
17243 To set limits for different named queues use
17244 an expansion depending on the &$queue_name$& variable.
17245
17246 .option queue_smtp_domains main "domain list&!!" unset
17247 .cindex "queueing incoming messages"
17248 .cindex "message" "queueing remote deliveries"
17249 .cindex "first pass routing"
17250 When this option is set, a delivery process is started whenever a message is
17251 received, routing is performed, and local deliveries take place.
17252 However, if any SMTP deliveries are required for domains that match
17253 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17254 message waits in the queue for the next queue run. Since routing of the message
17255 has taken place, Exim knows to which remote hosts it must be delivered, and so
17256 when the queue run happens, multiple messages for the same host are delivered
17257 over a single SMTP connection. The &%-odqs%& command line option causes all
17258 SMTP deliveries to be queued in this way, and is equivalent to setting
17259 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17260 &%queue_domains%&.
17261
17262
17263 .option receive_timeout main time 0s
17264 .cindex "timeout" "for non-SMTP input"
17265 This option sets the timeout for accepting a non-SMTP message, that is, the
17266 maximum time that Exim waits when reading a message on the standard input. If
17267 the value is zero, it will wait forever. This setting is overridden by the
17268 &%-or%& command line option. The timeout for incoming SMTP messages is
17269 controlled by &%smtp_receive_timeout%&.
17270
17271 .option received_header_text main string&!! "see below"
17272 .cindex "customizing" "&'Received:'& header"
17273 .cindex "&'Received:'& header line" "customizing"
17274 This string defines the contents of the &'Received:'& message header that is
17275 added to each message, except for the timestamp, which is automatically added
17276 on at the end (preceded by a semicolon). The string is expanded each time it is
17277 used. If the expansion yields an empty string, no &'Received:'& header line is
17278 added to the message. Otherwise, the string should start with the text
17279 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17280 header lines.
17281 The default setting is:
17282
17283 .code
17284 received_header_text = Received: \
17285   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17286     {${if def:sender_ident \
17287       {from ${quote_local_part:$sender_ident} }}\
17288         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17289   by $primary_hostname \
17290   ${if def:received_protocol {with $received_protocol }}\
17291   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17292   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17293   (Exim $version_number)\n\t\
17294   ${if def:sender_address \
17295   {(envelope-from <$sender_address>)\n\t}}\
17296   id $message_exim_id\
17297   ${if def:received_for {\n\tfor $received_for}}
17298 .endd
17299
17300 The references to the TLS version and cipher are
17301 omitted when Exim is built without TLS
17302 support. The use of conditional expansions ensures that this works for both
17303 locally generated messages and messages received from remote hosts, giving
17304 header lines such as the following:
17305 .code
17306 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17307 by marley.carol.example with esmtp (Exim 4.00)
17308 (envelope-from <bob@carol.example>)
17309 id 16IOWa-00019l-00
17310 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17311 Received: by scrooge.carol.example with local (Exim 4.00)
17312 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17313 .endd
17314 Until the body of the message has been received, the timestamp is the time when
17315 the message started to be received. Once the body has arrived, and all policy
17316 checks have taken place, the timestamp is updated to the time at which the
17317 message was accepted.
17318
17319
17320 .option received_headers_max main integer 30
17321 .cindex "loop" "prevention"
17322 .cindex "mail loop prevention"
17323 .cindex "&'Received:'& header line" "counting"
17324 When a message is to be delivered, the number of &'Received:'& headers is
17325 counted, and if it is greater than this parameter, a mail loop is assumed to
17326 have occurred, the delivery is abandoned, and an error message is generated.
17327 This applies to both local and remote deliveries.
17328
17329
17330 .option recipient_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 recipient addresses in message envelopes. The addresses are made fully
17335 qualified by the addition of the &%qualify_recipient%& value. This option also
17336 affects message header lines. Exim does not reject unqualified recipient
17337 addresses in headers, but it qualifies them only if the message came from a
17338 host that matches &%recipient_unqualified_hosts%&,
17339 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17340 option was not set.
17341
17342
17343 .option recipients_max main integer 0
17344 .cindex "limit" "number of recipients"
17345 .cindex "recipient" "maximum number"
17346 If this option is set greater than zero, it specifies the maximum number of
17347 original recipients for any message. Additional recipients that are generated
17348 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17349 all recipients over the limit; earlier recipients are delivered as normal.
17350 Non-SMTP messages with too many recipients are failed, and no deliveries are
17351 done.
17352
17353 .cindex "RCPT" "maximum number of incoming"
17354 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17355 RCPT commands in a single message.
17356
17357
17358 .option recipients_max_reject main boolean false
17359 If this option is set true, Exim rejects SMTP messages containing too many
17360 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17361 error to the eventual DATA command. Otherwise (the default) it gives a 452
17362 error to the surplus RCPT commands and accepts the message on behalf of the
17363 initial set of recipients. The remote server should then re-send the message
17364 for the remaining recipients at a later time.
17365
17366
17367 .option remote_max_parallel main integer 2
17368 .cindex "delivery" "parallelism for remote"
17369 This option controls parallel delivery of one message to a number of remote
17370 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17371 does all the remote deliveries for a message one by one. Otherwise, if a single
17372 message has to be delivered to more than one remote host, or if several copies
17373 have to be sent to the same remote host, up to &%remote_max_parallel%&
17374 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17375 deliveries are required, the maximum number of processes are started, and as
17376 each one finishes, another is begun. The order of starting processes is the
17377 same as if sequential delivery were being done, and can be controlled by the
17378 &%remote_sort_domains%& option. If parallel delivery takes place while running
17379 with debugging turned on, the debugging output from each delivery process is
17380 tagged with its process id.
17381
17382 This option controls only the maximum number of parallel deliveries for one
17383 message in one Exim delivery process. Because Exim has no central queue
17384 manager, there is no way of controlling the total number of simultaneous
17385 deliveries if the configuration allows a delivery attempt as soon as a message
17386 is received.
17387
17388 See also the &%max_parallel%& generic transport option,
17389 and the &%serialize_hosts%& smtp transport option.
17390
17391 .cindex "number of deliveries"
17392 .cindex "delivery" "maximum number of"
17393 If you want to control the total number of deliveries on the system, you
17394 need to set the &%queue_only%& option. This ensures that all incoming messages
17395 are added to the queue without starting a delivery process. Then set up an Exim
17396 daemon to start queue runner processes at appropriate intervals (probably
17397 fairly often, for example, every minute), and limit the total number of queue
17398 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17399 delivers only one message at a time, the maximum number of deliveries that can
17400 then take place at once is &%queue_run_max%& multiplied by
17401 &%remote_max_parallel%&.
17402
17403 If it is purely remote deliveries you want to control, use
17404 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17405 doing the SMTP routing before queueing, so that several messages for the same
17406 host will eventually get delivered down the same connection.
17407
17408
17409 .option remote_sort_domains main "domain list&!!" unset
17410 .cindex "sorting remote deliveries"
17411 .cindex "delivery" "sorting remote"
17412 When there are a number of remote deliveries for a message, they are sorted by
17413 domain into the order given by this list. For example,
17414 .code
17415 remote_sort_domains = *.cam.ac.uk:*.uk
17416 .endd
17417 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17418 then to those in the &%uk%& domain, then to any others.
17419
17420
17421 .option retry_data_expire main time 7d
17422 .cindex "hints database" "data expiry"
17423 This option sets a &"use before"& time on retry information in Exim's hints
17424 database. Any older retry data is ignored. This means that, for example, once a
17425 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17426 past failures.
17427
17428
17429 .option retry_interval_max main time 24h
17430 .cindex "retry" "limit on interval"
17431 .cindex "limit" "on retry interval"
17432 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17433 intervals between delivery attempts for messages that cannot be delivered
17434 straight away. This option sets an overall limit to the length of time between
17435 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17436 the default value.
17437
17438
17439 .option return_path_remove main boolean true
17440 .cindex "&'Return-path:'& header line" "removing"
17441 RFC 2821, section 4.4, states that an SMTP server must insert a
17442 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17443 The &'Return-path:'& header preserves the sender address as received in the
17444 MAIL command. This description implies that this header should not be present
17445 in an incoming message. If &%return_path_remove%& is true, any existing
17446 &'Return-path:'& headers are removed from messages at the time they are
17447 received. Exim's transports have options for adding &'Return-path:'& headers at
17448 the time of delivery. They are normally used only for final local deliveries.
17449
17450
17451 .option return_size_limit main integer 100K
17452 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17453
17454
17455 .option rfc1413_hosts main "host list&!!" @[]
17456 .cindex "RFC 1413"
17457 .cindex "host" "for RFC 1413 calls"
17458 RFC 1413 identification calls are made to any client host which matches
17459 an item in the list.
17460 The default value specifies just this host, being any local interface
17461 for the system.
17462
17463 .option rfc1413_query_timeout main time 0s
17464 .cindex "RFC 1413" "query timeout"
17465 .cindex "timeout" "for RFC 1413 call"
17466 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17467 no RFC 1413 calls are ever made.
17468
17469
17470 .option sender_unqualified_hosts main "host list&!!" unset
17471 .cindex "unqualified addresses"
17472 .cindex "host" "unqualified addresses from"
17473 This option lists those hosts from which Exim is prepared to accept unqualified
17474 sender addresses. The addresses are made fully qualified by the addition of
17475 &%qualify_domain%&. This option also affects message header lines. Exim does
17476 not reject unqualified addresses in headers that contain sender addresses, but
17477 it qualifies them only if the message came from a host that matches
17478 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17479 using TCP/IP), and the &%-bnq%& option was not set.
17480
17481
17482 .option slow_lookup_log main integer 0
17483 .cindex "logging" "slow lookups"
17484 .cindex "dns" "logging slow lookups"
17485 This option controls logging of slow lookups.
17486 If the value is nonzero it is taken as a number of milliseconds
17487 and lookups taking longer than this are logged.
17488 Currently this applies only to DNS lookups.
17489
17490
17491
17492 .option smtp_accept_keepalive main boolean true
17493 .cindex "keepalive" "on incoming connection"
17494 This option controls the setting of the SO_KEEPALIVE option on incoming
17495 TCP/IP socket connections. When set, it causes the kernel to probe idle
17496 connections periodically, by sending packets with &"old"& sequence numbers. The
17497 other end of the connection should send an acknowledgment if the connection is
17498 still okay or a reset if the connection has been aborted. The reason for doing
17499 this is that it has the beneficial effect of freeing up certain types of
17500 connection that can get stuck when the remote host is disconnected without
17501 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17502 hours to detect unreachable hosts.
17503
17504
17505
17506 .option smtp_accept_max main integer 20
17507 .cindex "limit" "incoming SMTP connections"
17508 .cindex "SMTP" "incoming connection count"
17509 .cindex "inetd"
17510 This option specifies the maximum number of simultaneous incoming SMTP calls
17511 that Exim will accept. It applies only to the listening daemon; there is no
17512 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17513 value is set to zero, no limit is applied. However, it is required to be
17514 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17515 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17516
17517 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17518 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17519 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17520 and &%smtp_load_reserve%& are then checked before accepting the connection.
17521
17522
17523 .option smtp_accept_max_nonmail main integer 10
17524 .cindex "limit" "non-mail SMTP commands"
17525 .cindex "SMTP" "limiting non-mail commands"
17526 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17527 the connection if there are too many. This option defines &"too many"&. The
17528 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17529 client looping sending EHLO, for example. The check is applied only if the
17530 client host matches &%smtp_accept_max_nonmail_hosts%&.
17531
17532 When a new message is expected, one occurrence of RSET is not counted. This
17533 allows a client to send one RSET between messages (this is not necessary,
17534 but some clients do it). Exim also allows one uncounted occurrence of HELO
17535 or EHLO, and one occurrence of STARTTLS between messages. After
17536 starting up a TLS session, another EHLO is expected, and so it too is not
17537 counted. The first occurrence of AUTH in a connection, or immediately
17538 following STARTTLS is not counted. Otherwise, all commands other than
17539 MAIL, RCPT, DATA, and QUIT are counted.
17540
17541
17542 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17543 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17544 check by setting this option. The default value makes it apply to all hosts. By
17545 changing the value, you can exclude any badly-behaved hosts that you have to
17546 live with.
17547
17548
17549 . Allow this long option name to split; give it unsplit as a fifth argument
17550 . for the automatic .oindex that is generated by .option.
17551 . We insert " &~&~" which is both pretty nasty visually and results in
17552 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17553 . zero-width-space, which would be nicer visually and results in (at least)
17554 . html that Firefox will split on when it's forced to reflow (rather than
17555 . inserting a horizontal scrollbar).  However, the text is still not
17556 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17557 . the option name to split.
17558
17559 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17560          smtp_accept_max_per_connection
17561 .cindex "SMTP" "limiting incoming message count"
17562 .cindex "limit" "messages per SMTP connection"
17563 The value of this option limits the number of MAIL commands that Exim is
17564 prepared to accept over a single SMTP connection, whether or not each command
17565 results in the transfer of a message. After the limit is reached, a 421
17566 response is given to subsequent MAIL commands. This limit is a safety
17567 precaution against a client that goes mad (incidents of this type have been
17568 seen).
17569
17570
17571 .option smtp_accept_max_per_host main string&!! unset
17572 .cindex "limit" "SMTP connections from one host"
17573 .cindex "host" "limiting SMTP connections from"
17574 This option restricts the number of simultaneous IP connections from a single
17575 host (strictly, from a single IP address) to the Exim daemon. The option is
17576 expanded, to enable different limits to be applied to different hosts by
17577 reference to &$sender_host_address$&. Once the limit is reached, additional
17578 connection attempts from the same host are rejected with error code 421. This
17579 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17580 of zero imposes no limit. If this option is set greater than zero, it is
17581 required that &%smtp_accept_max%& be non-zero.
17582
17583 &*Warning*&: When setting this option you should not use any expansion
17584 constructions that take an appreciable amount of time. The expansion and test
17585 happen in the main daemon loop, in order to reject additional connections
17586 without forking additional processes (otherwise a denial-of-service attack
17587 could cause a vast number or processes to be created). While the daemon is
17588 doing this processing, it cannot accept any other incoming connections.
17589
17590
17591
17592 .option smtp_accept_queue main integer 0
17593 .cindex "SMTP" "incoming connection count"
17594 .cindex "queueing incoming messages"
17595 .cindex "message" "queueing by SMTP connection count"
17596 If the number of simultaneous incoming SMTP connections being handled via the
17597 listening daemon exceeds this value, messages received by SMTP are just placed
17598 in the queue; no delivery processes are started automatically. The count is
17599 fixed at the start of an SMTP connection. It cannot be updated in the
17600 subprocess that receives messages, and so the queueing or not queueing applies
17601 to all messages received in the same connection.
17602
17603 A value of zero implies no limit, and clearly any non-zero value is useful only
17604 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17605 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17606 various &%-od%&&'x'& command line options.
17607
17608
17609 . See the comment on smtp_accept_max_per_connection
17610
17611 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17612          smtp_accept_queue_per_connection
17613 .cindex "queueing incoming messages"
17614 .cindex "message" "queueing by message count"
17615 This option limits the number of delivery processes that Exim starts
17616 automatically when receiving messages via SMTP, whether via the daemon or by
17617 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17618 and the number of messages received in a single SMTP session exceeds this
17619 number, subsequent messages are placed in the queue, but no delivery processes
17620 are started. This helps to limit the number of Exim processes when a server
17621 restarts after downtime and there is a lot of mail waiting for it on other
17622 systems. On large systems, the default should probably be increased, and on
17623 dial-in client systems it should probably be set to zero (that is, disabled).
17624
17625
17626 .option smtp_accept_reserve main integer 0
17627 .cindex "SMTP" "incoming call count"
17628 .cindex "host" "reserved"
17629 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17630 number of SMTP connections that are reserved for connections from the hosts
17631 that are specified in &%smtp_reserve_hosts%&. The value set in
17632 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17633 restricted to this number of connections; the option specifies a minimum number
17634 of connection slots for them, not a maximum. It is a guarantee that this group
17635 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17636 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17637 individual host.
17638
17639 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17640 set to 5, once there are 45 active connections (from any hosts), new
17641 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17642 provided the other criteria for acceptance are met.
17643
17644
17645 .option smtp_active_hostname main string&!! unset
17646 .cindex "host" "name in SMTP responses"
17647 .cindex "SMTP" "host name in responses"
17648 .vindex "&$primary_hostname$&"
17649 This option is provided for multi-homed servers that want to masquerade as
17650 several different hosts. At the start of an incoming SMTP connection, its value
17651 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17652 responses. For example, it is used as domain name in the response to an
17653 incoming HELO or EHLO command.
17654
17655 .vindex "&$smtp_active_hostname$&"
17656 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17657 is saved with any messages that are received. It is therefore available for use
17658 in routers and transports when the message is later delivered.
17659
17660 If this option is unset, or if its expansion is forced to fail, or if the
17661 expansion results in an empty string, the value of &$primary_hostname$& is
17662 used. Other expansion failures cause a message to be written to the main and
17663 panic logs, and the SMTP command receives a temporary error. Typically, the
17664 value of &%smtp_active_hostname%& depends on the incoming interface address.
17665 For example:
17666 .code
17667 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17668   {cox.mydomain}{box.mydomain}}
17669 .endd
17670
17671 Although &$smtp_active_hostname$& is primarily concerned with incoming
17672 messages, it is also used as the default for HELO commands in callout
17673 verification if there is no remote transport from which to obtain a
17674 &%helo_data%& value.
17675
17676 .option smtp_banner main string&!! "see below"
17677 .cindex "SMTP" "welcome banner"
17678 .cindex "banner for SMTP"
17679 .cindex "welcome banner for SMTP"
17680 .cindex "customizing" "SMTP banner"
17681 This string, which is expanded every time it is used, is output as the initial
17682 positive response to an SMTP connection. The default setting is:
17683 .code
17684 smtp_banner = $smtp_active_hostname ESMTP Exim \
17685   $version_number $tod_full
17686 .endd
17687 Failure to expand the string causes a panic error. If you want to create a
17688 multiline response to the initial SMTP connection, use &"\n"& in the string at
17689 appropriate points, but not at the end. Note that the 220 code is not included
17690 in this string. Exim adds it automatically (several times in the case of a
17691 multiline response).
17692
17693
17694 .option smtp_check_spool_space main boolean true
17695 .cindex "checking disk space"
17696 .cindex "disk space, checking"
17697 .cindex "spool directory" "checking space"
17698 When this option is set, if an incoming SMTP session encounters the SIZE
17699 option on a MAIL command, it checks that there is enough space in the
17700 spool directory's partition to accept a message of that size, while still
17701 leaving free the amount specified by &%check_spool_space%& (even if that value
17702 is zero). If there isn't enough space, a temporary error code is returned.
17703
17704
17705 .option smtp_connect_backlog main integer 20
17706 .cindex "connection backlog"
17707 .cindex "SMTP" "connection backlog"
17708 .cindex "backlog of connections"
17709 This option specifies a maximum number of waiting SMTP connections. Exim passes
17710 this value to the TCP/IP system when it sets up its listener. Once this number
17711 of connections are waiting for the daemon's attention, subsequent connection
17712 attempts are refused at the TCP/IP level. At least, that is what the manuals
17713 say; in some circumstances such connection attempts have been observed to time
17714 out instead. For large systems it is probably a good idea to increase the
17715 value (to 50, say). It also gives some protection against denial-of-service
17716 attacks by SYN flooding.
17717
17718
17719 .option smtp_enforce_sync main boolean true
17720 .cindex "SMTP" "synchronization checking"
17721 .cindex "synchronization checking in SMTP"
17722 The SMTP protocol specification requires the client to wait for a response from
17723 the server at certain points in the dialogue. Without PIPELINING these
17724 synchronization points are after every command; with PIPELINING they are
17725 fewer, but they still exist.
17726
17727 Some spamming sites send out a complete set of SMTP commands without waiting
17728 for any response. Exim protects against this by rejecting a message if the
17729 client has sent further input when it should not have. The error response &"554
17730 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17731 for this error cannot be perfect because of transmission delays (unexpected
17732 input may be on its way but not yet received when Exim checks). However, it
17733 does detect many instances.
17734
17735 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17736 If you want to disable the check selectively (for example, only for certain
17737 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17738 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17739
17740
17741
17742 .option smtp_etrn_command main string&!! unset
17743 .cindex "ETRN" "command to be run"
17744 .cindex "ESMTP extensions" ETRN
17745 .vindex "&$domain$&"
17746 If this option is set, the given command is run whenever an SMTP ETRN
17747 command is received from a host that is permitted to issue such commands (see
17748 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17749 are independently expanded. The expansion variable &$domain$& is set to the
17750 argument of the ETRN command, and no syntax checking is done on it. For
17751 example:
17752 .code
17753 smtp_etrn_command = /etc/etrn_command $domain \
17754                     $sender_host_address
17755 .endd
17756 If the option is not set, the argument for the ETRN command must
17757 be a &'#'& followed by an address string.
17758 In this case an &'exim -R <string>'& command is used;
17759 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17760
17761 A new process is created to run the command, but Exim does not wait for it to
17762 complete. Consequently, its status cannot be checked. If the command cannot be
17763 run, a line is written to the panic log, but the ETRN caller still receives
17764 a 250 success response. Exim is normally running under its own uid when
17765 receiving SMTP, so it is not possible for it to change the uid before running
17766 the command.
17767
17768
17769 .option smtp_etrn_serialize main boolean true
17770 .cindex "ETRN" "serializing"
17771 When this option is set, it prevents the simultaneous execution of more than
17772 one identical command as a result of ETRN in an SMTP connection. See
17773 section &<<SECTETRN>>& for details.
17774
17775
17776 .option smtp_load_reserve main fixed-point unset
17777 .cindex "load average"
17778 If the system load average ever gets higher than this, incoming SMTP calls are
17779 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17780 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17781 the load is over the limit. The option has no effect on ancient operating
17782 systems on which Exim cannot determine the load average. See also
17783 &%deliver_queue_load_max%& and &%queue_only_load%&.
17784
17785
17786
17787 .option smtp_max_synprot_errors main integer 3
17788 .cindex "SMTP" "limiting syntax and protocol errors"
17789 .cindex "limit" "SMTP syntax and protocol errors"
17790 Exim rejects SMTP commands that contain syntax or protocol errors. In
17791 particular, a syntactically invalid email address, as in this command:
17792 .code
17793 RCPT TO:<abc xyz@a.b.c>
17794 .endd
17795 causes immediate rejection of the command, before any other tests are done.
17796 (The ACL cannot be run if there is no valid address to set up for it.) An
17797 example of a protocol error is receiving RCPT before MAIL. If there are
17798 too many syntax or protocol errors in one SMTP session, the connection is
17799 dropped. The limit is set by this option.
17800
17801 .cindex "PIPELINING" "expected errors"
17802 When the PIPELINING extension to SMTP is in use, some protocol errors are
17803 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17804 Exim assumes that PIPELINING will be used if it advertises it (see
17805 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17806 not count towards the limit.
17807
17808
17809
17810 .option smtp_max_unknown_commands main integer 3
17811 .cindex "SMTP" "limiting unknown commands"
17812 .cindex "limit" "unknown SMTP commands"
17813 If there are too many unrecognized commands in an incoming SMTP session, an
17814 Exim server drops the connection. This is a defence against some kinds of abuse
17815 that subvert web
17816 clients
17817 into making connections to SMTP ports; in these circumstances, a number of
17818 non-SMTP command lines are sent first.
17819
17820
17821
17822 .option smtp_ratelimit_hosts main "host list&!!" unset
17823 .cindex "SMTP" "rate limiting"
17824 .cindex "limit" "rate of message arrival"
17825 .cindex "RCPT" "rate limiting"
17826 Some sites find it helpful to be able to limit the rate at which certain hosts
17827 can send them messages, and the rate at which an individual message can specify
17828 recipients.
17829
17830 Exim has two rate-limiting facilities. This section describes the older
17831 facility, which can limit rates within a single connection. The newer
17832 &%ratelimit%& ACL condition can limit rates across all connections. See section
17833 &<<SECTratelimiting>>& for details of the newer facility.
17834
17835 When a host matches &%smtp_ratelimit_hosts%&, the values of
17836 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17837 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17838 respectively. Each option, if set, must contain a set of four comma-separated
17839 values:
17840
17841 .ilist
17842 A threshold, before which there is no rate limiting.
17843 .next
17844 An initial time delay. Unlike other times in Exim, numbers with decimal
17845 fractional parts are allowed here.
17846 .next
17847 A factor by which to increase the delay each time.
17848 .next
17849 A maximum value for the delay. This should normally be less than 5 minutes,
17850 because after that time, the client is liable to timeout the SMTP command.
17851 .endlist
17852
17853 For example, these settings have been used successfully at the site which
17854 first suggested this feature, for controlling mail from their customers:
17855 .code
17856 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17857 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17858 .endd
17859 The first setting specifies delays that are applied to MAIL commands after
17860 two have been received over a single connection. The initial delay is 0.5
17861 seconds, increasing by a factor of 1.05 each time. The second setting applies
17862 delays to RCPT commands when more than four occur in a single message.
17863
17864
17865 .option smtp_ratelimit_mail main string unset
17866 See &%smtp_ratelimit_hosts%& above.
17867
17868
17869 .option smtp_ratelimit_rcpt main string unset
17870 See &%smtp_ratelimit_hosts%& above.
17871
17872
17873 .option smtp_receive_timeout main time&!! 5m
17874 .cindex "timeout" "for SMTP input"
17875 .cindex "SMTP" "input timeout"
17876 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17877 input, including batch SMTP. If a line of input (either an SMTP command or a
17878 data line) is not received within this time, the SMTP connection is dropped and
17879 the message is abandoned.
17880 A line is written to the log containing one of the following messages:
17881 .code
17882 SMTP command timeout on connection from...
17883 SMTP data timeout on connection from...
17884 .endd
17885 The former means that Exim was expecting to read an SMTP command; the latter
17886 means that it was in the DATA phase, reading the contents of a message.
17887
17888 If the first character of the option is a &"$"& the option is
17889 expanded before use and may depend on
17890 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17891
17892
17893 .oindex "&%-os%&"
17894 The value set by this option can be overridden by the
17895 &%-os%& command-line option. A setting of zero time disables the timeout, but
17896 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17897 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17898 timeout is controlled by &%receive_timeout%& and &%-or%&.
17899
17900
17901 .option smtp_reserve_hosts main "host list&!!" unset
17902 This option defines hosts for which SMTP connections are reserved; see
17903 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17904
17905
17906 .option smtp_return_error_details main boolean false
17907 .cindex "SMTP" "details policy failures"
17908 .cindex "policy control" "rejection, returning details"
17909 In the default state, Exim uses bland messages such as
17910 &"Administrative prohibition"& when it rejects SMTP commands for policy
17911 reasons. Many sysadmins like this because it gives away little information
17912 to spammers. However, some other sysadmins who are applying strict checking
17913 policies want to give out much fuller information about failures. Setting
17914 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17915 example, instead of &"Administrative prohibition"&, it might give:
17916 .code
17917 550-Rejected after DATA: '>' missing at end of address:
17918 550 failing address in "From" header is: <user@dom.ain
17919 .endd
17920
17921
17922 .option smtputf8_advertise_hosts main "host list&!!" *
17923 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17924 .cindex "ESMTP extensions" SMTPUTF8
17925 When Exim is built with support for internationalised mail names,
17926 the availability thereof is advertised in
17927 response to EHLO only to those client hosts that match this option. See
17928 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17929
17930
17931 .option spamd_address main string "127.0.0.1 783"
17932 This option is available when Exim is compiled with the content-scanning
17933 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17934 See section &<<SECTscanspamass>>& for more details.
17935
17936
17937
17938 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17939 This option is available when Exim is compiled with SPF support.
17940 See section &<<SECSPF>>& for more details.
17941
17942 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17943 This option is available when Exim is compiled with SPF support.  It
17944 allows the customisation of the SMTP comment that the SPF library
17945 generates.  You are strongly encouraged to link to your own explanative
17946 site. The template must not contain spaces. If you need spaces in the
17947 output, use the proper placeholder. If libspf2 can not parse the
17948 template, it uses a built-in default broken link. The following placeholders
17949 (along with Exim variables (but see below)) are allowed in the template:
17950 .ilist
17951 &*%_*&: A space.
17952 .next
17953 &*%{L}*&: Envelope sender's local part.
17954 .next
17955 &*%{S}*&: Envelope sender.
17956 .next
17957 &*%{O}*&: Envelope sender's domain.
17958 .next
17959 &*%{D}*&: Current(?) domain.
17960 .next
17961 &*%{I}*&: SMTP client Ip.
17962 .next
17963 &*%{C}*&: SMTP client pretty IP.
17964 .next
17965 &*%{T}*&: Epoch time (UTC).
17966 .next
17967 &*%{P}*&: SMTP client domain name.
17968 .next
17969 &*%{V}*&: IP version.
17970 .next
17971 &*%{H}*&: EHLO/HELO domain.
17972 .next
17973 &*%{R}*&: Receiving domain.
17974 .endlist
17975 The capitalized placeholders do proper URL encoding, if you use them
17976 lowercased, no encoding takes place.  This list was compiled from the
17977 libspf2 sources.
17978
17979 A note on using Exim variables: As
17980 currently the SPF library is initialized before the SMTP EHLO phase,
17981 the variables useful for expansion are quite limited.
17982
17983
17984 .option split_spool_directory main boolean false
17985 .cindex "multiple spool directories"
17986 .cindex "spool directory" "split"
17987 .cindex "directories, multiple"
17988 If this option is set, it causes Exim to split its input directory into 62
17989 subdirectories, each with a single alphanumeric character as its name. The
17990 sixth character of the message id is used to allocate messages to
17991 subdirectories; this is the least significant base-62 digit of the time of
17992 arrival of the message.
17993
17994 Splitting up the spool in this way may provide better performance on systems
17995 where there are long mail queues, by reducing the number of files in any one
17996 directory. The msglog directory is also split up in a similar way to the input
17997 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17998 are still placed in the single directory &_msglog.OLD_&.
17999
18000 It is not necessary to take any special action for existing messages when
18001 changing &%split_spool_directory%&. Exim notices messages that are in the
18002 &"wrong"& place, and continues to process them. If the option is turned off
18003 after a period of being on, the subdirectories will eventually empty and be
18004 automatically deleted.
18005
18006 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18007 changes. Instead of creating a list of all messages in the queue, and then
18008 trying to deliver each one, in turn, it constructs a list of those in one
18009 sub-directory and tries to deliver them, before moving on to the next
18010 sub-directory. The sub-directories are processed in a random order. This
18011 spreads out the scanning of the input directories, and uses less memory. It is
18012 particularly beneficial when there are lots of messages in the queue. However,
18013 if &%queue_run_in_order%& is set, none of this new processing happens. The
18014 entire queue has to be scanned and sorted before any deliveries can start.
18015
18016
18017 .option spool_directory main string&!! "set at compile time"
18018 .cindex "spool directory" "path to"
18019 This defines the directory in which Exim keeps its spool, that is, the messages
18020 it is waiting to deliver. The default value is taken from the compile-time
18021 configuration setting, if there is one. If not, this option must be set. The
18022 string is expanded, so it can contain, for example, a reference to
18023 &$primary_hostname$&.
18024
18025 If the spool directory name is fixed on your installation, it is recommended
18026 that you set it at build time rather than from this option, particularly if the
18027 log files are being written to the spool directory (see &%log_file_path%&).
18028 Otherwise log files cannot be used for errors that are detected early on, such
18029 as failures in the configuration file.
18030
18031 By using this option to override the compiled-in path, it is possible to run
18032 tests of Exim without using the standard spool.
18033
18034 .option spool_wireformat main boolean false
18035 .cindex "spool directory" "file formats"
18036 If this option is set, Exim may for some messages use an alternative format
18037 for data-files in the spool which matches the wire format.
18038 Doing this permits more efficient message reception and transmission.
18039 Currently it is only done for messages received using the ESMTP CHUNKING
18040 option.
18041
18042 The following variables will not have useful values:
18043 .code
18044 $max_received_linelength
18045 $body_linecount
18046 $body_zerocount
18047 .endd
18048
18049 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18050 and any external programs which are passed a reference to a message data file
18051 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18052 will need to be aware of the different formats potentially available.
18053
18054 Using any of the ACL conditions noted will negate the reception benefit
18055 (as a Unix-mbox-format file is constructed for them).
18056 The transmission benefit is maintained.
18057
18058 .option sqlite_lock_timeout main time 5s
18059 .cindex "sqlite lookup type" "lock timeout"
18060 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18061 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18062
18063 .option strict_acl_vars main boolean false
18064 .cindex "&ACL;" "variables, handling unset"
18065 This option controls what happens if a syntactically valid but undefined ACL
18066 variable is referenced. If it is false (the default), an empty string
18067 is substituted; if it is true, an error is generated. See section
18068 &<<SECTaclvariables>>& for details of ACL variables.
18069
18070 .option strip_excess_angle_brackets main boolean false
18071 .cindex "angle brackets, excess"
18072 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18073 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18074 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18075 passed on to another MTA, the excess angle brackets are not passed on. If this
18076 option is not set, multiple pairs of angle brackets cause a syntax error.
18077
18078
18079 .option strip_trailing_dot main boolean false
18080 .cindex "trailing dot on domain"
18081 .cindex "dot" "trailing on domain"
18082 If this option is set, a trailing dot at the end of a domain in an address is
18083 ignored. If this is in the envelope and the message is passed on to another
18084 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18085 domain causes a syntax error.
18086 However, addresses in header lines are checked only when an ACL requests header
18087 syntax checking.
18088
18089
18090 .option syslog_duplication main boolean true
18091 .cindex "syslog" "duplicate log lines; suppressing"
18092 When Exim is logging to syslog, it writes the log lines for its three
18093 separate logs at different syslog priorities so that they can in principle
18094 be separated on the logging hosts. Some installations do not require this
18095 separation, and in those cases, the duplication of certain log lines is a
18096 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18097 particular log line is written to syslog. For lines that normally go to
18098 both the main log and the reject log, the reject log version (possibly
18099 containing message header lines) is written, at LOG_NOTICE priority.
18100 Lines that normally go to both the main and the panic log are written at
18101 the LOG_ALERT priority.
18102
18103
18104 .option syslog_facility main string unset
18105 .cindex "syslog" "facility; setting"
18106 This option sets the syslog &"facility"& name, used when Exim is logging to
18107 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18108 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18109 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18110 details of Exim's logging.
18111
18112
18113 .option syslog_pid main boolean true
18114 .cindex "syslog" "pid"
18115 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18116 omitted when these lines are sent to syslog. (Syslog normally prefixes
18117 the log lines with the PID of the logging process automatically.) You need
18118 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18119 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18120
18121
18122
18123 .option syslog_processname main string &`exim`&
18124 .cindex "syslog" "process name; setting"
18125 This option sets the syslog &"ident"& name, used when Exim is logging to
18126 syslog. The value must be no longer than 32 characters. See chapter
18127 &<<CHAPlog>>& for details of Exim's logging.
18128
18129
18130
18131 .option syslog_timestamp main boolean true
18132 .cindex "syslog" "timestamps"
18133 .cindex timestamps syslog
18134 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18135 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18136 details of Exim's logging.
18137
18138
18139 .option system_filter main string&!! unset
18140 .cindex "filter" "system filter"
18141 .cindex "system filter" "specifying"
18142 .cindex "Sieve filter" "not available for system filter"
18143 This option specifies an Exim filter file that is applied to all messages at
18144 the start of each delivery attempt, before any routing is done. System filters
18145 must be Exim filters; they cannot be Sieve filters. If the system filter
18146 generates any deliveries to files or pipes, or any new mail messages, the
18147 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18148 which transports are to be used. Details of this facility are given in chapter
18149 &<<CHAPsystemfilter>>&.
18150 A forced expansion failure results in no filter operation.
18151
18152
18153 .option system_filter_directory_transport main string&!! unset
18154 .vindex "&$address_file$&"
18155 This sets the name of the transport driver that is to be used when the
18156 &%save%& command in a system message filter specifies a path ending in &"/"&,
18157 implying delivery of each message into a separate file in some directory.
18158 During the delivery, the variable &$address_file$& contains the path name.
18159
18160
18161 .option system_filter_file_transport main string&!! unset
18162 .cindex "file" "transport for system filter"
18163 This sets the name of the transport driver that is to be used when the &%save%&
18164 command in a system message filter specifies a path not ending in &"/"&. During
18165 the delivery, the variable &$address_file$& contains the path name.
18166
18167 .option system_filter_group main string unset
18168 .cindex "gid (group id)" "system filter"
18169 This option is used only when &%system_filter_user%& is also set. It sets the
18170 gid under which the system filter is run, overriding any gid that is associated
18171 with the user. The value may be numerical or symbolic.
18172
18173 .option system_filter_pipe_transport main string&!! unset
18174 .cindex "&(pipe)& transport" "for system filter"
18175 .vindex "&$address_pipe$&"
18176 This specifies the transport driver that is to be used when a &%pipe%& command
18177 is used in a system filter. During the delivery, the variable &$address_pipe$&
18178 contains the pipe command.
18179
18180
18181 .option system_filter_reply_transport main string&!! unset
18182 .cindex "&(autoreply)& transport" "for system filter"
18183 This specifies the transport driver that is to be used when a &%mail%& command
18184 is used in a system filter.
18185
18186
18187 .option system_filter_user main string unset
18188 .cindex "uid (user id)" "system filter"
18189 If this option is set to root, the system filter is run in the main Exim
18190 delivery process, as root.  Otherwise, the system filter runs in a separate
18191 process, as the given user, defaulting to the Exim run-time user.
18192 Unless the string consists entirely of digits, it
18193 is looked up in the password data. Failure to find the named user causes a
18194 configuration error. The gid is either taken from the password data, or
18195 specified by &%system_filter_group%&. When the uid is specified numerically,
18196 &%system_filter_group%& is required to be set.
18197
18198 If the system filter generates any pipe, file, or reply deliveries, the uid
18199 under which the filter is run is used when transporting them, unless a
18200 transport option overrides.
18201
18202
18203 .option tcp_nodelay main boolean true
18204 .cindex "daemon" "TCP_NODELAY on sockets"
18205 .cindex "Nagle algorithm"
18206 .cindex "TCP_NODELAY on listening sockets"
18207 If this option is set false, it stops the Exim daemon setting the
18208 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18209 turns off the &"Nagle algorithm"&, which is a way of improving network
18210 performance in interactive (character-by-character) situations. Turning it off
18211 should improve Exim's performance a bit, so that is what happens by default.
18212 However, it appears that some broken clients cannot cope, and time out. Hence
18213 this option. It affects only those sockets that are set up for listening by the
18214 daemon. Sockets created by the smtp transport for delivering mail always set
18215 TCP_NODELAY.
18216
18217
18218 .option timeout_frozen_after main time 0s
18219 .cindex "frozen messages" "timing out"
18220 .cindex "timeout" "frozen messages"
18221 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18222 message of any kind that has been in the queue for longer than the given time
18223 is automatically cancelled at the next queue run. If the frozen message is a
18224 bounce message, it is just discarded; otherwise, a bounce is sent to the
18225 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18226 If you want to timeout frozen bounce messages earlier than other kinds of
18227 frozen message, see &%ignore_bounce_errors_after%&.
18228
18229 &*Note:*& the default value of zero means no timeouts; with this setting,
18230 frozen messages remain in the queue forever (except for any frozen bounce
18231 messages that are released by &%ignore_bounce_errors_after%&).
18232
18233
18234 .option timezone main string unset
18235 .cindex "timezone, setting"
18236 .cindex "environment" "values from"
18237 The value of &%timezone%& is used to set the environment variable TZ while
18238 running Exim (if it is different on entry). This ensures that all timestamps
18239 created by Exim are in the required timezone. If you want all your timestamps
18240 to be in UTC (aka GMT) you should set
18241 .code
18242 timezone = UTC
18243 .endd
18244 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18245 or, if that is not set, from the value of the TZ environment variable when Exim
18246 is built. If &%timezone%& is set to the empty string, either at build or run
18247 time, any existing TZ variable is removed from the environment when Exim
18248 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18249 unfortunately not all, operating systems.
18250
18251
18252 .option tls_advertise_hosts main "host list&!!" *
18253 .cindex "TLS" "advertising"
18254 .cindex "encryption" "on SMTP connection"
18255 .cindex "SMTP" "encrypted connection"
18256 .cindex "ESMTP extensions" STARTTLS
18257 When Exim is built with support for TLS encrypted connections, the availability
18258 of the STARTTLS command to set up an encrypted session is advertised in
18259 response to EHLO only to those client hosts that match this option. See
18260 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18261 Note that the default value requires that a certificate be supplied
18262 using the &%tls_certificate%& option.  If TLS support for incoming connections
18263 is not required the &%tls_advertise_hosts%& option should be set empty.
18264
18265
18266 .option tls_certificate main string list&!! unset
18267 .cindex "TLS" "server certificate; location of"
18268 .cindex "certificate" "server, location of"
18269 The value of this option is expanded, and must then be a list of absolute paths to
18270 files which contain the server's certificates (in PEM format).
18271 Commonly only one file is needed.
18272 The server's private key is also
18273 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18274 &<<CHAPTLS>>& for further details.
18275
18276 &*Note*&: The certificates defined by this option are used only when Exim is
18277 receiving incoming messages as a server. If you want to supply certificates for
18278 use when sending messages as a client, you must set the &%tls_certificate%&
18279 option in the relevant &(smtp)& transport.
18280
18281 &*Note*&: If you use filenames based on IP addresses, change the list
18282 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18283
18284 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18285 when a list of more than one
18286 file is used, the &$tls_in_ourcert$& variable is unreliable.
18287 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18288
18289 .cindex SNI "selecting server certificate based on"
18290 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18291 if the OpenSSL build supports TLS extensions and the TLS client sends the
18292 Server Name Indication extension, then this option and others documented in
18293 &<<SECTtlssni>>& will be re-expanded.
18294
18295 If this option is unset or empty a fresh self-signed certificate will be
18296 generated for every connection.
18297
18298 .option tls_crl main string&!! unset
18299 .cindex "TLS" "server certificate revocation list"
18300 .cindex "certificate" "revocation list for server"
18301 This option specifies a certificate revocation list. The expanded value must
18302 be the name of a file that contains CRLs in PEM format.
18303
18304 Under OpenSSL the option can specify a directory with CRL files.
18305
18306 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18307 for each signing element of the certificate chain (i.e. all but the leaf).
18308 For the file variant this can be multiple PEM blocks in the one file.
18309
18310 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18311
18312
18313 .option tls_dh_max_bits main integer 2236
18314 .cindex "TLS" "D-H bit count"
18315 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18316 the chosen TLS library.  That value might prove to be too high for
18317 interoperability.  This option provides a maximum clamp on the value
18318 suggested, trading off security for interoperability.
18319
18320 The value must be at least 1024.
18321
18322 The value 2236 was chosen because, at time of adding the option, it was the
18323 hard-coded maximum value supported by the NSS cryptographic library, as used
18324 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18325
18326 If you prefer more security and are willing to break some clients, raise this
18327 number.
18328
18329 Note that the value passed to GnuTLS for *generating* a new prime may be a
18330 little less than this figure, because GnuTLS is inexact and may produce a
18331 larger prime than requested.
18332
18333
18334 .option tls_dhparam main string&!! unset
18335 .cindex "TLS" "D-H parameters for server"
18336 The value of this option is expanded and indicates the source of DH parameters
18337 to be used by Exim.
18338
18339 This option is ignored for GnuTLS version 3.6.0 and later.
18340 The library manages parameter negotiation internally.
18341
18342 &*Note: The Exim Maintainers strongly recommend,
18343 for other TLS library versions,
18344 using a filename with site-generated
18345 local DH parameters*&, which has been supported across all versions of Exim.  The
18346 other specific constants available are a fallback so that even when
18347 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18348
18349 If &%tls_dhparam%& is a filename starting with a &`/`&,
18350 then it names a file from which DH
18351 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18352 PKCS#3 representation of the DH prime.  If the file does not exist, for
18353 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18354 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18355 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18356 and treated as though the &%tls_dhparam%& were set to "none".
18357
18358 If this option expands to the string "none", then no DH parameters will be
18359 loaded by Exim.
18360
18361 If this option expands to the string "historic" and Exim is using GnuTLS, then
18362 Exim will attempt to load a file from inside the spool directory.  If the file
18363 does not exist, Exim will attempt to create it.
18364 See section &<<SECTgnutlsparam>>& for further details.
18365
18366 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18367 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18368
18369 In older versions of Exim the default was the 2048 bit prime described in section
18370 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18371 in IKE is assigned number 23.
18372
18373 Otherwise, the option must expand to the name used by Exim for any of a number
18374 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18375 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18376 the number used by IKE, or "default" which corresponds to
18377 &`exim.dev.20160529.3`&.
18378
18379 The available standard primes are:
18380 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18381 &`ike1`&, &`ike2`&, &`ike5`&,
18382 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18383 &`ike22`&, &`ike23`& and &`ike24`&.
18384
18385 The available additional primes are:
18386 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18387
18388 Some of these will be too small to be accepted by clients.
18389 Some may be too large to be accepted by clients.
18390 The open cryptographic community has suspicions about the integrity of some
18391 of the later IKE values, which led into RFC7919 providing new fixed constants
18392 (the "ffdhe" identifiers).
18393
18394 At this point, all of the "ike" values should be considered obsolete;
18395 they're still in Exim to avoid breaking unusual configurations, but are
18396 candidates for removal the next time we have backwards-incompatible changes.
18397
18398 The TLS protocol does not negotiate an acceptable size for this; clients tend
18399 to hard-drop connections if what is offered by the server is unacceptable,
18400 whether too large or too small, and there's no provision for the client to
18401 tell the server what these constraints are.  Thus, as a server operator, you
18402 need to make an educated guess as to what is most likely to work for your
18403 userbase.
18404
18405 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18406 is most likely to maximise interoperability.  The upper bound comes from
18407 applications using the Mozilla Network Security Services (NSS) library, which
18408 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18409 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18410 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18411 acceptable bound from 1024 to 2048.
18412
18413
18414 .option tls_eccurve main string&!! &`auto`&
18415 .cindex TLS "EC cryptography"
18416 This option selects a EC curve for use by Exim when used with OpenSSL.
18417 It has no effect when Exim is used with GnuTLS.
18418
18419 After expansion it must contain a valid EC curve parameter, such as
18420 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18421 for valid selections.
18422
18423 For OpenSSL versions before (and not including) 1.0.2, the string
18424 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18425 &`auto`& tells the library to choose.
18426
18427 If the option expands to an empty string, no EC curves will be enabled.
18428
18429
18430 .option tls_ocsp_file main string&!! unset
18431 .cindex TLS "certificate status"
18432 .cindex TLS "OCSP proof file"
18433 This option
18434 must if set expand to the absolute path to a file which contains a current
18435 status proof for the server's certificate, as obtained from the
18436 Certificate Authority.
18437
18438 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18439 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18440
18441 For OpenSSL 1.1.0 or later, and
18442 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18443 of files, to match a list given for the &%tls_certificate%& option.
18444 The ordering of the two lists must match.
18445 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18446
18447 The file(s) should be in DER format,
18448 except for GnuTLS 3.6.3 or later
18449 or for OpenSSL,
18450 when an optional filetype prefix can be used.
18451 The prefix must be one of "DER" or "PEM", followed by
18452 a single space.  If one is used it sets the format for subsequent
18453 files in the list; the initial format is DER.
18454 If multiple proofs are wanted, for multiple chain elements
18455 (this only works under TLS1.3)
18456 they must be coded as a combined OCSP response.
18457
18458 Although GnuTLS will accept PEM files with multiple separate
18459 PEM blobs (ie. separate OCSP responses), it sends them in the
18460 TLS Certificate record interleaved with the certificates of the chain;
18461 although a GnuTLS client is happy with that, an OpenSSL client is not.
18462
18463 .option tls_on_connect_ports main "string list" unset
18464 .cindex SSMTP
18465 .cindex SMTPS
18466 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18467 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18468 set up without waiting for the client to issue a STARTTLS command. For
18469 further details, see section &<<SECTsupobssmt>>&.
18470
18471
18472
18473 .option tls_privatekey main string list&!! unset
18474 .cindex "TLS" "server private key; location of"
18475 The value of this option is expanded, and must then be a list of absolute paths to
18476 files which contains the server's private keys.
18477 If this option is unset, or if
18478 the expansion is forced to fail, or the result is an empty string, the private
18479 key is assumed to be in the same file as the server's certificates. See chapter
18480 &<<CHAPTLS>>& for further details.
18481
18482 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18483
18484
18485 .option tls_remember_esmtp main boolean false
18486 .cindex "TLS" "esmtp state; remembering"
18487 .cindex "TLS" "broken clients"
18488 If this option is set true, Exim violates the RFCs by remembering that it is in
18489 &"esmtp"& state after successfully negotiating a TLS session. This provides
18490 support for broken clients that fail to send a new EHLO after starting a
18491 TLS session.
18492
18493
18494 .option tls_require_ciphers main string&!! unset
18495 .cindex "TLS" "requiring specific ciphers"
18496 .cindex "cipher" "requiring specific"
18497 This option controls which ciphers can be used for incoming TLS connections.
18498 The &(smtp)& transport has an option of the same name for controlling outgoing
18499 connections. This option is expanded for each connection, so can be varied for
18500 different clients if required. The value of this option must be a list of
18501 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18502 in somewhat different ways. If GnuTLS is being used, the client controls the
18503 preference order of the available ciphers. Details are given in sections
18504 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18505
18506
18507 .new
18508 .option tls_resumption_hosts main "host list&!!" unset
18509 .cindex TLS resumption
18510 This option controls which connections to offer the TLS resumption feature.
18511 See &<<SECTresumption>>& for details.
18512 .wen
18513
18514
18515 .option tls_try_verify_hosts main "host list&!!" unset
18516 .cindex "TLS" "client certificate verification"
18517 .cindex "certificate" "verification of client"
18518 See &%tls_verify_hosts%& below.
18519
18520
18521 .option tls_verify_certificates main string&!! system
18522 .cindex "TLS" "client certificate verification"
18523 .cindex "certificate" "verification of client"
18524 The value of this option is expanded, and must then be either the
18525 word "system"
18526 or the absolute path to
18527 a file or directory containing permitted certificates for clients that
18528 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18529
18530 The "system" value for the option will use a
18531 system default location compiled into the SSL library.
18532 This is not available for GnuTLS versions preceding 3.0.20,
18533 and will be taken as empty; an explicit location
18534 must be specified.
18535
18536 The use of a directory for the option value is not available for GnuTLS versions
18537 preceding 3.3.6 and a single file must be used.
18538
18539 With OpenSSL the certificates specified
18540 explicitly
18541 either by file or directory
18542 are added to those given by the system default location.
18543
18544 These certificates should be for the certificate authorities trusted, rather
18545 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18546 the value is a file then the certificates are sent by Exim as a server to
18547 connecting clients, defining the list of accepted certificate authorities.
18548 Thus the values defined should be considered public data.  To avoid this,
18549 use the explicit directory version. (If your peer is Exim up to 4.85,
18550 using GnuTLS, you may need to send the CAs (thus using the file
18551 variant). Otherwise the peer doesn't send its certificate.)
18552
18553 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18554
18555 A forced expansion failure or setting to an empty string is equivalent to
18556 being unset.
18557
18558
18559 .option tls_verify_hosts main "host list&!!" unset
18560 .cindex "TLS" "client certificate verification"
18561 .cindex "certificate" "verification of client"
18562 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18563 certificates from clients. The expected certificates are defined by
18564 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18565 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18566 &%tls_verify_certificates%& is not set.
18567
18568 Any client that matches &%tls_verify_hosts%& is constrained by
18569 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18570 present one of the listed certificates. If it does not, the connection is
18571 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18572 the host to use TLS. It can still send SMTP commands through unencrypted
18573 connections. Forcing a client to use TLS has to be done separately using an
18574 ACL to reject inappropriate commands when the connection is not encrypted.
18575
18576 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18577 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18578 certificate and checks it against &%tls_verify_certificates%&, but does not
18579 abort the connection if there is no certificate or if it does not match. This
18580 state can be detected in an ACL, which makes it possible to implement policies
18581 such as &"accept for relay only if a verified certificate has been received,
18582 but accept for local delivery if encrypted, even without a verified
18583 certificate"&.
18584
18585 Client hosts that match neither of these lists are not asked to present
18586 certificates.
18587
18588
18589 .option trusted_groups main "string list&!!" unset
18590 .cindex "trusted groups"
18591 .cindex "groups" "trusted"
18592 This option is expanded just once, at the start of Exim's processing. If this
18593 option is set, any process that is running in one of the listed groups, or
18594 which has one of them as a supplementary group, is trusted. The groups can be
18595 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18596 details of what trusted callers are permitted to do. If neither
18597 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18598 are trusted.
18599
18600 .option trusted_users main "string list&!!" unset
18601 .cindex "trusted users"
18602 .cindex "user" "trusted"
18603 This option is expanded just once, at the start of Exim's processing. If this
18604 option is set, any process that is running as one of the listed users is
18605 trusted. The users can be specified numerically or by name. See section
18606 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18607 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18608 Exim user are trusted.
18609
18610 .option unknown_login main string&!! unset
18611 .cindex "uid (user id)" "unknown caller"
18612 .vindex "&$caller_uid$&"
18613 This is a specialized feature for use in unusual configurations. By default, if
18614 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18615 gives up. The &%unknown_login%& option can be used to set a login name to be
18616 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18617 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18618 is used for the user's real name (gecos field), unless this has been set by the
18619 &%-F%& option.
18620
18621 .option unknown_username main string unset
18622 See &%unknown_login%&.
18623
18624 .option untrusted_set_sender main "address list&!!" unset
18625 .cindex "trusted users"
18626 .cindex "sender" "setting by untrusted user"
18627 .cindex "untrusted user setting sender"
18628 .cindex "user" "untrusted setting sender"
18629 .cindex "envelope from"
18630 .cindex "envelope sender"
18631 When an untrusted user submits a message to Exim using the standard input, Exim
18632 normally creates an envelope sender address from the user's login and the
18633 default qualification domain. Data from the &%-f%& option (for setting envelope
18634 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18635 is used) is ignored.
18636
18637 However, untrusted users are permitted to set an empty envelope sender address,
18638 to declare that a message should never generate any bounces. For example:
18639 .code
18640 exim -f '<>' user@domain.example
18641 .endd
18642 .vindex "&$sender_ident$&"
18643 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18644 other envelope sender addresses in a controlled way. When it is set, untrusted
18645 users are allowed to set envelope sender addresses that match any of the
18646 patterns in the list. Like all address lists, the string is expanded. The
18647 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18648 users to setting senders that start with their login ids
18649 followed by a hyphen
18650 by a setting like this:
18651 .code
18652 untrusted_set_sender = ^$sender_ident-
18653 .endd
18654 If you want to allow untrusted users to set envelope sender addresses without
18655 restriction, you can use
18656 .code
18657 untrusted_set_sender = *
18658 .endd
18659 The &%untrusted_set_sender%& option applies to all forms of local input, but
18660 only to the setting of the envelope sender. It does not permit untrusted users
18661 to use the other options which trusted user can use to override message
18662 parameters. Furthermore, it does not stop Exim from removing an existing
18663 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18664 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18665 overriding these actions. The handling of the &'Sender:'& header is also
18666 described in section &<<SECTthesenhea>>&.
18667
18668 The log line for a message's arrival shows the envelope sender following
18669 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18670 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18671 envelope sender address, the user's login is shown in parentheses after the
18672 sender address.
18673
18674
18675 .option uucp_from_pattern main string "see below"
18676 .cindex "&""From""& line"
18677 .cindex "UUCP" "&""From""& line"
18678 Some applications that pass messages to an MTA via a command line interface use
18679 an initial line starting with &"From&~"& to pass the envelope sender. In
18680 particular, this is used by UUCP software. Exim recognizes such a line by means
18681 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18682 matches, the sender address is constructed by expanding the contents of
18683 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18684 default pattern recognizes lines in the following two forms:
18685 .code
18686 From ph10 Fri Jan  5 12:35 GMT 1996
18687 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18688 .endd
18689 The pattern can be seen by running
18690 .code
18691 exim -bP uucp_from_pattern
18692 .endd
18693 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18694 year in the second case. The first word after &"From&~"& is matched in the
18695 regular expression by a parenthesized subpattern. The default value for
18696 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18697 (&"ph10"& in the example above) as the message's sender. See also
18698 &%ignore_fromline_hosts%&.
18699
18700
18701 .option uucp_from_sender main string&!! &`$1`&
18702 See &%uucp_from_pattern%& above.
18703
18704
18705 .option warn_message_file main string&!! unset
18706 .cindex "warning of delay" "customizing the message"
18707 .cindex "customizing" "warning message"
18708 This option defines a template file containing paragraphs of text to be used
18709 for constructing the warning message which is sent by Exim when a message has
18710 been in the queue for a specified amount of time, as specified by
18711 &%delay_warning%&. Details of the file's contents are given in chapter
18712 &<<CHAPemsgcust>>&.
18713 .cindex warn_message_file "tainted data"
18714 The option is expanded to give the file path, which must be
18715 absolute and untainted.
18716 See also &%bounce_message_file%&.
18717
18718
18719 .option write_rejectlog main boolean true
18720 .cindex "reject log" "disabling"
18721 If this option is set false, Exim no longer writes anything to the reject log.
18722 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18723 .ecindex IIDconfima
18724 .ecindex IIDmaiconf
18725
18726
18727
18728
18729 . ////////////////////////////////////////////////////////////////////////////
18730 . ////////////////////////////////////////////////////////////////////////////
18731
18732 .chapter "Generic options for routers" "CHAProutergeneric"
18733 .scindex IIDgenoprou1 "options" "generic; for routers"
18734 .scindex IIDgenoprou2 "generic options" "router"
18735 This chapter describes the generic options that apply to all routers.
18736 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18737
18738 For a general description of how a router operates, see sections
18739 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18740 which the preconditions are tested. The order of expansion of the options that
18741 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18742 &%headers_remove%&, &%transport%&.
18743
18744
18745
18746 .option address_data routers string&!! unset
18747 .cindex "router" "data attached to address"
18748 The string is expanded just before the router is run, that is, after all the
18749 precondition tests have succeeded. If the expansion is forced to fail, the
18750 router declines, the value of &%address_data%& remains unchanged, and the
18751 &%more%& option controls what happens next. Other expansion failures cause
18752 delivery of the address to be deferred.
18753
18754 .vindex "&$address_data$&"
18755 When the expansion succeeds, the value is retained with the address, and can be
18756 accessed using the variable &$address_data$& in the current router, subsequent
18757 routers, and the eventual transport.
18758
18759 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18760 that runs a user's filter file, the contents of &$address_data$& are accessible
18761 in the filter. This is not normally a problem, because such data is usually
18762 either not confidential or it &"belongs"& to the current user, but if you do
18763 put confidential data into &$address_data$& you need to remember this point.
18764
18765 Even if the router declines or passes, the value of &$address_data$& remains
18766 with the address, though it can be changed by another &%address_data%& setting
18767 on a subsequent router. If a router generates child addresses, the value of
18768 &$address_data$& propagates to them. This also applies to the special kind of
18769 &"child"& that is generated by a router with the &%unseen%& option.
18770
18771 The idea of &%address_data%& is that you can use it to look up a lot of data
18772 for the address once, and then pick out parts of the data later. For example,
18773 you could use a single LDAP lookup to return a string of the form
18774 .code
18775 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18776 .endd
18777 In the transport you could pick out the mailbox by a setting such as
18778 .code
18779 file = ${extract{mailbox}{$address_data}}
18780 .endd
18781 This makes the configuration file less messy, and also reduces the number of
18782 lookups (though Exim does cache lookups).
18783
18784 See also the &%set%& option below.
18785
18786 .vindex "&$sender_address_data$&"
18787 .vindex "&$address_data$&"
18788 The &%address_data%& facility is also useful as a means of passing information
18789 from one router to another, and from a router to a transport. In addition, if
18790 &$address_data$& is set by a router when verifying a recipient address from an
18791 ACL, it remains available for use in the rest of the ACL statement. After
18792 verifying a sender, the value is transferred to &$sender_address_data$&.
18793
18794
18795
18796 .option address_test routers&!? boolean true
18797 .oindex "&%-bt%&"
18798 .cindex "router" "skipping when address testing"
18799 If this option is set false, the router is skipped when routing is being tested
18800 by means of the &%-bt%& command line option. This can be a convenience when
18801 your first router sends messages to an external scanner, because it saves you
18802 having to set the &"already scanned"& indicator when testing real address
18803 routing.
18804
18805
18806
18807 .option cannot_route_message routers string&!! unset
18808 .cindex "router" "customizing &""cannot route""& message"
18809 .cindex "customizing" "&""cannot route""& message"
18810 This option specifies a text message that is used when an address cannot be
18811 routed because Exim has run out of routers. The default message is
18812 &"Unrouteable address"&. This option is useful only on routers that have
18813 &%more%& set false, or on the very last router in a configuration, because the
18814 value that is used is taken from the last router that is considered. This
18815 includes a router that is skipped because its preconditions are not met, as
18816 well as a router that declines. For example, using the default configuration,
18817 you could put:
18818 .code
18819 cannot_route_message = Remote domain not found in DNS
18820 .endd
18821 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18822 and
18823 .code
18824 cannot_route_message = Unknown local user
18825 .endd
18826 on the final router that checks for local users. If string expansion fails for
18827 this option, the default message is used. Unless the expansion failure was
18828 explicitly forced, a message about the failure is written to the main and panic
18829 logs, in addition to the normal message about the routing failure.
18830
18831
18832 .option caseful_local_part routers boolean false
18833 .cindex "case of local parts"
18834 .cindex "router" "case of local parts"
18835 By default, routers handle the local parts of addresses in a case-insensitive
18836 manner, though the actual case is preserved for transmission with the message.
18837 If you want the case of letters to be significant in a router, you must set
18838 this option true. For individual router options that contain address or local
18839 part lists (for example, &%local_parts%&), case-sensitive matching can be
18840 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18841 more details.
18842
18843 .vindex "&$local_part$&"
18844 .vindex "&$original_local_part$&"
18845 .vindex "&$parent_local_part$&"
18846 The value of the &$local_part$& variable is forced to lower case while a
18847 router is running unless &%caseful_local_part%& is set. When a router assigns
18848 an address to a transport, the value of &$local_part$& when the transport runs
18849 is the same as it was in the router. Similarly, when a router generates child
18850 addresses by aliasing or forwarding, the values of &$original_local_part$&
18851 and &$parent_local_part$& are those that were used by the redirecting router.
18852
18853 This option applies to the processing of an address by a router. When a
18854 recipient address is being processed in an ACL, there is a separate &%control%&
18855 modifier that can be used to specify case-sensitive processing within the ACL
18856 (see section &<<SECTcontrols>>&).
18857
18858
18859
18860 .option check_local_user routers&!? boolean false
18861 .cindex "local user, checking in router"
18862 .cindex "router" "checking for local user"
18863 .cindex "&_/etc/passwd_&"
18864 .vindex "&$home$&"
18865 When this option is true, Exim checks that the local part of the recipient
18866 address (with affixes removed if relevant) is the name of an account on the
18867 local system. The check is done by calling the &[getpwnam()]& function rather
18868 than trying to read &_/etc/passwd_& directly. This means that other methods of
18869 holding password data (such as NIS) are supported. If the local part is a local
18870 user,
18871 .cindex "tainted data" "de-tainting"
18872 &$local_part_data$& is set to an untainted version of the local part and
18873 &$home$& is set from the password data. The latter can be tested in other
18874 preconditions that are evaluated after this one (the order of evaluation is
18875 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18876 overridden by &%router_home_directory%&. If the local part is not a local user,
18877 the router is skipped.
18878
18879 If you want to check that the local part is either the name of a local user
18880 or matches something else, you cannot combine &%check_local_user%& with a
18881 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18882 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18883 setting to achieve this. For example:
18884 .code
18885 local_parts = passwd;$local_part : lsearch;/etc/other/users
18886 .endd
18887 Note, however, that the side effects of &%check_local_user%& (such as setting
18888 up a home directory) do not occur when a &(passwd)& lookup is used in a
18889 &%local_parts%& (or any other) precondition.
18890
18891
18892
18893 .option condition routers&!? string&!! unset
18894 .cindex "router" "customized precondition"
18895 This option specifies a general precondition test that has to succeed for the
18896 router to be called. The &%condition%& option is the last precondition to be
18897 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18898 result is a forced failure, or an empty string, or one of the strings &"0"& or
18899 &"no"& or &"false"& (checked without regard to the case of the letters), the
18900 router is skipped, and the address is offered to the next one.
18901
18902 If the result is any other value, the router is run (as this is the last
18903 precondition to be evaluated, all the other preconditions must be true).
18904
18905 This option is unusual in that multiple &%condition%& options may be present.
18906 All &%condition%& options must succeed.
18907
18908 The &%condition%& option provides a means of applying custom conditions to the
18909 running of routers. Note that in the case of a simple conditional expansion,
18910 the default expansion values are exactly what is wanted. For example:
18911 .code
18912 condition = ${if >{$message_age}{600}}
18913 .endd
18914 Because of the default behaviour of the string expansion, this is equivalent to
18915 .code
18916 condition = ${if >{$message_age}{600}{true}{}}
18917 .endd
18918
18919 A multiple condition example, which succeeds:
18920 .code
18921 condition = ${if >{$message_age}{600}}
18922 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18923 condition = foobar
18924 .endd
18925
18926 If the expansion fails (other than forced failure) delivery is deferred. Some
18927 of the other precondition options are common special cases that could in fact
18928 be specified using &%condition%&.
18929
18930 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18931 are far older, and use one set of semantics.  ACLs are newer and when
18932 they were created, the ACL &%condition%& process was given far stricter
18933 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18934 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18935 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18936 Router rules processing behavior.
18937
18938 This is best illustrated in an example:
18939 .code
18940 # If used in an ACL condition will fail with a syntax error, but
18941 # in a router condition any extra characters are treated as a string
18942
18943 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18944 true {yes} {no}}
18945
18946 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18947  {yes} {no}}
18948 .endd
18949 In each example above, the &%if%& statement actually ends after
18950 &"{google.com}}"&.  Since no true or false braces were defined, the
18951 default &%if%& behavior is to return a boolean true or a null answer
18952 (which evaluates to false). The rest of the line is then treated as a
18953 string. So the first example resulted in the boolean answer &"true"&
18954 with the string &" {yes} {no}}"& appended to it. The second example
18955 resulted in the null output (indicating false) with the string
18956 &" {yes} {no}}"& appended to it.
18957
18958 In fact you can put excess forward braces in too.  In the router
18959 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18960 mean something, like after a &"$"& or when required as part of a
18961 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18962 string characters.
18963
18964 Thus, in a Router, the above expansion strings will both always evaluate
18965 true, as the result of expansion is a non-empty string which doesn't
18966 match an explicit false value.  This can be tricky to debug.  By
18967 contrast, in an ACL either of those strings will always result in an
18968 expansion error because the result doesn't look sufficiently boolean.
18969
18970
18971 .option debug_print routers string&!! unset
18972 .cindex "testing" "variables in drivers"
18973 If this option is set and debugging is enabled (see the &%-d%& command line
18974 option) or in address-testing mode (see the &%-bt%& command line option),
18975 the string is expanded and included in the debugging output.
18976 If expansion of the string fails, the error message is written to the debugging
18977 output, and Exim carries on processing.
18978 This option is provided to help with checking out the values of variables and
18979 so on when debugging router configurations. For example, if a &%condition%&
18980 option appears not to be working, &%debug_print%& can be used to output the
18981 variables it references. The output happens after checks for &%domains%&,
18982 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18983 are tested. A newline is added to the text if it does not end with one.
18984 The variable &$router_name$& contains the name of the router.
18985
18986
18987
18988 .option disable_logging routers boolean false
18989 If this option is set true, nothing is logged for any routing errors
18990 or for any deliveries caused by this router. You should not set this option
18991 unless you really, really know what you are doing. See also the generic
18992 transport option of the same name.
18993
18994 .option dnssec_request_domains routers "domain list&!!" *
18995 .cindex "MX record" "security"
18996 .cindex "DNSSEC" "MX lookup"
18997 .cindex "security" "MX lookup"
18998 .cindex "DNS" "DNSSEC"
18999 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19000 the dnssec request bit set.
19001 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19002
19003 .option dnssec_require_domains routers "domain list&!!" unset
19004 .cindex "MX record" "security"
19005 .cindex "DNSSEC" "MX lookup"
19006 .cindex "security" "MX lookup"
19007 .cindex "DNS" "DNSSEC"
19008 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19009 the dnssec request bit set.  Any returns not having the Authenticated Data bit
19010 (AD bit) set will be ignored and logged as a host-lookup failure.
19011 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19012
19013
19014 .option domains routers&!? "domain list&!!" unset
19015 .cindex "router" "restricting to specific domains"
19016 .vindex "&$domain_data$&"
19017 If this option is set, the router is skipped unless the current domain matches
19018 the list. If the match is achieved by means of a file lookup, the data that the
19019 lookup returned for the domain is placed in &$domain_data$& for use in string
19020 expansions of the driver's private options and in the transport.
19021 See section &<<SECTrouprecon>>& for
19022 a list of the order in which preconditions are evaluated.
19023
19024
19025
19026 .option driver routers string unset
19027 This option must always be set. It specifies which of the available routers is
19028 to be used.
19029
19030
19031 .option dsn_lasthop routers boolean false
19032 .cindex "DSN" "success"
19033 .cindex "Delivery Status Notification" "success"
19034 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19035 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19036 instead send a success DSN as if the next hop does not support DSN.
19037 Not effective on redirect routers.
19038
19039
19040
19041 .option errors_to routers string&!! unset
19042 .cindex "envelope from"
19043 .cindex "envelope sender"
19044 .cindex "router" "changing address for errors"
19045 If a router successfully handles an address, it may assign the address to a
19046 transport for delivery or it may generate child addresses. In both cases, if
19047 there is a delivery problem during later processing, the resulting bounce
19048 message is sent to the address that results from expanding this string,
19049 provided that the address verifies successfully. The &%errors_to%& option is
19050 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19051
19052 The &%errors_to%& setting associated with an address can be overridden if it
19053 subsequently passes through other routers that have their own &%errors_to%&
19054 settings, or if the message is delivered by a transport with a &%return_path%&
19055 setting.
19056
19057 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19058 the expansion fails to verify, the errors address associated with the incoming
19059 address is used. At top level, this is the envelope sender. A non-forced
19060 expansion failure causes delivery to be deferred.
19061
19062 If an address for which &%errors_to%& has been set ends up being delivered over
19063 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19064 any bounces that are generated by other MTAs on the delivery route are also
19065 sent there. You can set &%errors_to%& to the empty string by either of these
19066 settings:
19067 .code
19068 errors_to =
19069 errors_to = ""
19070 .endd
19071 An expansion item that yields an empty string has the same effect. If you do
19072 this, a locally detected delivery error for addresses processed by this router
19073 no longer gives rise to a bounce message; the error is discarded. If the
19074 address is delivered to a remote host, the return path is set to &`<>`&, unless
19075 overridden by the &%return_path%& option on the transport.
19076
19077 .vindex "&$address_data$&"
19078 If for some reason you want to discard local errors, but use a non-empty
19079 MAIL command for remote delivery, you can preserve the original return
19080 path in &$address_data$& in the router, and reinstate it in the transport by
19081 setting &%return_path%&.
19082
19083 The most common use of &%errors_to%& is to direct mailing list bounces to the
19084 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19085 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19086
19087
19088
19089 .option expn routers&!? boolean true
19090 .cindex "address" "testing"
19091 .cindex "testing" "addresses"
19092 .cindex "EXPN" "router skipping"
19093 .cindex "router" "skipping for EXPN"
19094 If this option is turned off, the router is skipped when testing an address
19095 as a result of processing an SMTP EXPN command. You might, for example,
19096 want to turn it off on a router for users' &_.forward_& files, while leaving it
19097 on for the system alias file.
19098 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19099 are evaluated.
19100
19101 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19102 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19103 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19104
19105
19106
19107 .option fail_verify routers boolean false
19108 .cindex "router" "forcing verification failure"
19109 Setting this option has the effect of setting both &%fail_verify_sender%& and
19110 &%fail_verify_recipient%& to the same value.
19111
19112
19113
19114 .option fail_verify_recipient routers boolean false
19115 If this option is true and an address is accepted by this router when
19116 verifying a recipient, verification fails.
19117
19118
19119
19120 .option fail_verify_sender routers boolean false
19121 If this option is true and an address is accepted by this router when
19122 verifying a sender, verification fails.
19123
19124
19125
19126 .option fallback_hosts routers "string list" unset
19127 .cindex "router" "fallback hosts"
19128 .cindex "fallback" "hosts specified on router"
19129 String expansion is not applied to this option. The argument must be a
19130 colon-separated list of host names or IP addresses. The list separator can be
19131 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19132 each name or address. In fact, the format of each item is exactly the same as
19133 defined for the list of hosts in a &(manualroute)& router (see section
19134 &<<SECTformatonehostitem>>&).
19135
19136 If a router queues an address for a remote transport, this host list is
19137 associated with the address, and used instead of the transport's fallback host
19138 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19139 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19140 transport for further details.
19141
19142
19143 .option group routers string&!! "see below"
19144 .cindex "gid (group id)" "local delivery"
19145 .cindex "local transports" "uid and gid"
19146 .cindex "transport" "local"
19147 .cindex "router" "setting group"
19148 When a router queues an address for a transport, and the transport does not
19149 specify a group, the group given here is used when running the delivery
19150 process.
19151 The group may be specified numerically or by name. If expansion fails, the
19152 error is logged and delivery is deferred.
19153 The default is unset, unless &%check_local_user%& is set, when the default
19154 is taken from the password information. See also &%initgroups%& and &%user%&
19155 and the discussion in chapter &<<CHAPenvironment>>&.
19156
19157
19158
19159 .option headers_add routers list&!! unset
19160 .cindex "header lines" "adding"
19161 .cindex "router" "adding header lines"
19162 This option specifies a list of text headers,
19163 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19164 that is associated with any addresses that are accepted by the router.
19165 Each item is separately expanded, at routing time.  However, this
19166 option has no effect when an address is just being verified. The way in which
19167 the text is used to add header lines at transport time is described in section
19168 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19169 message is in the process of being transported. This means that references to
19170 header lines in string expansions in the transport's configuration do not
19171 &"see"& the added header lines.
19172
19173 The &%headers_add%& option is expanded after &%errors_to%&, but before
19174 &%headers_remove%& and &%transport%&. If an item is empty, or if
19175 an item expansion is forced to fail, the item has no effect. Other expansion
19176 failures are treated as configuration errors.
19177
19178 Unlike most options, &%headers_add%& can be specified multiple times
19179 for a router; all listed headers are added.
19180
19181 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19182 router that has the &%one_time%& option set.
19183
19184 .cindex "duplicate addresses"
19185 .oindex "&%unseen%&"
19186 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19187 additions are deleted when the address is passed on to subsequent routers.
19188 For a &%redirect%& router, if a generated address is the same as the incoming
19189 address, this can lead to duplicate addresses with different header
19190 modifications. Exim does not do duplicate deliveries (except, in certain
19191 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19192 which of the duplicates is discarded, so this ambiguous situation should be
19193 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19194
19195
19196
19197 .option headers_remove routers list&!! unset
19198 .cindex "header lines" "removing"
19199 .cindex "router" "removing header lines"
19200 This option specifies a list of text headers,
19201 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19202 that is associated with any addresses that are accepted by the router.
19203 However, the option has no effect when an address is just being verified.
19204 Each list item is separately expanded, at transport time.
19205 If an item ends in *, it will match any header with the given prefix.
19206 The way in which
19207 the text is used to remove header lines at transport time is described in
19208 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19209 the message is in the process of being transported. This means that references
19210 to header lines in string expansions in the transport's configuration still
19211 &"see"& the original header lines.
19212
19213 The &%headers_remove%& option is handled after &%errors_to%& and
19214 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19215 the item has no effect. Other expansion failures are treated as configuration
19216 errors.
19217
19218 Unlike most options, &%headers_remove%& can be specified multiple times
19219 for a router; all listed headers are removed.
19220
19221 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19222 router that has the &%one_time%& option set.
19223
19224 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19225 removal requests are deleted when the address is passed on to subsequent
19226 routers, and this can lead to problems with duplicates -- see the similar
19227 warning for &%headers_add%& above.
19228
19229 &*Warning 3*&: Because of the separate expansion of the list items,
19230 items that contain a list separator must have it doubled.
19231 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19232
19233
19234
19235 .option ignore_target_hosts routers "host list&!!" unset
19236 .cindex "IP address" "discarding"
19237 .cindex "router" "discarding IP addresses"
19238 Although this option is a host list, it should normally contain IP address
19239 entries rather than names. If any host that is looked up by the router has an
19240 IP address that matches an item in this list, Exim behaves as if that IP
19241 address did not exist. This option allows you to cope with rogue DNS entries
19242 like
19243 .code
19244 remote.domain.example.  A  127.0.0.1
19245 .endd
19246 by setting
19247 .code
19248 ignore_target_hosts = 127.0.0.1
19249 .endd
19250 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19251 discarded in this way, the router declines. In a conventional configuration, an
19252 attempt to mail to such a domain would normally provoke the &"unrouteable
19253 domain"& error, and an attempt to verify an address in the domain would fail.
19254 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19255 router declines if presented with one of the listed addresses.
19256
19257 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19258 means of the first or the second of the following settings, respectively:
19259 .code
19260 ignore_target_hosts = 0.0.0.0/0
19261 ignore_target_hosts = <; 0::0/0
19262 .endd
19263 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19264 in the second line matches all IPv6 addresses.
19265
19266 This option may also be useful for ignoring link-local and site-local IPv6
19267 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19268 is expanded before use as a list, it is possible to make it dependent on the
19269 domain that is being routed.
19270
19271 .vindex "&$host_address$&"
19272 During its expansion, &$host_address$& is set to the IP address that is being
19273 checked.
19274
19275 .option initgroups routers boolean false
19276 .cindex "additional groups"
19277 .cindex "groups" "additional"
19278 .cindex "local transports" "uid and gid"
19279 .cindex "transport" "local"
19280 If the router queues an address for a transport, and this option is true, and
19281 the uid supplied by the router is not overridden by the transport, the
19282 &[initgroups()]& function is called when running the transport to ensure that
19283 any additional groups associated with the uid are set up. See also &%group%&
19284 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19285
19286
19287
19288 .option local_part_prefix routers&!? "string list" unset
19289 .cindex affix "router precondition"
19290 .cindex "router" "prefix for local part"
19291 .cindex "prefix" "for local part, used in router"
19292 If this option is set, the router is skipped unless the local part starts with
19293 one of the given strings, or &%local_part_prefix_optional%& is true. See
19294 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19295 evaluated.
19296
19297 The list is scanned from left to right, and the first prefix that matches is
19298 used. A limited form of wildcard is available; if the prefix begins with an
19299 asterisk, it matches the longest possible sequence of arbitrary characters at
19300 the start of the local part. An asterisk should therefore always be followed by
19301 some character that does not occur in normal local parts.
19302 .cindex "multiple mailboxes"
19303 .cindex "mailbox" "multiple"
19304 Wildcarding can be used to set up multiple user mailboxes, as described in
19305 section &<<SECTmulbox>>&.
19306
19307 .vindex "&$local_part$&"
19308 .vindex "&$local_part_prefix$&"
19309 During the testing of the &%local_parts%& option, and while the router is
19310 running, the prefix is removed from the local part, and is available in the
19311 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19312 the router accepts the address, this remains true during subsequent delivery by
19313 a transport. In particular, the local part that is transmitted in the RCPT
19314 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19315 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19316 the relevant transport.
19317
19318 .vindex &$local_part_prefix_v$&
19319 If wildcarding (above) was used then the part of the prefix matching the
19320 wildcard is available in &$local_part_prefix_v$&.
19321
19322 When an address is being verified, &%local_part_prefix%& affects only the
19323 behaviour of the router. If the callout feature of verification is in use, this
19324 means that the full address, including the prefix, will be used during the
19325 callout.
19326
19327 The prefix facility is commonly used to handle local parts of the form
19328 &%owner-something%&. Another common use is to support local parts of the form
19329 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19330 to tell a user their forwarding is broken &-- by placing a router like this one
19331 immediately before the router that handles &_.forward_& files:
19332 .code
19333 real_localuser:
19334   driver = accept
19335   local_part_prefix = real-
19336   check_local_user
19337   transport = local_delivery
19338 .endd
19339 For security, it would probably be a good idea to restrict the use of this
19340 router to locally-generated messages, using a condition such as this:
19341 .code
19342   condition = ${if match {$sender_host_address}\
19343                          {\N^(|127\.0\.0\.1)$\N}}
19344 .endd
19345
19346 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19347 both conditions must be met if not optional. Care must be taken if wildcards
19348 are used in both a prefix and a suffix on the same router. Different
19349 separator characters must be used to avoid ambiguity.
19350
19351
19352 .option local_part_prefix_optional routers boolean false
19353 See &%local_part_prefix%& above.
19354
19355
19356
19357 .option local_part_suffix routers&!? "string list" unset
19358 .cindex "router" "suffix for local part"
19359 .cindex "suffix for local part" "used in router"
19360 This option operates in the same way as &%local_part_prefix%&, except that the
19361 local part must end (rather than start) with the given string, the
19362 &%local_part_suffix_optional%& option determines whether the suffix is
19363 mandatory, and the wildcard * character, if present, must be the last
19364 character of the suffix. This option facility is commonly used to handle local
19365 parts of the form &%something-request%& and multiple user mailboxes of the form
19366 &%username-foo%&.
19367
19368
19369 .option local_part_suffix_optional routers boolean false
19370 See &%local_part_suffix%& above.
19371
19372
19373
19374 .option local_parts routers&!? "local part list&!!" unset
19375 .cindex "router" "restricting to specific local parts"
19376 .cindex "local part" "checking in router"
19377 The router is run only if the local part of the address matches the list.
19378 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19379 are evaluated, and
19380 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19381 string is expanded, it is possible to make it depend on the domain, for
19382 example:
19383 .code
19384 local_parts = dbm;/usr/local/specials/$domain_data
19385 .endd
19386 .vindex "&$local_part_data$&"
19387 If the match is achieved by a lookup, the data that the lookup returned
19388 for the local part is placed in the variable &$local_part_data$& for use in
19389 expansions of the router's private options or in the transport.
19390 You might use this option, for
19391 example, if you have a large number of local virtual domains, and you want to
19392 send all postmaster mail to the same place without having to set up an alias in
19393 each virtual domain:
19394 .code
19395 postmaster:
19396   driver = redirect
19397   local_parts = postmaster
19398   data = postmaster@real.domain.example
19399 .endd
19400
19401
19402 .option log_as_local routers boolean "see below"
19403 .cindex "log" "delivery line"
19404 .cindex "delivery" "log line format"
19405 Exim has two logging styles for delivery, the idea being to make local
19406 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19407 recipient address is given just as the local part, without a domain. The use of
19408 this style is controlled by this option. It defaults to true for the &(accept)&
19409 router, and false for all the others. This option applies only when a
19410 router assigns an address to a transport. It has no effect on routers that
19411 redirect addresses.
19412
19413
19414
19415 .option more routers boolean&!! true
19416 The result of string expansion for this option must be a valid boolean value,
19417 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19418 result causes an error, and delivery is deferred. If the expansion is forced to
19419 fail, the default value for the option (true) is used. Other failures cause
19420 delivery to be deferred.
19421
19422 If this option is set false, and the router declines to handle the address, no
19423 further routers are tried, routing fails, and the address is bounced.
19424 .oindex "&%self%&"
19425 However, if the router explicitly passes an address to the following router by
19426 means of the setting
19427 .code
19428 self = pass
19429 .endd
19430 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19431 does not affect the behaviour if one of the precondition tests fails. In that
19432 case, the address is always passed to the next router.
19433
19434 Note that &%address_data%& is not considered to be a precondition. If its
19435 expansion is forced to fail, the router declines, and the value of &%more%&
19436 controls what happens next.
19437
19438
19439 .option pass_on_timeout routers boolean false
19440 .cindex "timeout" "of router"
19441 .cindex "router" "timeout"
19442 If a router times out during a host lookup, it normally causes deferral of the
19443 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19444 router, overriding &%no_more%&. This may be helpful for systems that are
19445 intermittently connected to the Internet, or those that want to pass to a smart
19446 host any messages that cannot immediately be delivered.
19447
19448 There are occasional other temporary errors that can occur while doing DNS
19449 lookups. They are treated in the same way as a timeout, and this option
19450 applies to all of them.
19451
19452
19453
19454 .option pass_router routers string unset
19455 .cindex "router" "go to after &""pass""&"
19456 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19457 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19458 routing to continue, and overriding a false setting of &%more%&. When one of
19459 these routers returns &"pass"&, the address is normally handed on to the next
19460 router in sequence. This can be changed by setting &%pass_router%& to the name
19461 of another router. However (unlike &%redirect_router%&) the named router must
19462 be below the current router, to avoid loops. Note that this option applies only
19463 to the special case of &"pass"&. It does not apply when a router returns
19464 &"decline"& because it cannot handle an address.
19465
19466
19467
19468 .option redirect_router routers string unset
19469 .cindex "router" "start at after redirection"
19470 Sometimes an administrator knows that it is pointless to reprocess addresses
19471 generated from alias or forward files with the same router again. For
19472 example, if an alias file translates real names into login ids there is no
19473 point searching the alias file a second time, especially if it is a large file.
19474
19475 The &%redirect_router%& option can be set to the name of any router instance.
19476 It causes the routing of any generated addresses to start at the named router
19477 instead of at the first router. This option has no effect if the router in
19478 which it is set does not generate new addresses.
19479
19480
19481
19482 .option require_files routers&!? "string list&!!" unset
19483 .cindex "file" "requiring for router"
19484 .cindex "router" "requiring file existence"
19485 This option provides a general mechanism for predicating the running of a
19486 router on the existence or non-existence of certain files or directories.
19487 Before running a router, as one of its precondition tests, Exim works its way
19488 through the &%require_files%& list, expanding each item separately.
19489
19490 Because the list is split before expansion, any colons in expansion items must
19491 be doubled, or the facility for using a different list separator must be used
19492 (&<<SECTlistsepchange>>&).
19493 If any expansion is forced to fail, the item is ignored. Other expansion
19494 failures cause routing of the address to be deferred.
19495
19496 If any expanded string is empty, it is ignored. Otherwise, except as described
19497 below, each string must be a fully qualified file path, optionally preceded by
19498 &"!"&. The paths are passed to the &[stat()]& function to test for the
19499 existence of the files or directories. The router is skipped if any paths not
19500 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19501
19502 .cindex "NFS"
19503 If &[stat()]& cannot determine whether a file exists or not, delivery of
19504 the message is deferred. This can happen when NFS-mounted filesystems are
19505 unavailable.
19506
19507 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19508 options, so you cannot use it to check for the existence of a file in which to
19509 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19510 full list of the order in which preconditions are evaluated.) However, as
19511 these options are all expanded, you can use the &%exists%& expansion condition
19512 to make such tests. The &%require_files%& option is intended for checking files
19513 that the router may be going to use internally, or which are needed by a
19514 transport (e.g., &_.procmailrc_&).
19515
19516 During delivery, the &[stat()]& function is run as root, but there is a
19517 facility for some checking of the accessibility of a file by another user.
19518 This is not a proper permissions check, but just a &"rough"& check that
19519 operates as follows:
19520
19521 If an item in a &%require_files%& list does not contain any forward slash
19522 characters, it is taken to be the user (and optional group, separated by a
19523 comma) to be checked for subsequent files in the list. If no group is specified
19524 but the user is specified symbolically, the gid associated with the uid is
19525 used. For example:
19526 .code
19527 require_files = mail:/some/file
19528 require_files = $local_part_data:$home/.procmailrc
19529 .endd
19530 If a user or group name in a &%require_files%& list does not exist, the
19531 &%require_files%& condition fails.
19532
19533 Exim performs the check by scanning along the components of the file path, and
19534 checking the access for the given uid and gid. It checks for &"x"& access on
19535 directories, and &"r"& access on the final file. Note that this means that file
19536 access control lists, if the operating system has them, are ignored.
19537
19538 &*Warning 1*&: When the router is being run to verify addresses for an
19539 incoming SMTP message, Exim is not running as root, but under its own uid. This
19540 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19541 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19542 user is not permitted to read one of the directories on the file's path.
19543
19544 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19545 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19546 without root access. In this case, if a check for access by a particular user
19547 is requested, Exim creates a subprocess that runs as that user, and tries the
19548 check again in that process.
19549
19550 The default action for handling an unresolved EACCES is to consider it to
19551 be caused by a configuration error, and routing is deferred because the
19552 existence or non-existence of the file cannot be determined. However, in some
19553 circumstances it may be desirable to treat this condition as if the file did
19554 not exist. If the filename (or the exclamation mark that precedes the filename
19555 for non-existence) is preceded by a plus sign, the EACCES error is treated
19556 as if the file did not exist. For example:
19557 .code
19558 require_files = +/some/file
19559 .endd
19560 If the router is not an essential part of verification (for example, it
19561 handles users' &_.forward_& files), another solution is to set the &%verify%&
19562 option false so that the router is skipped when verifying.
19563
19564
19565
19566 .option retry_use_local_part routers boolean "see below"
19567 .cindex "hints database" "retry keys"
19568 .cindex "local part" "in retry keys"
19569 When a delivery suffers a temporary routing failure, a retry record is created
19570 in Exim's hints database. For addresses whose routing depends only on the
19571 domain, the key for the retry record should not involve the local part, but for
19572 other addresses, both the domain and the local part should be included.
19573 Usually, remote routing is of the former kind, and local routing is of the
19574 latter kind.
19575
19576 This option controls whether the local part is used to form the key for retry
19577 hints for addresses that suffer temporary errors while being handled by this
19578 router. The default value is true for any router that has any of
19579 &%check_local_user%&,
19580 &%local_parts%&,
19581 &%condition%&,
19582 &%local_part_prefix%&,
19583 &%local_part_suffix%&,
19584 &%senders%& or
19585 &%require_files%&
19586 set, and false otherwise. Note that this option does not apply to hints keys
19587 for transport delays; they are controlled by a generic transport option of the
19588 same name.
19589
19590 Failing to set this option when it is needed
19591 (because a remote router handles only some of the local-parts for a domain)
19592 can result in incorrect error messages being generated.
19593
19594 The setting of &%retry_use_local_part%& applies only to the router on which it
19595 appears. If the router generates child addresses, they are routed
19596 independently; this setting does not become attached to them.
19597
19598
19599
19600 .option router_home_directory routers string&!! unset
19601 .cindex "router" "home directory for"
19602 .cindex "home directory" "for router"
19603 .vindex "&$home$&"
19604 This option sets a home directory for use while the router is running. (Compare
19605 &%transport_home_directory%&, which sets a home directory for later
19606 transporting.) In particular, if used on a &(redirect)& router, this option
19607 sets a value for &$home$& while a filter is running. The value is expanded;
19608 forced expansion failure causes the option to be ignored &-- other failures
19609 cause the router to defer.
19610
19611 Expansion of &%router_home_directory%& happens immediately after the
19612 &%check_local_user%& test (if configured), before any further expansions take
19613 place.
19614 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19615 are evaluated.)
19616 While the router is running, &%router_home_directory%& overrides the value of
19617 &$home$& that came from &%check_local_user%&.
19618
19619 When a router accepts an address and assigns it to a local transport (including
19620 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19621 delivery), the home directory setting for the transport is taken from the first
19622 of these values that is set:
19623
19624 .ilist
19625 The &%home_directory%& option on the transport;
19626 .next
19627 The &%transport_home_directory%& option on the router;
19628 .next
19629 The password data if &%check_local_user%& is set on the router;
19630 .next
19631 The &%router_home_directory%& option on the router.
19632 .endlist
19633
19634 In other words, &%router_home_directory%& overrides the password data for the
19635 router, but not for the transport.
19636
19637
19638
19639 .option self routers string freeze
19640 .cindex "MX record" "pointing to local host"
19641 .cindex "local host" "MX pointing to"
19642 This option applies to those routers that use a recipient address to find a
19643 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19644 and &(manualroute)& routers.
19645 Certain configurations of the &(queryprogram)& router can also specify a list
19646 of remote hosts.
19647 Usually such routers are configured to send the message to a remote host via an
19648 &(smtp)& transport. The &%self%& option specifies what happens when the first
19649 host on the list turns out to be the local host.
19650 The way in which Exim checks for the local host is described in section
19651 &<<SECTreclocipadd>>&.
19652
19653 Normally this situation indicates either an error in Exim's configuration (for
19654 example, the router should be configured not to process this domain), or an
19655 error in the DNS (for example, the MX should not point to this host). For this
19656 reason, the default action is to log the incident, defer the address, and
19657 freeze the message. The following alternatives are provided for use in special
19658 cases:
19659
19660 .vlist
19661 .vitem &%defer%&
19662 Delivery of the message is tried again later, but the message is not frozen.
19663
19664 .vitem "&%reroute%&: <&'domain'&>"
19665 The domain is changed to the given domain, and the address is passed back to
19666 be reprocessed by the routers. No rewriting of headers takes place. This
19667 behaviour is essentially a redirection.
19668
19669 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19670 The domain is changed to the given domain, and the address is passed back to be
19671 reprocessed by the routers. Any headers that contain the original domain are
19672 rewritten.
19673
19674 .vitem &%pass%&
19675 .oindex "&%more%&"
19676 .vindex "&$self_hostname$&"
19677 The router passes the address to the next router, or to the router named in the
19678 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19679 subsequent routing and delivery, the variable &$self_hostname$& contains the
19680 name of the local host that the router encountered. This can be used to
19681 distinguish between different cases for hosts with multiple names. The
19682 combination
19683 .code
19684 self = pass
19685 no_more
19686 .endd
19687 ensures that only those addresses that routed to the local host are passed on.
19688 Without &%no_more%&, addresses that were declined for other reasons would also
19689 be passed to the next router.
19690
19691 .vitem &%fail%&
19692 Delivery fails and an error report is generated.
19693
19694 .vitem &%send%&
19695 .cindex "local host" "sending to"
19696 The anomaly is ignored and the address is queued for the transport. This
19697 setting should be used with extreme caution. For an &(smtp)& transport, it
19698 makes sense only in cases where the program that is listening on the SMTP port
19699 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19700 different configuration file that handles the domain in another way.
19701 .endlist
19702
19703
19704
19705 .option senders routers&!? "address list&!!" unset
19706 .cindex "router" "checking senders"
19707 If this option is set, the router is skipped unless the message's sender
19708 address matches something on the list.
19709 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19710 are evaluated.
19711
19712 There are issues concerning verification when the running of routers is
19713 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19714 setting, it sets the sender to the null string. When using the &%-bt%& option
19715 to check a configuration file, it is necessary also to use the &%-f%& option to
19716 set an appropriate sender. For incoming mail, the sender is unset when
19717 verifying the sender, but is available when verifying any recipients. If the
19718 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19719 matters.
19720
19721
19722 .option set routers "string list" unset
19723 .cindex router variables
19724 This option may be used multiple times on a router;
19725 because of this the list aspect is mostly irrelevant.
19726 The list separator is a semicolon but can be changed in the
19727 usual way.
19728
19729 Each list-element given must be of the form &"name = value"&
19730 and the names used must start with the string &"r_"&.
19731 Values containing a list-separator should have them doubled.
19732 When a router runs, the strings are evaluated in order,
19733 to create variables which are added to the set associated with
19734 the address.
19735 .new
19736 This is done immediately after all the preconditions, before the
19737 evaluation of the &%address_data%& option.
19738 .wen
19739 The variable is set with the expansion of the value.
19740 The variables can be used by the router options
19741 (not including any preconditions)
19742 and by the transport.
19743 Later definitions of a given named variable will override former ones.
19744 Variable use is via the usual &$r_...$& syntax.
19745
19746 This is similar to the &%address_data%& option, except that
19747 many independent variables can be used, with choice of naming.
19748
19749
19750 .option translate_ip_address routers string&!! unset
19751 .cindex "IP address" "translating"
19752 .cindex "packet radio"
19753 .cindex "router" "IP address translation"
19754 There exist some rare networking situations (for example, packet radio) where
19755 it is helpful to be able to translate IP addresses generated by normal routing
19756 mechanisms into other IP addresses, thus performing a kind of manual IP
19757 routing. This should be done only if the normal IP routing of the TCP/IP stack
19758 is inadequate or broken. Because this is an extremely uncommon requirement, the
19759 code to support this option is not included in the Exim binary unless
19760 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19761
19762 .vindex "&$host_address$&"
19763 The &%translate_ip_address%& string is expanded for every IP address generated
19764 by the router, with the generated address set in &$host_address$&. If the
19765 expansion is forced to fail, no action is taken.
19766 For any other expansion error, delivery of the message is deferred.
19767 If the result of the expansion is an IP address, that replaces the original
19768 address; otherwise the result is assumed to be a host name &-- this is looked
19769 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19770 produce one or more replacement IP addresses. For example, to subvert all IP
19771 addresses in some specific networks, this could be added to a router:
19772 .code
19773 translate_ip_address = \
19774   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19775     {$value}fail}}
19776 .endd
19777 The file would contain lines like
19778 .code
19779 10.2.3.128/26    some.host
19780 10.8.4.34/26     10.44.8.15
19781 .endd
19782 You should not make use of this facility unless you really understand what you
19783 are doing.
19784
19785
19786
19787 .option transport routers string&!! unset
19788 This option specifies the transport to be used when a router accepts an address
19789 and sets it up for delivery. A transport is never needed if a router is used
19790 only for verification. The value of the option is expanded at routing time,
19791 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19792 and result must be the name of one of the configured transports. If it is not,
19793 delivery is deferred.
19794
19795 The &%transport%& option is not used by the &(redirect)& router, but it does
19796 have some private options that set up transports for pipe and file deliveries
19797 (see chapter &<<CHAPredirect>>&).
19798
19799
19800
19801 .option transport_current_directory routers string&!! unset
19802 .cindex "current directory for local transport"
19803 This option associates a current directory with any address that is routed
19804 to a local transport. This can happen either because a transport is
19805 explicitly configured for the router, or because it generates a delivery to a
19806 file or a pipe. During the delivery process (that is, at transport time), this
19807 option string is expanded and is set as the current directory, unless
19808 overridden by a setting on the transport.
19809 If the expansion fails for any reason, including forced failure, an error is
19810 logged, and delivery is deferred.
19811 See chapter &<<CHAPenvironment>>& for details of the local delivery
19812 environment.
19813
19814
19815
19816
19817 .option transport_home_directory routers string&!! "see below"
19818 .cindex "home directory" "for local transport"
19819 This option associates a home directory with any address that is routed to a
19820 local transport. This can happen either because a transport is explicitly
19821 configured for the router, or because it generates a delivery to a file or a
19822 pipe. During the delivery process (that is, at transport time), the option
19823 string is expanded and is set as the home directory, unless overridden by a
19824 setting of &%home_directory%& on the transport.
19825 If the expansion fails for any reason, including forced failure, an error is
19826 logged, and delivery is deferred.
19827
19828 If the transport does not specify a home directory, and
19829 &%transport_home_directory%& is not set for the router, the home directory for
19830 the transport is taken from the password data if &%check_local_user%& is set for
19831 the router. Otherwise it is taken from &%router_home_directory%& if that option
19832 is set; if not, no home directory is set for the transport.
19833
19834 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19835 environment.
19836
19837
19838
19839
19840 .option unseen routers boolean&!! false
19841 .cindex "router" "carrying on after success"
19842 The result of string expansion for this option must be a valid boolean value,
19843 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19844 result causes an error, and delivery is deferred. If the expansion is forced to
19845 fail, the default value for the option (false) is used. Other failures cause
19846 delivery to be deferred.
19847
19848 When this option is set true, routing does not cease if the router accepts the
19849 address. Instead, a copy of the incoming address is passed to the next router,
19850 overriding a false setting of &%more%&. There is little point in setting
19851 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19852 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19853 sometimes true and sometimes false).
19854
19855 .cindex "copy of message (&%unseen%& option)"
19856 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19857 qualifier in filter files. It can be used to cause copies of messages to be
19858 delivered to some other destination, while also carrying out a normal delivery.
19859 In effect, the current address is made into a &"parent"& that has two children
19860 &-- one that is delivered as specified by this router, and a clone that goes on
19861 to be routed further. For this reason, &%unseen%& may not be combined with the
19862 &%one_time%& option in a &(redirect)& router.
19863
19864 &*Warning*&: Header lines added to the address (or specified for removal) by
19865 this router or by previous routers affect the &"unseen"& copy of the message
19866 only. The clone that continues to be processed by further routers starts with
19867 no added headers and none specified for removal. For a &%redirect%& router, if
19868 a generated address is the same as the incoming address, this can lead to
19869 duplicate addresses with different header modifications. Exim does not do
19870 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19871 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19872 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19873 &%redirect%& router may be of help.
19874
19875 Unlike the handling of header modifications, any data that was set by the
19876 &%address_data%& option in the current or previous routers &'is'& passed on to
19877 subsequent routers.
19878
19879
19880 .option user routers string&!! "see below"
19881 .cindex "uid (user id)" "local delivery"
19882 .cindex "local transports" "uid and gid"
19883 .cindex "transport" "local"
19884 .cindex "router" "user for filter processing"
19885 .cindex "filter" "user for processing"
19886 When a router queues an address for a transport, and the transport does not
19887 specify a user, the user given here is used when running the delivery process.
19888 The user may be specified numerically or by name. If expansion fails, the
19889 error is logged and delivery is deferred.
19890 This user is also used by the &(redirect)& router when running a filter file.
19891 The default is unset, except when &%check_local_user%& is set. In this case,
19892 the default is taken from the password information. If the user is specified as
19893 a name, and &%group%& is not set, the group associated with the user is used.
19894 See also &%initgroups%& and &%group%& and the discussion in chapter
19895 &<<CHAPenvironment>>&.
19896
19897
19898
19899 .option verify routers&!? boolean true
19900 Setting this option has the effect of setting &%verify_sender%& and
19901 &%verify_recipient%& to the same value.
19902
19903
19904 .option verify_only routers&!? boolean false
19905 .cindex "EXPN" "with &%verify_only%&"
19906 .oindex "&%-bv%&"
19907 .cindex "router" "used only when verifying"
19908 If this option is set, the router is used only when verifying an address,
19909 delivering in cutthrough mode or
19910 testing with the &%-bv%& option, not when actually doing a delivery, testing
19911 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19912 restricted to verifying only senders or recipients by means of
19913 &%verify_sender%& and &%verify_recipient%&.
19914
19915 &*Warning*&: When the router is being run to verify addresses for an incoming
19916 SMTP message, Exim is not running as root, but under its own uid. If the router
19917 accesses any files, you need to make sure that they are accessible to the Exim
19918 user or group.
19919
19920
19921 .option verify_recipient routers&!? boolean true
19922 If this option is false, the router is skipped when verifying recipient
19923 addresses,
19924 delivering in cutthrough mode
19925 or testing recipient verification using &%-bv%&.
19926 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19927 are evaluated.
19928 See also the &$verify_mode$& variable.
19929
19930
19931 .option verify_sender routers&!? boolean true
19932 If this option is false, the router is skipped when verifying sender addresses
19933 or testing sender verification using &%-bvs%&.
19934 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19935 are evaluated.
19936 See also the &$verify_mode$& variable.
19937 .ecindex IIDgenoprou1
19938 .ecindex IIDgenoprou2
19939
19940
19941
19942
19943
19944
19945 . ////////////////////////////////////////////////////////////////////////////
19946 . ////////////////////////////////////////////////////////////////////////////
19947
19948 .chapter "The accept router" "CHID4"
19949 .cindex "&(accept)& router"
19950 .cindex "routers" "&(accept)&"
19951 The &(accept)& router has no private options of its own. Unless it is being
19952 used purely for verification (see &%verify_only%&) a transport is required to
19953 be defined by the generic &%transport%& option. If the preconditions that are
19954 specified by generic options are met, the router accepts the address and queues
19955 it for the given transport. The most common use of this router is for setting
19956 up deliveries to local mailboxes. For example:
19957 .code
19958 localusers:
19959   driver = accept
19960   domains = mydomain.example
19961   check_local_user
19962   transport = local_delivery
19963 .endd
19964 The &%domains%& condition in this example checks the domain of the address, and
19965 &%check_local_user%& checks that the local part is the login of a local user.
19966 When both preconditions are met, the &(accept)& router runs, and queues the
19967 address for the &(local_delivery)& transport.
19968
19969
19970
19971
19972
19973
19974 . ////////////////////////////////////////////////////////////////////////////
19975 . ////////////////////////////////////////////////////////////////////////////
19976
19977 .chapter "The dnslookup router" "CHAPdnslookup"
19978 .scindex IIDdnsrou1 "&(dnslookup)& router"
19979 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19980 The &(dnslookup)& router looks up the hosts that handle mail for the
19981 recipient's domain in the DNS. A transport must always be set for this router,
19982 unless &%verify_only%& is set.
19983
19984 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19985 SRV records. If none are found, or if SRV support is not configured,
19986 MX records are looked up. If no MX records exist, address records are sought.
19987 However, &%mx_domains%& can be set to disable the direct use of address
19988 records.
19989
19990 MX records of equal priority are sorted by Exim into a random order. Exim then
19991 looks for address records for the host names obtained from MX or SRV records.
19992 When a host has more than one IP address, they are sorted into a random order,
19993 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19994 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19995 generic option, the router declines.
19996
19997 Unless they have the highest priority (lowest MX value), MX records that point
19998 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19999 are discarded, together with any other MX records of equal or lower priority.
20000
20001 .cindex "MX record" "pointing to local host"
20002 .cindex "local host" "MX pointing to"
20003 .oindex "&%self%&" "in &(dnslookup)& router"
20004 If the host pointed to by the highest priority MX record, or looked up as an
20005 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20006 happens is controlled by the generic &%self%& option.
20007
20008
20009 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20010 There have been problems with DNS servers when SRV records are looked up.
20011 Some misbehaving servers return a DNS error or timeout when a non-existent
20012 SRV record is sought. Similar problems have in the past been reported for
20013 MX records. The global &%dns_again_means_nonexist%& option can help with this
20014 problem, but it is heavy-handed because it is a global option.
20015
20016 For this reason, there are two options, &%srv_fail_domains%& and
20017 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20018 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20019 an attempt to look up an SRV or MX record causes one of these results, and the
20020 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20021 such record"&. In the case of an SRV lookup, this means that the router
20022 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20023 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20024 case routing fails.
20025
20026
20027 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20028 .cindex "&(dnslookup)& router" "declines"
20029 There are a few cases where a &(dnslookup)& router will decline to accept
20030 an address; if such a router is expected to handle "all remaining non-local
20031 domains", then it is important to set &%no_more%&.
20032
20033 The router will defer rather than decline if the domain
20034 is found in the &%fail_defer_domains%& router option.
20035
20036 Reasons for a &(dnslookup)& router to decline currently include:
20037 .ilist
20038 The domain does not exist in DNS
20039 .next
20040 The domain exists but the MX record's host part is just "."; this is a common
20041 convention (borrowed from SRV) used to indicate that there is no such service
20042 for this domain and to not fall back to trying A/AAAA records.
20043 .next
20044 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20045 .next
20046 MX record points to a non-existent host.
20047 .next
20048 MX record points to an IP address and the main section option
20049 &%allow_mx_to_ip%& is not set.
20050 .next
20051 MX records exist and point to valid hosts, but all hosts resolve only to
20052 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20053 .next
20054 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20055 &%dns_check_names_pattern%& for handling one variant of this)
20056 .next
20057 &%check_secondary_mx%& is set on this router but the local host can
20058 not be found in the MX records (see below)
20059 .endlist
20060
20061
20062
20063
20064 .section "Private options for dnslookup" "SECID118"
20065 .cindex "options" "&(dnslookup)& router"
20066 The private options for the &(dnslookup)& router are as follows:
20067
20068 .option check_secondary_mx dnslookup boolean false
20069 .cindex "MX record" "checking for secondary"
20070 If this option is set, the router declines unless the local host is found in
20071 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20072 process domains for which the local host is a secondary mail exchanger
20073 differently to other domains. The way in which Exim decides whether a host is
20074 the local host is described in section &<<SECTreclocipadd>>&.
20075
20076
20077 .option check_srv dnslookup string&!! unset
20078 .cindex "SRV record" "enabling use of"
20079 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20080 addition to MX and address records. The support is disabled by default. To
20081 enable SRV support, set the &%check_srv%& option to the name of the service
20082 required. For example,
20083 .code
20084 check_srv = smtp
20085 .endd
20086 looks for SRV records that refer to the normal smtp service. The option is
20087 expanded, so the service name can vary from message to message or address
20088 to address. This might be helpful if SRV records are being used for a
20089 submission service. If the expansion is forced to fail, the &%check_srv%&
20090 option is ignored, and the router proceeds to look for MX records in the
20091 normal way.
20092
20093 When the expansion succeeds, the router searches first for SRV records for
20094 the given service (it assumes TCP protocol). A single SRV record with a
20095 host name that consists of just a single dot indicates &"no such service for
20096 this domain"&; if this is encountered, the router declines. If other kinds of
20097 SRV record are found, they are used to construct a host list for delivery
20098 according to the rules of RFC 2782. MX records are not sought in this case.
20099
20100 When no SRV records are found, MX records (and address records) are sought in
20101 the traditional way. In other words, SRV records take precedence over MX
20102 records, just as MX records take precedence over address records. Note that
20103 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20104 defined it. It is apparently believed that MX records are sufficient for email
20105 and that SRV records should not be used for this purpose. However, SRV records
20106 have an additional &"weight"& feature which some people might find useful when
20107 trying to split an SMTP load between hosts of different power.
20108
20109 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20110 when there is a DNS lookup error.
20111
20112
20113
20114
20115 .option fail_defer_domains dnslookup "domain list&!!" unset
20116 .cindex "MX record" "not found"
20117 DNS lookups for domains matching &%fail_defer_domains%&
20118 which find no matching record will cause the router to defer
20119 rather than the default behaviour of decline.
20120 This maybe be useful for queueing messages for a newly created
20121 domain while the DNS configuration is not ready.
20122 However, it will result in any message with mistyped domains
20123 also being queued.
20124
20125
20126 .option ipv4_only "string&!!" unset
20127 .cindex IPv6 disabling
20128 .cindex DNS "IPv6 disabling"
20129 The string is expanded, and if the result is anything but a forced failure,
20130 or an empty string, or one of the strings “0” or “no” or “false”
20131 (checked without regard to the case of the letters),
20132 only A records are used.
20133
20134 .option ipv4_prefer "string&!!" unset
20135 .cindex IPv4 preference
20136 .cindex DNS "IPv4 preference"
20137 The string is expanded, and if the result is anything but a forced failure,
20138 or an empty string, or one of the strings “0” or “no” or “false”
20139 (checked without regard to the case of the letters),
20140 A records are sorted before AAAA records (inverting the default).
20141
20142 .option mx_domains dnslookup "domain list&!!" unset
20143 .cindex "MX record" "required to exist"
20144 .cindex "SRV record" "required to exist"
20145 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20146 record in order to be recognized. (The name of this option could be improved.)
20147 For example, if all the mail hosts in &'fict.example'& are known to have MX
20148 records, except for those in &'discworld.fict.example'&, you could use this
20149 setting:
20150 .code
20151 mx_domains = ! *.discworld.fict.example : *.fict.example
20152 .endd
20153 This specifies that messages addressed to a domain that matches the list but
20154 has no MX record should be bounced immediately instead of being routed using
20155 the address record.
20156
20157
20158 .option mx_fail_domains dnslookup "domain list&!!" unset
20159 If the DNS lookup for MX records for one of the domains in this list causes a
20160 DNS lookup error, Exim behaves as if no MX records were found. See section
20161 &<<SECTprowitdnsloo>>& for more discussion.
20162
20163
20164
20165
20166 .option qualify_single dnslookup boolean true
20167 .cindex "DNS" "resolver options"
20168 .cindex "DNS" "qualifying single-component names"
20169 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20170 lookups. Typically, but not standardly, this causes the resolver to qualify
20171 single-component names with the default domain. For example, on a machine
20172 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20173 &'thesaurus.ref.example'& inside the resolver. For details of what your
20174 resolver actually does, consult your man pages for &'resolver'& and
20175 &'resolv.conf'&.
20176
20177
20178
20179 .option rewrite_headers dnslookup boolean true
20180 .cindex "rewriting" "header lines"
20181 .cindex "header lines" "rewriting"
20182 If the domain name in the address that is being processed is not fully
20183 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20184 an address is specified as &'dormouse@teaparty'&, the domain might be
20185 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20186 occur as a result of setting the &%widen_domains%& option. If
20187 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20188 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20189 header lines of the message are rewritten with the full domain name.
20190
20191 This option should be turned off only when it is known that no message is
20192 ever going to be sent outside an environment where the abbreviation makes
20193 sense.
20194
20195 When an MX record is looked up in the DNS and matches a wildcard record, name
20196 servers normally return a record containing the name that has been looked up,
20197 making it impossible to detect whether a wildcard was present or not. However,
20198 some name servers have recently been seen to return the wildcard entry. If the
20199 name returned by a DNS lookup begins with an asterisk, it is not used for
20200 header rewriting.
20201
20202
20203 .option same_domain_copy_routing dnslookup boolean false
20204 .cindex "address" "copying routing"
20205 Addresses with the same domain are normally routed by the &(dnslookup)& router
20206 to the same list of hosts. However, this cannot be presumed, because the router
20207 options and preconditions may refer to the local part of the address. By
20208 default, therefore, Exim routes each address in a message independently. DNS
20209 servers run caches, so repeated DNS lookups are not normally expensive, and in
20210 any case, personal messages rarely have more than a few recipients.
20211
20212 If you are running mailing lists with large numbers of subscribers at the same
20213 domain, and you are using a &(dnslookup)& router which is independent of the
20214 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20215 lookups for identical domains in one message. In this case, when &(dnslookup)&
20216 routes an address to a remote transport, any other unrouted addresses in the
20217 message that have the same domain are automatically given the same routing
20218 without processing them independently,
20219 provided the following conditions are met:
20220
20221 .ilist
20222 No router that processed the address specified &%headers_add%& or
20223 &%headers_remove%&.
20224 .next
20225 The router did not change the address in any way, for example, by &"widening"&
20226 the domain.
20227 .endlist
20228
20229
20230
20231
20232 .option search_parents dnslookup boolean false
20233 .cindex "DNS" "resolver options"
20234 When this option is true, the resolver option RES_DNSRCH is set for DNS
20235 lookups. This is different from the &%qualify_single%& option in that it
20236 applies to domains containing dots. Typically, but not standardly, it causes
20237 the resolver to search for the name in the current domain and in parent
20238 domains. For example, on a machine in the &'fict.example'& domain, if looking
20239 up &'teaparty.wonderland'& failed, the resolver would try
20240 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20241 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20242
20243 Setting this option true can cause problems in domains that have a wildcard MX
20244 record, because any domain that does not have its own MX record matches the
20245 local wildcard.
20246
20247
20248
20249 .option srv_fail_domains dnslookup "domain list&!!" unset
20250 If the DNS lookup for SRV records for one of the domains in this list causes a
20251 DNS lookup error, Exim behaves as if no SRV records were found. See section
20252 &<<SECTprowitdnsloo>>& for more discussion.
20253
20254
20255
20256
20257 .option widen_domains dnslookup "string list" unset
20258 .cindex "domain" "partial; widening"
20259 If a DNS lookup fails and this option is set, each of its strings in turn is
20260 added onto the end of the domain, and the lookup is tried again. For example,
20261 if
20262 .code
20263 widen_domains = fict.example:ref.example
20264 .endd
20265 is set and a lookup of &'klingon.dictionary'& fails,
20266 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20267 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20268 and &%search_parents%& options can cause some widening to be undertaken inside
20269 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20270 when verifying, unless &%rewrite_headers%& is false (not the default).
20271
20272
20273 .section "Effect of qualify_single and search_parents" "SECID119"
20274 When a domain from an envelope recipient is changed by the resolver as a result
20275 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20276 corresponding address in the message's header lines unless &%rewrite_headers%&
20277 is set false. Exim then re-routes the address, using the full domain.
20278
20279 These two options affect only the DNS lookup that takes place inside the router
20280 for the domain of the address that is being routed. They do not affect lookups
20281 such as that implied by
20282 .code
20283 domains = @mx_any
20284 .endd
20285 that may happen while processing a router precondition before the router is
20286 entered. No widening ever takes place for these lookups.
20287 .ecindex IIDdnsrou1
20288 .ecindex IIDdnsrou2
20289
20290
20291
20292
20293
20294
20295
20296
20297
20298 . ////////////////////////////////////////////////////////////////////////////
20299 . ////////////////////////////////////////////////////////////////////////////
20300
20301 .chapter "The ipliteral router" "CHID5"
20302 .cindex "&(ipliteral)& router"
20303 .cindex "domain literal" "routing"
20304 .cindex "routers" "&(ipliteral)&"
20305 This router has no private options. Unless it is being used purely for
20306 verification (see &%verify_only%&) a transport is required to be defined by the
20307 generic &%transport%& option. The router accepts the address if its domain part
20308 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20309 router handles the address
20310 .code
20311 root@[192.168.1.1]
20312 .endd
20313 by setting up delivery to the host with that IP address. IPv4 domain literals
20314 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20315 are similar, but the address is preceded by &`ipv6:`&. For example:
20316 .code
20317 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20318 .endd
20319 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20320 grounds that sooner or later somebody will try it.
20321
20322 .oindex "&%self%&" "in &(ipliteral)& router"
20323 If the IP address matches something in &%ignore_target_hosts%&, the router
20324 declines. If an IP literal turns out to refer to the local host, the generic
20325 &%self%& option determines what happens.
20326
20327 The RFCs require support for domain literals; however, their use is
20328 controversial in today's Internet. If you want to use this router, you must
20329 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20330 Exim will not recognize the domain literal syntax in addresses.
20331
20332
20333
20334 . ////////////////////////////////////////////////////////////////////////////
20335 . ////////////////////////////////////////////////////////////////////////////
20336
20337 .chapter "The iplookup router" "CHID6"
20338 .cindex "&(iplookup)& router"
20339 .cindex "routers" "&(iplookup)&"
20340 The &(iplookup)& router was written to fulfil a specific requirement in
20341 Cambridge University (which in fact no longer exists). For this reason, it is
20342 not included in the binary of Exim by default. If you want to include it, you
20343 must set
20344 .code
20345 ROUTER_IPLOOKUP=yes
20346 .endd
20347 in your &_Local/Makefile_& configuration file.
20348
20349 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20350 connection to one or more specific hosts. The host can then return the same or
20351 a different address &-- in effect rewriting the recipient address in the
20352 message's envelope. The new address is then passed on to subsequent routers. If
20353 this process fails, the address can be passed on to other routers, or delivery
20354 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20355 must not be specified for it.
20356
20357 .cindex "options" "&(iplookup)& router"
20358 .option hosts iplookup string unset
20359 This option must be supplied. Its value is a colon-separated list of host
20360 names. The hosts are looked up using &[gethostbyname()]&
20361 (or &[getipnodebyname()]& when available)
20362 and are tried in order until one responds to the query. If none respond, what
20363 happens is controlled by &%optional%&.
20364
20365
20366 .option optional iplookup boolean false
20367 If &%optional%& is true, if no response is obtained from any host, the address
20368 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20369 delivery to the address is deferred.
20370
20371
20372 .option port iplookup integer 0
20373 .cindex "port" "&(iplookup)& router"
20374 This option must be supplied. It specifies the port number for the TCP or UDP
20375 call.
20376
20377
20378 .option protocol iplookup string udp
20379 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20380 protocols is to be used.
20381
20382
20383 .option query iplookup string&!! "see below"
20384 This defines the content of the query that is sent to the remote hosts. The
20385 default value is:
20386 .code
20387 $local_part@$domain $local_part@$domain
20388 .endd
20389 The repetition serves as a way of checking that a response is to the correct
20390 query in the default case (see &%response_pattern%& below).
20391
20392
20393 .option reroute iplookup string&!! unset
20394 If this option is not set, the rerouted address is precisely the byte string
20395 returned by the remote host, up to the first white space, if any. If set, the
20396 string is expanded to form the rerouted address. It can include parts matched
20397 in the response by &%response_pattern%& by means of numeric variables such as
20398 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20399 whether or not a pattern is in use. In all cases, the rerouted address must end
20400 up in the form &'local_part@domain'&.
20401
20402
20403 .option response_pattern iplookup string unset
20404 This option can be set to a regular expression that is applied to the string
20405 returned from the remote host. If the pattern does not match the response, the
20406 router declines. If &%response_pattern%& is not set, no checking of the
20407 response is done, unless the query was defaulted, in which case there is a
20408 check that the text returned after the first white space is the original
20409 address. This checks that the answer that has been received is in response to
20410 the correct question. For example, if the response is just a new domain, the
20411 following could be used:
20412 .code
20413 response_pattern = ^([^@]+)$
20414 reroute = $local_part@$1
20415 .endd
20416
20417 .option timeout iplookup time 5s
20418 This specifies the amount of time to wait for a response from the remote
20419 machine. The same timeout is used for the &[connect()]& function for a TCP
20420 call. It does not apply to UDP.
20421
20422
20423
20424
20425 . ////////////////////////////////////////////////////////////////////////////
20426 . ////////////////////////////////////////////////////////////////////////////
20427
20428 .chapter "The manualroute router" "CHID7"
20429 .scindex IIDmanrou1 "&(manualroute)& router"
20430 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20431 .cindex "domain" "manually routing"
20432 The &(manualroute)& router is so-called because it provides a way of manually
20433 routing an address according to its domain. It is mainly used when you want to
20434 route addresses to remote hosts according to your own rules, bypassing the
20435 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20436 route to local transports, a facility that may be useful if you want to save
20437 messages for dial-in hosts in local files.
20438
20439 The &(manualroute)& router compares a list of domain patterns with the domain
20440 it is trying to route. If there is no match, the router declines. Each pattern
20441 has associated with it a list of hosts and some other optional data, which may
20442 include a transport. The combination of a pattern and its data is called a
20443 &"routing rule"&. For patterns that do not have an associated transport, the
20444 generic &%transport%& option must specify a transport, unless the router is
20445 being used purely for verification (see &%verify_only%&).
20446
20447 .vindex "&$host$&"
20448 In the case of verification, matching the domain pattern is sufficient for the
20449 router to accept the address. When actually routing an address for delivery,
20450 an address that matches a domain pattern is queued for the associated
20451 transport. If the transport is not a local one, a host list must be associated
20452 with the pattern; IP addresses are looked up for the hosts, and these are
20453 passed to the transport along with the mail address. For local transports, a
20454 host list is optional. If it is present, it is passed in &$host$& as a single
20455 text string.
20456
20457 The list of routing rules can be provided as an inline string in
20458 &%route_list%&, or the data can be obtained by looking up the domain in a file
20459 or database by setting &%route_data%&. Only one of these settings may appear in
20460 any one instance of &(manualroute)&. The format of routing rules is described
20461 below, following the list of private options.
20462
20463
20464 .section "Private options for manualroute" "SECTprioptman"
20465
20466 .cindex "options" "&(manualroute)& router"
20467 The private options for the &(manualroute)& router are as follows:
20468
20469 .option host_all_ignored manualroute string defer
20470 See &%host_find_failed%&.
20471
20472 .option host_find_failed manualroute string freeze
20473 This option controls what happens when &(manualroute)& tries to find an IP
20474 address for a host, and the host does not exist. The option can be set to one
20475 of the following values:
20476 .code
20477 decline
20478 defer
20479 fail
20480 freeze
20481 ignore
20482 pass
20483 .endd
20484 The default (&"freeze"&) assumes that this state is a serious configuration
20485 error. The difference between &"pass"& and &"decline"& is that the former
20486 forces the address to be passed to the next router (or the router defined by
20487 &%pass_router%&),
20488 .oindex "&%more%&"
20489 overriding &%no_more%&, whereas the latter passes the address to the next
20490 router only if &%more%& is true.
20491
20492 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20493 cannot be found. If all the hosts in the list are ignored, the behaviour is
20494 controlled by the &%host_all_ignored%& option. This takes the same values
20495 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20496
20497 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20498 state; if a host lookup gets a temporary error, delivery is deferred unless the
20499 generic &%pass_on_timeout%& option is set.
20500
20501
20502 .option hosts_randomize manualroute boolean false
20503 .cindex "randomized host list"
20504 .cindex "host" "list of; randomized"
20505 If this option is set, the order of the items in a host list in a routing rule
20506 is randomized each time the list is used, unless an option in the routing rule
20507 overrides (see below). Randomizing the order of a host list can be used to do
20508 crude load sharing. However, if more than one mail address is routed by the
20509 same router to the same host list, the host lists are considered to be the same
20510 (even though they may be randomized into different orders) for the purpose of
20511 deciding whether to batch the deliveries into a single SMTP transaction.
20512
20513 When &%hosts_randomize%& is true, a host list may be split
20514 into groups whose order is separately randomized. This makes it possible to
20515 set up MX-like behaviour. The boundaries between groups are indicated by an
20516 item that is just &`+`& in the host list. For example:
20517 .code
20518 route_list = * host1:host2:host3:+:host4:host5
20519 .endd
20520 The order of the first three hosts and the order of the last two hosts is
20521 randomized for each use, but the first three always end up before the last two.
20522 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20523 randomized host list is passed to an &(smtp)& transport that also has
20524 &%hosts_randomize set%&, the list is not re-randomized.
20525
20526
20527 .option route_data manualroute string&!! unset
20528 If this option is set, it must expand to yield the data part of a routing rule.
20529 Typically, the expansion string includes a lookup based on the domain. For
20530 example:
20531 .code
20532 route_data = ${lookup{$domain}dbm{/etc/routes}}
20533 .endd
20534 If the expansion is forced to fail, or the result is an empty string, the
20535 router declines. Other kinds of expansion failure cause delivery to be
20536 deferred.
20537
20538
20539 .option route_list manualroute "string list" unset
20540 This string is a list of routing rules, in the form defined below. Note that,
20541 unlike most string lists, the items are separated by semicolons. This is so
20542 that they may contain colon-separated host lists.
20543
20544
20545 .option same_domain_copy_routing manualroute boolean false
20546 .cindex "address" "copying routing"
20547 Addresses with the same domain are normally routed by the &(manualroute)&
20548 router to the same list of hosts. However, this cannot be presumed, because the
20549 router options and preconditions may refer to the local part of the address. By
20550 default, therefore, Exim routes each address in a message independently. DNS
20551 servers run caches, so repeated DNS lookups are not normally expensive, and in
20552 any case, personal messages rarely have more than a few recipients.
20553
20554 If you are running mailing lists with large numbers of subscribers at the same
20555 domain, and you are using a &(manualroute)& router which is independent of the
20556 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20557 lookups for identical domains in one message. In this case, when
20558 &(manualroute)& routes an address to a remote transport, any other unrouted
20559 addresses in the message that have the same domain are automatically given the
20560 same routing without processing them independently. However, this is only done
20561 if &%headers_add%& and &%headers_remove%& are unset.
20562
20563
20564
20565
20566 .section "Routing rules in route_list" "SECID120"
20567 The value of &%route_list%& is a string consisting of a sequence of routing
20568 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20569 entered as two semicolons. Alternatively, the list separator can be changed as
20570 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20571 Empty rules are ignored. The format of each rule is
20572 .display
20573 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20574 .endd
20575 The following example contains two rules, each with a simple domain pattern and
20576 no options:
20577 .code
20578 route_list = \
20579   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20580   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20581 .endd
20582 The three parts of a rule are separated by white space. The pattern and the
20583 list of hosts can be enclosed in quotes if necessary, and if they are, the
20584 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20585 single domain pattern, which is the only mandatory item in the rule. The
20586 pattern is in the same format as one item in a domain list (see section
20587 &<<SECTdomainlist>>&),
20588 except that it may not be the name of an interpolated file.
20589 That is, it may be wildcarded, or a regular expression, or a file or database
20590 lookup (with semicolons doubled, because of the use of semicolon as a separator
20591 in a &%route_list%&).
20592
20593 The rules in &%route_list%& are searched in order until one of the patterns
20594 matches the domain that is being routed. The list of hosts and then options are
20595 then used as described below. If there is no match, the router declines. When
20596 &%route_list%& is set, &%route_data%& must not be set.
20597
20598
20599
20600 .section "Routing rules in route_data" "SECID121"
20601 The use of &%route_list%& is convenient when there are only a small number of
20602 routing rules. For larger numbers, it is easier to use a file or database to
20603 hold the routing information, and use the &%route_data%& option instead.
20604 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20605 Most commonly, &%route_data%& is set as a string that contains an
20606 expansion lookup. For example, suppose we place two routing rules in a file
20607 like this:
20608 .code
20609 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20610 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20611 .endd
20612 This data can be accessed by setting
20613 .code
20614 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20615 .endd
20616 Failure of the lookup results in an empty string, causing the router to
20617 decline. However, you do not have to use a lookup in &%route_data%&. The only
20618 requirement is that the result of expanding the string is a list of hosts,
20619 possibly followed by options, separated by white space. The list of hosts must
20620 be enclosed in quotes if it contains white space.
20621
20622
20623
20624
20625 .section "Format of the list of hosts" "SECID122"
20626 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20627 always separately expanded before use. If the expansion fails, the router
20628 declines. The result of the expansion must be a colon-separated list of names
20629 and/or IP addresses, optionally also including ports.
20630 If the list is written with spaces, it must be protected with quotes.
20631 The format of each item
20632 in the list is described in the next section. The list separator can be changed
20633 as described in section &<<SECTlistsepchange>>&.
20634
20635 If the list of hosts was obtained from a &%route_list%& item, the following
20636 variables are set during its expansion:
20637
20638 .ilist
20639 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20640 If the domain was matched against a regular expression, the numeric variables
20641 &$1$&, &$2$&, etc. may be set. For example:
20642 .code
20643 route_list = ^domain(\d+)   host-$1.text.example
20644 .endd
20645 .next
20646 &$0$& is always set to the entire domain.
20647 .next
20648 &$1$& is also set when partial matching is done in a file lookup.
20649
20650 .next
20651 .vindex "&$value$&"
20652 If the pattern that matched the domain was a lookup item, the data that was
20653 looked up is available in the expansion variable &$value$&. For example:
20654 .code
20655 route_list = lsearch;;/some/file.routes  $value
20656 .endd
20657 .endlist
20658
20659 Note the doubling of the semicolon in the pattern that is necessary because
20660 semicolon is the default route list separator.
20661
20662
20663
20664 .section "Format of one host item" "SECTformatonehostitem"
20665 Each item in the list of hosts can be either a host name or an IP address,
20666 optionally with an attached port number, or it can be a single "+"
20667 (see &%hosts_randomize%&).
20668 When no port is given, an IP address
20669 is not enclosed in brackets. When a port is specified, it overrides the port
20670 specification on the transport. The port is separated from the name or address
20671 by a colon. This leads to some complications:
20672
20673 .ilist
20674 Because colon is the default separator for the list of hosts, either
20675 the colon that specifies a port must be doubled, or the list separator must
20676 be changed. The following two examples have the same effect:
20677 .code
20678 route_list = * "host1.tld::1225 : host2.tld::1226"
20679 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20680 .endd
20681 .next
20682 When IPv6 addresses are involved, it gets worse, because they contain
20683 colons of their own. To make this case easier, it is permitted to
20684 enclose an IP address (either v4 or v6) in square brackets if a port
20685 number follows. For example:
20686 .code
20687 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20688 .endd
20689 .endlist
20690
20691 .section "How the list of hosts is used" "SECThostshowused"
20692 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20693 the hosts is tried, in the order specified, when carrying out the SMTP
20694 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20695 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20696 transport.
20697
20698 Hosts may be listed by name or by IP address. An unadorned name in the list of
20699 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20700 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20701 records in the DNS. For example:
20702 .code
20703 route_list = *  x.y.z:p.q.r/MX:e.f.g
20704 .endd
20705 If this feature is used with a port specifier, the port must come last. For
20706 example:
20707 .code
20708 route_list = *  dom1.tld/mx::1225
20709 .endd
20710 If the &%hosts_randomize%& option is set, the order of the items in the list is
20711 randomized before any lookups are done. Exim then scans the list; for any name
20712 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20713 be an interface on the local host and the item is not the first in the list,
20714 Exim discards it and any subsequent items. If it is the first item, what
20715 happens is controlled by the
20716 .oindex "&%self%&" "in &(manualroute)& router"
20717 &%self%& option of the router.
20718
20719 A name on the list that is followed by &`/MX`& is replaced with the list of
20720 hosts obtained by looking up MX records for the name. This is always a DNS
20721 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20722 below) are not relevant here. The order of these hosts is determined by the
20723 preference values in the MX records, according to the usual rules. Because
20724 randomizing happens before the MX lookup, it does not affect the order that is
20725 defined by MX preferences.
20726
20727 If the local host is present in the sublist obtained from MX records, but is
20728 not the most preferred host in that list, it and any equally or less
20729 preferred hosts are removed before the sublist is inserted into the main list.
20730
20731 If the local host is the most preferred host in the MX list, what happens
20732 depends on where in the original list of hosts the &`/MX`& item appears. If it
20733 is not the first item (that is, there are previous hosts in the main list),
20734 Exim discards this name and any subsequent items in the main list.
20735
20736 If the MX item is first in the list of hosts, and the local host is the
20737 most preferred host, what happens is controlled by the &%self%& option of the
20738 router.
20739
20740 DNS failures when lookup up the MX records are treated in the same way as DNS
20741 failures when looking up IP addresses: &%pass_on_timeout%& and
20742 &%host_find_failed%& are used when relevant.
20743
20744 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20745 whether obtained from an MX lookup or not.
20746
20747
20748
20749 .section "How the options are used" "SECThowoptused"
20750 The options are a sequence of words, space-separated.
20751 One of the words can be the name of a transport; this overrides the
20752 &%transport%& option on the router for this particular routing rule only. The
20753 other words (if present) control randomization of the list of hosts on a
20754 per-rule basis, and how the IP addresses of the hosts are to be found when
20755 routing to a remote transport. These options are as follows:
20756
20757 .ilist
20758 &%randomize%&: randomize the order of the hosts in this list, overriding the
20759 setting of &%hosts_randomize%& for this routing rule only.
20760 .next
20761 &%no_randomize%&: do not randomize the order of the hosts in this list,
20762 overriding the setting of &%hosts_randomize%& for this routing rule only.
20763 .next
20764 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20765 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20766 also look in &_/etc/hosts_& or other sources of information.
20767 .next
20768 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20769 no address records are found. If there is a temporary DNS error (such as a
20770 timeout), delivery is deferred.
20771 .next
20772 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20773 .next
20774 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20775 .endlist
20776
20777 For example:
20778 .code
20779 route_list = domain1  host1:host2:host3  randomize bydns;\
20780              domain2  host4:host5
20781 .endd
20782 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20783 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20784 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20785 or &[gethostbyname()]&, and the result of the lookup is the result of that
20786 call.
20787
20788 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20789 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20790 instead of TRY_AGAIN. That is why the default action is to try a DNS
20791 lookup first. Only if that gives a definite &"no such host"& is the local
20792 function called.
20793
20794 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20795 inadvertent constraint that a transport name as an option had to be the last
20796 option specified.
20797
20798
20799
20800 If no IP address for a host can be found, what happens is controlled by the
20801 &%host_find_failed%& option.
20802
20803 .vindex "&$host$&"
20804 When an address is routed to a local transport, IP addresses are not looked up.
20805 The host list is passed to the transport in the &$host$& variable.
20806
20807
20808
20809 .section "Manualroute examples" "SECID123"
20810 In some of the examples that follow, the presence of the &%remote_smtp%&
20811 transport, as defined in the default configuration file, is assumed:
20812
20813 .ilist
20814 .cindex "smart host" "example router"
20815 The &(manualroute)& router can be used to forward all external mail to a
20816 &'smart host'&. If you have set up, in the main part of the configuration, a
20817 named domain list that contains your local domains, for example:
20818 .code
20819 domainlist local_domains = my.domain.example
20820 .endd
20821 You can arrange for all other domains to be routed to a smart host by making
20822 your first router something like this:
20823 .code
20824 smart_route:
20825   driver = manualroute
20826   domains = !+local_domains
20827   transport = remote_smtp
20828   route_list = * smarthost.ref.example
20829 .endd
20830 This causes all non-local addresses to be sent to the single host
20831 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20832 they are tried in order
20833 (but you can use &%hosts_randomize%& to vary the order each time).
20834 Another way of configuring the same thing is this:
20835 .code
20836 smart_route:
20837   driver = manualroute
20838   transport = remote_smtp
20839   route_list = !+local_domains  smarthost.ref.example
20840 .endd
20841 There is no difference in behaviour between these two routers as they stand.
20842 However, they behave differently if &%no_more%& is added to them. In the first
20843 example, the router is skipped if the domain does not match the &%domains%&
20844 precondition; the following router is always tried. If the router runs, it
20845 always matches the domain and so can never decline. Therefore, &%no_more%&
20846 would have no effect. In the second case, the router is never skipped; it
20847 always runs. However, if it doesn't match the domain, it declines. In this case
20848 &%no_more%& would prevent subsequent routers from running.
20849
20850 .next
20851 .cindex "mail hub example"
20852 A &'mail hub'& is a host which receives mail for a number of domains via MX
20853 records in the DNS and delivers it via its own private routing mechanism. Often
20854 the final destinations are behind a firewall, with the mail hub being the one
20855 machine that can connect to machines both inside and outside the firewall. The
20856 &(manualroute)& router is usually used on a mail hub to route incoming messages
20857 to the correct hosts. For a small number of domains, the routing can be inline,
20858 using the &%route_list%& option, but for a larger number a file or database
20859 lookup is easier to manage.
20860
20861 If the domain names are in fact the names of the machines to which the mail is
20862 to be sent by the mail hub, the configuration can be quite simple. For
20863 example:
20864 .code
20865 hub_route:
20866   driver = manualroute
20867   transport = remote_smtp
20868   route_list = *.rhodes.tvs.example  $domain
20869 .endd
20870 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20871 whose names are the same as the mail domains. A similar approach can be taken
20872 if the host name can be obtained from the domain name by a string manipulation
20873 that the expansion facilities can handle. Otherwise, a lookup based on the
20874 domain can be used to find the host:
20875 .code
20876 through_firewall:
20877   driver = manualroute
20878   transport = remote_smtp
20879   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20880 .endd
20881 The result of the lookup must be the name or IP address of the host (or
20882 hosts) to which the address is to be routed. If the lookup fails, the route
20883 data is empty, causing the router to decline. The address then passes to the
20884 next router.
20885
20886 .next
20887 .cindex "batched SMTP output example"
20888 .cindex "SMTP" "batched outgoing; example"
20889 You can use &(manualroute)& to deliver messages to pipes or files in batched
20890 SMTP format for onward transportation by some other means. This is one way of
20891 storing mail for a dial-up host when it is not connected. The route list entry
20892 can be as simple as a single domain name in a configuration like this:
20893 .code
20894 save_in_file:
20895   driver = manualroute
20896   transport = batchsmtp_appendfile
20897   route_list = saved.domain.example
20898 .endd
20899 though often a pattern is used to pick up more than one domain. If there are
20900 several domains or groups of domains with different transport requirements,
20901 different transports can be listed in the routing information:
20902 .code
20903 save_in_file:
20904   driver = manualroute
20905   route_list = \
20906     *.saved.domain1.example  $domain  batch_appendfile; \
20907     *.saved.domain2.example  \
20908       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20909       batch_pipe
20910 .endd
20911 .vindex "&$domain$&"
20912 .vindex "&$host$&"
20913 The first of these just passes the domain in the &$host$& variable, which
20914 doesn't achieve much (since it is also in &$domain$&), but the second does a
20915 file lookup to find a value to pass, causing the router to decline to handle
20916 the address if the lookup fails.
20917
20918 .next
20919 .cindex "UUCP" "example of router for"
20920 Routing mail directly to UUCP software is a specific case of the use of
20921 &(manualroute)& in a gateway to another mail environment. This is an example of
20922 one way it can be done:
20923 .code
20924 # Transport
20925 uucp:
20926   driver = pipe
20927   user = nobody
20928   command = /usr/local/bin/uux -r - \
20929     ${substr_-5:$host}!rmail ${local_part}
20930   return_fail_output = true
20931
20932 # Router
20933 uucphost:
20934   transport = uucp
20935   driver = manualroute
20936   route_data = \
20937     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20938 .endd
20939 The file &_/usr/local/exim/uucphosts_& contains entries like
20940 .code
20941 darksite.ethereal.example:           darksite.UUCP
20942 .endd
20943 It can be set up more simply without adding and removing &".UUCP"& but this way
20944 makes clear the distinction between the domain name
20945 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20946 .endlist
20947 .ecindex IIDmanrou1
20948 .ecindex IIDmanrou2
20949
20950
20951
20952
20953
20954
20955
20956
20957 . ////////////////////////////////////////////////////////////////////////////
20958 . ////////////////////////////////////////////////////////////////////////////
20959
20960 .chapter "The queryprogram router" "CHAPdriverlast"
20961 .scindex IIDquerou1 "&(queryprogram)& router"
20962 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20963 .cindex "routing" "by external program"
20964 The &(queryprogram)& router routes an address by running an external command
20965 and acting on its output. This is an expensive way to route, and is intended
20966 mainly for use in lightly-loaded systems, or for performing experiments.
20967 However, if it is possible to use the precondition options (&%domains%&,
20968 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20969 be used in special cases, even on a busy host. There are the following private
20970 options:
20971 .cindex "options" "&(queryprogram)& router"
20972
20973 .option command queryprogram string&!! unset
20974 This option must be set. It specifies the command that is to be run. The
20975 command is split up into a command name and arguments, and then each is
20976 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20977 &<<CHAPpipetransport>>&).
20978
20979
20980 .option command_group queryprogram string unset
20981 .cindex "gid (group id)" "in &(queryprogram)& router"
20982 This option specifies a gid to be set when running the command while routing an
20983 address for deliver. It must be set if &%command_user%& specifies a numerical
20984 uid. If it begins with a digit, it is interpreted as the numerical value of the
20985 gid. Otherwise it is looked up using &[getgrnam()]&.
20986
20987
20988 .option command_user queryprogram string unset
20989 .cindex "uid (user id)" "for &(queryprogram)&"
20990 This option must be set. It specifies the uid which is set when running the
20991 command while routing an address for delivery. If the value begins with a digit,
20992 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20993 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20994 not set, a value for the gid also.
20995
20996 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20997 root, which it does during a normal delivery in a conventional configuration.
20998 However, when an address is being verified during message reception, Exim is
20999 usually running as the Exim user, not as root. If the &(queryprogram)& router
21000 is called from a non-root process, Exim cannot change uid or gid before running
21001 the command. In this circumstance the command runs under the current uid and
21002 gid.
21003
21004
21005 .option current_directory queryprogram string /
21006 This option specifies an absolute path which is made the current directory
21007 before running the command.
21008
21009
21010 .option timeout queryprogram time 1h
21011 If the command does not complete within the timeout period, its process group
21012 is killed and the message is frozen. A value of zero time specifies no
21013 timeout.
21014
21015
21016 The standard output of the command is connected to a pipe, which is read when
21017 the command terminates. It should consist of a single line of output,
21018 containing up to five fields, separated by white space. The maximum length of
21019 the line is 1023 characters. Longer lines are silently truncated. The first
21020 field is one of the following words (case-insensitive):
21021
21022 .ilist
21023 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21024 below).
21025 .next
21026 &'Decline'&: the router declines; pass the address to the next router, unless
21027 &%no_more%& is set.
21028 .next
21029 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21030 subsequent text on the line is an error message. If the router is run as part
21031 of address verification during an incoming SMTP message, the message is
21032 included in the SMTP response.
21033 .next
21034 &'Defer'&: routing could not be completed at this time; try again later. Any
21035 subsequent text on the line is an error message which is logged. It is not
21036 included in any SMTP response.
21037 .next
21038 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21039 .next
21040 &'Pass'&: pass the address to the next router (or the router specified by
21041 &%pass_router%&), overriding &%no_more%&.
21042 .next
21043 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21044 new addresses, which are routed independently, starting with the first router,
21045 or the router specified by &%redirect_router%&, if set.
21046 .endlist
21047
21048 When the first word is &'accept'&, the remainder of the line consists of a
21049 number of keyed data values, as follows (split into two lines here, to fit on
21050 the page):
21051 .code
21052 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21053 LOOKUP=byname|bydns DATA=<text>
21054 .endd
21055 The data items can be given in any order, and all are optional. If no transport
21056 is included, the transport specified by the generic &%transport%& option is
21057 used. The list of hosts and the lookup type are needed only if the transport is
21058 an &(smtp)& transport that does not itself supply a list of hosts.
21059
21060 The format of the list of hosts is the same as for the &(manualroute)& router.
21061 As well as host names and IP addresses with optional port numbers, as described
21062 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21063 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21064 (see section &<<SECThostshowused>>&).
21065
21066 If the lookup type is not specified, Exim behaves as follows when trying to
21067 find an IP address for each host: First, a DNS lookup is done. If this yields
21068 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21069 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21070 result of the lookup is the result of that call.
21071
21072 .vindex "&$address_data$&"
21073 If the DATA field is set, its value is placed in the &$address_data$&
21074 variable. For example, this return line
21075 .code
21076 accept hosts=x1.y.example:x2.y.example data="rule1"
21077 .endd
21078 routes the address to the default transport, passing a list of two hosts. When
21079 the transport runs, the string &"rule1"& is in &$address_data$&.
21080 .ecindex IIDquerou1
21081 .ecindex IIDquerou2
21082
21083
21084
21085
21086 . ////////////////////////////////////////////////////////////////////////////
21087 . ////////////////////////////////////////////////////////////////////////////
21088
21089 .chapter "The redirect router" "CHAPredirect"
21090 .scindex IIDredrou1 "&(redirect)& router"
21091 .scindex IIDredrou2 "routers" "&(redirect)&"
21092 .cindex "alias file" "in a &(redirect)& router"
21093 .cindex "address redirection" "&(redirect)& router"
21094 The &(redirect)& router handles several kinds of address redirection. Its most
21095 common uses are for resolving local part aliases from a central alias file
21096 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21097 files, but it has many other potential uses. The incoming address can be
21098 redirected in several different ways:
21099
21100 .ilist
21101 It can be replaced by one or more new addresses which are themselves routed
21102 independently.
21103 .next
21104 It can be routed to be delivered to a given file or directory.
21105 .next
21106 It can be routed to be delivered to a specified pipe command.
21107 .next
21108 It can cause an automatic reply to be generated.
21109 .next
21110 It can be forced to fail, optionally with a custom error message.
21111 .next
21112 It can be temporarily deferred, optionally with a custom message.
21113 .next
21114 It can be discarded.
21115 .endlist
21116
21117 The generic &%transport%& option must not be set for &(redirect)& routers.
21118 However, there are some private options which define transports for delivery to
21119 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21120 &%pipe_transport%& and &%reply_transport%& descriptions below.
21121
21122 If success DSNs have been requested
21123 .cindex "DSN" "success"
21124 .cindex "Delivery Status Notification" "success"
21125 redirection triggers one and the DSN options are not passed any further.
21126
21127
21128
21129 .section "Redirection data" "SECID124"
21130 The router operates by interpreting a text string which it obtains either by
21131 expanding the contents of the &%data%& option, or by reading the entire
21132 contents of a file whose name is given in the &%file%& option. These two
21133 options are mutually exclusive. The first is commonly used for handling system
21134 aliases, in a configuration like this:
21135 .code
21136 system_aliases:
21137   driver = redirect
21138   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21139 .endd
21140 If the lookup fails, the expanded string in this example is empty. When the
21141 expansion of &%data%& results in an empty string, the router declines. A forced
21142 expansion failure also causes the router to decline; other expansion failures
21143 cause delivery to be deferred.
21144
21145 A configuration using &%file%& is commonly used for handling users'
21146 &_.forward_& files, like this:
21147 .code
21148 userforward:
21149   driver = redirect
21150   check_local_user
21151   file = $home/.forward
21152   no_verify
21153 .endd
21154 If the file does not exist, or causes no action to be taken (for example, it is
21155 empty or consists only of comments), the router declines. &*Warning*&: This
21156 is not the case when the file contains syntactically valid items that happen to
21157 yield empty addresses, for example, items containing only RFC 2822 address
21158 comments.
21159
21160 .cindex "tainted data" "in filenames"
21161 .cindex redirect "tainted data"
21162 Tainted data may not be used for a filename.
21163
21164 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21165 directly for redirection,
21166 as they are provided by a potential attacker.
21167 In the examples above, &$local_part$& is used for looking up data held locally
21168 on the system, and not used directly (the second example derives &$home$& via
21169 the passsword file or database, using &$local_part$&).
21170
21171
21172
21173 .section "Forward files and address verification" "SECID125"
21174 .cindex "address redirection" "while verifying"
21175 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21176 &_.forward_& files, as in the example above. There are two reasons for this:
21177
21178 .ilist
21179 When Exim is receiving an incoming SMTP message from a remote host, it is
21180 running under the Exim uid, not as root. Exim is unable to change uid to read
21181 the file as the user, and it may not be able to read it as the Exim user. So in
21182 practice the router may not be able to operate.
21183 .next
21184 However, even when the router can operate, the existence of a &_.forward_& file
21185 is unimportant when verifying an address. What should be checked is whether the
21186 local part is a valid user name or not. Cutting out the redirection processing
21187 saves some resources.
21188 .endlist
21189
21190
21191
21192
21193
21194
21195 .section "Interpreting redirection data" "SECID126"
21196 .cindex "Sieve filter" "specifying in redirection data"
21197 .cindex "filter" "specifying in redirection data"
21198 The contents of the data string, whether obtained from &%data%& or &%file%&,
21199 can be interpreted in two different ways:
21200
21201 .ilist
21202 If the &%allow_filter%& option is set true, and the data begins with the text
21203 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21204 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21205 respectively. Details of the syntax and semantics of filter files are described
21206 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21207 document is intended for use by end users.
21208 .next
21209 Otherwise, the data must be a comma-separated list of redirection items, as
21210 described in the next section.
21211 .endlist
21212
21213 When a message is redirected to a file (a &"mail folder"&), the filename given
21214 in a non-filter redirection list must always be an absolute path. A filter may
21215 generate a relative path &-- how this is handled depends on the transport's
21216 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21217 for the &(appendfile)& transport.
21218
21219
21220
21221 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21222 .cindex "address redirection" "non-filter list items"
21223 When the redirection data is not an Exim or Sieve filter, for example, if it
21224 comes from a conventional alias or forward file, it consists of a list of
21225 addresses, filenames, pipe commands, or certain special items (see section
21226 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21227 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21228 depending on their default values. The items in the list are separated by
21229 commas or newlines.
21230 If a comma is required in an item, the entire item must be enclosed in double
21231 quotes.
21232
21233 Lines starting with a # character are comments, and are ignored, and # may
21234 also appear following a comma, in which case everything between the # and the
21235 next newline character is ignored.
21236
21237 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21238 double quotes are retained because some forms of mail address require their use
21239 (but never to enclose the entire address). In the following description,
21240 &"item"& refers to what remains after any surrounding double quotes have been
21241 removed.
21242
21243 .vindex "&$local_part$&"
21244 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21245 and the expansion contains a reference to &$local_part$&, you should make use
21246 of the &%quote_local_part%& expansion operator, in case the local part contains
21247 special characters. For example, to redirect all mail for the domain
21248 &'obsolete.example'&, retaining the existing local part, you could use this
21249 setting:
21250 .code
21251 data = ${quote_local_part:$local_part}@newdomain.example
21252 .endd
21253
21254
21255 .section "Redirecting to a local mailbox" "SECTredlocmai"
21256 .cindex "routing" "loops in"
21257 .cindex "loop" "while routing, avoidance of"
21258 .cindex "address redirection" "to local mailbox"
21259 A redirection item may safely be the same as the address currently under
21260 consideration. This does not cause a routing loop, because a router is
21261 automatically skipped if any ancestor of the address that is being processed
21262 is the same as the current address and was processed by the current router.
21263 Such an address is therefore passed to the following routers, so it is handled
21264 as if there were no redirection. When making this loop-avoidance test, the
21265 complete local part, including any prefix or suffix, is used.
21266
21267 .cindex "address redirection" "local part without domain"
21268 Specifying the same local part without a domain is a common usage in personal
21269 filter files when the user wants to have messages delivered to the local
21270 mailbox and also forwarded elsewhere. For example, the user whose login is
21271 &'cleo'& might have a &_.forward_& file containing this:
21272 .code
21273 cleo, cleopatra@egypt.example
21274 .endd
21275 .cindex "backslash in alias file"
21276 .cindex "alias file" "backslash in"
21277 For compatibility with other MTAs, such unqualified local parts may be
21278 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21279 it does make a difference if more than one domain is being handled
21280 synonymously.
21281
21282 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21283 2822 address that does not include a domain, the item is qualified using the
21284 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21285 addresses are qualified using the value in &%qualify_recipient%&, but you can
21286 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21287
21288 Care must be taken if there are alias names for local users.
21289 Consider an MTA handling a single local domain where the system alias file
21290 contains:
21291 .code
21292 Sam.Reman: spqr
21293 .endd
21294 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21295 messages in the local mailbox, and also forward copies elsewhere. He creates
21296 this forward file:
21297 .code
21298 Sam.Reman, spqr@reme.elsewhere.example
21299 .endd
21300 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21301 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21302 second time round, because it has previously routed it,
21303 and the following routers presumably cannot handle the alias. The forward file
21304 should really contain
21305 .code
21306 spqr, spqr@reme.elsewhere.example
21307 .endd
21308 but because this is such a common error, the &%check_ancestor%& option (see
21309 below) exists to provide a way to get round it. This is normally set on a
21310 &(redirect)& router that is handling users' &_.forward_& files.
21311
21312
21313
21314 .section "Special items in redirection lists" "SECTspecitredli"
21315 In addition to addresses, the following types of item may appear in redirection
21316 lists (that is, in non-filter redirection data):
21317
21318 .ilist
21319 .cindex "pipe" "in redirection list"
21320 .cindex "address redirection" "to pipe"
21321 An item is treated as a pipe command if it begins with &"|"& and does not parse
21322 as a valid RFC 2822 address that includes a domain. A transport for running the
21323 command must be specified by the &%pipe_transport%& option.
21324 Normally, either the router or the transport specifies a user and a group under
21325 which to run the delivery. The default is to use the Exim user and group.
21326
21327 Single or double quotes can be used for enclosing the individual arguments of
21328 the pipe command; no interpretation of escapes is done for single quotes. If
21329 the command contains a comma character, it is necessary to put the whole item
21330 in double quotes, for example:
21331 .code
21332 "|/some/command ready,steady,go"
21333 .endd
21334 since items in redirection lists are terminated by commas. Do not, however,
21335 quote just the command. An item such as
21336 .code
21337 |"/some/command ready,steady,go"
21338 .endd
21339 is interpreted as a pipe with a rather strange command name, and no arguments.
21340
21341 Note that the above example assumes that the text comes from a lookup source
21342 of some sort, so that the quotes are part of the data.  If composing a
21343 redirect router with a &%data%& option directly specifying this command, the
21344 quotes will be used by the configuration parser to define the extent of one
21345 string, but will not be passed down into the redirect router itself.  There
21346 are two main approaches to get around this: escape quotes to be part of the
21347 data itself, or avoid using this mechanism and instead create a custom
21348 transport with the &%command%& option set and reference that transport from
21349 an &%accept%& router.
21350
21351 .next
21352 .cindex "file" "in redirection list"
21353 .cindex "address redirection" "to file"
21354 An item is interpreted as a path name if it begins with &"/"& and does not
21355 parse as a valid RFC 2822 address that includes a domain. For example,
21356 .code
21357 /home/world/minbari
21358 .endd
21359 is treated as a filename, but
21360 .code
21361 /s=molari/o=babylon/@x400gate.way
21362 .endd
21363 is treated as an address. For a filename, a transport must be specified using
21364 the &%file_transport%& option. However, if the generated path name ends with a
21365 forward slash character, it is interpreted as a directory name rather than a
21366 filename, and &%directory_transport%& is used instead.
21367
21368 Normally, either the router or the transport specifies a user and a group under
21369 which to run the delivery. The default is to use the Exim user and group.
21370
21371 .cindex "&_/dev/null_&"
21372 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21373 bypassed at a high level, and the log entry shows &"**bypassed**"&
21374 instead of a transport name. In this case the user and group are not used.
21375
21376 .next
21377 .cindex "included address list"
21378 .cindex "address redirection" "included external list"
21379 If an item is of the form
21380 .code
21381 :include:<path name>
21382 .endd
21383 a list of further items is taken from the given file and included at that
21384 point. &*Note*&: Such a file can not be a filter file; it is just an
21385 out-of-line addition to the list. The items in the included list are separated
21386 by commas or newlines and are not subject to expansion. If this is the first
21387 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21388 the alias name. This example is incorrect:
21389 .code
21390 list1    :include:/opt/lists/list1
21391 .endd
21392 It must be given as
21393 .code
21394 list1:   :include:/opt/lists/list1
21395 .endd
21396 .cindex "tainted data" "in filenames"
21397 .cindex redirect "tainted data"
21398 Tainted data may not be used for a filename.
21399 .next
21400 .cindex "address redirection" "to black hole"
21401 .cindex "delivery" "discard"
21402 .cindex "delivery" "blackhole"
21403 .cindex "black hole"
21404 .cindex "abandoning mail"
21405 Sometimes you want to throw away mail to a particular local part.  Making the
21406 &%data%& option expand to an empty string does not work, because that causes
21407 the router to decline. Instead, the alias item
21408 .code
21409 :blackhole:
21410 .endd
21411 can be used. It does what its name implies. No delivery is
21412 done, and no error message is generated. This has the same effect as specifying
21413 &_/dev/null_& as a destination, but it can be independently disabled.
21414
21415 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21416 delivery is done for the original local part, even if other redirection items
21417 are present. If you are generating a multi-item list (for example, by reading a
21418 database) and need the ability to provide a no-op item, you must use
21419 &_/dev/null_&.
21420
21421 .next
21422 .cindex "delivery" "forcing failure"
21423 .cindex "delivery" "forcing deferral"
21424 .cindex "failing delivery" "forcing"
21425 .cindex "deferred delivery, forcing"
21426 .cindex "customizing" "failure message"
21427 An attempt to deliver a particular address can be deferred or forced to fail by
21428 redirection items of the form
21429 .code
21430 :defer:
21431 :fail:
21432 .endd
21433 respectively. When a redirection list contains such an item, it applies
21434 to the entire redirection; any other items in the list are ignored. Any
21435 text following &':fail:'& or &':defer:'& is placed in the error text
21436 associated with the failure. For example, an alias file might contain:
21437 .code
21438 X.Employee:  :fail: Gone away, no forwarding address
21439 .endd
21440 In the case of an address that is being verified from an ACL or as the subject
21441 of a
21442 .cindex "VRFY" "error text, display of"
21443 VRFY command, the text is included in the SMTP error response by
21444 default.
21445 .cindex "EXPN" "error text, display of"
21446 The text is not included in the response to an EXPN command. In non-SMTP cases
21447 the text is included in the error message that Exim generates.
21448
21449 .cindex "SMTP" "error codes"
21450 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21451 &':fail:'&. However, if the message starts with three digits followed by a
21452 space, optionally followed by an extended code of the form &'n.n.n'&, also
21453 followed by a space, and the very first digit is the same as the default error
21454 code, the code from the message is used instead. If the very first digit is
21455 incorrect, a panic error is logged, and the default code is used. You can
21456 suppress the use of the supplied code in a redirect router by setting the
21457 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21458 ignored.
21459
21460 .vindex "&$acl_verify_message$&"
21461 In an ACL, an explicitly provided message overrides the default, but the
21462 default message is available in the variable &$acl_verify_message$& and can
21463 therefore be included in a custom message if this is desired.
21464
21465 Normally the error text is the rest of the redirection list &-- a comma does
21466 not terminate it &-- but a newline does act as a terminator. Newlines are not
21467 normally present in alias expansions. In &(lsearch)& lookups they are removed
21468 as part of the continuation process, but they may exist in other kinds of
21469 lookup and in &':include:'& files.
21470
21471 During routing for message delivery (as opposed to verification), a redirection
21472 containing &':fail:'& causes an immediate failure of the incoming address,
21473 whereas &':defer:'& causes the message to remain in the queue so that a
21474 subsequent delivery attempt can happen at a later time. If an address is
21475 deferred for too long, it will ultimately fail, because the normal retry
21476 rules still apply.
21477
21478 .next
21479 .cindex "alias file" "exception to default"
21480 Sometimes it is useful to use a single-key search type with a default (see
21481 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21482 for exceptions to the default. These can be handled by aliasing them to
21483 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21484 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21485 results in an empty redirection list has the same effect.
21486 .endlist
21487
21488
21489 .section "Duplicate addresses" "SECTdupaddr"
21490 .cindex "duplicate addresses"
21491 .cindex "address duplicate, discarding"
21492 .cindex "pipe" "duplicated"
21493 Exim removes duplicate addresses from the list to which it is delivering, so as
21494 to deliver just one copy to each address. This does not apply to deliveries
21495 routed to pipes by different immediate parent addresses, but an indirect
21496 aliasing scheme of the type
21497 .code
21498 pipe:       |/some/command $local_part
21499 localpart1: pipe
21500 localpart2: pipe
21501 .endd
21502 does not work with a message that is addressed to both local parts, because
21503 when the second is aliased to the intermediate local part &"pipe"& it gets
21504 discarded as being the same as a previously handled address. However, a scheme
21505 such as
21506 .code
21507 localpart1: |/some/command $local_part
21508 localpart2: |/some/command $local_part
21509 .endd
21510 does result in two different pipe deliveries, because the immediate parents of
21511 the pipes are distinct.
21512
21513
21514
21515 .section "Repeated redirection expansion" "SECID128"
21516 .cindex "repeated redirection expansion"
21517 .cindex "address redirection" "repeated for each delivery attempt"
21518 When a message cannot be delivered to all of its recipients immediately,
21519 leading to two or more delivery attempts, redirection expansion is carried out
21520 afresh each time for those addresses whose children were not all previously
21521 delivered. If redirection is being used as a mailing list, this can lead to new
21522 members of the list receiving copies of old messages. The &%one_time%& option
21523 can be used to avoid this.
21524
21525
21526 .section "Errors in redirection lists" "SECID129"
21527 .cindex "address redirection" "errors"
21528 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21529 error is skipped, and an entry is written to the main log. This may be useful
21530 for mailing lists that are automatically managed. Otherwise, if an error is
21531 detected while generating the list of new addresses, the original address is
21532 deferred. See also &%syntax_errors_to%&.
21533
21534
21535
21536 .section "Private options for the redirect router" "SECID130"
21537
21538 .cindex "options" "&(redirect)& router"
21539 The private options for the &(redirect)& router are as follows:
21540
21541
21542 .option allow_defer redirect boolean false
21543 Setting this option allows the use of &':defer:'& in non-filter redirection
21544 data, or the &%defer%& command in an Exim filter file.
21545
21546
21547 .option allow_fail redirect boolean false
21548 .cindex "failing delivery" "from filter"
21549 If this option is true, the &':fail:'& item can be used in a redirection list,
21550 and the &%fail%& command may be used in an Exim filter file.
21551
21552
21553 .option allow_filter redirect boolean false
21554 .cindex "filter" "enabling use of"
21555 .cindex "Sieve filter" "enabling use of"
21556 Setting this option allows Exim to interpret redirection data that starts with
21557 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21558 are some features of Exim filter files that some administrators may wish to
21559 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21560
21561 It is also possible to lock out Exim filters or Sieve filters while allowing
21562 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21563
21564
21565 The filter is run using the uid and gid set by the generic &%user%& and
21566 &%group%& options. These take their defaults from the password data if
21567 &%check_local_user%& is set, so in the normal case of users' personal filter
21568 files, the filter is run as the relevant user. When &%allow_filter%& is set
21569 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21570
21571
21572
21573 .option allow_freeze redirect boolean false
21574 .cindex "freezing messages" "allowing in filter"
21575 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21576 This command is more normally encountered in system filters, and is disabled by
21577 default for redirection filters because it isn't something you usually want to
21578 let ordinary users do.
21579
21580
21581
21582 .option check_ancestor redirect boolean false
21583 This option is concerned with handling generated addresses that are the same
21584 as some address in the list of redirection ancestors of the current address.
21585 Although it is turned off by default in the code, it is set in the default
21586 configuration file for handling users' &_.forward_& files. It is recommended
21587 for this use of the &(redirect)& router.
21588
21589 When &%check_ancestor%& is set, if a generated address (including the domain)
21590 is the same as any ancestor of the current address, it is replaced by a copy of
21591 the current address. This helps in the case where local part A is aliased to B,
21592 and B has a &_.forward_& file pointing back to A. For example, within a single
21593 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21594 &_&~jb/.forward_& contains:
21595 .code
21596 \Joe.Bloggs, <other item(s)>
21597 .endd
21598 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21599 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21600 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21601 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21602 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21603 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21604 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21605 original address. See also the &%repeat_use%& option below.
21606
21607
21608 .option check_group redirect boolean "see below"
21609 When the &%file%& option is used, the group owner of the file is checked only
21610 when this option is set. The permitted groups are those listed in the
21611 &%owngroups%& option, together with the user's default group if
21612 &%check_local_user%& is set. If the file has the wrong group, routing is
21613 deferred. The default setting for this option is true if &%check_local_user%&
21614 is set and the &%modemask%& option permits the group write bit, or if the
21615 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21616
21617
21618
21619 .option check_owner redirect boolean "see below"
21620 When the &%file%& option is used, the owner of the file is checked only when
21621 this option is set. If &%check_local_user%& is set, the local user is
21622 permitted; otherwise the owner must be one of those listed in the &%owners%&
21623 option. The default value for this option is true if &%check_local_user%& or
21624 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21625
21626
21627 .option data redirect string&!! unset
21628 This option is mutually exclusive with &%file%&. One or other of them must be
21629 set, but not both. The contents of &%data%& are expanded, and then used as the
21630 list of forwarding items, or as a set of filtering instructions. If the
21631 expansion is forced to fail, or the result is an empty string or a string that
21632 has no effect (consists entirely of comments), the router declines.
21633
21634 When filtering instructions are used, the string must begin with &"#Exim
21635 filter"&, and all comments in the string, including this initial one, must be
21636 terminated with newline characters. For example:
21637 .code
21638 data = #Exim filter\n\
21639        if $h_to: contains Exim then save $home/mail/exim endif
21640 .endd
21641 If you are reading the data from a database where newlines cannot be included,
21642 you can use the &${sg}$& expansion item to turn the escape string of your
21643 choice into a newline.
21644
21645
21646 .option directory_transport redirect string&!! unset
21647 A &(redirect)& router sets up a direct delivery to a directory when a path name
21648 ending with a slash is specified as a new &"address"&. The transport used is
21649 specified by this option, which, after expansion, must be the name of a
21650 configured transport. This should normally be an &(appendfile)& transport.
21651
21652
21653 .option file redirect string&!! unset
21654 This option specifies the name of a file that contains the redirection data. It
21655 is mutually exclusive with the &%data%& option. The string is expanded before
21656 use; if the expansion is forced to fail, the router declines. Other expansion
21657 failures cause delivery to be deferred. The result of a successful expansion
21658 must be an absolute path. The entire file is read and used as the redirection
21659 data. If the data is an empty string or a string that has no effect (consists
21660 entirely of comments), the router declines.
21661
21662 .cindex "NFS" "checking for file existence"
21663 If the attempt to open the file fails with a &"does not exist"& error, Exim
21664 runs a check on the containing directory,
21665 unless &%ignore_enotdir%& is true (see below).
21666 If the directory does not appear to exist, delivery is deferred. This can
21667 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21668 is a mount problem. If the containing directory does exist, but the file does
21669 not, the router declines.
21670
21671
21672 .option file_transport redirect string&!! unset
21673 .vindex "&$address_file$&"
21674 A &(redirect)& router sets up a direct delivery to a file when a path name not
21675 ending in a slash is specified as a new &"address"&. The transport used is
21676 specified by this option, which, after expansion, must be the name of a
21677 configured transport. This should normally be an &(appendfile)& transport. When
21678 it is running, the filename is in &$address_file$&.
21679
21680
21681 .option filter_prepend_home redirect boolean true
21682 When this option is true, if a &(save)& command in an Exim filter specifies a
21683 relative path, and &$home$& is defined, it is automatically prepended to the
21684 relative path. If this option is set false, this action does not happen. The
21685 relative path is then passed to the transport unmodified.
21686
21687
21688 .option forbid_blackhole redirect boolean false
21689 .cindex "restricting access to features"
21690 .cindex "filter" "locking out certain features"
21691 If this option is true, the &':blackhole:'& item may not appear in a
21692 redirection list.
21693
21694
21695 .option forbid_exim_filter redirect boolean false
21696 .cindex "restricting access to features"
21697 .cindex "filter" "locking out certain features"
21698 If this option is set true, only Sieve filters are permitted when
21699 &%allow_filter%& is true.
21700
21701
21702
21703
21704 .option forbid_file redirect boolean false
21705 .cindex "restricting access to features"
21706 .cindex "delivery" "to file; forbidding"
21707 .cindex "filter" "locking out certain features"
21708 .cindex "Sieve filter" "forbidding delivery to a file"
21709 .cindex "Sieve filter" "&""keep""& facility; disabling"
21710 If this option is true, this router may not generate a new address that
21711 specifies delivery to a local file or directory, either from a filter or from a
21712 conventional forward file. This option is forced to be true if &%one_time%& is
21713 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21714 locks out the Sieve's &"keep"& facility.
21715
21716
21717 .option forbid_filter_dlfunc redirect boolean false
21718 .cindex "restricting access to features"
21719 .cindex "filter" "locking out certain features"
21720 If this option is true, string expansions in Exim filters are not allowed to
21721 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21722 functions.
21723
21724 .option forbid_filter_existstest redirect boolean false
21725 .cindex "restricting access to features"
21726 .cindex "filter" "locking out certain features"
21727 .cindex "expansion" "statting a file"
21728 If this option is true, string expansions in Exim filters are not allowed to
21729 make use of the &%exists%& condition or the &%stat%& expansion item.
21730
21731 .option forbid_filter_logwrite redirect boolean false
21732 .cindex "restricting access to features"
21733 .cindex "filter" "locking out certain features"
21734 If this option is true, use of the logging facility in Exim filters is not
21735 permitted. Logging is in any case available only if the filter is being run
21736 under some unprivileged uid (which is normally the case for ordinary users'
21737 &_.forward_& files).
21738
21739
21740 .option forbid_filter_lookup redirect boolean false
21741 .cindex "restricting access to features"
21742 .cindex "filter" "locking out certain features"
21743 If this option is true, string expansions in Exim filter files are not allowed
21744 to make use of &%lookup%& items.
21745
21746
21747 .option forbid_filter_perl redirect boolean false
21748 .cindex "restricting access to features"
21749 .cindex "filter" "locking out certain features"
21750 This option has an effect only if Exim is built with embedded Perl support. If
21751 it is true, string expansions in Exim filter files are not allowed to make use
21752 of the embedded Perl support.
21753
21754
21755 .option forbid_filter_readfile redirect boolean false
21756 .cindex "restricting access to features"
21757 .cindex "filter" "locking out certain features"
21758 If this option is true, string expansions in Exim filter files are not allowed
21759 to make use of &%readfile%& items.
21760
21761
21762 .option forbid_filter_readsocket redirect boolean false
21763 .cindex "restricting access to features"
21764 .cindex "filter" "locking out certain features"
21765 If this option is true, string expansions in Exim filter files are not allowed
21766 to make use of &%readsocket%& items.
21767
21768
21769 .option forbid_filter_reply redirect boolean false
21770 .cindex "restricting access to features"
21771 .cindex "filter" "locking out certain features"
21772 If this option is true, this router may not generate an automatic reply
21773 message. Automatic replies can be generated only from Exim or Sieve filter
21774 files, not from traditional forward files. This option is forced to be true if
21775 &%one_time%& is set.
21776
21777
21778 .option forbid_filter_run redirect boolean false
21779 .cindex "restricting access to features"
21780 .cindex "filter" "locking out certain features"
21781 If this option is true, string expansions in Exim filter files are not allowed
21782 to make use of &%run%& items.
21783
21784
21785 .option forbid_include redirect boolean false
21786 .cindex "restricting access to features"
21787 .cindex "filter" "locking out certain features"
21788 If this option is true, items of the form
21789 .code
21790 :include:<path name>
21791 .endd
21792 are not permitted in non-filter redirection lists.
21793
21794
21795 .option forbid_pipe redirect boolean false
21796 .cindex "restricting access to features"
21797 .cindex "filter" "locking out certain features"
21798 .cindex "delivery" "to pipe; forbidding"
21799 If this option is true, this router may not generate a new address which
21800 specifies delivery to a pipe, either from an Exim filter or from a conventional
21801 forward file. This option is forced to be true if &%one_time%& is set.
21802
21803
21804 .option forbid_sieve_filter redirect boolean false
21805 .cindex "restricting access to features"
21806 .cindex "filter" "locking out certain features"
21807 If this option is set true, only Exim filters are permitted when
21808 &%allow_filter%& is true.
21809
21810
21811 .cindex "SMTP" "error codes"
21812 .option forbid_smtp_code redirect boolean false
21813 If this option is set true, any SMTP error codes that are present at the start
21814 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21815 the default codes (451 and 550, respectively) are always used.
21816
21817
21818
21819
21820 .option hide_child_in_errmsg redirect boolean false
21821 .cindex "bounce message" "redirection details; suppressing"
21822 If this option is true, it prevents Exim from quoting a child address if it
21823 generates a bounce or delay message for it. Instead it says &"an address
21824 generated from <&'the top level address'&>"&. Of course, this applies only to
21825 bounces generated locally. If a message is forwarded to another host, &'its'&
21826 bounce may well quote the generated address.
21827
21828
21829 .option ignore_eacces redirect boolean false
21830 .cindex "EACCES"
21831 If this option is set and an attempt to open a redirection file yields the
21832 EACCES error (permission denied), the &(redirect)& router behaves as if the
21833 file did not exist.
21834
21835
21836 .option ignore_enotdir redirect boolean false
21837 .cindex "ENOTDIR"
21838 If this option is set and an attempt to open a redirection file yields the
21839 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21840 router behaves as if the file did not exist.
21841
21842 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21843 router that has the &%file%& option set discovers that the file does not exist
21844 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21845 against unmounted NFS directories. If the parent can not be statted, delivery
21846 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21847 is set, because that option tells Exim to ignore &"something on the path is not
21848 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21849 that some operating systems give ENOENT where others give ENOTDIR.
21850
21851
21852
21853 .option include_directory redirect string unset
21854 If this option is set, the path names of any &':include:'& items in a
21855 redirection list must start with this directory.
21856
21857
21858 .option modemask redirect "octal integer" 022
21859 This specifies mode bits which must not be set for a file specified by the
21860 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21861
21862
21863 .option one_time redirect boolean false
21864 .cindex "one-time aliasing/forwarding expansion"
21865 .cindex "alias file" "one-time expansion"
21866 .cindex "forward file" "one-time expansion"
21867 .cindex "mailing lists" "one-time expansion"
21868 .cindex "address redirection" "one-time expansion"
21869 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21870 files each time it tries to deliver a message causes a problem when one or more
21871 of the generated addresses fails be delivered at the first attempt. The problem
21872 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21873 but of what happens when the redirection list changes during the time that the
21874 message is on Exim's queue. This is particularly true in the case of mailing
21875 lists, where new subscribers might receive copies of messages that were posted
21876 before they subscribed.
21877
21878 If &%one_time%& is set and any addresses generated by the router fail to
21879 deliver at the first attempt, the failing addresses are added to the message as
21880 &"top level"& addresses, and the parent address that generated them is marked
21881 &"delivered"&. Thus, redirection does not happen again at the next delivery
21882 attempt.
21883
21884 &*Warning 1*&: Any header line addition or removal that is specified by this
21885 router would be lost if delivery did not succeed at the first attempt. For this
21886 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21887 permitted when &%one_time%& is set.
21888
21889 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21890 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21891 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21892
21893 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21894 &%one_time%&.
21895
21896 The original top-level address is remembered with each of the generated
21897 addresses, and is output in any log messages. However, any intermediate parent
21898 addresses are not recorded. This makes a difference to the log only if
21899 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21900 typically be used for mailing lists, where there is normally just one level of
21901 expansion.
21902
21903
21904 .option owners redirect "string list" unset
21905 .cindex "ownership" "alias file"
21906 .cindex "ownership" "forward file"
21907 .cindex "alias file" "ownership"
21908 .cindex "forward file" "ownership"
21909 This specifies a list of permitted owners for the file specified by &%file%&.
21910 This list is in addition to the local user when &%check_local_user%& is set.
21911 See &%check_owner%& above.
21912
21913
21914 .option owngroups redirect "string list" unset
21915 This specifies a list of permitted groups for the file specified by &%file%&.
21916 The list is in addition to the local user's primary group when
21917 &%check_local_user%& is set. See &%check_group%& above.
21918
21919
21920 .option pipe_transport redirect string&!! unset
21921 .vindex "&$address_pipe$&"
21922 A &(redirect)& router sets up a direct delivery to a pipe when a string
21923 starting with a vertical bar character is specified as a new &"address"&. The
21924 transport used is specified by this option, which, after expansion, must be the
21925 name of a configured transport. This should normally be a &(pipe)& transport.
21926 When the transport is run, the pipe command is in &$address_pipe$&.
21927
21928
21929 .option qualify_domain redirect string&!! unset
21930 .vindex "&$qualify_recipient$&"
21931 If this option is set, and an unqualified address (one without a domain) is
21932 generated, and that address would normally be qualified by the global setting
21933 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21934 expanding this string. If the expansion fails, the router declines. If you want
21935 to revert to the default, you can have the expansion generate
21936 &$qualify_recipient$&.
21937
21938 This option applies to all unqualified addresses generated by Exim filters,
21939 but for traditional &_.forward_& files, it applies only to addresses that are
21940 not preceded by a backslash. Sieve filters cannot generate unqualified
21941 addresses.
21942
21943 .option qualify_preserve_domain redirect boolean false
21944 .cindex "domain" "in redirection; preserving"
21945 .cindex "preserving domain in redirection"
21946 .cindex "address redirection" "domain; preserving"
21947 If this option is set, the router's local &%qualify_domain%& option must not be
21948 set (a configuration error occurs if it is). If an unqualified address (one
21949 without a domain) is generated, it is qualified with the domain of the parent
21950 address (the immediately preceding ancestor) instead of the global
21951 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21952 this applies whether or not the address is preceded by a backslash.
21953
21954
21955 .option repeat_use redirect boolean true
21956 If this option is set false, the router is skipped for a child address that has
21957 any ancestor that was routed by this router. This test happens before any of
21958 the other preconditions are tested. Exim's default anti-looping rules skip
21959 only when the ancestor is the same as the current address. See also
21960 &%check_ancestor%& above and the generic &%redirect_router%& option.
21961
21962
21963 .option reply_transport redirect string&!! unset
21964 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21965 &%vacation%& command is used in a filter file. The transport used is specified
21966 by this option, which, after expansion, must be the name of a configured
21967 transport. This should normally be an &(autoreply)& transport. Other transports
21968 are unlikely to do anything sensible or useful.
21969
21970
21971 .option rewrite redirect boolean true
21972 .cindex "address redirection" "disabling rewriting"
21973 If this option is set false, addresses generated by the router are not
21974 subject to address rewriting. Otherwise, they are treated like new addresses
21975 and are rewritten according to the global rewriting rules.
21976
21977
21978 .option sieve_subaddress redirect string&!! unset
21979 The value of this option is passed to a Sieve filter to specify the
21980 :subaddress part of an address.
21981
21982 .option sieve_useraddress redirect string&!! unset
21983 The value of this option is passed to a Sieve filter to specify the :user part
21984 of an address. However, if it is unset, the entire original local part
21985 (including any prefix or suffix) is used for :user.
21986
21987
21988 .option sieve_vacation_directory redirect string&!! unset
21989 .cindex "Sieve filter" "vacation directory"
21990 To enable the &"vacation"& extension for Sieve filters, you must set
21991 &%sieve_vacation_directory%& to the directory where vacation databases are held
21992 (do not put anything else in that directory), and ensure that the
21993 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21994 needs their own directory; Exim will create it if necessary.
21995
21996
21997
21998 .option skip_syntax_errors redirect boolean false
21999 .cindex "forward file" "broken"
22000 .cindex "address redirection" "broken files"
22001 .cindex "alias file" "broken"
22002 .cindex "broken alias or forward files"
22003 .cindex "ignoring faulty addresses"
22004 .cindex "skipping faulty addresses"
22005 .cindex "error" "skipping bad syntax"
22006 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22007 non-filter redirection data are skipped, and each failing address is logged. If
22008 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22009 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22010 are expanded and placed at the head of the error message generated by
22011 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22012 be the same address as the generic &%errors_to%& option. The
22013 &%skip_syntax_errors%& option is often used when handling mailing lists.
22014
22015 If all the addresses in a redirection list are skipped because of syntax
22016 errors, the router declines to handle the original address, and it is passed to
22017 the following routers.
22018
22019 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22020 error in the filter causes filtering to be abandoned without any action being
22021 taken. The incident is logged, and the router declines to handle the address,
22022 so it is passed to the following routers.
22023
22024 .cindex "Sieve filter" "syntax errors in"
22025 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22026 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22027 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22028
22029 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22030 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22031 option, used with an address that does not get redirected, can be used to
22032 notify users of these errors, by means of a router like this:
22033 .code
22034 userforward:
22035   driver = redirect
22036   allow_filter
22037   check_local_user
22038   file = $home/.forward
22039   file_transport = address_file
22040   pipe_transport = address_pipe
22041   reply_transport = address_reply
22042   no_verify
22043   skip_syntax_errors
22044   syntax_errors_to = real-$local_part@$domain
22045   syntax_errors_text = \
22046    This is an automatically generated message. An error has\n\
22047    been found in your .forward file. Details of the error are\n\
22048    reported below. While this error persists, you will receive\n\
22049    a copy of this message for every message that is addressed\n\
22050    to you. If your .forward file is a filter file, or if it is\n\
22051    a non-filter file containing no valid forwarding addresses,\n\
22052    a copy of each incoming message will be put in your normal\n\
22053    mailbox. If a non-filter file contains at least one valid\n\
22054    forwarding address, forwarding to the valid addresses will\n\
22055    happen, and those will be the only deliveries that occur.
22056 .endd
22057 You also need a router to ensure that local addresses that are prefixed by
22058 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22059 put this immediately before the &(userforward)& router:
22060 .code
22061 real_localuser:
22062   driver = accept
22063   check_local_user
22064   local_part_prefix = real-
22065   transport = local_delivery
22066 .endd
22067 For security, it would probably be a good idea to restrict the use of this
22068 router to locally-generated messages, using a condition such as this:
22069 .code
22070   condition = ${if match {$sender_host_address}\
22071                          {\N^(|127\.0\.0\.1)$\N}}
22072 .endd
22073
22074
22075 .option syntax_errors_text redirect string&!! unset
22076 See &%skip_syntax_errors%& above.
22077
22078
22079 .option syntax_errors_to redirect string unset
22080 See &%skip_syntax_errors%& above.
22081 .ecindex IIDredrou1
22082 .ecindex IIDredrou2
22083
22084
22085
22086
22087
22088
22089 . ////////////////////////////////////////////////////////////////////////////
22090 . ////////////////////////////////////////////////////////////////////////////
22091
22092 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22093          "Environment for local transports"
22094 .scindex IIDenvlotra1 "local transports" "environment for"
22095 .scindex IIDenvlotra2 "environment" "local transports"
22096 .scindex IIDenvlotra3 "transport" "local; environment for"
22097 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22098 transport can be thought of as similar to a pipe.) Exim always runs transports
22099 in subprocesses, under specified uids and gids. Typical deliveries to local
22100 mailboxes run under the uid and gid of the local user.
22101
22102 Exim also sets a specific current directory while running the transport; for
22103 some transports a home directory setting is also relevant. The &(pipe)&
22104 transport is the only one that sets up environment variables; see section
22105 &<<SECTpipeenv>>& for details.
22106
22107 The values used for the uid, gid, and the directories may come from several
22108 different places. In many cases, the router that handles the address associates
22109 settings with that address as a result of its &%check_local_user%&, &%group%&,
22110 or &%user%& options. However, values may also be given in the transport's own
22111 configuration, and these override anything that comes from the router.
22112
22113
22114
22115 .section "Concurrent deliveries" "SECID131"
22116 .cindex "concurrent deliveries"
22117 .cindex "simultaneous deliveries"
22118 If two different messages for the same local recipient arrive more or less
22119 simultaneously, the two delivery processes are likely to run concurrently. When
22120 the &(appendfile)& transport is used to write to a file, Exim applies locking
22121 rules to stop concurrent processes from writing to the same file at the same
22122 time.
22123
22124 However, when you use a &(pipe)& transport, it is up to you to arrange any
22125 locking that is needed. Here is a silly example:
22126 .code
22127 my_transport:
22128   driver = pipe
22129   command = /bin/sh -c 'cat >>/some/file'
22130 .endd
22131 This is supposed to write the message at the end of the file. However, if two
22132 messages arrive at the same time, the file will be scrambled. You can use the
22133 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22134 file using the same algorithm that Exim itself uses.
22135
22136
22137
22138
22139 .section "Uids and gids" "SECTenvuidgid"
22140 .cindex "local transports" "uid and gid"
22141 .cindex "transport" "local; uid and gid"
22142 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22143 overrides any group that the router set in the address, even if &%user%& is not
22144 set for the transport. This makes it possible, for example, to run local mail
22145 delivery under the uid of the recipient (set by the router), but in a special
22146 group (set by the transport). For example:
22147 .code
22148 # Routers ...
22149 # User/group are set by check_local_user in this router
22150 local_users:
22151   driver = accept
22152   check_local_user
22153   transport = group_delivery
22154
22155 # Transports ...
22156 # This transport overrides the group
22157 group_delivery:
22158   driver = appendfile
22159   file = /var/spool/mail/$local_part_data
22160   group = mail
22161 .endd
22162 If &%user%& is set for a transport, its value overrides what is set in the
22163 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22164 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22165 set.
22166
22167 .oindex "&%initgroups%&"
22168 When the uid is taken from the transport's configuration, the &[initgroups()]&
22169 function is called for the groups associated with that uid if the
22170 &%initgroups%& option is set for the transport. When the uid is not specified
22171 by the transport, but is associated with the address by a router, the option
22172 for calling &[initgroups()]& is taken from the router configuration.
22173
22174 .cindex "&(pipe)& transport" "uid for"
22175 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22176 is set and &%user%& is not set, the uid of the process that called Exim to
22177 receive the message is used, and if &%group%& is not set, the corresponding
22178 original gid is also used.
22179
22180 This is the detailed preference order for obtaining a gid; the first of the
22181 following that is set is used:
22182
22183 .ilist
22184 A &%group%& setting of the transport;
22185 .next
22186 A &%group%& setting of the router;
22187 .next
22188 A gid associated with a user setting of the router, either as a result of
22189 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22190 .next
22191 The group associated with a non-numeric &%user%& setting of the transport;
22192 .next
22193 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22194 the uid is the creator's uid;
22195 .next
22196 The Exim gid if the Exim uid is being used as a default.
22197 .endlist
22198
22199 If, for example, the user is specified numerically on the router and there are
22200 no group settings, no gid is available. In this situation, an error occurs.
22201 This is different for the uid, for which there always is an ultimate default.
22202 The first of the following that is set is used:
22203
22204 .ilist
22205 A &%user%& setting of the transport;
22206 .next
22207 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22208 .next
22209 A &%user%& setting of the router;
22210 .next
22211 A &%check_local_user%& setting of the router;
22212 .next
22213 The Exim uid.
22214 .endlist
22215
22216 Of course, an error will still occur if the uid that is chosen is on the
22217 &%never_users%& list.
22218
22219
22220
22221
22222
22223 .section "Current and home directories" "SECID132"
22224 .cindex "current directory for local transport"
22225 .cindex "home directory" "for local transport"
22226 .cindex "transport" "local; home directory for"
22227 .cindex "transport" "local; current directory for"
22228 Routers may set current and home directories for local transports by means of
22229 the &%transport_current_directory%& and &%transport_home_directory%& options.
22230 However, if the transport's &%current_directory%& or &%home_directory%& options
22231 are set, they override the router's values. In detail, the home directory
22232 for a local transport is taken from the first of these values that is set:
22233
22234 .ilist
22235 The &%home_directory%& option on the transport;
22236 .next
22237 The &%transport_home_directory%& option on the router;
22238 .next
22239 The password data if &%check_local_user%& is set on the router;
22240 .next
22241 The &%router_home_directory%& option on the router.
22242 .endlist
22243
22244 The current directory is taken from the first of these values that is set:
22245
22246 .ilist
22247 The &%current_directory%& option on the transport;
22248 .next
22249 The &%transport_current_directory%& option on the router.
22250 .endlist
22251
22252
22253 If neither the router nor the transport sets a current directory, Exim uses the
22254 value of the home directory, if it is set. Otherwise it sets the current
22255 directory to &_/_& before running a local transport.
22256
22257
22258
22259 .section "Expansion variables derived from the address" "SECID133"
22260 .vindex "&$domain$&"
22261 .vindex "&$local_part$&"
22262 .vindex "&$original_domain$&"
22263 Normally a local delivery is handling a single address, and in that case the
22264 variables such as &$domain$& and &$local_part$& are set during local
22265 deliveries. However, in some circumstances more than one address may be handled
22266 at once (for example, while writing batch SMTP for onward transmission by some
22267 other means). In this case, the variables associated with the local part are
22268 never set, &$domain$& is set only if all the addresses have the same domain,
22269 and &$original_domain$& is never set.
22270 .ecindex IIDenvlotra1
22271 .ecindex IIDenvlotra2
22272 .ecindex IIDenvlotra3
22273
22274
22275
22276
22277
22278
22279
22280 . ////////////////////////////////////////////////////////////////////////////
22281 . ////////////////////////////////////////////////////////////////////////////
22282
22283 .chapter "Generic options for transports" "CHAPtransportgeneric"
22284 .scindex IIDgenoptra1 "generic options" "transport"
22285 .scindex IIDgenoptra2 "options" "generic; for transports"
22286 .scindex IIDgenoptra3 "transport" "generic options for"
22287 The following generic options apply to all transports:
22288
22289
22290 .option body_only transports boolean false
22291 .cindex "transport" "body only"
22292 .cindex "message" "transporting body only"
22293 .cindex "body of message" "transporting"
22294 If this option is set, the message's headers are not transported. It is
22295 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22296 or &(pipe)& transports, the settings of &%message_prefix%& and
22297 &%message_suffix%& should be checked, because this option does not
22298 automatically suppress them.
22299
22300
22301 .option current_directory transports string&!! unset
22302 .cindex "transport" "current directory for"
22303 This specifies the current directory that is to be set while running the
22304 transport, overriding any value that may have been set by the router.
22305 If the expansion fails for any reason, including forced failure, an error is
22306 logged, and delivery is deferred.
22307
22308
22309 .option disable_logging transports boolean false
22310 If this option is set true, nothing is logged for any
22311 deliveries by the transport or for any
22312 transport errors. You should not set this option unless you really, really know
22313 what you are doing.
22314
22315
22316 .option debug_print transports string&!! unset
22317 .cindex "testing" "variables in drivers"
22318 If this option is set and debugging is enabled (see the &%-d%& command line
22319 option), the string is expanded and included in the debugging output when the
22320 transport is run.
22321 If expansion of the string fails, the error message is written to the debugging
22322 output, and Exim carries on processing.
22323 This facility is provided to help with checking out the values of variables and
22324 so on when debugging driver configurations. For example, if a &%headers_add%&
22325 option is not working properly, &%debug_print%& could be used to output the
22326 variables it references. A newline is added to the text if it does not end with
22327 one.
22328 The variables &$transport_name$& and &$router_name$& contain the name of the
22329 transport and the router that called it.
22330
22331 .option delivery_date_add transports boolean false
22332 .cindex "&'Delivery-date:'& header line"
22333 If this option is true, a &'Delivery-date:'& header is added to the message.
22334 This gives the actual time the delivery was made. As this is not a standard
22335 header, Exim has a configuration option (&%delivery_date_remove%&) which
22336 requests its removal from incoming messages, so that delivered messages can
22337 safely be resent to other recipients.
22338
22339
22340 .option driver transports string unset
22341 This specifies which of the available transport drivers is to be used.
22342 There is no default, and this option must be set for every transport.
22343
22344
22345 .option envelope_to_add transports boolean false
22346 .cindex "&'Envelope-to:'& header line"
22347 If this option is true, an &'Envelope-to:'& header is added to the message.
22348 This gives the original address(es) in the incoming envelope that caused this
22349 delivery to happen. More than one address may be present if the transport is
22350 configured to handle several addresses at once, or if more than one original
22351 address was redirected to the same final address. As this is not a standard
22352 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22353 its removal from incoming messages, so that delivered messages can safely be
22354 resent to other recipients.
22355
22356
22357 .option event_action transports string&!! unset
22358 .cindex events
22359 This option declares a string to be expanded for Exim's events mechanism.
22360 For details see chapter &<<CHAPevents>>&.
22361
22362
22363 .option group transports string&!! "Exim group"
22364 .cindex "transport" "group; specifying"
22365 This option specifies a gid for running the transport process, overriding any
22366 value that the router supplies, and also overriding any value associated with
22367 &%user%& (see below).
22368
22369
22370 .option headers_add transports list&!! unset
22371 .cindex "header lines" "adding in transport"
22372 .cindex "transport" "header lines; adding"
22373 This option specifies a list of text headers,
22374 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22375 which are (separately) expanded and added to the header
22376 portion of a message as it is transported, as described in section
22377 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22378 routers. If the result of the expansion is an empty string, or if the expansion
22379 is forced to fail, no action is taken. Other expansion failures are treated as
22380 errors and cause the delivery to be deferred.
22381
22382 Unlike most options, &%headers_add%& can be specified multiple times
22383 for a transport; all listed headers are added.
22384
22385
22386 .option headers_only transports boolean false
22387 .cindex "transport" "header lines only"
22388 .cindex "message" "transporting headers only"
22389 .cindex "header lines" "transporting"
22390 If this option is set, the message's body is not transported. It is mutually
22391 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22392 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22393 checked, since this option does not automatically suppress them.
22394
22395
22396 .option headers_remove transports list&!! unset
22397 .cindex "header lines" "removing"
22398 .cindex "transport" "header lines; removing"
22399 This option specifies a list of text headers,
22400 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22401 to be removed from the message.
22402 However, the option has no effect when an address is just being verified.
22403 Each list item is separately expanded.
22404 If the result of the expansion is an empty string, or if the expansion
22405 is forced to fail, no action is taken. Other expansion failures are treated as
22406 errors and cause the delivery to be deferred.
22407 If an item ends in *, it will match any header with the given prefix.
22408
22409 Matching headers are omitted from the message as it is transported, as described
22410 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22411 routers.
22412
22413 Unlike most options, &%headers_remove%& can be specified multiple times
22414 for a transport; all listed headers are removed.
22415
22416 &*Warning*&: Because of the separate expansion of the list items,
22417 items that contain a list separator must have it doubled.
22418 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22419
22420
22421
22422 .option headers_rewrite transports string unset
22423 .cindex "transport" "header lines; rewriting"
22424 .cindex "rewriting" "at transport time"
22425 This option allows addresses in header lines to be rewritten at transport time,
22426 that is, as the message is being copied to its destination. The contents of the
22427 option are a colon-separated list of rewriting rules. Each rule is in exactly
22428 the same form as one of the general rewriting rules that are applied when a
22429 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22430 example,
22431 .code
22432 headers_rewrite = a@b c@d f : \
22433                   x@y w@z
22434 .endd
22435 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22436 &'w@z'& in all address-bearing header lines. The rules are applied to the
22437 header lines just before they are written out at transport time, so they affect
22438 only those copies of the message that pass through the transport. However, only
22439 the message's original header lines, and any that were added by a system
22440 filter, are rewritten. If a router or transport adds header lines, they are not
22441 affected by this option. These rewriting rules are &'not'& applied to the
22442 envelope. You can change the return path using &%return_path%&, but you cannot
22443 change envelope recipients at this time.
22444
22445
22446 .option home_directory transports string&!! unset
22447 .cindex "transport" "home directory for"
22448 .vindex "&$home$&"
22449 This option specifies a home directory setting for a local transport,
22450 overriding any value that may be set by the router. The home directory is
22451 placed in &$home$& while expanding the transport's private options. It is also
22452 used as the current directory if no current directory is set by the
22453 &%current_directory%& option on the transport or the
22454 &%transport_current_directory%& option on the router. If the expansion fails
22455 for any reason, including forced failure, an error is logged, and delivery is
22456 deferred.
22457
22458
22459 .option initgroups transports boolean false
22460 .cindex "additional groups"
22461 .cindex "groups" "additional"
22462 .cindex "transport" "group; additional"
22463 If this option is true and the uid for the delivery process is provided by the
22464 transport, the &[initgroups()]& function is called when running the transport
22465 to ensure that any additional groups associated with the uid are set up.
22466
22467
22468 .option max_parallel transports integer&!! unset
22469 .cindex limit "transport parallelism"
22470 .cindex transport "parallel processes"
22471 .cindex transport "concurrency limit"
22472 .cindex "delivery" "parallelism for transport"
22473 If this option is set and expands to an integer greater than zero
22474 it limits the number of concurrent runs of the transport.
22475 The control does not apply to shadow transports.
22476
22477 .cindex "hints database" "transport concurrency control"
22478 Exim implements this control by means of a hints database in which a record is
22479 incremented whenever a transport process is being created. The record
22480 is decremented and possibly removed when the process terminates.
22481 Obviously there is scope for
22482 records to get left lying around if there is a system or program crash. To
22483 guard against this, Exim ignores any records that are more than six hours old.
22484
22485 If you use this option, you should also arrange to delete the
22486 relevant hints database whenever your system reboots. The names of the files
22487 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22488 may be one or two files, depending on the type of DBM in use. The same files
22489 are used for ETRN and smtp transport serialization.
22490
22491
22492 .option message_size_limit transports string&!! 0
22493 .cindex "limit" "message size per transport"
22494 .cindex "size" "of message, limit"
22495 .cindex "transport" "message size; limiting"
22496 This option controls the size of messages passed through the transport. It is
22497 expanded before use; the result of the expansion must be a sequence of decimal
22498 digits, optionally followed by K or M. If the expansion fails for any reason,
22499 including forced failure, or if the result is not of the required form,
22500 delivery is deferred. If the value is greater than zero and the size of a
22501 message exceeds this limit, the address is failed. If there is any chance that
22502 the resulting bounce message could be routed to the same transport, you should
22503 ensure that &%return_size_limit%& is less than the transport's
22504 &%message_size_limit%&, as otherwise the bounce message will fail to get
22505 delivered.
22506
22507
22508
22509 .option rcpt_include_affixes transports boolean false
22510 .cindex "prefix" "for local part, including in envelope"
22511 .cindex "suffix for local part" "including in envelope"
22512 .cindex "local part" "prefix"
22513 .cindex "local part" "suffix"
22514 When this option is false (the default), and an address that has had any
22515 affixes (prefixes or suffixes) removed from the local part is delivered by any
22516 form of SMTP or LMTP, the affixes are not included. For example, if a router
22517 that contains
22518 .code
22519 local_part_prefix = *-
22520 .endd
22521 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22522 is delivered with
22523 .code
22524 RCPT TO:<xyz@some.domain>
22525 .endd
22526 This is also the case when an ACL-time callout is being used to verify a
22527 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22528 whole local part is included in the RCPT command. This option applies to BSMTP
22529 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22530 &(lmtp)& and &(smtp)& transports.
22531
22532
22533 .option retry_use_local_part transports boolean "see below"
22534 .cindex "hints database" "retry keys"
22535 When a delivery suffers a temporary failure, a retry record is created
22536 in Exim's hints database. For remote deliveries, the key for the retry record
22537 is based on the name and/or IP address of the failing remote host. For local
22538 deliveries, the key is normally the entire address, including both the local
22539 part and the domain. This is suitable for most common cases of local delivery
22540 temporary failure &-- for example, exceeding a mailbox quota should delay only
22541 deliveries to that mailbox, not to the whole domain.
22542
22543 However, in some special cases you may want to treat a temporary local delivery
22544 as a failure associated with the domain, and not with a particular local part.
22545 (For example, if you are storing all mail for some domain in files.) You can do
22546 this by setting &%retry_use_local_part%& false.
22547
22548 For all the local transports, its default value is true. For remote transports,
22549 the default value is false for tidiness, but changing the value has no effect
22550 on a remote transport in the current implementation.
22551
22552
22553 .option return_path transports string&!! unset
22554 .cindex "envelope sender"
22555 .cindex "envelope from"
22556 .cindex "transport" "return path; changing"
22557 .cindex "return path" "changing in transport"
22558 If this option is set, the string is expanded at transport time and replaces
22559 the existing return path (envelope sender) value in the copy of the message
22560 that is being delivered. An empty return path is permitted. This feature is
22561 designed for remote deliveries, where the value of this option is used in the
22562 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22563 only effect is to change the address that is placed in the &'Return-path:'&
22564 header line, if one is added to the message (see the next option).
22565
22566 &*Note:*& A changed return path is not logged unless you add
22567 &%return_path_on_delivery%& to the log selector.
22568
22569 .vindex "&$return_path$&"
22570 The expansion can refer to the existing value via &$return_path$&. This is
22571 either the message's envelope sender, or an address set by the
22572 &%errors_to%& option on a router. If the expansion is forced to fail, no
22573 replacement occurs; if it fails for another reason, delivery is deferred. This
22574 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22575 section &<<SECTverp>>&.
22576
22577 &*Note*&: If a delivery error is detected locally, including the case when a
22578 remote server rejects a message at SMTP time, the bounce message is not sent to
22579 the value of this option. It is sent to the previously set errors address.
22580 This defaults to the incoming sender address, but can be changed by setting
22581 &%errors_to%& in a router.
22582
22583
22584
22585 .option return_path_add transports boolean false
22586 .cindex "&'Return-path:'& header line"
22587 If this option is true, a &'Return-path:'& header is added to the message.
22588 Although the return path is normally available in the prefix line of BSD
22589 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22590 have easy access to it.
22591
22592 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22593 the delivery SMTP server makes the final delivery"&. This implies that this
22594 header should not be present in incoming messages. Exim has a configuration
22595 option, &%return_path_remove%&, which requests removal of this header from
22596 incoming messages, so that delivered messages can safely be resent to other
22597 recipients.
22598
22599
22600 .option shadow_condition transports string&!! unset
22601 See &%shadow_transport%& below.
22602
22603
22604 .option shadow_transport transports string unset
22605 .cindex "shadow transport"
22606 .cindex "transport" "shadow"
22607 A local transport may set the &%shadow_transport%& option to the name of
22608 another local transport. Shadow remote transports are not supported.
22609
22610 Whenever a delivery to the main transport succeeds, and either
22611 &%shadow_condition%& is unset, or its expansion does not result in the empty
22612 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22613 passed to the shadow transport, with the same delivery address or addresses. If
22614 expansion fails, no action is taken except that non-forced expansion failures
22615 cause a log line to be written.
22616
22617 The result of the shadow transport is discarded and does not affect the
22618 subsequent processing of the message. Only a single level of shadowing is
22619 provided; the &%shadow_transport%& option is ignored on any transport when it
22620 is running as a shadow. Options concerned with output from pipes are also
22621 ignored. The log line for the successful delivery has an item added on the end,
22622 of the form
22623 .code
22624 ST=<shadow transport name>
22625 .endd
22626 If the shadow transport did not succeed, the error message is put in
22627 parentheses afterwards. Shadow transports can be used for a number of different
22628 purposes, including keeping more detailed log information than Exim normally
22629 provides, and implementing automatic acknowledgment policies based on message
22630 headers that some sites insist on.
22631
22632
22633 .option transport_filter transports string&!! unset
22634 .cindex "transport" "filter"
22635 .cindex "filter" "transport filter"
22636 This option sets up a filtering (in the Unix shell sense) process for messages
22637 at transport time. It should not be confused with mail filtering as set up by
22638 individual users or via a system filter.
22639 If unset, or expanding to an empty string, no filtering is done.
22640
22641 When the message is about to be written out, the command specified by
22642 &%transport_filter%& is started up in a separate, parallel process, and
22643 the entire message, including the header lines, is passed to it on its standard
22644 input (this in fact is done from a third process, to avoid deadlock). The
22645 command must be specified as an absolute path.
22646
22647 The lines of the message that are written to the transport filter are
22648 terminated by newline (&"\n"&). The message is passed to the filter before any
22649 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22650 lines beginning with a dot, and also before any processing implied by the
22651 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22652 &(pipe)& transports.
22653
22654 The standard error for the filter process is set to the same destination as its
22655 standard output; this is read and written to the message's ultimate
22656 destination. The process that writes the message to the filter, the
22657 filter itself, and the original process that reads the result and delivers it
22658 are all run in parallel, like a shell pipeline.
22659
22660 The filter can perform any transformations it likes, but of course should take
22661 care not to break RFC 2822 syntax. Exim does not check the result, except to
22662 test for a final newline when SMTP is in use. All messages transmitted over
22663 SMTP must end with a newline, so Exim supplies one if it is missing.
22664
22665 .cindex "content scanning" "per user"
22666 A transport filter can be used to provide content-scanning on a per-user basis
22667 at delivery time if the only required effect of the scan is to modify the
22668 message. For example, a content scan could insert a new header line containing
22669 a spam score. This could be interpreted by a filter in the user's MUA. It is
22670 not possible to discard a message at this stage.
22671
22672 .cindex "SIZE" "ESMTP extension"
22673 A problem might arise if the filter increases the size of a message that is
22674 being sent down an SMTP connection. If the receiving SMTP server has indicated
22675 support for the SIZE parameter, Exim will have sent the size of the message
22676 at the start of the SMTP session. If what is actually sent is substantially
22677 more, the server might reject the message. This can be worked round by setting
22678 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22679 additions to the message, or to disable the use of SIZE altogether.
22680
22681 .vindex "&$pipe_addresses$&"
22682 The value of the &%transport_filter%& option is the command string for starting
22683 the filter, which is run directly from Exim, not under a shell. The string is
22684 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22685 Exim breaks it up into arguments and then expands each argument separately (see
22686 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22687 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22688 of arguments, one for each address that applies to this delivery. (This isn't
22689 an ideal name for this feature here, but as it was already implemented for the
22690 &(pipe)& transport, it seemed sensible not to change it.)
22691
22692 .vindex "&$host$&"
22693 .vindex "&$host_address$&"
22694 The expansion variables &$host$& and &$host_address$& are available when the
22695 transport is a remote one. They contain the name and IP address of the host to
22696 which the message is being sent. For example:
22697 .code
22698 transport_filter = /some/directory/transport-filter.pl \
22699   $host $host_address $sender_address $pipe_addresses
22700 .endd
22701
22702 Two problems arise if you want to use more complicated expansion items to
22703 generate transport filter commands, both of which due to the fact that the
22704 command is split up &'before'& expansion.
22705 .ilist
22706 If an expansion item contains white space, you must quote it, so that it is all
22707 part of the same command item. If the entire option setting is one such
22708 expansion item, you have to take care what kind of quoting you use. For
22709 example:
22710 .code
22711 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22712 .endd
22713 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22714 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22715 stripped by Exim when it read the option's value. When the value is used, if
22716 the single quotes were missing, the line would be split into two items,
22717 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22718 Exim tried to expand the first one.
22719 .next
22720 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22721 expansion cannot generate multiple arguments, or a command name followed by
22722 arguments. Consider this example:
22723 .code
22724 transport_filter = ${lookup{$host}lsearch{/a/file}\
22725                     {$value}{/bin/cat}}
22726 .endd
22727 The result of the lookup is interpreted as the name of the command, even
22728 if it contains white space. The simplest way round this is to use a shell:
22729 .code
22730 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22731                                {$value}{/bin/cat}}
22732 .endd
22733 .endlist
22734
22735 The filter process is run under the same uid and gid as the normal delivery.
22736 For remote deliveries this is the Exim uid/gid by default. The command should
22737 normally yield a zero return code. Transport filters are not supposed to fail.
22738 A non-zero code is taken to mean that the transport filter encountered some
22739 serious problem. Delivery of the message is deferred; the message remains on
22740 the queue and is tried again later. It is not possible to cause a message to be
22741 bounced from a transport filter.
22742
22743 If a transport filter is set on an autoreply transport, the original message is
22744 passed through the filter as it is being copied into the newly generated
22745 message, which happens if the &%return_message%& option is set.
22746
22747
22748 .option transport_filter_timeout transports time 5m
22749 .cindex "transport" "filter, timeout"
22750 When Exim is reading the output of a transport filter, it applies a timeout
22751 that can be set by this option. Exceeding the timeout is normally treated as a
22752 temporary delivery failure. However, if a transport filter is used with a
22753 &(pipe)& transport, a timeout in the transport filter is treated in the same
22754 way as a timeout in the pipe command itself. By default, a timeout is a hard
22755 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22756 becomes a temporary error.
22757
22758
22759 .option user transports string&!! "Exim user"
22760 .cindex "uid (user id)" "local delivery"
22761 .cindex "transport" "user, specifying"
22762 This option specifies the user under whose uid the delivery process is to be
22763 run, overriding any uid that may have been set by the router. If the user is
22764 given as a name, the uid is looked up from the password data, and the
22765 associated group is taken as the value of the gid to be used if the &%group%&
22766 option is not set.
22767
22768 For deliveries that use local transports, a user and group are normally
22769 specified explicitly or implicitly (for example, as a result of
22770 &%check_local_user%&) by the router or transport.
22771
22772 .cindex "hints database" "access by remote transport"
22773 For remote transports, you should leave this option unset unless you really are
22774 sure you know what you are doing. When a remote transport is running, it needs
22775 to be able to access Exim's hints databases, because each host may have its own
22776 retry data.
22777 .ecindex IIDgenoptra1
22778 .ecindex IIDgenoptra2
22779 .ecindex IIDgenoptra3
22780
22781
22782
22783
22784
22785
22786 . ////////////////////////////////////////////////////////////////////////////
22787 . ////////////////////////////////////////////////////////////////////////////
22788
22789 .chapter "Address batching in local transports" "CHAPbatching" &&&
22790          "Address batching"
22791 .cindex "transport" "local; address batching in"
22792 The only remote transport (&(smtp)&) is normally configured to handle more than
22793 one address at a time, so that when several addresses are routed to the same
22794 remote host, just one copy of the message is sent. Local transports, however,
22795 normally handle one address at a time. That is, a separate instance of the
22796 transport is run for each address that is routed to the transport. A separate
22797 copy of the message is delivered each time.
22798
22799 .cindex "batched local delivery"
22800 .oindex "&%batch_max%&"
22801 .oindex "&%batch_id%&"
22802 In special cases, it may be desirable to handle several addresses at once in a
22803 local transport, for example:
22804
22805 .ilist
22806 In an &(appendfile)& transport, when storing messages in files for later
22807 delivery by some other means, a single copy of the message with multiple
22808 recipients saves space.
22809 .next
22810 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22811 a single copy saves time, and is the normal way LMTP is expected to work.
22812 .next
22813 In a &(pipe)& transport, when passing the message
22814 to a scanner program or
22815 to some other delivery mechanism such as UUCP, multiple recipients may be
22816 acceptable.
22817 .endlist
22818
22819 These three local transports all have the same options for controlling multiple
22820 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22821 repeating the information for each transport, these options are described here.
22822
22823 The &%batch_max%& option specifies the maximum number of addresses that can be
22824 delivered together in a single run of the transport. Its default value is one
22825 (no batching). When more than one address is routed to a transport that has a
22826 &%batch_max%& value greater than one, the addresses are delivered in a batch
22827 (that is, in a single run of the transport with multiple recipients), subject
22828 to certain conditions:
22829
22830 .ilist
22831 .vindex "&$local_part$&"
22832 If any of the transport's options contain a reference to &$local_part$&, no
22833 batching is possible.
22834 .next
22835 .vindex "&$domain$&"
22836 If any of the transport's options contain a reference to &$domain$&, only
22837 addresses with the same domain are batched.
22838 .next
22839 .cindex "customizing" "batching condition"
22840 If &%batch_id%& is set, it is expanded for each address, and only those
22841 addresses with the same expanded value are batched. This allows you to specify
22842 customized batching conditions. Failure of the expansion for any reason,
22843 including forced failure, disables batching, but it does not stop the delivery
22844 from taking place.
22845 .next
22846 Batched addresses must also have the same errors address (where to send
22847 delivery errors), the same header additions and removals, the same user and
22848 group for the transport, and if a host list is present, the first host must
22849 be the same.
22850 .endlist
22851
22852 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22853 both when the file or pipe command is specified in the transport, and when it
22854 is specified by a &(redirect)& router, but all the batched addresses must of
22855 course be routed to the same file or pipe command. These two transports have an
22856 option called &%use_bsmtp%&, which causes them to deliver the message in
22857 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22858 &%check_string%& and &%escape_string%& options are forced to the values
22859 .code
22860 check_string = "."
22861 escape_string = ".."
22862 .endd
22863 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22864 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22865 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22866
22867 .cindex "&'Envelope-to:'& header line"
22868 If the generic &%envelope_to_add%& option is set for a batching transport, the
22869 &'Envelope-to:'& header that is added to the message contains all the addresses
22870 that are being processed together. If you are using a batching &(appendfile)&
22871 transport without &%use_bsmtp%&, the only way to preserve the recipient
22872 addresses is to set the &%envelope_to_add%& option.
22873
22874 .cindex "&(pipe)& transport" "with multiple addresses"
22875 .vindex "&$pipe_addresses$&"
22876 If you are using a &(pipe)& transport without BSMTP, and setting the
22877 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22878 the command. This is not a true variable; it is a bit of magic that causes each
22879 of the recipient addresses to be inserted into the command as a separate
22880 argument. This provides a way of accessing all the addresses that are being
22881 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22882 are specified by a &(redirect)& router.
22883
22884
22885
22886
22887 . ////////////////////////////////////////////////////////////////////////////
22888 . ////////////////////////////////////////////////////////////////////////////
22889
22890 .chapter "The appendfile transport" "CHAPappendfile"
22891 .scindex IIDapptra1 "&(appendfile)& transport"
22892 .scindex IIDapptra2 "transports" "&(appendfile)&"
22893 .cindex "directory creation"
22894 .cindex "creating directories"
22895 The &(appendfile)& transport delivers a message by appending it to an existing
22896 file, or by creating an entirely new file in a specified directory. Single
22897 files to which messages are appended can be in the traditional Unix mailbox
22898 format, or optionally in the MBX format supported by the Pine MUA and
22899 University of Washington IMAP daemon, &'inter alia'&. When each message is
22900 being delivered as a separate file, &"maildir"& format can optionally be used
22901 to give added protection against failures that happen part-way through the
22902 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22903 supported. For all file formats, Exim attempts to create as many levels of
22904 directory as necessary, provided that &%create_directory%& is set.
22905
22906 The code for the optional formats is not included in the Exim binary by
22907 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22908 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22909 included.
22910
22911 .cindex "quota" "system"
22912 Exim recognizes system quota errors, and generates an appropriate message. Exim
22913 also supports its own quota control within the transport, for use when the
22914 system facility is unavailable or cannot be used for some reason.
22915
22916 If there is an error while appending to a file (for example, quota exceeded or
22917 partition filled), Exim attempts to reset the file's length and last
22918 modification time back to what they were before. If there is an error while
22919 creating an entirely new file, the new file is removed.
22920
22921 Before appending to a file, a number of security checks are made, and the
22922 file is locked. A detailed description is given below, after the list of
22923 private options.
22924
22925 The &(appendfile)& transport is most commonly used for local deliveries to
22926 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22927 putting messages into files for remote delivery by some means other than Exim.
22928 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22929 option).
22930
22931
22932
22933 .section "The file and directory options" "SECTfildiropt"
22934 The &%file%& option specifies a single file, to which the message is appended;
22935 the &%directory%& option specifies a directory, in which a new file containing
22936 the message is created. Only one of these two options can be set, and for
22937 normal deliveries to mailboxes, one of them &'must'& be set.
22938
22939 .vindex "&$address_file$&"
22940 .vindex "&$local_part$&"
22941 However, &(appendfile)& is also used for delivering messages to files or
22942 directories whose names (or parts of names) are obtained from alias,
22943 forwarding, or filtering operations (for example, a &%save%& command in a
22944 user's Exim filter). When such a transport is running, &$local_part$& contains
22945 the local part that was aliased or forwarded, and &$address_file$& contains the
22946 name (or partial name) of the file or directory generated by the redirection
22947 operation. There are two cases:
22948
22949 .ilist
22950 If neither &%file%& nor &%directory%& is set, the redirection operation
22951 must specify an absolute path (one that begins with &`/`&). This is the most
22952 common case when users with local accounts use filtering to sort mail into
22953 different folders. See for example, the &(address_file)& transport in the
22954 default configuration. If the path ends with a slash, it is assumed to be the
22955 name of a directory. A delivery to a directory can also be forced by setting
22956 &%maildir_format%& or &%mailstore_format%&.
22957 .next
22958 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22959 used to determine the file or directory name for the delivery. Normally, the
22960 contents of &$address_file$& are used in some way in the string expansion.
22961 .endlist
22962 .cindex "tainted data" "in filenames"
22963 .cindex appendfile "tainted data"
22964 Tainted data may not be used for a file or directory name.
22965 This means that, for instance, &$local_part$& cannot be used directly
22966 as a component of a path.  It can however be used as the key for a lookup
22967 which returns a path (or component).
22968
22969
22970 .cindex "Sieve filter" "configuring &(appendfile)&"
22971 .cindex "Sieve filter" "relative mailbox path handling"
22972 As an example of the second case, consider an environment where users do not
22973 have home directories. They may be permitted to use Exim filter commands of the
22974 form:
22975 .code
22976 save folder23
22977 .endd
22978 or Sieve filter commands of the form:
22979 .code
22980 require "fileinto";
22981 fileinto "folder23";
22982 .endd
22983 In this situation, the expansion of &%file%& or &%directory%& in the transport
22984 must transform the relative path into an appropriate absolute filename. In the
22985 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22986 is used as a result of a &"keep"& action in the filter. This example shows one
22987 way of handling this requirement:
22988 .code
22989 file = ${if eq{$address_file}{inbox} \
22990             {/var/mail/$local_part_data} \
22991             {${if eq{${substr_0_1:$address_file}}{/} \
22992                   {$address_file} \
22993                   {$home/mail/$address_file} \
22994             }} \
22995        }
22996 .endd
22997 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22998 location, absolute paths are used without change, and other folders are in the
22999 &_mail_& directory within the home directory.
23000
23001 &*Note 1*&: While processing an Exim filter, a relative path such as
23002 &_folder23_& is turned into an absolute path if a home directory is known to
23003 the router. In particular, this is the case if &%check_local_user%& is set. If
23004 you want to prevent this happening at routing time, you can set
23005 &%router_home_directory%& empty. This forces the router to pass the relative
23006 path to the transport.
23007
23008 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23009 the &%file%& or &%directory%& option is still used if it is set.
23010
23011
23012
23013
23014 .section "Private options for appendfile" "SECID134"
23015 .cindex "options" "&(appendfile)& transport"
23016
23017
23018
23019 .option allow_fifo appendfile boolean false
23020 .cindex "fifo (named pipe)"
23021 .cindex "named pipe (fifo)"
23022 .cindex "pipe" "named (fifo)"
23023 Setting this option permits delivery to named pipes (FIFOs) as well as to
23024 regular files. If no process is reading the named pipe at delivery time, the
23025 delivery is deferred.
23026
23027
23028 .option allow_symlink appendfile boolean false
23029 .cindex "symbolic link" "to mailbox"
23030 .cindex "mailbox" "symbolic link"
23031 By default, &(appendfile)& will not deliver if the path name for the file is
23032 that of a symbolic link. Setting this option relaxes that constraint, but there
23033 are security issues involved in the use of symbolic links. Be sure you know
23034 what you are doing if you set this. Details of exactly what this option affects
23035 are included in the discussion which follows this list of options.
23036
23037
23038 .option batch_id appendfile string&!! unset
23039 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23040 However, batching is automatically disabled for &(appendfile)& deliveries that
23041 happen as a result of forwarding or aliasing or other redirection directly to a
23042 file.
23043
23044
23045 .option batch_max appendfile integer 1
23046 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23047
23048
23049 .option check_group appendfile boolean false
23050 When this option is set, the group owner of the file defined by the &%file%&
23051 option is checked to see that it is the same as the group under which the
23052 delivery process is running. The default setting is false because the default
23053 file mode is 0600, which means that the group is irrelevant.
23054
23055
23056 .option check_owner appendfile boolean true
23057 When this option is set, the owner of the file defined by the &%file%& option
23058 is checked to ensure that it is the same as the user under which the delivery
23059 process is running.
23060
23061
23062 .option check_string appendfile string "see below"
23063 .cindex "&""From""& line"
23064 As &(appendfile)& writes the message, the start of each line is tested for
23065 matching &%check_string%&, and if it does, the initial matching characters are
23066 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23067 a literal string, not a regular expression, and the case of any letters it
23068 contains is significant.
23069
23070 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23071 are forced to &"."& and &".."& respectively, and any settings in the
23072 configuration are ignored. Otherwise, they default to &"From&~"& and
23073 &">From&~"& when the &%file%& option is set, and unset when any of the
23074 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23075
23076 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23077 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23078 &"From&~"& indicates the start of a new message. All four options need changing
23079 if another format is used. For example, to deliver to mailboxes in MMDF format:
23080 .cindex "MMDF format mailbox"
23081 .cindex "mailbox" "MMDF format"
23082 .code
23083 check_string = "\1\1\1\1\n"
23084 escape_string = "\1\1\1\1 \n"
23085 message_prefix = "\1\1\1\1\n"
23086 message_suffix = "\1\1\1\1\n"
23087 .endd
23088 .option create_directory appendfile boolean true
23089 .cindex "directory creation"
23090 When this option is true, Exim attempts to create any missing superior
23091 directories for the file that it is about to write. A created directory's mode
23092 is given by the &%directory_mode%& option.
23093
23094 The group ownership of a newly created directory is highly dependent on the
23095 operating system (and possibly the file system) that is being used. For
23096 example, in Solaris, if the parent directory has the setgid bit set, its group
23097 is propagated to the child; if not, the currently set group is used. However,
23098 in FreeBSD, the parent's group is always used.
23099
23100
23101
23102 .option create_file appendfile string anywhere
23103 This option constrains the location of files and directories that are created
23104 by this transport. It applies to files defined by the &%file%& option and
23105 directories defined by the &%directory%& option. In the case of maildir
23106 delivery, it applies to the top level directory, not the maildir directories
23107 beneath.
23108
23109 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23110 &"belowhome"&. In the second and third cases, a home directory must have been
23111 set for the transport. This option is not useful when an explicit filename is
23112 given for normal mailbox deliveries. It is intended for the case when filenames
23113 are generated from users' &_.forward_& files. These are usually handled
23114 by an &(appendfile)& transport called &%address_file%&. See also
23115 &%file_must_exist%&.
23116
23117
23118 .option directory appendfile string&!! unset
23119 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23120 or &%directory%& must be set, unless the delivery is the direct result of a
23121 redirection (see section &<<SECTfildiropt>>&).
23122
23123 When &%directory%& is set, the string is expanded, and the message is delivered
23124 into a new file or files in or below the given directory, instead of being
23125 appended to a single mailbox file. A number of different formats are provided
23126 (see &%maildir_format%& and &%mailstore_format%&), and see section
23127 &<<SECTopdir>>& for further details of this form of delivery.
23128
23129
23130 .option directory_file appendfile string&!! "see below"
23131 .cindex "base62"
23132 .vindex "&$inode$&"
23133 When &%directory%& is set, but neither &%maildir_format%& nor
23134 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23135 whose name is obtained by expanding this string. The default value is:
23136 .code
23137 q${base62:$tod_epoch}-$inode
23138 .endd
23139 This generates a unique name from the current time, in base 62 form, and the
23140 inode of the file. The variable &$inode$& is available only when expanding this
23141 option.
23142
23143
23144 .option directory_mode appendfile "octal integer" 0700
23145 If &(appendfile)& creates any directories as a result of the
23146 &%create_directory%& option, their mode is specified by this option.
23147
23148
23149 .option escape_string appendfile string "see description"
23150 See &%check_string%& above.
23151
23152
23153 .option file appendfile string&!! unset
23154 This option is mutually exclusive with the &%directory%& option, but one of
23155 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23156 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23157 specifies a single file, to which the message is appended. One or more of
23158 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23159 &%file%&.
23160
23161 .cindex "NFS" "lock file"
23162 .cindex "locking files"
23163 .cindex "lock files"
23164 If you are using more than one host to deliver over NFS into the same
23165 mailboxes, you should always use lock files.
23166
23167 The string value is expanded for each delivery, and must yield an absolute
23168 path. The most common settings of this option are variations on one of these
23169 examples:
23170 .code
23171 file = /var/spool/mail/$local_part_data
23172 file = /home/$local_part_data/inbox
23173 file = $home/inbox
23174 .endd
23175 .cindex "&""sticky""& bit"
23176 In the first example, all deliveries are done into the same directory. If Exim
23177 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23178 create a file in the directory, so the &"sticky"& bit must be turned on for
23179 deliveries to be possible, or alternatively the &%group%& option can be used to
23180 run the delivery under a group id which has write access to the directory.
23181
23182
23183
23184 .option file_format appendfile string unset
23185 .cindex "file" "mailbox; checking existing format"
23186 This option requests the transport to check the format of an existing file
23187 before adding to it. The check consists of matching a specific string at the
23188 start of the file. The value of the option consists of an even number of
23189 colon-separated strings. The first of each pair is the test string, and the
23190 second is the name of a transport. If the transport associated with a matched
23191 string is not the current transport, control is passed over to the other
23192 transport. For example, suppose the standard &(local_delivery)& transport has
23193 this added to it:
23194 .code
23195 file_format = "From       : local_delivery :\
23196                \1\1\1\1\n : local_mmdf_delivery"
23197 .endd
23198 Mailboxes that begin with &"From"& are still handled by this transport, but if
23199 a mailbox begins with four binary ones followed by a newline, control is passed
23200 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23201 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23202 is assumed to match the current transport. If the start of a mailbox doesn't
23203 match any string, or if the transport named for a given string is not defined,
23204 delivery is deferred.
23205
23206
23207 .option file_must_exist appendfile boolean false
23208 If this option is true, the file specified by the &%file%& option must exist.
23209 A temporary error occurs if it does not, causing delivery to be deferred.
23210 If this option is false, the file is created if it does not exist.
23211
23212
23213 .option lock_fcntl_timeout appendfile time 0s
23214 .cindex "timeout" "mailbox locking"
23215 .cindex "mailbox" "locking, blocking and non-blocking"
23216 .cindex "locking files"
23217 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23218 when locking an open mailbox file. If the call fails, the delivery process
23219 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23220 Non-blocking calls are used so that the file is not kept open during the wait
23221 for the lock; the reason for this is to make it as safe as possible for
23222 deliveries over NFS in the case when processes might be accessing an NFS
23223 mailbox without using a lock file. This should not be done, but
23224 misunderstandings and hence misconfigurations are not unknown.
23225
23226 On a busy system, however, the performance of a non-blocking lock approach is
23227 not as good as using a blocking lock with a timeout. In this case, the waiting
23228 is done inside the system call, and Exim's delivery process acquires the lock
23229 and can proceed as soon as the previous lock holder releases it.
23230
23231 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23232 timeout, are used. There may still be some retrying: the maximum number of
23233 retries is
23234 .code
23235 (lock_retries * lock_interval) / lock_fcntl_timeout
23236 .endd
23237 rounded up to the next whole number. In other words, the total time during
23238 which &(appendfile)& is trying to get a lock is roughly the same, unless
23239 &%lock_fcntl_timeout%& is set very large.
23240
23241 You should consider setting this option if you are getting a lot of delayed
23242 local deliveries because of errors of the form
23243 .code
23244 failed to lock mailbox /some/file (fcntl)
23245 .endd
23246
23247 .option lock_flock_timeout appendfile time 0s
23248 This timeout applies to file locking when using &[flock()]& (see
23249 &%use_flock%&); the timeout operates in a similar manner to
23250 &%lock_fcntl_timeout%&.
23251
23252
23253 .option lock_interval appendfile time 3s
23254 This specifies the time to wait between attempts to lock the file. See below
23255 for details of locking.
23256
23257
23258 .option lock_retries appendfile integer 10
23259 This specifies the maximum number of attempts to lock the file. A value of zero
23260 is treated as 1. See below for details of locking.
23261
23262
23263 .option lockfile_mode appendfile "octal integer" 0600
23264 This specifies the mode of the created lock file, when a lock file is being
23265 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23266
23267
23268 .option lockfile_timeout appendfile time 30m
23269 .cindex "timeout" "mailbox locking"
23270 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23271 exists and is older than this value, it is assumed to have been left behind by
23272 accident, and Exim attempts to remove it.
23273
23274
23275 .option mailbox_filecount appendfile string&!! unset
23276 .cindex "mailbox" "specifying size of"
23277 .cindex "size" "of mailbox"
23278 If this option is set, it is expanded, and the result is taken as the current
23279 number of files in the mailbox. It must be a decimal number, optionally
23280 followed by K or M. This provides a way of obtaining this information from an
23281 external source that maintains the data.
23282
23283
23284 .option mailbox_size appendfile string&!! unset
23285 .cindex "mailbox" "specifying size of"
23286 .cindex "size" "of mailbox"
23287 If this option is set, it is expanded, and the result is taken as the current
23288 size the mailbox. It must be a decimal number, optionally followed by K or M.
23289 This provides a way of obtaining this information from an external source that
23290 maintains the data. This is likely to be helpful for maildir deliveries where
23291 it is computationally expensive to compute the size of a mailbox.
23292
23293
23294
23295 .option maildir_format appendfile boolean false
23296 .cindex "maildir format" "specifying"
23297 If this option is set with the &%directory%& option, the delivery is into a new
23298 file, in the &"maildir"& format that is used by other mail software. When the
23299 transport is activated directly from a &(redirect)& router (for example, the
23300 &(address_file)& transport in the default configuration), setting
23301 &%maildir_format%& causes the path received from the router to be treated as a
23302 directory, whether or not it ends with &`/`&. This option is available only if
23303 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23304 &<<SECTmaildirdelivery>>& below for further details.
23305
23306
23307 .option maildir_quota_directory_regex appendfile string "See below"
23308 .cindex "maildir format" "quota; directories included in"
23309 .cindex "quota" "maildir; directories included in"
23310 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23311 a regular expression for specifying directories, relative to the quota
23312 directory (see &%quota_directory%&), that should be included in the quota
23313 calculation. The default value is:
23314 .code
23315 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23316 .endd
23317 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23318 (directories whose names begin with a dot). If you want to exclude the
23319 &_Trash_&
23320 folder from the count (as some sites do), you need to change this setting to
23321 .code
23322 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23323 .endd
23324 This uses a negative lookahead in the regular expression to exclude the
23325 directory whose name is &_.Trash_&. When a directory is excluded from quota
23326 calculations, quota processing is bypassed for any messages that are delivered
23327 directly into that directory.
23328
23329
23330 .option maildir_retries appendfile integer 10
23331 This option specifies the number of times to retry when writing a file in
23332 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23333
23334
23335 .option maildir_tag appendfile string&!! unset
23336 This option applies only to deliveries in maildir format, and is described in
23337 section &<<SECTmaildirdelivery>>& below.
23338
23339
23340 .option maildir_use_size_file appendfile&!! boolean false
23341 .cindex "maildir format" "&_maildirsize_& file"
23342 The result of string expansion for this option must be a valid boolean value.
23343 If it is true, it enables support for &_maildirsize_& files. Exim
23344 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23345 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23346 value is zero. See &%maildir_quota_directory_regex%& above and section
23347 &<<SECTmaildirdelivery>>& below for further details.
23348
23349 .option maildirfolder_create_regex appendfile string unset
23350 .cindex "maildir format" "&_maildirfolder_& file"
23351 .cindex "&_maildirfolder_&, creating"
23352 The value of this option is a regular expression. If it is unset, it has no
23353 effect. Otherwise, before a maildir delivery takes place, the pattern is
23354 matched against the name of the maildir directory, that is, the directory
23355 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23356 delivery. If there is a match, Exim checks for the existence of a file called
23357 &_maildirfolder_& in the directory, and creates it if it does not exist.
23358 See section &<<SECTmaildirdelivery>>& for more details.
23359
23360
23361 .option mailstore_format appendfile boolean false
23362 .cindex "mailstore format" "specifying"
23363 If this option is set with the &%directory%& option, the delivery is into two
23364 new files in  &"mailstore"& format. The option is available only if
23365 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23366 below for further details.
23367
23368
23369 .option mailstore_prefix appendfile string&!! unset
23370 This option applies only to deliveries in mailstore format, and is described in
23371 section &<<SECTopdir>>& below.
23372
23373
23374 .option mailstore_suffix appendfile string&!! unset
23375 This option applies only to deliveries in mailstore format, and is described in
23376 section &<<SECTopdir>>& below.
23377
23378
23379 .option mbx_format appendfile boolean false
23380 .cindex "locking files"
23381 .cindex "file" "locking"
23382 .cindex "file" "MBX format"
23383 .cindex "MBX format, specifying"
23384 This option is available only if Exim has been compiled with SUPPORT_MBX
23385 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23386 the message is appended to the mailbox file in MBX format instead of
23387 traditional Unix format. This format is supported by Pine4 and its associated
23388 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23389
23390 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23391 automatically changed by the use of &%mbx_format%&. They should normally be set
23392 empty when using MBX format, so this option almost always appears in this
23393 combination:
23394 .code
23395 mbx_format = true
23396 message_prefix =
23397 message_suffix =
23398 .endd
23399 If none of the locking options are mentioned in the configuration,
23400 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23401 is possible to specify the other kinds of locking with &%mbx_format%&, but
23402 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23403 interworks with &'c-client'&, providing for shared access to the mailbox. It
23404 should not be used if any program that does not use this form of locking is
23405 going to access the mailbox, nor should it be used if the mailbox file is NFS
23406 mounted, because it works only when the mailbox is accessed from a single host.
23407
23408 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23409 the standard version of &'c-client'&, because as long as it has a mailbox open
23410 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23411 append messages to it.
23412
23413
23414 .option message_prefix appendfile string&!! "see below"
23415 .cindex "&""From""& line"
23416 The string specified here is expanded and output at the start of every message.
23417 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23418 in which case it is:
23419 .code
23420 message_prefix = "From ${if def:return_path{$return_path}\
23421   {MAILER-DAEMON}} $tod_bsdinbox\n"
23422 .endd
23423 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23424 &`\n`& to &`\r\n`& in &%message_prefix%&.
23425
23426 .option message_suffix appendfile string&!! "see below"
23427 The string specified here is expanded and output at the end of every message.
23428 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23429 in which case it is a single newline character. The suffix can be suppressed by
23430 setting
23431 .code
23432 message_suffix =
23433 .endd
23434 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23435 &`\n`& to &`\r\n`& in &%message_suffix%&.
23436
23437 .option mode appendfile "octal integer" 0600
23438 If the output file is created, it is given this mode. If it already exists and
23439 has wider permissions, they are reduced to this mode. If it has narrower
23440 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23441 if the delivery is the result of a &%save%& command in a filter file specifying
23442 a particular mode, the mode of the output file is always forced to take that
23443 value, and this option is ignored.
23444
23445
23446 .option mode_fail_narrower appendfile boolean true
23447 This option applies in the case when an existing mailbox file has a narrower
23448 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23449 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23450 continues with the delivery attempt, using the existing mode of the file.
23451
23452
23453 .option notify_comsat appendfile boolean false
23454 If this option is true, the &'comsat'& daemon is notified after every
23455 successful delivery to a user mailbox. This is the daemon that notifies logged
23456 on users about incoming mail.
23457
23458
23459 .option quota appendfile string&!! unset
23460 .cindex "quota" "imposed by Exim"
23461 This option imposes a limit on the size of the file to which Exim is appending,
23462 or to the total space used in the directory tree when the &%directory%& option
23463 is set. In the latter case, computation of the space used is expensive, because
23464 all the files in the directory (and any sub-directories) have to be
23465 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23466 &%maildir_use_size_file%& for ways to avoid this in environments where users
23467 have no shell access to their mailboxes).
23468
23469 As there is no interlock against two simultaneous deliveries into a
23470 multi-file mailbox, it is possible for the quota to be overrun in this case.
23471 For single-file mailboxes, of course, an interlock is a necessity.
23472
23473 A file's size is taken as its &'used'& value. Because of blocking effects, this
23474 may be a lot less than the actual amount of disk space allocated to the file.
23475 If the sizes of a number of files are being added up, the rounding effect can
23476 become quite noticeable, especially on systems that have large block sizes.
23477 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23478 the obvious value which users understand most easily.
23479
23480 The value of the option is expanded, and must then be a numerical value
23481 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23482 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23483 and further option modifiers. If Exim is running on a system with
23484 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23485 be handled.
23486
23487 The option modifier &%no_check%& can be used to force delivery even if the over
23488 quota condition is met. The quota gets updated as usual.
23489
23490 &*Note*&: A value of zero is interpreted as &"no quota"&.
23491
23492 The expansion happens while Exim is running as root, before it changes uid for
23493 the delivery. This means that files that are inaccessible to the end user can
23494 be used to hold quota values that are looked up in the expansion. When delivery
23495 fails because this quota is exceeded, the handling of the error is as for
23496 system quota failures.
23497
23498 By default, Exim's quota checking mimics system quotas, and restricts the
23499 mailbox to the specified maximum size, though the value is not accurate to the
23500 last byte, owing to separator lines and additional headers that may get added
23501 during message delivery. When a mailbox is nearly full, large messages may get
23502 refused even though small ones are accepted, because the size of the current
23503 message is added to the quota when the check is made. This behaviour can be
23504 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23505 for exceeding the quota does not include the current message. Thus, deliveries
23506 continue until the quota has been exceeded; thereafter, no further messages are
23507 delivered. See also &%quota_warn_threshold%&.
23508
23509
23510 .option quota_directory appendfile string&!! unset
23511 This option defines the directory to check for quota purposes when delivering
23512 into individual files. The default is the delivery directory, or, if a file
23513 called &_maildirfolder_& exists in a maildir directory, the parent of the
23514 delivery directory.
23515
23516
23517 .option quota_filecount appendfile string&!! 0
23518 This option applies when the &%directory%& option is set. It limits the total
23519 number of files in the directory (compare the inode limit in system quotas). It
23520 can only be used if &%quota%& is also set. The value is expanded; an expansion
23521 failure causes delivery to be deferred. A value of zero is interpreted as
23522 &"no quota"&.
23523
23524 The option modifier &%no_check%& can be used to force delivery even if the over
23525 quota condition is met. The quota gets updated as usual.
23526
23527 .option quota_is_inclusive appendfile boolean true
23528 See &%quota%& above.
23529
23530
23531 .option quota_size_regex appendfile string unset
23532 This option applies when one of the delivery modes that writes a separate file
23533 for each message is being used. When Exim wants to find the size of one of
23534 these files in order to test the quota, it first checks &%quota_size_regex%&.
23535 If this is set to a regular expression that matches the filename, and it
23536 captures one string, that string is interpreted as a representation of the
23537 file's size. The value of &%quota_size_regex%& is not expanded.
23538
23539 This feature is useful only when users have no shell access to their mailboxes
23540 &-- otherwise they could defeat the quota simply by renaming the files. This
23541 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23542 the file length to the filename. For example:
23543 .code
23544 maildir_tag = ,S=$message_size
23545 quota_size_regex = ,S=(\d+)
23546 .endd
23547 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23548 number of lines in the message.
23549
23550 The regular expression should not assume that the length is at the end of the
23551 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23552 sometimes add other information onto the ends of message filenames.
23553
23554 Section &<<SECID136>>& contains further information.
23555
23556 This option should not be used when other message-handling software
23557 may duplicate messages by making hardlinks to the files.  When that is done Exim
23558 will count the message size once for each filename, in contrast with the actual
23559 disk usage.  When the option is not set, calculating total usage requires
23560 a system-call per file to get the size; the number of links is then available also
23561 as is used to adjust the effective size.
23562
23563
23564 .option quota_warn_message appendfile string&!! "see below"
23565 See below for the use of this option. If it is not set when
23566 &%quota_warn_threshold%& is set, it defaults to
23567 .code
23568 quota_warn_message = "\
23569   To: $local_part@$domain\n\
23570   Subject: Your mailbox\n\n\
23571   This message is automatically created \
23572   by mail delivery software.\n\n\
23573   The size of your mailbox has exceeded \
23574   a warning threshold that is\n\
23575   set by the system administrator.\n"
23576 .endd
23577
23578
23579 .option quota_warn_threshold appendfile string&!! 0
23580 .cindex "quota" "warning threshold"
23581 .cindex "mailbox" "size warning"
23582 .cindex "size" "of mailbox"
23583 This option is expanded in the same way as &%quota%& (see above). If the
23584 resulting value is greater than zero, and delivery of the message causes the
23585 size of the file or total space in the directory tree to cross the given
23586 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23587 may be specified as a percentage of it by following the value with a percent
23588 sign. For example:
23589 .code
23590 quota = 10M
23591 quota_warn_threshold = 75%
23592 .endd
23593 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23594 percent sign is ignored.
23595
23596 The warning message itself is specified by the &%quota_warn_message%& option,
23597 and it must start with a &'To:'& header line containing the recipient(s) of the
23598 warning message. These do not necessarily have to include the recipient(s) of
23599 the original message. A &'Subject:'& line should also normally be supplied. You
23600 can include any other header lines that you want. If you do not include a
23601 &'From:'& line, the default is:
23602 .code
23603 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23604 .endd
23605 .oindex &%errors_reply_to%&
23606 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23607 option.
23608
23609 The &%quota%& option does not have to be set in order to use this option; they
23610 are independent of one another except when the threshold is specified as a
23611 percentage.
23612
23613
23614 .option use_bsmtp appendfile boolean false
23615 .cindex "envelope from"
23616 .cindex "envelope sender"
23617 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23618 format, with the envelope sender and recipient(s) included as SMTP commands. If
23619 you want to include a leading HELO command with such messages, you can do
23620 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23621 for details of batch SMTP.
23622
23623
23624 .option use_crlf appendfile boolean false
23625 .cindex "carriage return"
23626 .cindex "linefeed"
23627 This option causes lines to be terminated with the two-character CRLF sequence
23628 (carriage return, linefeed) instead of just a linefeed character. In the case
23629 of batched SMTP, the byte sequence written to the file is then an exact image
23630 of what would be sent down a real SMTP connection.
23631
23632 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23633 (which are used to supply the traditional &"From&~"& and blank line separators
23634 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23635 carriage return characters if these are needed. In cases where these options
23636 have non-empty defaults, the values end with a single linefeed, so they must be
23637 changed to end with &`\r\n`& if &%use_crlf%& is set.
23638
23639
23640 .option use_fcntl_lock appendfile boolean "see below"
23641 This option controls the use of the &[fcntl()]& function to lock a file for
23642 exclusive use when a message is being appended. It is set by default unless
23643 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23644 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23645 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23646
23647
23648 .option use_flock_lock appendfile boolean false
23649 This option is provided to support the use of &[flock()]& for file locking, for
23650 the few situations where it is needed. Most modern operating systems support
23651 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23652 each other. Exim uses &[fcntl()]& locking by default.
23653
23654 This option is required only if you are using an operating system where
23655 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23656 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23657 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23658
23659 .cindex "Solaris" "&[flock()]& support"
23660 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23661 have it (and some, I think, provide a not quite right version built on top of
23662 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23663 the ability to use it, and any attempt to do so will cause a configuration
23664 error.
23665
23666 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23667 is just being mapped onto &[fcntl()]& by the OS).
23668
23669
23670 .option use_lockfile appendfile boolean "see below"
23671 If this option is turned off, Exim does not attempt to create a lock file when
23672 appending to a mailbox file. In this situation, the only locking is by
23673 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23674 sure that every MUA that is ever going to look at your users' mailboxes uses
23675 &[fcntl()]& rather than a lock file, and even then only when you are not
23676 delivering over NFS from more than one host.
23677
23678 .cindex "NFS" "lock file"
23679 In order to append to an NFS file safely from more than one host, it is
23680 necessary to take out a lock &'before'& opening the file, and the lock file
23681 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23682 file corruption.
23683
23684 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23685 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23686 except when &%mbx_format%& is set.
23687
23688
23689 .option use_mbx_lock appendfile boolean "see below"
23690 This option is available only if Exim has been compiled with SUPPORT_MBX
23691 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23692 locking rules be used. It is set by default if &%mbx_format%& is set and none
23693 of the locking options are mentioned in the configuration. The locking rules
23694 are the same as are used by the &'c-client'& library that underlies Pine and
23695 the IMAP4 and POP daemons that come with it (see the discussion below). The
23696 rules allow for shared access to the mailbox. However, this kind of locking
23697 does not work when the mailbox is NFS mounted.
23698
23699 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23700 &%use_flock_lock%& to control what kind of locking is used in implementing the
23701 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23702 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23703
23704
23705
23706
23707 .section "Operational details for appending" "SECTopappend"
23708 .cindex "appending to a file"
23709 .cindex "file" "appending"
23710 Before appending to a file, the following preparations are made:
23711
23712 .ilist
23713 If the name of the file is &_/dev/null_&, no action is taken, and a success
23714 return is given.
23715
23716 .next
23717 .cindex "directory creation"
23718 If any directories on the file's path are missing, Exim creates them if the
23719 &%create_directory%& option is set. A created directory's mode is given by the
23720 &%directory_mode%& option.
23721
23722 .next
23723 If &%file_format%& is set, the format of an existing file is checked. If this
23724 indicates that a different transport should be used, control is passed to that
23725 transport.
23726
23727 .next
23728 .cindex "file" "locking"
23729 .cindex "locking files"
23730 .cindex "NFS" "lock file"
23731 If &%use_lockfile%& is set, a lock file is built in a way that will work
23732 reliably over NFS, as follows:
23733
23734 .olist
23735 Create a &"hitching post"& file whose name is that of the lock file with the
23736 current time, primary host name, and process id added, by opening for writing
23737 as a new file. If this fails with an access error, delivery is deferred.
23738 .next
23739 Close the hitching post file, and hard link it to the lock filename.
23740 .next
23741 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23742 Unlink the hitching post name.
23743 .next
23744 Otherwise, use &[stat()]& to get information about the hitching post file, and
23745 then unlink hitching post name. If the number of links is exactly two, creation
23746 of the lock file succeeded but something (for example, an NFS server crash and
23747 restart) caused this fact not to be communicated to the &[link()]& call.
23748 .next
23749 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23750 up to &%lock_retries%& times. However, since any program that writes to a
23751 mailbox should complete its task very quickly, it is reasonable to time out old
23752 lock files that are normally the result of user agent and system crashes. If an
23753 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23754 it before trying again.
23755 .endlist olist
23756
23757 .next
23758 A call is made to &[lstat()]& to discover whether the main file exists, and if
23759 so, what its characteristics are. If &[lstat()]& fails for any reason other
23760 than non-existence, delivery is deferred.
23761
23762 .next
23763 .cindex "symbolic link" "to mailbox"
23764 .cindex "mailbox" "symbolic link"
23765 If the file does exist and is a symbolic link, delivery is deferred, unless the
23766 &%allow_symlink%& option is set, in which case the ownership of the link is
23767 checked, and then &[stat()]& is called to find out about the real file, which
23768 is then subjected to the checks below. The check on the top-level link
23769 ownership prevents one user creating a link for another's mailbox in a sticky
23770 directory, though allowing symbolic links in this case is definitely not a good
23771 idea. If there is a chain of symbolic links, the intermediate ones are not
23772 checked.
23773
23774 .next
23775 If the file already exists but is not a regular file, or if the file's owner
23776 and group (if the group is being checked &-- see &%check_group%& above) are
23777 different from the user and group under which the delivery is running,
23778 delivery is deferred.
23779
23780 .next
23781 If the file's permissions are more generous than specified, they are reduced.
23782 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23783 is set false, in which case the delivery is tried using the existing
23784 permissions.
23785
23786 .next
23787 The file's inode number is saved, and the file is then opened for appending.
23788 If this fails because the file has vanished, &(appendfile)& behaves as if it
23789 hadn't existed (see below). For any other failures, delivery is deferred.
23790
23791 .next
23792 If the file is opened successfully, check that the inode number hasn't
23793 changed, that it is still a regular file, and that the owner and permissions
23794 have not changed. If anything is wrong, defer delivery and freeze the message.
23795
23796 .next
23797 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23798 option is set. Otherwise, check that the file is being created in a permitted
23799 directory if the &%create_file%& option is set (deferring on failure), and then
23800 open for writing as a new file, with the O_EXCL and O_CREAT options,
23801 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23802 set). In this case, which can happen if the link points to a non-existent file,
23803 the file is opened for writing using O_CREAT but not O_EXCL, because
23804 that prevents link following.
23805
23806 .next
23807 .cindex "loop" "while file testing"
23808 If opening fails because the file exists, obey the tests given above for
23809 existing files. However, to avoid looping in a situation where the file is
23810 being continuously created and destroyed, the exists/not-exists loop is broken
23811 after 10 repetitions, and the message is then frozen.
23812
23813 .next
23814 If opening fails with any other error, defer delivery.
23815
23816 .next
23817 .cindex "file" "locking"
23818 .cindex "locking files"
23819 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23820 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23821 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23822 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23823 file, and an exclusive lock on the file whose name is
23824 .code
23825 /tmp/.<device-number>.<inode-number>
23826 .endd
23827 using the device and inode numbers of the open mailbox file, in accordance with
23828 the MBX locking rules. This file is created with a mode that is specified by
23829 the &%lockfile_mode%& option.
23830
23831 If Exim fails to lock the file, there are two possible courses of action,
23832 depending on the value of the locking timeout. This is obtained from
23833 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23834
23835 If the timeout value is zero, the file is closed, Exim waits for
23836 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23837 to lock it again. This happens up to &%lock_retries%& times, after which the
23838 delivery is deferred.
23839
23840 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23841 &[flock()]& are used (with the given timeout), so there has already been some
23842 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23843 immediately. It retries up to
23844 .code
23845 (lock_retries * lock_interval) / <timeout>
23846 .endd
23847 times (rounded up).
23848 .endlist
23849
23850 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23851 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23852
23853
23854 .section "Operational details for delivery to a new file" "SECTopdir"
23855 .cindex "delivery" "to single file"
23856 .cindex "&""From""& line"
23857 When the &%directory%& option is set instead of &%file%&, each message is
23858 delivered into a newly-created file or set of files. When &(appendfile)& is
23859 activated directly from a &(redirect)& router, neither &%file%& nor
23860 &%directory%& is normally set, because the path for delivery is supplied by the
23861 router. (See for example, the &(address_file)& transport in the default
23862 configuration.) In this case, delivery is to a new file if either the path name
23863 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23864
23865 No locking is required while writing the message to a new file, so the various
23866 locking options of the transport are ignored. The &"From"& line that by default
23867 separates messages in a single file is not normally needed, nor is the escaping
23868 of message lines that start with &"From"&, and there is no need to ensure a
23869 newline at the end of each message. Consequently, the default values for
23870 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23871 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23872
23873 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23874 the files in the delivery directory by default. However, you can specify a
23875 different directory by setting &%quota_directory%&. Also, for maildir
23876 deliveries (see below) the &_maildirfolder_& convention is honoured.
23877
23878
23879 .cindex "maildir format"
23880 .cindex "mailstore format"
23881 There are three different ways in which delivery to individual files can be
23882 done, controlled by the settings of the &%maildir_format%& and
23883 &%mailstore_format%& options. Note that code to support maildir or mailstore
23884 formats is not included in the binary unless SUPPORT_MAILDIR or
23885 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23886
23887 .cindex "directory creation"
23888 In all three cases an attempt is made to create the directory and any necessary
23889 sub-directories if they do not exist, provided that the &%create_directory%&
23890 option is set (the default). The location of a created directory can be
23891 constrained by setting &%create_file%&. A created directory's mode is given by
23892 the &%directory_mode%& option. If creation fails, or if the
23893 &%create_directory%& option is not set when creation is required, delivery is
23894 deferred.
23895
23896
23897
23898 .section "Maildir delivery" "SECTmaildirdelivery"
23899 .cindex "maildir format" "description of"
23900 If the &%maildir_format%& option is true, Exim delivers each message by writing
23901 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23902 directory that is defined by the &%directory%& option (the &"delivery
23903 directory"&). If the delivery is successful, the file is renamed into the
23904 &_new_& subdirectory.
23905
23906 In the filename, <&'stime'&> is the current time of day in seconds, and
23907 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23908 Exim checks that the time-of-day clock has moved on by at least one microsecond
23909 before terminating the delivery process. This guarantees uniqueness for the
23910 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23911 opening it. If any response other than ENOENT (does not exist) is given,
23912 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23913
23914 Before Exim carries out a maildir delivery, it ensures that subdirectories
23915 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23916 do not exist, Exim tries to create them and any superior directories in their
23917 path, subject to the &%create_directory%& and &%create_file%& options. If the
23918 &%maildirfolder_create_regex%& option is set, and the regular expression it
23919 contains matches the delivery directory, Exim also ensures that a file called
23920 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23921 &_maildirfolder_& file cannot be created, delivery is deferred.
23922
23923 These features make it possible to use Exim to create all the necessary files
23924 and directories in a maildir mailbox, including subdirectories for maildir++
23925 folders. Consider this example:
23926 .code
23927 maildir_format = true
23928 directory = /var/mail/$local_part_data\
23929            ${if eq{$local_part_suffix}{}{}\
23930            {/.${substr_1:$local_part_suffix}}}
23931 maildirfolder_create_regex = /\.[^/]+$
23932 .endd
23933 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23934 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23935 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23936 not match this name, so Exim will not look for or create the file
23937 &_/var/mail/pimbo/maildirfolder_&, though it will create
23938 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23939
23940 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23941 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23942 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23943 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23944 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23945
23946 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23947 not inadvertently match the toplevel maildir directory, because a
23948 &_maildirfolder_& file at top level would completely break quota calculations.
23949
23950 .cindex "quota" "in maildir delivery"
23951 .cindex "maildir++"
23952 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23953 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23954 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23955 Exim assumes the directory is a maildir++ folder directory, which is one level
23956 down from the user's top level mailbox directory. This causes it to start at
23957 the parent directory instead of the current directory when calculating the
23958 amount of space used.
23959
23960 One problem with delivering into a multi-file mailbox is that it is
23961 computationally expensive to compute the size of the mailbox for quota
23962 checking. Various approaches have been taken to reduce the amount of work
23963 needed. The next two sections describe two of them. A third alternative is to
23964 use some external process for maintaining the size data, and use the expansion
23965 of the &%mailbox_size%& option as a way of importing it into Exim.
23966
23967
23968
23969
23970 .section "Using tags to record message sizes" "SECID135"
23971 If &%maildir_tag%& is set, the string is expanded for each delivery.
23972 When the maildir file is renamed into the &_new_& sub-directory, the
23973 tag is added to its name. However, if adding the tag takes the length of the
23974 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23975 the tag is dropped and the maildir file is created with no tag.
23976
23977
23978 .vindex "&$message_size$&"
23979 Tags can be used to encode the size of files in their names; see
23980 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23981 happens after the message has been written. The value of the &$message_size$&
23982 variable is set to the number of bytes actually written. If the expansion is
23983 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23984 be deferred. The expanded tag may contain any printing characters except &"/"&.
23985 Non-printing characters in the string are ignored; if the resulting string is
23986 empty, it is ignored. If it starts with an alphanumeric character, a leading
23987 colon is inserted; this default has not proven to be the path that popular
23988 maildir implementations have chosen (but changing it in Exim would break
23989 backwards compatibility).
23990
23991 For one common implementation, you might set:
23992 .code
23993 maildir_tag = ,S=${message_size}
23994 .endd
23995 but you should check the documentation of the other software to be sure.
23996
23997 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23998 as this allows Exim to extract the size from your tag, instead of having to
23999 &[stat()]& each message file.
24000
24001
24002 .section "Using a maildirsize file" "SECID136"
24003 .cindex "quota" "in maildir delivery"
24004 .cindex "maildir format" "&_maildirsize_& file"
24005 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24006 storing quota and message size information in a file called &_maildirsize_&
24007 within the toplevel maildir directory. If this file does not exist, Exim
24008 creates it, setting the quota from the &%quota%& option of the transport. If
24009 the maildir directory itself does not exist, it is created before any attempt
24010 to write a &_maildirsize_& file.
24011
24012 The &_maildirsize_& file is used to hold information about the sizes of
24013 messages in the maildir, thus speeding up quota calculations. The quota value
24014 in the file is just a cache; if the quota is changed in the transport, the new
24015 value overrides the cached value when the next message is delivered. The cache
24016 is maintained for the benefit of other programs that access the maildir and
24017 need to know the quota.
24018
24019 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24020 file is maintained (with a zero quota setting), but no quota is imposed.
24021
24022 A regular expression is available for controlling which directories in the
24023 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24024 See the description of the &%maildir_quota_directory_regex%& option above for
24025 details.
24026
24027
24028 .section "Mailstore delivery" "SECID137"
24029 .cindex "mailstore format" "description of"
24030 If the &%mailstore_format%& option is true, each message is written as two
24031 files in the given directory. A unique base name is constructed from the
24032 message id and the current delivery process, and the files that are written use
24033 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24034 contains the message's envelope, and the &_.msg_& file contains the message
24035 itself. The base name is placed in the variable &$mailstore_basename$&.
24036
24037 During delivery, the envelope is first written to a file with the suffix
24038 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24039 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24040 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24041 file before accessing either of them. An alternative approach is to wait for
24042 the absence of a &_.tmp_& file.
24043
24044 The envelope file starts with any text defined by the &%mailstore_prefix%&
24045 option, expanded and terminated by a newline if there isn't one. Then follows
24046 the sender address on one line, then all the recipient addresses, one per line.
24047 There can be more than one recipient only if the &%batch_max%& option is set
24048 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24049 appended to the file, followed by a newline if it does not end with one.
24050
24051 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24052 failure, it is ignored. Other expansion errors are treated as serious
24053 configuration errors, and delivery is deferred. The variable
24054 &$mailstore_basename$& is available for use during these expansions.
24055
24056
24057 .section "Non-special new file delivery" "SECID138"
24058 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24059 file is created directly in the named directory. For example, when delivering
24060 messages into files in batched SMTP format for later delivery to some host (see
24061 section &<<SECTbatchSMTP>>&), a setting such as
24062 .code
24063 directory = /var/bsmtp/$host
24064 .endd
24065 might be used. A message is written to a file with a temporary name, which is
24066 then renamed when the delivery is complete. The final name is obtained by
24067 expanding the contents of the &%directory_file%& option.
24068 .ecindex IIDapptra1
24069 .ecindex IIDapptra2
24070
24071
24072
24073
24074
24075
24076 . ////////////////////////////////////////////////////////////////////////////
24077 . ////////////////////////////////////////////////////////////////////////////
24078
24079 .chapter "The autoreply transport" "CHID8"
24080 .scindex IIDauttra1 "transports" "&(autoreply)&"
24081 .scindex IIDauttra2 "&(autoreply)& transport"
24082 The &(autoreply)& transport is not a true transport in that it does not cause
24083 the message to be transmitted. Instead, it generates a new mail message as an
24084 automatic reply to the incoming message. &'References:'& and
24085 &'Auto-Submitted:'& header lines are included. These are constructed according
24086 to the rules in RFCs 2822 and 3834, respectively.
24087
24088 If the router that passes the message to this transport does not have the
24089 &%unseen%& option set, the original message (for the current recipient) is not
24090 delivered anywhere. However, when the &%unseen%& option is set on the router
24091 that passes the message to this transport, routing of the address continues, so
24092 another router can set up a normal message delivery.
24093
24094
24095 The &(autoreply)& transport is usually run as the result of mail filtering, a
24096 &"vacation"& message being the standard example. However, it can also be run
24097 directly from a router like any other transport. To reduce the possibility of
24098 message cascades, messages created by the &(autoreply)& transport always have
24099 empty envelope sender addresses, like bounce messages.
24100
24101 The parameters of the message to be sent can be specified in the configuration
24102 by options described below. However, these are used only when the address
24103 passed to the transport does not contain its own reply information. When the
24104 transport is run as a consequence of a
24105 &%mail%&
24106 or &%vacation%& command in a filter file, the parameters of the message are
24107 supplied by the filter, and passed with the address. The transport's options
24108 that define the message are then ignored (so they are not usually set in this
24109 case). The message is specified entirely by the filter or by the transport; it
24110 is never built from a mixture of options. However, the &%file_optional%&,
24111 &%mode%&, and &%return_message%& options apply in all cases.
24112
24113 &(Autoreply)& is implemented as a local transport. When used as a result of a
24114 command in a user's filter file, &(autoreply)& normally runs under the uid and
24115 gid of the user, and with appropriate current and home directories (see chapter
24116 &<<CHAPenvironment>>&).
24117
24118 There is a subtle difference between routing a message to a &(pipe)& transport
24119 that generates some text to be returned to the sender, and routing it to an
24120 &(autoreply)& transport. This difference is noticeable only if more than one
24121 address from the same message is so handled. In the case of a pipe, the
24122 separate outputs from the different addresses are gathered up and returned to
24123 the sender in a single message, whereas if &(autoreply)& is used, a separate
24124 message is generated for each address that is passed to it.
24125
24126 Non-printing characters are not permitted in the header lines generated for the
24127 message that &(autoreply)& creates, with the exception of newlines that are
24128 immediately followed by white space. If any non-printing characters are found,
24129 the transport defers.
24130 Whether characters with the top bit set count as printing characters or not is
24131 controlled by the &%print_topbitchars%& global option.
24132
24133 If any of the generic options for manipulating headers (for example,
24134 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24135 of the original message that is included in the generated message when
24136 &%return_message%& is set. They do not apply to the generated message itself.
24137
24138 .vindex "&$sender_address$&"
24139 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24140 the message, indicating that there were no recipients, it does not treat this
24141 as an error. This means that autoreplies sent to &$sender_address$& when this
24142 is empty (because the incoming message is a bounce message) do not cause
24143 problems. They are just discarded.
24144
24145
24146
24147 .section "Private options for autoreply" "SECID139"
24148 .cindex "options" "&(autoreply)& transport"
24149
24150 .option bcc autoreply string&!! unset
24151 This specifies the addresses that are to receive &"blind carbon copies"& of the
24152 message when the message is specified by the transport.
24153
24154
24155 .option cc autoreply string&!! unset
24156 This specifies recipients of the message and the contents of the &'Cc:'& header
24157 when the message is specified by the transport.
24158
24159
24160 .option file autoreply string&!! unset
24161 The contents of the file are sent as the body of the message when the message
24162 is specified by the transport. If both &%file%& and &%text%& are set, the text
24163 string comes first.
24164
24165
24166 .option file_expand autoreply boolean false
24167 If this is set, the contents of the file named by the &%file%& option are
24168 subjected to string expansion as they are added to the message.
24169
24170
24171 .option file_optional autoreply boolean false
24172 If this option is true, no error is generated if the file named by the &%file%&
24173 option or passed with the address does not exist or cannot be read.
24174
24175
24176 .option from autoreply string&!! unset
24177 This specifies the contents of the &'From:'& header when the message is
24178 specified by the transport.
24179
24180
24181 .option headers autoreply string&!! unset
24182 This specifies additional RFC 2822 headers that are to be added to the message
24183 when the message is specified by the transport. Several can be given by using
24184 &"\n"& to separate them. There is no check on the format.
24185
24186
24187 .option log autoreply string&!! unset
24188 This option names a file in which a record of every message sent is logged when
24189 the message is specified by the transport.
24190
24191
24192 .option mode autoreply "octal integer" 0600
24193 If either the log file or the &"once"& file has to be created, this mode is
24194 used.
24195
24196
24197 .option never_mail autoreply "address list&!!" unset
24198 If any run of the transport creates a message with a recipient that matches any
24199 item in the list, that recipient is quietly discarded. If all recipients are
24200 discarded, no message is created. This applies both when the recipients are
24201 generated by a filter and when they are specified in the transport.
24202
24203
24204
24205 .option once autoreply string&!! unset
24206 This option names a file or DBM database in which a record of each &'To:'&
24207 recipient is kept when the message is specified by the transport. &*Note*&:
24208 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24209
24210 If &%once%& is unset, or is set to an empty string, the message is always sent.
24211 By default, if &%once%& is set to a non-empty filename, the message
24212 is not sent if a potential recipient is already listed in the database.
24213 However, if the &%once_repeat%& option specifies a time greater than zero, the
24214 message is sent if that much time has elapsed since a message was last sent to
24215 this recipient. A setting of zero time for &%once_repeat%& (the default)
24216 prevents a message from being sent a second time &-- in this case, zero means
24217 infinity.
24218
24219 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24220 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24221 greater than zero, it changes the way Exim implements the &%once%& option.
24222 Instead of using a DBM file to record every recipient it sends to, it uses a
24223 regular file, whose size will never get larger than the given value.
24224
24225 In the file, Exim keeps a linear list of recipient addresses and the times at
24226 which they were sent messages. If the file is full when a new address needs to
24227 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24228 means that a given recipient may receive multiple messages, but at
24229 unpredictable intervals that depend on the rate of turnover of addresses in the
24230 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24231
24232
24233 .option once_file_size autoreply integer 0
24234 See &%once%& above.
24235
24236
24237 .option once_repeat autoreply time&!! 0s
24238 See &%once%& above.
24239 After expansion, the value of this option must be a valid time value.
24240
24241
24242 .option reply_to autoreply string&!! unset
24243 This specifies the contents of the &'Reply-To:'& header when the message is
24244 specified by the transport.
24245
24246
24247 .option return_message autoreply boolean false
24248 If this is set, a copy of the original message is returned with the new
24249 message, subject to the maximum size set in the &%return_size_limit%& global
24250 configuration option.
24251
24252
24253 .option subject autoreply string&!! unset
24254 This specifies the contents of the &'Subject:'& header when the message is
24255 specified by the transport. It is tempting to quote the original subject in
24256 automatic responses. For example:
24257 .code
24258 subject = Re: $h_subject:
24259 .endd
24260 There is a danger in doing this, however. It may allow a third party to
24261 subscribe your users to an opt-in mailing list, provided that the list accepts
24262 bounce messages as subscription confirmations. Well-managed lists require a
24263 non-bounce message to confirm a subscription, so the danger is relatively
24264 small.
24265
24266
24267
24268 .option text autoreply string&!! unset
24269 This specifies a single string to be used as the body of the message when the
24270 message is specified by the transport. If both &%text%& and &%file%& are set,
24271 the text comes first.
24272
24273
24274 .option to autoreply string&!! unset
24275 This specifies recipients of the message and the contents of the &'To:'& header
24276 when the message is specified by the transport.
24277 .ecindex IIDauttra1
24278 .ecindex IIDauttra2
24279
24280
24281
24282
24283 . ////////////////////////////////////////////////////////////////////////////
24284 . ////////////////////////////////////////////////////////////////////////////
24285
24286 .chapter "The lmtp transport" "CHAPLMTP"
24287 .cindex "transports" "&(lmtp)&"
24288 .cindex "&(lmtp)& transport"
24289 .cindex "LMTP" "over a pipe"
24290 .cindex "LMTP" "over a socket"
24291 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24292 specified command
24293 or by interacting with a Unix domain socket.
24294 This transport is something of a cross between the &(pipe)& and &(smtp)&
24295 transports. Exim also has support for using LMTP over TCP/IP; this is
24296 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24297 to be of minority interest, the default build-time configure in &_src/EDITME_&
24298 has it commented out. You need to ensure that
24299 .code
24300 TRANSPORT_LMTP=yes
24301 .endd
24302 .cindex "options" "&(lmtp)& transport"
24303 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24304 included in the Exim binary. The private options of the &(lmtp)& transport are
24305 as follows:
24306
24307 .option batch_id lmtp string&!! unset
24308 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24309
24310
24311 .option batch_max lmtp integer 1
24312 This limits the number of addresses that can be handled in a single delivery.
24313 Most LMTP servers can handle several addresses at once, so it is normally a
24314 good idea to increase this value. See the description of local delivery
24315 batching in chapter &<<CHAPbatching>>&.
24316
24317
24318 .option command lmtp string&!! unset
24319 This option must be set if &%socket%& is not set. The string is a command which
24320 is run in a separate process. It is split up into a command name and list of
24321 arguments, each of which is separately expanded (so expansion cannot change the
24322 number of arguments). The command is run directly, not via a shell. The message
24323 is passed to the new process using the standard input and output to operate the
24324 LMTP protocol.
24325
24326 .option ignore_quota lmtp boolean false
24327 .cindex "LMTP" "ignoring quota errors"
24328 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24329 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24330 in its response to the LHLO command.
24331
24332 .option socket lmtp string&!! unset
24333 This option must be set if &%command%& is not set. The result of expansion must
24334 be the name of a Unix domain socket. The transport connects to the socket and
24335 delivers the message to it using the LMTP protocol.
24336
24337
24338 .option timeout lmtp time 5m
24339 The transport is aborted if the created process or Unix domain socket does not
24340 respond to LMTP commands or message input within this timeout. Delivery
24341 is deferred, and will be tried again later. Here is an example of a typical
24342 LMTP transport:
24343 .code
24344 lmtp:
24345   driver = lmtp
24346   command = /some/local/lmtp/delivery/program
24347   batch_max = 20
24348   user = exim
24349 .endd
24350 This delivers up to 20 addresses at a time, in a mixture of domains if
24351 necessary, running as the user &'exim'&.
24352
24353
24354
24355 . ////////////////////////////////////////////////////////////////////////////
24356 . ////////////////////////////////////////////////////////////////////////////
24357
24358 .chapter "The pipe transport" "CHAPpipetransport"
24359 .scindex IIDpiptra1 "transports" "&(pipe)&"
24360 .scindex IIDpiptra2 "&(pipe)& transport"
24361 The &(pipe)& transport is used to deliver messages via a pipe to a command
24362 running in another process. One example is the use of &(pipe)& as a
24363 pseudo-remote transport for passing messages to some other delivery mechanism
24364 (such as UUCP). Another is the use by individual users to automatically process
24365 their incoming messages. The &(pipe)& transport can be used in one of the
24366 following ways:
24367
24368 .ilist
24369 .vindex "&$local_part$&"
24370 A router routes one address to a transport in the normal way, and the
24371 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24372 contains the local part of the address (as usual), and the command that is run
24373 is specified by the &%command%& option on the transport.
24374 .next
24375 .vindex "&$pipe_addresses$&"
24376 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24377 transport can handle more than one address in a single run. In this case, when
24378 more than one address is routed to the transport, &$local_part$& is not set
24379 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24380 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24381 that are routed to the transport.
24382 .next
24383 .vindex "&$address_pipe$&"
24384 A router redirects an address directly to a pipe command (for example, from an
24385 alias or forward file). In this case, &$address_pipe$& contains the text of the
24386 pipe command, and the &%command%& option on the transport is ignored unless
24387 &%force_command%& is set. If only one address is being transported
24388 (&%batch_max%& is not greater than one, or only one address was redirected to
24389 this pipe command), &$local_part$& contains the local part that was redirected.
24390 .endlist
24391
24392
24393 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24394 deliver messages over pipes using the LMTP interactive protocol. This is
24395 implemented by the &(lmtp)& transport.
24396
24397 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24398 &_.forward_& file, the command runs under the uid and gid of that user. In
24399 other cases, the uid and gid have to be specified explicitly, either on the
24400 transport or on the router that handles the address. Current and &"home"&
24401 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24402 details of the local delivery environment and chapter &<<CHAPbatching>>&
24403 for a discussion of local delivery batching.
24404
24405 .cindex "tainted data" "in pipe command"
24406 .cindex pipe "tainted data"
24407 Tainted data may not be used for the command name.
24408
24409
24410 .section "Concurrent delivery" "SECID140"
24411 If two messages arrive at almost the same time, and both are routed to a pipe
24412 delivery, the two pipe transports may be run concurrently. You must ensure that
24413 any pipe commands you set up are robust against this happening. If the commands
24414 write to a file, the &%exim_lock%& utility might be of use.
24415 Alternatively the &%max_parallel%& option could be used with a value
24416 of "1" to enforce serialization.
24417
24418
24419
24420
24421 .section "Returned status and data" "SECID141"
24422 .cindex "&(pipe)& transport" "returned data"
24423 If the command exits with a non-zero return code, the delivery is deemed to
24424 have failed, unless either the &%ignore_status%& option is set (in which case
24425 the return code is treated as zero), or the return code is one of those listed
24426 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24427 later"&. In this case, delivery is deferred. Details of a permanent failure are
24428 logged, but are not included in the bounce message, which merely contains
24429 &"local delivery failed"&.
24430
24431 If the command exits on a signal and the &%freeze_signal%& option is set then
24432 the message will be frozen in the queue. If that option is not set, a bounce
24433 will be sent as normal.
24434
24435 If the return code is greater than 128 and the command being run is a shell
24436 script, it normally means that the script was terminated by a signal whose
24437 value is the return code minus 128. The &%freeze_signal%& option does not
24438 apply in this case.
24439
24440 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24441 return code is set to 127. This is the value that a shell returns if it is
24442 asked to run a non-existent command. The wording for the log line suggests that
24443 a non-existent command may be the problem.
24444
24445 The &%return_output%& option can affect the result of a pipe delivery. If it is
24446 set and the command produces any output on its standard output or standard
24447 error streams, the command is considered to have failed, even if it gave a zero
24448 return code or if &%ignore_status%& is set. The output from the command is
24449 included as part of the bounce message. The &%return_fail_output%& option is
24450 similar, except that output is returned only when the command exits with a
24451 failure return code, that is, a value other than zero or a code that matches
24452 &%temp_errors%&.
24453
24454
24455
24456 .section "How the command is run" "SECThowcommandrun"
24457 .cindex "&(pipe)& transport" "path for command"
24458 The command line is (by default) broken down into a command name and arguments
24459 by the &(pipe)& transport itself. The &%allow_commands%& and
24460 &%restrict_to_path%& options can be used to restrict the commands that may be
24461 run.
24462
24463 .cindex "quoting" "in pipe command"
24464 Unquoted arguments are delimited by white space. If an argument appears in
24465 double quotes, backslash is interpreted as an escape character in the usual
24466 way. If an argument appears in single quotes, no escaping is done.
24467
24468 String expansion is applied to the command line except when it comes from a
24469 traditional &_.forward_& file (commands from a filter file are expanded). The
24470 expansion is applied to each argument in turn rather than to the whole line.
24471 For this reason, any string expansion item that contains white space must be
24472 quoted so as to be contained within a single argument. A setting such as
24473 .code
24474 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24475 .endd
24476 will not work, because the expansion item gets split between several
24477 arguments. You have to write
24478 .code
24479 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24480 .endd
24481 to ensure that it is all in one argument. The expansion is done in this way,
24482 argument by argument, so that the number of arguments cannot be changed as a
24483 result of expansion, and quotes or backslashes in inserted variables do not
24484 interact with external quoting. However, this leads to problems if you want to
24485 generate multiple arguments (or the command name plus arguments) from a single
24486 expansion. In this situation, the simplest solution is to use a shell. For
24487 example:
24488 .code
24489 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24490 .endd
24491
24492 .cindex "transport" "filter"
24493 .cindex "filter" "transport filter"
24494 .vindex "&$pipe_addresses$&"
24495 Special handling takes place when an argument consists of precisely the text
24496 &`$pipe_addresses`& (no quotes).
24497 This is not a general expansion variable; the only
24498 place this string is recognized is when it appears as an argument for a pipe or
24499 transport filter command. It causes each address that is being handled to be
24500 inserted in the argument list at that point &'as a separate argument'&. This
24501 avoids any problems with spaces or shell metacharacters, and is of use when a
24502 &(pipe)& transport is handling groups of addresses in a batch.
24503
24504 If &%force_command%& is enabled on the transport, special handling takes place
24505 for an argument that consists of precisely the text &`$address_pipe`&.  It
24506 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24507 argument is inserted in the argument list at that point
24508 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24509 the only item in the argument; in fact, if it were then &%force_command%&
24510 should behave as a no-op.  Rather, it should be used to adjust the command
24511 run while preserving the argument vector separation.
24512
24513 After splitting up into arguments and expansion, the resulting command is run
24514 in a subprocess directly from the transport, &'not'& under a shell. The
24515 message that is being delivered is supplied on the standard input, and the
24516 standard output and standard error are both connected to a single pipe that is
24517 read by Exim. The &%max_output%& option controls how much output the command
24518 may produce, and the &%return_output%& and &%return_fail_output%& options
24519 control what is done with it.
24520
24521 Not running the command under a shell (by default) lessens the security risks
24522 in cases when a command from a user's filter file is built out of data that was
24523 taken from an incoming message. If a shell is required, it can of course be
24524 explicitly specified as the command to be run. However, there are circumstances
24525 where existing commands (for example, in &_.forward_& files) expect to be run
24526 under a shell and cannot easily be modified. To allow for these cases, there is
24527 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24528 works. Instead of breaking up the command line as just described, it expands it
24529 as a single string and passes the result to &_/bin/sh_&. The
24530 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24531 with &%use_shell%&, and the whole mechanism is inherently less secure.
24532
24533
24534
24535 .section "Environment variables" "SECTpipeenv"
24536 .cindex "&(pipe)& transport" "environment for command"
24537 .cindex "environment" "&(pipe)& transport"
24538 The environment variables listed below are set up when the command is invoked.
24539 This list is a compromise for maximum compatibility with other MTAs. Note that
24540 the &%environment%& option can be used to add additional variables to this
24541 environment. The environment for the &(pipe)& transport is not subject
24542 to the &%add_environment%& and &%keep_environment%& main config options.
24543 .display
24544 &`DOMAIN            `&   the domain of the address
24545 &`HOME              `&   the home directory, if set
24546 &`HOST              `&   the host name when called from a router (see below)
24547 &`LOCAL_PART        `&   see below
24548 &`LOCAL_PART_PREFIX `&   see below
24549 &`LOCAL_PART_SUFFIX `&   see below
24550 &`LOGNAME           `&   see below
24551 &`MESSAGE_ID        `&   Exim's local ID for the message
24552 &`PATH              `&   as specified by the &%path%& option below
24553 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24554 &`RECIPIENT         `&   the complete recipient address
24555 &`SENDER            `&   the sender of the message (empty if a bounce)
24556 &`SHELL             `&   &`/bin/sh`&
24557 &`TZ                `&   the value of the &%timezone%& option, if set
24558 &`USER              `&   see below
24559 .endd
24560 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24561 router, LOCAL_PART is set to the local part of the address. When it is
24562 called as a result of a forward or alias expansion, LOCAL_PART is set to
24563 the local part of the address that was expanded. In both cases, any affixes are
24564 removed from the local part, and made available in LOCAL_PART_PREFIX and
24565 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24566 same value as LOCAL_PART for compatibility with other MTAs.
24567
24568 .cindex "HOST"
24569 HOST is set only when a &(pipe)& transport is called from a router that
24570 associates hosts with an address, typically when using &(pipe)& as a
24571 pseudo-remote transport. HOST is set to the first host name specified by
24572 the router.
24573
24574 .cindex "HOME"
24575 If the transport's generic &%home_directory%& option is set, its value is used
24576 for the HOME environment variable. Otherwise, a home directory may be set
24577 by the router's &%transport_home_directory%& option, which defaults to the
24578 user's home directory if &%check_local_user%& is set.
24579
24580
24581 .section "Private options for pipe" "SECID142"
24582 .cindex "options" "&(pipe)& transport"
24583
24584
24585
24586 .option allow_commands pipe "string list&!!" unset
24587 .cindex "&(pipe)& transport" "permitted commands"
24588 The string is expanded, and is then interpreted as a colon-separated list of
24589 permitted commands. If &%restrict_to_path%& is not set, the only commands
24590 permitted are those in the &%allow_commands%& list. They need not be absolute
24591 paths; the &%path%& option is still used for relative paths. If
24592 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24593 in the &%allow_commands%& list, or a name without any slashes that is found on
24594 the path. In other words, if neither &%allow_commands%& nor
24595 &%restrict_to_path%& is set, there is no restriction on the command, but
24596 otherwise only commands that are permitted by one or the other are allowed. For
24597 example, if
24598 .code
24599 allow_commands = /usr/bin/vacation
24600 .endd
24601 and &%restrict_to_path%& is not set, the only permitted command is
24602 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24603 &%use_shell%& is set.
24604
24605
24606 .option batch_id pipe string&!! unset
24607 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24608
24609
24610 .option batch_max pipe integer 1
24611 This limits the number of addresses that can be handled in a single delivery.
24612 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24613
24614
24615 .option check_string pipe string unset
24616 As &(pipe)& writes the message, the start of each line is tested for matching
24617 &%check_string%&, and if it does, the initial matching characters are replaced
24618 by the contents of &%escape_string%&, provided both are set. The value of
24619 &%check_string%& is a literal string, not a regular expression, and the case of
24620 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24621 of &%check_string%& and &%escape_string%& are forced to values that implement
24622 the SMTP escaping protocol. Any settings made in the configuration file are
24623 ignored.
24624
24625
24626 .option command pipe string&!! unset
24627 This option need not be set when &(pipe)& is being used to deliver to pipes
24628 obtained directly from address redirections. In other cases, the option must be
24629 set, to provide a command to be run. It need not yield an absolute path (see
24630 the &%path%& option below). The command is split up into separate arguments by
24631 Exim, and each argument is separately expanded, as described in section
24632 &<<SECThowcommandrun>>& above.
24633
24634
24635 .option environment pipe string&!! unset
24636 .cindex "&(pipe)& transport" "environment for command"
24637 .cindex "environment" "&(pipe)& transport"
24638 This option is used to add additional variables to the environment in which the
24639 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24640 a string which is expanded, and then interpreted as a colon-separated list of
24641 environment settings of the form <&'name'&>=<&'value'&>.
24642
24643
24644 .option escape_string pipe string unset
24645 See &%check_string%& above.
24646
24647
24648 .option freeze_exec_fail pipe boolean false
24649 .cindex "exec failure"
24650 .cindex "failure of exec"
24651 .cindex "&(pipe)& transport" "failure of exec"
24652 Failure to exec the command in a pipe transport is by default treated like
24653 any other failure while running the command. However, if &%freeze_exec_fail%&
24654 is set, failure to exec is treated specially, and causes the message to be
24655 frozen, whatever the setting of &%ignore_status%&.
24656
24657
24658 .option freeze_signal pipe boolean false
24659 .cindex "signal exit"
24660 .cindex "&(pipe)& transport", "signal exit"
24661 Normally if the process run by a command in a pipe transport exits on a signal,
24662 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24663 frozen in Exim's queue instead.
24664
24665
24666 .option force_command pipe boolean false
24667 .cindex "force command"
24668 .cindex "&(pipe)& transport", "force command"
24669 Normally when a router redirects an address directly to a pipe command
24670 the &%command%& option on the transport is ignored.  If &%force_command%&
24671 is set, the &%command%& option will used. This is especially
24672 useful for forcing a wrapper or additional argument to be added to the
24673 command. For example:
24674 .code
24675 command = /usr/bin/remote_exec myhost -- $address_pipe
24676 force_command
24677 .endd
24678
24679 Note that &$address_pipe$& is handled specially in &%command%& when
24680 &%force_command%& is set, expanding out to the original argument vector as
24681 separate items, similarly to a Unix shell &`"$@"`& construct.
24682
24683
24684 .option ignore_status pipe boolean false
24685 If this option is true, the status returned by the subprocess that is set up to
24686 run the command is ignored, and Exim behaves as if zero had been returned.
24687 Otherwise, a non-zero status or termination by signal causes an error return
24688 from the transport unless the status value is one of those listed in
24689 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24690
24691 &*Note*&: This option does not apply to timeouts, which do not return a status.
24692 See the &%timeout_defer%& option for how timeouts are handled.
24693
24694
24695 .option log_defer_output pipe boolean false
24696 .cindex "&(pipe)& transport" "logging output"
24697 If this option is set, and the status returned by the command is
24698 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24699 and any output was produced on stdout or stderr, the first line of it is
24700 written to the main log.
24701
24702
24703 .option log_fail_output pipe boolean false
24704 If this option is set, and the command returns any output on stdout or
24705 stderr, and also ends with a return code that is neither zero nor one of
24706 the return codes listed in &%temp_errors%& (that is, the delivery
24707 failed), the first line of output is written to the main log. This
24708 option and &%log_output%& are mutually exclusive.  Only one of them may
24709 be set.
24710
24711
24712 .option log_output pipe boolean false
24713 If this option is set and the command returns any output on stdout or
24714 stderr, the first line of output is written to the main log, whatever
24715 the return code. This option and &%log_fail_output%& are mutually
24716 exclusive. Only one of them may be set.
24717
24718
24719 .option max_output pipe integer 20K
24720 This specifies the maximum amount of output that the command may produce on its
24721 standard output and standard error file combined. If the limit is exceeded, the
24722 process running the command is killed. This is intended as a safety measure to
24723 catch runaway processes. The limit is applied independently of the settings of
24724 the options that control what is done with such output (for example,
24725 &%return_output%&). Because of buffering effects, the amount of output may
24726 exceed the limit by a small amount before Exim notices.
24727
24728
24729 .option message_prefix pipe string&!! "see below"
24730 The string specified here is expanded and output at the start of every message.
24731 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24732 .code
24733 message_prefix = \
24734   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24735   ${tod_bsdinbox}\n
24736 .endd
24737 .cindex "Cyrus"
24738 .cindex "&%tmail%&"
24739 .cindex "&""From""& line"
24740 This is required by the commonly used &_/usr/bin/vacation_& program.
24741 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24742 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24743 setting
24744 .code
24745 message_prefix =
24746 .endd
24747 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24748 &`\n`& to &`\r\n`& in &%message_prefix%&.
24749
24750
24751 .option message_suffix pipe string&!! "see below"
24752 The string specified here is expanded and output at the end of every message.
24753 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24754 The suffix can be suppressed by setting
24755 .code
24756 message_suffix =
24757 .endd
24758 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24759 &`\n`& to &`\r\n`& in &%message_suffix%&.
24760
24761
24762 .option path pipe string&!! "/bin:/usr/bin"
24763 This option is expanded and
24764 specifies the string that is set up in the PATH environment
24765 variable of the subprocess.
24766 If the &%command%& option does not yield an absolute path name, the command is
24767 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24768 apply to a command specified as a transport filter.
24769
24770
24771 .option permit_coredump pipe boolean false
24772 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24773 a core-dump of a pipe command, enable this command.  This enables core-dumps
24774 during delivery and affects both the Exim binary and the pipe command run.
24775 It is recommended that this option remain off unless and until you have a need
24776 for it and that this only be enabled when needed, as the risk of excessive
24777 resource consumption can be quite high.  Note also that Exim is typically
24778 installed as a setuid binary and most operating systems will inhibit coredumps
24779 of these by default, so further OS-specific action may be required.
24780
24781
24782 .option pipe_as_creator pipe boolean false
24783 .cindex "uid (user id)" "local delivery"
24784 If the generic &%user%& option is not set and this option is true, the delivery
24785 process is run under the uid that was in force when Exim was originally called
24786 to accept the message. If the group id is not otherwise set (via the generic
24787 &%group%& option), the gid that was in force when Exim was originally called to
24788 accept the message is used.
24789
24790
24791 .option restrict_to_path pipe boolean false
24792 When this option is set, any command name not listed in &%allow_commands%& must
24793 contain no slashes. The command is searched for only in the directories listed
24794 in the &%path%& option. This option is intended for use in the case when a pipe
24795 command has been generated from a user's &_.forward_& file. This is usually
24796 handled by a &(pipe)& transport called &%address_pipe%&.
24797
24798
24799 .option return_fail_output pipe boolean false
24800 If this option is true, and the command produced any output and ended with a
24801 return code other than zero or one of the codes listed in &%temp_errors%& (that
24802 is, the delivery failed), the output is returned in the bounce message.
24803 However, if the message has a null sender (that is, it is itself a bounce
24804 message), output from the command is discarded. This option and
24805 &%return_output%& are mutually exclusive. Only one of them may be set.
24806
24807
24808
24809 .option return_output pipe boolean false
24810 If this option is true, and the command produced any output, the delivery is
24811 deemed to have failed whatever the return code from the command, and the output
24812 is returned in the bounce message. Otherwise, the output is just discarded.
24813 However, if the message has a null sender (that is, it is a bounce message),
24814 output from the command is always discarded, whatever the setting of this
24815 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24816 of them may be set.
24817
24818
24819
24820 .option temp_errors pipe "string list" "see below"
24821 .cindex "&(pipe)& transport" "temporary failure"
24822 This option contains either a colon-separated list of numbers, or a single
24823 asterisk. If &%ignore_status%& is false
24824 and &%return_output%& is not set,
24825 and the command exits with a non-zero return code, the failure is treated as
24826 temporary and the delivery is deferred if the return code matches one of the
24827 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24828 codes are treated as permanent errors. The default setting contains the codes
24829 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24830 compiled on a system that does not define these macros, it assumes values of 75
24831 and 73, respectively.
24832
24833
24834 .option timeout pipe time 1h
24835 If the command fails to complete within this time, it is killed. This normally
24836 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24837 specifies no timeout. In order to ensure that any subprocesses created by the
24838 command are also killed, Exim makes the initial process a process group leader,
24839 and kills the whole process group on a timeout. However, this can be defeated
24840 if one of the processes starts a new process group.
24841
24842 .option timeout_defer pipe boolean false
24843 A timeout in a &(pipe)& transport, either in the command that the transport
24844 runs, or in a transport filter that is associated with it, is by default
24845 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24846 is set true, both kinds of timeout become temporary errors, causing the
24847 delivery to be deferred.
24848
24849 .option umask pipe "octal integer" 022
24850 This specifies the umask setting for the subprocess that runs the command.
24851
24852
24853 .option use_bsmtp pipe boolean false
24854 .cindex "envelope sender"
24855 If this option is set true, the &(pipe)& transport writes messages in &"batch
24856 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24857 commands. If you want to include a leading HELO command with such messages,
24858 you can do so by setting the &%message_prefix%& option. See section
24859 &<<SECTbatchSMTP>>& for details of batch SMTP.
24860
24861 .option use_classresources pipe boolean false
24862 .cindex "class resources (BSD)"
24863 This option is available only when Exim is running on FreeBSD, NetBSD, or
24864 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24865 resource limits when a &(pipe)& transport is run to perform a delivery. The
24866 limits for the uid under which the pipe is to run are obtained from the login
24867 class database.
24868
24869
24870 .option use_crlf pipe boolean false
24871 .cindex "carriage return"
24872 .cindex "linefeed"
24873 This option causes lines to be terminated with the two-character CRLF sequence
24874 (carriage return, linefeed) instead of just a linefeed character. In the case
24875 of batched SMTP, the byte sequence written to the pipe is then an exact image
24876 of what would be sent down a real SMTP connection.
24877
24878 The contents of the &%message_prefix%& and &%message_suffix%& options are
24879 written verbatim, so must contain their own carriage return characters if these
24880 are needed. When &%use_bsmtp%& is not set, the default values for both
24881 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24882 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24883
24884
24885 .option use_shell pipe boolean false
24886 .vindex "&$pipe_addresses$&"
24887 If this option is set, it causes the command to be passed to &_/bin/sh_&
24888 instead of being run directly from the transport, as described in section
24889 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24890 where the command is expected to be run under a shell and cannot easily be
24891 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24892 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24893 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24894 its &%-c%& option.
24895
24896
24897
24898 .section "Using an external local delivery agent" "SECID143"
24899 .cindex "local delivery" "using an external agent"
24900 .cindex "&'procmail'&"
24901 .cindex "external local delivery"
24902 .cindex "delivery" "&'procmail'&"
24903 .cindex "delivery" "by external agent"
24904 The &(pipe)& transport can be used to pass all messages that require local
24905 delivery to a separate local delivery agent such as &%procmail%&. When doing
24906 this, care must be taken to ensure that the pipe is run under an appropriate
24907 uid and gid. In some configurations one wants this to be a uid that is trusted
24908 by the delivery agent to supply the correct sender of the message. It may be
24909 necessary to recompile or reconfigure the delivery agent so that it trusts an
24910 appropriate user. The following is an example transport and router
24911 configuration for &%procmail%&:
24912 .code
24913 # transport
24914 procmail_pipe:
24915   driver = pipe
24916   command = /usr/local/bin/procmail -d $local_part_data
24917   return_path_add
24918   delivery_date_add
24919   envelope_to_add
24920   check_string = "From "
24921   escape_string = ">From "
24922   umask = 077
24923   user = $local_part_data
24924   group = mail
24925
24926 # router
24927 procmail:
24928   driver = accept
24929   check_local_user
24930   transport = procmail_pipe
24931 .endd
24932 In this example, the pipe is run as the local user, but with the group set to
24933 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24934 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24935 user to supply a correct sender address. If you do not specify either a
24936 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24937 home directory is the user's home directory by default.
24938
24939 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24940 .code
24941 IFS=" "
24942 .endd
24943 as shown in some &%procmail%& documentation, because Exim does not by default
24944 use a shell to run pipe commands.
24945
24946 .cindex "Cyrus"
24947 The next example shows a transport and a router for a system where local
24948 deliveries are handled by the Cyrus IMAP server.
24949 .code
24950 # transport
24951 local_delivery_cyrus:
24952   driver = pipe
24953   command = /usr/cyrus/bin/deliver \
24954             -m ${substr_1:$local_part_suffix} -- $local_part
24955   user = cyrus
24956   group = mail
24957   return_output
24958   log_output
24959   message_prefix =
24960   message_suffix =
24961
24962 # router
24963 local_user_cyrus:
24964   driver = accept
24965   check_local_user
24966   local_part_suffix = .*
24967   transport = local_delivery_cyrus
24968 .endd
24969 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24970 &%return_output%& to cause any text written by Cyrus to be returned to the
24971 sender.
24972 .ecindex IIDpiptra1
24973 .ecindex IIDpiptra2
24974
24975
24976 . ////////////////////////////////////////////////////////////////////////////
24977 . ////////////////////////////////////////////////////////////////////////////
24978
24979 .chapter "The smtp transport" "CHAPsmtptrans"
24980 .scindex IIDsmttra1 "transports" "&(smtp)&"
24981 .scindex IIDsmttra2 "&(smtp)& transport"
24982 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24983 or LMTP protocol. The list of hosts to try can either be taken from the address
24984 that is being processed (having been set up by the router), or specified
24985 explicitly for the transport. Timeout and retry processing (see chapter
24986 &<<CHAPretry>>&) is applied to each IP address independently.
24987
24988
24989 .section "Multiple messages on a single connection" "SECID144"
24990 The sending of multiple messages over a single TCP/IP connection can arise in
24991 two ways:
24992
24993 .ilist
24994 If a message contains more than &%max_rcpt%& (see below) addresses that are
24995 routed to the same host, more than one copy of the message has to be sent to
24996 that host. In this situation, multiple copies may be sent in a single run of
24997 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24998 does when it has too many addresses to send in one message also depends on the
24999 value of the global &%remote_max_parallel%& option. Details are given in
25000 section &<<SECToutSMTPTCP>>&.)
25001 .next
25002 .cindex "hints database" "remembering routing"
25003 When a message has been successfully delivered over a TCP/IP connection, Exim
25004 looks in its hints database to see if there are any other messages awaiting a
25005 connection to the same host. If there are, a new delivery process is started
25006 for one of them, and the current TCP/IP connection is passed on to it. The new
25007 process may in turn send multiple copies and possibly create yet another
25008 process.
25009 .endlist
25010
25011
25012 For each copy sent over the same TCP/IP connection, a sequence counter is
25013 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25014 no further messages are sent over that connection.
25015
25016
25017
25018 .section "Use of the $host and $host_address variables" "SECID145"
25019 .vindex "&$host$&"
25020 .vindex "&$host_address$&"
25021 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25022 &$host_address$& are the name and IP address of the first host on the host list
25023 passed by the router. However, when the transport is about to connect to a
25024 specific host, and while it is connected to that host, &$host$& and
25025 &$host_address$& are set to the values for that host. These are the values
25026 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25027 &%serialize_hosts%&, and the various TLS options are expanded.
25028
25029
25030 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25031 .vindex &$tls_bits$&
25032 .vindex &$tls_cipher$&
25033 .vindex &$tls_peerdn$&
25034 .vindex &$tls_sni$&
25035 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25036 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25037 are the values that were set when the message was received.
25038 These are the values that are used for options that are expanded before any
25039 SMTP connections are made. Just before each connection is made, these four
25040 variables are emptied. If TLS is subsequently started, they are set to the
25041 appropriate values for the outgoing connection, and these are the values that
25042 are in force when any authenticators are run and when the
25043 &%authenticated_sender%& option is expanded.
25044
25045 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25046 and will be removed in a future release.
25047
25048
25049 .section "Private options for smtp" "SECID146"
25050 .cindex "options" "&(smtp)& transport"
25051 The private options of the &(smtp)& transport are as follows:
25052
25053
25054 .option address_retry_include_sender smtp boolean true
25055 .cindex "4&'xx'& responses" "retrying after"
25056 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25057 is the combination of sender and recipient that is delayed in subsequent queue
25058 runs until the retry time is reached. You can delay the recipient without
25059 reference to the sender (which is what earlier versions of Exim did), by
25060 setting &%address_retry_include_sender%& false. However, this can lead to
25061 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25062
25063 .option allow_localhost smtp boolean false
25064 .cindex "local host" "sending to"
25065 .cindex "fallback" "hosts specified on transport"
25066 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25067 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25068 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25069 the delivery anyway. This should be used only in special cases when the
25070 configuration ensures that no looping will result (for example, a differently
25071 configured Exim is listening on the port to which the message is sent).
25072
25073
25074 .option authenticated_sender smtp string&!! unset
25075 .cindex "Cyrus"
25076 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25077 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25078 overriding any existing authenticated sender value. If the string expansion is
25079 forced to fail, the option is ignored. Other expansion failures cause delivery
25080 to be deferred. If the result of expansion is an empty string, that is also
25081 ignored.
25082
25083 The expansion happens after the outgoing connection has been made and TLS
25084 started, if required. This means that the &$host$&, &$host_address$&,
25085 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25086 particular connection.
25087
25088 If the SMTP session is not authenticated, the expansion of
25089 &%authenticated_sender%& still happens (and can cause the delivery to be
25090 deferred if it fails), but no AUTH= item is added to MAIL commands
25091 unless &%authenticated_sender_force%& is true.
25092
25093 This option allows you to use the &(smtp)& transport in LMTP mode to
25094 deliver mail to Cyrus IMAP and provide the proper local part as the
25095 &"authenticated sender"&, via a setting such as:
25096 .code
25097 authenticated_sender = $local_part
25098 .endd
25099 This removes the need for IMAP subfolders to be assigned special ACLs to
25100 allow direct delivery to those subfolders.
25101
25102 Because of expected uses such as that just described for Cyrus (when no
25103 domain is involved), there is no checking on the syntax of the provided
25104 value.
25105
25106
25107 .option authenticated_sender_force smtp boolean false
25108 If this option is set true, the &%authenticated_sender%& option's value
25109 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25110 authenticated as a client.
25111
25112
25113 .option command_timeout smtp time 5m
25114 .cindex timeout "smtp transport command"
25115 This sets a timeout for receiving a response to an SMTP command that has been
25116 sent out. It is also used when waiting for the initial banner line from the
25117 remote host. Its value must not be zero.
25118
25119
25120 .option connect_timeout smtp time 5m
25121 .cindex timeout "smtp transport connect"
25122 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25123 to a remote host. A setting of zero allows the system timeout (typically
25124 several minutes) to act. To have any effect, the value of this option must be
25125 less than the system timeout. However, it has been observed that on some
25126 systems there is no system timeout, which is why the default value for this
25127 option is 5 minutes, a value recommended by RFC 1123.
25128
25129
25130 .option connection_max_messages smtp integer 500
25131 .cindex "SMTP" "passed connection"
25132 .cindex "SMTP" "multiple deliveries"
25133 .cindex "multiple SMTP deliveries"
25134 This controls the maximum number of separate message deliveries that are sent
25135 over a single TCP/IP connection. If the value is zero, there is no limit.
25136 For testing purposes, this value can be overridden by the &%-oB%& command line
25137 option.
25138
25139
25140 .option dane_require_tls_ciphers smtp string&!! unset
25141 .cindex "TLS" "requiring specific ciphers for DANE"
25142 .cindex "cipher" "requiring specific"
25143 .cindex DANE "TLS ciphers"
25144 This option may be used to override &%tls_require_ciphers%& for connections
25145 where DANE has been determined to be in effect.
25146 If not set, then &%tls_require_ciphers%& will be used.
25147 Normal SMTP delivery is not able to make strong demands of TLS cipher
25148 configuration, because delivery will fall back to plaintext.  Once DANE has
25149 been determined to be in effect, there is no plaintext fallback and making the
25150 TLS cipherlist configuration stronger will increase security, rather than
25151 counter-intuitively decreasing it.
25152 If the option expands to be empty or is forced to fail, then it will
25153 be treated as unset and &%tls_require_ciphers%& will be used instead.
25154
25155
25156 .option data_timeout smtp time 5m
25157 .cindex timeout "for transmitted SMTP data blocks"
25158 This sets a timeout for the transmission of each block in the data portion of
25159 the message. As a result, the overall timeout for a message depends on the size
25160 of the message. Its value must not be zero. See also &%final_timeout%&.
25161
25162
25163 .option dkim_canon smtp string&!! unset
25164 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25165 .option dkim_domain smtp string list&!! unset
25166 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25167 .option dkim_hash smtp string&!! sha256
25168 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25169 .option dkim_identity smtp string&!! unset
25170 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25171 .option dkim_private_key smtp string&!! unset
25172 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25173 .option dkim_selector smtp string&!! unset
25174 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25175 .option dkim_strict smtp string&!! unset
25176 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25177 .option dkim_sign_headers smtp string&!! "per RFC"
25178 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25179 .option dkim_timestamps smtp string&!! unset
25180 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25181
25182
25183 .option delay_after_cutoff smtp boolean true
25184 .cindex "final cutoff" "retries, controlling"
25185 .cindex retry "final cutoff"
25186 This option controls what happens when all remote IP addresses for a given
25187 domain have been inaccessible for so long that they have passed their retry
25188 cutoff times.
25189
25190 In the default state, if the next retry time has not been reached for any of
25191 them, the address is bounced without trying any deliveries. In other words,
25192 Exim delays retrying an IP address after the final cutoff time until a new
25193 retry time is reached, and can therefore bounce an address without ever trying
25194 a delivery, when machines have been down for a long time. Some people are
25195 unhappy at this prospect, so...
25196
25197 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25198 addresses are past their final cutoff time, Exim tries to deliver to those
25199 IP addresses that have not been tried since the message arrived. If there are
25200 none, of if they all fail, the address is bounced. In other words, it does not
25201 delay when a new message arrives, but immediately tries those expired IP
25202 addresses that haven't been tried since the message arrived. If there is a
25203 continuous stream of messages for the dead hosts, unsetting
25204 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25205 to them.
25206
25207
25208 .option dns_qualify_single smtp boolean true
25209 If the &%hosts%& or &%fallback_hosts%& option is being used,
25210 and the &%gethostbyname%& option is false,
25211 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25212 in chapter &<<CHAPdnslookup>>& for more details.
25213
25214
25215 .option dns_search_parents smtp boolean false
25216 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25217 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25218 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25219 details.
25220
25221
25222 .option dnssec_request_domains smtp "domain list&!!" *
25223 .cindex "MX record" "security"
25224 .cindex "DNSSEC" "MX lookup"
25225 .cindex "security" "MX lookup"
25226 .cindex "DNS" "DNSSEC"
25227 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25228 the dnssec request bit set. Setting this transport option is only useful if the
25229 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25230 router option.
25231
25232
25233
25234 .option dnssec_require_domains smtp "domain list&!!" unset
25235 .cindex "MX record" "security"
25236 .cindex "DNSSEC" "MX lookup"
25237 .cindex "security" "MX lookup"
25238 .cindex "DNS" "DNSSEC"
25239 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25240 the dnssec request bit set.  Setting this transport option is only
25241 useful if the transport overrides or sets the host names. See the
25242 &%dnssec_require_domains%& router option.
25243
25244
25245
25246 .option dscp smtp string&!! unset
25247 .cindex "DCSP" "outbound"
25248 This option causes the DSCP value associated with a socket to be set to one
25249 of a number of fixed strings or to numeric value.
25250 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25251 Common values include &`throughput`&, &`mincost`&, and on newer systems
25252 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25253
25254 The outbound packets from Exim will be marked with this value in the header
25255 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25256 that these values will have any effect, not be stripped by networking
25257 equipment, or do much of anything without cooperation with your Network
25258 Engineer and those of all network operators between the source and destination.
25259
25260
25261 .option fallback_hosts smtp "string list" unset
25262 .cindex "fallback" "hosts specified on transport"
25263 String expansion is not applied to this option. The argument must be a
25264 colon-separated list of host names or IP addresses, optionally also including
25265 port numbers, though the separator can be changed, as described in section
25266 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25267 item in a &%route_list%& setting for the &(manualroute)& router, as described
25268 in section &<<SECTformatonehostitem>>&.
25269
25270 Fallback hosts can also be specified on routers, which associate them with the
25271 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25272 &%fallback_hosts%& specified on the transport is used only if the address does
25273 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25274 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25275 However, &%hosts_randomize%& does apply to fallback host lists.
25276
25277 If Exim is unable to deliver to any of the hosts for a particular address, and
25278 the errors are not permanent rejections, the address is put on a separate
25279 transport queue with its host list replaced by the fallback hosts, unless the
25280 address was routed via MX records and the current host was in the original MX
25281 list. In that situation, the fallback host list is not used.
25282
25283 Once normal deliveries are complete, the fallback queue is delivered by
25284 re-running the same transports with the new host lists. If several failing
25285 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25286 copy of the message is sent.
25287
25288 The resolution of the host names on the fallback list is controlled by the
25289 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25290 both to cases when the host list comes with the address and when it is taken
25291 from &%hosts%&. This option provides a &"use a smart host only if delivery
25292 fails"& facility.
25293
25294
25295 .option final_timeout smtp time 10m
25296 .cindex timeout "for transmitted SMTP data accept"
25297 This is the timeout that applies while waiting for the response to the final
25298 line containing just &"."& that terminates a message. Its value must not be
25299 zero.
25300
25301 .option gethostbyname smtp boolean false
25302 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25303 being used, names are looked up using &[gethostbyname()]&
25304 (or &[getipnodebyname()]& when available)
25305 instead of using the DNS. Of course, that function may in fact use the DNS, but
25306 it may also consult other sources of information such as &_/etc/hosts_&.
25307
25308 .option gnutls_compat_mode smtp boolean unset
25309 This option controls whether GnuTLS is used in compatibility mode in an Exim
25310 server. This reduces security slightly, but improves interworking with older
25311 implementations of TLS.
25312
25313 .option helo_data smtp string&!! "see below"
25314 .cindex "HELO" "argument, setting"
25315 .cindex "EHLO" "argument, setting"
25316 .cindex "LHLO argument setting"
25317 The value of this option is expanded after a connection to a another host has
25318 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25319 command that starts the outgoing SMTP or LMTP session. The default value of the
25320 option is:
25321 .code
25322 $primary_hostname
25323 .endd
25324 During the expansion, the variables &$host$& and &$host_address$& are set to
25325 the identity of the remote host, and the variables &$sending_ip_address$& and
25326 &$sending_port$& are set to the local IP address and port number that are being
25327 used. These variables can be used to generate different values for different
25328 servers or different local IP addresses. For example, if you want the string
25329 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25330 interface address, you could use this:
25331 .code
25332 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25333   {$primary_hostname}}
25334 .endd
25335 The use of &%helo_data%& applies both to sending messages and when doing
25336 callouts.
25337
25338 .option hosts smtp "string list&!!" unset
25339 Hosts are associated with an address by a router such as &(dnslookup)&, which
25340 finds the hosts by looking up the address domain in the DNS, or by
25341 &(manualroute)&, which has lists of hosts in its configuration. However,
25342 email addresses can be passed to the &(smtp)& transport by any router, and not
25343 all of them can provide an associated list of hosts.
25344
25345 The &%hosts%& option specifies a list of hosts to be used if the address being
25346 processed does not have any hosts associated with it. The hosts specified by
25347 &%hosts%& are also used, whether or not the address has its own hosts, if
25348 &%hosts_override%& is set.
25349
25350 The string is first expanded, before being interpreted as a colon-separated
25351 list of host names or IP addresses, possibly including port numbers. The
25352 separator may be changed to something other than colon, as described in section
25353 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25354 item in a &%route_list%& setting for the &(manualroute)& router, as described
25355 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25356 of the &(manualroute)& router is not available here.
25357
25358 If the expansion fails, delivery is deferred. Unless the failure was caused by
25359 the inability to complete a lookup, the error is logged to the panic log as
25360 well as the main log. Host names are looked up either by searching directly for
25361 address records in the DNS or by calling &[gethostbyname()]& (or
25362 &[getipnodebyname()]& when available), depending on the setting of the
25363 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25364 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25365 address are used.
25366
25367 During delivery, the hosts are tried in order, subject to their retry status,
25368 unless &%hosts_randomize%& is set.
25369
25370
25371 .option hosts_avoid_esmtp smtp "host list&!!" unset
25372 .cindex "ESMTP, avoiding use of"
25373 .cindex "HELO" "forcing use of"
25374 .cindex "EHLO" "avoiding use of"
25375 .cindex "PIPELINING" "avoiding the use of"
25376 This option is for use with broken hosts that announce ESMTP facilities (for
25377 example, PIPELINING) and then fail to implement them properly. When a host
25378 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25379 start of the SMTP session. This means that it cannot use any of the ESMTP
25380 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25381
25382
25383 .option hosts_avoid_pipelining smtp "host list&!!" unset
25384 .cindex "PIPELINING" "avoiding the use of"
25385 .cindex "ESMTP extensions" PIPELINING
25386 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25387 that matches this list, even if the server host advertises PIPELINING support.
25388
25389 .option hosts_pipe_connect smtp "host list&!!" unset
25390 .cindex "pipelining" "early connection"
25391 .cindex "pipelining" PIPE_CONNECT
25392 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25393 this option controls which to hosts the facility watched for
25394 and recorded, and used for subsequent connections.
25395
25396 The retry hints database is used for the record,
25397 and records are subject to the &%retry_data_expire%& option.
25398 When used, the pipelining saves on roundtrip times.
25399 It also turns SMTP into a client-first protocol
25400 so combines well with TCP Fast Open.
25401
25402 See also the &%pipelining_connect_advertise_hosts%& main option.
25403
25404 Note:
25405 When the facility is used, the transport &%helo_data%& option
25406 will be expanded before the &$sending_ip_address$& variable
25407 is filled in.
25408 A check is made for the use of that variable, without the
25409 presence of a &"def:"& test on it, but suitably complex coding
25410 can avoid the check and produce unexpected results.
25411 You have been warned.
25412
25413
25414 .option hosts_avoid_tls smtp "host list&!!" unset
25415 .cindex "TLS" "avoiding for certain hosts"
25416 Exim will not try to start a TLS session when delivering to any host that
25417 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25418
25419 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25420 .cindex "TLS" "avoiding for certain hosts"
25421 Exim will not try to start a TLS session for a verify callout,
25422 or when delivering in cutthrough mode,
25423 to any host that matches this list.
25424
25425
25426 .option hosts_max_try smtp integer 5
25427 .cindex "host" "maximum number to try"
25428 .cindex "limit" "number of hosts tried"
25429 .cindex "limit" "number of MX tried"
25430 .cindex "MX record" "maximum tried"
25431 This option limits the number of IP addresses that are tried for any one
25432 delivery in cases where there are temporary delivery errors. Section
25433 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25434
25435
25436 .option hosts_max_try_hardlimit smtp integer 50
25437 This is an additional check on the maximum number of IP addresses that Exim
25438 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25439 why it exists.
25440
25441
25442
25443 .option hosts_nopass_tls smtp "host list&!!" unset
25444 .cindex "TLS" "passing connection"
25445 .cindex "multiple SMTP deliveries"
25446 .cindex "TLS" "multiple message deliveries"
25447 For any host that matches this list, a connection on which a TLS session has
25448 been started will not be passed to a new delivery process for sending another
25449 message on the same connection. See section &<<SECTmulmessam>>& for an
25450 explanation of when this might be needed.
25451
25452 .option hosts_noproxy_tls smtp "host list&!!" unset
25453 .cindex "TLS" "passing connection"
25454 .cindex "multiple SMTP deliveries"
25455 .cindex "TLS" "multiple message deliveries"
25456 For any host that matches this list, a TLS session which has
25457 been started will not be passed to a new delivery process for sending another
25458 message on the same session.
25459
25460 The traditional implementation closes down TLS and re-starts it in the new
25461 process, on the same open TCP connection, for each successive message
25462 sent.  If permitted by this option a pipe to to the new process is set up
25463 instead, and the original process maintains the TLS connection and proxies
25464 the SMTP connection from and to the new process and any subsequents.
25465 The new process has no access to TLS information, so cannot include it in
25466 logging.
25467
25468
25469
25470 .option hosts_override smtp boolean false
25471 If this option is set and the &%hosts%& option is also set, any hosts that are
25472 attached to the address are ignored, and instead the hosts specified by the
25473 &%hosts%& option are always used. This option does not apply to
25474 &%fallback_hosts%&.
25475
25476
25477 .option hosts_randomize smtp boolean false
25478 .cindex "randomized host list"
25479 .cindex "host" "list of; randomized"
25480 .cindex "fallback" "randomized hosts"
25481 If this option is set, and either the list of hosts is taken from the
25482 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25483 were not obtained from MX records (this includes fallback hosts from the
25484 router), and were not randomized by the router, the order of trying the hosts
25485 is randomized each time the transport runs. Randomizing the order of a host
25486 list can be used to do crude load sharing.
25487
25488 When &%hosts_randomize%& is true, a host list may be split into groups whose
25489 order is separately randomized. This makes it possible to set up MX-like
25490 behaviour. The boundaries between groups are indicated by an item that is just
25491 &`+`& in the host list. For example:
25492 .code
25493 hosts = host1:host2:host3:+:host4:host5
25494 .endd
25495 The order of the first three hosts and the order of the last two hosts is
25496 randomized for each use, but the first three always end up before the last two.
25497 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25498
25499 .option hosts_require_auth smtp "host list&!!" unset
25500 .cindex "authentication" "required by client"
25501 This option provides a list of servers for which authentication must succeed
25502 before Exim will try to transfer a message. If authentication fails for
25503 servers which are not in this list, Exim tries to send unauthenticated. If
25504 authentication fails for one of these servers, delivery is deferred. This
25505 temporary error is detectable in the retry rules, so it can be turned into a
25506 hard failure if required. See also &%hosts_try_auth%&, and chapter
25507 &<<CHAPSMTPAUTH>>& for details of authentication.
25508
25509
25510 .option hosts_request_ocsp smtp "host list&!!" *
25511 .cindex "TLS" "requiring for certain servers"
25512 Exim will request a Certificate Status on a
25513 TLS session for any host that matches this list.
25514 &%tls_verify_certificates%& should also be set for the transport.
25515
25516 .option hosts_require_dane smtp "host list&!!" unset
25517 .cindex DANE "transport options"
25518 .cindex DANE "requiring for certain servers"
25519 If built with DANE support, Exim  will require that a DNSSEC-validated
25520 TLSA record is present for any host matching the list,
25521 and that a DANE-verified TLS connection is made. See
25522 the &%dnssec_request_domains%& router and transport options.
25523 There will be no fallback to in-clear communication.
25524 See section &<<SECDANE>>&.
25525
25526 .option hosts_require_ocsp smtp "host list&!!" unset
25527 .cindex "TLS" "requiring for certain servers"
25528 Exim will request, and check for a valid Certificate Status being given, on a
25529 TLS session for any host that matches this list.
25530 &%tls_verify_certificates%& should also be set for the transport.
25531
25532 .option hosts_require_tls smtp "host list&!!" unset
25533 .cindex "TLS" "requiring for certain servers"
25534 Exim will insist on using a TLS session when delivering to any host that
25535 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25536 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25537 incoming messages, use an appropriate ACL.
25538
25539 .option hosts_try_auth smtp "host list&!!" unset
25540 .cindex "authentication" "optional in client"
25541 This option provides a list of servers to which, provided they announce
25542 authentication support, Exim will attempt to authenticate as a client when it
25543 connects. If authentication fails
25544 .new
25545 and &%hosts_require_auth%& permits,
25546 .wen
25547 Exim will try to transfer the message unauthenticated.
25548 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25549
25550 .option hosts_try_chunking smtp "host list&!!" *
25551 .cindex CHUNKING "enabling, in client"
25552 .cindex BDAT "SMTP command"
25553 .cindex "RFC 3030" "CHUNKING"
25554 This option provides a list of servers to which, provided they announce
25555 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25556 Unless DKIM signing is being done,
25557 BDAT will not be used in conjunction with a transport filter.
25558
25559 .option hosts_try_dane smtp "host list&!!" *
25560 .cindex DANE "transport options"
25561 .cindex DANE "attempting for certain servers"
25562 If built with DANE support, Exim  will require that a DNSSEC-validated
25563 TLSA record is present for any host matching the list,
25564 and that a DANE-verified TLS connection is made. See
25565 the &%dnssec_request_domains%& router and transport options.
25566 There will be no fallback to in-clear communication.
25567 See section &<<SECDANE>>&.
25568
25569 .option hosts_try_fastopen smtp "host list&!!" *
25570 .cindex "fast open, TCP" "enabling, in client"
25571 .cindex "TCP Fast Open" "enabling, in client"
25572 .cindex "RFC 7413" "TCP Fast Open"
25573 This option provides a list of servers to which, provided
25574 the facility is supported by this system, Exim will attempt to
25575 perform a TCP Fast Open.
25576 No data is sent on the SYN segment but, if the remote server also
25577 supports the facility, it can send its SMTP banner immediately after
25578 the SYN,ACK segment.  This can save up to one round-trip time.
25579
25580 The facility is only active for previously-contacted servers,
25581 as the initiator must present a cookie in the SYN segment.
25582
25583 On (at least some) current Linux distributions the facility must be enabled
25584 in the kernel by the sysadmin before the support is usable.
25585 There is no option for control of the server side; if the system supports
25586 it it is always enabled.  Note that lengthy operations in the connect ACL,
25587 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25588
25589 .option hosts_try_prdr smtp "host list&!!" *
25590 .cindex "PRDR" "enabling, optional in client"
25591 .cindex "ESMTP extensions" PRDR
25592 This option provides a list of servers to which, provided they announce
25593 PRDR support, Exim will attempt to negotiate PRDR
25594 for multi-recipient messages.
25595 The option can usually be left as default.
25596
25597 .option interface smtp "string list&!!" unset
25598 .cindex "bind IP address"
25599 .cindex "IP address" "binding"
25600 .vindex "&$host$&"
25601 .vindex "&$host_address$&"
25602 This option specifies which interface to bind to when making an outgoing SMTP
25603 call. The value is an IP address, not an interface name such as
25604 &`eth0`&. Do not confuse this with the interface address that was used when a
25605 message was received, which is in &$received_ip_address$&, formerly known as
25606 &$interface_address$&. The name was changed to minimize confusion with the
25607 outgoing interface address. There is no variable that contains an outgoing
25608 interface address because, unless it is set by this option, its value is
25609 unknown.
25610
25611 During the expansion of the &%interface%& option the variables &$host$& and
25612 &$host_address$& refer to the host to which a connection is about to be made
25613 during the expansion of the string. Forced expansion failure, or an empty
25614 string result causes the option to be ignored. Otherwise, after expansion, the
25615 string must be a list of IP addresses, colon-separated by default, but the
25616 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25617 For example:
25618 .code
25619 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25620 .endd
25621 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25622 connection. If none of them are the correct type, the option is ignored. If
25623 &%interface%& is not set, or is ignored, the system's IP functions choose which
25624 interface to use if the host has more than one.
25625
25626
25627 .option keepalive smtp boolean true
25628 .cindex "keepalive" "on outgoing connection"
25629 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25630 connections. When set, it causes the kernel to probe idle connections
25631 periodically, by sending packets with &"old"& sequence numbers. The other end
25632 of the connection should send a acknowledgment if the connection is still okay
25633 or a reset if the connection has been aborted. The reason for doing this is
25634 that it has the beneficial effect of freeing up certain types of connection
25635 that can get stuck when the remote host is disconnected without tidying up the
25636 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25637 unreachable hosts.
25638
25639
25640 .option lmtp_ignore_quota smtp boolean false
25641 .cindex "LMTP" "ignoring quota errors"
25642 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25643 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25644 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25645
25646 .option max_rcpt smtp integer 100
25647 .cindex "RCPT" "maximum number of outgoing"
25648 This option limits the number of RCPT commands that are sent in a single
25649 SMTP message transaction. Each set of addresses is treated independently, and
25650 so can cause parallel connections to the same host if &%remote_max_parallel%&
25651 permits this.
25652
25653
25654 .new
25655 .option message_linelength_limit smtp integer 998
25656 .cindex "line length" limit
25657 This option sets the maximum line length, in bytes, that the transport
25658 will send.  Any messages with lines exceeding the given value
25659 will fail and a failure-DSN ("bounce") message will if possible be returned
25660 to the sender.
25661 The default value is that defined by the SMTP standards.
25662
25663 It is generally wise to also check in the data ACL so that messages
25664 received via SMTP can be refused without producing a bounce.
25665 .wen
25666
25667
25668 .option multi_domain smtp boolean&!! true
25669 .vindex "&$domain$&"
25670 When this option is set, the &(smtp)& transport can handle a number of
25671 addresses containing a mixture of different domains provided they all resolve
25672 to the same list of hosts. Turning the option off restricts the transport to
25673 handling only one domain at a time. This is useful if you want to use
25674 &$domain$& in an expansion for the transport, because it is set only when there
25675 is a single domain involved in a remote delivery.
25676
25677 It is expanded per-address and can depend on any of
25678 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25679 &$host$&, &$host_address$& and &$host_port$&.
25680
25681 .new
25682 If the connection is DANE-enabled then this option is ignored;
25683 only messages having the domain used for the DANE TLSA lookup are
25684 sent on the connection.
25685 .wen
25686
25687 .option port smtp string&!! "see below"
25688 .cindex "port" "sending TCP/IP"
25689 .cindex "TCP/IP" "setting outgoing port"
25690 This option specifies the TCP/IP port on the server to which Exim connects.
25691 &*Note:*& Do not confuse this with the port that was used when a message was
25692 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25693 The name was changed to minimize confusion with the outgoing port. There is no
25694 variable that contains an outgoing port.
25695
25696 If the value of this option begins with a digit it is taken as a port number;
25697 otherwise it is looked up using &[getservbyname()]&. The default value is
25698 normally &"smtp"&,
25699 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25700 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25701 If the expansion fails, or if a port number cannot be found, delivery
25702 is deferred.
25703
25704 Note that at least one Linux distribution has been seen failing
25705 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25706
25707
25708
25709 .option protocol smtp string smtp
25710 .cindex "LMTP" "over TCP/IP"
25711 .cindex "ssmtp protocol" "outbound"
25712 .cindex "TLS" "SSL-on-connect outbound"
25713 .vindex "&$port$&"
25714 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25715 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25716 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25717 deliveries into closed message stores. Exim also has support for running LMTP
25718 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25719
25720 If this option is set to &"smtps"&, the default value for the &%port%& option
25721 changes to &"smtps"&, and the transport initiates TLS immediately after
25722 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25723 The Internet standards bodies used to strongly discourage use of this mode,
25724 but as of RFC 8314 it is perferred over STARTTLS for message submission
25725 (as distinct from MTA-MTA communication).
25726
25727
25728 .option retry_include_ip_address smtp boolean&!! true
25729 Exim normally includes both the host name and the IP address in the key it
25730 constructs for indexing retry data after a temporary delivery failure. This
25731 means that when one of several IP addresses for a host is failing, it gets
25732 tried periodically (controlled by the retry rules), but use of the other IP
25733 addresses is not affected.
25734
25735 However, in some dialup environments hosts are assigned a different IP address
25736 each time they connect. In this situation the use of the IP address as part of
25737 the retry key leads to undesirable behaviour. Setting this option false causes
25738 Exim to use only the host name.
25739 Since it is expanded it can be made to depend on the host or domain.
25740
25741
25742 .option serialize_hosts smtp "host list&!!" unset
25743 .cindex "serializing connections"
25744 .cindex "host" "serializing connections"
25745 Because Exim operates in a distributed manner, if several messages for the same
25746 host arrive at around the same time, more than one simultaneous connection to
25747 the remote host can occur. This is not usually a problem except when there is a
25748 slow link between the hosts. In that situation it may be helpful to restrict
25749 Exim to one connection at a time. This can be done by setting
25750 &%serialize_hosts%& to match the relevant hosts.
25751
25752 .cindex "hints database" "serializing deliveries to a host"
25753 Exim implements serialization by means of a hints database in which a record is
25754 written whenever a process connects to one of the restricted hosts. The record
25755 is deleted when the connection is completed. Obviously there is scope for
25756 records to get left lying around if there is a system or program crash. To
25757 guard against this, Exim ignores any records that are more than six hours old.
25758
25759 If you set up this kind of serialization, you should also arrange to delete the
25760 relevant hints database whenever your system reboots. The names of the files
25761 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25762 may be one or two files, depending on the type of DBM in use. The same files
25763 are used for ETRN serialization.
25764
25765 See also the &%max_parallel%& generic transport option.
25766
25767
25768 .option size_addition smtp integer 1024
25769 .cindex "SIZE" "ESMTP extension"
25770 .cindex "message" "size issue for transport filter"
25771 .cindex "size" "of message"
25772 .cindex "transport" "filter"
25773 .cindex "filter" "transport filter"
25774 If a remote SMTP server indicates that it supports the SIZE option of the
25775 MAIL command, Exim uses this to pass over the message size at the start of
25776 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25777 sends, to allow for headers and other text that may be added during delivery by
25778 configuration options or in a transport filter. It may be necessary to increase
25779 this if a lot of text is added to messages.
25780
25781 Alternatively, if the value of &%size_addition%& is set negative, it disables
25782 the use of the SIZE option altogether.
25783
25784
25785 .option socks_proxy smtp string&!! unset
25786 .cindex proxy SOCKS
25787 This option enables use of SOCKS proxies for connections made by the
25788 transport.  For details see section &<<SECTproxySOCKS>>&.
25789
25790
25791 .option tls_certificate smtp string&!! unset
25792 .cindex "TLS" "client certificate, location of"
25793 .cindex "certificate" "client, location of"
25794 .vindex "&$host$&"
25795 .vindex "&$host_address$&"
25796 The value of this option must be the absolute path to a file which contains the
25797 client's certificate, for possible use when sending a message over an encrypted
25798 connection. The values of &$host$& and &$host_address$& are set to the name and
25799 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25800 details of TLS.
25801
25802 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25803 certificate when sending messages as a client. The global option of the same
25804 name specifies the certificate for Exim as a server; it is not automatically
25805 assumed that the same certificate should be used when Exim is operating as a
25806 client.
25807
25808
25809 .option tls_crl smtp string&!! unset
25810 .cindex "TLS" "client certificate revocation list"
25811 .cindex "certificate" "revocation list for client"
25812 This option specifies a certificate revocation list. The expanded value must
25813 be the name of a file that contains a CRL in PEM format.
25814
25815
25816 .option tls_dh_min_bits smtp integer 1024
25817 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25818 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25819 key agreement is negotiated, the server will provide a large prime number
25820 for use.  This option establishes the minimum acceptable size of that number.
25821 If the parameter offered by the server is too small, then the TLS handshake
25822 will fail.
25823
25824 Only supported when using GnuTLS.
25825
25826
25827 .option tls_privatekey smtp string&!! unset
25828 .cindex "TLS" "client private key, location of"
25829 .vindex "&$host$&"
25830 .vindex "&$host_address$&"
25831 The value of this option must be the absolute path to a file which contains the
25832 client's private key. This is used when sending a message over an encrypted
25833 connection using a client certificate. The values of &$host$& and
25834 &$host_address$& are set to the name and address of the server during the
25835 expansion. If this option is unset, or the expansion is forced to fail, or the
25836 result is an empty string, the private key is assumed to be in the same file as
25837 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25838
25839
25840 .option tls_require_ciphers smtp string&!! unset
25841 .cindex "TLS" "requiring specific ciphers"
25842 .cindex "cipher" "requiring specific"
25843 .vindex "&$host$&"
25844 .vindex "&$host_address$&"
25845 The value of this option must be a list of permitted cipher suites, for use
25846 when setting up an outgoing encrypted connection. (There is a global option of
25847 the same name for controlling incoming connections.) The values of &$host$& and
25848 &$host_address$& are set to the name and address of the server during the
25849 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25850 is used in different ways by OpenSSL and GnuTLS (see sections
25851 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25852 ciphers is a preference order.
25853
25854
25855 .new
25856 .option tls_resumption_hosts smtp "host list&!!" unset
25857 .cindex TLS resumption
25858 This option controls which connections to use the TLS resumption feature.
25859 See &<<SECTresumption>>& for details.
25860 .wen
25861
25862
25863
25864 .option tls_sni smtp string&!! unset
25865 .cindex "TLS" "Server Name Indication"
25866 .cindex "TLS" SNI
25867 .cindex SNI "setting in client"
25868 .vindex "&$tls_sni$&"
25869 If this option is set
25870 .new
25871 and the connection is not DANE-validated
25872 .wen
25873 then it sets the $tls_out_sni variable and causes any
25874 TLS session to pass this value as the Server Name Indication extension to
25875 the remote side, which can be used by the remote side to select an appropriate
25876 certificate and private key for the session.
25877
25878 See &<<SECTtlssni>>& for more information.
25879
25880 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25881 TLS extensions.
25882
25883
25884
25885
25886 .option tls_tempfail_tryclear smtp boolean true
25887 .cindex "4&'xx'& responses" "to STARTTLS"
25888 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25889 setting up a TLS session, this option determines whether or not Exim should try
25890 to deliver the message unencrypted. If it is set false, delivery to the
25891 current host is deferred; if there are other hosts, they are tried. If this
25892 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25893 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25894 TLS negotiation fails, Exim closes the current connection (because it is in an
25895 unknown state), opens a new one to the same host, and then tries the delivery
25896 in clear.
25897
25898
25899 .option tls_try_verify_hosts smtp "host list&!!" *
25900 .cindex "TLS" "server certificate verification"
25901 .cindex "certificate" "verification of server"
25902 This option gives a list of hosts for which, on encrypted connections,
25903 certificate verification will be tried but need not succeed.
25904 The &%tls_verify_certificates%& option must also be set.
25905 Note that unless the host is in this list
25906 TLS connections will be denied to hosts using self-signed certificates
25907 when &%tls_verify_certificates%& is matched.
25908 The &$tls_out_certificate_verified$& variable is set when
25909 certificate verification succeeds.
25910
25911
25912 .option tls_verify_cert_hostnames smtp "host list&!!" *
25913 .cindex "TLS" "server certificate hostname verification"
25914 .cindex "certificate" "verification of server"
25915 This option give a list of hosts for which,
25916 while verifying the server certificate,
25917 checks will be included on the host name
25918 (note that this will generally be the result of a DNS MX lookup)
25919 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25920 limited to being the initial component of a 3-or-more component FQDN.
25921
25922 There is no equivalent checking on client certificates.
25923
25924
25925 .option tls_verify_certificates smtp string&!! system
25926 .cindex "TLS" "server certificate verification"
25927 .cindex "certificate" "verification of server"
25928 .vindex "&$host$&"
25929 .vindex "&$host_address$&"
25930 The value of this option must be either the
25931 word "system"
25932 or the absolute path to
25933 a file or directory containing permitted certificates for servers,
25934 for use when setting up an encrypted connection.
25935
25936 The "system" value for the option will use a location compiled into the SSL library.
25937 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25938 is taken as empty and an explicit location
25939 must be specified.
25940
25941 The use of a directory for the option value is not available for GnuTLS versions
25942 preceding 3.3.6 and a single file must be used.
25943
25944 With OpenSSL the certificates specified
25945 explicitly
25946 either by file or directory
25947 are added to those given by the system default location.
25948
25949 The values of &$host$& and
25950 &$host_address$& are set to the name and address of the server during the
25951 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25952
25953 For back-compatibility,
25954 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25955 (a single-colon empty list counts as being set)
25956 and certificate verification fails the TLS connection is closed.
25957
25958
25959 .option tls_verify_hosts smtp "host list&!!" unset
25960 .cindex "TLS" "server certificate verification"
25961 .cindex "certificate" "verification of server"
25962 This option gives a list of hosts for which, on encrypted connections,
25963 certificate verification must succeed.
25964 The &%tls_verify_certificates%& option must also be set.
25965 If both this option and &%tls_try_verify_hosts%& are unset
25966 operation is as if this option selected all hosts.
25967
25968 .option utf8_downconvert smtp integer&!! -1
25969 .cindex utf8 "address downconversion"
25970 .cindex i18n "utf8 address downconversion"
25971 If built with internationalization support,
25972 this option controls conversion of UTF-8 in message envelope addresses
25973 to a-label form.
25974 If, after expansion, the value is 1, 0, or -1 then this value overrides
25975 any value previously set for the message.  Otherwise, any previously
25976 set value is used.  To permit use of a previous value,
25977 set this option to an empty string.
25978 For details on the values see section &<<SECTi18nMTA>>&.
25979
25980
25981
25982
25983 .section "How the limits for the number of hosts to try are used" &&&
25984          "SECTvalhosmax"
25985 .cindex "host" "maximum number to try"
25986 .cindex "limit" "hosts; maximum number tried"
25987 There are two options that are concerned with the number of hosts that are
25988 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25989 &%hosts_max_try_hardlimit%&.
25990
25991
25992 The &%hosts_max_try%& option limits the number of hosts that are tried
25993 for a single delivery. However, despite the term &"host"& in its name, the
25994 option actually applies to each IP address independently. In other words, a
25995 multihomed host is treated as several independent hosts, just as it is for
25996 retrying.
25997
25998 Many of the larger ISPs have multiple MX records which often point to
25999 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26000 created as a result of routing one of these domains.
26001
26002 Trying every single IP address on such a long list does not seem sensible; if
26003 several at the top of the list fail, it is reasonable to assume there is some
26004 problem that is likely to affect all of them. Roughly speaking, the value of
26005 &%hosts_max_try%& is the maximum number that are tried before deferring the
26006 delivery. However, the logic cannot be quite that simple.
26007
26008 Firstly, IP addresses that are skipped because their retry times have not
26009 arrived do not count, and in addition, addresses that are past their retry
26010 limits are also not counted, even when they are tried. This means that when
26011 some IP addresses are past their retry limits, more than the value of
26012 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26013 that all IP addresses are considered before timing out an email address (but
26014 see below for an exception).
26015
26016 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26017 list to see if there is a subsequent host with a different (higher valued) MX.
26018 If there is, that host is considered next, and the current IP address is used
26019 but not counted. This behaviour helps in the case of a domain with a retry rule
26020 that hardly ever delays any hosts, as is now explained:
26021
26022 Consider the case of a long list of hosts with one MX value, and a few with a
26023 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26024 hosts at the top of the list are tried at first. With the default retry rule,
26025 which specifies increasing retry times, the higher MX hosts are eventually
26026 tried when those at the top of the list are skipped because they have not
26027 reached their retry times.
26028
26029 However, it is common practice to put a fixed short retry time on domains for
26030 large ISPs, on the grounds that their servers are rarely down for very long.
26031 Unfortunately, these are exactly the domains that tend to resolve to long lists
26032 of hosts. The short retry time means that the lowest MX hosts are tried every
26033 time. The attempts may be in a different order because of random sorting, but
26034 without the special MX check, the higher MX hosts would never be tried until
26035 all the lower MX hosts had timed out (which might be several days), because
26036 there are always some lower MX hosts that have reached their retry times. With
26037 the special check, Exim considers at least one IP address from each MX value at
26038 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26039 reached.
26040
26041 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26042 particular, Exim normally eventually tries all the IP addresses before timing
26043 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26044 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26045 been set up with hundreds of IP addresses for some domains. It can
26046 take a very long time indeed for an address to time out in these cases.
26047
26048 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26049 Exim never tries more than this number of IP addresses; if it hits this limit
26050 and they are all timed out, the email address is bounced, even though not all
26051 possible IP addresses have been tried.
26052 .ecindex IIDsmttra1
26053 .ecindex IIDsmttra2
26054
26055
26056
26057
26058
26059 . ////////////////////////////////////////////////////////////////////////////
26060 . ////////////////////////////////////////////////////////////////////////////
26061
26062 .chapter "Address rewriting" "CHAPrewrite"
26063 .scindex IIDaddrew "rewriting" "addresses"
26064 There are some circumstances in which Exim automatically rewrites domains in
26065 addresses. The two most common are when an address is given without a domain
26066 (referred to as an &"unqualified address"&) or when an address contains an
26067 abbreviated domain that is expanded by DNS lookup.
26068
26069 Unqualified envelope addresses are accepted only for locally submitted
26070 messages, or for messages that are received from hosts matching
26071 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26072 appropriate. Unqualified addresses in header lines are qualified if they are in
26073 locally submitted messages, or messages from hosts that are permitted to send
26074 unqualified envelope addresses. Otherwise, unqualified addresses in header
26075 lines are neither qualified nor rewritten.
26076
26077 One situation in which Exim does &'not'& automatically rewrite a domain is
26078 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26079 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26080 do this. The new RFCs do not contain this suggestion.
26081
26082
26083 .section "Explicitly configured address rewriting" "SECID147"
26084 This chapter describes the rewriting rules that can be used in the
26085 main rewrite section of the configuration file, and also in the generic
26086 &%headers_rewrite%& option that can be set on any transport.
26087
26088 Some people believe that configured address rewriting is a Mortal Sin.
26089 Others believe that life is not possible without it. Exim provides the
26090 facility; you do not have to use it.
26091
26092 The main rewriting rules that appear in the &"rewrite"& section of the
26093 configuration file are applied to addresses in incoming messages, both envelope
26094 addresses and addresses in header lines. Each rule specifies the types of
26095 address to which it applies.
26096
26097 Whether or not addresses in header lines are rewritten depends on the origin of
26098 the headers and the type of rewriting. Global rewriting, that is, rewriting
26099 rules from the rewrite section of the configuration file, is applied only to
26100 those headers that were received with the message. Header lines that are added
26101 by ACLs or by a system filter or by individual routers or transports (which
26102 are specific to individual recipient addresses) are not rewritten by the global
26103 rules.
26104
26105 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26106 applies all headers except those added by routers and transports. That is, as
26107 well as the headers that were received with the message, it also applies to
26108 headers that were added by an ACL or a system filter.
26109
26110
26111 In general, rewriting addresses from your own system or domain has some
26112 legitimacy. Rewriting other addresses should be done only with great care and
26113 in special circumstances. The author of Exim believes that rewriting should be
26114 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26115 Although it can sometimes be used as a routing tool, this is very strongly
26116 discouraged.
26117
26118 There are two commonly encountered circumstances where rewriting is used, as
26119 illustrated by these examples:
26120
26121 .ilist
26122 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26123 exchange mail with each other behind a firewall, but there is only a single
26124 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26125 &'hitch.fict.example'& when sending mail off-site.
26126 .next
26127 A host rewrites the local parts of its own users so that, for example,
26128 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26129 .endlist
26130
26131
26132
26133 .section "When does rewriting happen?" "SECID148"
26134 .cindex "rewriting" "timing of"
26135 .cindex "&ACL;" "rewriting addresses in"
26136 Configured address rewriting can take place at several different stages of a
26137 message's processing.
26138
26139 .vindex "&$sender_address$&"
26140 At the start of an ACL for MAIL, the sender address may have been rewritten
26141 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
26142 ordinary rewrite rules have yet been applied. If, however, the sender address
26143 is verified in the ACL, it is rewritten before verification, and remains
26144 rewritten thereafter. The subsequent value of &$sender_address$& is the
26145 rewritten address. This also applies if sender verification happens in a
26146 RCPT ACL. Otherwise, when the sender address is not verified, it is
26147 rewritten as soon as a message's header lines have been received.
26148
26149 .vindex "&$domain$&"
26150 .vindex "&$local_part$&"
26151 Similarly, at the start of an ACL for RCPT, the current recipient's address
26152 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26153 rewrite rules have yet been applied to it. However, the behaviour is different
26154 from the sender address when a recipient is verified. The address is rewritten
26155 for the verification, but the rewriting is not remembered at this stage. The
26156 value of &$local_part$& and &$domain$& after verification are always the same
26157 as they were before (that is, they contain the unrewritten &-- except for
26158 SMTP-time rewriting &-- address).
26159
26160 As soon as a message's header lines have been received, all the envelope
26161 recipient addresses are permanently rewritten, and rewriting is also applied to
26162 the addresses in the header lines (if configured). This happens before adding
26163 any header lines that were specified in MAIL or RCPT ACLs, and
26164 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26165 before the DATA ACL and &[local_scan()]& functions are run.
26166
26167 When an address is being routed, either for delivery or for verification,
26168 rewriting is applied immediately to child addresses that are generated by
26169 redirection, unless &%no_rewrite%& is set on the router.
26170
26171 .cindex "envelope from"
26172 .cindex "envelope sender" "rewriting at transport time"
26173 .cindex "rewriting" "at transport time"
26174 .cindex "header lines" "rewriting at transport time"
26175 At transport time, additional rewriting of addresses in header lines can be
26176 specified by setting the generic &%headers_rewrite%& option on a transport.
26177 This option contains rules that are identical in form to those in the rewrite
26178 section of the configuration file. They are applied to the original message
26179 header lines and any that were added by ACLs or a system filter. They are not
26180 applied to header lines that are added by routers or the transport.
26181
26182 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26183 transport option. However, it is not possible to rewrite envelope recipients at
26184 transport time.
26185
26186
26187
26188
26189 .section "Testing the rewriting rules that apply on input" "SECID149"
26190 .cindex "rewriting" "testing"
26191 .cindex "testing" "rewriting"
26192 Exim's input rewriting configuration appears in a part of the runtime
26193 configuration file headed by &"begin rewrite"&. It can be tested by the
26194 &%-brw%& command line option. This takes an address (which can be a full RFC
26195 2822 address) as its argument. The output is a list of how the address would be
26196 transformed by the rewriting rules for each of the different places it might
26197 appear in an incoming message, that is, for each different header and for the
26198 envelope sender and recipient fields. For example,
26199 .code
26200 exim -brw ph10@exim.workshop.example
26201 .endd
26202 might produce the output
26203 .code
26204 sender: Philip.Hazel@exim.workshop.example
26205 from: Philip.Hazel@exim.workshop.example
26206 to: ph10@exim.workshop.example
26207 cc: ph10@exim.workshop.example
26208 bcc: ph10@exim.workshop.example
26209 reply-to: Philip.Hazel@exim.workshop.example
26210 env-from: Philip.Hazel@exim.workshop.example
26211 env-to: ph10@exim.workshop.example
26212 .endd
26213 which shows that rewriting has been set up for that address when used in any of
26214 the source fields, but not when it appears as a recipient address. At the
26215 present time, there is no equivalent way of testing rewriting rules that are
26216 set for a particular transport.
26217
26218
26219 .section "Rewriting rules" "SECID150"
26220 .cindex "rewriting" "rules"
26221 The rewrite section of the configuration file consists of lines of rewriting
26222 rules in the form
26223 .display
26224 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26225 .endd
26226 Rewriting rules that are specified for the &%headers_rewrite%& generic
26227 transport option are given as a colon-separated list. Each item in the list
26228 takes the same form as a line in the main rewriting configuration (except that
26229 any colons must be doubled, of course).
26230
26231 The formats of source patterns and replacement strings are described below.
26232 Each is terminated by white space, unless enclosed in double quotes, in which
26233 case normal quoting conventions apply inside the quotes. The flags are single
26234 characters which may appear in any order. Spaces and tabs between them are
26235 ignored.
26236
26237 For each address that could potentially be rewritten, the rules are scanned in
26238 order, and replacements for the address from earlier rules can themselves be
26239 replaced by later rules (but see the &"q"& and &"R"& flags).
26240
26241 The order in which addresses are rewritten is undefined, may change between
26242 releases, and must not be relied on, with one exception: when a message is
26243 received, the envelope sender is always rewritten first, before any header
26244 lines are rewritten. For example, the replacement string for a rewrite of an
26245 address in &'To:'& must not assume that the message's address in &'From:'& has
26246 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26247 that the envelope sender has already been rewritten.
26248
26249 .vindex "&$domain$&"
26250 .vindex "&$local_part$&"
26251 The variables &$local_part$& and &$domain$& can be used in the replacement
26252 string to refer to the address that is being rewritten. Note that lookup-driven
26253 rewriting can be done by a rule of the form
26254 .code
26255 *@*   ${lookup ...
26256 .endd
26257 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26258 refer to the address that is being rewritten.
26259
26260
26261 .section "Rewriting patterns" "SECID151"
26262 .cindex "rewriting" "patterns"
26263 .cindex "address list" "in a rewriting pattern"
26264 The source pattern in a rewriting rule is any item which may appear in an
26265 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26266 single-item address list, which means that it is expanded before being tested
26267 against the address. As always, if you use a regular expression as a pattern,
26268 you must take care to escape dollar and backslash characters, or use the &`\N`&
26269 facility to suppress string expansion within the regular expression.
26270
26271 Domains in patterns should be given in lower case. Local parts in patterns are
26272 case-sensitive. If you want to do case-insensitive matching of local parts, you
26273 can use a regular expression that starts with &`^(?i)`&.
26274
26275 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26276 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26277 depending on the type of match which occurred. These can be used in the
26278 replacement string to insert portions of the incoming address. &$0$& always
26279 refers to the complete incoming address. When a regular expression is used, the
26280 numerical variables are set from its capturing subexpressions. For other types
26281 of pattern they are set as follows:
26282
26283 .ilist
26284 If a local part or domain starts with an asterisk, the numerical variables
26285 refer to the character strings matched by asterisks, with &$1$& associated with
26286 the first asterisk, and &$2$& with the second, if present. For example, if the
26287 pattern
26288 .code
26289 *queen@*.fict.example
26290 .endd
26291 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26292 .code
26293 $0 = hearts-queen@wonderland.fict.example
26294 $1 = hearts-
26295 $2 = wonderland
26296 .endd
26297 Note that if the local part does not start with an asterisk, but the domain
26298 does, it is &$1$& that contains the wild part of the domain.
26299
26300 .next
26301 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26302 of the domain are placed in the next available numerical variables. Suppose,
26303 for example, that the address &'foo@bar.baz.example'& is processed by a
26304 rewriting rule of the form
26305 .display
26306 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26307 .endd
26308 and the key in the file that matches the domain is &`*.baz.example`&. Then
26309 .code
26310 $1 = foo
26311 $2 = bar
26312 $3 = baz.example
26313 .endd
26314 If the address &'foo@baz.example'& is looked up, this matches the same
26315 wildcard file entry, and in this case &$2$& is set to the empty string, but
26316 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26317 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26318 whole domain. For non-partial domain lookups, no numerical variables are set.
26319 .endlist
26320
26321
26322 .section "Rewriting replacements" "SECID152"
26323 .cindex "rewriting" "replacements"
26324 If the replacement string for a rule is a single asterisk, addresses that
26325 match the pattern and the flags are &'not'& rewritten, and no subsequent
26326 rewriting rules are scanned. For example,
26327 .code
26328 hatta@lookingglass.fict.example  *  f
26329 .endd
26330 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26331 &'From:'& headers.
26332
26333 .vindex "&$domain$&"
26334 .vindex "&$local_part$&"
26335 If the replacement string is not a single asterisk, it is expanded, and must
26336 yield a fully qualified address. Within the expansion, the variables
26337 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26338 Any letters they contain retain their original case &-- they are not lower
26339 cased. The numerical variables are set up according to the type of pattern that
26340 matched the address, as described above. If the expansion is forced to fail by
26341 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26342 current rule is abandoned, but subsequent rules may take effect. Any other
26343 expansion failure causes the entire rewriting operation to be abandoned, and an
26344 entry written to the panic log.
26345
26346
26347
26348 .section "Rewriting flags" "SECID153"
26349 There are three different kinds of flag that may appear on rewriting rules:
26350
26351 .ilist
26352 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26353 c, f, h, r, s, t.
26354 .next
26355 A flag that specifies rewriting at SMTP time: S.
26356 .next
26357 Flags that control the rewriting process: Q, q, R, w.
26358 .endlist
26359
26360 For rules that are part of the &%headers_rewrite%& generic transport option,
26361 E, F, T, and S are not permitted.
26362
26363
26364
26365 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26366          "SECID154"
26367 .cindex "rewriting" "flags"
26368 If none of the following flag letters, nor the &"S"& flag (see section
26369 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26370 and to both the sender and recipient fields of the envelope, whereas a
26371 transport-time rewriting rule just applies to all headers. Otherwise, the
26372 rewriting rule is skipped unless the relevant addresses are being processed.
26373 .display
26374 &`E`&       rewrite all envelope fields
26375 &`F`&       rewrite the envelope From field
26376 &`T`&       rewrite the envelope To field
26377 &`b`&       rewrite the &'Bcc:'& header
26378 &`c`&       rewrite the &'Cc:'& header
26379 &`f`&       rewrite the &'From:'& header
26380 &`h`&       rewrite all headers
26381 &`r`&       rewrite the &'Reply-To:'& header
26382 &`s`&       rewrite the &'Sender:'& header
26383 &`t`&       rewrite the &'To:'& header
26384 .endd
26385 "All headers" means all of the headers listed above that can be selected
26386 individually, plus their &'Resent-'& versions. It does not include
26387 other headers such as &'Subject:'& etc.
26388
26389 You should be particularly careful about rewriting &'Sender:'& headers, and
26390 restrict this to special known cases in your own domains.
26391
26392
26393 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26394 .cindex "SMTP" "rewriting malformed addresses"
26395 .cindex "RCPT" "rewriting argument of"
26396 .cindex "MAIL" "rewriting argument of"
26397 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26398 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26399 before any other processing; even before syntax checking. The pattern is
26400 required to be a regular expression, and it is matched against the whole of the
26401 data for the command, including any surrounding angle brackets.
26402
26403 .vindex "&$domain$&"
26404 .vindex "&$local_part$&"
26405 This form of rewrite rule allows for the handling of addresses that are not
26406 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26407 input). Because the input is not required to be a syntactically valid address,
26408 the variables &$local_part$& and &$domain$& are not available during the
26409 expansion of the replacement string. The result of rewriting replaces the
26410 original address in the MAIL or RCPT command.
26411
26412
26413 .section "Flags controlling the rewriting process" "SECID155"
26414 There are four flags which control the way the rewriting process works. These
26415 take effect only when a rule is invoked, that is, when the address is of the
26416 correct type (matches the flags) and matches the pattern:
26417
26418 .ilist
26419 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26420 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26421 absence of &"Q"& the rewritten address must always include a domain.
26422 .next
26423 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26424 even if no rewriting actually takes place because of a &"fail"& in the
26425 expansion. The &"q"& flag is not effective if the address is of the wrong type
26426 (does not match the flags) or does not match the pattern.
26427 .next
26428 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26429 address, up to ten times. It can be combined with the &"q"& flag, to stop
26430 rewriting once it fails to match (after at least one successful rewrite).
26431 .next
26432 .cindex "rewriting" "whole addresses"
26433 When an address in a header is rewritten, the rewriting normally applies only
26434 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26435 left unchanged. For example, rewriting might change
26436 .code
26437 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26438 .endd
26439 into
26440 .code
26441 From: Ford Prefect <prefectf@hitch.fict.example>
26442 .endd
26443 .cindex "RFC 2047"
26444 Sometimes there is a need to replace the whole address item, and this can be
26445 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26446 causes an address in a header line to be rewritten, the entire address is
26447 replaced, not just the working part. The replacement must be a complete RFC
26448 2822 address, including the angle brackets if necessary. If text outside angle
26449 brackets contains a character whose value is greater than 126 or less than 32
26450 (except for tab), the text is encoded according to RFC 2047. The character set
26451 is taken from &%headers_charset%&, which gets its default at build time.
26452
26453 When the &"w"& flag is set on a rule that causes an envelope address to be
26454 rewritten, all but the working part of the replacement address is discarded.
26455 .endlist
26456
26457
26458 .section "Rewriting examples" "SECID156"
26459 Here is an example of the two common rewriting paradigms:
26460 .code
26461 *@*.hitch.fict.example  $1@hitch.fict.example
26462 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26463                      {$value}fail}@hitch.fict.example bctfrF
26464 .endd
26465 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26466 the string expansion to fail if the lookup does not succeed. In this context it
26467 has the effect of leaving the original address unchanged, but Exim goes on to
26468 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26469 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26470 explicitly, which would cause the rewritten address to be the same as before,
26471 at the cost of a small bit of processing. Not supplying either of these is an
26472 error, since the rewritten address would then contain no local part.
26473
26474 The first example above replaces the domain with a superior, more general
26475 domain. This may not be desirable for certain local parts. If the rule
26476 .code
26477 root@*.hitch.fict.example  *
26478 .endd
26479 were inserted before the first rule, rewriting would be suppressed for the
26480 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26481
26482 Rewriting can be made conditional on a number of tests, by making use of
26483 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26484 messages that originate outside the local host:
26485 .code
26486 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26487                          {$1@hitch.fict.example}fail}"
26488 .endd
26489 The replacement string is quoted in this example because it contains white
26490 space.
26491
26492 .cindex "rewriting" "bang paths"
26493 .cindex "bang paths" "rewriting"
26494 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26495 an address it treats it as an unqualified local part which it qualifies with
26496 the local qualification domain (if the source of the message is local or if the
26497 remote host is permitted to send unqualified addresses). Rewriting can
26498 sometimes be used to handle simple bang paths with a fixed number of
26499 components. For example, the rule
26500 .code
26501 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26502 .endd
26503 rewrites a two-component bang path &'host.name!user'& as the domain address
26504 &'user@host.name'&. However, there is a security implication in using this as
26505 a global rewriting rule for envelope addresses. It can provide a backdoor
26506 method for using your system as a relay, because the incoming addresses appear
26507 to be local. If the bang path addresses are received via SMTP, it is safer to
26508 use the &"S"& flag to rewrite them as they are received, so that relay checking
26509 can be done on the rewritten addresses.
26510 .ecindex IIDaddrew
26511
26512
26513
26514
26515
26516 . ////////////////////////////////////////////////////////////////////////////
26517 . ////////////////////////////////////////////////////////////////////////////
26518
26519 .chapter "Retry configuration" "CHAPretry"
26520 .scindex IIDretconf1 "retry" "configuration, description of"
26521 .scindex IIDregconf2 "configuration file" "retry section"
26522 The &"retry"& section of the runtime configuration file contains a list of
26523 retry rules that control how often Exim tries to deliver messages that cannot
26524 be delivered at the first attempt. If there are no retry rules (the section is
26525 empty or not present), there are no retries. In this situation, temporary
26526 errors are treated as permanent. The default configuration contains a single,
26527 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26528 line option can be used to test which retry rule will be used for a given
26529 address, domain and error.
26530
26531 The most common cause of retries is temporary failure to deliver to a remote
26532 host because the host is down, or inaccessible because of a network problem.
26533 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26534 address) basis, not on a per-message basis. Thus, if one message has recently
26535 been delayed, delivery of a new message to the same host is not immediately
26536 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26537 log selector is set, the message
26538 .cindex "retry" "time not reached"
26539 &"retry time not reached"& is written to the main log whenever a delivery is
26540 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26541 the handling of errors during remote deliveries.
26542
26543 Retry processing applies to routing as well as to delivering, except as covered
26544 in the next paragraph. The retry rules do not distinguish between these
26545 actions. It is not possible, for example, to specify different behaviour for
26546 failures to route the domain &'snark.fict.example'& and failures to deliver to
26547 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26548 added complication, so did not implement it. However, although they share the
26549 same retry rule, the actual retry times for routing and transporting a given
26550 domain are maintained independently.
26551
26552 When a delivery is not part of a queue run (typically an immediate delivery on
26553 receipt of a message), the routers are always run, and local deliveries are
26554 always attempted, even if retry times are set for them. This makes for better
26555 behaviour if one particular message is causing problems (for example, causing
26556 quota overflow, or provoking an error in a filter file). If such a delivery
26557 suffers a temporary failure, the retry data is updated as normal, and
26558 subsequent delivery attempts from queue runs occur only when the retry time for
26559 the local address is reached.
26560
26561 .section "Changing retry rules" "SECID157"
26562 If you change the retry rules in your configuration, you should consider
26563 whether or not to delete the retry data that is stored in Exim's spool area in
26564 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26565 always safe; that is why they are called &"hints"&.
26566
26567 The hints retry data contains suggested retry times based on the previous
26568 rules. In the case of a long-running problem with a remote host, it might
26569 record the fact that the host has timed out. If your new rules increase the
26570 timeout time for such a host, you should definitely remove the old retry data
26571 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26572 messages that it should now be retaining.
26573
26574
26575
26576 .section "Format of retry rules" "SECID158"
26577 .cindex "retry" "rules"
26578 Each retry rule occupies one line and consists of three or four parts,
26579 separated by white space: a pattern, an error name, an optional list of sender
26580 addresses, and a list of retry parameters. The pattern and sender lists must be
26581 enclosed in double quotes if they contain white space. The rules are searched
26582 in order until one is found where the pattern, error name, and sender list (if
26583 present) match the failing host or address, the error that occurred, and the
26584 message's sender, respectively.
26585
26586
26587 The pattern is any single item that may appear in an address list (see section
26588 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26589 which means that it is expanded before being tested against the address that
26590 has been delayed. A negated address list item is permitted. Address
26591 list processing treats a plain domain name as if it were preceded by &"*@"&,
26592 which makes it possible for many retry rules to start with just a domain. For
26593 example,
26594 .code
26595 lookingglass.fict.example        *  F,24h,30m;
26596 .endd
26597 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26598 whereas
26599 .code
26600 alice@lookingglass.fict.example  *  F,24h,30m;
26601 .endd
26602 applies only to temporary failures involving the local part &%alice%&.
26603 In practice, almost all rules start with a domain name pattern without a local
26604 part.
26605
26606 .cindex "regular expressions" "in retry rules"
26607 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26608 must match a complete address, not just a domain, because that is how regular
26609 expressions work in address lists.
26610 .display
26611 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26612 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26613 .endd
26614
26615
26616 .section "Choosing which retry rule to use for address errors" "SECID159"
26617 When Exim is looking for a retry rule after a routing attempt has failed (for
26618 example, after a DNS timeout), each line in the retry configuration is tested
26619 against the complete address only if &%retry_use_local_part%& is set for the
26620 router. Otherwise, only the domain is used, except when matching against a
26621 regular expression, when the local part of the address is replaced with &"*"&.
26622 A domain on its own can match a domain pattern, or a pattern that starts with
26623 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26624 &%check_local_user%& is true, and false for other routers.
26625
26626 Similarly, when Exim is looking for a retry rule after a local delivery has
26627 failed (for example, after a mailbox full error), each line in the retry
26628 configuration is tested against the complete address only if
26629 &%retry_use_local_part%& is set for the transport (it defaults true for all
26630 local transports).
26631
26632 .cindex "4&'xx'& responses" "retry rules for"
26633 However, when Exim is looking for a retry rule after a remote delivery attempt
26634 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26635 whole address is always used as the key when searching the retry rules. The
26636 rule that is found is used to create a retry time for the combination of the
26637 failing address and the message's sender. It is the combination of sender and
26638 recipient that is delayed in subsequent queue runs until its retry time is
26639 reached. You can delay the recipient without regard to the sender by setting
26640 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26641 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26642 commands.
26643
26644
26645
26646 .section "Choosing which retry rule to use for host and message errors" &&&
26647          "SECID160"
26648 For a temporary error that is not related to an individual address (for
26649 example, a connection timeout), each line in the retry configuration is checked
26650 twice. First, the name of the remote host is used as a domain name (preceded by
26651 &"*@"& when matching a regular expression). If this does not match the line,
26652 the domain from the email address is tried in a similar fashion. For example,
26653 suppose the MX records for &'a.b.c.example'& are
26654 .code
26655 a.b.c.example  MX  5  x.y.z.example
26656                MX  6  p.q.r.example
26657                MX  7  m.n.o.example
26658 .endd
26659 and the retry rules are
26660 .code
26661 p.q.r.example    *      F,24h,30m;
26662 a.b.c.example    *      F,4d,45m;
26663 .endd
26664 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26665 first rule matches neither the host nor the domain, so Exim looks at the second
26666 rule. This does not match the host, but it does match the domain, so it is used
26667 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26668 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26669 first retry rule is used, because it matches the host.
26670
26671 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26672 first rule to determine retry times, but for all the other hosts for the domain
26673 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26674 routing to &'a.b.c.example'& suffers a temporary failure.
26675
26676 &*Note*&: The host name is used when matching the patterns, not its IP address.
26677 However, if a message is routed directly to an IP address without the use of a
26678 host name, for example, if a &(manualroute)& router contains a setting such as:
26679 .code
26680 route_list = *.a.example  192.168.34.23
26681 .endd
26682 then the &"host name"& that is used when searching for a retry rule is the
26683 textual form of the IP address.
26684
26685 .section "Retry rules for specific errors" "SECID161"
26686 .cindex "retry" "specific errors; specifying"
26687 The second field in a retry rule is the name of a particular error, or an
26688 asterisk, which matches any error. The errors that can be tested for are:
26689
26690 .vlist
26691 .vitem &%auth_failed%&
26692 Authentication failed when trying to send to a host in the
26693 &%hosts_require_auth%& list in an &(smtp)& transport.
26694
26695 .vitem &%data_4xx%&
26696 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26697 after the command, or after sending the message's data.
26698
26699 .vitem &%mail_4xx%&
26700 A 4&'xx'& error was received for an outgoing MAIL command.
26701
26702 .vitem &%rcpt_4xx%&
26703 A 4&'xx'& error was received for an outgoing RCPT command.
26704 .endlist
26705
26706 For the three 4&'xx'& errors, either the first or both of the x's can be given
26707 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26708 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26709 and have retries every ten minutes with a one-hour timeout, you could set up a
26710 retry rule of this form:
26711 .code
26712 the.domain.name  rcpt_452   F,1h,10m
26713 .endd
26714 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26715 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26716
26717 .vlist
26718 .vitem &%lost_connection%&
26719 A server unexpectedly closed the SMTP connection. There may, of course,
26720 legitimate reasons for this (host died, network died), but if it repeats a lot
26721 for the same host, it indicates something odd.
26722
26723 .vitem &%lookup%&
26724 A DNS lookup for a host failed.
26725 Note that a &%dnslookup%& router will need to have matched
26726 its &%fail_defer_domains%& option for this retry type to be usable.
26727 Also note that a &%manualroute%& router will probably need
26728 its &%host_find_failed%& option set to &%defer%&.
26729
26730 .vitem &%refused_MX%&
26731 A connection to a host obtained from an MX record was refused.
26732
26733 .vitem &%refused_A%&
26734 A connection to a host not obtained from an MX record was refused.
26735
26736 .vitem &%refused%&
26737 A connection was refused.
26738
26739 .vitem &%timeout_connect_MX%&
26740 A connection attempt to a host obtained from an MX record timed out.
26741
26742 .vitem &%timeout_connect_A%&
26743 A connection attempt to a host not obtained from an MX record timed out.
26744
26745 .vitem &%timeout_connect%&
26746 A connection attempt timed out.
26747
26748 .vitem &%timeout_MX%&
26749 There was a timeout while connecting or during an SMTP session with a host
26750 obtained from an MX record.
26751
26752 .vitem &%timeout_A%&
26753 There was a timeout while connecting or during an SMTP session with a host not
26754 obtained from an MX record.
26755
26756 .vitem &%timeout%&
26757 There was a timeout while connecting or during an SMTP session.
26758
26759 .vitem &%tls_required%&
26760 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26761 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26762 to STARTTLS, or there was a problem setting up the TLS connection.
26763
26764 .vitem &%quota%&
26765 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26766 transport.
26767
26768 .vitem &%quota_%&<&'time'&>
26769 .cindex "quota" "error testing in retry rule"
26770 .cindex "retry" "quota error testing"
26771 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26772 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26773 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26774 for four days.
26775 .endlist
26776
26777 .cindex "mailbox" "time of last read"
26778 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26779 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26780 it should be based on the last time that the user accessed the mailbox.
26781 However, it is not always possible to determine this. Exim uses the following
26782 heuristic rules:
26783
26784 .ilist
26785 If the mailbox is a single file, the time of last access (the &"atime"&) is
26786 used. As no new messages are being delivered (because the mailbox is over
26787 quota), Exim does not access the file, so this is the time of last user access.
26788 .next
26789 .cindex "maildir format" "time of last read"
26790 For a maildir delivery, the time of last modification of the &_new_&
26791 subdirectory is used. As the mailbox is over quota, no new files are created in
26792 the &_new_& subdirectory, because no new messages are being delivered. Any
26793 change to the &_new_& subdirectory is therefore assumed to be the result of an
26794 MUA moving a new message to the &_cur_& directory when it is first read. The
26795 time that is used is therefore the last time that the user read a new message.
26796 .next
26797 For other kinds of multi-file mailbox, the time of last access cannot be
26798 obtained, so a retry rule that uses this type of error field is never matched.
26799 .endlist
26800
26801 The quota errors apply both to system-enforced quotas and to Exim's own quota
26802 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26803 when a local delivery is deferred because a partition is full (the ENOSPC
26804 error).
26805
26806
26807
26808 .section "Retry rules for specified senders" "SECID162"
26809 .cindex "retry" "rules; sender-specific"
26810 You can specify retry rules that apply only when the failing message has a
26811 specific sender. In particular, this can be used to define retry rules that
26812 apply only to bounce messages. The third item in a retry rule can be of this
26813 form:
26814 .display
26815 &`senders=`&<&'address list'&>
26816 .endd
26817 The retry timings themselves are then the fourth item. For example:
26818 .code
26819 *   rcpt_4xx   senders=:   F,1h,30m
26820 .endd
26821 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26822 host. If the address list contains white space, it must be enclosed in quotes.
26823 For example:
26824 .code
26825 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26826 .endd
26827 &*Warning*&: This facility can be unhelpful if it is used for host errors
26828 (which do not depend on the recipient). The reason is that the sender is used
26829 only to match the retry rule. Once the rule has been found for a host error,
26830 its contents are used to set a retry time for the host, and this will apply to
26831 all messages, not just those with specific senders.
26832
26833 When testing retry rules using &%-brt%&, you can supply a sender using the
26834 &%-f%& command line option, like this:
26835 .code
26836 exim -f "" -brt user@dom.ain
26837 .endd
26838 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26839 list is never matched.
26840
26841
26842
26843
26844
26845 .section "Retry parameters" "SECID163"
26846 .cindex "retry" "parameters in rules"
26847 The third (or fourth, if a senders list is present) field in a retry rule is a
26848 sequence of retry parameter sets, separated by semicolons. Each set consists of
26849 .display
26850 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26851 .endd
26852 The letter identifies the algorithm for computing a new retry time; the cutoff
26853 time is the time beyond which this algorithm no longer applies, and the
26854 arguments vary the algorithm's action. The cutoff time is measured from the
26855 time that the first failure for the domain (combined with the local part if
26856 relevant) was detected, not from the time the message was received.
26857
26858 .cindex "retry" "algorithms"
26859 .cindex "retry" "fixed intervals"
26860 .cindex "retry" "increasing intervals"
26861 .cindex "retry" "random intervals"
26862 The available algorithms are:
26863
26864 .ilist
26865 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26866 the interval.
26867 .next
26868 &'G'&: retry at geometrically increasing intervals. The first argument
26869 specifies a starting value for the interval, and the second a multiplier, which
26870 is used to increase the size of the interval at each retry.
26871 .next
26872 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26873 retry, the previous interval is multiplied by the factor in order to get a
26874 maximum for the next interval. The minimum interval is the first argument of
26875 the parameter, and an actual interval is chosen randomly between them. Such a
26876 rule has been found to be helpful in cluster configurations when all the
26877 members of the cluster restart at once, and may therefore synchronize their
26878 queue processing times.
26879 .endlist
26880
26881 When computing the next retry time, the algorithm definitions are scanned in
26882 order until one whose cutoff time has not yet passed is reached. This is then
26883 used to compute a new retry time that is later than the current time. In the
26884 case of fixed interval retries, this simply means adding the interval to the
26885 current time. For geometrically increasing intervals, retry intervals are
26886 computed from the rule's parameters until one that is greater than the previous
26887 interval is found. The main configuration variable
26888 .cindex "limit" "retry interval"
26889 .cindex "retry" "interval, maximum"
26890 .oindex "&%retry_interval_max%&"
26891 &%retry_interval_max%& limits the maximum interval between retries. It
26892 cannot be set greater than &`24h`&, which is its default value.
26893
26894 A single remote domain may have a number of hosts associated with it, and each
26895 host may have more than one IP address. Retry algorithms are selected on the
26896 basis of the domain name, but are applied to each IP address independently. If,
26897 for example, a host has two IP addresses and one is unusable, Exim will
26898 generate retry times for it and will not try to use it until its next retry
26899 time comes. Thus the good IP address is likely to be tried first most of the
26900 time.
26901
26902 .cindex "hints database" "use for retrying"
26903 Retry times are hints rather than promises. Exim does not make any attempt to
26904 run deliveries exactly at the computed times. Instead, a queue runner process
26905 starts delivery processes for delayed messages periodically, and these attempt
26906 new deliveries only for those addresses that have passed their next retry time.
26907 If a new message arrives for a deferred address, an immediate delivery attempt
26908 occurs only if the address has passed its retry time. In the absence of new
26909 messages, the minimum time between retries is the interval between queue runner
26910 processes. There is not much point in setting retry times of five minutes if
26911 your queue runners happen only once an hour, unless there are a significant
26912 number of incoming messages (which might be the case on a system that is
26913 sending everything to a smart host, for example).
26914
26915 The data in the retry hints database can be inspected by using the
26916 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26917 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26918 &'exinext'& utility script can be used to find out what the next retry times
26919 are for the hosts associated with a particular mail domain, and also for local
26920 deliveries that have been deferred.
26921
26922
26923 .section "Retry rule examples" "SECID164"
26924 Here are some example retry rules:
26925 .code
26926 alice@wonderland.fict.example quota_5d  F,7d,3h
26927 wonderland.fict.example       quota_5d
26928 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26929 lookingglass.fict.example     *         F,24h,30m;
26930 *                 refused_A   F,2h,20m;
26931 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26932 .endd
26933 The first rule sets up special handling for mail to
26934 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26935 mailbox has not been read for at least 5 days. Retries continue every three
26936 hours for 7 days. The second rule handles over-quota errors for all other local
26937 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26938 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26939 fail are bounced immediately if the mailbox has not been read for at least 5
26940 days.
26941
26942 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26943 happen every 15 minutes for an hour, then with geometrically increasing
26944 intervals until two days have passed since a delivery first failed. After the
26945 first hour there is a delay of one hour, then two hours, then four hours, and
26946 so on (this is a rather extreme example).
26947
26948 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26949 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26950 all other domains, with special action for connection refusal from hosts that
26951 were not obtained from an MX record.
26952
26953 The final rule in a retry configuration should always have asterisks in the
26954 first two fields so as to provide a general catch-all for any addresses that do
26955 not have their own special handling. This example tries every 15 minutes for 2
26956 hours, then with intervals starting at one hour and increasing by a factor of
26957 1.5 up to 16 hours, then every 8 hours up to 5 days.
26958
26959
26960
26961 .section "Timeout of retry data" "SECID165"
26962 .cindex "timeout" "of retry data"
26963 .oindex "&%retry_data_expire%&"
26964 .cindex "hints database" "data expiry"
26965 .cindex "retry" "timeout of data"
26966 Exim timestamps the data that it writes to its retry hints database. When it
26967 consults the data during a delivery it ignores any that is older than the value
26968 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26969 been tried for 7 days, Exim will try to deliver to it immediately a message
26970 arrives, and if that fails, it will calculate a retry time as if it were
26971 failing for the first time.
26972
26973 This improves the behaviour for messages routed to rarely-used hosts such as MX
26974 backups. If such a host was down at one time, and happens to be down again when
26975 Exim tries a month later, using the old retry data would imply that it had been
26976 down all the time, which is not a justified assumption.
26977
26978 If a host really is permanently dead, this behaviour causes a burst of retries
26979 every now and again, but only if messages routed to it are rare. If there is a
26980 message at least once every 7 days the retry data never expires.
26981
26982
26983
26984
26985 .section "Long-term failures" "SECID166"
26986 .cindex "delivery failure, long-term"
26987 .cindex "retry" "after long-term failure"
26988 Special processing happens when an email address has been failing for so long
26989 that the cutoff time for the last algorithm is reached. For example, using the
26990 default retry rule:
26991 .code
26992 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26993 .endd
26994 the cutoff time is four days. Reaching the retry cutoff is independent of how
26995 long any specific message has been failing; it is the length of continuous
26996 failure for the recipient address that counts.
26997
26998 When the cutoff time is reached for a local delivery, or for all the IP
26999 addresses associated with a remote delivery, a subsequent delivery failure
27000 causes Exim to give up on the address, and a bounce message is generated.
27001 In order to cater for new messages that use the failing address, a next retry
27002 time is still computed from the final algorithm, and is used as follows:
27003
27004 For local deliveries, one delivery attempt is always made for any subsequent
27005 messages. If this delivery fails, the address fails immediately. The
27006 post-cutoff retry time is not used.
27007
27008 .cindex "final cutoff" "retries, controlling"
27009 .cindex retry "final cutoff"
27010 If the delivery is remote, there are two possibilities, controlled by the
27011 .oindex "&%delay_after_cutoff%&"
27012 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27013 default. Until the post-cutoff retry time for one of the IP addresses,
27014 as set by the &%retry_data_expire%& option, is
27015 reached, the failing email address is bounced immediately, without a delivery
27016 attempt taking place. After that time, one new delivery attempt is made to
27017 those IP addresses that are past their retry times, and if that still fails,
27018 the address is bounced and new retry times are computed.
27019
27020 In other words, when all the hosts for a given email address have been failing
27021 for a long time, Exim bounces rather then defers until one of the hosts' retry
27022 times is reached. Then it tries once, and bounces if that attempt fails. This
27023 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27024 to a broken destination, but if the host does recover, Exim will eventually
27025 notice.
27026
27027 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27028 addresses are past their final cutoff time, Exim tries to deliver to those IP
27029 addresses that have not been tried since the message arrived. If there are
27030 no suitable IP addresses, or if they all fail, the address is bounced. In other
27031 words, it does not delay when a new message arrives, but tries the expired
27032 addresses immediately, unless they have been tried since the message arrived.
27033 If there is a continuous stream of messages for the failing domains, setting
27034 &%delay_after_cutoff%& false means that there will be many more attempts to
27035 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27036 true.
27037
27038 .section "Deliveries that work intermittently" "SECID167"
27039 .cindex "retry" "intermittently working deliveries"
27040 Some additional logic is needed to cope with cases where a host is
27041 intermittently available, or when a message has some attribute that prevents
27042 its delivery when others to the same address get through. In this situation,
27043 because some messages are successfully delivered, the &"retry clock"& for the
27044 host or address keeps getting reset by the successful deliveries, and so
27045 failing messages remain in the queue for ever because the cutoff time is never
27046 reached.
27047
27048 Two exceptional actions are applied to prevent this happening. The first
27049 applies to errors that are related to a message rather than a remote host.
27050 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27051 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27052 commands, and quota failures. For this type of error, if a message's arrival
27053 time is earlier than the &"first failed"& time for the error, the earlier time
27054 is used when scanning the retry rules to decide when to try next and when to
27055 time out the address.
27056
27057 The exceptional second action applies in all cases. If a message has been on
27058 the queue for longer than the cutoff time of any applicable retry rule for a
27059 given address, a delivery is attempted for that address, even if it is not yet
27060 time, and if this delivery fails, the address is timed out. A new retry time is
27061 not computed in this case, so that other messages for the same address are
27062 considered immediately.
27063 .ecindex IIDretconf1
27064 .ecindex IIDregconf2
27065
27066
27067
27068
27069
27070
27071 . ////////////////////////////////////////////////////////////////////////////
27072 . ////////////////////////////////////////////////////////////////////////////
27073
27074 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27075 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27076 .scindex IIDauthconf2 "authentication"
27077 The &"authenticators"& section of Exim's runtime configuration is concerned
27078 with SMTP authentication. This facility is an extension to the SMTP protocol,
27079 described in RFC 2554, which allows a client SMTP host to authenticate itself
27080 to a server. This is a common way for a server to recognize clients that are
27081 permitted to use it as a relay. SMTP authentication is not of relevance to the
27082 transfer of mail between servers that have no managerial connection with each
27083 other.
27084
27085 .cindex "AUTH" "description of"
27086 .cindex "ESMTP extensions" AUTH
27087 Very briefly, the way SMTP authentication works is as follows:
27088
27089 .ilist
27090 The server advertises a number of authentication &'mechanisms'& in response to
27091 the client's EHLO command.
27092 .next
27093 The client issues an AUTH command, naming a specific mechanism. The command
27094 may, optionally, contain some authentication data.
27095 .next
27096 The server may issue one or more &'challenges'&, to which the client must send
27097 appropriate responses. In simple authentication mechanisms, the challenges are
27098 just prompts for user names and passwords. The server does not have to issue
27099 any challenges &-- in some mechanisms the relevant data may all be transmitted
27100 with the AUTH command.
27101 .next
27102 The server either accepts or denies authentication.
27103 .next
27104 If authentication succeeds, the client may optionally make use of the AUTH
27105 option on the MAIL command to pass an authenticated sender in subsequent
27106 mail transactions. Authentication lasts for the remainder of the SMTP
27107 connection.
27108 .next
27109 If authentication fails, the client may give up, or it may try a different
27110 authentication mechanism, or it may try transferring mail over the
27111 unauthenticated connection.
27112 .endlist
27113
27114 If you are setting up a client, and want to know which authentication
27115 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27116 SMTP port) on the server, and issue an EHLO command. The response to this
27117 includes the list of supported mechanisms. For example:
27118 .display
27119 &`$ `&&*&`telnet server.example 25`&*&
27120 &`Trying 192.168.34.25...`&
27121 &`Connected to server.example.`&
27122 &`Escape character is &#x0027;^]&#x0027;.`&
27123 &`220 server.example ESMTP Exim 4.20 ...`&
27124 &*&`ehlo client.example`&*&
27125 &`250-server.example Hello client.example [10.8.4.5]`&
27126 &`250-SIZE 52428800`&
27127 &`250-PIPELINING`&
27128 &`250-AUTH PLAIN`&
27129 &`250 HELP`&
27130 .endd
27131 The second-last line of this example output shows that the server supports
27132 authentication using the PLAIN mechanism. In Exim, the different authentication
27133 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27134 routers and transports, which authenticators are included in the binary is
27135 controlled by build-time definitions. The following are currently available,
27136 included by setting
27137 .code
27138 AUTH_CRAM_MD5=yes
27139 AUTH_CYRUS_SASL=yes
27140 AUTH_DOVECOT=yes
27141 AUTH_EXTERNAL=yes
27142 AUTH_GSASL=yes
27143 AUTH_HEIMDAL_GSSAPI=yes
27144 AUTH_PLAINTEXT=yes
27145 AUTH_SPA=yes
27146 AUTH_TLS=yes
27147 .endd
27148 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27149 authentication mechanism (RFC 2195), and the second provides an interface to
27150 the Cyrus SASL authentication library.
27151 The third is an interface to Dovecot's authentication system, delegating the
27152 work via a socket interface.
27153 The fourth provides for negotiation of authentication done via non-SMTP means,
27154 as defined by RFC 4422 Appendix A.
27155 The fifth provides an interface to the GNU SASL authentication library, which
27156 provides mechanisms but typically not data sources.
27157 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27158 supporting setting a server keytab.
27159 The seventh can be configured to support
27160 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27161 not formally documented, but used by several MUAs.
27162 The eighth authenticator
27163 supports Microsoft's &'Secure Password Authentication'& mechanism.
27164 The last is an Exim authenticator but not an SMTP one;
27165 instead it can use information from a TLS negotiation.
27166
27167 The authenticators are configured using the same syntax as other drivers (see
27168 section &<<SECTfordricon>>&). If no authenticators are required, no
27169 authentication section need be present in the configuration file. Each
27170 authenticator can in principle have both server and client functions. When Exim
27171 is receiving SMTP mail, it is acting as a server; when it is sending out
27172 messages over SMTP, it is acting as a client. Authenticator configuration
27173 options are provided for use in both these circumstances.
27174
27175 To make it clear which options apply to which situation, the prefixes
27176 &%server_%& and &%client_%& are used on option names that are specific to
27177 either the server or the client function, respectively. Server and client
27178 functions are disabled if none of their options are set. If an authenticator is
27179 to be used for both server and client functions, a single definition, using
27180 both sets of options, is required. For example:
27181 .code
27182 cram:
27183   driver = cram_md5
27184   public_name = CRAM-MD5
27185   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27186   client_name = ph10
27187   client_secret = secret2
27188 .endd
27189 The &%server_%& option is used when Exim is acting as a server, and the
27190 &%client_%& options when it is acting as a client.
27191
27192 Descriptions of the individual authenticators are given in subsequent chapters.
27193 The remainder of this chapter covers the generic options for the
27194 authenticators, followed by general discussion of the way authentication works
27195 in Exim.
27196
27197 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27198 per-mechanism basis.  Please read carefully to determine which variables hold
27199 account labels such as usercodes and which hold passwords or other
27200 authenticating data.
27201
27202 Note that some mechanisms support two different identifiers for accounts: the
27203 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27204 and &'authz'& are commonly encountered.  The American spelling is standard here.
27205 Conceptually, authentication data such as passwords are tied to the identifier
27206 used to authenticate; servers may have rules to permit one user to act as a
27207 second user, so that after login the session is treated as though that second
27208 user had logged in.  That second user is the &'authorization id'&.  A robust
27209 configuration might confirm that the &'authz'& field is empty or matches the
27210 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27211 as verified data, the &'authz'& as an unverified request which the server might
27212 choose to honour.
27213
27214 A &'realm'& is a text string, typically a domain name, presented by a server
27215 to a client to help it select an account and credentials to use.  In some
27216 mechanisms, the client and server provably agree on the realm, but clients
27217 typically can not treat the realm as secure data to be blindly trusted.
27218
27219
27220
27221 .section "Generic options for authenticators" "SECID168"
27222 .cindex "authentication" "generic options"
27223 .cindex "options" "generic; for authenticators"
27224
27225 .option client_condition authenticators string&!! unset
27226 When Exim is authenticating as a client, it skips any authenticator whose
27227 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27228 used, for example, to skip plain text authenticators when the connection is not
27229 encrypted by a setting such as:
27230 .code
27231 client_condition = ${if !eq{$tls_out_cipher}{}}
27232 .endd
27233
27234
27235 .option client_set_id authenticators string&!! unset
27236 When client authentication succeeds, this condition is expanded; the
27237 result is used in the log lines for outbound messages.
27238 Typically it will be the user name used for authentication.
27239
27240
27241 .option driver authenticators string unset
27242 This option must always be set. It specifies which of the available
27243 authenticators is to be used.
27244
27245
27246 .option public_name authenticators string unset
27247 This option specifies the name of the authentication mechanism that the driver
27248 implements, and by which it is known to the outside world. These names should
27249 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27250 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27251 defaults to the driver's instance name.
27252
27253
27254 .option server_advertise_condition authenticators string&!! unset
27255 When a server is about to advertise an authentication mechanism, the condition
27256 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27257 mechanism is not advertised.
27258 If the expansion fails, the mechanism is not advertised. If the failure was not
27259 forced, and was not caused by a lookup defer, the incident is logged.
27260 See section &<<SECTauthexiser>>& below for further discussion.
27261
27262
27263 .option server_condition authenticators string&!! unset
27264 This option must be set for a &%plaintext%& server authenticator, where it
27265 is used directly to control authentication. See section &<<SECTplainserver>>&
27266 for details.
27267
27268 For the &(gsasl)& authenticator, this option is required for various
27269 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27270
27271 For the other authenticators, &%server_condition%& can be used as an additional
27272 authentication or authorization mechanism that is applied after the other
27273 authenticator conditions succeed. If it is set, it is expanded when the
27274 authenticator would otherwise return a success code. If the expansion is forced
27275 to fail, authentication fails. Any other expansion failure causes a temporary
27276 error code to be returned. If the result of a successful expansion is an empty
27277 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27278 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27279 other result, a temporary error code is returned, with the expanded string as
27280 the error text.
27281
27282
27283 .option server_debug_print authenticators string&!! unset
27284 If this option is set and authentication debugging is enabled (see the &%-d%&
27285 command line option), the string is expanded and included in the debugging
27286 output when the authenticator is run as a server. This can help with checking
27287 out the values of variables.
27288 If expansion of the string fails, the error message is written to the debugging
27289 output, and Exim carries on processing.
27290
27291
27292 .option server_set_id authenticators string&!! unset
27293 .vindex "&$authenticated_id$&"
27294 .vindex "&$authenticated_fail_id$&"
27295 When an Exim server successfully authenticates a client, this string is
27296 expanded using data from the authentication, and preserved for any incoming
27297 messages in the variable &$authenticated_id$&. It is also included in the log
27298 lines for incoming messages. For example, a user/password authenticator
27299 configuration might preserve the user name that was used to authenticate, and
27300 refer to it subsequently during delivery of the message.
27301 On a failing authentication the expansion result is instead saved in
27302 the &$authenticated_fail_id$& variable.
27303 If expansion fails, the option is ignored.
27304
27305
27306 .option server_mail_auth_condition authenticators string&!! unset
27307 This option allows a server to discard authenticated sender addresses supplied
27308 as part of MAIL commands in SMTP connections that are authenticated by the
27309 driver on which &%server_mail_auth_condition%& is set. The option is not used
27310 as part of the authentication process; instead its (unexpanded) value is
27311 remembered for later use.
27312 How it is used is described in the following section.
27313
27314
27315
27316
27317
27318 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27319 .cindex "authentication" "sender; authenticated"
27320 .cindex "AUTH" "on MAIL command"
27321 When a client supplied an AUTH= item on a MAIL command, Exim applies
27322 the following checks before accepting it as the authenticated sender of the
27323 message:
27324
27325 .ilist
27326 If the connection is not using extended SMTP (that is, HELO was used rather
27327 than EHLO), the use of AUTH= is a syntax error.
27328 .next
27329 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27330 .next
27331 .vindex "&$authenticated_sender$&"
27332 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27333 running, the value of &$authenticated_sender$& is set to the value obtained
27334 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27335 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27336 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27337 given for the MAIL command.
27338 .next
27339 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27340 is accepted and placed in &$authenticated_sender$& only if the client has
27341 authenticated.
27342 .next
27343 If the AUTH= value was accepted by either of the two previous rules, and
27344 the client has authenticated, and the authenticator has a setting for the
27345 &%server_mail_auth_condition%&, the condition is checked at this point. The
27346 valued that was saved from the authenticator is expanded. If the expansion
27347 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27348 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27349 the value of &$authenticated_sender$& is retained and passed on with the
27350 message.
27351 .endlist
27352
27353
27354 When &$authenticated_sender$& is set for a message, it is passed on to other
27355 hosts to which Exim authenticates as a client. Do not confuse this value with
27356 &$authenticated_id$&, which is a string obtained from the authentication
27357 process, and which is not usually a complete email address.
27358
27359 .vindex "&$sender_address$&"
27360 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27361 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27362 therefore make use of &$authenticated_sender$&. The converse is not true: the
27363 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27364 ACL is run.
27365
27366
27367
27368 .section "Authentication on an Exim server" "SECTauthexiser"
27369 .cindex "authentication" "on an Exim server"
27370 When Exim receives an EHLO command, it advertises the public names of those
27371 authenticators that are configured as servers, subject to the following
27372 conditions:
27373
27374 .ilist
27375 The client host must match &%auth_advertise_hosts%& (default *).
27376 .next
27377 If the &%server_advertise_condition%& option is set, its expansion must not
27378 yield the empty string, &"0"&, &"no"&, or &"false"&.
27379 .endlist
27380
27381 The order in which the authenticators are defined controls the order in which
27382 the mechanisms are advertised.
27383
27384 Some mail clients (for example, some versions of Netscape) require the user to
27385 provide a name and password for authentication whenever AUTH is advertised,
27386 even though authentication may not in fact be needed (for example, Exim may be
27387 set up to allow unconditional relaying from the client by an IP address check).
27388 You can make such clients more friendly by not advertising AUTH to them.
27389 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27390 that runs for RCPT) to relay without authentication, you should set
27391 .code
27392 auth_advertise_hosts = ! 10.9.8.0/24
27393 .endd
27394 so that no authentication mechanisms are advertised to them.
27395
27396 The &%server_advertise_condition%& controls the advertisement of individual
27397 authentication mechanisms. For example, it can be used to restrict the
27398 advertisement of a particular mechanism to encrypted connections, by a setting
27399 such as:
27400 .code
27401 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27402 .endd
27403 .vindex "&$tls_in_cipher$&"
27404 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27405 yields &"yes"&, which allows the advertisement to happen.
27406
27407 When an Exim server receives an AUTH command from a client, it rejects it
27408 immediately if AUTH was not advertised in response to an earlier EHLO
27409 command. This is the case if
27410
27411 .ilist
27412 The client host does not match &%auth_advertise_hosts%&; or
27413 .next
27414 No authenticators are configured with server options; or
27415 .next
27416 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27417 server authenticators.
27418 .endlist
27419
27420
27421 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27422 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27423 AUTH is accepted from any client host.
27424
27425 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27426 server authentication mechanism that was advertised in response to EHLO and
27427 that matches the one named in the AUTH command. If it finds one, it runs
27428 the appropriate authentication protocol, and authentication either succeeds or
27429 fails. If there is no matching advertised mechanism, the AUTH command is
27430 rejected with a 504 error.
27431
27432 .vindex "&$received_protocol$&"
27433 .vindex "&$sender_host_authenticated$&"
27434 When a message is received from an authenticated host, the value of
27435 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27436 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27437 public name) of the authenticator driver that successfully authenticated the
27438 client from which the message was received. This variable is empty if there was
27439 no successful authentication.
27440
27441 .cindex authentication "expansion item"
27442 Successful authentication sets up information used by the
27443 &%authresults%& expansion item.
27444
27445
27446
27447
27448 .section "Testing server authentication" "SECID169"
27449 .cindex "authentication" "testing a server"
27450 .cindex "AUTH" "testing a server"
27451 .cindex "base64 encoding" "creating authentication test data"
27452 Exim's &%-bh%& option can be useful for testing server authentication
27453 configurations. The data for the AUTH command has to be sent using base64
27454 encoding. A quick way to produce such data for testing is the following Perl
27455 script:
27456 .code
27457 use MIME::Base64;
27458 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27459 .endd
27460 .cindex "binary zero" "in authentication data"
27461 This interprets its argument as a Perl string, and then encodes it. The
27462 interpretation as a Perl string allows binary zeros, which are required for
27463 some kinds of authentication, to be included in the data. For example, a
27464 command line to run this script on such data might be
27465 .code
27466 encode '\0user\0password'
27467 .endd
27468 Note the use of single quotes to prevent the shell interpreting the
27469 backslashes, so that they can be interpreted by Perl to specify characters
27470 whose code value is zero.
27471
27472 &*Warning 1*&: If either of the user or password strings starts with an octal
27473 digit, you must use three zeros instead of one after the leading backslash. If
27474 you do not, the octal digit that starts your string will be incorrectly
27475 interpreted as part of the code for the first character.
27476
27477 &*Warning 2*&: If there are characters in the strings that Perl interprets
27478 specially, you must use a Perl escape to prevent them being misinterpreted. For
27479 example, a command such as
27480 .code
27481 encode '\0user@domain.com\0pas$$word'
27482 .endd
27483 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27484
27485 If you have the &%mimencode%& command installed, another way to produce
27486 base64-encoded strings is to run the command
27487 .code
27488 echo -e -n `\0user\0password' | mimencode
27489 .endd
27490 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27491 in the argument, and the &%-n%& option specifies no newline at the end of its
27492 output. However, not all versions of &%echo%& recognize these options, so you
27493 should check your version before relying on this suggestion.
27494
27495
27496
27497 .section "Authentication by an Exim client" "SECID170"
27498 .cindex "authentication" "on an Exim client"
27499 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27500 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27501 announces support for authentication, and the host matches an entry in either
27502 of these options, Exim (as a client) tries to authenticate as follows:
27503
27504 .ilist
27505 For each authenticator that is configured as a client, in the order in which
27506 they are defined in the configuration, it searches the authentication
27507 mechanisms announced by the server for one whose name matches the public name
27508 of the authenticator.
27509 .next
27510 .vindex "&$host$&"
27511 .vindex "&$host_address$&"
27512 When it finds one that matches, it runs the authenticator's client code. The
27513 variables &$host$& and &$host_address$& are available for any string expansions
27514 that the client might do. They are set to the server's name and IP address. If
27515 any expansion is forced to fail, the authentication attempt is abandoned, and
27516 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27517 delivery to be deferred.
27518 .next
27519 If the result of the authentication attempt is a temporary error or a timeout,
27520 Exim abandons trying to send the message to the host for the moment. It will
27521 try again later. If there are any backup hosts available, they are tried in the
27522 usual way.
27523 .next
27524 If the response to authentication is a permanent error (5&'xx'& code), Exim
27525 carries on searching the list of authenticators and tries another one if
27526 possible. If all authentication attempts give permanent errors, or if there are
27527 no attempts because no mechanisms match (or option expansions force failure),
27528 what happens depends on whether the host matches &%hosts_require_auth%& or
27529 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27530 delivery is deferred. The error can be detected in the retry rules, and thereby
27531 turned into a permanent error if you wish. In the second case, Exim tries to
27532 deliver the message unauthenticated.
27533 .endlist
27534
27535 Note that the hostlist test for whether to do authentication can be
27536 confused if name-IP lookups change between the time the peer is decided
27537 upon and the time that the transport runs.  For example, with a manualroute
27538 router given a host name, and with DNS "round-robin" used by that name: if
27539 the local resolver cache times out between the router and the transport
27540 running, the transport may get an IP for the name for its authentication
27541 check which does not match the connection peer IP.
27542 No authentication will then be done, despite the names being identical.
27543
27544 For such cases use a separate transport which always authenticates.
27545
27546 .cindex "AUTH" "on MAIL command"
27547 When Exim has authenticated itself to a remote server, it adds the AUTH
27548 parameter to the MAIL commands it sends, if it has an authenticated sender for
27549 the message. If the message came from a remote host, the authenticated sender
27550 is the one that was receiving on an incoming MAIL command, provided that the
27551 incoming connection was authenticated and the &%server_mail_auth%& condition
27552 allowed the authenticated sender to be retained. If a local process calls Exim
27553 to send a message, the sender address that is built from the login name and
27554 &%qualify_domain%& is treated as authenticated. However, if the
27555 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27556 the authenticated sender that was received with the message.
27557 .ecindex IIDauthconf1
27558 .ecindex IIDauthconf2
27559
27560
27561
27562
27563
27564
27565 . ////////////////////////////////////////////////////////////////////////////
27566 . ////////////////////////////////////////////////////////////////////////////
27567
27568 .chapter "The plaintext authenticator" "CHAPplaintext"
27569 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27570 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27571 The &(plaintext)& authenticator can be configured to support the PLAIN and
27572 LOGIN authentication mechanisms, both of which transfer authentication data as
27573 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27574 security risk; you are strongly advised to insist on the use of SMTP encryption
27575 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27576 use unencrypted plain text, you should not use the same passwords for SMTP
27577 connections as you do for login accounts.
27578
27579 .section "Avoiding cleartext use" "SECTplain_TLS"
27580 The following generic option settings will disable &(plaintext)& authenticators when
27581 TLS is not being used:
27582 .code
27583   server_advertise_condition = ${if def:tls_in_cipher }
27584   client_condition =           ${if def:tls_out_cipher}
27585 .endd
27586
27587 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27588 but is still vulnerable to a Man In The Middle attack unless certificates
27589 (including their names) have been properly verified.
27590
27591 .section "Plaintext server options" "SECID171"
27592 .cindex "options" "&(plaintext)& authenticator (server)"
27593 When configured as a server, &(plaintext)& uses the following options:
27594
27595 .option server_condition authenticators string&!! unset
27596 This is actually a global authentication option, but it must be set in order to
27597 configure the &(plaintext)& driver as a server. Its use is described below.
27598
27599 .option server_prompts plaintext "string list&!!" unset
27600 The contents of this option, after expansion, must be a colon-separated list of
27601 prompt strings. If expansion fails, a temporary authentication rejection is
27602 given.
27603
27604 .section "Using plaintext in a server" "SECTplainserver"
27605 .cindex "AUTH" "in &(plaintext)& authenticator"
27606 .cindex "binary zero" "in &(plaintext)& authenticator"
27607 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27608         "in &(plaintext)& authenticator"
27609 .vindex "&$auth1$&, &$auth2$&, etc"
27610 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27611
27612 When running as a server, &(plaintext)& performs the authentication test by
27613 expanding a string. The data sent by the client with the AUTH command, or in
27614 response to subsequent prompts, is base64 encoded, and so may contain any byte
27615 values when decoded. If any data is supplied with the command, it is treated as
27616 a list of strings, separated by NULs (binary zeros), the first three of which
27617 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27618 (neither LOGIN nor PLAIN uses more than three strings).
27619
27620 For compatibility with previous releases of Exim, the values are also placed in
27621 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27622 variables for this purpose is now deprecated, as it can lead to confusion in
27623 string expansions that also use them for other things.
27624
27625 If there are more strings in &%server_prompts%& than the number of strings
27626 supplied with the AUTH command, the remaining prompts are used to obtain more
27627 data. Each response from the client may be a list of NUL-separated strings.
27628
27629 .vindex "&$authenticated_id$&"
27630 Once a sufficient number of data strings have been received,
27631 &%server_condition%& is expanded. If the expansion is forced to fail,
27632 authentication fails. Any other expansion failure causes a temporary error code
27633 to be returned. If the result of a successful expansion is an empty string,
27634 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27635 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27636 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27637 For any other result, a temporary error code is returned, with the expanded
27638 string as the error text.
27639
27640 &*Warning*&: If you use a lookup in the expansion to find the user's
27641 password, be sure to make the authentication fail if the user is unknown.
27642 There are good and bad examples at the end of the next section.
27643
27644
27645
27646 .section "The PLAIN authentication mechanism" "SECID172"
27647 .cindex "PLAIN authentication mechanism"
27648 .cindex authentication PLAIN
27649 .cindex "binary zero" "in &(plaintext)& authenticator"
27650 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27651 sent as one item of data (that is, one combined string containing two NUL
27652 separators). The data is sent either as part of the AUTH command, or
27653 subsequently in response to an empty prompt from the server.
27654
27655 The second and third strings are a user name and a corresponding password.
27656 Using a single fixed user name and password as an example, this could be
27657 configured as follows:
27658 .code
27659 fixed_plain:
27660   driver = plaintext
27661   public_name = PLAIN
27662   server_prompts = :
27663   server_condition = \
27664     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27665   server_set_id = $auth2
27666 .endd
27667 Note that the default result strings from &%if%& (&"true"& or an empty string)
27668 are exactly what we want here, so they need not be specified. Obviously, if the
27669 password contains expansion-significant characters such as dollar, backslash,
27670 or closing brace, they have to be escaped.
27671
27672 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27673 the end of a string list are ignored). If all the data comes as part of the
27674 AUTH command, as is commonly the case, the prompt is not used. This
27675 authenticator is advertised in the response to EHLO as
27676 .code
27677 250-AUTH PLAIN
27678 .endd
27679 and a client host can authenticate itself by sending the command
27680 .code
27681 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27682 .endd
27683 As this contains three strings (more than the number of prompts), no further
27684 data is required from the client. Alternatively, the client may just send
27685 .code
27686 AUTH PLAIN
27687 .endd
27688 to initiate authentication, in which case the server replies with an empty
27689 prompt. The client must respond with the combined data string.
27690
27691 The data string is base64 encoded, as required by the RFC. This example,
27692 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27693 represents a zero byte. This is split up into three strings, the first of which
27694 is empty. The &%server_condition%& option in the authenticator checks that the
27695 second two are &`username`& and &`mysecret`& respectively.
27696
27697 Having just one fixed user name and password, as in this example, is not very
27698 realistic, though for a small organization with only a handful of
27699 authenticating clients it could make sense.
27700
27701 A more sophisticated instance of this authenticator could use the user name in
27702 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27703 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27704 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27705 This is an incorrect example:
27706 .code
27707 server_condition = \
27708   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27709 .endd
27710 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27711 which it then compares to the supplied password (&$auth3$&). Why is this example
27712 incorrect? It works fine for existing users, but consider what happens if a
27713 non-existent user name is given. The lookup fails, but as no success/failure
27714 strings are given for the lookup, it yields an empty string. Thus, to defeat
27715 the authentication, all a client has to do is to supply a non-existent user
27716 name and an empty password. The correct way of writing this test is:
27717 .code
27718 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27719   {${if eq{$value}{$auth3}}} {false}}
27720 .endd
27721 In this case, if the lookup succeeds, the result is checked; if the lookup
27722 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27723 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27724 always fails if its second argument is empty. However, the second way of
27725 writing the test makes the logic clearer.
27726
27727
27728 .section "The LOGIN authentication mechanism" "SECID173"
27729 .cindex "LOGIN authentication mechanism"
27730 .cindex authentication LOGIN
27731 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27732 in a number of programs. No data is sent with the AUTH command. Instead, a
27733 user name and password are supplied separately, in response to prompts. The
27734 plaintext authenticator can be configured to support this as in this example:
27735 .code
27736 fixed_login:
27737   driver = plaintext
27738   public_name = LOGIN
27739   server_prompts = User Name : Password
27740   server_condition = \
27741     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27742   server_set_id = $auth1
27743 .endd
27744 Because of the way plaintext operates, this authenticator accepts data supplied
27745 with the AUTH command (in contravention of the specification of LOGIN), but
27746 if the client does not supply it (as is the case for LOGIN clients), the prompt
27747 strings are used to obtain two data items.
27748
27749 Some clients are very particular about the precise text of the prompts. For
27750 example, Outlook Express is reported to recognize only &"Username:"& and
27751 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27752 strings. It uses the &%ldapauth%& expansion condition to check the user
27753 name and password by binding to an LDAP server:
27754 .code
27755 login:
27756   driver = plaintext
27757   public_name = LOGIN
27758   server_prompts = Username:: : Password::
27759   server_condition = ${if and{{ \
27760     !eq{}{$auth1} }{ \
27761     ldapauth{\
27762       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27763       pass=${quote:$auth2} \
27764       ldap://ldap.example.org/} }} }
27765   server_set_id = uid=$auth1,ou=people,o=example.org
27766 .endd
27767 We have to check that the username is not empty before using it, because LDAP
27768 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27769 operator to correctly quote the DN for authentication. However, the basic
27770 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27771 correct one to use for the password, because quoting is needed only to make
27772 the password conform to the Exim syntax. At the LDAP level, the password is an
27773 uninterpreted string.
27774
27775
27776 .section "Support for different kinds of authentication" "SECID174"
27777 A number of string expansion features are provided for the purpose of
27778 interfacing to different ways of user authentication. These include checking
27779 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27780 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27781 &<<SECTexpcond>>&.
27782
27783
27784
27785
27786 .section "Using plaintext in a client" "SECID175"
27787 .cindex "options" "&(plaintext)& authenticator (client)"
27788 The &(plaintext)& authenticator has two client options:
27789
27790 .option client_ignore_invalid_base64 plaintext boolean false
27791 If the client receives a server prompt that is not a valid base64 string,
27792 authentication is abandoned by default. However, if this option is set true,
27793 the error in the challenge is ignored and the client sends the response as
27794 usual.
27795
27796 .option client_send plaintext string&!! unset
27797 The string is a colon-separated list of authentication data strings. Each
27798 string is independently expanded before being sent to the server. The first
27799 string is sent with the AUTH command; any more strings are sent in response
27800 to prompts from the server. Before each string is expanded, the value of the
27801 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27802 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27803 way. Thus, the prompt that is received in response to sending the first string
27804 (with the AUTH command) can be used in the expansion of the second string, and
27805 so on. If an invalid base64 string is received when
27806 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27807 &$auth$&<&'n'&> variable.
27808
27809 &*Note*&: You cannot use expansion to create multiple strings, because
27810 splitting takes priority and happens first.
27811
27812 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27813 the data, further processing is applied to each string before it is sent. If
27814 there are any single circumflex characters in the string, they are converted to
27815 NULs. Should an actual circumflex be required as data, it must be doubled in
27816 the string.
27817
27818 This is an example of a client configuration that implements the PLAIN
27819 authentication mechanism with a fixed user name and password:
27820 .code
27821 fixed_plain:
27822   driver = plaintext
27823   public_name = PLAIN
27824   client_send = ^username^mysecret
27825 .endd
27826 The lack of colons means that the entire text is sent with the AUTH
27827 command, with the circumflex characters converted to NULs. A similar example
27828 that uses the LOGIN mechanism is:
27829 .code
27830 fixed_login:
27831   driver = plaintext
27832   public_name = LOGIN
27833   client_send = : username : mysecret
27834 .endd
27835 The initial colon means that the first string is empty, so no data is sent with
27836 the AUTH command itself. The remaining strings are sent in response to
27837 prompts.
27838 .ecindex IIDplaiauth1
27839 .ecindex IIDplaiauth2
27840
27841
27842
27843
27844 . ////////////////////////////////////////////////////////////////////////////
27845 . ////////////////////////////////////////////////////////////////////////////
27846
27847 .chapter "The cram_md5 authenticator" "CHID9"
27848 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27849 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27850 .cindex "CRAM-MD5 authentication mechanism"
27851 .cindex authentication CRAM-MD5
27852 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27853 sends a challenge string to the client, and the response consists of a user
27854 name and the CRAM-MD5 digest of the challenge string combined with a secret
27855 string (password) which is known to both server and client. Thus, the secret
27856 is not sent over the network as plain text, which makes this authenticator more
27857 secure than &(plaintext)&. However, the downside is that the secret has to be
27858 available in plain text at either end.
27859
27860
27861 .section "Using cram_md5 as a server" "SECID176"
27862 .cindex "options" "&(cram_md5)& authenticator (server)"
27863 This authenticator has one server option, which must be set to configure the
27864 authenticator as a server:
27865
27866 .option server_secret cram_md5 string&!! unset
27867 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27868 When the server receives the client's response, the user name is placed in
27869 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27870 obtain the password for that user. The server then computes the CRAM-MD5 digest
27871 that the client should have sent, and checks that it received the correct
27872 string. If the expansion of &%server_secret%& is forced to fail, authentication
27873 fails. If the expansion fails for some other reason, a temporary error code is
27874 returned to the client.
27875
27876 For compatibility with previous releases of Exim, the user name is also placed
27877 in &$1$&. However, the use of this variables for this purpose is now
27878 deprecated, as it can lead to confusion in string expansions that also use
27879 numeric variables for other things.
27880
27881 For example, the following authenticator checks that the user name given by the
27882 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27883 user name, authentication fails.
27884 .code
27885 fixed_cram:
27886   driver = cram_md5
27887   public_name = CRAM-MD5
27888   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27889   server_set_id = $auth1
27890 .endd
27891 .vindex "&$authenticated_id$&"
27892 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27893 name in &$authenticated_id$&. A more typical configuration might look up the
27894 secret string in a file, using the user name as the key. For example:
27895 .code
27896 lookup_cram:
27897   driver = cram_md5
27898   public_name = CRAM-MD5
27899   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27900                   {$value}fail}
27901   server_set_id = $auth1
27902 .endd
27903 Note that this expansion explicitly forces failure if the lookup fails
27904 because &$auth1$& contains an unknown user name.
27905
27906 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27907 using the relevant libraries, you need to know the realm to specify in the
27908 lookup and then ask for the &"userPassword"& attribute for that user in that
27909 realm, with:
27910 .code
27911 cyrusless_crammd5:
27912   driver = cram_md5
27913   public_name = CRAM-MD5
27914   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27915                   dbmjz{/etc/sasldb2}{$value}fail}
27916   server_set_id = $auth1
27917 .endd
27918
27919 .section "Using cram_md5 as a client" "SECID177"
27920 .cindex "options" "&(cram_md5)& authenticator (client)"
27921 When used as a client, the &(cram_md5)& authenticator has two options:
27922
27923
27924
27925 .option client_name cram_md5 string&!! "the primary host name"
27926 This string is expanded, and the result used as the user name data when
27927 computing the response to the server's challenge.
27928
27929
27930 .option client_secret cram_md5 string&!! unset
27931 This option must be set for the authenticator to work as a client. Its value is
27932 expanded and the result used as the secret string when computing the response.
27933
27934
27935 .vindex "&$host$&"
27936 .vindex "&$host_address$&"
27937 Different user names and secrets can be used for different servers by referring
27938 to &$host$& or &$host_address$& in the options. Forced failure of either
27939 expansion string is treated as an indication that this authenticator is not
27940 prepared to handle this case. Exim moves on to the next configured client
27941 authenticator. Any other expansion failure causes Exim to give up trying to
27942 send the message to the current server.
27943
27944 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27945 strings, is:
27946 .code
27947 fixed_cram:
27948   driver = cram_md5
27949   public_name = CRAM-MD5
27950   client_name = ph10
27951   client_secret = secret
27952 .endd
27953 .ecindex IIDcramauth1
27954 .ecindex IIDcramauth2
27955
27956
27957
27958 . ////////////////////////////////////////////////////////////////////////////
27959 . ////////////////////////////////////////////////////////////////////////////
27960
27961 .chapter "The cyrus_sasl authenticator" "CHID10"
27962 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27963 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27964 .cindex "Cyrus" "SASL library"
27965 .cindex "Kerberos"
27966 The code for this authenticator was provided by Matthew Byng-Maddick while
27967 at A L Digital Ltd.
27968
27969 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27970 library implementation of the RFC 2222 (&"Simple Authentication and Security
27971 Layer"&). This library supports a number of authentication mechanisms,
27972 including PLAIN and LOGIN, but also several others that Exim does not support
27973 directly. In particular, there is support for Kerberos authentication.
27974
27975 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27976 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27977 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27978 name of the driver to determine which mechanism to support.
27979
27980 Where access to some kind of secret file is required, for example, in GSSAPI
27981 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27982 user, and that the Cyrus SASL library has no way of escalating privileges
27983 by default. You may also find you need to set environment variables,
27984 depending on the driver you are using.
27985
27986 The application name provided by Exim is &"exim"&, so various SASL options may
27987 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27988 Kerberos, note that because of limitations in the GSSAPI interface,
27989 changing the server keytab might need to be communicated down to the Kerberos
27990 layer independently. The mechanism for doing so is dependent upon the Kerberos
27991 implementation.
27992
27993 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27994 may be set to point to an alternative keytab file. Exim will pass this
27995 variable through from its own inherited environment when started as root or the
27996 Exim user. The keytab file needs to be readable by the Exim user.
27997 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27998 environment variable.  In practice, for those releases, the Cyrus authenticator
27999 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28000 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28001
28002
28003 .section "Using cyrus_sasl as a server" "SECID178"
28004 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28005 (on a successful authentication) into &$auth1$&. For compatibility with
28006 previous releases of Exim, the username is also placed in &$1$&. However, the
28007 use of this variable for this purpose is now deprecated, as it can lead to
28008 confusion in string expansions that also use numeric variables for other
28009 things.
28010
28011
28012 .option server_hostname cyrus_sasl string&!! "see below"
28013 This option selects the hostname that is used when communicating with the
28014 library. The default value is &`$primary_hostname`&. It is up to the underlying
28015 SASL plug-in what it does with this data.
28016
28017
28018 .option server_mech cyrus_sasl string "see below"
28019 This option selects the authentication mechanism this driver should use. The
28020 default is the value of the generic &%public_name%& option. This option allows
28021 you to use a different underlying mechanism from the advertised name. For
28022 example:
28023 .code
28024 sasl:
28025   driver = cyrus_sasl
28026   public_name = X-ANYTHING
28027   server_mech = CRAM-MD5
28028   server_set_id = $auth1
28029 .endd
28030
28031 .option server_realm cyrus_sasl string&!! unset
28032 This specifies the SASL realm that the server claims to be in.
28033
28034
28035 .option server_service cyrus_sasl string &`smtp`&
28036 This is the SASL service that the server claims to implement.
28037
28038
28039 For straightforward cases, you do not need to set any of the authenticator's
28040 private options. All you need to do is to specify an appropriate mechanism as
28041 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28042 PLAIN, you could have two authenticators as follows:
28043 .code
28044 sasl_cram_md5:
28045   driver = cyrus_sasl
28046   public_name = CRAM-MD5
28047   server_set_id = $auth1
28048
28049 sasl_plain:
28050   driver = cyrus_sasl
28051   public_name = PLAIN
28052   server_set_id = $auth2
28053 .endd
28054 Cyrus SASL does implement the LOGIN authentication method, even though it is
28055 not a standard method. It is disabled by default in the source distribution,
28056 but it is present in many binary distributions.
28057 .ecindex IIDcyrauth1
28058 .ecindex IIDcyrauth2
28059
28060
28061
28062
28063 . ////////////////////////////////////////////////////////////////////////////
28064 . ////////////////////////////////////////////////////////////////////////////
28065 .chapter "The dovecot authenticator" "CHAPdovecot"
28066 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28067 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28068 This authenticator is an interface to the authentication facility of the
28069 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28070 Note that Dovecot must be configured to use auth-client not auth-userdb.
28071 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28072 to use the same mechanisms for SMTP authentication. This is a server
28073 authenticator only. There is only one option:
28074
28075 .option server_socket dovecot string unset
28076
28077 This option must specify the UNIX socket that is the interface to Dovecot
28078 authentication. The &%public_name%& option must specify an authentication
28079 mechanism that Dovecot is configured to support. You can have several
28080 authenticators for different mechanisms. For example:
28081 .code
28082 dovecot_plain:
28083   driver = dovecot
28084   public_name = PLAIN
28085   server_socket = /var/run/dovecot/auth-client
28086   server_set_id = $auth1
28087
28088 dovecot_ntlm:
28089   driver = dovecot
28090   public_name = NTLM
28091   server_socket = /var/run/dovecot/auth-client
28092   server_set_id = $auth1
28093 .endd
28094 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28095 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28096 option is passed in the Dovecot authentication command. If, for a TLS
28097 connection, a client certificate has been verified, the &"valid-client-cert"&
28098 option is passed. When authentication succeeds, the identity of the user
28099 who authenticated is placed in &$auth1$&.
28100
28101 The Dovecot configuration to match the above wil look
28102 something like:
28103 .code
28104 conf.d/10-master.conf :-
28105
28106 service auth {
28107 ...
28108 #SASL
28109   unix_listener auth-client {
28110     mode = 0660
28111     user = mail
28112   }
28113 ...
28114 }
28115
28116 conf.d/10-auth.conf :-
28117
28118 auth_mechanisms = plain login ntlm
28119 .endd
28120
28121 .ecindex IIDdcotauth1
28122 .ecindex IIDdcotauth2
28123
28124
28125 . ////////////////////////////////////////////////////////////////////////////
28126 . ////////////////////////////////////////////////////////////////////////////
28127 .chapter "The gsasl authenticator" "CHAPgsasl"
28128 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28129 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28130 .cindex "authentication" "GNU SASL"
28131 .cindex "authentication" "SASL"
28132 .cindex "authentication" "EXTERNAL"
28133 .cindex "authentication" "ANONYMOUS"
28134 .cindex "authentication" "PLAIN"
28135 .cindex "authentication" "LOGIN"
28136 .cindex "authentication" "DIGEST-MD5"
28137 .cindex "authentication" "CRAM-MD5"
28138 .cindex "authentication" "SCRAM family"
28139 The &(gsasl)& authenticator provides integration for the GNU SASL
28140 library and the mechanisms it provides.  This is new as of the 4.80 release
28141 and there are a few areas where the library does not let Exim smoothly
28142 scale to handle future authentication mechanisms, so no guarantee can be
28143 made that any particular new authentication mechanism will be supported
28144 without code changes in Exim.
28145
28146 The library is expected to add support in an upcoming
28147 realease for the SCRAM-SHA-256 method.
28148 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28149 when this happens.
28150
28151
28152 .option client_authz gsasl string&!! unset
28153 This option can be used to supply an &'authorization id'&
28154 which is different to the &'authentication_id'& provided
28155 by &%client_username%& option.
28156 If unset or (after expansion) empty it is not used,
28157 which is the common case.
28158
28159 .option client_channelbinding gsasl boolean false
28160 See &%server_channelbinding%& below.
28161
28162 .option client_password gsasl string&!! unset
28163 This option is exapanded before use, and should result in
28164 the password to be used, in clear.
28165
28166 .option client_username gsasl string&!! unset
28167 This option is exapanded before use, and should result in
28168 the account name to be used.
28169
28170 .option client_spassword gsasl string&!! unset
28171 If a SCRAM mechanism is being used and this option is set
28172 it is used in preference to &%client_password%&.
28173 The value after expansion should be
28174 a 40 (for SHA-1) or 64 (for SHA-256) character string
28175 with the PBKDF2-prepared password, hex-encoded.
28176 Note that this value will depend on the salt and iteration-count
28177 supplied by the server.
28178
28179
28180
28181 .option server_channelbinding gsasl boolean false
28182 Do not set this true and rely on the properties
28183 without consulting a cryptographic engineer.
28184 . Unsure what that's about.  It might be the "Triple Handshake"
28185 . vulnerability; cf. https://www.mitls.org/pages/attacks/3SHAKE
28186 . If so, we're ok, requiring Extended Master Secret if TLS
28187 . Session Resumption was used.
28188
28189 Some authentication mechanisms are able to use external context at both ends
28190 of the session to bind the authentication to that context, and fail the
28191 authentication process if that context differs.  Specifically, some TLS
28192 ciphersuites can provide identifying information about the cryptographic
28193 context.
28194
28195 This should have meant that certificate identity and verification becomes a
28196 non-issue, as a man-in-the-middle attack will cause the correct client and
28197 server to see different identifiers and authentication will fail.
28198
28199 This is
28200 only usable by mechanisms which support "channel binding"; at time of
28201 writing, that's the SCRAM family.
28202 When using this feature the "-PLUS" variants of the method names need to be used.
28203
28204 This defaults off to ensure smooth upgrade across Exim releases, in case
28205 this option causes some clients to start failing.  Some future release
28206 of Exim might have switched the default to be true.
28207
28208 However, Channel Binding in TLS has proven to be vulnerable in current versions.
28209 Do not plan to rely upon this feature for security, ever, without consulting
28210 with a subject matter expert (a cryptographic engineer).
28211
28212
28213 .option server_hostname gsasl string&!! "see below"
28214 This option selects the hostname that is used when communicating with the
28215 library. The default value is &`$primary_hostname`&.
28216 Some mechanisms will use this data.
28217
28218
28219 .option server_mech gsasl string "see below"
28220 This option selects the authentication mechanism this driver should use. The
28221 default is the value of the generic &%public_name%& option. This option allows
28222 you to use a different underlying mechanism from the advertised name. For
28223 example:
28224 .code
28225 sasl:
28226   driver = gsasl
28227   public_name = X-ANYTHING
28228   server_mech = CRAM-MD5
28229   server_set_id = $auth1
28230 .endd
28231
28232
28233 .option server_password gsasl string&!! unset
28234 Various mechanisms need access to the cleartext password on the server, so
28235 that proof-of-possession can be demonstrated on the wire, without sending
28236 the password itself.
28237
28238 The data available for lookup varies per mechanism.
28239 In all cases, &$auth1$& is set to the &'authentication id'&.
28240 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28241 if available, else the empty string.
28242 The &$auth3$& variable will always be the &'realm'& if available,
28243 else the empty string.
28244
28245 A forced failure will cause authentication to defer.
28246
28247 If using this option, it may make sense to set the &%server_condition%&
28248 option to be simply "true".
28249
28250
28251 .option server_realm gsasl string&!! unset
28252 This specifies the SASL realm that the server claims to be in.
28253 Some mechanisms will use this data.
28254
28255
28256 .option server_scram_iter gsasl string&!! 4096
28257 This option provides data for the SCRAM family of mechanisms.
28258 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28259 when this option is expanded.
28260
28261 The result of expansion should be a decimal number,
28262 and represents both a lower-bound on the security, and
28263 a compute cost factor imposed on the client
28264 (if it does not cache results, or the server changes
28265 either the iteration count or the salt).
28266 A minimum value of 4096 is required by the standards
28267 for all current SCRAM mechanism variants.
28268
28269 .option server_scram_salt gsasl string&!! unset
28270 This option provides data for the SCRAM family of mechanisms.
28271 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28272 when this option is expanded.
28273 The value should be a base64-encoded string,
28274 of random data typically 4-to-16 bytes long.
28275 If unset or empty after expansion the library will provides a value for the
28276 protocol conversation.
28277
28278
28279 .option server_key gsasl string&!! unset
28280 .option server_skey gsasl string&!! unset
28281 These options can be used for the SCRAM family of mechanisms
28282 to provide stored information related to a password,
28283 the storage of which is preferable to plaintext.
28284
28285 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28286 &%server_skey%& is StoredKey.
28287
28288 They are only available for version 1.9.0 (or later) of the gsasl library.
28289 When this is so, the macros
28290 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28291 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28292 will be defined.
28293
28294 The &$authN$& variables are available when these options are expanded.
28295
28296 If set, the results of expansion should for each
28297 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28298 of base64-coded data, and will be used in preference to the
28299 &%server_password%& option.
28300 If unset or not of the right length, &%server_password%& will be used.
28301
28302 The libgsasl library release includes a utility &'gsasl'& which can be used
28303 to generate these values.
28304
28305
28306 .option server_service gsasl string &`smtp`&
28307 This is the SASL service that the server claims to implement.
28308 Some mechanisms will use this data.
28309
28310
28311 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28312 .vindex "&$auth1$&, &$auth2$&, etc"
28313 These may be set when evaluating specific options, as detailed above.
28314 They will also be set when evaluating &%server_condition%&.
28315
28316 Unless otherwise stated below, the &(gsasl)& integration will use the following
28317 meanings for these variables:
28318
28319 .ilist
28320 .vindex "&$auth1$&"
28321 &$auth1$&: the &'authentication id'&
28322 .next
28323 .vindex "&$auth2$&"
28324 &$auth2$&: the &'authorization id'&
28325 .next
28326 .vindex "&$auth3$&"
28327 &$auth3$&: the &'realm'&
28328 .endlist
28329
28330 On a per-mechanism basis:
28331
28332 .ilist
28333 .cindex "authentication" "EXTERNAL"
28334 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28335 the &%server_condition%& option must be present.
28336 .next
28337 .cindex "authentication" "ANONYMOUS"
28338 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28339 the &%server_condition%& option must be present.
28340 .next
28341 .cindex "authentication" "GSSAPI"
28342 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28343 &$auth2$& will be set to the &'authorization id'&,
28344 the &%server_condition%& option must be present.
28345 .endlist
28346
28347 An &'anonymous token'& is something passed along as an unauthenticated
28348 identifier; this is analogous to FTP anonymous authentication passing an
28349 email address, or software-identifier@, as the "password".
28350
28351
28352 An example showing the password having the realm specified in the callback
28353 and demonstrating a Cyrus SASL to GSASL migration approach is:
28354 .code
28355 gsasl_cyrusless_crammd5:
28356   driver = gsasl
28357   public_name = CRAM-MD5
28358   server_realm = imap.example.org
28359   server_password = ${lookup{$auth1:$auth3:userPassword}\
28360                     dbmjz{/etc/sasldb2}{$value}fail}
28361   server_set_id = ${quote:$auth1}
28362   server_condition = yes
28363 .endd
28364
28365
28366 . ////////////////////////////////////////////////////////////////////////////
28367 . ////////////////////////////////////////////////////////////////////////////
28368
28369 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28370 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28371 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28372 .cindex "authentication" "GSSAPI"
28373 .cindex "authentication" "Kerberos"
28374 The &(heimdal_gssapi)& authenticator provides server integration for the
28375 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28376 reliably.
28377
28378 .option server_hostname heimdal_gssapi string&!! "see below"
28379 This option selects the hostname that is used, with &%server_service%&,
28380 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28381 identifier.  The default value is &`$primary_hostname`&.
28382
28383 .option server_keytab heimdal_gssapi string&!! unset
28384 If set, then Heimdal will not use the system default keytab (typically
28385 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28386 The value should be a pathname, with no &"file:"& prefix.
28387
28388 .option server_service heimdal_gssapi string&!! "smtp"
28389 This option specifies the service identifier used, in conjunction with
28390 &%server_hostname%&, for building the identifier for finding credentials
28391 from the keytab.
28392
28393
28394 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28395 Beware that these variables will typically include a realm, thus will appear
28396 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28397 not verified, so a malicious client can set it to anything.
28398
28399 The &$auth1$& field should be safely trustable as a value from the Key
28400 Distribution Center.  Note that these are not quite email addresses.
28401 Each identifier is for a role, and so the left-hand-side may include a
28402 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28403
28404 .vindex "&$auth1$&, &$auth2$&, etc"
28405 .ilist
28406 .vindex "&$auth1$&"
28407 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28408 .next
28409 .vindex "&$auth2$&"
28410 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28411 authentication.  If that was empty, this will also be set to the
28412 GSS Display Name.
28413 .endlist
28414
28415
28416 . ////////////////////////////////////////////////////////////////////////////
28417 . ////////////////////////////////////////////////////////////////////////////
28418
28419 .chapter "The spa authenticator" "CHAPspa"
28420 .scindex IIDspaauth1 "&(spa)& authenticator"
28421 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28422 .cindex "authentication" "Microsoft Secure Password"
28423 .cindex "authentication" "NTLM"
28424 .cindex "Microsoft Secure Password Authentication"
28425 .cindex "NTLM authentication"
28426 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28427 Password Authentication'& mechanism,
28428 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28429 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28430 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28431 server side was subsequently contributed by Tom Kistner. The mechanism works as
28432 follows:
28433
28434 .ilist
28435 After the AUTH command has been accepted, the client sends an SPA
28436 authentication request based on the user name and optional domain.
28437 .next
28438 The server sends back a challenge.
28439 .next
28440 The client builds a challenge response which makes use of the user's password
28441 and sends it to the server, which then accepts or rejects it.
28442 .endlist
28443
28444 Encryption is used to protect the password in transit.
28445
28446
28447
28448 .section "Using spa as a server" "SECID179"
28449 .cindex "options" "&(spa)& authenticator (server)"
28450 The &(spa)& authenticator has just one server option:
28451
28452 .option server_password spa string&!! unset
28453 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28454 This option is expanded, and the result must be the cleartext password for the
28455 authenticating user, whose name is at this point in &$auth1$&. For
28456 compatibility with previous releases of Exim, the user name is also placed in
28457 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28458 it can lead to confusion in string expansions that also use numeric variables
28459 for other things. For example:
28460 .code
28461 spa:
28462   driver = spa
28463   public_name = NTLM
28464   server_password = \
28465     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28466 .endd
28467 If the expansion is forced to fail, authentication fails. Any other expansion
28468 failure causes a temporary error code to be returned.
28469
28470
28471
28472
28473
28474 .section "Using spa as a client" "SECID180"
28475 .cindex "options" "&(spa)& authenticator (client)"
28476 The &(spa)& authenticator has the following client options:
28477
28478
28479
28480 .option client_domain spa string&!! unset
28481 This option specifies an optional domain for the authentication.
28482
28483
28484 .option client_password spa string&!! unset
28485 This option specifies the user's password, and must be set.
28486
28487
28488 .option client_username spa string&!! unset
28489 This option specifies the user name, and must be set. Here is an example of a
28490 configuration of this authenticator for use with the mail servers at
28491 &'msn.com'&:
28492 .code
28493 msn:
28494   driver = spa
28495   public_name = MSN
28496   client_username = msn/msn_username
28497   client_password = msn_plaintext_password
28498   client_domain = DOMAIN_OR_UNSET
28499 .endd
28500 .ecindex IIDspaauth1
28501 .ecindex IIDspaauth2
28502
28503
28504
28505
28506
28507 . ////////////////////////////////////////////////////////////////////////////
28508 . ////////////////////////////////////////////////////////////////////////////
28509
28510 .chapter "The external authenticator" "CHAPexternauth"
28511 .scindex IIDexternauth1 "&(external)& authenticator"
28512 .scindex IIDexternauth2 "authenticators" "&(external)&"
28513 .cindex "authentication" "Client Certificate"
28514 .cindex "authentication" "X509"
28515 .cindex "Certificate-based authentication"
28516 The &(external)& authenticator provides support for
28517 authentication based on non-SMTP information.
28518 The specification is in RFC 4422 Appendix A
28519 (&url(https://tools.ietf.org/html/rfc4422)).
28520 It is only a transport and negotiation mechanism;
28521 the process of authentication is entirely controlled
28522 by the server configuration.
28523
28524 The client presents an identity in-clear.
28525 It is probably wise for a server to only advertise,
28526 and for clients to only attempt,
28527 this authentication method on a secure (eg. under TLS) connection.
28528
28529 One possible use, compatible with the
28530 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
28531 is for using X509 client certificates.
28532
28533 It thus overlaps in function with the TLS authenticator
28534 (see &<<CHAPtlsauth>>&)
28535 but is a full SMTP SASL authenticator
28536 rather than being implicit for TLS-connection carried
28537 client certificates only.
28538
28539 The examples and discussion in this chapter assume that
28540 client-certificate authentication is being done.
28541
28542 The client must present a certificate,
28543 for which it must have been requested via the
28544 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28545 (see &<<CHAPTLS>>&).
28546 For authentication to be effective the certificate should be
28547 verifiable against a trust-anchor certificate known to the server.
28548
28549 .section "External options" "SECTexternsoptions"
28550 .cindex "options" "&(external)& authenticator (server)"
28551 The &(external)& authenticator has two server options:
28552
28553 .option server_param2 external string&!! unset
28554 .option server_param3 external string&!! unset
28555 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28556 These options are expanded before the &%server_condition%& option
28557 and the result are placed in &$auth2$& and &$auth3$& resectively.
28558 If the expansion is forced to fail, authentication fails. Any other expansion
28559 failure causes a temporary error code to be returned.
28560
28561 They can be used to clarify the coding of a complex &%server_condition%&.
28562
28563 .section "Using external in a server" "SECTexternserver"
28564 .cindex "AUTH" "in &(external)& authenticator"
28565 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28566         "in &(external)& authenticator"
28567 .vindex "&$auth1$&, &$auth2$&, etc"
28568 .cindex "base64 encoding" "in &(external)& authenticator"
28569
28570 When running as a server, &(external)& performs the authentication test by
28571 expanding a string. The data sent by the client with the AUTH command, or in
28572 response to subsequent prompts, is base64 encoded, and so may contain any byte
28573 values when decoded. The decoded value is treated as
28574 an identity for authentication and
28575 placed in the expansion variable &$auth1$&.
28576
28577 For compatibility with previous releases of Exim, the value is also placed in
28578 the expansion variable &$1$&. However, the use of this
28579 variable for this purpose is now deprecated, as it can lead to confusion in
28580 string expansions that also use them for other things.
28581
28582 .vindex "&$authenticated_id$&"
28583 Once an identity has been received,
28584 &%server_condition%& is expanded. If the expansion is forced to fail,
28585 authentication fails. Any other expansion failure causes a temporary error code
28586 to be returned. If the result of a successful expansion is an empty string,
28587 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28588 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28589 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28590 For any other result, a temporary error code is returned, with the expanded
28591 string as the error text.
28592
28593 Example:
28594 .code
28595 ext_ccert_san_mail:
28596   driver =            external
28597   public_name =       EXTERNAL
28598
28599   server_advertise_condition = $tls_in_certificate_verified
28600   server_param2 =     ${certextract {subj_altname,mail,>:} \
28601                                     {$tls_in_peercert}}
28602   server_condition =  ${if forany {$auth2} \
28603                             {eq {$item}{$auth1}}}
28604   server_set_id =     $auth1
28605 .endd
28606 This accepts a client certificate that is verifiable against any
28607 of your configured trust-anchors
28608 (which usually means the full set of public CAs)
28609 and which has a mail-SAN matching the claimed identity sent by the client.
28610
28611 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28612 The account name is therefore guessable by an opponent.
28613 TLS 1.3 protects both server and client certificates, and is not vulnerable
28614 in this way.
28615
28616
28617 .section "Using external in a client" "SECTexternclient"
28618 .cindex "options" "&(external)& authenticator (client)"
28619 The &(external)& authenticator has one client option:
28620
28621 .option client_send external string&!! unset
28622 This option is expanded and sent with the AUTH command as the
28623 identity being asserted.
28624
28625 Example:
28626 .code
28627 ext_ccert:
28628   driver =      external
28629   public_name = EXTERNAL
28630
28631   client_condition = ${if !eq{$tls_out_cipher}{}}
28632   client_send = myaccount@smarthost.example.net
28633 .endd
28634
28635
28636 .ecindex IIDexternauth1
28637 .ecindex IIDexternauth2
28638
28639
28640
28641
28642
28643 . ////////////////////////////////////////////////////////////////////////////
28644 . ////////////////////////////////////////////////////////////////////////////
28645
28646 .chapter "The tls authenticator" "CHAPtlsauth"
28647 .scindex IIDtlsauth1 "&(tls)& authenticator"
28648 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28649 .cindex "authentication" "Client Certificate"
28650 .cindex "authentication" "X509"
28651 .cindex "Certificate-based authentication"
28652 The &(tls)& authenticator provides server support for
28653 authentication based on client certificates.
28654
28655 It is not an SMTP authentication mechanism and is not
28656 advertised by the server as part of the SMTP EHLO response.
28657 It is an Exim authenticator in the sense that it affects
28658 the protocol element of the log line, can be tested for
28659 by the &%authenticated%& ACL condition, and can set
28660 the &$authenticated_id$& variable.
28661
28662 The client must present a verifiable certificate,
28663 for which it must have been requested via the
28664 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28665 (see &<<CHAPTLS>>&).
28666
28667 If an authenticator of this type is configured it is
28668 run before any SMTP-level communication is done,
28669 and can authenticate the connection.
28670 If it does, SMTP authentication is not offered.
28671
28672 A maximum of one authenticator of this type may be present.
28673
28674
28675 .cindex "options" "&(tls)& authenticator (server)"
28676 The &(tls)& authenticator has three server options:
28677
28678 .option server_param1 tls string&!! unset
28679 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28680 This option is expanded after the TLS negotiation and
28681 the result is placed in &$auth1$&.
28682 If the expansion is forced to fail, authentication fails. Any other expansion
28683 failure causes a temporary error code to be returned.
28684
28685 .option server_param2 tls string&!! unset
28686 .option server_param3 tls string&!! unset
28687 As above, for &$auth2$& and &$auth3$&.
28688
28689 &%server_param1%& may also be spelled &%server_param%&.
28690
28691
28692 Example:
28693 .code
28694 tls:
28695   driver = tls
28696   server_param1 =     ${certextract {subj_altname,mail,>:} \
28697                                     {$tls_in_peercert}}
28698   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28699                                  {forany {$auth1} \
28700                             {!= {0} \
28701                                 {${lookup ldap{ldap:///\
28702                          mailname=${quote_ldap_dn:${lc:$item}},\
28703                          ou=users,LDAP_DC?mailid} {$value}{0} \
28704                        }    }  } }}}
28705   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28706 .endd
28707 This accepts a client certificate that is verifiable against any
28708 of your configured trust-anchors
28709 (which usually means the full set of public CAs)
28710 and which has a SAN with a good account name.
28711
28712 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28713 The account name is therefore guessable by an opponent.
28714 TLS 1.3 protects both server and client certificates, and is not vulnerable
28715 in this way.
28716 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28717
28718 . An alternative might use
28719 . .code
28720 .   server_param1 = ${sha256:$tls_in_peercert}
28721 . .endd
28722 . to require one of a set of specific certs that define a given account
28723 . (the verification is still required, but mostly irrelevant).
28724 . This would help for per-device use.
28725 .
28726 . However, for the future we really need support for checking a
28727 . user cert in LDAP - which probably wants a base-64 DER.
28728
28729 .ecindex IIDtlsauth1
28730 .ecindex IIDtlsauth2
28731
28732
28733 Note that because authentication is traditionally an SMTP operation,
28734 the &%authenticated%& ACL condition cannot be used in
28735 a connect- or helo-ACL.
28736
28737
28738
28739 . ////////////////////////////////////////////////////////////////////////////
28740 . ////////////////////////////////////////////////////////////////////////////
28741
28742 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28743          "Encrypted SMTP connections"
28744 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28745 .scindex IIDencsmtp2 "SMTP" "encryption"
28746 .cindex "TLS" "on SMTP connection"
28747 .cindex "OpenSSL"
28748 .cindex "GnuTLS"
28749 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28750 Sockets Layer), is implemented by making use of the OpenSSL library or the
28751 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28752 cryptographic code in the Exim distribution itself for implementing TLS. In
28753 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28754 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28755 You also need to understand the basic concepts of encryption at a managerial
28756 level, and in particular, the way that public keys, private keys, and
28757 certificates are used.
28758
28759 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28760 connection is established, the client issues a STARTTLS command. If the
28761 server accepts this, the client and the server negotiate an encryption
28762 mechanism. If the negotiation succeeds, the data that subsequently passes
28763 between them is encrypted.
28764
28765 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28766 and if so, what cipher suite is in use, whether the client supplied a
28767 certificate, and whether or not that certificate was verified. This makes it
28768 possible for an Exim server to deny or accept certain commands based on the
28769 encryption state.
28770
28771 &*Warning*&: Certain types of firewall and certain anti-virus products can
28772 disrupt TLS connections. You need to turn off SMTP scanning for these products
28773 in order to get TLS to work.
28774
28775
28776
28777 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28778          "SECID284"
28779 .cindex "submissions protocol"
28780 .cindex "ssmtp protocol"
28781 .cindex "smtps protocol"
28782 .cindex "SMTP" "submissions protocol"
28783 .cindex "SMTP" "ssmtp protocol"
28784 .cindex "SMTP" "smtps protocol"
28785 The history of port numbers for TLS in SMTP is a little messy and has been
28786 contentious.  As of RFC 8314, the common practice of using the historically
28787 allocated port 465 for "email submission but with TLS immediately upon connect
28788 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28789 by them in preference to STARTTLS.
28790
28791 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28792 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28793 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28794
28795 This approach was, for a while, officially abandoned when encrypted SMTP was
28796 standardized, but many clients kept using it, even as the TCP port number was
28797 reassigned for other use.
28798 Thus you may encounter guidance claiming that you shouldn't enable use of
28799 this port.
28800 In practice, a number of mail-clients have only ever supported submissions,
28801 not submission with STARTTLS upgrade.
28802 Ideally, offer both submission (587) and submissions (465) service.
28803
28804 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28805 global option. Its value must be a list of port numbers;
28806 the most common use is expected to be:
28807 .code
28808 tls_on_connect_ports = 465
28809 .endd
28810 The port numbers specified by this option apply to all SMTP connections, both
28811 via the daemon and via &'inetd'&. You still need to specify all the ports that
28812 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28813 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28814 an extra port &-- rather, it specifies different behaviour on a port that is
28815 defined elsewhere.
28816
28817 There is also a &%-tls-on-connect%& command line option. This overrides
28818 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28819
28820
28821
28822
28823
28824
28825 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28826 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28827 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28828 To build Exim to use OpenSSL you need to set
28829 .code
28830 USE_OPENSSL=yes
28831 .endd
28832 in Local/Makefile.
28833
28834 To build Exim to use GnuTLS, you need to set
28835 .code
28836 USE_GNUTLS=yes
28837 .endd
28838 in Local/Makefile.
28839
28840 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28841 include files and libraries for GnuTLS can be found.
28842
28843 There are some differences in usage when using GnuTLS instead of OpenSSL:
28844
28845 .ilist
28846 The &%tls_verify_certificates%& option
28847 cannot be the path of a directory
28848 for GnuTLS versions before 3.3.6
28849 (for later versions, or OpenSSL, it can be either).
28850 .next
28851 The default value for &%tls_dhparam%& differs for historical reasons.
28852 .next
28853 .vindex "&$tls_in_peerdn$&"
28854 .vindex "&$tls_out_peerdn$&"
28855 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28856 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28857 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28858 .next
28859 OpenSSL identifies cipher suites using hyphens as separators, for example:
28860 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28861 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28862 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28863 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28864 to handle its own older variants) when processing lists of cipher suites in the
28865 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28866 option).
28867 .next
28868 The &%tls_require_ciphers%& options operate differently, as described in the
28869 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28870 .next
28871 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28872 When using OpenSSL, this option is ignored.
28873 (If an API is found to let OpenSSL be configured in this way,
28874 let the Exim Maintainers know and we'll likely use it).
28875 .next
28876 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28877 main option, it must be ordered to match the &%tls_certificate%& list.
28878 .next
28879 Some other recently added features may only be available in one or the other.
28880 This should be documented with the feature.  If the documentation does not
28881 explicitly state that the feature is infeasible in the other TLS
28882 implementation, then patches are welcome.
28883 .new
28884 .next
28885 The output from "exim -bV" will show which (if any) support was included
28886 in the build.
28887 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
28888 .wen
28889 .endlist
28890
28891
28892 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28893 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28894 an explicit path; if the latter, then the text about generation still applies,
28895 but not the chosen filename.
28896 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28897 See the documentation of &%tls_dhparam%& for more information.
28898
28899 GnuTLS uses D-H parameters that may take a substantial amount of time
28900 to compute. It is unreasonable to re-compute them for every TLS session.
28901 Therefore, Exim keeps this data in a file in its spool directory, called
28902 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28903 of bits requested.
28904 The file is owned by the Exim user and is readable only by
28905 its owner. Every Exim process that start up GnuTLS reads the D-H
28906 parameters from this file. If the file does not exist, the first Exim process
28907 that needs it computes the data and writes it to a temporary file which is
28908 renamed once it is complete. It does not matter if several Exim processes do
28909 this simultaneously (apart from wasting a few resources). Once a file is in
28910 place, new Exim processes immediately start using it.
28911
28912 For maximum security, the parameters that are stored in this file should be
28913 recalculated periodically, the frequency depending on your paranoia level.
28914 If you are avoiding using the fixed D-H primes published in RFCs, then you
28915 are concerned about some advanced attacks and will wish to do this; if you do
28916 not regenerate then you might as well stick to the standard primes.
28917
28918 Arranging this is easy in principle; just delete the file when you want new
28919 values to be computed. However, there may be a problem. The calculation of new
28920 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28921 If the system is not very active, &_/dev/random_& may delay returning data
28922 until enough randomness (entropy) is available. This may cause Exim to hang for
28923 a substantial amount of time, causing timeouts on incoming connections.
28924
28925 The solution is to generate the parameters externally to Exim. They are stored
28926 in &_gnutls-params-N_& in PEM format, which means that they can be
28927 generated externally using the &(certtool)& command that is part of GnuTLS.
28928
28929 To replace the parameters with new ones, instead of deleting the file
28930 and letting Exim re-create it, you can generate new parameters using
28931 &(certtool)& and, when this has been done, replace Exim's cache file by
28932 renaming. The relevant commands are something like this:
28933 .code
28934 # ls
28935 [ look for file; assume gnutls-params-2236 is the most recent ]
28936 # rm -f new-params
28937 # touch new-params
28938 # chown exim:exim new-params
28939 # chmod 0600 new-params
28940 # certtool --generate-dh-params --bits 2236 >>new-params
28941 # openssl dhparam -noout -text -in new-params | head
28942 [ check the first line, make sure it's not more than 2236;
28943   if it is, then go back to the start ("rm") and repeat
28944   until the size generated is at most the size requested ]
28945 # chmod 0400 new-params
28946 # mv new-params gnutls-params-2236
28947 .endd
28948 If Exim never has to generate the parameters itself, the possibility of
28949 stalling is removed.
28950
28951 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28952 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28953 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28954 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28955 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28956 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28957 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28958 which applies to all D-H usage, client or server.  If the value returned by
28959 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28960 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28961 limit, which is still much higher than Exim historically used.
28962
28963 The filename and bits used will change as the GnuTLS maintainers change the
28964 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28965 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28966 2432 bits, while NSS is limited to 2236 bits.
28967
28968 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28969 increase the chance of the generated prime actually being within acceptable
28970 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28971 procedure above.  There is no sane procedure available to Exim to double-check
28972 the size of the generated prime, so it might still be too large.
28973
28974
28975 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28976 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28977 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28978 There is a function in the OpenSSL library that can be passed a list of cipher
28979 suites before the cipher negotiation takes place. This specifies which ciphers
28980 are acceptable for TLS versions prior to 1.3.
28981 The list is colon separated and may contain names like
28982 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28983 directly to this function call.
28984 Many systems will install the OpenSSL manual-pages, so you may have
28985 &'ciphers(1)'& available to you.
28986 The following quotation from the OpenSSL
28987 documentation specifies what forms of item are allowed in the cipher string:
28988
28989 .ilist
28990 It can consist of a single cipher suite such as RC4-SHA.
28991 .next
28992 It can represent a list of cipher suites containing a certain algorithm,
28993 or cipher suites of a certain type. For example SHA1 represents all
28994 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28995 SSL v3 algorithms.
28996 .next
28997 Lists of cipher suites can be combined in a single cipher string using
28998 the + character. This is used as a logical and operation. For example
28999 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29000 algorithms.
29001 .endlist
29002
29003 Each cipher string can be optionally preceded by one of the characters &`!`&,
29004 &`-`& or &`+`&.
29005 .ilist
29006 If &`!`& is used, the ciphers are permanently deleted from the list. The
29007 ciphers deleted can never reappear in the list even if they are explicitly
29008 stated.
29009 .next
29010 If &`-`& is used, the ciphers are deleted from the list, but some or all
29011 of the ciphers can be added again by later options.
29012 .next
29013 If &`+`& is used, the ciphers are moved to the end of the list. This
29014 option does not add any new ciphers; it just moves matching existing ones.
29015 .endlist
29016
29017 If none of these characters is present, the string is interpreted as
29018 a list of ciphers to be appended to the current preference list. If the list
29019 includes any ciphers already present they will be ignored: that is, they will
29020 not be moved to the end of the list.
29021 .endlist
29022
29023 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29024 string:
29025 .code
29026 # note single-quotes to get ! past any shell history expansion
29027 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29028 .endd
29029
29030 This example will let the library defaults be permitted on the MX port, where
29031 there's probably no identity verification anyway, but ups the ante on the
29032 submission ports where the administrator might have some influence on the
29033 choice of clients used:
29034 .code
29035 # OpenSSL variant; see man ciphers(1)
29036 tls_require_ciphers = ${if =={$received_port}{25}\
29037                            {DEFAULT}\
29038                            {HIGH:!MD5:!SHA1}}
29039 .endd
29040
29041 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29042 .code
29043 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29044 .endd
29045
29046 For TLS version 1.3 the control available is less fine-grained
29047 and Exim does not provide access to it at present.
29048 The value of the &%tls_require_ciphers%& option is ignored when
29049 TLS version 1.3 is negotiated.
29050
29051 As of writing the library default cipher suite list for TLSv1.3 is
29052 .code
29053 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29054 .endd
29055
29056
29057 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29058          "SECTreqciphgnu"
29059 .cindex "GnuTLS" "specifying parameters for"
29060 .cindex "TLS" "specifying ciphers (GnuTLS)"
29061 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29062 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29063 .cindex "TLS" "specifying protocols (GnuTLS)"
29064 .cindex "TLS" "specifying priority string (GnuTLS)"
29065 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29066 The GnuTLS library allows the caller to provide a "priority string", documented
29067 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29068 ciphersuite specification in OpenSSL.
29069
29070 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29071 and controls both protocols and ciphers.
29072
29073 The &%tls_require_ciphers%& option is available both as an global option,
29074 controlling how Exim behaves as a server, and also as an option of the
29075 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29076 the value is string expanded.  The resulting string is not an Exim list and
29077 the string is given to the GnuTLS library, so that Exim does not need to be
29078 aware of future feature enhancements of GnuTLS.
29079
29080 Documentation of the strings accepted may be found in the GnuTLS manual, under
29081 "Priority strings".  This is online as
29082 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29083 but beware that this relates to GnuTLS 3, which may be newer than the version
29084 installed on your system.  If you are using GnuTLS 3,
29085 then the example code
29086 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29087 on that site can be used to test a given string.
29088
29089 For example:
29090 .code
29091 # Disable older versions of protocols
29092 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29093 .endd
29094
29095 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29096 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29097 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29098
29099 This example will let the library defaults be permitted on the MX port, where
29100 there's probably no identity verification anyway, and lowers security further
29101 by increasing compatibility; but this ups the ante on the submission ports
29102 where the administrator might have some influence on the choice of clients
29103 used:
29104 .code
29105 # GnuTLS variant
29106 tls_require_ciphers = ${if =={$received_port}{25}\
29107                            {NORMAL:%COMPAT}\
29108                            {SECURE128}}
29109 .endd
29110
29111
29112 .section "Configuring an Exim server to use TLS" "SECID182"
29113 .cindex "TLS" "configuring an Exim server"
29114 .cindex "ESMTP extensions" STARTTLS
29115 When Exim has been built with TLS support, it advertises the availability of
29116 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29117 but not to any others. The default value of this option is *, which means
29118 that STARTTLS is always advertised.  Set it to blank to never advertise;
29119 this is reasonable for systems that want to use TLS only as a client.
29120
29121 If STARTTLS is to be used you
29122 need to set some other options in order to make TLS available.
29123
29124 If a client issues a STARTTLS command and there is some configuration
29125 problem in the server, the command is rejected with a 454 error. If the client
29126 persists in trying to issue SMTP commands, all except QUIT are rejected
29127 with the error
29128 .code
29129 554 Security failure
29130 .endd
29131 If a STARTTLS command is issued within an existing TLS session, it is
29132 rejected with a 554 error code.
29133
29134 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29135 must be set to match some hosts. The default is * which matches all hosts.
29136
29137 If this is all you do, TLS encryption will be enabled but not authentication -
29138 meaning that the peer has no assurance it is actually you he is talking to.
29139 You gain protection from a passive sniffer listening on the wire but not
29140 from someone able to intercept the communication.
29141
29142 Further protection requires some further configuration at the server end.
29143
29144 To make TLS work you need to set, in the server,
29145 .code
29146 tls_certificate = /some/file/name
29147 tls_privatekey = /some/file/name
29148 .endd
29149 These options are, in fact, expanded strings, so you can make them depend on
29150 the identity of the client that is connected if you wish. The first file
29151 contains the server's X509 certificate, and the second contains the private key
29152 that goes with it. These files need to be
29153 PEM format and readable by the Exim user, and must
29154 always be given as full path names.
29155 The key must not be password-protected.
29156 They can be the same file if both the
29157 certificate and the key are contained within it. If &%tls_privatekey%& is not
29158 set, or if its expansion is forced to fail or results in an empty string, this
29159 is assumed to be the case. The certificate file may also contain intermediate
29160 certificates that need to be sent to the client to enable it to authenticate
29161 the server's certificate.
29162
29163 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29164 colon-separated lists of file paths.  Ciphers using given authentication
29165 algorithms require the presence of a suitable certificate to supply the
29166 public-key.  The server selects among the certificates to present to the
29167 client depending on the selected cipher, hence the priority ordering for
29168 ciphers will affect which certificate is used.
29169
29170 If you do not understand about certificates and keys, please try to find a
29171 source of this background information, which is not Exim-specific. (There are a
29172 few comments below in section &<<SECTcerandall>>&.)
29173
29174 &*Note*&: These options do not apply when Exim is operating as a client &--
29175 they apply only in the case of a server. If you need to use a certificate in an
29176 Exim client, you must set the options of the same names in an &(smtp)&
29177 transport.
29178
29179 With just these options, an Exim server will be able to use TLS. It does not
29180 require the client to have a certificate (but see below for how to insist on
29181 this). There is one other option that may be needed in other situations. If
29182 .code
29183 tls_dhparam = /some/file/name
29184 .endd
29185 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29186 with the parameters contained in the file.
29187 Set this to &`none`& to disable use of DH entirely, by making no prime
29188 available:
29189 .code
29190 tls_dhparam = none
29191 .endd
29192 This may also be set to a string identifying a standard prime to be used for
29193 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29194 used is &`ike23`&.  There are a few standard primes available, see the
29195 documentation for &%tls_dhparam%& for the complete list.
29196
29197 See the command
29198 .code
29199 openssl dhparam
29200 .endd
29201 for a way of generating file data.
29202
29203 The strings supplied for these three options are expanded every time a client
29204 host connects. It is therefore possible to use different certificates and keys
29205 for different hosts, if you so wish, by making use of the client's IP address
29206 in &$sender_host_address$& to control the expansion. If a string expansion is
29207 forced to fail, Exim behaves as if the option is not set.
29208
29209 .cindex "cipher" "logging"
29210 .cindex "log" "TLS cipher"
29211 .vindex "&$tls_in_cipher$&"
29212 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29213 an incoming TLS connection. It is included in the &'Received:'& header of an
29214 incoming message (by default &-- you can, of course, change this), and it is
29215 also included in the log line that records a message's arrival, keyed by
29216 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29217 condition can be used to test for specific cipher suites in ACLs.
29218
29219 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29220 can check the name of the cipher suite and vary their actions accordingly. The
29221 cipher suite names vary, depending on which TLS library is being used. For
29222 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29223 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29224 documentation for more details.
29225
29226 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29227 (again depending on the &%tls_cipher%& log selector).
29228
29229
29230 .section "Requesting and verifying client certificates" "SECID183"
29231 .cindex "certificate" "verification of client"
29232 .cindex "TLS" "client certificate verification"
29233 If you want an Exim server to request a certificate when negotiating a TLS
29234 session with a client, you must set either &%tls_verify_hosts%& or
29235 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29236 apply to all TLS connections. For any host that matches one of these options,
29237 Exim requests a certificate as part of the setup of the TLS session. The
29238 contents of the certificate are verified by comparing it with a list of
29239 expected trust-anchors or certificates.
29240 These may be the system default set (depending on library version),
29241 an explicit file or,
29242 depending on library version, a directory, identified by
29243 &%tls_verify_certificates%&.
29244
29245 A file can contain multiple certificates, concatenated end to end. If a
29246 directory is used
29247 (OpenSSL only),
29248 each certificate must be in a separate file, with a name (or a symbolic link)
29249 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29250 certificate. You can compute the relevant hash by running the command
29251 .code
29252 openssl x509 -hash -noout -in /cert/file
29253 .endd
29254 where &_/cert/file_& contains a single certificate.
29255
29256 There is no checking of names of the client against the certificate
29257 Subject Name or Subject Alternate Names.
29258
29259 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29260 what happens if the client does not supply a certificate, or if the certificate
29261 does not match any of the certificates in the collection named by
29262 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29263 attempt to set up a TLS session is aborted, and the incoming connection is
29264 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29265 session continues. ACLs that run for subsequent SMTP commands can detect the
29266 fact that no certificate was verified, and vary their actions accordingly. For
29267 example, you can insist on a certificate before accepting a message for
29268 relaying, but not when the message is destined for local delivery.
29269
29270 .vindex "&$tls_in_peerdn$&"
29271 When a client supplies a certificate (whether it verifies or not), the value of
29272 the Distinguished Name of the certificate is made available in the variable
29273 &$tls_in_peerdn$& during subsequent processing of the message.
29274
29275 .cindex "log" "distinguished name"
29276 Because it is often a long text string, it is not included in the log line or
29277 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29278 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29279 &%received_header_text%& to change the &'Received:'& header. When no
29280 certificate is supplied, &$tls_in_peerdn$& is empty.
29281
29282
29283 .section "Revoked certificates" "SECID184"
29284 .cindex "TLS" "revoked certificates"
29285 .cindex "revocation list"
29286 .cindex "certificate" "revocation list"
29287 .cindex "OCSP" "stapling"
29288 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29289 certificates are revoked. If you have such a list, you can pass it to an Exim
29290 server using the global option called &%tls_crl%& and to an Exim client using
29291 an identically named option for the &(smtp)& transport. In each case, the value
29292 of the option is expanded and must then be the name of a file that contains a
29293 CRL in PEM format.
29294 The downside is that clients have to periodically re-download a potentially huge
29295 file from every certificate authority they know of.
29296
29297 The way with most moving parts at query time is Online Certificate
29298 Status Protocol (OCSP), where the client verifies the certificate
29299 against an OCSP server run by the CA.  This lets the CA track all
29300 usage of the certs.  It requires running software with access to the
29301 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29302 is based on HTTP and can be proxied accordingly.
29303
29304 The only widespread OCSP server implementation (known to this writer)
29305 comes as part of OpenSSL and aborts on an invalid request, such as
29306 connecting to the port and then disconnecting.  This requires
29307 re-entering the passphrase each time some random client does this.
29308
29309 The third way is OCSP Stapling; in this, the server using a certificate
29310 issued by the CA periodically requests an OCSP proof of validity from
29311 the OCSP server, then serves it up inline as part of the TLS
29312 negotiation.   This approach adds no extra round trips, does not let the
29313 CA track users, scales well with number of certs issued by the CA and is
29314 resilient to temporary OCSP server failures, as long as the server
29315 starts retrying to fetch an OCSP proof some time before its current
29316 proof expires.  The downside is that it requires server support.
29317
29318 Unless Exim is built with the support disabled,
29319 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29320 support for OCSP stapling is included.
29321
29322 There is a global option called &%tls_ocsp_file%&.
29323 The file specified therein is expected to be in DER format, and contain
29324 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29325 option will be re-expanded for SNI, if the &%tls_certificate%& option
29326 contains &`tls_in_sni`&, as per other TLS options.
29327
29328 Exim does not at this time implement any support for fetching a new OCSP
29329 proof.  The burden is on the administrator to handle this, outside of
29330 Exim.  The file specified should be replaced atomically, so that the
29331 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29332 on each connection, so a new file will be handled transparently on the
29333 next connection.
29334
29335 When built with OpenSSL Exim will check for a valid next update timestamp
29336 in the OCSP proof; if not present, or if the proof has expired, it will be
29337 ignored.
29338
29339 For the client to be able to verify the stapled OCSP the server must
29340 also supply, in its stapled information, any intermediate
29341 certificates for the chain leading to the OCSP proof from the signer
29342 of the server certificate.  There may be zero or one such. These
29343 intermediate certificates should be added to the server OCSP stapling
29344 file named by &%tls_ocsp_file%&.
29345
29346 Note that the proof only covers the terminal server certificate,
29347 not any of the chain from CA to it.
29348
29349 There is no current way to staple a proof for a client certificate.
29350
29351 .code
29352   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29353   OCSP server is supplied.  The server URL may be included in the
29354   server certificate, if the CA is helpful.
29355
29356   One failure mode seen was the OCSP Signer cert expiring before the end
29357   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29358   noted this as invalid overall, but the re-fetch script did not.
29359 .endd
29360
29361
29362 .new
29363 .section "Caching of static server configuration items" "SECTserverTLScache"
29364 .cindex certificate caching
29365 .cindex privatekey caching
29366 .cindex crl caching
29367 .cindex ocsp caching
29368 .cindex ciphers caching
29369 .cindex "CA bundle" caching
29370 .cindex "certificate authorities" caching
29371 .cindex tls_certificate caching
29372 .cindex tls_privatekey caching
29373 .cindex tls_crl caching
29374 .cindex tls_ocsp_file caching
29375 .cindex tls_require_ciphers caching
29376 .cindex tls_verify_certificate caching
29377 .cindex caching certificate
29378 .cindex caching privatekey
29379 .cindex caching crl
29380 .cindex caching ocsp
29381 .cindex caching ciphers
29382 .cindex caching "certificate authorities
29383 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29384 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29385 expandable elements,
29386 then the associated information is loaded at daemon startup.
29387 It is made available
29388 to child processes forked for handling received SMTP connections.
29389
29390 This caching is currently only supported under Linux and FreeBSD.
29391
29392 If caching is not possible, for example if an item has to be dependent
29393 on the peer host so contains a &$sender_host_name$& expansion, the load
29394 of the associated information is done at the startup of the TLS connection.
29395
29396 The cache is invalidated and reloaded after any changes to the directories
29397 containing files specified by these options.
29398
29399 The information specified by the main option &%tls_verify_certificates%&
29400 is similarly cached so long as it specifies files explicitly
29401 or (under GnuTLS) is the string &"system,cache"&.
29402 The latter case is not automatically invalidated;
29403 it is the operator's responsibility to arrange for a daemon restart
29404 any time the system certificate authority bundle is updated.
29405 A HUP signal is sufficient for this.
29406 The value &"system"& results in no caching under GnuTLS.
29407
29408 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29409 is acceptable in configurations for the Exim executavble.
29410
29411 Caching of the system Certificate Authorities bundle can
29412 save siginificant time and processing on every TLS connection
29413 accepted by Exim.
29414 .wen
29415
29416
29417
29418
29419 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29420 .cindex "cipher" "logging"
29421 .cindex "log" "TLS cipher"
29422 .cindex "log" "distinguished name"
29423 .cindex "TLS" "configuring an Exim client"
29424 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29425 deliveries as well as to incoming, the latter one causing logging of the
29426 server certificate's DN. The remaining client configuration for TLS is all
29427 within the &(smtp)& transport.
29428
29429 .cindex "ESMTP extensions" STARTTLS
29430 It is not necessary to set any options to have TLS work in the &(smtp)&
29431 transport. If Exim is built with TLS support, and TLS is advertised by a
29432 server, the &(smtp)& transport always tries to start a TLS session. However,
29433 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29434 transport) to a list of server hosts for which TLS should not be used.
29435
29436 If you do not want Exim to attempt to send messages unencrypted when an attempt
29437 to set up an encrypted connection fails in any way, you can set
29438 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29439 those hosts, delivery is always deferred if an encrypted connection cannot be
29440 set up. If there are any other hosts for the address, they are tried in the
29441 usual way.
29442
29443 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29444 the message unencrypted. It always does this if the response to STARTTLS is
29445 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29446 session after a success response code, what happens is controlled by the
29447 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29448 delivery to this host is deferred, and other hosts (if available) are tried. If
29449 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29450 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29451 negotiation fails, Exim closes the current connection (because it is in an
29452 unknown state), opens a new one to the same host, and then tries the delivery
29453 unencrypted.
29454
29455 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29456 transport provide the client with a certificate, which is passed to the server
29457 if it requests it.
29458 This is an optional thing for TLS connections, although either end
29459 may insist on it.
29460 If the server is Exim, it will request a certificate only if
29461 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29462
29463 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29464 for client use (they are usable for server use).
29465 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29466 in failed connections.
29467
29468 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29469 specifies a collection of expected server certificates.
29470 These may be
29471 the system default set (depending on library version),
29472 a file,
29473 or (depending on library version) a directory.
29474 The client verifies the server's certificate
29475 against this collection, taking into account any revoked certificates that are
29476 in the list defined by &%tls_crl%&.
29477 Failure to verify fails the TLS connection unless either of the
29478 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29479
29480 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29481 certificate verification to the listed servers.  Verification either must
29482 or need not succeed respectively.
29483
29484 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29485 name checks are made on the server certificate.
29486 .new
29487 The match against this list is, as per other Exim usage, the
29488 IP for the host.  That is most closely associated with the
29489 name on the DNS A (or AAAA) record for the host.
29490 However, the name that needs to be in the certificate
29491 is the one at the head of any CNAME chain leading to the A record.
29492 .wen
29493 The option defaults to always checking.
29494
29495 The &(smtp)& transport has two OCSP-related options:
29496 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29497 is requested and required for the connection to proceed.  The default
29498 value is empty.
29499 &%hosts_request_ocsp%&; a host-list for which (additionally)
29500 a Certificate Status is requested (but not necessarily verified).  The default
29501 value is "*" meaning that requests are made unless configured
29502 otherwise.
29503
29504 The host(s) should also be in &%hosts_require_tls%&, and
29505 &%tls_verify_certificates%& configured for the transport,
29506 for OCSP to be relevant.
29507
29508 If
29509 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29510 list of permitted cipher suites. If either of these checks fails, delivery to
29511 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29512 alternative hosts, if any.
29513
29514  &*Note*&:
29515 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29516 is operating as a client. Exim does not assume that a server certificate (set
29517 by the global options of the same name) should also be used when operating as a
29518 client.
29519
29520 .vindex "&$host$&"
29521 .vindex "&$host_address$&"
29522 All the TLS options in the &(smtp)& transport are expanded before use, with
29523 &$host$& and &$host_address$& containing the name and address of the server to
29524 which the client is connected. Forced failure of an expansion causes Exim to
29525 behave as if the relevant option were unset.
29526
29527 .vindex &$tls_out_bits$&
29528 .vindex &$tls_out_cipher$&
29529 .vindex &$tls_out_peerdn$&
29530 .vindex &$tls_out_sni$&
29531 Before an SMTP connection is established, the
29532 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29533 variables are emptied. (Until the first connection, they contain the values
29534 that were set when the message was received.) If STARTTLS is subsequently
29535 successfully obeyed, these variables are set to the relevant values for the
29536 outgoing connection.
29537
29538
29539
29540 .new
29541 .section "Caching of static client configuration items" "SECTclientTLScache"
29542 .cindex certificate caching
29543 .cindex privatekey caching
29544 .cindex crl caching
29545 .cindex ciphers caching
29546 .cindex "CA bundle" caching
29547 .cindex "certificate authorities" caching
29548 .cindex tls_certificate caching
29549 .cindex tls_privatekey caching
29550 .cindex tls_crl caching
29551 .cindex tls_require_ciphers caching
29552 .cindex tls_verify_certificate caching
29553 .cindex caching certificate
29554 .cindex caching privatekey
29555 .cindex caching crl
29556 .cindex caching ciphers
29557 .cindex caching "certificate authorities
29558 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29559 and &%tls_crl%& have values with no
29560 expandable elements,
29561 then the associated information is loaded per smtp transport
29562 at daemon startup, at the start of a queue run, or on a
29563 command-line specified message delivery.
29564 It is made available
29565 to child processes forked for handling making SMTP connections.
29566
29567 This caching is currently only supported under Linux.
29568
29569 If caching is not possible, the load
29570 of the associated information is done at the startup of the TLS connection.
29571
29572 The cache is invalidated in the daemon
29573 and reloaded after any changes to the directories
29574 containing files specified by these options.
29575
29576 The information specified by the main option &%tls_verify_certificates%&
29577 is similarly cached so long as it specifies files explicitly
29578 or (under GnuTLS) is the string &"system,cache"&.
29579 The latter case is not automatically invaludated;
29580 it is the operator's responsibility to arrange for a daemon restart
29581 any time the system certificate authority bundle is updated.
29582 A HUP signal is sufficient for this.
29583 The value &"system"& results in no caching under GnuTLS.
29584
29585 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29586 is acceptable in configurations for the Exim executavble.
29587
29588 Caching of the system Certificate Authorities bundle can
29589 save siginificant time and processing on every TLS connection
29590 initiated by Exim.
29591 .wen
29592
29593
29594
29595
29596 .section "Use of TLS Server Name Indication" "SECTtlssni"
29597 .cindex "TLS" "Server Name Indication"
29598 .cindex "TLS" SNI
29599 .cindex SNI
29600 .vindex "&$tls_in_sni$&"
29601 .oindex "&%tls_in_sni%&"
29602 With TLS1.0 or above, there is an extension mechanism by which extra
29603 information can be included at various points in the protocol.  One of these
29604 extensions, documented in RFC 6066 (and before that RFC 4366) is
29605 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29606 client in the initial handshake, so that the server can examine the servername
29607 within and possibly choose to use different certificates and keys (and more)
29608 for this session.
29609
29610 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29611 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29612 address.
29613
29614 With SMTP to MX, there are the same problems here as in choosing the identity
29615 against which to validate a certificate: you can't rely on insecure DNS to
29616 provide the identity which you then cryptographically verify.  So this will
29617 be of limited use in that environment.
29618
29619 With SMTP to Submission, there is a well-defined hostname which clients are
29620 connecting to and can validate certificates against.  Thus clients &*can*&
29621 choose to include this information in the TLS negotiation.  If this becomes
29622 wide-spread, then hosters can choose to present different certificates to
29623 different clients.  Or even negotiate different cipher suites.
29624
29625 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29626 if not empty, will be sent on a TLS session as part of the handshake.  There's
29627 nothing more to it.  Choosing a sensible value not derived insecurely is the
29628 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29629 for the lifetime of the client connection (including during authentication).
29630
29631 .new
29632 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29633 is forced to the domain part of the recipient address.
29634 .wen
29635
29636 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29637 received from a client.
29638 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29639
29640 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29641 option (prior to expansion) then the following options will be re-expanded
29642 during TLS session handshake, to permit alternative values to be chosen:
29643
29644 .ilist
29645 &%tls_certificate%&
29646 .next
29647 &%tls_crl%&
29648 .next
29649 &%tls_privatekey%&
29650 .next
29651 &%tls_verify_certificates%&
29652 .next
29653 &%tls_ocsp_file%&
29654 .endlist
29655
29656 Great care should be taken to deal with matters of case, various injection
29657 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29658 can always be referenced; it is important to remember that &$tls_in_sni$& is
29659 arbitrary unverified data provided prior to authentication.
29660 Further, the initial certificate is loaded before SNI has arrived, so
29661 an expansion for &%tls_certificate%& must have a default which is used
29662 when &$tls_in_sni$& is empty.
29663
29664 The Exim developers are proceeding cautiously and so far no other TLS options
29665 are re-expanded.
29666
29667 When Exim is built against OpenSSL, OpenSSL must have been built with support
29668 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29669 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29670 see &`-servername`& in the output, then OpenSSL has support.
29671
29672 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29673 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29674 built, then you have SNI support).
29675
29676
29677
29678 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29679          "SECTmulmessam"
29680 .cindex "multiple SMTP deliveries with TLS"
29681 .cindex "TLS" "multiple message deliveries"
29682 Exim sends multiple messages down the same TCP/IP connection by starting up
29683 an entirely new delivery process for each message, passing the socket from
29684 one process to the next. This implementation does not fit well with the use
29685 of TLS, because there is quite a lot of state information associated with a TLS
29686 connection, not just a socket identification. Passing all the state information
29687 to a new process is not feasible. Consequently, for sending using TLS Exim
29688 starts an additional proxy process for handling the encryption, piping the
29689 unencrypted data stream from and to the delivery processes.
29690
29691 An older mode of operation can be enabled on a per-host basis by the
29692 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29693 this list the proxy process described above is not used; instead Exim
29694 shuts down an existing TLS session being run by the delivery process
29695 before passing the socket to a new process. The new process may then
29696 try to start a new TLS session, and if successful, may try to re-authenticate
29697 if AUTH is in use, before sending the next message.
29698
29699 The RFC is not clear as to whether or not an SMTP session continues in clear
29700 after TLS has been shut down, or whether TLS may be restarted again later, as
29701 just described. However, if the server is Exim, this shutdown and
29702 reinitialization works. It is not known which (if any) other servers operate
29703 successfully if the client closes a TLS session and continues with unencrypted
29704 SMTP, but there are certainly some that do not work. For such servers, Exim
29705 should not pass the socket to another process, because the failure of the
29706 subsequent attempt to use it would cause Exim to record a temporary host error,
29707 and delay other deliveries to that host.
29708
29709 To test for this case, Exim sends an EHLO command to the server after
29710 closing down the TLS session. If this fails in any way, the connection is
29711 closed instead of being passed to a new delivery process, but no retry
29712 information is recorded.
29713
29714 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29715 &(smtp)& transport to match those hosts for which Exim should not pass
29716 connections to new processes if TLS has been used.
29717
29718
29719
29720
29721 .section "Certificates and all that" "SECTcerandall"
29722 .cindex "certificate" "references to discussion"
29723 In order to understand fully how TLS works, you need to know about
29724 certificates, certificate signing, and certificate authorities.
29725 This is a large topic and an introductory guide is unsuitable for the Exim
29726 reference manual, so instead we provide pointers to existing documentation.
29727
29728 The Apache web-server was for a long time the canonical guide, so their
29729 documentation is a good place to start; their SSL module's Introduction
29730 document is currently at
29731 .display
29732 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29733 .endd
29734 and their FAQ is at
29735 .display
29736 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29737 .endd
29738
29739 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29740 0-201-61598-3) in 2001, contains both introductory and more in-depth
29741 descriptions.
29742 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29743 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29744 Ivan is the author of the popular TLS testing tools at
29745 &url(https://www.ssllabs.com/).
29746
29747
29748 .section "Certificate chains" "SECID186"
29749 The file named by &%tls_certificate%& may contain more than one
29750 certificate. This is useful in the case where the certificate that is being
29751 sent is validated by an intermediate certificate which the other end does
29752 not have. Multiple certificates must be in the correct order in the file.
29753 First the host's certificate itself, then the first intermediate
29754 certificate to validate the issuer of the host certificate, then the next
29755 intermediate certificate to validate the issuer of the first intermediate
29756 certificate, and so on, until finally (optionally) the root certificate.
29757 The root certificate must already be trusted by the recipient for
29758 validation to succeed, of course, but if it's not preinstalled, sending the
29759 root certificate along with the rest makes it available for the user to
29760 install if the receiving end is a client MUA that can interact with a user.
29761
29762 Note that certificates using MD5 are unlikely to work on today's Internet;
29763 even if your libraries allow loading them for use in Exim when acting as a
29764 server, increasingly clients will not accept such certificates.  The error
29765 diagnostics in such a case can be frustratingly vague.
29766
29767
29768
29769 .section "Self-signed certificates" "SECID187"
29770 .cindex "certificate" "self-signed"
29771 You can create a self-signed certificate using the &'req'& command provided
29772 with OpenSSL, like this:
29773 . ==== Do not shorten the duration here without reading and considering
29774 . ==== the text below.  Please leave it at 9999 days.
29775 .code
29776 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29777             -days 9999 -nodes
29778 .endd
29779 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29780 delimited and so can be identified independently. The &%-days%& option
29781 specifies a period for which the certificate is valid. The &%-nodes%& option is
29782 important: if you do not set it, the key is encrypted with a passphrase
29783 that you are prompted for, and any use that is made of the key causes more
29784 prompting for the passphrase. This is not helpful if you are going to use
29785 this certificate and key in an MTA, where prompting is not possible.
29786
29787 . ==== I expect to still be working 26 years from now.  The less technical
29788 . ==== debt I create, in terms of storing up trouble for my later years, the
29789 . ==== happier I will be then.  We really have reached the point where we
29790 . ==== should start, at the very least, provoking thought and making folks
29791 . ==== pause before proceeding, instead of leaving all the fixes until two
29792 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29793 . ==== -pdp, 2012
29794 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29795 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29796 the above command might produce a date in the past.  Think carefully about
29797 the lifetime of the systems you're deploying, and either reduce the duration
29798 of the certificate or reconsider your platform deployment.  (At time of
29799 writing, reducing the duration is the most likely choice, but the inexorable
29800 progression of time takes us steadily towards an era where this will not
29801 be a sensible resolution).
29802
29803 A self-signed certificate made in this way is sufficient for testing, and
29804 may be adequate for all your requirements if you are mainly interested in
29805 encrypting transfers, and not in secure identification.
29806
29807 However, many clients require that the certificate presented by the server be a
29808 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29809 certificate. In this situation, the self-signed certificate described above
29810 must be installed on the client host as a trusted root &'certification
29811 authority'& (CA), and the certificate used by Exim must be a user certificate
29812 signed with that self-signed certificate.
29813
29814 For information on creating self-signed CA certificates and using them to sign
29815 user certificates, see the &'General implementation overview'& chapter of the
29816 Open-source PKI book, available online at
29817 &url(https://sourceforge.net/projects/ospkibook/).
29818 .ecindex IIDencsmtp1
29819 .ecindex IIDencsmtp2
29820
29821
29822 .new
29823 .section "TLS Resumption" "SECTresumption"
29824 .cindex TLS resumption
29825 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
29826 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
29827 (or later).
29828
29829 Session resumption (this is the "stateless" variant) involves the server sending
29830 a "session ticket" to the client on one connection, which can be stored by the
29831 client and used for a later session.  The ticket contains sufficient state for
29832 the server to reconstruct the TLS session, avoiding some expensive crypto
29833 calculation and (on TLS1.2) one full packet roundtrip time.
29834
29835 .ilist
29836 Operational cost/benefit:
29837
29838  The extra data being transmitted costs a minor amount, and the client has
29839  extra costs in storing and retrieving the data.
29840
29841  In the Exim/Gnutls implementation the extra cost on an initial connection
29842  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
29843  The saved cost on a subsequent connection is about 4ms; three or more
29844  connections become a net win.  On longer network paths, two or more
29845  connections will have an average lower startup time thanks to the one
29846  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
29847  packet roundtrips.
29848
29849 .cindex "hints database" tls
29850  Since a new hints DB is used on the TLS client,
29851  the hints DB maintenance should be updated to additionally handle "tls".
29852
29853 .next
29854 Security aspects:
29855
29856  The session ticket is encrypted, but is obviously an additional security
29857  vulnarability surface.  An attacker able to decrypt it would have access
29858  all connections using the resumed session.
29859  The session ticket encryption key is not committed to storage by the server
29860  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
29861  overlap; GnuTLS 6hr but does not specify any overlap).
29862  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
29863  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
29864
29865  There is a question-mark over the security of the Diffie-Helman parameters
29866  used for session negotiation.
29867
29868 .next
29869 Observability:
29870
29871  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
29872  element.
29873
29874  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
29875  have bits 0-4 indicating respectively
29876  support built, client requested ticket, client offered session,
29877  server issued ticket, resume used.  A suitable decode list is provided
29878  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
29879
29880 .next
29881 Control:
29882
29883 The &%tls_resumption_hosts%& main option specifies a hostlist for which
29884 exim, operating as a server, will offer resumption to clients.
29885 Current best practice is to not offer the feature to MUA connection.
29886 Commonly this can be done like this:
29887 .code
29888 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
29889 .endd
29890 If the peer host matches the list after expansion then resumption
29891 is offered and/or accepted.
29892
29893 The &%tls_resumption_hosts%& smtp transport option performs the
29894 equivalent function for operation as a client.
29895 If the peer host matches the list after expansion then resumption
29896 is attempted (if a stored session is available) or the information
29897 stored (if supplied by the peer).
29898
29899
29900 .next
29901 Issues:
29902
29903  In a resumed session:
29904 .ilist
29905   The variables &$tls_{in,out}_cipher$& will have values different
29906  to the original (under GnuTLS).
29907 .next
29908   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
29909  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
29910 . XXX need to do something with that hosts_require_ocsp
29911 .endlist
29912
29913 .endlist
29914 .wen
29915
29916
29917 .section DANE "SECDANE"
29918 .cindex DANE
29919 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29920 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29921 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29922 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29923 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29924 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29925
29926 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29927 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29928 by (a) is thought to be smaller than that of the set of root CAs.
29929
29930 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29931 fail to pass on a server's STARTTLS.
29932
29933 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
29934 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29935 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29936
29937 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29938 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29939 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29940 DNSSEC.
29941 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29942 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29943
29944 There are no changes to Exim specific to server-side operation of DANE.
29945 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29946 in &_Local/Makefile_&.
29947 If it has been included, the macro "_HAVE_DANE" will be defined.
29948
29949 A TLSA record consist of 4 fields, the "Certificate Usage", the
29950 "Selector", the "Matching type", and the "Certificate Association Data".
29951 For a detailed description of the TLSA record see
29952 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29953
29954 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29955 These are the "Trust Anchor" and "End Entity" variants.
29956 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29957 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29958 this is appropriate for a single system, using a self-signed certificate.
29959 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29960 well-known one.
29961 A private CA at simplest is just a self-signed certificate (with certain
29962 attributes) which is used to sign server certificates, but running one securely
29963 does require careful arrangement.
29964 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29965 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29966 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29967 all of which point to a single TLSA record.
29968 DANE-TA and DANE-EE can both be used together.
29969
29970 Our recommendation is to use DANE with a certificate from a public CA,
29971 because this enables a variety of strategies for remote clients to verify
29972 your certificate.
29973 You can then publish information both via DANE and another technology,
29974 "MTA-STS", described below.
29975
29976 When you use DANE-TA to publish trust anchor information, you ask entities
29977 outside your administrative control to trust the Certificate Authority for
29978 connections to you.
29979 If using a private CA then you should expect others to still apply the
29980 technical criteria they'd use for a public CA to your certificates.
29981 In particular, you should probably try to follow current best practices for CA
29982 operation around hash algorithms and key sizes.
29983 Do not expect other organizations to lower their security expectations just
29984 because a particular profile might be reasonable for your own internal use.
29985
29986 When this text was last updated, this in practice means to avoid use of SHA-1
29987 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29988 than 4096, for interoperability); to use keyUsage fields correctly; to use
29989 random serial numbers.
29990 The list of requirements is subject to change as best practices evolve.
29991 If you're not already using a private CA, or it doesn't meet these
29992 requirements, then we encourage you to avoid all these issues and use a public
29993 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29994
29995 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29996 a "Matching Type" (3rd) field of SHA2-512(2).
29997
29998 For the "Certificate Authority Data" (4th) field, commands like
29999
30000 .code
30001   openssl x509 -pubkey -noout <certificate.pem \
30002   | openssl rsa -outform der -pubin 2>/dev/null \
30003   | openssl sha512 \
30004   | awk '{print $2}'
30005 .endd
30006
30007 are workable to create a hash of the certificate's public key.
30008
30009 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30010
30011 .code
30012   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30013 .endd
30014
30015 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30016 is useful for quickly generating TLSA records.
30017
30018
30019 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30020
30021 The Certificate issued by the CA published in the DANE-TA model should be
30022 issued using a strong hash algorithm.
30023 Exim, and importantly various other MTAs sending to you, will not
30024 re-enable hash algorithms which have been disabled by default in TLS
30025 libraries.
30026 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30027 interoperability (and probably the maximum too, in 2018).
30028
30029 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30030 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30031 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30032
30033 .code
30034   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30035                                  {= {4}{$tls_out_tlsa_usage}} } \
30036                          {*}{}}
30037 .endd
30038
30039 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30040 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30041 found. If the definition of &%hosts_request_ocsp%& includes the
30042 string "tls_out_tlsa_usage", they are re-expanded in time to
30043 control the OCSP request.
30044
30045 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30046 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30047
30048
30049 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30050 and &%dane_require_tls_ciphers%&.
30051 The &"require"& variant will result in failure if the target host is not
30052 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30053 the &%dnssec_request_domains%& router or transport option.
30054
30055 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30056
30057 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
30058 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30059 will be required for the host.  If it does not, the host will not
30060 be used; there is no fallback to non-DANE or non-TLS.
30061
30062 If DANE is requested and usable, then the TLS cipher list configuration
30063 prefers to use the option &%dane_require_tls_ciphers%& and falls
30064 back to &%tls_require_ciphers%& only if that is unset.
30065 This lets you configure "decent crypto" for DANE and "better than nothing
30066 crypto" as the default.  Note though that while GnuTLS lets the string control
30067 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30068 limited to ciphersuite constraints.
30069
30070 If DANE is requested and useable (see above) the following transport options are ignored:
30071 .code
30072   hosts_require_tls
30073   tls_verify_hosts
30074   tls_try_verify_hosts
30075   tls_verify_certificates
30076   tls_crl
30077   tls_verify_cert_hostnames
30078   tls_sni
30079 .endd
30080
30081 If DANE is not usable, whether requested or not, and CA-anchored
30082 verification evaluation is wanted, the above variables should be set appropriately.
30083
30084 The router and transport option &%dnssec_request_domains%& must not be
30085 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30086
30087 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30088
30089 There is a new variable &$tls_out_dane$& which will have "yes" if
30090 verification succeeded using DANE and "no" otherwise (only useful
30091 in combination with events; see &<<CHAPevents>>&),
30092 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30093
30094 .cindex DANE reporting
30095 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30096 to achieve DANE-verified connection, if one was either requested and offered, or
30097 required.  This is intended to support TLS-reporting as defined in
30098 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30099 The &$event_data$& will be one of the Result Types defined in
30100 Section 4.3 of that document.
30101
30102 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30103
30104 DANE is specified in published RFCs and decouples certificate authority trust
30105 selection from a "race to the bottom" of "you must trust everything for mail
30106 to get through".  There is an alternative technology called MTA-STS, which
30107 instead publishes MX trust anchor information on an HTTPS website.  At the
30108 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30109 Exim has no support for MTA-STS as a client, but Exim mail server operators
30110 can choose to publish information describing their TLS configuration using
30111 MTA-STS to let those clients who do use that protocol derive trust
30112 information.
30113
30114 The MTA-STS design requires a certificate from a public Certificate Authority
30115 which is recognized by clients sending to you.
30116 That selection of which CAs are trusted by others is outside your control.
30117
30118 The most interoperable course of action is probably to use
30119 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30120 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30121 records for DANE clients (such as Exim and Postfix) and to publish anchor
30122 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30123 domain itself (with caveats around occasionally broken MTA-STS because of
30124 incompatible specification changes prior to reaching RFC status).
30125
30126
30127
30128 . ////////////////////////////////////////////////////////////////////////////
30129 . ////////////////////////////////////////////////////////////////////////////
30130
30131 .chapter "Access control lists" "CHAPACL"
30132 .scindex IIDacl "&ACL;" "description"
30133 .cindex "control of incoming mail"
30134 .cindex "message" "controlling incoming"
30135 .cindex "policy control" "access control lists"
30136 Access Control Lists (ACLs) are defined in a separate section of the runtime
30137 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30138 name, terminated by a colon. Here is a complete ACL section that contains just
30139 one very small ACL:
30140 .code
30141 begin acl
30142 small_acl:
30143   accept   hosts = one.host.only
30144 .endd
30145 You can have as many lists as you like in the ACL section, and the order in
30146 which they appear does not matter. The lists are self-terminating.
30147
30148 The majority of ACLs are used to control Exim's behaviour when it receives
30149 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30150 when a local process submits a message using SMTP by specifying the &%-bs%&
30151 option. The most common use is for controlling which recipients are accepted
30152 in incoming messages. In addition, you can define an ACL that is used to check
30153 local non-SMTP messages. The default configuration file contains an example of
30154 a realistic ACL for checking RCPT commands. This is discussed in chapter
30155 &<<CHAPdefconfil>>&.
30156
30157
30158 .section "Testing ACLs" "SECID188"
30159 The &%-bh%& command line option provides a way of testing your ACL
30160 configuration locally by running a fake SMTP session with which you interact.
30161
30162
30163 .section "Specifying when ACLs are used" "SECID189"
30164 .cindex "&ACL;" "options for specifying"
30165 In order to cause an ACL to be used, you have to name it in one of the relevant
30166 options in the main part of the configuration. These options are:
30167 .cindex "AUTH" "ACL for"
30168 .cindex "DATA" "ACLs for"
30169 .cindex "ETRN" "ACL for"
30170 .cindex "EXPN" "ACL for"
30171 .cindex "HELO" "ACL for"
30172 .cindex "EHLO" "ACL for"
30173 .cindex "DKIM" "ACL for"
30174 .cindex "MAIL" "ACL for"
30175 .cindex "QUIT, ACL for"
30176 .cindex "RCPT" "ACL for"
30177 .cindex "STARTTLS, ACL for"
30178 .cindex "VRFY" "ACL for"
30179 .cindex "SMTP" "connection, ACL for"
30180 .cindex "non-SMTP messages" "ACLs for"
30181 .cindex "MIME content scanning" "ACL for"
30182 .cindex "PRDR" "ACL for"
30183
30184 .table2 140pt
30185 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30186 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30187 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30188 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30189 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30190 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30191 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30192 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30193 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30194 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30195 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30196 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30197 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30198 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30199 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30200 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30201 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30202 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30203 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30204 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30205 .endtable
30206
30207 For example, if you set
30208 .code
30209 acl_smtp_rcpt = small_acl
30210 .endd
30211 the little ACL defined above is used whenever Exim receives a RCPT command
30212 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30213 done when RCPT commands arrive. A rejection of RCPT should cause the
30214 sending MTA to give up on the recipient address contained in the RCPT
30215 command, whereas rejection at other times may cause the client MTA to keep on
30216 trying to deliver the message. It is therefore recommended that you do as much
30217 testing as possible at RCPT time.
30218
30219
30220 .section "The non-SMTP ACLs" "SECID190"
30221 .cindex "non-SMTP messages" "ACLs for"
30222 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30223 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30224 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30225 the state of the SMTP connection such as encryption and authentication) are not
30226 relevant and are forbidden in these ACLs. However, the sender and recipients
30227 are known, so the &%senders%& and &%sender_domains%& conditions and the
30228 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30229 &$authenticated_sender$& are also available. You can specify added header lines
30230 in any of these ACLs.
30231
30232 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30233 non-SMTP message, before any of the message has been read. (This is the
30234 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30235 batched SMTP input, it runs after the DATA command has been reached. The
30236 result of this ACL is ignored; it cannot be used to reject a message. If you
30237 really need to, you could set a value in an ACL variable here and reject based
30238 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30239 controls, and in particular, it can be used to set
30240 .code
30241 control = suppress_local_fixups
30242 .endd
30243 This cannot be used in the other non-SMTP ACLs because by the time they are
30244 run, it is too late.
30245
30246 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30247 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30248
30249 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30250 kind of rejection is treated as permanent, because there is no way of sending a
30251 temporary error for these kinds of message.
30252
30253
30254 .section "The SMTP connect ACL" "SECID191"
30255 .cindex "SMTP" "connection, ACL for"
30256 .oindex &%smtp_banner%&
30257 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30258 session, after the test specified by &%host_reject_connection%& (which is now
30259 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30260 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30261 the message override the banner message that is otherwise specified by the
30262 &%smtp_banner%& option.
30263
30264
30265 .section "The EHLO/HELO ACL" "SECID192"
30266 .cindex "EHLO" "ACL for"
30267 .cindex "HELO" "ACL for"
30268 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30269 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30270 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30271 Note that a client may issue more than one EHLO or HELO command in an SMTP
30272 session, and indeed is required to issue a new EHLO or HELO after successfully
30273 setting up encryption following a STARTTLS command.
30274
30275 Note also that a deny neither forces the client to go away nor means that
30276 mail will be refused on the connection.  Consider checking for
30277 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30278
30279 If the command is accepted by an &%accept%& verb that has a &%message%&
30280 modifier, the message may not contain more than one line (it will be truncated
30281 at the first newline and a panic logged if it does). Such a message cannot
30282 affect the EHLO options that are listed on the second and subsequent lines of
30283 an EHLO response.
30284
30285
30286 .section "The DATA ACLs" "SECID193"
30287 .cindex "DATA" "ACLs for"
30288 Two ACLs are associated with the DATA command, because it is two-stage
30289 command, with two responses being sent to the client.
30290 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30291 is obeyed. This gives you control after all the RCPT commands, but before
30292 the message itself is received. It offers the opportunity to give a negative
30293 response to the DATA command before the data is transmitted. Header lines
30294 added by MAIL or RCPT ACLs are not visible at this time, but any that
30295 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30296
30297 You cannot test the contents of the message, for example, to verify addresses
30298 in the headers, at RCPT time or when the DATA command is received. Such
30299 tests have to appear in the ACL that is run after the message itself has been
30300 received, before the final response to the DATA command is sent. This is
30301 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30302 associated with the DATA command.
30303
30304 .cindex CHUNKING "BDAT command"
30305 .cindex BDAT "SMTP command"
30306 .cindex "RFC 3030" CHUNKING
30307 If CHUNKING was advertised and a BDAT command sequence is received,
30308 the &%acl_smtp_predata%& ACL is not run.
30309 . XXX why not?  It should be possible, for the first BDAT.
30310 The &%acl_smtp_data%& is run after the last BDAT command and all of
30311 the data specified is received.
30312
30313 For both of these ACLs, it is not possible to reject individual recipients. An
30314 error response rejects the entire message. Unfortunately, it is known that some
30315 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30316 before or after the data) correctly &-- they keep the message on their queues
30317 and try again later, but that is their problem, though it does waste some of
30318 your resources.
30319
30320 The &%acl_smtp_data%& ACL is run after
30321 the &%acl_smtp_data_prdr%&,
30322 the &%acl_smtp_dkim%&
30323 and the &%acl_smtp_mime%& ACLs.
30324
30325 .section "The SMTP DKIM ACL" "SECTDKIMACL"
30326 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30327 enabled (which is the default).
30328
30329 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30330 received, and is executed for each DKIM signature found in a message.  If not
30331 otherwise specified, the default action is to accept.
30332
30333 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30334
30335 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30336
30337
30338 .section "The SMTP MIME ACL" "SECID194"
30339 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30340 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30341
30342 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30343
30344
30345 .section "The SMTP PRDR ACL" "SECTPRDRACL"
30346 .cindex "PRDR" "ACL for"
30347 .oindex "&%prdr_enable%&"
30348 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30349 with PRDR support enabled (which is the default).
30350 It becomes active only when the PRDR feature is negotiated between
30351 client and server for a message, and more than one recipient
30352 has been accepted.
30353
30354 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30355 has been received, and is executed once for each recipient of the message
30356 with &$local_part$& and &$domain$& valid.
30357 The test may accept, defer or deny for individual recipients.
30358 The &%acl_smtp_data%& will still be called after this ACL and
30359 can reject the message overall, even if this ACL has accepted it
30360 for some or all recipients.
30361
30362 PRDR may be used to support per-user content filtering.  Without it
30363 one must defer any recipient after the first that has a different
30364 content-filter configuration.  With PRDR, the RCPT-time check
30365 .cindex "PRDR" "variable for"
30366 for this can be disabled when the variable &$prdr_requested$&
30367 is &"yes"&.
30368 Any required difference in behaviour of the main DATA-time
30369 ACL should however depend on the PRDR-time ACL having run, as Exim
30370 will avoid doing so in some situations (e.g. single-recipient mails).
30371
30372 See also the &%prdr_enable%& global option
30373 and the &%hosts_try_prdr%& smtp transport option.
30374
30375 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30376 If the ACL is not defined, processing completes as if
30377 the feature was not requested by the client.
30378
30379 .section "The QUIT ACL" "SECTQUITACL"
30380 .cindex "QUIT, ACL for"
30381 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30382 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30383 does not in fact control any access.
30384 For this reason, it may only accept
30385 or warn as its final result.
30386
30387 This ACL can be used for tasks such as custom logging at the end of an SMTP
30388 session. For example, you can use ACL variables in other ACLs to count
30389 messages, recipients, etc., and log the totals at QUIT time using one or
30390 more &%logwrite%& modifiers on a &%warn%& verb.
30391
30392 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30393 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30394
30395 You do not need to have a final &%accept%&, but if you do, you can use a
30396 &%message%& modifier to specify custom text that is sent as part of the 221
30397 response to QUIT.
30398
30399 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30400 failure (for example, failure to open a log file, or when Exim is bombing out
30401 because it has detected an unrecoverable error), all SMTP commands from the
30402 client are given temporary error responses until QUIT is received or the
30403 connection is closed. In these special cases, the QUIT ACL does not run.
30404
30405
30406 .section "The not-QUIT ACL" "SECTNOTQUITACL"
30407 .vindex &$acl_smtp_notquit$&
30408 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30409 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30410 trouble, such as being unable to write to its log files, this ACL is not run,
30411 because it might try to do things (such as write to log files) that make the
30412 situation even worse.
30413
30414 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30415 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30416 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30417 and &%warn%&.
30418
30419 .vindex &$smtp_notquit_reason$&
30420 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30421 to a string that indicates the reason for the termination of the SMTP
30422 connection. The possible values are:
30423 .table2
30424 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30425 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30426 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30427 .irow &`connection-lost`&          "The SMTP connection has been lost"
30428 .irow &`data-timeout`&             "Timeout while reading message data"
30429 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30430 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30431 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30432 .irow &`synchronization-error`&    "SMTP synchronization error"
30433 .irow &`tls-failed`&               "TLS failed to start"
30434 .endtable
30435 In most cases when an SMTP connection is closed without having received QUIT,
30436 Exim sends an SMTP response message before actually closing the connection.
30437 With the exception of the &`acl-drop`& case, the default message can be
30438 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30439 &%drop%& verb in another ACL, it is the message from the other ACL that is
30440 used.
30441
30442
30443 .section "Finding an ACL to use" "SECID195"
30444 .cindex "&ACL;" "finding which to use"
30445 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30446 you can use different ACLs in different circumstances. For example,
30447 .code
30448 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30449                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30450 .endd
30451 In the default configuration file there are some example settings for
30452 providing an RFC 4409 message &"submission"& service on port 587 and
30453 an RFC 8314 &"submissions"& service on port 465. You can use a string
30454 expansion like this to choose an ACL for MUAs on these ports which is
30455 more appropriate for this purpose than the default ACL on port 25.
30456
30457 The expanded string does not have to be the name of an ACL in the
30458 configuration file; there are other possibilities. Having expanded the
30459 string, Exim searches for an ACL as follows:
30460
30461 .ilist
30462 If the string begins with a slash, Exim uses it as a filename, and reads its
30463 contents as an ACL. The lines are processed in the same way as lines in the
30464 Exim configuration file. In particular, continuation lines are supported, blank
30465 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30466 If the file does not exist or cannot be read, an error occurs (typically
30467 causing a temporary failure of whatever caused the ACL to be run). For example:
30468 .code
30469 acl_smtp_data = /etc/acls/\
30470   ${lookup{$sender_host_address}lsearch\
30471   {/etc/acllist}{$value}{default}}
30472 .endd
30473 This looks up an ACL file to use on the basis of the host's IP address, falling
30474 back to a default if the lookup fails. If an ACL is successfully read from a
30475 file, it is retained in memory for the duration of the Exim process, so that it
30476 can be re-used without having to re-read the file.
30477 .next
30478 If the string does not start with a slash, and does not contain any spaces,
30479 Exim searches the ACL section of the configuration for an ACL whose name
30480 matches the string.
30481 .next
30482 If no named ACL is found, or if the string contains spaces, Exim parses
30483 the string as an inline ACL. This can save typing in cases where you just
30484 want to have something like
30485 .code
30486 acl_smtp_vrfy = accept
30487 .endd
30488 in order to allow free use of the VRFY command. Such a string may contain
30489 newlines; it is processed in the same way as an ACL that is read from a file.
30490 .endlist
30491
30492
30493
30494
30495 .section "ACL return codes" "SECID196"
30496 .cindex "&ACL;" "return codes"
30497 Except for the QUIT ACL, which does not affect the SMTP return code (see
30498 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30499 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30500 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30501 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30502 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30503 This also causes a 4&'xx'& return code.
30504
30505 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30506 &"deny"&, because there is no mechanism for passing temporary errors to the
30507 submitters of non-SMTP messages.
30508
30509
30510 ACLs that are relevant to message reception may also return &"discard"&. This
30511 has the effect of &"accept"&, but causes either the entire message or an
30512 individual recipient address to be discarded. In other words, it is a
30513 blackholing facility. Use it with care.
30514
30515 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30516 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30517 RCPT ACL is to discard just the one recipient address. If there are no
30518 recipients left when the message's data is received, the DATA ACL is not
30519 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30520 remaining recipients. The &"discard"& return is not permitted for the
30521 &%acl_smtp_predata%& ACL.
30522
30523 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30524 is done on the address and the result determines the SMTP response.
30525
30526
30527 .cindex "&[local_scan()]& function" "when all recipients discarded"
30528 The &[local_scan()]& function is always run, even if there are no remaining
30529 recipients; it may create new recipients.
30530
30531
30532
30533 .section "Unset ACL options" "SECID197"
30534 .cindex "&ACL;" "unset options"
30535 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30536 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30537 not defined at all. For any defined ACL, the default action when control
30538 reaches the end of the ACL statements is &"deny"&.
30539
30540 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30541 these two are ACLs that are used only for their side effects. They cannot be
30542 used to accept or reject anything.
30543
30544 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30545 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30546 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30547 when the ACL is not defined is &"accept"&.
30548
30549 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30550 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30551 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30552 messages over an SMTP connection. For an example, see the ACL in the default
30553 configuration file.
30554
30555
30556
30557
30558 .section "Data for message ACLs" "SECID198"
30559 .cindex "&ACL;" "data for message ACL"
30560 .vindex &$domain$&
30561 .vindex &$local_part$&
30562 .vindex &$sender_address$&
30563 .vindex &$sender_host_address$&
30564 .vindex &$smtp_command$&
30565 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30566 that contain information about the host and the message's sender (for example,
30567 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30568 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30569 &$local_part$& are set from the argument address. The entire SMTP command
30570 is available in &$smtp_command$&.
30571
30572 When an ACL for the AUTH parameter of MAIL is running, the variables that
30573 contain information about the host are set, but &$sender_address$& is not yet
30574 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30575 how it is used.
30576
30577 .vindex "&$message_size$&"
30578 The &$message_size$& variable is set to the value of the SIZE parameter on
30579 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30580 that parameter is not given. The value is updated to the true message size by
30581 the time the final DATA ACL is run (after the message data has been
30582 received).
30583
30584 .vindex "&$rcpt_count$&"
30585 .vindex "&$recipients_count$&"
30586 The &$rcpt_count$& variable increases by one for each RCPT command received.
30587 The &$recipients_count$& variable increases by one each time a RCPT command is
30588 accepted, so while an ACL for RCPT is being processed, it contains the number
30589 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30590 &$rcpt_count$& contains the total number of RCPT commands, and
30591 &$recipients_count$& contains the total number of accepted recipients.
30592
30593
30594
30595
30596
30597 .section "Data for non-message ACLs" "SECTdatfornon"
30598 .cindex "&ACL;" "data for non-message ACL"
30599 .vindex &$smtp_command_argument$&
30600 .vindex &$smtp_command$&
30601 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30602 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30603 and the entire SMTP command is available in &$smtp_command$&.
30604 These variables can be tested using a &%condition%& condition. For example,
30605 here is an ACL for use with AUTH, which insists that either the session is
30606 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30607 does not permit authentication methods that use cleartext passwords on
30608 unencrypted connections.
30609 .code
30610 acl_check_auth:
30611   accept encrypted = *
30612   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30613                      {CRAM-MD5}}
30614   deny   message   = TLS encryption or CRAM-MD5 required
30615 .endd
30616 (Another way of applying this restriction is to arrange for the authenticators
30617 that use cleartext passwords not to be advertised when the connection is not
30618 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30619 option to do this.)
30620
30621
30622
30623 .section "Format of an ACL" "SECID199"
30624 .cindex "&ACL;" "format of"
30625 .cindex "&ACL;" "verbs, definition of"
30626 An individual ACL consists of a number of statements. Each statement starts
30627 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30628 Modifiers can change the way the verb operates, define error and log messages,
30629 set variables, insert delays, and vary the processing of accepted messages.
30630
30631 If all the conditions are met, the verb is obeyed. The same condition may be
30632 used (with different arguments) more than once in the same statement. This
30633 provides a means of specifying an &"and"& conjunction between conditions. For
30634 example:
30635 .code
30636 deny  dnslists = list1.example
30637       dnslists = list2.example
30638 .endd
30639 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30640 the conditions and modifiers when it reaches a condition that fails. What
30641 happens then depends on the verb (and in one case, on a special modifier). Not
30642 all the conditions make sense at every testing point. For example, you cannot
30643 test a sender address in the ACL that is run for a VRFY command.
30644
30645
30646 .section "ACL verbs" "SECID200"
30647 The ACL verbs are as follows:
30648
30649 .ilist
30650 .cindex "&%accept%& ACL verb"
30651 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30652 of the conditions are not met, what happens depends on whether &%endpass%&
30653 appears among the conditions (for syntax see below). If the failing condition
30654 is before &%endpass%&, control is passed to the next ACL statement; if it is
30655 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30656 check a RCPT command:
30657 .code
30658 accept domains = +local_domains
30659        endpass
30660        verify = recipient
30661 .endd
30662 If the recipient domain does not match the &%domains%& condition, control
30663 passes to the next statement. If it does match, the recipient is verified, and
30664 the command is accepted if verification succeeds. However, if verification
30665 fails, the ACL yields &"deny"&, because the failing condition is after
30666 &%endpass%&.
30667
30668 The &%endpass%& feature has turned out to be confusing to many people, so its
30669 use is not recommended nowadays. It is always possible to rewrite an ACL so
30670 that &%endpass%& is not needed, and it is no longer used in the default
30671 configuration.
30672
30673 .cindex "&%message%& ACL modifier" "with &%accept%&"
30674 If a &%message%& modifier appears on an &%accept%& statement, its action
30675 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30676 (when an &%accept%& verb either accepts or passes control to the next
30677 statement), &%message%& can be used to vary the message that is sent when an
30678 SMTP command is accepted. For example, in a RCPT ACL you could have:
30679 .display
30680 &`accept  `&<&'some conditions'&>
30681 &`        message = OK, I will allow you through today`&
30682 .endd
30683 You can specify an SMTP response code, optionally followed by an &"extended
30684 response code"& at the start of the message, but the first digit must be the
30685 same as would be sent by default, which is 2 for an &%accept%& verb.
30686
30687 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30688 an error message that is used when access is denied. This behaviour is retained
30689 for backward compatibility, but current &"best practice"& is to avoid the use
30690 of &%endpass%&.
30691
30692
30693 .next
30694 .cindex "&%defer%& ACL verb"
30695 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30696 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30697 &%defer%& is the same as &%deny%&, because there is no way of sending a
30698 temporary error. For a RCPT command, &%defer%& is much the same as using a
30699 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30700 be used in any ACL, and even for a recipient it might be a simpler approach.
30701
30702
30703 .next
30704 .cindex "&%deny%& ACL verb"
30705 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30706 the conditions are not met, control is passed to the next ACL statement. For
30707 example,
30708 .code
30709 deny dnslists = blackholes.mail-abuse.org
30710 .endd
30711 rejects commands from hosts that are on a DNS black list.
30712
30713
30714 .next
30715 .cindex "&%discard%& ACL verb"
30716 &%discard%&: This verb behaves like &%accept%&, except that it returns
30717 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30718 that are concerned with receiving messages. When all the conditions are true,
30719 the sending entity receives a &"success"& response. However, &%discard%& causes
30720 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30721 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30722 message's recipients are discarded. Recipients that are discarded before DATA
30723 do not appear in the log line when the &%received_recipients%& log selector is set.
30724
30725 If the &%log_message%& modifier is set when &%discard%& operates,
30726 its contents are added to the line that is automatically written to the log.
30727 The &%message%& modifier operates exactly as it does for &%accept%&.
30728
30729
30730 .next
30731 .cindex "&%drop%& ACL verb"
30732 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30733 forcibly closed after the 5&'xx'& error message has been sent. For example:
30734 .code
30735 drop   condition = ${if > {$rcpt_count}{20}}
30736        message   = I don't take more than 20 RCPTs
30737 .endd
30738 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30739 The connection is always dropped after sending a 550 response.
30740
30741 .next
30742 .cindex "&%require%& ACL verb"
30743 &%require%&: If all the conditions are met, control is passed to the next ACL
30744 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30745 example, when checking a RCPT command,
30746 .code
30747 require message = Sender did not verify
30748         verify  = sender
30749 .endd
30750 passes control to subsequent statements only if the message's sender can be
30751 verified. Otherwise, it rejects the command. Note the positioning of the
30752 &%message%& modifier, before the &%verify%& condition. The reason for this is
30753 discussed in section &<<SECTcondmodproc>>&.
30754
30755 .next
30756 .cindex "&%warn%& ACL verb"
30757 &%warn%&: If all the conditions are true, a line specified by the
30758 &%log_message%& modifier is written to Exim's main log. Control always passes
30759 to the next ACL statement. If any condition is false, the log line is not
30760 written. If an identical log line is requested several times in the same
30761 message, only one copy is actually written to the log. If you want to force
30762 duplicates to be written, use the &%logwrite%& modifier instead.
30763
30764 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30765 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30766 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30767 first failing condition. There is more about adding header lines in section
30768 &<<SECTaddheadacl>>&.
30769
30770 If any condition on a &%warn%& statement cannot be completed (that is, there is
30771 some sort of defer), the log line specified by &%log_message%& is not written.
30772 This does not include the case of a forced failure from a lookup, which
30773 is considered to be a successful completion. After a defer, no further
30774 conditions or modifiers in the &%warn%& statement are processed. The incident
30775 is logged, and the ACL continues to be processed, from the next statement
30776 onwards.
30777
30778
30779 .vindex "&$acl_verify_message$&"
30780 When one of the &%warn%& conditions is an address verification that fails, the
30781 text of the verification failure message is in &$acl_verify_message$&. If you
30782 want this logged, you must set it up explicitly. For example:
30783 .code
30784 warn   !verify = sender
30785        log_message = sender verify failed: $acl_verify_message
30786 .endd
30787 .endlist
30788
30789 At the end of each ACL there is an implicit unconditional &%deny%&.
30790
30791 As you can see from the examples above, the conditions and modifiers are
30792 written one to a line, with the first one on the same line as the verb, and
30793 subsequent ones on following lines. If you have a very long condition, you can
30794 continue it onto several physical lines by the usual backslash continuation
30795 mechanism. It is conventional to align the conditions vertically.
30796
30797
30798
30799 .section "ACL variables" "SECTaclvariables"
30800 .cindex "&ACL;" "variables"
30801 There are some special variables that can be set during ACL processing. They
30802 can be used to pass information between different ACLs, different invocations
30803 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30804 transports, and filters that are used to deliver a message. The names of these
30805 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30806 an underscore, but the remainder of the name can be any sequence of
30807 alphanumeric characters and underscores that you choose. There is no limit on
30808 the number of ACL variables. The two sets act as follows:
30809 .ilist
30810 The values of those variables whose names begin with &$acl_c$& persist
30811 throughout an SMTP connection. They are never reset. Thus, a value that is set
30812 while receiving one message is still available when receiving the next message
30813 on the same SMTP connection.
30814 .next
30815 The values of those variables whose names begin with &$acl_m$& persist only
30816 while a message is being received. They are reset afterwards. They are also
30817 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30818 .endlist
30819
30820 When a message is accepted, the current values of all the ACL variables are
30821 preserved with the message and are subsequently made available at delivery
30822 time. The ACL variables are set by a modifier called &%set%&. For example:
30823 .code
30824 accept hosts = whatever
30825        set acl_m4 = some value
30826 accept authenticated = *
30827        set acl_c_auth = yes
30828 .endd
30829 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30830 be set. If you want to set a variable without taking any action, you can use a
30831 &%warn%& verb without any other modifiers or conditions.
30832
30833 .oindex &%strict_acl_vars%&
30834 What happens if a syntactically valid but undefined ACL variable is
30835 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30836 false (the default), an empty string is substituted; if it is true, an
30837 error is generated.
30838
30839 Versions of Exim before 4.64 have a limited set of numbered variables, but
30840 their names are compatible, so there is no problem with upgrading.
30841
30842
30843 .section "Condition and modifier processing" "SECTcondmodproc"
30844 .cindex "&ACL;" "conditions; processing"
30845 .cindex "&ACL;" "modifiers; processing"
30846 An exclamation mark preceding a condition negates its result. For example:
30847 .code
30848 deny   domains = *.dom.example
30849       !verify  = recipient
30850 .endd
30851 causes the ACL to return &"deny"& if the recipient domain ends in
30852 &'dom.example'& and the recipient address cannot be verified. Sometimes
30853 negation can be used on the right-hand side of a condition. For example, these
30854 two statements are equivalent:
30855 .code
30856 deny  hosts = !192.168.3.4
30857 deny !hosts =  192.168.3.4
30858 .endd
30859 However, for many conditions (&%verify%& being a good example), only left-hand
30860 side negation of the whole condition is possible.
30861
30862 The arguments of conditions and modifiers are expanded. A forced failure
30863 of an expansion causes a condition to be ignored, that is, it behaves as if the
30864 condition is true. Consider these two statements:
30865 .code
30866 accept  senders = ${lookup{$host_name}lsearch\
30867                   {/some/file}{$value}fail}
30868 accept  senders = ${lookup{$host_name}lsearch\
30869                   {/some/file}{$value}{}}
30870 .endd
30871 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30872 the returned list is searched, but if the lookup fails the behaviour is
30873 different in the two cases. The &%fail%& in the first statement causes the
30874 condition to be ignored, leaving no further conditions. The &%accept%& verb
30875 therefore succeeds. The second statement, however, generates an empty list when
30876 the lookup fails. No sender can match an empty list, so the condition fails,
30877 and therefore the &%accept%& also fails.
30878
30879 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30880 specify actions that are taken as the conditions for a statement are checked;
30881 others specify text for messages that are used when access is denied or a
30882 warning is generated. The &%control%& modifier affects the way an incoming
30883 message is handled.
30884
30885 The positioning of the modifiers in an ACL statement is important, because the
30886 processing of a verb ceases as soon as its outcome is known. Only those
30887 modifiers that have already been encountered will take effect. For example,
30888 consider this use of the &%message%& modifier:
30889 .code
30890 require message = Can't verify sender
30891         verify  = sender
30892         message = Can't verify recipient
30893         verify  = recipient
30894         message = This message cannot be used
30895 .endd
30896 If sender verification fails, Exim knows that the result of the statement is
30897 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30898 so its text is used as the error message. If sender verification succeeds, but
30899 recipient verification fails, the second message is used. If recipient
30900 verification succeeds, the third message becomes &"current"&, but is never used
30901 because there are no more conditions to cause failure.
30902
30903 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30904 modifier that is used, because all the conditions must be true for rejection to
30905 happen. Specifying more than one &%message%& modifier does not make sense, and
30906 the message can even be specified after all the conditions. For example:
30907 .code
30908 deny   hosts = ...
30909       !senders = *@my.domain.example
30910        message = Invalid sender from client host
30911 .endd
30912 The &"deny"& result does not happen until the end of the statement is reached,
30913 by which time Exim has set up the message.
30914
30915
30916
30917 .section "ACL modifiers" "SECTACLmodi"
30918 .cindex "&ACL;" "modifiers; list of"
30919 The ACL modifiers are as follows:
30920
30921 .vlist
30922 .vitem &*add_header*&&~=&~<&'text'&>
30923 This modifier specifies one or more header lines that are to be added to an
30924 incoming message, assuming, of course, that the message is ultimately
30925 accepted. For details, see section &<<SECTaddheadacl>>&.
30926
30927 .vitem &*continue*&&~=&~<&'text'&>
30928 .cindex "&%continue%& ACL modifier"
30929 .cindex "database" "updating in ACL"
30930 This modifier does nothing of itself, and processing of the ACL always
30931 continues with the next condition or modifier. The value of &%continue%& is in
30932 the side effects of expanding its argument. Typically this could be used to
30933 update a database. It is really just a syntactic tidiness, to avoid having to
30934 write rather ugly lines like this:
30935 .display
30936 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30937 .endd
30938 Instead, all you need is
30939 .display
30940 &`continue = `&<&'some expansion'&>
30941 .endd
30942
30943 .vitem &*control*&&~=&~<&'text'&>
30944 .cindex "&%control%& ACL modifier"
30945 This modifier affects the subsequent processing of the SMTP connection or of an
30946 incoming message that is accepted. The effect of the first type of control
30947 lasts for the duration of the connection, whereas the effect of the second type
30948 lasts only until the current message has been received. The message-specific
30949 controls always apply to the whole message, not to individual recipients,
30950 even if the &%control%& modifier appears in a RCPT ACL.
30951
30952 As there are now quite a few controls that can be applied, they are described
30953 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30954 in several different ways. For example:
30955
30956 . ==== As this is a nested list, any displays it contains must be indented
30957 . ==== as otherwise they are too far to the left. That comment applies only
30958 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30959 . ==== way.
30960
30961 .ilist
30962 It can be at the end of an &%accept%& statement:
30963 .code
30964     accept  ...some conditions
30965             control = queue
30966 .endd
30967 In this case, the control is applied when this statement yields &"accept"&, in
30968 other words, when the conditions are all true.
30969
30970 .next
30971 It can be in the middle of an &%accept%& statement:
30972 .code
30973     accept  ...some conditions...
30974             control = queue
30975             ...some more conditions...
30976 .endd
30977 If the first set of conditions are true, the control is applied, even if the
30978 statement does not accept because one of the second set of conditions is false.
30979 In this case, some subsequent statement must yield &"accept"& for the control
30980 to be relevant.
30981
30982 .next
30983 It can be used with &%warn%& to apply the control, leaving the
30984 decision about accepting or denying to a subsequent verb. For
30985 example:
30986 .code
30987     warn    ...some conditions...
30988             control = freeze
30989     accept  ...
30990 .endd
30991 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30992 &%logwrite%&, so it does not add anything to the message and does not write a
30993 log entry.
30994
30995 .next
30996 If you want to apply a control unconditionally, you can use it with a
30997 &%require%& verb. For example:
30998 .code
30999     require  control = no_multiline_responses
31000 .endd
31001 .endlist
31002
31003 .vitem &*delay*&&~=&~<&'time'&>
31004 .cindex "&%delay%& ACL modifier"
31005 .oindex "&%-bh%&"
31006 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31007 the time interval before proceeding. However, when testing Exim using the
31008 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31009 output instead). The time is given in the usual Exim notation, and the delay
31010 happens as soon as the modifier is processed. In an SMTP session, pending
31011 output is flushed before the delay is imposed.
31012
31013 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31014 example:
31015 .code
31016 deny    ...some conditions...
31017         delay = 30s
31018 .endd
31019 The delay happens if all the conditions are true, before the statement returns
31020 &"deny"&. Compare this with:
31021 .code
31022 deny    delay = 30s
31023         ...some conditions...
31024 .endd
31025 which waits for 30s before processing the conditions. The &%delay%& modifier
31026 can also be used with &%warn%& and together with &%control%&:
31027 .code
31028 warn    ...some conditions...
31029         delay = 2m
31030         control = freeze
31031 accept  ...
31032 .endd
31033
31034 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31035 responses to several commands are no longer buffered and sent in one packet (as
31036 they would normally be) because all output is flushed before imposing the
31037 delay. This optimization is disabled so that a number of small delays do not
31038 appear to the client as one large aggregated delay that might provoke an
31039 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31040 using a &%control%& modifier to set &%no_delay_flush%&.
31041
31042
31043 .vitem &*endpass*&
31044 .cindex "&%endpass%& ACL modifier"
31045 This modifier, which has no argument, is recognized only in &%accept%& and
31046 &%discard%& statements. It marks the boundary between the conditions whose
31047 failure causes control to pass to the next statement, and the conditions whose
31048 failure causes the ACL to return &"deny"&. This concept has proved to be
31049 confusing to some people, so the use of &%endpass%& is no longer recommended as
31050 &"best practice"&. See the description of &%accept%& above for more details.
31051
31052
31053 .vitem &*log_message*&&~=&~<&'text'&>
31054 .cindex "&%log_message%& ACL modifier"
31055 This modifier sets up a message that is used as part of the log message if the
31056 ACL denies access or a &%warn%& statement's conditions are true. For example:
31057 .code
31058 require log_message = wrong cipher suite $tls_in_cipher
31059         encrypted   = DES-CBC3-SHA
31060 .endd
31061 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31062 example:
31063 .display
31064 &`discard `&<&'some conditions'&>
31065 &`        log_message = Discarded $local_part@$domain because...`&
31066 .endd
31067 When access is denied, &%log_message%& adds to any underlying error message
31068 that may exist because of a condition failure. For example, while verifying a
31069 recipient address, a &':fail:'& redirection might have already set up a
31070 message.
31071
31072 The message may be defined before the conditions to which it applies, because
31073 the string expansion does not happen until Exim decides that access is to be
31074 denied. This means that any variables that are set by the condition are
31075 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31076 variables are set after a DNS black list lookup succeeds. If the expansion of
31077 &%log_message%& fails, or if the result is an empty string, the modifier is
31078 ignored.
31079
31080 .vindex "&$acl_verify_message$&"
31081 If you want to use a &%warn%& statement to log the result of an address
31082 verification, you can use &$acl_verify_message$& to include the verification
31083 error message.
31084
31085 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31086 the start of the logged message. If the same warning log message is requested
31087 more than once while receiving  a single email message, only one copy is
31088 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31089 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31090 is logged for a successful &%warn%& statement.
31091
31092 If &%log_message%& is not present and there is no underlying error message (for
31093 example, from the failure of address verification), but &%message%& is present,
31094 the &%message%& text is used for logging rejections. However, if any text for
31095 logging contains newlines, only the first line is logged. In the absence of
31096 both &%log_message%& and &%message%&, a default built-in message is used for
31097 logging rejections.
31098
31099
31100 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31101 .cindex "&%log_reject_target%& ACL modifier"
31102 .cindex "logging in ACL" "specifying which log"
31103 This modifier makes it possible to specify which logs are used for messages
31104 about ACL rejections. Its argument is a colon-separated list of words that can
31105 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31106 may be empty, in which case a rejection is not logged at all. For example, this
31107 ACL fragment writes no logging information when access is denied:
31108 .display
31109 &`deny `&<&'some conditions'&>
31110 &`     log_reject_target =`&
31111 .endd
31112 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31113 permanent and temporary rejections. Its effect lasts for the rest of the
31114 current ACL.
31115
31116
31117 .vitem &*logwrite*&&~=&~<&'text'&>
31118 .cindex "&%logwrite%& ACL modifier"
31119 .cindex "logging in ACL" "immediate"
31120 This modifier writes a message to a log file as soon as it is encountered when
31121 processing an ACL. (Compare &%log_message%&, which, except in the case of
31122 &%warn%& and &%discard%&, is used only if the ACL statement denies
31123 access.) The &%logwrite%& modifier can be used to log special incidents in
31124 ACLs. For example:
31125 .display
31126 &`accept `&<&'some special conditions'&>
31127 &`       control  = freeze`&
31128 &`       logwrite = froze message because ...`&
31129 .endd
31130 By default, the message is written to the main log. However, it may begin
31131 with a colon, followed by a comma-separated list of log names, and then
31132 another colon, to specify exactly which logs are to be written. For
31133 example:
31134 .code
31135 logwrite = :main,reject: text for main and reject logs
31136 logwrite = :panic: text for panic log only
31137 .endd
31138
31139
31140 .vitem &*message*&&~=&~<&'text'&>
31141 .cindex "&%message%& ACL modifier"
31142 This modifier sets up a text string that is expanded and used as a response
31143 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31144 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31145 there is some complication if &%endpass%& is involved; see the description of
31146 &%accept%& for details.)
31147
31148 The expansion of the message happens at the time Exim decides that the ACL is
31149 to end, not at the time it processes &%message%&. If the expansion fails, or
31150 generates an empty string, the modifier is ignored. Here is an example where
31151 &%message%& must be specified first, because the ACL ends with a rejection if
31152 the &%hosts%& condition fails:
31153 .code
31154 require  message = Host not recognized
31155          hosts = 10.0.0.0/8
31156 .endd
31157 (Once a condition has failed, no further conditions or modifiers are
31158 processed.)
31159
31160 .cindex "SMTP" "error codes"
31161 .oindex "&%smtp_banner%&
31162 For ACLs that are triggered by SMTP commands, the message is returned as part
31163 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31164 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31165 is accepted. In the case of the connect ACL, accepting with a message modifier
31166 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31167 accept message may not contain more than one line (otherwise it will be
31168 truncated at the first newline and a panic logged), and it cannot affect the
31169 EHLO options.
31170
31171 When SMTP is involved, the message may begin with an overriding response code,
31172 consisting of three digits optionally followed by an &"extended response code"&
31173 of the form &'n.n.n'&, each code being followed by a space. For example:
31174 .code
31175 deny  message = 599 1.2.3 Host not welcome
31176       hosts = 192.168.34.0/24
31177 .endd
31178 The first digit of the supplied response code must be the same as would be sent
31179 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31180 access, but for the predata ACL, note that the default success code is 354, not
31181 2&'xx'&.
31182
31183 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31184 the message modifier cannot override the 221 response code.
31185
31186 The text in a &%message%& modifier is literal; any quotes are taken as
31187 literals, but because the string is expanded, backslash escapes are processed
31188 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
31189 response.
31190
31191 .vindex "&$acl_verify_message$&"
31192 For ACLs that are called by an &%acl =%& ACL condition, the message is
31193 stored in &$acl_verify_message$&, from which the calling ACL may use it.
31194
31195 If &%message%& is used on a statement that verifies an address, the message
31196 specified overrides any message that is generated by the verification process.
31197 However, the original message is available in the variable
31198 &$acl_verify_message$&, so you can incorporate it into your message if you
31199 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31200 routers to be passed back as part of the SMTP response, you should either not
31201 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31202
31203 For compatibility with previous releases of Exim, a &%message%& modifier that
31204 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31205 modifier, but this usage is now deprecated. However, &%message%& acts only when
31206 all the conditions are true, wherever it appears in an ACL command, whereas
31207 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31208 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31209 effect.
31210
31211
31212 .vitem &*queue*&&~=&~<&'text'&>
31213 .cindex "&%queue%& ACL modifier"
31214 .cindex "named queues" "selecting in ACL"
31215 This modifier specifies the use of a named queue for spool files
31216 for the message.
31217 It can only be used before the message is received (i.e. not in
31218 the DATA ACL).
31219 This could be used, for example, for known high-volume burst sources
31220 of traffic, or for quarantine of messages.
31221 Separate queue-runner processes will be needed for named queues.
31222 If the text after expansion is empty, the default queue is used.
31223
31224
31225 .vitem &*remove_header*&&~=&~<&'text'&>
31226 This modifier specifies one or more header names in a colon-separated list
31227  that are to be removed from an incoming message, assuming, of course, that
31228 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31229
31230
31231 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31232 .cindex "&%set%& ACL modifier"
31233 This modifier puts a value into one of the ACL variables (see section
31234 &<<SECTaclvariables>>&).
31235
31236
31237 .vitem &*udpsend*&&~=&~<&'parameters'&>
31238 .cindex "UDP communications"
31239 This modifier sends a UDP packet, for purposes such as statistics
31240 collection or behaviour monitoring. The parameters are expanded, and
31241 the result of the expansion must be a colon-separated list consisting
31242 of a destination server, port number, and the packet contents. The
31243 server can be specified as a host name or IPv4 or IPv6 address. The
31244 separator can be changed with the usual angle bracket syntax. For
31245 example, you might want to collect information on which hosts connect
31246 when:
31247 .code
31248 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31249              $tod_zulu $sender_host_address
31250 .endd
31251 .endlist
31252
31253
31254
31255
31256 .section "Use of the control modifier" "SECTcontrols"
31257 .cindex "&%control%& ACL modifier"
31258 The &%control%& modifier supports the following settings:
31259
31260 .vlist
31261 .vitem &*control&~=&~allow_auth_unadvertised*&
31262 This modifier allows a client host to use the SMTP AUTH command even when it
31263 has not been advertised in response to EHLO. Furthermore, because there are
31264 apparently some really broken clients that do this, Exim will accept AUTH after
31265 HELO (rather than EHLO) when this control is set. It should be used only if you
31266 really need it, and you should limit its use to those broken clients that do
31267 not work without it. For example:
31268 .code
31269 warn hosts   = 192.168.34.25
31270      control = allow_auth_unadvertised
31271 .endd
31272 Normally, when an Exim server receives an AUTH command, it checks the name of
31273 the authentication mechanism that is given in the command to ensure that it
31274 matches an advertised mechanism. When this control is set, the check that a
31275 mechanism has been advertised is bypassed. Any configured mechanism can be used
31276 by the client. This control is permitted only in the connection and HELO ACLs.
31277
31278
31279 .vitem &*control&~=&~caseful_local_part*& &&&
31280        &*control&~=&~caselower_local_part*&
31281 .cindex "&ACL;" "case of local part in"
31282 .cindex "case of local parts"
31283 .vindex "&$local_part$&"
31284 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31285 (that is, during RCPT processing). By default, the contents of &$local_part$&
31286 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31287 any uppercase letters in the original local part are restored in &$local_part$&
31288 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31289 is encountered.
31290
31291 These controls affect only the current recipient. Moreover, they apply only to
31292 local part handling that takes place directly in the ACL (for example, as a key
31293 in lookups). If a test to verify the recipient is obeyed, the case-related
31294 handling of the local part during the verification is controlled by the router
31295 configuration (see the &%caseful_local_part%& generic router option).
31296
31297 This facility could be used, for example, to add a spam score to local parts
31298 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31299 spam score:
31300 .code
31301 warn  control = caseful_local_part
31302       set acl_m4 = ${eval:\
31303                      $acl_m4 + \
31304                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31305                     }
31306       control = caselower_local_part
31307 .endd
31308 Notice that we put back the lower cased version afterwards, assuming that
31309 is what is wanted for subsequent tests.
31310
31311
31312 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31313 .cindex "&ACL;" "cutthrough routing"
31314 .cindex "cutthrough" "requesting"
31315 This option requests delivery be attempted while the item is being received.
31316
31317 The option is usable in the RCPT ACL.
31318 If enabled for a message received via smtp and routed to an smtp transport,
31319 and only one transport, interface, destination host and port combination
31320 is used for all recipients of the message,
31321 then the delivery connection is made while the receiving connection is open
31322 and data is copied from one to the other.
31323
31324 An attempt to set this option for any recipient but the first
31325 for a mail will be quietly ignored.
31326 If a recipient-verify callout
31327 (with use_sender)
31328 connection is subsequently
31329 requested in the same ACL it is held open and used for
31330 any subsequent recipients and the data,
31331 otherwise one is made after the initial RCPT ACL completes.
31332
31333 Note that routers are used in verify mode,
31334 and cannot depend on content of received headers.
31335 Note also that headers cannot be
31336 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31337 Headers may be modified by routers (subject to the above) and transports.
31338 The &'Received-By:'& header is generated as soon as the body reception starts,
31339 rather than the traditional time after the full message is received;
31340 this will affect the timestamp.
31341
31342 All the usual ACLs are called; if one results in the message being
31343 rejected, all effort spent in delivery (including the costs on
31344 the ultimate destination) will be wasted.
31345 Note that in the case of data-time ACLs this includes the entire
31346 message body.
31347
31348 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31349 of outgoing messages is done, because it sends data to the ultimate destination
31350 before the entire message has been received from the source.
31351 It is not supported for messages received with the SMTP PRDR
31352 or CHUNKING
31353 options in use.
31354
31355 Should the ultimate destination system positively accept or reject the mail,
31356 a corresponding indication is given to the source system and nothing is queued.
31357 If the item is successfully delivered in cutthrough mode
31358 the delivery log lines are tagged with ">>" rather than "=>" and appear
31359 before the acceptance "<=" line.
31360
31361 If there is a temporary error the item is queued for later delivery in the
31362 usual fashion.
31363 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31364 to the control; the default value is &"spool"& and the alternate value
31365 &"pass"& copies an SMTP defer response from the target back to the initiator
31366 and does not queue the message.
31367 Note that this is independent of any recipient verify conditions in the ACL.
31368
31369 Delivery in this mode avoids the generation of a bounce mail to a
31370 (possibly faked)
31371 sender when the destination system is doing content-scan based rejection.
31372
31373
31374 .vitem &*control&~=&~debug/*&<&'options'&>
31375 .cindex "&ACL;" "enabling debug logging"
31376 .cindex "debugging" "enabling from an ACL"
31377 This control turns on debug logging, almost as though Exim had been invoked
31378 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31379 by default called &'debuglog'&.
31380 The filename can be adjusted with the &'tag'& option, which
31381 may access any variables already defined.  The logging may be adjusted with
31382 the &'opts'& option, which takes the same values as the &`-d`& command-line
31383 option.
31384 Logging started this way may be stopped, and the file removed,
31385 with the &'kill'& option.
31386 Some examples (which depend on variables that don't exist in all
31387 contexts):
31388 .code
31389       control = debug
31390       control = debug/tag=.$sender_host_address
31391       control = debug/opts=+expand+acl
31392       control = debug/tag=.$message_exim_id/opts=+expand
31393       control = debug/kill
31394 .endd
31395
31396
31397 .vitem &*control&~=&~dkim_disable_verify*&
31398 .cindex "disable DKIM verify"
31399 .cindex "DKIM" "disable verify"
31400 This control turns off DKIM verification processing entirely.  For details on
31401 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31402
31403
31404 .vitem &*control&~=&~dmarc_disable_verify*&
31405 .cindex "disable DMARC verify"
31406 .cindex "DMARC" "disable verify"
31407 This control turns off DMARC verification processing entirely.  For details on
31408 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31409
31410
31411 .vitem &*control&~=&~dscp/*&<&'value'&>
31412 .cindex "&ACL;" "setting DSCP value"
31413 .cindex "DSCP" "inbound"
31414 This option causes the DSCP value associated with the socket for the inbound
31415 connection to be adjusted to a given value, given as one of a number of fixed
31416 strings or to numeric value.
31417 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31418 Common values include &`throughput`&, &`mincost`&, and on newer systems
31419 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31420
31421 The outbound packets from Exim will be marked with this value in the header
31422 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31423 that these values will have any effect, not be stripped by networking
31424 equipment, or do much of anything without cooperation with your Network
31425 Engineer and those of all network operators between the source and destination.
31426
31427
31428 .vitem &*control&~=&~enforce_sync*& &&&
31429        &*control&~=&~no_enforce_sync*&
31430 .cindex "SMTP" "synchronization checking"
31431 .cindex "synchronization checking in SMTP"
31432 These controls make it possible to be selective about when SMTP synchronization
31433 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31434 state of the switch (it is true by default). See the description of this option
31435 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31436
31437 The effect of these two controls lasts for the remainder of the SMTP
31438 connection. They can appear in any ACL except the one for the non-SMTP
31439 messages. The most straightforward place to put them is in the ACL defined by
31440 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31441 before the first synchronization check. The expected use is to turn off the
31442 synchronization checks for badly-behaved hosts that you nevertheless need to
31443 work with.
31444
31445
31446 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31447 .cindex "fake defer"
31448 .cindex "defer, fake"
31449 This control works in exactly the same way as &%fakereject%& (described below)
31450 except that it causes an SMTP 450 response after the message data instead of a
31451 550 response. You must take care when using &%fakedefer%& because it causes the
31452 messages to be duplicated when the sender retries. Therefore, you should not
31453 use &%fakedefer%& if the message is to be delivered normally.
31454
31455 .vitem &*control&~=&~fakereject/*&<&'message'&>
31456 .cindex "fake rejection"
31457 .cindex "rejection, fake"
31458 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31459 words, only when an SMTP message is being received. If Exim accepts the
31460 message, instead the final 250 response, a 550 rejection message is sent.
31461 However, Exim proceeds to deliver the message as normal. The control applies
31462 only to the current message, not to any subsequent ones that may be received in
31463 the same SMTP connection.
31464
31465 The text for the 550 response is taken from the &%control%& modifier. If no
31466 message is supplied, the following is used:
31467 .code
31468 550-Your message has been rejected but is being
31469 550-kept for evaluation.
31470 550-If it was a legitimate message, it may still be
31471 550 delivered to the target recipient(s).
31472 .endd
31473 This facility should be used with extreme caution.
31474
31475 .vitem &*control&~=&~freeze*&
31476 .cindex "frozen messages" "forcing in ACL"
31477 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31478 other words, only when a message is being received. If the message is accepted,
31479 it is placed on Exim's queue and frozen. The control applies only to the
31480 current message, not to any subsequent ones that may be received in the same
31481 SMTP connection.
31482
31483 This modifier can optionally be followed by &`/no_tell`&. If the global option
31484 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31485 is told about the freezing), provided all the &*control=freeze*& modifiers that
31486 are obeyed for the current message have the &`/no_tell`& option.
31487
31488 .vitem &*control&~=&~no_delay_flush*&
31489 .cindex "SMTP" "output flushing, disabling for delay"
31490 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31491 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31492 use. This control, as long as it is encountered before the &%delay%& modifier,
31493 disables such output flushing.
31494
31495 .vitem &*control&~=&~no_callout_flush*&
31496 .cindex "SMTP" "output flushing, disabling for callout"
31497 Exim normally flushes SMTP output before performing a callout in an ACL, to
31498 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31499 use. This control, as long as it is encountered before the &%verify%& condition
31500 that causes the callout, disables such output flushing.
31501
31502 .vitem &*control&~=&~no_mbox_unspool*&
31503 This control is available when Exim is compiled with the content scanning
31504 extension. Content scanning may require a copy of the current message, or parts
31505 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31506 or spam scanner. Normally, such copies are deleted when they are no longer
31507 needed. If this control is set, the copies are not deleted. The control applies
31508 only to the current message, not to any subsequent ones that may be received in
31509 the same SMTP connection. It is provided for debugging purposes and is unlikely
31510 to be useful in production.
31511
31512 .vitem &*control&~=&~no_multiline_responses*&
31513 .cindex "multiline responses, suppressing"
31514 This control is permitted for any ACL except the one for non-SMTP messages.
31515 It seems that there are broken clients in use that cannot handle multiline
31516 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31517
31518 If this control is set, multiline SMTP responses from ACL rejections are
31519 suppressed. One way of doing this would have been to put out these responses as
31520 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31521 (&"use multiline responses for more"& it says &-- ha!), and some of the
31522 responses might get close to that. So this facility, which is after all only a
31523 sop to broken clients, is implemented by doing two very easy things:
31524
31525 .ilist
31526 Extra information that is normally output as part of a rejection caused by
31527 sender verification failure is omitted. Only the final line (typically &"sender
31528 verification failed"&) is sent.
31529 .next
31530 If a &%message%& modifier supplies a multiline response, only the first
31531 line is output.
31532 .endlist
31533
31534 The setting of the switch can, of course, be made conditional on the
31535 calling host. Its effect lasts until the end of the SMTP connection.
31536
31537 .vitem &*control&~=&~no_pipelining*&
31538 .cindex "PIPELINING" "suppressing advertising"
31539 .cindex "ESMTP extensions" PIPELINING
31540 This control turns off the advertising of the PIPELINING extension to SMTP in
31541 the current session. To be useful, it must be obeyed before Exim sends its
31542 response to an EHLO command. Therefore, it should normally appear in an ACL
31543 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31544 &%pipelining_advertise_hosts%&.
31545
31546 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31547        &*control&~=&~queue_only*&
31548 .oindex "&%queue%&"
31549 .oindex "&%queue_only%&"
31550 .cindex "queueing incoming messages"
31551 .cindex queueing "forcing in ACL"
31552 .cindex "first pass routing"
31553 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31554 other words, only when a message is being received. If the message is accepted,
31555 it is placed on Exim's queue and left there for delivery by a subsequent queue
31556 runner.
31557 If used with no options set,
31558 no immediate delivery process is started. In other words, it has the
31559 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31560
31561 If the &'first_pass_route'& option is given then
31562 the behaviour is like the command-line &'-oqds'& option;
31563 a delivery process is started which stops short of making
31564 any SMTP delivery.  The benefit is that the hints database will be updated for
31565 the message being waiting for a specific host, and a later queue run will be
31566 able to send all such messages on a single connection.
31567
31568 The control only applies to the current message, not to any subsequent ones that
31569  may be received in the same SMTP connection.
31570
31571 .vitem &*control&~=&~submission/*&<&'options'&>
31572 .cindex "message" "submission"
31573 .cindex "submission mode"
31574 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31575 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31576 the current message is a submission from a local MUA. In this case, Exim
31577 operates in &"submission mode"&, and applies certain fixups to the message if
31578 necessary. For example, it adds a &'Date:'& header line if one is not present.
31579 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31580 late (the message has already been created).
31581
31582 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31583 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31584 submission mode; the available options for this control are described there.
31585 The control applies only to the current message, not to any subsequent ones
31586 that may be received in the same SMTP connection.
31587
31588 .vitem &*control&~=&~suppress_local_fixups*&
31589 .cindex "submission fixups, suppressing"
31590 This control applies to locally submitted (non TCP/IP) messages, and is the
31591 complement of &`control = submission`&. It disables the fixups that are
31592 normally applied to locally-submitted messages. Specifically:
31593
31594 .ilist
31595 Any &'Sender:'& header line is left alone (in this respect, it is a
31596 dynamic version of &%local_sender_retain%&).
31597 .next
31598 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31599 .next
31600 There is no check that &'From:'& corresponds to the actual sender.
31601 .endlist ilist
31602
31603 This control may be useful when a remotely-originated message is accepted,
31604 passed to some scanning program, and then re-submitted for delivery. It can be
31605 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31606 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31607 data is read.
31608
31609 &*Note:*& This control applies only to the current message, not to any others
31610 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31611
31612 .vitem &*control&~=&~utf8_downconvert*&
31613 This control enables conversion of UTF-8 in message envelope addresses
31614 to a-label form.
31615 For details see section &<<SECTi18nMTA>>&.
31616 .endlist vlist
31617
31618
31619 .section "Summary of message fixup control" "SECTsummesfix"
31620 All four possibilities for message fixups can be specified:
31621
31622 .ilist
31623 Locally submitted, fixups applied: the default.
31624 .next
31625 Locally submitted, no fixups applied: use
31626 &`control = suppress_local_fixups`&.
31627 .next
31628 Remotely submitted, no fixups applied: the default.
31629 .next
31630 Remotely submitted, fixups applied: use &`control = submission`&.
31631 .endlist
31632
31633
31634
31635 .section "Adding header lines in ACLs" "SECTaddheadacl"
31636 .cindex "header lines" "adding in an ACL"
31637 .cindex "header lines" "position of added lines"
31638 .cindex "&%add_header%& ACL modifier"
31639 The &%add_header%& modifier can be used to add one or more extra header lines
31640 to an incoming message, as in this example:
31641 .code
31642 warn dnslists = sbl.spamhaus.org : \
31643                 dialup.mail-abuse.org
31644      add_header = X-blacklisted-at: $dnslist_domain
31645 .endd
31646 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31647 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31648 receiving a message). The message must ultimately be accepted for
31649 &%add_header%& to have any significant effect. You can use &%add_header%& with
31650 any ACL verb, including &%deny%& (though this is potentially useful only in a
31651 RCPT ACL).
31652
31653 Headers will not be added to the message if the modifier is used in
31654 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31655
31656 Leading and trailing newlines are removed from
31657 the data for the &%add_header%& modifier; if it then
31658 contains one or more newlines that
31659 are not followed by a space or a tab, it is assumed to contain multiple header
31660 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31661 front of any line that is not a valid header line.
31662
31663 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31664 They are added to the message before processing the DATA and MIME ACLs.
31665 However, if an identical header line is requested more than once, only one copy
31666 is actually added to the message. Further header lines may be accumulated
31667 during the DATA and MIME ACLs, after which they are added to the message, again
31668 with duplicates suppressed. Thus, it is possible to add two identical header
31669 lines to an SMTP message, but only if one is added before DATA and one after.
31670 In the case of non-SMTP messages, new headers are accumulated during the
31671 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31672 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31673 are included in the entry that is written to the reject log.
31674
31675 .cindex "header lines" "added; visibility of"
31676 Header lines are not visible in string expansions
31677 of message headers
31678 until they are added to the
31679 message. It follows that header lines defined in the MAIL, RCPT, and predata
31680 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31681 header lines that are added by the DATA or MIME ACLs are not visible in those
31682 ACLs. Because of this restriction, you cannot use header lines as a way of
31683 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31684 this, you can use ACL variables, as described in section
31685 &<<SECTaclvariables>>&.
31686
31687 The list of headers yet to be added is given by the &%$headers_added%& variable.
31688
31689 The &%add_header%& modifier acts immediately as it is encountered during the
31690 processing of an ACL. Notice the difference between these two cases:
31691 .display
31692 &`accept add_header = ADDED: some text`&
31693 &`       `&<&'some condition'&>
31694
31695 &`accept `&<&'some condition'&>
31696 &`       add_header = ADDED: some text`&
31697 .endd
31698 In the first case, the header line is always added, whether or not the
31699 condition is true. In the second case, the header line is added only if the
31700 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31701 ACL statement. All those that are encountered before a condition fails are
31702 honoured.
31703
31704 .cindex "&%warn%& ACL verb"
31705 For compatibility with previous versions of Exim, a &%message%& modifier for a
31706 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31707 effect only if all the conditions are true, even if it appears before some of
31708 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31709 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31710 are present on a &%warn%& verb, both are processed according to their
31711 specifications.
31712
31713 By default, new header lines are added to a message at the end of the existing
31714 header lines. However, you can specify that any particular header line should
31715 be added right at the start (before all the &'Received:'& lines), immediately
31716 after the first block of &'Received:'& lines, or immediately before any line
31717 that is not a &'Received:'& or &'Resent-something:'& header.
31718
31719 This is done by specifying &":at_start:"&, &":after_received:"&, or
31720 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31721 header line, respectively. (Header text cannot start with a colon, as there has
31722 to be a header name first.) For example:
31723 .code
31724 warn add_header = \
31725        :after_received:X-My-Header: something or other...
31726 .endd
31727 If more than one header line is supplied in a single &%add_header%& modifier,
31728 each one is treated independently and can therefore be placed differently. If
31729 you add more than one line at the start, or after the Received: block, they end
31730 up in reverse order.
31731
31732 &*Warning*&: This facility currently applies only to header lines that are
31733 added in an ACL. It does NOT work for header lines that are added in a
31734 system filter or in a router or transport.
31735
31736
31737
31738 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31739 .cindex "header lines" "removing in an ACL"
31740 .cindex "header lines" "position of removed lines"
31741 .cindex "&%remove_header%& ACL modifier"
31742 The &%remove_header%& modifier can be used to remove one or more header lines
31743 from an incoming message, as in this example:
31744 .code
31745 warn   message        = Remove internal headers
31746        remove_header  = x-route-mail1 : x-route-mail2
31747 .endd
31748 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31749 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31750 receiving a message). The message must ultimately be accepted for
31751 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31752 with any ACL verb, including &%deny%&, though this is really not useful for
31753 any verb that doesn't result in a delivered message.
31754
31755 Headers will not be removed from the message if the modifier is used in
31756 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31757
31758 More than one header can be removed at the same time by using a colon separated
31759 list of header names. The header matching is case insensitive. Wildcards are
31760 not permitted, nor is list expansion performed, so you cannot use hostlists to
31761 create a list of headers, however both connection and message variable expansion
31762 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31763 .code
31764 warn   hosts           = +internal_hosts
31765        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31766 warn   message         = Remove internal headers
31767        remove_header   = $acl_c_ihdrs
31768 .endd
31769 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31770 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31771 If multiple header lines match, all are removed.
31772 There is no harm in attempting to remove the same header twice nor in removing
31773 a non-existent header. Further header lines to be removed may be accumulated
31774 during the DATA and MIME ACLs, after which they are removed from the message,
31775 if present. In the case of non-SMTP messages, headers to be removed are
31776 accumulated during the non-SMTP ACLs, and are removed from the message after
31777 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31778 ACL, there really is no effect because there is no logging of what headers
31779 would have been removed.
31780
31781 .cindex "header lines" "removed; visibility of"
31782 Header lines are not visible in string expansions until the DATA phase when it
31783 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31784 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31785 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31786 this restriction, you cannot use header lines as a way of controlling data
31787 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31788 you should instead use ACL variables, as described in section
31789 &<<SECTaclvariables>>&.
31790
31791 The &%remove_header%& modifier acts immediately as it is encountered during the
31792 processing of an ACL. Notice the difference between these two cases:
31793 .display
31794 &`accept remove_header = X-Internal`&
31795 &`       `&<&'some condition'&>
31796
31797 &`accept `&<&'some condition'&>
31798 &`       remove_header = X-Internal`&
31799 .endd
31800 In the first case, the header line is always removed, whether or not the
31801 condition is true. In the second case, the header line is removed only if the
31802 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31803 same ACL statement. All those that are encountered before a condition fails
31804 are honoured.
31805
31806 &*Warning*&: This facility currently applies only to header lines that are
31807 present during ACL processing. It does NOT remove header lines that are added
31808 in a system filter or in a router or transport.
31809
31810
31811
31812
31813 .section "ACL conditions" "SECTaclconditions"
31814 .cindex "&ACL;" "conditions; list of"
31815 Some of the conditions listed in this section are available only when Exim is
31816 compiled with the content-scanning extension. They are included here briefly
31817 for completeness. More detailed descriptions can be found in the discussion on
31818 content scanning in chapter &<<CHAPexiscan>>&.
31819
31820 Not all conditions are relevant in all circumstances. For example, testing
31821 senders and recipients does not make sense in an ACL that is being run as the
31822 result of the arrival of an ETRN command, and checks on message headers can be
31823 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31824 can use the same condition (with different parameters) more than once in the
31825 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31826 The conditions are as follows:
31827
31828
31829 .vlist
31830 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31831 .cindex "&ACL;" "nested"
31832 .cindex "&ACL;" "indirect"
31833 .cindex "&ACL;" "arguments"
31834 .cindex "&%acl%& ACL condition"
31835 The possible values of the argument are the same as for the
31836 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31837 &"accept"& the condition is true; if it returns &"deny"& the condition is
31838 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31839 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31840 condition false. This means that further processing of the &%warn%& verb
31841 ceases, but processing of the ACL continues.
31842
31843 If the argument is a named ACL, up to nine space-separated optional values
31844 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31845 and $acl_narg is set to the count of values.
31846 Previous values of these variables are restored after the call returns.
31847 The name and values are expanded separately.
31848 Note that spaces in complex expansions which are used as arguments
31849 will act as argument separators.
31850
31851 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31852 the connection is dropped. If it returns &"discard"&, the verb must be
31853 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31854 conditions are tested.
31855
31856 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31857 loops. This condition allows you to use different ACLs in different
31858 circumstances. For example, different ACLs can be used to handle RCPT commands
31859 for different local users or different local domains.
31860
31861 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31862 .cindex "&%authenticated%& ACL condition"
31863 .cindex "authentication" "ACL checking"
31864 .cindex "&ACL;" "testing for authentication"
31865 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31866 the name of the authenticator is tested against the list. To test for
31867 authentication by any authenticator, you can set
31868 .code
31869 authenticated = *
31870 .endd
31871
31872 .vitem &*condition&~=&~*&<&'string'&>
31873 .cindex "&%condition%& ACL condition"
31874 .cindex "customizing" "ACL condition"
31875 .cindex "&ACL;" "customized test"
31876 .cindex "&ACL;" "testing, customized"
31877 This feature allows you to make up custom conditions. If the result of
31878 expanding the string is an empty string, the number zero, or one of the strings
31879 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31880 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31881 any other value, some error is assumed to have occurred, and the ACL returns
31882 &"defer"&. However, if the expansion is forced to fail, the condition is
31883 ignored. The effect is to treat it as true, whether it is positive or
31884 negative.
31885
31886 .vitem &*decode&~=&~*&<&'location'&>
31887 .cindex "&%decode%& ACL condition"
31888 This condition is available only when Exim is compiled with the
31889 content-scanning extension, and it is allowed only in the ACL defined by
31890 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31891 If all goes well, the condition is true. It is false only if there are
31892 problems such as a syntax error or a memory shortage. For more details, see
31893 chapter &<<CHAPexiscan>>&.
31894
31895 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31896 .cindex "&%dnslists%& ACL condition"
31897 .cindex "DNS list" "in ACL"
31898 .cindex "black list (DNS)"
31899 .cindex "&ACL;" "testing a DNS list"
31900 This condition checks for entries in DNS black lists. These are also known as
31901 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31902 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31903 different variants of this condition to describe briefly here. See sections
31904 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31905
31906 .vitem &*domains&~=&~*&<&'domain&~list'&>
31907 .cindex "&%domains%& ACL condition"
31908 .cindex "domain" "ACL checking"
31909 .cindex "&ACL;" "testing a recipient domain"
31910 .vindex "&$domain_data$&"
31911 This condition is relevant only after a RCPT command. It checks that the domain
31912 of the recipient address is in the domain list. If percent-hack processing is
31913 enabled, it is done before this test is done. If the check succeeds with a
31914 lookup, the result of the lookup is placed in &$domain_data$& until the next
31915 &%domains%& test.
31916
31917 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31918 use &%domains%& in a DATA ACL.
31919
31920
31921 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31922 .cindex "&%encrypted%& ACL condition"
31923 .cindex "encryption" "checking in an ACL"
31924 .cindex "&ACL;" "testing for encryption"
31925 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31926 name of the cipher suite in use is tested against the list. To test for
31927 encryption without testing for any specific cipher suite(s), set
31928 .code
31929 encrypted = *
31930 .endd
31931
31932
31933 .vitem &*hosts&~=&~*&<&'host&~list'&>
31934 .cindex "&%hosts%& ACL condition"
31935 .cindex "host" "ACL checking"
31936 .cindex "&ACL;" "testing the client host"
31937 This condition tests that the calling host matches the host list. If you have
31938 name lookups or wildcarded host names and IP addresses in the same host list,
31939 you should normally put the IP addresses first. For example, you could have:
31940 .code
31941 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31942 .endd
31943 The lookup in this example uses the host name for its key. This is implied by
31944 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31945 and it wouldn't matter which way round you had these two items.)
31946
31947 The reason for the problem with host names lies in the left-to-right way that
31948 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31949 but when it reaches an item that requires a host name, it fails if it cannot
31950 find a host name to compare with the pattern. If the above list is given in the
31951 opposite order, the &%accept%& statement fails for a host whose name cannot be
31952 found, even if its IP address is 10.9.8.7.
31953
31954 If you really do want to do the name check first, and still recognize the IP
31955 address even if the name lookup fails, you can rewrite the ACL like this:
31956 .code
31957 accept hosts = dbm;/etc/friendly/hosts
31958 accept hosts = 10.9.8.7
31959 .endd
31960 The default action on failing to find the host name is to assume that the host
31961 is not in the list, so the first &%accept%& statement fails. The second
31962 statement can then check the IP address.
31963
31964 .vindex "&$host_data$&"
31965 If a &%hosts%& condition is satisfied by means of a lookup, the result
31966 of the lookup is made available in the &$host_data$& variable. This
31967 allows you, for example, to set up a statement like this:
31968 .code
31969 deny  hosts = net-lsearch;/some/file
31970       message = $host_data
31971 .endd
31972 which gives a custom error message for each denied host.
31973
31974 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31975 .cindex "&%local_parts%& ACL condition"
31976 .cindex "local part" "ACL checking"
31977 .cindex "&ACL;" "testing a local part"
31978 .vindex "&$local_part_data$&"
31979 This condition is relevant only after a RCPT command. It checks that the local
31980 part of the recipient address is in the list. If percent-hack processing is
31981 enabled, it is done before this test. If the check succeeds with a lookup, the
31982 result of the lookup is placed in &$local_part_data$&, which remains set until
31983 the next &%local_parts%& test.
31984
31985 .vitem &*malware&~=&~*&<&'option'&>
31986 .cindex "&%malware%& ACL condition"
31987 .cindex "&ACL;" "virus scanning"
31988 .cindex "&ACL;" "scanning for viruses"
31989 This condition is available only when Exim is compiled with the
31990 content-scanning extension
31991 and only after a DATA command.
31992 It causes the incoming message to be scanned for
31993 viruses. For details, see chapter &<<CHAPexiscan>>&.
31994
31995 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31996 .cindex "&%mime_regex%& ACL condition"
31997 .cindex "&ACL;" "testing by regex matching"
31998 This condition is available only when Exim is compiled with the
31999 content-scanning extension, and it is allowed only in the ACL defined by
32000 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32001 with any of the regular expressions. For details, see chapter
32002 &<<CHAPexiscan>>&.
32003
32004 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32005 .cindex "rate limiting"
32006 This condition can be used to limit the rate at which a user or host submits
32007 messages. Details are given in section &<<SECTratelimiting>>&.
32008
32009 .vitem &*recipients&~=&~*&<&'address&~list'&>
32010 .cindex "&%recipients%& ACL condition"
32011 .cindex "recipient" "ACL checking"
32012 .cindex "&ACL;" "testing a recipient"
32013 This condition is relevant only after a RCPT command. It checks the entire
32014 recipient address against a list of recipients.
32015
32016 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32017 .cindex "&%regex%& ACL condition"
32018 .cindex "&ACL;" "testing by regex matching"
32019 This condition is available only when Exim is compiled with the
32020 content-scanning extension, and is available only in the DATA, MIME, and
32021 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32022 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32023
32024 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32025 .cindex "&%sender_domains%& ACL condition"
32026 .cindex "sender" "ACL checking"
32027 .cindex "&ACL;" "testing a sender domain"
32028 .vindex "&$domain$&"
32029 .vindex "&$sender_address_domain$&"
32030 This condition tests the domain of the sender of the message against the given
32031 domain list. &*Note*&: The domain of the sender address is in
32032 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32033 of this condition. This is an exception to the general rule for testing domain
32034 lists. It is done this way so that, if this condition is used in an ACL for a
32035 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32036 influence the sender checking.
32037
32038 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32039 relaying, because sender addresses are easily, and commonly, forged.
32040
32041 .vitem &*senders&~=&~*&<&'address&~list'&>
32042 .cindex "&%senders%& ACL condition"
32043 .cindex "sender" "ACL checking"
32044 .cindex "&ACL;" "testing a sender"
32045 This condition tests the sender of the message against the given list. To test
32046 for a bounce message, which has an empty sender, set
32047 .code
32048 senders = :
32049 .endd
32050 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32051 relaying, because sender addresses are easily, and commonly, forged.
32052
32053 .vitem &*spam&~=&~*&<&'username'&>
32054 .cindex "&%spam%& ACL condition"
32055 .cindex "&ACL;" "scanning for spam"
32056 This condition is available only when Exim is compiled with the
32057 content-scanning extension. It causes the incoming message to be scanned by
32058 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32059
32060 .vitem &*verify&~=&~certificate*&
32061 .cindex "&%verify%& ACL condition"
32062 .cindex "TLS" "client certificate verification"
32063 .cindex "certificate" "verification of client"
32064 .cindex "&ACL;" "certificate verification"
32065 .cindex "&ACL;" "testing a TLS certificate"
32066 This condition is true in an SMTP session if the session is encrypted, and a
32067 certificate was received from the client, and the certificate was verified. The
32068 server requests a certificate only if the client matches &%tls_verify_hosts%&
32069 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32070
32071 .vitem &*verify&~=&~csa*&
32072 .cindex "CSA verification"
32073 This condition checks whether the sending host (the client) is authorized to
32074 send email. Details of how this works are given in section
32075 &<<SECTverifyCSA>>&.
32076
32077 .vitem &*verify&~=&~header_names_ascii*&
32078 .cindex "&%verify%& ACL condition"
32079 .cindex "&ACL;" "verifying header names only ASCII"
32080 .cindex "header lines" "verifying header names only ASCII"
32081 .cindex "verifying" "header names only ASCII"
32082 This condition is relevant only in an ACL that is run after a message has been
32083 received.
32084 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32085 It checks all header names (not the content) to make sure
32086 there are no non-ASCII characters, also excluding control characters.  The
32087 allowable characters are decimal ASCII values 33 through 126.
32088
32089 Exim itself will handle headers with non-ASCII characters, but it can cause
32090 problems for downstream applications, so this option will allow their
32091 detection and rejection in the DATA ACL's.
32092
32093 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32094 .cindex "&%verify%& ACL condition"
32095 .cindex "&ACL;" "verifying sender in the header"
32096 .cindex "header lines" "verifying the sender in"
32097 .cindex "sender" "verifying in header"
32098 .cindex "verifying" "sender in header"
32099 This condition is relevant only in an ACL that is run after a message has been
32100 received, that is, in an ACL specified by &%acl_smtp_data%& or
32101 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32102 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32103 is loosely thought of as a &"sender"& address (hence the name of the test).
32104 However, an address that appears in one of these headers need not be an address
32105 that accepts bounce messages; only sender addresses in envelopes are required
32106 to accept bounces. Therefore, if you use the callout option on this check, you
32107 might want to arrange for a non-empty address in the MAIL command.
32108
32109 Details of address verification and the options are given later, starting at
32110 section &<<SECTaddressverification>>& (callouts are described in section
32111 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32112 condition to restrict it to bounce messages only:
32113 .code
32114 deny    senders = :
32115        !verify  = header_sender
32116         message = A valid sender header is required for bounces
32117 .endd
32118
32119 .vitem &*verify&~=&~header_syntax*&
32120 .cindex "&%verify%& ACL condition"
32121 .cindex "&ACL;" "verifying header syntax"
32122 .cindex "header lines" "verifying syntax"
32123 .cindex "verifying" "header syntax"
32124 This condition is relevant only in an ACL that is run after a message has been
32125 received, that is, in an ACL specified by &%acl_smtp_data%& or
32126 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32127 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32128 and &'Bcc:'&), returning true if there are no problems.
32129 Unqualified addresses (local parts without domains) are
32130 permitted only in locally generated messages and from hosts that match
32131 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32132 appropriate.
32133
32134 Note that this condition is a syntax check only. However, a common spamming
32135 ploy used to be to send syntactically invalid headers such as
32136 .code
32137 To: @
32138 .endd
32139 and this condition can be used to reject such messages, though they are not as
32140 common as they used to be.
32141
32142 .vitem &*verify&~=&~helo*&
32143 .cindex "&%verify%& ACL condition"
32144 .cindex "&ACL;" "verifying HELO/EHLO"
32145 .cindex "HELO" "verifying"
32146 .cindex "EHLO" "verifying"
32147 .cindex "verifying" "EHLO"
32148 .cindex "verifying" "HELO"
32149 This condition is true if a HELO or EHLO command has been received from the
32150 client host, and its contents have been verified. If there has been no previous
32151 attempt to verify the HELO/EHLO contents, it is carried out when this
32152 condition is encountered. See the description of the &%helo_verify_hosts%& and
32153 &%helo_try_verify_hosts%& options for details of how to request verification
32154 independently of this condition, and for detail of the verification.
32155
32156 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32157 option), this condition is always true.
32158
32159
32160 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32161 .cindex "verifying" "not blind"
32162 .cindex "bcc recipients, verifying none"
32163 This condition checks that there are no blind (bcc) recipients in the message.
32164 Every envelope recipient must appear either in a &'To:'& header line or in a
32165 &'Cc:'& header line for this condition to be true. Local parts are checked
32166 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32167 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32168 used only in a DATA or non-SMTP ACL.
32169
32170 There is one possible option, &`case_insensitive`&.  If this is present then
32171 local parts are checked case-insensitively.
32172
32173 There are, of course, many legitimate messages that make use of blind (bcc)
32174 recipients. This check should not be used on its own for blocking messages.
32175
32176
32177 .vitem &*verify&~=&~recipient/*&<&'options'&>
32178 .cindex "&%verify%& ACL condition"
32179 .cindex "&ACL;" "verifying recipient"
32180 .cindex "recipient" "verifying"
32181 .cindex "verifying" "recipient"
32182 .vindex "&$address_data$&"
32183 This condition is relevant only after a RCPT command. It verifies the current
32184 recipient. Details of address verification are given later, starting at section
32185 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32186 of &$address_data$& is the last value that was set while routing the address.
32187 This applies even if the verification fails. When an address that is being
32188 verified is redirected to a single address, verification continues with the new
32189 address, and in that case, the subsequent value of &$address_data$& is the
32190 value for the child address.
32191
32192 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32193 .cindex "&%verify%& ACL condition"
32194 .cindex "&ACL;" "verifying host reverse lookup"
32195 .cindex "host" "verifying reverse lookup"
32196 This condition ensures that a verified host name has been looked up from the IP
32197 address of the client host. (This may have happened already if the host name
32198 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32199 Verification ensures that the host name obtained from a reverse DNS lookup, or
32200 one of its aliases, does, when it is itself looked up in the DNS, yield the
32201 original IP address.
32202
32203 There is one possible option, &`defer_ok`&.  If this is present and a
32204 DNS operation returns a temporary error, the verify condition succeeds.
32205
32206 If this condition is used for a locally generated message (that is, when there
32207 is no client host involved), it always succeeds.
32208
32209 .vitem &*verify&~=&~sender/*&<&'options'&>
32210 .cindex "&%verify%& ACL condition"
32211 .cindex "&ACL;" "verifying sender"
32212 .cindex "sender" "verifying"
32213 .cindex "verifying" "sender"
32214 This condition is relevant only after a MAIL or RCPT command, or after a
32215 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32216 the message's sender is empty (that is, this is a bounce message), the
32217 condition is true. Otherwise, the sender address is verified.
32218
32219 .vindex "&$address_data$&"
32220 .vindex "&$sender_address_data$&"
32221 If there is data in the &$address_data$& variable at the end of routing, its
32222 value is placed in &$sender_address_data$& at the end of verification. This
32223 value can be used in subsequent conditions and modifiers in the same ACL
32224 statement. It does not persist after the end of the current statement. If you
32225 want to preserve the value for longer, you can save it in an ACL variable.
32226
32227 Details of verification are given later, starting at section
32228 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32229 to avoid doing it more than once per message.
32230
32231 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32232 .cindex "&%verify%& ACL condition"
32233 This is a variation of the previous option, in which a modified address is
32234 verified as a sender.
32235
32236 Note that '/' is legal in local-parts; if the address may have such
32237 (eg. is generated from the received message)
32238 they must be protected from the options parsing by doubling:
32239 .code
32240 verify = sender=${listquote{/}{${address:$h_sender:}}}
32241 .endd
32242 .endlist
32243
32244
32245
32246 .section "Using DNS lists" "SECTmorednslists"
32247 .cindex "DNS list" "in ACL"
32248 .cindex "black list (DNS)"
32249 .cindex "&ACL;" "testing a DNS list"
32250 In its simplest form, the &%dnslists%& condition tests whether the calling host
32251 is on at least one of a number of DNS lists by looking up the inverted IP
32252 address in one or more DNS domains. (Note that DNS list domains are not mail
32253 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32254 special options instead.) For example, if the calling host's IP
32255 address is 192.168.62.43, and the ACL statement is
32256 .code
32257 deny dnslists = blackholes.mail-abuse.org : \
32258                 dialups.mail-abuse.org
32259 .endd
32260 the following records are looked up:
32261 .code
32262 43.62.168.192.blackholes.mail-abuse.org
32263 43.62.168.192.dialups.mail-abuse.org
32264 .endd
32265 As soon as Exim finds an existing DNS record, processing of the list stops.
32266 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32267 to test that a host is on more than one list (an &"and"& conjunction), you can
32268 use two separate conditions:
32269 .code
32270 deny dnslists = blackholes.mail-abuse.org
32271      dnslists = dialups.mail-abuse.org
32272 .endd
32273 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32274 behaves as if the host does not match the list item, that is, as if the DNS
32275 record does not exist. If there are further items in the DNS list, they are
32276 processed.
32277
32278 This is usually the required action when &%dnslists%& is used with &%deny%&
32279 (which is the most common usage), because it prevents a DNS failure from
32280 blocking mail. However, you can change this behaviour by putting one of the
32281 following special items in the list:
32282 .display
32283 &`+include_unknown `&   behave as if the item is on the list
32284 &`+exclude_unknown `&   behave as if the item is not on the list (default)
32285 &`+defer_unknown   `&   give a temporary error
32286 .endd
32287 .cindex "&`+include_unknown`&"
32288 .cindex "&`+exclude_unknown`&"
32289 .cindex "&`+defer_unknown`&"
32290 Each of these applies to any subsequent items on the list. For example:
32291 .code
32292 deny dnslists = +defer_unknown : foo.bar.example
32293 .endd
32294 Testing the list of domains stops as soon as a match is found. If you want to
32295 warn for one list and block for another, you can use two different statements:
32296 .code
32297 deny  dnslists = blackholes.mail-abuse.org
32298 warn  dnslists = dialups.mail-abuse.org
32299       message  = X-Warn: sending host is on dialups list
32300 .endd
32301 .cindex caching "of dns lookup"
32302 .cindex DNS TTL
32303 DNS list lookups are cached by Exim for the duration of the SMTP session
32304 (but limited by the DNS return TTL value),
32305 so a lookup based on the IP address is done at most once for any incoming
32306 connection (assuming long-enough TTL).
32307 Exim does not share information between multiple incoming
32308 connections (but your local name server cache should be active).
32309
32310 There are a number of DNS lists to choose from, some commercial, some free,
32311 or free for small deployments.  An overview can be found at
32312 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32313
32314
32315
32316 .section "Specifying the IP address for a DNS list lookup" "SECID201"
32317 .cindex "DNS list" "keyed by explicit IP address"
32318 By default, the IP address that is used in a DNS list lookup is the IP address
32319 of the calling host. However, you can specify another IP address by listing it
32320 after the domain name, introduced by a slash. For example:
32321 .code
32322 deny dnslists = black.list.tld/192.168.1.2
32323 .endd
32324 This feature is not very helpful with explicit IP addresses; it is intended for
32325 use with IP addresses that are looked up, for example, the IP addresses of the
32326 MX hosts or nameservers of an email sender address. For an example, see section
32327 &<<SECTmulkeyfor>>& below.
32328
32329
32330
32331
32332 .section "DNS lists keyed on domain names" "SECID202"
32333 .cindex "DNS list" "keyed by domain name"
32334 There are some lists that are keyed on domain names rather than inverted IP
32335 addresses (see, e.g., the &'domain based zones'& link at
32336 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32337 with these lists. You can change the name that is looked up in a DNS list by
32338 listing it after the domain name, introduced by a slash. For example,
32339 .code
32340 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32341       message  = Sender's domain is listed at $dnslist_domain
32342 .endd
32343 This particular example is useful only in ACLs that are obeyed after the
32344 RCPT or DATA commands, when a sender address is available. If (for
32345 example) the message's sender is &'user@tld.example'& the name that is looked
32346 up by this example is
32347 .code
32348 tld.example.dsn.rfc-ignorant.org
32349 .endd
32350 A single &%dnslists%& condition can contain entries for both names and IP
32351 addresses. For example:
32352 .code
32353 deny dnslists = sbl.spamhaus.org : \
32354                 dsn.rfc-ignorant.org/$sender_address_domain
32355 .endd
32356 The first item checks the sending host's IP address; the second checks a domain
32357 name. The whole condition is true if either of the DNS lookups succeeds.
32358
32359
32360
32361
32362 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
32363 .cindex "DNS list" "multiple keys for"
32364 The syntax described above for looking up explicitly-defined values (either
32365 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32366 name for the DNS list, what follows the slash can in fact be a list of items.
32367 As with all lists in Exim, the default separator is a colon. However, because
32368 this is a sublist within the list of DNS blacklist domains, it is necessary
32369 either to double the separators like this:
32370 .code
32371 dnslists = black.list.tld/name.1::name.2
32372 .endd
32373 or to change the separator character, like this:
32374 .code
32375 dnslists = black.list.tld/<;name.1;name.2
32376 .endd
32377 If an item in the list is an IP address, it is inverted before the DNS
32378 blacklist domain is appended. If it is not an IP address, no inversion
32379 occurs. Consider this condition:
32380 .code
32381 dnslists = black.list.tld/<;192.168.1.2;a.domain
32382 .endd
32383 The DNS lookups that occur are:
32384 .code
32385 2.1.168.192.black.list.tld
32386 a.domain.black.list.tld
32387 .endd
32388 Once a DNS record has been found (that matches a specific IP return
32389 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32390 are done. If there is a temporary DNS error, the rest of the sublist of domains
32391 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32392 only if no other DNS lookup in this sublist succeeds. In other words, a
32393 successful lookup for any of the items in the sublist overrides a temporary
32394 error for a previous item.
32395
32396 The ability to supply a list of items after the slash is in some sense just a
32397 syntactic convenience. These two examples have the same effect:
32398 .code
32399 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32400 dnslists = black.list.tld/a.domain::b.domain
32401 .endd
32402 However, when the data for the list is obtained from a lookup, the second form
32403 is usually much more convenient. Consider this example:
32404 .code
32405 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32406                                    ${lookup dnsdb {>|mxh=\
32407                                    $sender_address_domain} }} }
32408      message  = The mail servers for the domain \
32409                 $sender_address_domain \
32410                 are listed at $dnslist_domain ($dnslist_value); \
32411                 see $dnslist_text.
32412 .endd
32413 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32414 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32415 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32416 of expanding the condition might be something like this:
32417 .code
32418 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32419 .endd
32420 Thus, this example checks whether or not the IP addresses of the sender
32421 domain's mail servers are on the Spamhaus black list.
32422
32423 The key that was used for a successful DNS list lookup is put into the variable
32424 &$dnslist_matched$& (see section &<<SECID204>>&).
32425
32426
32427
32428
32429 .section "Data returned by DNS lists" "SECID203"
32430 .cindex "DNS list" "data returned from"
32431 DNS lists are constructed using address records in the DNS. The original RBL
32432 just used the address 127.0.0.1 on the right hand side of each record, but the
32433 RBL+ list and some other lists use a number of values with different meanings.
32434 The values used on the RBL+ list are:
32435 .display
32436 127.1.0.1  RBL
32437 127.1.0.2  DUL
32438 127.1.0.3  DUL and RBL
32439 127.1.0.4  RSS
32440 127.1.0.5  RSS and RBL
32441 127.1.0.6  RSS and DUL
32442 127.1.0.7  RSS and DUL and RBL
32443 .endd
32444 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32445 different values. Some DNS lists may return more than one address record;
32446 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32447
32448
32449 .section "Variables set from DNS lists" "SECID204"
32450 .cindex "expansion" "variables, set from DNS list"
32451 .cindex "DNS list" "variables set from"
32452 .vindex "&$dnslist_domain$&"
32453 .vindex "&$dnslist_matched$&"
32454 .vindex "&$dnslist_text$&"
32455 .vindex "&$dnslist_value$&"
32456 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32457 the name of the overall domain that matched (for example,
32458 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32459 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32460 the DNS record. When the key is an IP address, it is not reversed in
32461 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32462 cases, for example:
32463 .code
32464 deny dnslists = spamhaus.example
32465 .endd
32466 the key is also available in another variable (in this case,
32467 &$sender_host_address$&). In more complicated cases, however, this is not true.
32468 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32469 might generate a dnslists lookup like this:
32470 .code
32471 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32472 .endd
32473 If this condition succeeds, the value in &$dnslist_matched$& might be
32474 &`192.168.6.7`& (for example).
32475
32476 If more than one address record is returned by the DNS lookup, all the IP
32477 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32478 The variable &$dnslist_text$& contains the contents of any associated TXT
32479 record. For lists such as RBL+ the TXT record for a merged entry is often not
32480 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32481 information.
32482
32483 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32484 &-- even if these appear before the condition in the ACL, they are not
32485 expanded until after it has failed. For example:
32486 .code
32487 deny    hosts = !+local_networks
32488         message = $sender_host_address is listed \
32489                   at $dnslist_domain
32490         dnslists = rbl-plus.mail-abuse.example
32491 .endd
32492
32493
32494
32495 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
32496 .cindex "DNS list" "matching specific returned data"
32497 You can add an equals sign and an IP address after a &%dnslists%& domain name
32498 in order to restrict its action to DNS records with a matching right hand side.
32499 For example,
32500 .code
32501 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32502 .endd
32503 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32504 any address record is considered to be a match. For the moment, we assume
32505 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32506 describes how multiple records are handled.
32507
32508 More than one IP address may be given for checking, using a comma as a
32509 separator. These are alternatives &-- if any one of them matches, the
32510 &%dnslists%& condition is true. For example:
32511 .code
32512 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32513 .endd
32514 If you want to specify a constraining address list and also specify names or IP
32515 addresses to be looked up, the constraining address list must be specified
32516 first. For example:
32517 .code
32518 deny dnslists = dsn.rfc-ignorant.org\
32519                 =127.0.0.2/$sender_address_domain
32520 .endd
32521
32522 If the character &`&&`& is used instead of &`=`&, the comparison for each
32523 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32524 In other words, the listed addresses are used as bit masks. The comparison is
32525 true if all the bits in the mask are present in the address that is being
32526 tested. For example:
32527 .code
32528 dnslists = a.b.c&0.0.0.3
32529 .endd
32530 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32531 want to test whether one bit or another bit is present (as opposed to both
32532 being present), you must use multiple values. For example:
32533 .code
32534 dnslists = a.b.c&0.0.0.1,0.0.0.2
32535 .endd
32536 matches if the final component of the address is an odd number or two times
32537 an odd number.
32538
32539
32540
32541 .section "Negated DNS matching conditions" "SECID205"
32542 You can supply a negative list of IP addresses as part of a &%dnslists%&
32543 condition. Whereas
32544 .code
32545 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32546 .endd
32547 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32548 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32549 .code
32550 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32551 .endd
32552 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32553 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32554 words, the result of the test is inverted if an exclamation mark appears before
32555 the &`=`& (or the &`&&`&) sign.
32556
32557 &*Note*&: This kind of negation is not the same as negation in a domain,
32558 host, or address list (which is why the syntax is different).
32559
32560 If you are using just one list, the negation syntax does not gain you much. The
32561 previous example is precisely equivalent to
32562 .code
32563 deny  dnslists = a.b.c
32564      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32565 .endd
32566 However, if you are using multiple lists, the negation syntax is clearer.
32567 Consider this example:
32568 .code
32569 deny  dnslists = sbl.spamhaus.org : \
32570                  list.dsbl.org : \
32571                  dnsbl.njabl.org!=127.0.0.3 : \
32572                  relays.ordb.org
32573 .endd
32574 Using only positive lists, this would have to be:
32575 .code
32576 deny  dnslists = sbl.spamhaus.org : \
32577                  list.dsbl.org
32578 deny  dnslists = dnsbl.njabl.org
32579      !dnslists = dnsbl.njabl.org=127.0.0.3
32580 deny  dnslists = relays.ordb.org
32581 .endd
32582 which is less clear, and harder to maintain.
32583
32584
32585
32586
32587 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32588 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32589 thereby providing more than one IP address. When an item in a &%dnslists%& list
32590 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32591 the match to specific results from the DNS lookup, there are two ways in which
32592 the checking can be handled. For example, consider the condition:
32593 .code
32594 dnslists = a.b.c=127.0.0.1
32595 .endd
32596 What happens if the DNS lookup for the incoming IP address yields both
32597 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32598 condition true because at least one given value was found, or is it false
32599 because at least one of the found values was not listed? And how does this
32600 affect negated conditions? Both possibilities are provided for with the help of
32601 additional separators &`==`& and &`=&&`&.
32602
32603 .ilist
32604 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32605 IP addresses matches one of the listed addresses. For the example above, the
32606 condition is true because 127.0.0.1 matches.
32607 .next
32608 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32609 looked up IP addresses matches one of the listed addresses. If the condition is
32610 changed to:
32611 .code
32612 dnslists = a.b.c==127.0.0.1
32613 .endd
32614 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32615 false because 127.0.0.2 is not listed. You would need to have:
32616 .code
32617 dnslists = a.b.c==127.0.0.1,127.0.0.2
32618 .endd
32619 for the condition to be true.
32620 .endlist
32621
32622 When &`!`& is used to negate IP address matching, it inverts the result, giving
32623 the precise opposite of the behaviour above. Thus:
32624 .ilist
32625 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32626 addresses matches one of the listed addresses. Consider:
32627 .code
32628 dnslists = a.b.c!&0.0.0.1
32629 .endd
32630 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32631 false because 127.0.0.1 matches.
32632 .next
32633 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32634 looked up IP address that does not match. Consider:
32635 .code
32636 dnslists = a.b.c!=&0.0.0.1
32637 .endd
32638 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32639 true, because 127.0.0.2 does not match. You would need to have:
32640 .code
32641 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32642 .endd
32643 for the condition to be false.
32644 .endlist
32645 When the DNS lookup yields only a single IP address, there is no difference
32646 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32647
32648
32649
32650
32651 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32652 .cindex "DNS list" "information from merged"
32653 When the facility for restricting the matching IP values in a DNS list is used,
32654 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32655 the true reason for rejection. This happens when lists are merged and the IP
32656 address in the A record is used to distinguish them; unfortunately there is
32657 only one TXT record. One way round this is not to use merged lists, but that
32658 can be inefficient because it requires multiple DNS lookups where one would do
32659 in the vast majority of cases when the host of interest is not on any of the
32660 lists.
32661
32662 A less inefficient way of solving this problem is available. If
32663 two domain names, comma-separated, are given, the second is used first to
32664 do an initial check, making use of any IP value restrictions that are set.
32665 If there is a match, the first domain is used, without any IP value
32666 restrictions, to get the TXT record. As a byproduct of this, there is also
32667 a check that the IP being tested is indeed on the first list. The first
32668 domain is the one that is put in &$dnslist_domain$&. For example:
32669 .code
32670 deny   dnslists = \
32671          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32672          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32673        message  = \
32674          rejected because $sender_host_address is blacklisted \
32675          at $dnslist_domain\n$dnslist_text
32676 .endd
32677 For the first blacklist item, this starts by doing a lookup in
32678 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32679 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32680 value, and as long as something is found, it looks for the corresponding TXT
32681 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32682 The second blacklist item is processed similarly.
32683
32684 If you are interested in more than one merged list, the same list must be
32685 given several times, but because the results of the DNS lookups are cached,
32686 the DNS calls themselves are not repeated. For example:
32687 .code
32688 deny dnslists = \
32689          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32690          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32691          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32692          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32693 .endd
32694 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32695 values matches (or if no record is found), this is the only lookup that is
32696 done. Only if there is a match is one of the more specific lists consulted.
32697
32698
32699
32700 .section "DNS lists and IPv6" "SECTmorednslistslast"
32701 .cindex "IPv6" "DNS black lists"
32702 .cindex "DNS list" "IPv6 usage"
32703 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32704 nibble by nibble. For example, if the calling host's IP address is
32705 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32706 .code
32707 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32708   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32709 .endd
32710 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32711 lists contain wildcard records, intended for IPv4, that interact badly with
32712 IPv6. For example, the DNS entry
32713 .code
32714 *.3.some.list.example.    A    127.0.0.1
32715 .endd
32716 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32717 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32718
32719 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32720 &%condition%& condition, as in this example:
32721 .code
32722 deny   condition = ${if isip4{$sender_host_address}}
32723        dnslists  = some.list.example
32724 .endd
32725
32726 If an explicit key is being used for a DNS lookup and it may be an IPv6
32727 address you should specify alternate list separators for both the outer
32728 (DNS list name) list and inner (lookup keys) list:
32729 .code
32730        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32731 .endd
32732
32733 .section "Rate limiting incoming messages" "SECTratelimiting"
32734 .cindex "rate limiting" "client sending"
32735 .cindex "limiting client sending rates"
32736 .oindex "&%smtp_ratelimit_*%&"
32737 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32738 which clients can send email. This is more powerful than the
32739 &%smtp_ratelimit_*%& options, because those options control the rate of
32740 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32741 works across all connections (concurrent and sequential) from the same client
32742 host. The syntax of the &%ratelimit%& condition is:
32743 .display
32744 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32745 .endd
32746 If the average client sending rate is less than &'m'& messages per time
32747 period &'p'& then the condition is false; otherwise it is true.
32748
32749 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32750 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32751 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32752 of &'p'&.
32753
32754 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32755 time interval, for example, &`8h`& for eight hours. A larger time constant
32756 means that it takes Exim longer to forget a client's past behaviour. The
32757 parameter &'m'& is the maximum number of messages that a client is permitted to
32758 send in each time interval. It also specifies the number of messages permitted
32759 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32760 constant, you can allow a client to send more messages in a burst without
32761 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32762 both small, messages must be sent at an even rate.
32763
32764 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32765 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32766 when deploying the &%ratelimit%& ACL condition. The script prints usage
32767 instructions when it is run with no arguments.
32768
32769 The key is used to look up the data for calculating the client's average
32770 sending rate. This data is stored in Exim's spool directory, alongside the
32771 retry and other hints databases. The default key is &$sender_host_address$&,
32772 which means Exim computes the sending rate of each client host IP address.
32773 By changing the key you can change how Exim identifies clients for the purpose
32774 of ratelimiting. For example, to limit the sending rate of each authenticated
32775 user, independent of the computer they are sending from, set the key to
32776 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32777 example, &$authenticated_id$& is only meaningful if the client has
32778 authenticated (which you can check with the &%authenticated%& ACL condition).
32779
32780 The lookup key does not have to identify clients: If you want to limit the
32781 rate at which a recipient receives messages, you can use the key
32782 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32783 ACL.
32784
32785 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32786 specifies what Exim measures the rate of, for example, messages or recipients
32787 or bytes. You can adjust the measurement using the &%unique=%& and/or
32788 &%count=%& options. You can also control when Exim updates the recorded rate
32789 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32790 separated by a slash, like the other parameters. They may appear in any order.
32791
32792 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32793 any options that alter the meaning of the stored data. The limit &'m'& is not
32794 stored, so you can alter the configured maximum rate and Exim will still
32795 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32796 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32797 behaviour. The lookup key is not affected by changes to the update mode and
32798 the &%count=%& option.
32799
32800
32801 .section "Ratelimit options for what is being measured" "ratoptmea"
32802 .cindex "rate limiting" "per_* options"
32803 The &%per_conn%& option limits the client's connection rate. It is not
32804 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32805 &%acl_not_smtp_start%& ACLs.
32806
32807 The &%per_mail%& option limits the client's rate of sending messages. This is
32808 the default if none of the &%per_*%& options is specified. It can be used in
32809 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32810 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32811
32812 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32813 the same ACLs as the &%per_mail%& option, though it is best to use this option
32814 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32815 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32816 in its MAIL command, which may be inaccurate or completely missing. You can
32817 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32818 in kilobytes, megabytes, or gigabytes, respectively.
32819
32820 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32821 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32822 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
32823 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32824 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32825 in either case the rate limiting engine will see a message with many
32826 recipients as a large high-speed burst.
32827
32828 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32829 number of different recipients that the client has sent messages to in the
32830 last time period. That is, if the client repeatedly sends messages to the same
32831 recipient, its measured rate is not increased. This option can only be used in
32832 &%acl_smtp_rcpt%&.
32833
32834 The &%per_cmd%& option causes Exim to recompute the rate every time the
32835 condition is processed. This can be used to limit the rate of any SMTP
32836 command. If it is used in multiple ACLs it can limit the aggregate rate of
32837 multiple different commands.
32838
32839 The &%count=%& option can be used to alter how much Exim adds to the client's
32840 measured rate. For example, the &%per_byte%& option is equivalent to
32841 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32842 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32843 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32844
32845 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32846
32847
32848 .section "Ratelimit update modes" "ratoptupd"
32849 .cindex "rate limiting" "reading data without updating"
32850 You can specify one of three options with the &%ratelimit%& condition to
32851 control when its database is updated. This section describes the &%readonly%&
32852 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32853
32854 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32855 previously-computed rate to check against the limit.
32856
32857 For example, you can test the client's sending rate and deny it access (when
32858 it is too fast) in the connect ACL. If the client passes this check then it
32859 can go on to send a message, in which case its recorded rate will be updated
32860 in the MAIL ACL. Subsequent connections from the same client will check this
32861 new rate.
32862 .code
32863 acl_check_connect:
32864  deny ratelimit = 100 / 5m / readonly
32865       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32866                   (max $sender_rate_limit)
32867 # ...
32868 acl_check_mail:
32869  warn ratelimit = 100 / 5m / strict
32870       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32871                   (max $sender_rate_limit)
32872 .endd
32873
32874 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32875 processing a message then it may increase the client's measured rate more than
32876 it should. For example, this will happen if you check the &%per_rcpt%& option
32877 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32878 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32879 multiple update problems by using the &%readonly%& option on later ratelimit
32880 checks.
32881
32882 The &%per_*%& options described above do not make sense in some ACLs. If you
32883 use a &%per_*%& option in an ACL where it is not normally permitted then the
32884 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32885 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32886 next section) so you must specify the &%readonly%& option explicitly.
32887
32888
32889 .section "Ratelimit options for handling fast clients" "ratoptfast"
32890 .cindex "rate limiting" "strict and leaky modes"
32891 If a client's average rate is greater than the maximum, the rate limiting
32892 engine can react in two possible ways, depending on the presence of the
32893 &%strict%& or &%leaky%& update modes. This is independent of the other
32894 counter-measures (such as rejecting the message) that may be specified by the
32895 rest of the ACL.
32896
32897 The &%leaky%& (default) option means that the client's recorded rate is not
32898 updated if it is above the limit. The effect of this is that Exim measures the
32899 client's average rate of successfully sent email,
32900 up to the given limit.
32901 This is appropriate if the countermeasure when the condition is true
32902 consists of refusing the message, and
32903 is generally the better choice if you have clients that retry automatically.
32904 If the action when true is anything more complex then this option is
32905 likely not what is wanted.
32906
32907 The &%strict%& option means that the client's recorded rate is always
32908 updated. The effect of this is that Exim measures the client's average rate
32909 of attempts to send email, which can be much higher than the maximum it is
32910 actually allowed. If the client is over the limit it may be subjected to
32911 counter-measures by the ACL. It must slow down and allow sufficient time to
32912 pass that its computed rate falls below the maximum before it can send email
32913 again. The time (the number of smoothing periods) it must wait and not
32914 attempt to send mail can be calculated with this formula:
32915 .code
32916         ln(peakrate/maxrate)
32917 .endd
32918
32919
32920 .section "Limiting the rate of different events" "ratoptuniq"
32921 .cindex "rate limiting" "counting unique events"
32922 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32923 rate of different events. For example, the &%per_addr%& option uses this
32924 mechanism to count the number of different recipients that the client has
32925 sent messages to in the last time period; it is equivalent to
32926 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32927 measure the rate that a client uses different sender addresses with the
32928 options &`per_mail/unique=$sender_address`&.
32929
32930 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32931 has seen for that key. The whole set is thrown away when it is older than the
32932 rate smoothing period &'p'&, so each different event is counted at most once
32933 per period. In the &%leaky%& update mode, an event that causes the client to
32934 go over the limit is not added to the set, in the same way that the client's
32935 recorded rate is not updated in the same situation.
32936
32937 When you combine the &%unique=%& and &%readonly%& options, the specific
32938 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32939 rate.
32940
32941 The &%unique=%& mechanism needs more space in the ratelimit database than the
32942 other &%ratelimit%& options in order to store the event set. The number of
32943 unique values is potentially as large as the rate limit, so the extra space
32944 required increases with larger limits.
32945
32946 The uniqueification is not perfect: there is a small probability that Exim
32947 will think a new event has happened before. If the sender's rate is less than
32948 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32949 the measured rate can go above the limit, in which case Exim may under-count
32950 events by a significant margin. Fortunately, if the rate is high enough (2.7
32951 times the limit) that the false positive rate goes above 9%, then Exim will
32952 throw away the over-full event set before the measured rate falls below the
32953 limit. Therefore the only harm should be that exceptionally high sending rates
32954 are logged incorrectly; any countermeasures you configure will be as effective
32955 as intended.
32956
32957
32958 .section "Using rate limiting" "useratlim"
32959 Exim's other ACL facilities are used to define what counter-measures are taken
32960 when the rate limit is exceeded. This might be anything from logging a warning
32961 (for example, while measuring existing sending rates in order to define
32962 policy), through time delays to slow down fast senders, up to rejecting the
32963 message. For example:
32964 .code
32965 # Log all senders' rates
32966 warn ratelimit = 0 / 1h / strict
32967      log_message = Sender rate $sender_rate / $sender_rate_period
32968
32969 # Slow down fast senders; note the need to truncate $sender_rate
32970 # at the decimal point.
32971 warn ratelimit = 100 / 1h / per_rcpt / strict
32972      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32973                    $sender_rate_limit }s
32974
32975 # Keep authenticated users under control
32976 deny authenticated = *
32977      ratelimit = 100 / 1d / strict / $authenticated_id
32978
32979 # System-wide rate limit
32980 defer ratelimit = 10 / 1s / $primary_hostname
32981       message = Sorry, too busy. Try again later.
32982
32983 # Restrict incoming rate from each host, with a default
32984 # set using a macro and special cases looked up in a table.
32985 defer ratelimit = ${lookup {$sender_host_address} \
32986                    cdb {DB/ratelimits.cdb} \
32987                    {$value} {RATELIMIT} }
32988       message = Sender rate exceeds $sender_rate_limit \
32989                messages per $sender_rate_period
32990 .endd
32991 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32992 especially with the &%per_rcpt%& option, you may suffer from a performance
32993 bottleneck caused by locking on the ratelimit hints database. Apart from
32994 making your ACLs less complicated, you can reduce the problem by using a
32995 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32996 this means that Exim will lose its hints data after a reboot (including retry
32997 hints, the callout cache, and ratelimit data).
32998
32999
33000
33001 .section "Address verification" "SECTaddressverification"
33002 .cindex "verifying address" "options for"
33003 .cindex "policy control" "address verification"
33004 Several of the &%verify%& conditions described in section
33005 &<<SECTaclconditions>>& cause addresses to be verified. Section
33006 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33007 The verification conditions can be followed by options that modify the
33008 verification process. The options are separated from the keyword and from each
33009 other by slashes, and some of them contain parameters. For example:
33010 .code
33011 verify = sender/callout
33012 verify = recipient/defer_ok/callout=10s,defer_ok
33013 .endd
33014 The first stage of address verification, which always happens, is to run the
33015 address through the routers, in &"verify mode"&. Routers can detect the
33016 difference between verification and routing for delivery, and their actions can
33017 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33018 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33019 The available options are as follows:
33020
33021 .ilist
33022 If the &%callout%& option is specified, successful routing to one or more
33023 remote hosts is followed by a &"callout"& to those hosts as an additional
33024 check. Callouts and their sub-options are discussed in the next section.
33025 .next
33026 If there is a defer error while doing verification routing, the ACL
33027 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33028 options, the condition is forced to be true instead. Note that this is a main
33029 verification option as well as a suboption for callouts.
33030 .next
33031 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33032 discusses the reporting of sender address verification failures.
33033 .next
33034 The &%success_on_redirect%& option causes verification always to succeed
33035 immediately after a successful redirection. By default, if a redirection
33036 generates just one address, that address is also verified. See further
33037 discussion in section &<<SECTredirwhilveri>>&.
33038 .new
33039 .next
33040 If the &%quota%& option is specified for recipient verify,
33041 successful routing to an appendfile transport is followed by a call into
33042 the transport to evaluate the quota status for the recipient.
33043 No actual delivery is done, but verification will succeed if the quota
33044 is sufficient for the message (if the sender gave a message size) or
33045 not already exceeded (otherwise).
33046 .wen
33047 .endlist
33048
33049 .cindex "verifying address" "differentiating failures"
33050 .vindex "&$recipient_verify_failure$&"
33051 .vindex "&$sender_verify_failure$&"
33052 .vindex "&$acl_verify_message$&"
33053 After an address verification failure, &$acl_verify_message$& contains the
33054 error message that is associated with the failure. It can be preserved by
33055 coding like this:
33056 .code
33057 warn  !verify = sender
33058        set acl_m0 = $acl_verify_message
33059 .endd
33060 If you are writing your own custom rejection message or log message when
33061 denying access, you can use this variable to include information about the
33062 verification failure.
33063
33064 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33065 appropriate) contains one of the following words:
33066
33067 .ilist
33068 &%qualify%&: The address was unqualified (no domain), and the message
33069 was neither local nor came from an exempted host.
33070 .next
33071 &%route%&: Routing failed.
33072 .next
33073 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33074 occurred at or before the MAIL command (that is, on initial
33075 connection, HELO, or MAIL).
33076 .next
33077 &%recipient%&: The RCPT command in a callout was rejected.
33078 .next
33079 &%postmaster%&: The postmaster check in a callout was rejected.
33080 .new
33081 .next
33082 &%quota%&: The quota check for a local recipient did non pass.
33083 .endlist
33084
33085 The main use of these variables is expected to be to distinguish between
33086 rejections of MAIL and rejections of RCPT in callouts.
33087
33088 The above variables may also be set after a &*successful*&
33089 address verification to:
33090
33091 .ilist
33092 &%random%&: A random local-part callout succeeded
33093 .endlist
33094
33095
33096
33097
33098 .section "Callout verification" "SECTcallver"
33099 .cindex "verifying address" "by callout"
33100 .cindex "callout" "verification"
33101 .cindex "SMTP" "callout verification"
33102 For non-local addresses, routing verifies the domain, but is unable to do any
33103 checking of the local part. There are situations where some means of verifying
33104 the local part is desirable. One way this can be done is to make an SMTP
33105 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33106 a subsequent host for a recipient address, to see if the host accepts the
33107 address. We use the term &'callout'& to cover both cases. Note that for a
33108 sender address, the callback is not to the client host that is trying to
33109 deliver the message, but to one of the hosts that accepts incoming mail for the
33110 sender's domain.
33111
33112 Exim does not do callouts by default. If you want them to happen, you must
33113 request them by setting appropriate options on the &%verify%& condition, as
33114 described below. This facility should be used with care, because it can add a
33115 lot of resource usage to the cost of verifying an address. However, Exim does
33116 cache the results of callouts, which helps to reduce the cost. Details of
33117 caching are in section &<<SECTcallvercache>>&.
33118
33119 Recipient callouts are usually used only between hosts that are controlled by
33120 the same administration. For example, a corporate gateway host could use
33121 callouts to check for valid recipients on an internal mailserver. A successful
33122 callout does not guarantee that a real delivery to the address would succeed;
33123 on the other hand, a failing callout does guarantee that a delivery would fail.
33124
33125 If the &%callout%& option is present on a condition that verifies an address, a
33126 second stage of verification occurs if the address is successfully routed to
33127 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33128 &(manualroute)& router, where the router specifies the hosts. However, if a
33129 router that does not set up hosts routes to an &(smtp)& transport with a
33130 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33131 &%hosts_override%& set, its hosts are always used, whether or not the router
33132 supplies a host list.
33133 Callouts are only supported on &(smtp)& transports.
33134
33135 The port that is used is taken from the transport, if it is specified and is a
33136 remote transport. (For routers that do verification only, no transport need be
33137 specified.) Otherwise, the default SMTP port is used. If a remote transport
33138 specifies an outgoing interface, this is used; otherwise the interface is not
33139 specified. Likewise, the text that is used for the HELO command is taken from
33140 the transport's &%helo_data%& option; if there is no transport, the value of
33141 &$smtp_active_hostname$& is used.
33142
33143 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33144 test whether a bounce message could be delivered to the sender address. The
33145 following SMTP commands are sent:
33146 .display
33147 &`HELO `&<&'local host name'&>
33148 &`MAIL FROM:<>`&
33149 &`RCPT TO:`&<&'the address to be tested'&>
33150 &`QUIT`&
33151 .endd
33152 LHLO is used instead of HELO if the transport's &%protocol%& option is
33153 set to &"lmtp"&.
33154
33155 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33156 settings.
33157
33158 A recipient callout check is similar. By default, it also uses an empty address
33159 for the sender. This default is chosen because most hosts do not make use of
33160 the sender address when verifying a recipient. Using the same address means
33161 that a single cache entry can be used for each recipient. Some sites, however,
33162 do make use of the sender address when verifying. These are catered for by the
33163 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33164
33165 If the response to the RCPT command is a 2&'xx'& code, the verification
33166 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33167 Exim tries the next host, if any. If there is a problem with all the remote
33168 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33169 &%callout%& option is given, in which case the condition is forced to succeed.
33170
33171 .cindex "SMTP" "output flushing, disabling for callout"
33172 A callout may take a little time. For this reason, Exim normally flushes SMTP
33173 output before performing a callout in an ACL, to avoid unexpected timeouts in
33174 clients when the SMTP PIPELINING extension is in use. The flushing can be
33175 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33176
33177
33178
33179
33180 .section "Additional parameters for callouts" "CALLaddparcall"
33181 .cindex "callout" "additional parameters for"
33182 The &%callout%& option can be followed by an equals sign and a number of
33183 optional parameters, separated by commas. For example:
33184 .code
33185 verify = recipient/callout=10s,defer_ok
33186 .endd
33187 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33188 separate verify options, is retained for backwards compatibility, but is now
33189 deprecated. The additional parameters for &%callout%& are as follows:
33190
33191
33192 .vlist
33193 .vitem <&'a&~time&~interval'&>
33194 .cindex "callout" "timeout, specifying"
33195 This specifies the timeout that applies for the callout attempt to each host.
33196 For example:
33197 .code
33198 verify = sender/callout=5s
33199 .endd
33200 The default is 30 seconds. The timeout is used for each response from the
33201 remote host. It is also used for the initial connection, unless overridden by
33202 the &%connect%& parameter.
33203
33204
33205 .vitem &*connect&~=&~*&<&'time&~interval'&>
33206 .cindex "callout" "connection timeout, specifying"
33207 This parameter makes it possible to set a different (usually smaller) timeout
33208 for making the SMTP connection. For example:
33209 .code
33210 verify = sender/callout=5s,connect=1s
33211 .endd
33212 If not specified, this timeout defaults to the general timeout value.
33213
33214 .vitem &*defer_ok*&
33215 .cindex "callout" "defer, action on"
33216 When this parameter is present, failure to contact any host, or any other kind
33217 of temporary error, is treated as success by the ACL. However, the cache is not
33218 updated in this circumstance.
33219
33220 .vitem &*fullpostmaster*&
33221 .cindex "callout" "full postmaster check"
33222 This operates like the &%postmaster%& option (see below), but if the check for
33223 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33224 accordance with the specification in RFC 2821. The RFC states that the
33225 unqualified address &'postmaster'& should be accepted.
33226
33227
33228 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33229 .cindex "callout" "sender when verifying header"
33230 When verifying addresses in header lines using the &%header_sender%&
33231 verification option, Exim behaves by default as if the addresses are envelope
33232 sender addresses from a message. Callout verification therefore tests to see
33233 whether a bounce message could be delivered, by using an empty address in the
33234 MAIL command. However, it is arguable that these addresses might never be used
33235 as envelope senders, and could therefore justifiably reject bounce messages
33236 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33237 address to use in the MAIL command. For example:
33238 .code
33239 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33240 .endd
33241 This parameter is available only for the &%header_sender%& verification option.
33242
33243
33244 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33245 .cindex "callout" "overall timeout, specifying"
33246 This parameter sets an overall timeout for performing a callout verification.
33247 For example:
33248 .code
33249 verify = sender/callout=5s,maxwait=30s
33250 .endd
33251 This timeout defaults to four times the callout timeout for individual SMTP
33252 commands. The overall timeout applies when there is more than one host that can
33253 be tried. The timeout is checked before trying the next host. This prevents
33254 very long delays if there are a large number of hosts and all are timing out
33255 (for example, when network connections are timing out).
33256
33257
33258 .vitem &*no_cache*&
33259 .cindex "callout" "cache, suppressing"
33260 .cindex "caching callout, suppressing"
33261 When this parameter is given, the callout cache is neither read nor updated.
33262
33263 .vitem &*postmaster*&
33264 .cindex "callout" "postmaster; checking"
33265 When this parameter is set, a successful callout check is followed by a similar
33266 check for the local part &'postmaster'& at the same domain. If this address is
33267 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33268 the postmaster check is recorded in a cache record; if it is a failure, this is
33269 used to fail subsequent callouts for the domain without a connection being
33270 made, until the cache record expires.
33271
33272 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33273 The postmaster check uses an empty sender in the MAIL command by default.
33274 You can use this parameter to do a postmaster check using a different address.
33275 For example:
33276 .code
33277 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33278 .endd
33279 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33280 one overrides. The &%postmaster%& parameter is equivalent to this example:
33281 .code
33282 require  verify = sender/callout=postmaster_mailfrom=
33283 .endd
33284 &*Warning*&: The caching arrangements for postmaster checking do not take
33285 account of the sender address. It is assumed that either the empty address or
33286 a fixed non-empty address will be used. All that Exim remembers is that the
33287 postmaster check for the domain succeeded or failed.
33288
33289
33290 .vitem &*random*&
33291 .cindex "callout" "&""random""& check"
33292 When this parameter is set, before doing the normal callout check, Exim does a
33293 check for a &"random"& local part at the same domain. The local part is not
33294 really random &-- it is defined by the expansion of the option
33295 &%callout_random_local_part%&, which defaults to
33296 .code
33297 $primary_hostname-$tod_epoch-testing
33298 .endd
33299 The idea here is to try to determine whether the remote host accepts all local
33300 parts without checking. If it does, there is no point in doing callouts for
33301 specific local parts. If the &"random"& check succeeds, the result is saved in
33302 a cache record, and used to force the current and subsequent callout checks to
33303 succeed without a connection being made, until the cache record expires.
33304
33305 .vitem &*use_postmaster*&
33306 .cindex "callout" "sender for recipient check"
33307 This parameter applies to recipient callouts only. For example:
33308 .code
33309 deny  !verify = recipient/callout=use_postmaster
33310 .endd
33311 .vindex "&$qualify_domain$&"
33312 It causes a non-empty postmaster address to be used in the MAIL command when
33313 performing the callout for the recipient, and also for a &"random"& check if
33314 that is configured. The local part of the address is &`postmaster`& and the
33315 domain is the contents of &$qualify_domain$&.
33316
33317 .vitem &*use_sender*&
33318 This option applies to recipient callouts only. For example:
33319 .code
33320 require  verify = recipient/callout=use_sender
33321 .endd
33322 It causes the message's actual sender address to be used in the MAIL
33323 command when performing the callout, instead of an empty address. There is no
33324 need to use this option unless you know that the called hosts make use of the
33325 sender when checking recipients. If used indiscriminately, it reduces the
33326 usefulness of callout caching.
33327
33328 .vitem &*hold*&
33329 This option applies to recipient callouts only. For example:
33330 .code
33331 require  verify = recipient/callout=use_sender,hold
33332 .endd
33333 It causes the connection to be held open and used for any further recipients
33334 and for eventual delivery (should that be done quickly).
33335 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33336 when that is used for the connections.
33337 The advantage is only gained if there are no callout cache hits
33338 (which could be enforced by the no_cache option),
33339 if the use_sender option is used,
33340 if neither the random nor the use_postmaster option is used,
33341 and if no other callouts intervene.
33342 .endlist
33343
33344 If you use any of the parameters that set a non-empty sender for the MAIL
33345 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33346 &%use_sender%&), you should think about possible loops. Recipient checking is
33347 usually done between two hosts that are under the same management, and the host
33348 that receives the callouts is not normally configured to do callouts itself.
33349 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33350 these circumstances.
33351
33352 However, if you use a non-empty sender address for a callout to an arbitrary
33353 host, there is the likelihood that the remote host will itself initiate a
33354 callout check back to your host. As it is checking what appears to be a message
33355 sender, it is likely to use an empty address in MAIL, thus avoiding a
33356 callout loop. However, to be on the safe side it would be best to set up your
33357 own ACLs so that they do not do sender verification checks when the recipient
33358 is the address you use for header sender or postmaster callout checking.
33359
33360 Another issue to think about when using non-empty senders for callouts is
33361 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33362 by the sender/recipient combination; thus, for any given recipient, many more
33363 actual callouts are performed than when an empty sender or postmaster is used.
33364
33365
33366
33367
33368 .section "Callout caching" "SECTcallvercache"
33369 .cindex "hints database" "callout cache"
33370 .cindex "callout" "cache, description of"
33371 .cindex "caching" "callout"
33372 Exim caches the results of callouts in order to reduce the amount of resources
33373 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33374 option. A hints database called &"callout"& is used for the cache. Two
33375 different record types are used: one records the result of a callout check for
33376 a specific address, and the other records information that applies to the
33377 entire domain (for example, that it accepts the local part &'postmaster'&).
33378
33379 When an original callout fails, a detailed SMTP error message is given about
33380 the failure. However, for subsequent failures use the cache data, this message
33381 is not available.
33382
33383 The expiry times for negative and positive address cache records are
33384 independent, and can be set by the global options &%callout_negative_expire%&
33385 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33386
33387 If a host gives a negative response to an SMTP connection, or rejects any
33388 commands up to and including
33389 .code
33390 MAIL FROM:<>
33391 .endd
33392 (but not including the MAIL command with a non-empty address),
33393 any callout attempt is bound to fail. Exim remembers such failures in a
33394 domain cache record, which it uses to fail callouts for the domain without
33395 making new connections, until the domain record times out. There are two
33396 separate expiry times for domain cache records:
33397 &%callout_domain_negative_expire%& (default 3h) and
33398 &%callout_domain_positive_expire%& (default 7d).
33399
33400 Domain records expire when the negative expiry time is reached if callouts
33401 cannot be made for the domain, or if the postmaster check failed.
33402 Otherwise, they expire when the positive expiry time is reached. This
33403 ensures that, for example, a host that stops accepting &"random"& local parts
33404 will eventually be noticed.
33405
33406 The callout caching mechanism is based on the domain of the address that is
33407 being tested. If the domain routes to several hosts, it is assumed that their
33408 behaviour will be the same.
33409
33410
33411
33412 .new
33413 .section "Quota caching" "SECTquotacache"
33414 .cindex "hints database" "quota cache"
33415 .cindex "quota" "cache, description of"
33416 .cindex "caching" "quota"
33417 Exim caches the results of quota verification
33418 in order to reduce the amount of resources used.
33419 The &"callout"& hints database is used.
33420
33421 The default cache periods are five minutes for a positive (good) result
33422 and one hour for a negative result.
33423 To change the periods the &%quota%& option can be followed by an equals sign
33424 and a number of optional paramemters, separated by commas.
33425 For example:
33426 .code
33427 verify = recipient/quota=cachepos=1h,cacheneg=1d
33428 .endd
33429 Possible parameters are:
33430 .vlist
33431 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33432 .cindex "quota cache" "positive entry expiry, specifying"
33433 Set the lifetime for a positive cache entry.
33434 A value of zero seconds is legitimate.
33435
33436 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33437 .cindex "quota cache" "negative entry expiry, specifying"
33438 As above, for a negative entry.
33439
33440 .vitem &*no_cache*&
33441 Set both positive and negative lifetimes to zero.
33442 .wen
33443
33444 .section "Sender address verification reporting" "SECTsenaddver"
33445 .cindex "verifying" "suppressing error details"
33446 See section &<<SECTaddressverification>>& for a general discussion of
33447 verification. When sender verification fails in an ACL, the details of the
33448 failure are given as additional output lines before the 550 response to the
33449 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33450 you might see:
33451 .code
33452 MAIL FROM:<xyz@abc.example>
33453 250 OK
33454 RCPT TO:<pqr@def.example>
33455 550-Verification failed for <xyz@abc.example>
33456 550-Called:   192.168.34.43
33457 550-Sent:     RCPT TO:<xyz@abc.example>
33458 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33459 550 Sender verification failed
33460 .endd
33461 If more than one RCPT command fails in the same way, the details are given
33462 only for the first of them. However, some administrators do not want to send
33463 out this much information. You can suppress the details by adding
33464 &`/no_details`& to the ACL statement that requests sender verification. For
33465 example:
33466 .code
33467 verify = sender/no_details
33468 .endd
33469
33470 .section "Redirection while verifying" "SECTredirwhilveri"
33471 .cindex "verifying" "redirection while"
33472 .cindex "address redirection" "while verifying"
33473 A dilemma arises when a local address is redirected by aliasing or forwarding
33474 during verification: should the generated addresses themselves be verified,
33475 or should the successful expansion of the original address be enough to verify
33476 it? By default, Exim takes the following pragmatic approach:
33477
33478 .ilist
33479 When an incoming address is redirected to just one child address, verification
33480 continues with the child address, and if that fails to verify, the original
33481 verification also fails.
33482 .next
33483 When an incoming address is redirected to more than one child address,
33484 verification does not continue. A success result is returned.
33485 .endlist
33486
33487 This seems the most reasonable behaviour for the common use of aliasing as a
33488 way of redirecting different local parts to the same mailbox. It means, for
33489 example, that a pair of alias entries of the form
33490 .code
33491 A.Wol:   aw123
33492 aw123:   :fail: Gone away, no forwarding address
33493 .endd
33494 work as expected, with both local parts causing verification failure. When a
33495 redirection generates more than one address, the behaviour is more like a
33496 mailing list, where the existence of the alias itself is sufficient for
33497 verification to succeed.
33498
33499 It is possible, however, to change the default behaviour so that all successful
33500 redirections count as successful verifications, however many new addresses are
33501 generated. This is specified by the &%success_on_redirect%& verification
33502 option. For example:
33503 .code
33504 require verify = recipient/success_on_redirect/callout=10s
33505 .endd
33506 In this example, verification succeeds if a router generates a new address, and
33507 the callout does not occur, because no address was routed to a remote host.
33508
33509 When verification is being tested via the &%-bv%& option, the treatment of
33510 redirections is as just described, unless the &%-v%& or any debugging option is
33511 also specified. In that case, full verification is done for every generated
33512 address and a report is output for each of them.
33513
33514
33515
33516 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33517 .cindex "CSA" "verifying"
33518 Client SMTP Authorization is a system that allows a site to advertise
33519 which machines are and are not permitted to send email. This is done by placing
33520 special SRV records in the DNS; these are looked up using the client's HELO
33521 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33522 Authorization checks in Exim are performed by the ACL condition:
33523 .code
33524 verify = csa
33525 .endd
33526 This fails if the client is not authorized. If there is a DNS problem, or if no
33527 valid CSA SRV record is found, or if the client is authorized, the condition
33528 succeeds. These three cases can be distinguished using the expansion variable
33529 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33530 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33531 be likely to cause problems for legitimate email.
33532
33533 The error messages produced by the CSA code include slightly more
33534 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33535 looking up the CSA SRV record, or problems looking up the CSA target
33536 address record. There are four reasons for &$csa_status$& being &"fail"&:
33537
33538 .ilist
33539 The client's host name is explicitly not authorized.
33540 .next
33541 The client's IP address does not match any of the CSA target IP addresses.
33542 .next
33543 The client's host name is authorized but it has no valid target IP addresses
33544 (for example, the target's addresses are IPv6 and the client is using IPv4).
33545 .next
33546 The client's host name has no CSA SRV record but a parent domain has asserted
33547 that all subdomains must be explicitly authorized.
33548 .endlist
33549
33550 The &%csa%& verification condition can take an argument which is the domain to
33551 use for the DNS query. The default is:
33552 .code
33553 verify = csa/$sender_helo_name
33554 .endd
33555 This implementation includes an extension to CSA. If the query domain
33556 is an address literal such as [192.0.2.95], or if it is a bare IP
33557 address, Exim searches for CSA SRV records in the reverse DNS as if
33558 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33559 meaningful to say:
33560 .code
33561 verify = csa/$sender_host_address
33562 .endd
33563 In fact, this is the check that Exim performs if the client does not say HELO.
33564 This extension can be turned off by setting the main configuration option
33565 &%dns_csa_use_reverse%& to be false.
33566
33567 If a CSA SRV record is not found for the domain itself, a search
33568 is performed through its parent domains for a record which might be
33569 making assertions about subdomains. The maximum depth of this search is limited
33570 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33571 default. Exim does not look for CSA SRV records in a top level domain, so the
33572 default settings handle HELO domains as long as seven
33573 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33574 of legitimate HELO domains.
33575
33576 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33577 direct SRV lookups, this is not sufficient because of the extra parent domain
33578 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33579 addresses into lookups in the reverse DNS space. The result of a successful
33580 lookup such as:
33581 .code
33582 ${lookup dnsdb {csa=$sender_helo_name}}
33583 .endd
33584 has two space-separated fields: an authorization code and a target host name.
33585 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33586 authorization required but absent, or &"?"& for unknown.
33587
33588
33589
33590
33591 .section "Bounce address tag validation" "SECTverifyPRVS"
33592 .cindex "BATV, verifying"
33593 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33594 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33595 Genuine incoming bounce messages should therefore always be addressed to
33596 recipients that have a valid tag. This scheme is a way of detecting unwanted
33597 bounce messages caused by sender address forgeries (often called &"collateral
33598 spam"&), because the recipients of such messages do not include valid tags.
33599
33600 There are two expansion items to help with the implementation of the BATV
33601 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33602 the original envelope sender address by using a simple key to add a hash of the
33603 address and some time-based randomizing information. The &%prvs%& expansion
33604 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33605 The syntax of these expansion items is described in section
33606 &<<SECTexpansionitems>>&.
33607 The validity period on signed addresses is seven days.
33608
33609 As an example, suppose the secret per-address keys are stored in an MySQL
33610 database. A query to look up the key for an address could be defined as a macro
33611 like this:
33612 .code
33613 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33614                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33615                 }{$value}}
33616 .endd
33617 Suppose also that the senders who make use of BATV are defined by an address
33618 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33619 use this:
33620 .code
33621 # Bounces: drop unsigned addresses for BATV senders
33622 deny senders = :
33623      recipients = +batv_senders
33624      message = This address does not send an unsigned reverse path
33625
33626 # Bounces: In case of prvs-signed address, check signature.
33627 deny senders = :
33628      condition  = ${prvscheck {$local_part@$domain}\
33629                   {PRVSCHECK_SQL}{1}}
33630      !condition = $prvscheck_result
33631      message = Invalid reverse path signature.
33632 .endd
33633 The first statement rejects recipients for bounce messages that are addressed
33634 to plain BATV sender addresses, because it is known that BATV senders do not
33635 send out messages with plain sender addresses. The second statement rejects
33636 recipients that are prvs-signed, but with invalid signatures (either because
33637 the key is wrong, or the signature has timed out).
33638
33639 A non-prvs-signed address is not rejected by the second statement, because the
33640 &%prvscheck%& expansion yields an empty string if its first argument is not a
33641 prvs-signed address, thus causing the &%condition%& condition to be false. If
33642 the first argument is a syntactically valid prvs-signed address, the yield is
33643 the third string (in this case &"1"&), whether or not the cryptographic and
33644 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33645 of the checks (empty for failure, &"1"& for success).
33646
33647 There is one more issue you must consider when implementing prvs-signing:
33648 you have to ensure that the routers accept prvs-signed addresses and
33649 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33650 router to remove the signature with a configuration along these lines:
33651 .code
33652 batv_redirect:
33653   driver = redirect
33654   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33655 .endd
33656 This works because, if the third argument of &%prvscheck%& is empty, the result
33657 of the expansion of a prvs-signed address is the decoded value of the original
33658 address. This router should probably be the first of your routers that handles
33659 local addresses.
33660
33661 To create BATV-signed addresses in the first place, a transport of this form
33662 can be used:
33663 .code
33664 external_smtp_batv:
33665   driver = smtp
33666   return_path = ${prvs {$return_path} \
33667                        {${lookup mysql{SELECT \
33668                        secret FROM batv_prvs WHERE \
33669                        sender='${quote_mysql:$sender_address}'} \
33670                        {$value}fail}}}
33671 .endd
33672 If no key can be found for the existing return path, no signing takes place.
33673
33674
33675
33676 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33677 .cindex "&ACL;" "relay control"
33678 .cindex "relaying" "control by ACL"
33679 .cindex "policy control" "relay control"
33680 An MTA is said to &'relay'& a message if it receives it from some host and
33681 delivers it directly to another host as a result of a remote address contained
33682 within it. Redirecting a local address via an alias or forward file and then
33683 passing the message on to another host is not relaying,
33684 .cindex "&""percent hack""&"
33685 but a redirection as a result of the &"percent hack"& is.
33686
33687 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33688 A host which is acting as a gateway or an MX backup is concerned with incoming
33689 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33690 a host which is acting as a smart host for a number of clients is concerned
33691 with outgoing relaying from those clients to the Internet at large. Often the
33692 same host is fulfilling both functions,
33693 . ///
33694 . as illustrated in the diagram below,
33695 . ///
33696 but in principle these two kinds of relaying are entirely independent. What is
33697 not wanted is the transmission of mail from arbitrary remote hosts through your
33698 system to arbitrary domains.
33699
33700
33701 You can implement relay control by means of suitable statements in the ACL that
33702 runs for each RCPT command. For convenience, it is often easiest to use
33703 Exim's named list facility to define the domains and hosts involved. For
33704 example, suppose you want to do the following:
33705
33706 .ilist
33707 Deliver a number of domains to mailboxes on the local host (or process them
33708 locally in some other way). Let's say these are &'my.dom1.example'& and
33709 &'my.dom2.example'&.
33710 .next
33711 Relay mail for a number of other domains for which you are the secondary MX.
33712 These might be &'friend1.example'& and &'friend2.example'&.
33713 .next
33714 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33715 Suppose your LAN is 192.168.45.0/24.
33716 .endlist
33717
33718
33719 In the main part of the configuration, you put the following definitions:
33720 .code
33721 domainlist local_domains    = my.dom1.example : my.dom2.example
33722 domainlist relay_to_domains = friend1.example : friend2.example
33723 hostlist   relay_from_hosts = 192.168.45.0/24
33724 .endd
33725 Now you can use these definitions in the ACL that is run for every RCPT
33726 command:
33727 .code
33728 acl_check_rcpt:
33729   accept domains = +local_domains : +relay_to_domains
33730   accept hosts   = +relay_from_hosts
33731 .endd
33732 The first statement accepts any RCPT command that contains an address in
33733 the local or relay domains. For any other domain, control passes to the second
33734 statement, which accepts the command only if it comes from one of the relay
33735 hosts. In practice, you will probably want to make your ACL more sophisticated
33736 than this, for example, by including sender and recipient verification. The
33737 default configuration includes a more comprehensive example, which is described
33738 in chapter &<<CHAPdefconfil>>&.
33739
33740
33741
33742 .section "Checking a relay configuration" "SECTcheralcon"
33743 .cindex "relaying" "checking control of"
33744 You can check the relay characteristics of your configuration in the same way
33745 that you can test any ACL behaviour for an incoming SMTP connection, by using
33746 the &%-bh%& option to run a fake SMTP session with which you interact.
33747 .ecindex IIDacl
33748
33749
33750
33751 . ////////////////////////////////////////////////////////////////////////////
33752 . ////////////////////////////////////////////////////////////////////////////
33753
33754 .chapter "Content scanning at ACL time" "CHAPexiscan"
33755 .scindex IIDcosca "content scanning" "at ACL time"
33756 The extension of Exim to include content scanning at ACL time, formerly known
33757 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33758 was integrated into the main source for Exim release 4.50, and Tom continues to
33759 maintain it. Most of the wording of this chapter is taken from Tom's
33760 specification.
33761
33762 It is also possible to scan the content of messages at other times. The
33763 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33764 scanning after all the ACLs have run. A transport filter can be used to scan
33765 messages at delivery time (see the &%transport_filter%& option, described in
33766 chapter &<<CHAPtransportgeneric>>&).
33767
33768 If you want to include the ACL-time content-scanning features when you compile
33769 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33770 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33771
33772 .ilist
33773 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33774 for all MIME parts for SMTP and non-SMTP messages, respectively.
33775 .next
33776 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33777 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33778 run at the end of message reception (the &%acl_smtp_data%& ACL).
33779 .next
33780 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33781 of messages, or parts of messages, for debugging purposes.
33782 .next
33783 Additional expansion variables that are set in the new ACL and by the new
33784 conditions.
33785 .next
33786 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33787 .endlist
33788
33789 Content-scanning is continually evolving, and new features are still being
33790 added. While such features are still unstable and liable to incompatible
33791 changes, they are made available in Exim by setting options whose names begin
33792 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33793 this manual. You can find out about them by reading the file called
33794 &_doc/experimental.txt_&.
33795
33796 All the content-scanning facilities work on a MBOX copy of the message that is
33797 temporarily created in a file called:
33798 .display
33799 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33800 .endd
33801 The &_.eml_& extension is a friendly hint to virus scanners that they can
33802 expect an MBOX-like structure inside that file. The file is created when the
33803 first content scanning facility is called. Subsequent calls to content
33804 scanning conditions open the same file again. The directory is recursively
33805 removed when the &%acl_smtp_data%& ACL has finished running, unless
33806 .code
33807 control = no_mbox_unspool
33808 .endd
33809 has been encountered. When the MIME ACL decodes files, they are put into the
33810 same directory by default.
33811
33812
33813
33814 .section "Scanning for viruses" "SECTscanvirus"
33815 .cindex "virus scanning"
33816 .cindex "content scanning" "for viruses"
33817 .cindex "content scanning" "the &%malware%& condition"
33818 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33819 It supports a &"generic"& interface to scanners called via the shell, and
33820 specialized interfaces for &"daemon"& type virus scanners, which are resident
33821 in memory and thus are much faster.
33822
33823 Since message data needs to have arrived,
33824 the condition may be only called in ACL defined by
33825 &%acl_smtp_data%&,
33826 &%acl_smtp_data_prdr%&,
33827 &%acl_smtp_mime%& or
33828 &%acl_smtp_dkim%&
33829
33830 A timeout of 2 minutes is applied to a scanner call (by default);
33831 if it expires then a defer action is taken.
33832
33833 .oindex "&%av_scanner%&"
33834 You can set the &%av_scanner%& option in the main part of the configuration
33835 to specify which scanner to use, together with any additional options that
33836 are needed. The basic syntax is as follows:
33837 .display
33838 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33839 .endd
33840 If you do not set &%av_scanner%&, it defaults to
33841 .code
33842 av_scanner = sophie:/var/run/sophie
33843 .endd
33844 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33845 before use.
33846 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33847 The following scanner types are supported in this release,
33848 though individual ones can be included or not at build time:
33849
33850 .vlist
33851 .vitem &%avast%&
33852 .cindex "virus scanners" "avast"
33853 This is the scanner daemon of Avast. It has been tested with Avast Core
33854 Security (currently at version 2.2.0).
33855 You can get a trial version at &url(https://www.avast.com) or for Linux
33856 at &url(https://www.avast.com/linux-server-antivirus).
33857 This scanner type takes one option,
33858 which can be either a full path to a UNIX socket,
33859 or host and port specifiers separated by white space.
33860 The host may be a name or an IP address; the port is either a
33861 single number or a pair of numbers with a dash between.
33862 A list of options may follow. These options are interpreted on the
33863 Exim's side of the malware scanner, or are given on separate lines to
33864 the daemon as options before the main scan command.
33865
33866 .cindex &`pass_unscanned`& "avast"
33867 If &`pass_unscanned`&
33868 is set, any files the Avast scanner can't scan (e.g.
33869 decompression bombs, or invalid archives) are considered clean. Use with
33870 care.
33871
33872 For example:
33873 .code
33874 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33875 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33876 av_scanner = avast:192.168.2.22 5036
33877 .endd
33878 If you omit the argument, the default path
33879 &_/var/run/avast/scan.sock_&
33880 is used.
33881 If you use a remote host,
33882 you need to make Exim's spool directory available to it,
33883 as the scanner is passed a file path, not file contents.
33884 For information about available commands and their options you may use
33885 .code
33886 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33887     FLAGS
33888     SENSITIVITY
33889     PACK
33890 .endd
33891
33892 If the scanner returns a temporary failure (e.g. license issues, or
33893 permission problems), the message is deferred and a paniclog entry is
33894 written.  The usual &`defer_ok`& option is available.
33895
33896 .vitem &%aveserver%&
33897 .cindex "virus scanners" "Kaspersky"
33898 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33899 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33900 which is the path to the daemon's UNIX socket. The default is shown in this
33901 example:
33902 .code
33903 av_scanner = aveserver:/var/run/aveserver
33904 .endd
33905
33906
33907 .vitem &%clamd%&
33908 .cindex "virus scanners" "clamd"
33909 This daemon-type scanner is GPL and free. You can get it at
33910 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33911 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33912 in the MIME ACL. This is no longer believed to be necessary.
33913
33914 The options are a list of server specifiers, which may be
33915 a UNIX socket specification,
33916 a TCP socket specification,
33917 or a (global) option.
33918
33919 A socket specification consists of a space-separated list.
33920 For a Unix socket the first element is a full path for the socket,
33921 for a TCP socket the first element is the IP address
33922 and the second a port number,
33923 Any further elements are per-server (non-global) options.
33924 These per-server options are supported:
33925 .code
33926 retry=<timespec>        Retry on connect fail
33927 .endd
33928
33929 The &`retry`& option specifies a time after which a single retry for
33930 a failed connect is made.  The default is to not retry.
33931
33932 If a Unix socket file is specified, only one server is supported.
33933
33934 Examples:
33935 .code
33936 av_scanner = clamd:/opt/clamd/socket
33937 av_scanner = clamd:192.0.2.3 1234
33938 av_scanner = clamd:192.0.2.3 1234:local
33939 av_scanner = clamd:192.0.2.3 1234 retry=10s
33940 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33941 .endd
33942 If the value of av_scanner points to a UNIX socket file or contains the
33943 &`local`&
33944 option, then the ClamAV interface will pass a filename containing the data
33945 to be scanned, which should normally result in less I/O happening and be
33946 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33947 Exim does not assume that there is a common filesystem with the remote host.
33948
33949 The final example shows that multiple TCP targets can be specified.  Exim will
33950 randomly use one for each incoming email (i.e. it load balances them).  Note
33951 that only TCP targets may be used if specifying a list of scanners; a UNIX
33952 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33953 unavailable, Exim will try the remaining one(s) until it finds one that works.
33954 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33955 not keep track of scanner state between multiple messages, and the scanner
33956 selection is random, so the message will get logged in the mainlog for each
33957 email that the down scanner gets chosen first (message wrapped to be readable):
33958 .code
33959 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33960    clamd: connection to localhost, port 3310 failed
33961    (Connection refused)
33962 .endd
33963
33964 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33965 contributing the code for this scanner.
33966
33967 .vitem &%cmdline%&
33968 .cindex "virus scanners" "command line interface"
33969 This is the keyword for the generic command line scanner interface. It can be
33970 used to attach virus scanners that are invoked from the shell. This scanner
33971 type takes 3 mandatory options:
33972
33973 .olist
33974 The full path and name of the scanner binary, with all command line options,
33975 and a placeholder (&`%s`&) for the directory to scan.
33976
33977 .next
33978 A regular expression to match against the STDOUT and STDERR output of the
33979 virus scanner. If the expression matches, a virus was found. You must make
33980 absolutely sure that this expression matches on &"virus found"&. This is called
33981 the &"trigger"& expression.
33982
33983 .next
33984 Another regular expression, containing exactly one pair of parentheses, to
33985 match the name of the virus found in the scanners output. This is called the
33986 &"name"& expression.
33987 .endlist olist
33988
33989 For example, Sophos Sweep reports a virus on a line like this:
33990 .code
33991 Virus 'W32/Magistr-B' found in file ./those.bat
33992 .endd
33993 For the trigger expression, we can match the phrase &"found in file"&. For the
33994 name expression, we want to extract the W32/Magistr-B string, so we can match
33995 for the single quotes left and right of it. Altogether, this makes the
33996 configuration setting:
33997 .code
33998 av_scanner = cmdline:\
33999              /path/to/sweep -ss -all -rec -archive %s:\
34000              found in file:'(.+)'
34001 .endd
34002 .vitem &%drweb%&
34003 .cindex "virus scanners" "DrWeb"
34004 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34005 takes one option,
34006 either a full path to a UNIX socket,
34007 or host and port specifiers separated by white space.
34008 The host may be a name or an IP address; the port is either a
34009 single number or a pair of numbers with a dash between.
34010 For example:
34011 .code
34012 av_scanner = drweb:/var/run/drwebd.sock
34013 av_scanner = drweb:192.168.2.20 31337
34014 .endd
34015 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34016 is used. Thanks to Alex Miller for contributing the code for this scanner.
34017
34018 .vitem &%f-protd%&
34019 .cindex "virus scanners" "f-protd"
34020 The f-protd scanner is accessed via HTTP over TCP.
34021 One argument is taken, being a space-separated hostname and port number
34022 (or port-range).
34023 For example:
34024 .code
34025 av_scanner = f-protd:localhost 10200-10204
34026 .endd
34027 If you omit the argument, the default values shown above are used.
34028
34029 .vitem &%f-prot6d%&
34030 .cindex "virus scanners" "f-prot6d"
34031 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34032 One argument is taken, being a space-separated hostname and port number.
34033 For example:
34034 .code
34035 av_scanner = f-prot6d:localhost 10200
34036 .endd
34037 If you omit the argument, the default values show above are used.
34038
34039 .vitem &%fsecure%&
34040 .cindex "virus scanners" "F-Secure"
34041 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34042 argument which is the path to a UNIX socket. For example:
34043 .code
34044 av_scanner = fsecure:/path/to/.fsav
34045 .endd
34046 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34047 Thelmen for contributing the code for this scanner.
34048
34049 .vitem &%kavdaemon%&
34050 .cindex "virus scanners" "Kaspersky"
34051 This is the scanner daemon of Kaspersky Version 4. This version of the
34052 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34053 scanner type takes one option, which is the path to the daemon's UNIX socket.
34054 For example:
34055 .code
34056 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34057 .endd
34058 The default path is &_/var/run/AvpCtl_&.
34059
34060 .vitem &%mksd%&
34061 .cindex "virus scanners" "mksd"
34062 This was a daemon type scanner that is aimed mainly at Polish users,
34063 though some documentation was available in English.
34064 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34065 and this appears to be a candidate for removal from Exim, unless
34066 we are informed of other virus scanners which use the same protocol
34067 to integrate.
34068 The only option for this scanner type is
34069 the maximum number of processes used simultaneously to scan the attachments,
34070 provided that mksd has
34071 been run with at least the same number of child processes. For example:
34072 .code
34073 av_scanner = mksd:2
34074 .endd
34075 You can safely omit this option (the default value is 1).
34076
34077 .vitem &%sock%&
34078 .cindex "virus scanners" "simple socket-connected"
34079 This is a general-purpose way of talking to simple scanner daemons
34080 running on the local machine.
34081 There are four options:
34082 an address (which may be an IP address and port, or the path of a Unix socket),
34083 a commandline to send (may include a single %s which will be replaced with
34084 the path to the mail file to be scanned),
34085 an RE to trigger on from the returned data,
34086 and an RE to extract malware_name from the returned data.
34087 For example:
34088 .code
34089 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34090 .endd
34091 Note that surrounding whitespace is stripped from each option, meaning
34092 there is no way to specify a trailing newline.
34093 The socket specifier and both regular-expressions are required.
34094 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34095 specify an empty element to get this.
34096
34097 .vitem &%sophie%&
34098 .cindex "virus scanners" "Sophos and Sophie"
34099 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34100 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34101 for this scanner type is the path to the UNIX socket that Sophie uses for
34102 client communication. For example:
34103 .code
34104 av_scanner = sophie:/tmp/sophie
34105 .endd
34106 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34107 the option.
34108 .endlist
34109
34110 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34111 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34112 ACL.
34113
34114 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34115 makes it possible to use different scanners. See further below for an example.
34116 The &%malware%& condition caches its results, so when you use it multiple times
34117 for the same message, the actual scanning process is only carried out once.
34118 However, using expandable items in &%av_scanner%& disables this caching, in
34119 which case each use of the &%malware%& condition causes a new scan of the
34120 message.
34121
34122 The &%malware%& condition takes a right-hand argument that is expanded before
34123 use and taken as a list, slash-separated by default.
34124 The first element can then be one of
34125
34126 .ilist
34127 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34128 The condition succeeds if a virus was found, and fail otherwise. This is the
34129 recommended usage.
34130 .next
34131 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34132 the condition fails immediately.
34133 .next
34134 A regular expression, in which case the message is scanned for viruses. The
34135 condition succeeds if a virus is found and its name matches the regular
34136 expression. This allows you to take special actions on certain types of virus.
34137 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34138 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34139 .endlist
34140
34141 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34142 messages even if there is a problem with the virus scanner.
34143 Otherwise, such a problem causes the ACL to defer.
34144
34145 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34146 specify a non-default timeout.  The default is two minutes.
34147 For example:
34148 .code
34149 malware = * / defer_ok / tmo=10s
34150 .endd
34151 A timeout causes the ACL to defer.
34152
34153 .vindex "&$callout_address$&"
34154 When a connection is made to the scanner the expansion variable &$callout_address$&
34155 is set to record the actual address used.
34156
34157 .vindex "&$malware_name$&"
34158 When a virus is found, the condition sets up an expansion variable called
34159 &$malware_name$& that contains the name of the virus. You can use it in a
34160 &%message%& modifier that specifies the error returned to the sender, and/or in
34161 logging data.
34162
34163 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34164 imposed by your anti-virus scanner.
34165
34166 Here is a very simple scanning example:
34167 .code
34168 deny malware = *
34169      message = This message contains malware ($malware_name)
34170 .endd
34171 The next example accepts messages when there is a problem with the scanner:
34172 .code
34173 deny malware = */defer_ok
34174      message = This message contains malware ($malware_name)
34175 .endd
34176 The next example shows how to use an ACL variable to scan with both sophie and
34177 aveserver. It assumes you have set:
34178 .code
34179 av_scanner = $acl_m0
34180 .endd
34181 in the main Exim configuration.
34182 .code
34183 deny set acl_m0 = sophie
34184      malware = *
34185      message = This message contains malware ($malware_name)
34186
34187 deny set acl_m0 = aveserver
34188      malware = *
34189      message = This message contains malware ($malware_name)
34190 .endd
34191
34192
34193 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34194 .cindex "content scanning" "for spam"
34195 .cindex "spam scanning"
34196 .cindex "SpamAssassin"
34197 .cindex "Rspamd"
34198 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34199 score and a report for the message.
34200 Support is also provided for Rspamd.
34201
34202 For more information about installation and configuration of SpamAssassin or
34203 Rspamd refer to their respective websites at
34204 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34205
34206 SpamAssassin can be installed with CPAN by running:
34207 .code
34208 perl -MCPAN -e 'install Mail::SpamAssassin'
34209 .endd
34210 SpamAssassin has its own set of configuration files. Please review its
34211 documentation to see how you can tweak it. The default installation should work
34212 nicely, however.
34213
34214 .oindex "&%spamd_address%&"
34215 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34216 intend to use an instance running on the local host you do not need to set
34217 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34218 you must set the &%spamd_address%& option in the global part of the Exim
34219 configuration as follows (example):
34220 .code
34221 spamd_address = 192.168.99.45 783
34222 .endd
34223 The SpamAssassin protocol relies on a TCP half-close from the client.
34224 If your SpamAssassin client side is running a Linux system with an
34225 iptables firewall, consider setting
34226 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34227 timeout, Exim uses when waiting for a response from the SpamAssassin
34228 server (currently defaulting to 120s).  With a lower value the Linux
34229 connection tracking may consider your half-closed connection as dead too
34230 soon.
34231
34232
34233 To use Rspamd (which by default listens on all local addresses
34234 on TCP port 11333)
34235 you should add &%variant=rspamd%& after the address/port pair, for example:
34236 .code
34237 spamd_address = 127.0.0.1 11333 variant=rspamd
34238 .endd
34239
34240 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34241 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34242 filename instead of an address/port pair:
34243 .code
34244 spamd_address = /var/run/spamd_socket
34245 .endd
34246 You can have multiple &%spamd%& servers to improve scalability. These can
34247 reside on other hardware reachable over the network. To specify multiple
34248 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34249 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34250 .code
34251 spamd_address = 192.168.2.10 783 : \
34252                 192.168.2.11 783 : \
34253                 192.168.2.12 783
34254 .endd
34255 Up to 32 &%spamd%& servers are supported.
34256 When a server fails to respond to the connection attempt, all other
34257 servers are tried until one succeeds. If no server responds, the &%spam%&
34258 condition defers.
34259
34260 Unix and TCP socket specifications may be mixed in any order.
34261 Each element of the list is a list itself, space-separated by default
34262 and changeable in the usual way (&<<SECTlistsepchange>>&);
34263 take care to not double the separator.
34264
34265 For TCP socket specifications a host name or IP (v4 or v6, but
34266 subject to list-separator quoting rules) address can be used,
34267 and the port can be one or a dash-separated pair.
34268 In the latter case, the range is tried in strict order.
34269
34270 Elements after the first for Unix sockets, or second for TCP socket,
34271 are options.
34272 The supported options are:
34273 .code
34274 pri=<priority>      Selection priority
34275 weight=<value>      Selection bias
34276 time=<start>-<end>  Use only between these times of day
34277 retry=<timespec>    Retry on connect fail
34278 tmo=<timespec>      Connection time limit
34279 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34280 .endd
34281
34282 The &`pri`& option specifies a priority for the server within the list,
34283 higher values being tried first.
34284 The default priority is 1.
34285
34286 The &`weight`& option specifies a selection bias.
34287 Within a priority set
34288 servers are queried in a random fashion, weighted by this value.
34289 The default value for selection bias is 1.
34290
34291 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34292 in the local time zone; each element being one or more digits.
34293 Either the seconds or both minutes and seconds, plus the leading &`.`&
34294 characters, may be omitted and will be taken as zero.
34295
34296 Timeout specifications for the &`retry`& and &`tmo`& options
34297 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34298
34299 The &`tmo`& option specifies an overall timeout for communication.
34300 The default value is two minutes.
34301
34302 The &`retry`& option specifies a time after which a single retry for
34303 a failed connect is made.
34304 The default is to not retry.
34305
34306 The &%spamd_address%& variable is expanded before use if it starts with
34307 a dollar sign. In this case, the expansion may return a string that is
34308 used as the list so that multiple spamd servers can be the result of an
34309 expansion.
34310
34311 .vindex "&$callout_address$&"
34312 When a connection is made to the server the expansion variable &$callout_address$&
34313 is set to record the actual address used.
34314
34315 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34316 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34317 .code
34318 deny spam = joe
34319      message = This message was classified as SPAM
34320 .endd
34321 The right-hand side of the &%spam%& condition specifies a name. This is
34322 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34323 to scan using a specific profile, but rather use the SpamAssassin system-wide
34324 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34325 Rspamd does not use this setting. However, you must put something on the
34326 right-hand side.
34327
34328 The name allows you to use per-domain or per-user antispam profiles in
34329 principle, but this is not straightforward in practice, because a message may
34330 have multiple recipients, not necessarily all in the same domain. Because the
34331 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34332 read the contents of the message, the variables &$local_part$& and &$domain$&
34333 are not set.
34334 Careful enforcement of single-recipient messages
34335 (e.g. by responding with defer in the recipient ACL for all recipients
34336 after the first),
34337 or the use of PRDR,
34338 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34339 are needed to use this feature.
34340
34341 The right-hand side of the &%spam%& condition is expanded before being used, so
34342 you can put lookups or conditions there. When the right-hand side evaluates to
34343 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34344
34345
34346 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34347 large ones may cause significant performance degradation. As most spam messages
34348 are quite small, it is recommended that you do not scan the big ones. For
34349 example:
34350 .code
34351 deny condition = ${if < {$message_size}{10K}}
34352      spam = nobody
34353      message = This message was classified as SPAM
34354 .endd
34355
34356 The &%spam%& condition returns true if the threshold specified in the user's
34357 SpamAssassin profile has been matched or exceeded. If you want to use the
34358 &%spam%& condition for its side effects (see the variables below), you can make
34359 it always return &"true"& by appending &`:true`& to the username.
34360
34361 .cindex "spam scanning" "returned variables"
34362 When the &%spam%& condition is run, it sets up a number of expansion
34363 variables.
34364 Except for &$spam_report$&,
34365 these variables are saved with the received message so are
34366 available for use at delivery time.
34367
34368 .vlist
34369 .vitem &$spam_score$&
34370 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34371 for inclusion in log or reject messages.
34372
34373 .vitem &$spam_score_int$&
34374 The spam score of the message, multiplied by ten, as an integer value. For
34375 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34376 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34377 The integer value is useful for numeric comparisons in conditions.
34378
34379 .vitem &$spam_bar$&
34380 A string consisting of a number of &"+"& or &"-"& characters, representing the
34381 integer part of the spam score value. A spam score of 4.4 would have a
34382 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34383 headers, since MUAs can match on such strings. The maximum length of the
34384 spam bar is 50 characters.
34385
34386 .vitem &$spam_report$&
34387 A multiline text table, containing the full SpamAssassin report for the
34388 message. Useful for inclusion in headers or reject messages.
34389 This variable is only usable in a DATA-time ACL.
34390 Beware that SpamAssassin may return non-ASCII characters, especially
34391 when running in country-specific locales, which are not legal
34392 unencoded in headers.
34393
34394 .vitem &$spam_action$&
34395 For SpamAssassin either 'reject' or 'no action' depending on the
34396 spam score versus threshold.
34397 For Rspamd, the recommended action.
34398
34399 .endlist
34400
34401 The &%spam%& condition caches its results unless expansion in
34402 spamd_address was used. If you call it again with the same user name, it
34403 does not scan again, but rather returns the same values as before.
34404
34405 The &%spam%& condition returns DEFER if there is any error while running
34406 the message through SpamAssassin or if the expansion of spamd_address
34407 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34408 statement block), append &`/defer_ok`& to the right-hand side of the
34409 spam condition, like this:
34410 .code
34411 deny spam    = joe/defer_ok
34412      message = This message was classified as SPAM
34413 .endd
34414 This causes messages to be accepted even if there is a problem with &%spamd%&.
34415
34416 Here is a longer, commented example of the use of the &%spam%&
34417 condition:
34418 .code
34419 # put headers in all messages (no matter if spam or not)
34420 warn  spam = nobody:true
34421       add_header = X-Spam-Score: $spam_score ($spam_bar)
34422       add_header = X-Spam-Report: $spam_report
34423
34424 # add second subject line with *SPAM* marker when message
34425 # is over threshold
34426 warn  spam = nobody
34427       add_header = Subject: *SPAM* $h_Subject:
34428
34429 # reject spam at high scores (> 12)
34430 deny  spam = nobody:true
34431       condition = ${if >{$spam_score_int}{120}{1}{0}}
34432       message = This message scored $spam_score spam points.
34433 .endd
34434
34435
34436
34437 .section "Scanning MIME parts" "SECTscanmimepart"
34438 .cindex "content scanning" "MIME parts"
34439 .cindex "MIME content scanning"
34440 .oindex "&%acl_smtp_mime%&"
34441 .oindex "&%acl_not_smtp_mime%&"
34442 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34443 each MIME part of an SMTP message, including multipart types, in the sequence
34444 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34445 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34446 options may both refer to the same ACL if you want the same processing in both
34447 cases.
34448
34449 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34450 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34451 the case of a non-SMTP message. However, a MIME ACL is called only if the
34452 message contains a &'Content-Type:'& header line. When a call to a MIME
34453 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34454 result code is sent to the client. In the case of an SMTP message, the
34455 &%acl_smtp_data%& ACL is not called when this happens.
34456
34457 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34458 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34459 condition to match against the raw MIME part. You can also use the
34460 &%mime_regex%& condition to match against the decoded MIME part (see section
34461 &<<SECTscanregex>>&).
34462
34463 At the start of a MIME ACL, a number of variables are set from the header
34464 information for the relevant MIME part. These are described below. The contents
34465 of the MIME part are not by default decoded into a disk file except for MIME
34466 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34467 part into a disk file, you can use the &%decode%& condition. The general
34468 syntax is:
34469 .display
34470 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34471 .endd
34472 The right hand side is expanded before use. After expansion,
34473 the value can be:
34474
34475 .olist
34476 &"0"& or &"false"&, in which case no decoding is done.
34477 .next
34478 The string &"default"&. In that case, the file is put in the temporary
34479 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34480 a sequential filename consisting of the message id and a sequence number. The
34481 full path and name is available in &$mime_decoded_filename$& after decoding.
34482 .next
34483 A full path name starting with a slash. If the full name is an existing
34484 directory, it is used as a replacement for the default directory. The filename
34485 is then sequentially assigned. If the path does not exist, it is used as
34486 the full path and filename.
34487 .next
34488 If the string does not start with a slash, it is used as the
34489 filename, and the default path is then used.
34490 .endlist
34491 The &%decode%& condition normally succeeds. It is only false for syntax
34492 errors or unusual circumstances such as memory shortages. You can easily decode
34493 a file with its original, proposed filename using
34494 .code
34495 decode = $mime_filename
34496 .endd
34497 However, you should keep in mind that &$mime_filename$& might contain
34498 anything. If you place files outside of the default path, they are not
34499 automatically unlinked.
34500
34501 For RFC822 attachments (these are messages attached to messages, with a
34502 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34503 as for the primary message, only that the &$mime_is_rfc822$& expansion
34504 variable is set (see below). Attached messages are always decoded to disk
34505 before being checked, and the files are unlinked once the check is done.
34506
34507 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34508 used to match regular expressions against raw and decoded MIME parts,
34509 respectively. They are described in section &<<SECTscanregex>>&.
34510
34511 .cindex "MIME content scanning" "returned variables"
34512 The following list describes all expansion variables that are
34513 available in the MIME ACL:
34514
34515 .vlist
34516 .vitem &$mime_anomaly_level$& &&&
34517        &$mime_anomaly_text$&
34518 .vindex &$mime_anomaly_level$&
34519 .vindex &$mime_anomaly_text$&
34520 If there are problems decoding, these variables contain information on
34521 the detected issue.
34522
34523 .vitem &$mime_boundary$&
34524 .vindex &$mime_boundary$&
34525 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34526 have a boundary string, which is stored in this variable. If the current part
34527 has no boundary parameter in the &'Content-Type:'& header, this variable
34528 contains the empty string.
34529
34530 .vitem &$mime_charset$&
34531 .vindex &$mime_charset$&
34532 This variable contains the character set identifier, if one was found in the
34533 &'Content-Type:'& header. Examples for charset identifiers are:
34534 .code
34535 us-ascii
34536 gb2312 (Chinese)
34537 iso-8859-1
34538 .endd
34539 Please note that this value is not normalized, so you should do matches
34540 case-insensitively.
34541
34542 .vitem &$mime_content_description$&
34543 .vindex &$mime_content_description$&
34544 This variable contains the normalized content of the &'Content-Description:'&
34545 header. It can contain a human-readable description of the parts content. Some
34546 implementations repeat the filename for attachments here, but they are usually
34547 only used for display purposes.
34548
34549 .vitem &$mime_content_disposition$&
34550 .vindex &$mime_content_disposition$&
34551 This variable contains the normalized content of the &'Content-Disposition:'&
34552 header. You can expect strings like &"attachment"& or &"inline"& here.
34553
34554 .vitem &$mime_content_id$&
34555 .vindex &$mime_content_id$&
34556 This variable contains the normalized content of the &'Content-ID:'& header.
34557 This is a unique ID that can be used to reference a part from another part.
34558
34559 .vitem &$mime_content_size$&
34560 .vindex &$mime_content_size$&
34561 This variable is set only after the &%decode%& modifier (see above) has been
34562 successfully run. It contains the size of the decoded part in kilobytes. The
34563 size is always rounded up to full kilobytes, so only a completely empty part
34564 has a &$mime_content_size$& of zero.
34565
34566 .vitem &$mime_content_transfer_encoding$&
34567 .vindex &$mime_content_transfer_encoding$&
34568 This variable contains the normalized content of the
34569 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34570 type. Typical values are &"base64"& and &"quoted-printable"&.
34571
34572 .vitem &$mime_content_type$&
34573 .vindex &$mime_content_type$&
34574 If the MIME part has a &'Content-Type:'& header, this variable contains its
34575 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34576 are some examples of popular MIME types, as they may appear in this variable:
34577 .code
34578 text/plain
34579 text/html
34580 application/octet-stream
34581 image/jpeg
34582 audio/midi
34583 .endd
34584 If the MIME part has no &'Content-Type:'& header, this variable contains the
34585 empty string.
34586
34587 .vitem &$mime_decoded_filename$&
34588 .vindex &$mime_decoded_filename$&
34589 This variable is set only after the &%decode%& modifier (see above) has been
34590 successfully run. It contains the full path and filename of the file
34591 containing the decoded data.
34592 .endlist
34593
34594 .cindex "RFC 2047"
34595 .vlist
34596 .vitem &$mime_filename$&
34597 .vindex &$mime_filename$&
34598 This is perhaps the most important of the MIME variables. It contains a
34599 proposed filename for an attachment, if one was found in either the
34600 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34601 RFC2047
34602 or RFC2231
34603 decoded, but no additional sanity checks are done.
34604  If no filename was
34605 found, this variable contains the empty string.
34606
34607 .vitem &$mime_is_coverletter$&
34608 .vindex &$mime_is_coverletter$&
34609 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34610 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34611 content in the cover letter, while not restricting attachments at all.
34612
34613 The variable contains 1 (true) for a MIME part believed to be part of the
34614 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34615 follows:
34616
34617 .olist
34618 The outermost MIME part of a message is always a cover letter.
34619
34620 .next
34621 If a multipart/alternative or multipart/related MIME part is a cover letter,
34622 so are all MIME subparts within that multipart.
34623
34624 .next
34625 If any other multipart is a cover letter, the first subpart is a cover letter,
34626 and the rest are attachments.
34627
34628 .next
34629 All parts contained within an attachment multipart are attachments.
34630 .endlist olist
34631
34632 As an example, the following will ban &"HTML mail"& (including that sent with
34633 alternative plain text), while allowing HTML files to be attached. HTML
34634 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34635 .code
34636 deny !condition = $mime_is_rfc822
34637      condition = $mime_is_coverletter
34638      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34639      message = HTML mail is not accepted here
34640 .endd
34641
34642 .vitem &$mime_is_multipart$&
34643 .vindex &$mime_is_multipart$&
34644 This variable has the value 1 (true) when the current part has the main type
34645 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34646 Since multipart entities only serve as containers for other parts, you may not
34647 want to carry out specific actions on them.
34648
34649 .vitem &$mime_is_rfc822$&
34650 .vindex &$mime_is_rfc822$&
34651 This variable has the value 1 (true) if the current part is not a part of the
34652 checked message itself, but part of an attached message. Attached message
34653 decoding is fully recursive.
34654
34655 .vitem &$mime_part_count$&
34656 .vindex &$mime_part_count$&
34657 This variable is a counter that is raised for each processed MIME part. It
34658 starts at zero for the very first part (which is usually a multipart). The
34659 counter is per-message, so it is reset when processing RFC822 attachments (see
34660 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34661 complete, so you can use it in the DATA ACL to determine the number of MIME
34662 parts of a message. For non-MIME messages, this variable contains the value -1.
34663 .endlist
34664
34665
34666
34667 .section "Scanning with regular expressions" "SECTscanregex"
34668 .cindex "content scanning" "with regular expressions"
34669 .cindex "regular expressions" "content scanning with"
34670 You can specify your own custom regular expression matches on the full body of
34671 the message, or on individual MIME parts.
34672
34673 The &%regex%& condition takes one or more regular expressions as arguments and
34674 matches them against the full message (when called in the DATA ACL) or a raw
34675 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34676 linewise, with a maximum line length of 32K characters. That means you cannot
34677 have multiline matches with the &%regex%& condition.
34678
34679 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34680 to 32K of decoded content (the whole content at once, not linewise). If the
34681 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34682 is decoded automatically when &%mime_regex%& is executed (using default path
34683 and filename values). If the decoded data is larger than  32K, only the first
34684 32K characters are checked.
34685
34686 The regular expressions are passed as a colon-separated list. To include a
34687 literal colon, you must double it. Since the whole right-hand side string is
34688 expanded before being used, you must also escape dollar signs and backslashes
34689 with more backslashes, or use the &`\N`& facility to disable expansion.
34690 Here is a simple example that contains two regular expressions:
34691 .code
34692 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34693      message = contains blacklisted regex ($regex_match_string)
34694 .endd
34695 The conditions returns true if any one of the regular expressions matches. The
34696 &$regex_match_string$& expansion variable is then set up and contains the
34697 matching regular expression.
34698 The expansion variables &$regex1$& &$regex2$& etc
34699 are set to any substrings captured by the regular expression.
34700
34701 &*Warning*&: With large messages, these conditions can be fairly
34702 CPU-intensive.
34703
34704 .ecindex IIDcosca
34705
34706
34707
34708
34709 . ////////////////////////////////////////////////////////////////////////////
34710 . ////////////////////////////////////////////////////////////////////////////
34711
34712 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34713          "Local scan function"
34714 .scindex IIDlosca "&[local_scan()]& function" "description of"
34715 .cindex "customizing" "input scan using C function"
34716 .cindex "policy control" "by local scan function"
34717 In these days of email worms, viruses, and ever-increasing spam, some sites
34718 want to apply a lot of checking to messages before accepting them.
34719
34720 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34721 passing messages to external virus and spam scanning software. You can also do
34722 a certain amount in Exim itself through string expansions and the &%condition%&
34723 condition in the ACL that runs after the SMTP DATA command or the ACL for
34724 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34725
34726 To allow for further customization to a site's own requirements, there is the
34727 possibility of linking Exim with a private message scanning function, written
34728 in C. If you want to run code that is written in something other than C, you
34729 can of course use a little C stub to call it.
34730
34731 The local scan function is run once for every incoming message, at the point
34732 when Exim is just about to accept the message.
34733 It can therefore be used to control non-SMTP messages from local processes as
34734 well as messages arriving via SMTP.
34735
34736 Exim applies a timeout to calls of the local scan function, and there is an
34737 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34738 Zero means &"no timeout"&.
34739 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34740 before calling the local scan function, so that the most common types of crash
34741 are caught. If the timeout is exceeded or one of those signals is caught, the
34742 incoming message is rejected with a temporary error if it is an SMTP message.
34743 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34744 code. The incident is logged on the main and reject logs.
34745
34746
34747
34748 .section "Building Exim to use a local scan function" "SECID207"
34749 .cindex "&[local_scan()]& function" "building Exim to use"
34750 To make use of the local scan function feature, you must tell Exim where your
34751 function is before building Exim, by setting
34752 both HAVE_LOCAL_SCAN and
34753 LOCAL_SCAN_SOURCE in your
34754 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34755 directory, so you might set
34756 .code
34757 HAVE_LOCAL_SCAN=yes
34758 LOCAL_SCAN_SOURCE=Local/local_scan.c
34759 .endd
34760 for example. The function must be called &[local_scan()]&;
34761 the source file(s) for it should first #define LOCAL_SCAN
34762 and then #include "local_scan.h".
34763 It is called by
34764 Exim after it has received a message, when the success return code is about to
34765 be sent. This is after all the ACLs have been run. The return code from your
34766 function controls whether the message is actually accepted or not. There is a
34767 commented template function (that just accepts the message) in the file
34768 _src/local_scan.c_.
34769
34770 If you want to make use of Exim's runtime configuration file to set options
34771 for your &[local_scan()]& function, you must also set
34772 .code
34773 LOCAL_SCAN_HAS_OPTIONS=yes
34774 .endd
34775 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34776
34777
34778
34779
34780 .section "API for local_scan()" "SECTapiforloc"
34781 .cindex "&[local_scan()]& function" "API description"
34782 .cindex &%dlfunc%& "API description"
34783 You must include this line near the start of your code:
34784 .code
34785 #define LOCAL_SCAN
34786 #include "local_scan.h"
34787 .endd
34788 This header file defines a number of variables and other values, and the
34789 prototype for the function itself. Exim is coded to use unsigned char values
34790 almost exclusively, and one of the things this header defines is a shorthand
34791 for &`unsigned char`& called &`uschar`&.
34792 It also makes available the following macro definitions, to simplify casting character
34793 strings and pointers to character strings:
34794 .code
34795 #define CS   (char *)
34796 #define CCS  (const char *)
34797 #define CSS  (char **)
34798 #define US   (unsigned char *)
34799 #define CUS  (const unsigned char *)
34800 #define USS  (unsigned char **)
34801 .endd
34802 The function prototype for &[local_scan()]& is:
34803 .code
34804 extern int local_scan(int fd, uschar **return_text);
34805 .endd
34806 The arguments are as follows:
34807
34808 .ilist
34809 &%fd%& is a file descriptor for the file that contains the body of the message
34810 (the -D file). The file is open for reading and writing, but updating it is not
34811 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34812
34813 The descriptor is positioned at character 19 of the file, which is the first
34814 character of the body itself, because the first 19 characters are the message
34815 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34816 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34817 case this changes in some future version.
34818 .next
34819 &%return_text%& is an address which you can use to return a pointer to a text
34820 string at the end of the function. The value it points to on entry is NULL.
34821 .endlist
34822
34823 The function must return an &%int%& value which is one of the following macros:
34824
34825 .vlist
34826 .vitem &`LOCAL_SCAN_ACCEPT`&
34827 .vindex "&$local_scan_data$&"
34828 The message is accepted. If you pass back a string of text, it is saved with
34829 the message, and made available in the variable &$local_scan_data$&. No
34830 newlines are permitted (if there are any, they are turned into spaces) and the
34831 maximum length of text is 1000 characters.
34832
34833 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34834 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34835 queued without immediate delivery, and is frozen.
34836
34837 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34838 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34839 queued without immediate delivery.
34840
34841 .vitem &`LOCAL_SCAN_REJECT`&
34842 The message is rejected; the returned text is used as an error message which is
34843 passed back to the sender and which is also logged. Newlines are permitted &--
34844 they cause a multiline response for SMTP rejections, but are converted to
34845 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34846 used.
34847
34848 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34849 The message is temporarily rejected; the returned text is used as an error
34850 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34851 problem"& is used.
34852
34853 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34854 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34855 message is not written to the reject log. It has the effect of unsetting the
34856 &%rejected_header%& log selector for just this rejection. If
34857 &%rejected_header%& is already unset (see the discussion of the
34858 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34859 same as LOCAL_SCAN_REJECT.
34860
34861 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34862 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34863 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34864 .endlist
34865
34866 If the message is not being received by interactive SMTP, rejections are
34867 reported by writing to &%stderr%& or by sending an email, as configured by the
34868 &%-oe%& command line options.
34869
34870
34871
34872 .section "Configuration options for local_scan()" "SECTconoptloc"
34873 .cindex "&[local_scan()]& function" "configuration options"
34874 It is possible to have option settings in the main configuration file
34875 that set values in static variables in the &[local_scan()]& module. If you
34876 want to do this, you must have the line
34877 .code
34878 LOCAL_SCAN_HAS_OPTIONS=yes
34879 .endd
34880 in your &_Local/Makefile_& when you build Exim. (This line is in
34881 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34882 file, you must define static variables to hold the option values, and a table
34883 to define them.
34884
34885 The table must be a vector called &%local_scan_options%&, of type
34886 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34887 and a pointer to the variable that holds the value. The entries must appear in
34888 alphabetical order. Following &%local_scan_options%& you must also define a
34889 variable called &%local_scan_options_count%& that contains the number of
34890 entries in the table. Here is a short example, showing two kinds of option:
34891 .code
34892 static int my_integer_option = 42;
34893 static uschar *my_string_option = US"a default string";
34894
34895 optionlist local_scan_options[] = {
34896   { "my_integer", opt_int,       &my_integer_option },
34897   { "my_string",  opt_stringptr, &my_string_option }
34898 };
34899
34900 int local_scan_options_count =
34901   sizeof(local_scan_options)/sizeof(optionlist);
34902 .endd
34903 The values of the variables can now be changed from Exim's runtime
34904 configuration file by including a local scan section as in this example:
34905 .code
34906 begin local_scan
34907 my_integer = 99
34908 my_string = some string of text...
34909 .endd
34910 The available types of option data are as follows:
34911
34912 .vlist
34913 .vitem &*opt_bool*&
34914 This specifies a boolean (true/false) option. The address should point to a
34915 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34916 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34917 whether such a variable has been set at all, you can initialize it to
34918 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34919 values.)
34920
34921 .vitem &*opt_fixed*&
34922 This specifies a fixed point number, such as is used for load averages.
34923 The address should point to a variable of type &`int`&. The value is stored
34924 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34925
34926 .vitem &*opt_int*&
34927 This specifies an integer; the address should point to a variable of type
34928 &`int`&. The value may be specified in any of the integer formats accepted by
34929 Exim.
34930
34931 .vitem &*opt_mkint*&
34932 This is the same as &%opt_int%&, except that when such a value is output in a
34933 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34934 printed with the suffix K or M.
34935
34936 .vitem &*opt_octint*&
34937 This also specifies an integer, but the value is always interpreted as an
34938 octal integer, whether or not it starts with the digit zero, and it is
34939 always output in octal.
34940
34941 .vitem &*opt_stringptr*&
34942 This specifies a string value; the address must be a pointer to a
34943 variable that points to a string (for example, of type &`uschar *`&).
34944
34945 .vitem &*opt_time*&
34946 This specifies a time interval value. The address must point to a variable of
34947 type &`int`&. The value that is placed there is a number of seconds.
34948 .endlist
34949
34950 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34951 out the values of all the &[local_scan()]& options.
34952
34953
34954
34955 .section "Available Exim variables" "SECID208"
34956 .cindex "&[local_scan()]& function" "available Exim variables"
34957 The header &_local_scan.h_& gives you access to a number of C variables. These
34958 are the only ones that are guaranteed to be maintained from release to release.
34959 Note, however, that you can obtain the value of any Exim expansion variable,
34960 including &$recipients$&, by calling &'expand_string()'&. The exported
34961 C variables are as follows:
34962
34963 .vlist
34964 .vitem &*int&~body_linecount*&
34965 This variable contains the number of lines in the message's body.
34966 It is not valid if the &%spool_files_wireformat%& option is used.
34967
34968 .vitem &*int&~body_zerocount*&
34969 This variable contains the number of binary zero bytes in the message's body.
34970 It is not valid if the &%spool_files_wireformat%& option is used.
34971
34972 .vitem &*unsigned&~int&~debug_selector*&
34973 This variable is set to zero when no debugging is taking place. Otherwise, it
34974 is a bitmap of debugging selectors. Two bits are identified for use in
34975 &[local_scan()]&; they are defined as macros:
34976
34977 .ilist
34978 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34979 testing option that is not privileged &-- any caller may set it. All the
34980 other selector bits can be set only by admin users.
34981
34982 .next
34983 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34984 by the &`+local_scan`& debug selector. It is not included in the default set
34985 of debugging bits.
34986 .endlist ilist
34987
34988 Thus, to write to the debugging output only when &`+local_scan`& has been
34989 selected, you should use code like this:
34990 .code
34991 if ((debug_selector & D_local_scan) != 0)
34992   debug_printf("xxx", ...);
34993 .endd
34994 .vitem &*uschar&~*expand_string_message*&
34995 After a failing call to &'expand_string()'& (returned value NULL), the
34996 variable &%expand_string_message%& contains the error message, zero-terminated.
34997
34998 .vitem &*header_line&~*header_list*&
34999 A pointer to a chain of header lines. The &%header_line%& structure is
35000 discussed below.
35001
35002 .vitem &*header_line&~*header_last*&
35003 A pointer to the last of the header lines.
35004
35005 .vitem &*uschar&~*headers_charset*&
35006 The value of the &%headers_charset%& configuration option.
35007
35008 .vitem &*BOOL&~host_checking*&
35009 This variable is TRUE during a host checking session that is initiated by the
35010 &%-bh%& command line option.
35011
35012 .vitem &*uschar&~*interface_address*&
35013 The IP address of the interface that received the message, as a string. This
35014 is NULL for locally submitted messages.
35015
35016 .vitem &*int&~interface_port*&
35017 The port on which this message was received. When testing with the &%-bh%&
35018 command line option, the value of this variable is -1 unless a port has been
35019 specified via the &%-oMi%& option.
35020
35021 .vitem &*uschar&~*message_id*&
35022 This variable contains Exim's message id for the incoming message (the value of
35023 &$message_exim_id$&) as a zero-terminated string.
35024
35025 .vitem &*uschar&~*received_protocol*&
35026 The name of the protocol by which the message was received.
35027
35028 .vitem &*int&~recipients_count*&
35029 The number of accepted recipients.
35030
35031 .vitem &*recipient_item&~*recipients_list*&
35032 .cindex "recipient" "adding in local scan"
35033 .cindex "recipient" "removing in local scan"
35034 The list of accepted recipients, held in a vector of length
35035 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35036 can add additional recipients by calling &'receive_add_recipient()'& (see
35037 below). You can delete recipients by removing them from the vector and
35038 adjusting the value in &%recipients_count%&. In particular, by setting
35039 &%recipients_count%& to zero you remove all recipients. If you then return the
35040 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35041 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35042 and then call &'receive_add_recipient()'& as often as needed.
35043
35044 .vitem &*uschar&~*sender_address*&
35045 The envelope sender address. For bounce messages this is the empty string.
35046
35047 .vitem &*uschar&~*sender_host_address*&
35048 The IP address of the sending host, as a string. This is NULL for
35049 locally-submitted messages.
35050
35051 .vitem &*uschar&~*sender_host_authenticated*&
35052 The name of the authentication mechanism that was used, or NULL if the message
35053 was not received over an authenticated SMTP connection.
35054
35055 .vitem &*uschar&~*sender_host_name*&
35056 The name of the sending host, if known.
35057
35058 .vitem &*int&~sender_host_port*&
35059 The port on the sending host.
35060
35061 .vitem &*BOOL&~smtp_input*&
35062 This variable is TRUE for all SMTP input, including BSMTP.
35063
35064 .vitem &*BOOL&~smtp_batched_input*&
35065 This variable is TRUE for BSMTP input.
35066
35067 .vitem &*int&~store_pool*&
35068 The contents of this variable control which pool of memory is used for new
35069 requests. See section &<<SECTmemhanloc>>& for details.
35070 .endlist
35071
35072
35073 .section "Structure of header lines" "SECID209"
35074 The &%header_line%& structure contains the members listed below.
35075 You can add additional header lines by calling the &'header_add()'& function
35076 (see below). You can cause header lines to be ignored (deleted) by setting
35077 their type to *.
35078
35079
35080 .vlist
35081 .vitem &*struct&~header_line&~*next*&
35082 A pointer to the next header line, or NULL for the last line.
35083
35084 .vitem &*int&~type*&
35085 A code identifying certain headers that Exim recognizes. The codes are printing
35086 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35087 Notice in particular that any header line whose type is * is not transmitted
35088 with the message. This flagging is used for header lines that have been
35089 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35090 lines.) Effectively, * means &"deleted"&.
35091
35092 .vitem &*int&~slen*&
35093 The number of characters in the header line, including the terminating and any
35094 internal newlines.
35095
35096 .vitem &*uschar&~*text*&
35097 A pointer to the text of the header. It always ends with a newline, followed by
35098 a zero byte. Internal newlines are preserved.
35099 .endlist
35100
35101
35102
35103 .section "Structure of recipient items" "SECID210"
35104 The &%recipient_item%& structure contains these members:
35105
35106 .vlist
35107 .vitem &*uschar&~*address*&
35108 This is a pointer to the recipient address as it was received.
35109
35110 .vitem &*int&~pno*&
35111 This is used in later Exim processing when top level addresses are created by
35112 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35113 and must always contain -1 at this stage.
35114
35115 .vitem &*uschar&~*errors_to*&
35116 If this value is not NULL, bounce messages caused by failing to deliver to the
35117 recipient are sent to the address it contains. In other words, it overrides the
35118 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35119 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35120 an unqualified address, Exim qualifies it using the domain from
35121 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35122 is NULL for all recipients.
35123 .endlist
35124
35125
35126
35127 .section "Available Exim functions" "SECID211"
35128 .cindex "&[local_scan()]& function" "available Exim functions"
35129 The header &_local_scan.h_& gives you access to a number of Exim functions.
35130 These are the only ones that are guaranteed to be maintained from release to
35131 release:
35132
35133 .vlist
35134 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35135        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35136
35137 This function creates a child process that runs the command specified by
35138 &%argv%&. The environment for the process is specified by &%envp%&, which can
35139 be NULL if no environment variables are to be passed. A new umask is supplied
35140 for the process in &%newumask%&.
35141
35142 Pipes to the standard input and output of the new process are set up
35143 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35144 standard error is cloned to the standard output. If there are any file
35145 descriptors &"in the way"& in the new process, they are closed. If the final
35146 argument is TRUE, the new process is made into a process group leader.
35147
35148 The function returns the pid of the new process, or -1 if things go wrong.
35149
35150 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35151 This function waits for a child process to terminate, or for a timeout (in
35152 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35153 return value is as follows:
35154
35155 .ilist
35156 >= 0
35157
35158 The process terminated by a normal exit and the value is the process
35159 ending status.
35160
35161 .next
35162 < 0 and > &--256
35163
35164 The process was terminated by a signal and the value is the negation of the
35165 signal number.
35166
35167 .next
35168 &--256
35169
35170 The process timed out.
35171 .next
35172 &--257
35173
35174 The was some other error in wait(); &%errno%& is still set.
35175 .endlist
35176
35177 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35178 This function provide you with a means of submitting a new message to
35179 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35180 want, but this packages it all up for you.) The function creates a pipe,
35181 forks a subprocess that is running
35182 .code
35183 exim -t -oem -oi -f <>
35184 .endd
35185 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35186 that is connected to the standard input. The yield of the function is the PID
35187 of the subprocess. You can then write a message to the file descriptor, with
35188 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35189
35190 When you have finished, call &'child_close()'& to wait for the process to
35191 finish and to collect its ending status. A timeout value of zero is usually
35192 fine in this circumstance. Unless you have made a mistake with the recipient
35193 addresses, you should get a return code of zero.
35194
35195
35196 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35197        *sender_authentication)*&
35198 This function is a more sophisticated version of &'child_open()'&. The command
35199 that it runs is:
35200 .display
35201 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35202 .endd
35203 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35204
35205
35206 .vitem &*void&~debug_printf(char&~*,&~...)*&
35207 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35208 output is written to the standard error stream. If no debugging is selected,
35209 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35210 conditional on the &`local_scan`& debug selector by coding like this:
35211 .code
35212 if ((debug_selector & D_local_scan) != 0)
35213   debug_printf("xxx", ...);
35214 .endd
35215
35216 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35217 This is an interface to Exim's string expansion code. The return value is the
35218 expanded string, or NULL if there was an expansion failure.
35219 The C variable &%expand_string_message%& contains an error message after an
35220 expansion failure. If expansion does not change the string, the return value is
35221 the pointer to the input string. Otherwise, the return value points to a new
35222 block of memory that was obtained by a call to &'store_get()'&. See section
35223 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35224
35225 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35226 This function allows you to an add additional header line at the end of the
35227 existing ones. The first argument is the type, and should normally be a space
35228 character. The second argument is a format string and any number of
35229 substitution arguments as for &[sprintf()]&. You may include internal newlines
35230 if you want, and you must ensure that the string ends with a newline.
35231
35232 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35233         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35234 This function adds a new header line at a specified point in the header
35235 chain. The header itself is specified as for &'header_add()'&.
35236
35237 If &%name%& is NULL, the new header is added at the end of the chain if
35238 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35239 NULL, the header lines are searched for the first non-deleted header that
35240 matches the name. If one is found, the new header is added before it if
35241 &%after%& is false. If &%after%& is true, the new header is added after the
35242 found header and any adjacent subsequent ones with the same name (even if
35243 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35244 option controls where the header is added. If it is true, addition is at the
35245 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35246 headers, or at the top if there are no &'Received:'& headers, you could use
35247 .code
35248 header_add_at_position(TRUE, US"Received", TRUE,
35249   ' ', "X-xxx: ...");
35250 .endd
35251 Normally, there is always at least one non-deleted &'Received:'& header, but
35252 there may not be if &%received_header_text%& expands to an empty string.
35253
35254
35255 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35256 This function removes header lines. If &%occurrence%& is zero or negative, all
35257 occurrences of the header are removed. If occurrence is greater than zero, that
35258 particular instance of the header is removed. If no header(s) can be found that
35259 match the specification, the function does nothing.
35260
35261
35262 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35263         int&~length,&~BOOL&~notdel)*&"
35264 This function tests whether the given header has the given name. It is not just
35265 a string comparison, because white space is permitted between the name and the
35266 colon. If the &%notdel%& argument is true, a false return is forced for all
35267 &"deleted"& headers; otherwise they are not treated specially. For example:
35268 .code
35269 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35270 .endd
35271 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35272 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35273 This function base64-encodes a string, which is passed by address and length.
35274 The text may contain bytes of any value, including zero. The result is passed
35275 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35276 zero-terminated.
35277
35278 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35279 This function decodes a base64-encoded string. Its arguments are a
35280 zero-terminated base64-encoded string and the address of a variable that is set
35281 to point to the result, which is in dynamic memory. The length of the decoded
35282 string is the yield of the function. If the input is invalid base64 data, the
35283 yield is -1. A zero byte is added to the end of the output string to make it
35284 easy to interpret as a C string (assuming it contains no zeros of its own). The
35285 added zero byte is not included in the returned count.
35286
35287 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35288 This function checks for a match in a domain list. Domains are always
35289 matched caselessly. The return value is one of the following:
35290 .display
35291 &`OK     `& match succeeded
35292 &`FAIL   `& match failed
35293 &`DEFER  `& match deferred
35294 .endd
35295 DEFER is usually caused by some kind of lookup defer, such as the
35296 inability to contact a database.
35297
35298 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35299         BOOL&~caseless)*&"
35300 This function checks for a match in a local part list. The third argument
35301 controls case-sensitivity. The return values are as for
35302 &'lss_match_domain()'&.
35303
35304 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35305         BOOL&~caseless)*&"
35306 This function checks for a match in an address list. The third argument
35307 controls the case-sensitivity of the local part match. The domain is always
35308 matched caselessly. The return values are as for &'lss_match_domain()'&.
35309
35310 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35311         uschar&~*list)*&"
35312 This function checks for a match in a host list. The most common usage is
35313 expected to be
35314 .code
35315 lss_match_host(sender_host_name, sender_host_address, ...)
35316 .endd
35317 .vindex "&$sender_host_address$&"
35318 An empty address field matches an empty item in the host list. If the host name
35319 is NULL, the name corresponding to &$sender_host_address$& is automatically
35320 looked up if a host name is required to match an item in the list. The return
35321 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35322 returns ERROR in the case when it had to look up a host name, but the lookup
35323 failed.
35324
35325 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35326         *format,&~...)*&"
35327 This function writes to Exim's log files. The first argument should be zero (it
35328 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35329 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35330 them. It specifies to which log or logs the message is written. The remaining
35331 arguments are a format and relevant insertion arguments. The string should not
35332 contain any newlines, not even at the end.
35333
35334
35335 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35336 This function adds an additional recipient to the message. The first argument
35337 is the recipient address. If it is unqualified (has no domain), it is qualified
35338 with the &%qualify_recipient%& domain. The second argument must always be -1.
35339
35340 This function does not allow you to specify a private &%errors_to%& address (as
35341 described with the structure of &%recipient_item%& above), because it pre-dates
35342 the addition of that field to the structure. However, it is easy to add such a
35343 value afterwards. For example:
35344 .code
35345  receive_add_recipient(US"monitor@mydom.example", -1);
35346  recipients_list[recipients_count-1].errors_to =
35347    US"postmaster@mydom.example";
35348 .endd
35349
35350 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35351 This is a convenience function to remove a named recipient from the list of
35352 recipients. It returns true if a recipient was removed, and false if no
35353 matching recipient could be found. The argument must be a complete email
35354 address.
35355 .endlist
35356
35357
35358 .cindex "RFC 2047"
35359 .vlist
35360 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35361   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35362 This function decodes strings that are encoded according to RFC 2047. Typically
35363 these are the contents of header lines. First, each &"encoded word"& is decoded
35364 from the Q or B encoding into a byte-string. Then, if provided with the name of
35365 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35366 made  to translate the result to the named character set. If this fails, the
35367 binary string is returned with an error message.
35368
35369 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35370 maximum MIME word length is enforced. The third argument is the target
35371 encoding, or NULL if no translation is wanted.
35372
35373 .cindex "binary zero" "in RFC 2047 decoding"
35374 .cindex "RFC 2047" "binary zero in"
35375 If a binary zero is encountered in the decoded string, it is replaced by the
35376 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35377 not be 0 because header lines are handled as zero-terminated strings.
35378
35379 The function returns the result of processing the string, zero-terminated; if
35380 &%lenptr%& is not NULL, the length of the result is set in the variable to
35381 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35382
35383 If an error is encountered, the function returns NULL and uses the &%error%&
35384 argument to return an error message. The variable pointed to by &%error%& is
35385 set to NULL if there is no error; it may be set non-NULL even when the function
35386 returns a non-NULL value if decoding was successful, but there was a problem
35387 with translation.
35388
35389
35390 .vitem &*int&~smtp_fflush(void)*&
35391 This function is used in conjunction with &'smtp_printf()'&, as described
35392 below.
35393
35394 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35395 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35396 output stream. You should use this function only when there is an SMTP output
35397 stream, that is, when the incoming message is being received via interactive
35398 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35399 is FALSE. If you want to test for an incoming message from another host (as
35400 opposed to a local process that used the &%-bs%& command line option), you can
35401 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35402 is involved.
35403
35404 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35405 output function, so it can be used for all forms of SMTP connection.
35406
35407 The second argument is used to request that the data be buffered
35408 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35409 This is advisory only, but likely to save on system-calls and packets
35410 sent when a sequence of calls to the function are made.
35411
35412 The argument was added in Exim version 4.90 - changing the API/ABI.
35413 Nobody noticed until 4.93 was imminent, at which point the
35414 ABI version number was incremented.
35415
35416 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35417 must start with an appropriate response code: 550 if you are going to return
35418 LOCAL_SCAN_REJECT, 451 if you are going to return
35419 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35420 initial lines of a multi-line response, the code must be followed by a hyphen
35421 to indicate that the line is not the final response line. You must also ensure
35422 that the lines you write terminate with CRLF. For example:
35423 .code
35424 smtp_printf("550-this is some extra info\r\n");
35425 return LOCAL_SCAN_REJECT;
35426 .endd
35427 Note that you can also create multi-line responses by including newlines in
35428 the data returned via the &%return_text%& argument. The added value of using
35429 &'smtp_printf()'& is that, for instance, you could introduce delays between
35430 multiple output lines.
35431
35432 The &'smtp_printf()'& function does not return any error indication, because it
35433 does not
35434 guarantee a flush of
35435 pending output, and therefore does not test
35436 the state of the stream. (In the main code of Exim, flushing and error
35437 detection is done when Exim is ready for the next SMTP input command.) If
35438 you want to flush the output and check for an error (for example, the
35439 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35440 arguments. It flushes the output stream, and returns a non-zero value if there
35441 is an error.
35442
35443 .vitem &*void&~*store_get(int,BOOL)*&
35444 This function accesses Exim's internal store (memory) manager. It gets a new
35445 chunk of memory whose size is given by the first argument.
35446 The second argument should be given as TRUE if the memory will be used for
35447 data possibly coming from an attacker (eg. the message content),
35448 FALSE if it is locally-sourced.
35449 Exim bombs out if it ever
35450 runs out of memory. See the next section for a discussion of memory handling.
35451
35452 .vitem &*void&~*store_get_perm(int,BOOL)*&
35453 This function is like &'store_get()'&, but it always gets memory from the
35454 permanent pool. See the next section for a discussion of memory handling.
35455
35456 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35457 See below.
35458
35459 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35460 See below.
35461
35462 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35463 These three functions create strings using Exim's dynamic memory facilities.
35464 The first makes a copy of an entire string. The second copies up to a maximum
35465 number of characters, indicated by the second argument. The third uses a format
35466 and insertion arguments to create a new string. In each case, the result is a
35467 pointer to a new string in the current memory pool. See the next section for
35468 more discussion.
35469 .endlist
35470
35471
35472
35473 .section "More about Exim's memory handling" "SECTmemhanloc"
35474 .cindex "&[local_scan()]& function" "memory handling"
35475 No function is provided for freeing memory, because that is never needed.
35476 The dynamic memory that Exim uses when receiving a message is automatically
35477 recycled if another message is received by the same process (this applies only
35478 to incoming SMTP connections &-- other input methods can supply only one
35479 message at a time). After receiving the last message, a reception process
35480 terminates.
35481
35482 Because it is recycled, the normal dynamic memory cannot be used for holding
35483 data that must be preserved over a number of incoming messages on the same SMTP
35484 connection. However, Exim in fact uses two pools of dynamic memory; the second
35485 one is not recycled, and can be used for this purpose.
35486
35487 If you want to allocate memory that remains available for subsequent messages
35488 in the same SMTP connection, you should set
35489 .code
35490 store_pool = POOL_PERM
35491 .endd
35492 before calling the function that does the allocation. There is no need to
35493 restore the value if you do not need to; however, if you do want to revert to
35494 the normal pool, you can either restore the previous value of &%store_pool%& or
35495 set it explicitly to POOL_MAIN.
35496
35497 The pool setting applies to all functions that get dynamic memory, including
35498 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35499 There is also a convenience function called &'store_get_perm()'& that gets a
35500 block of memory from the permanent pool while preserving the value of
35501 &%store_pool%&.
35502 .ecindex IIDlosca
35503
35504
35505
35506
35507 . ////////////////////////////////////////////////////////////////////////////
35508 . ////////////////////////////////////////////////////////////////////////////
35509
35510 .chapter "System-wide message filtering" "CHAPsystemfilter"
35511 .scindex IIDsysfil1 "filter" "system filter"
35512 .scindex IIDsysfil2 "filtering all mail"
35513 .scindex IIDsysfil3 "system filter"
35514 The previous chapters (on ACLs and the local scan function) describe checks
35515 that can be applied to messages before they are accepted by a host. There is
35516 also a mechanism for checking messages once they have been received, but before
35517 they are delivered. This is called the &'system filter'&.
35518
35519 The system filter operates in a similar manner to users' filter files, but it
35520 is run just once per message (however many recipients the message has).
35521 It should not normally be used as a substitute for routing, because &%deliver%&
35522 commands in a system router provide new envelope recipient addresses.
35523 The system filter must be an Exim filter. It cannot be a Sieve filter.
35524
35525 The system filter is run at the start of a delivery attempt, before any routing
35526 is done. If a message fails to be completely delivered at the first attempt,
35527 the system filter is run again at the start of every retry.
35528 If you want your filter to do something only once per message, you can make use
35529 of the &%first_delivery%& condition in an &%if%& command in the filter to
35530 prevent it happening on retries.
35531
35532 .vindex "&$domain$&"
35533 .vindex "&$local_part$&"
35534 &*Warning*&: Because the system filter runs just once, variables that are
35535 specific to individual recipient addresses, such as &$local_part$& and
35536 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35537 you want to run a centrally-specified filter for each recipient address
35538 independently, you can do so by setting up a suitable &(redirect)& router, as
35539 described in section &<<SECTperaddfil>>& below.
35540
35541
35542 .section "Specifying a system filter" "SECID212"
35543 .cindex "uid (user id)" "system filter"
35544 .cindex "gid (group id)" "system filter"
35545 The name of the file that contains the system filter must be specified by
35546 setting &%system_filter%&. If you want the filter to run under a uid and gid
35547 other than root, you must also set &%system_filter_user%& and
35548 &%system_filter_group%& as appropriate. For example:
35549 .code
35550 system_filter = /etc/mail/exim.filter
35551 system_filter_user = exim
35552 .endd
35553 If a system filter generates any deliveries directly to files or pipes (via the
35554 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35555 specified by setting &%system_filter_file_transport%& and
35556 &%system_filter_pipe_transport%&, respectively. Similarly,
35557 &%system_filter_reply_transport%& must be set to handle any messages generated
35558 by the &%reply%& command.
35559
35560
35561 .section "Testing a system filter" "SECID213"
35562 You can run simple tests of a system filter in the same way as for a user
35563 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35564 are permitted only in system filters are recognized.
35565
35566 If you want to test the combined effect of a system filter and a user filter,
35567 you can use both &%-bF%& and &%-bf%& on the same command line.
35568
35569
35570
35571 .section "Contents of a system filter" "SECID214"
35572 The language used to specify system filters is the same as for users' filter
35573 files. It is described in the separate end-user document &'Exim's interface to
35574 mail filtering'&. However, there are some additional features that are
35575 available only in system filters; these are described in subsequent sections.
35576 If they are encountered in a user's filter file or when testing with &%-bf%&,
35577 they cause errors.
35578
35579 .cindex "frozen messages" "manual thaw; testing in filter"
35580 There are two special conditions which, though available in users' filter
35581 files, are designed for use in system filters. The condition &%first_delivery%&
35582 is true only for the first attempt at delivering a message, and
35583 &%manually_thawed%& is true only if the message has been frozen, and
35584 subsequently thawed by an admin user. An explicit forced delivery counts as a
35585 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35586
35587 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35588 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35589 succeed, it will not be tried again.
35590 If you want Exim to retry an unseen delivery until it succeeds, you should
35591 arrange to set it up every time the filter runs.
35592
35593 When a system filter finishes running, the values of the variables &$n0$& &--
35594 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35595 users' filter files. Thus a system filter can, for example, set up &"scores"&
35596 to which users' filter files can refer.
35597
35598
35599
35600 .section "Additional variable for system filters" "SECID215"
35601 .vindex "&$recipients$&"
35602 The expansion variable &$recipients$&, containing a list of all the recipients
35603 of the message (separated by commas and white space), is available in system
35604 filters. It is not available in users' filters for privacy reasons.
35605
35606
35607
35608 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35609 .cindex "freezing messages"
35610 .cindex "message" "freezing"
35611 .cindex "message" "forced failure"
35612 .cindex "&%fail%&" "in system filter"
35613 .cindex "&%freeze%& in system filter"
35614 .cindex "&%defer%& in system filter"
35615 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35616 always available in system filters, but are not normally enabled in users'
35617 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35618 for the &(redirect)& router.) These commands can optionally be followed by the
35619 word &%text%& and a string containing an error message, for example:
35620 .code
35621 fail text "this message looks like spam to me"
35622 .endd
35623 The keyword &%text%& is optional if the next character is a double quote.
35624
35625 The &%defer%& command defers delivery of the original recipients of the
35626 message. The &%fail%& command causes all the original recipients to be failed,
35627 and a bounce message to be created. The &%freeze%& command suspends all
35628 delivery attempts for the original recipients. In all cases, any new deliveries
35629 that are specified by the filter are attempted as normal after the filter has
35630 run.
35631
35632 The &%freeze%& command is ignored if the message has been manually unfrozen and
35633 not manually frozen since. This means that automatic freezing by a system
35634 filter can be used as a way of checking out suspicious messages. If a message
35635 is found to be all right, manually unfreezing it allows it to be delivered.
35636
35637 .cindex "log" "&%fail%& command log line"
35638 .cindex "&%fail%&" "log line; reducing"
35639 The text given with a fail command is used as part of the bounce message as
35640 well as being written to the log. If the message is quite long, this can fill
35641 up a lot of log space when such failures are common. To reduce the size of the
35642 log message, Exim interprets the text in a special way if it starts with the
35643 two characters &`<<`& and contains &`>>`& later. The text between these two
35644 strings is written to the log, and the rest of the text is used in the bounce
35645 message. For example:
35646 .code
35647 fail "<<filter test 1>>Your message is rejected \
35648      because it contains attachments that we are \
35649      not prepared to receive."
35650 .endd
35651
35652 .cindex "loop" "caused by &%fail%&"
35653 Take great care with the &%fail%& command when basing the decision to fail on
35654 the contents of the message, because the bounce message will of course include
35655 the contents of the original message and will therefore trigger the &%fail%&
35656 command again (causing a mail loop) unless steps are taken to prevent this.
35657 Testing the &%error_message%& condition is one way to prevent this. You could
35658 use, for example
35659 .code
35660 if $message_body contains "this is spam" and not error_message
35661 then fail text "spam is not wanted here" endif
35662 .endd
35663 though of course that might let through unwanted bounce messages. The
35664 alternative is clever checking of the body and/or headers to detect bounces
35665 generated by the filter.
35666
35667 The interpretation of a system filter file ceases after a
35668 &%defer%&,
35669 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35670 set up earlier in the filter file are honoured, so you can use a sequence such
35671 as
35672 .code
35673 mail ...
35674 freeze
35675 .endd
35676 to send a specified message when the system filter is freezing (or deferring or
35677 failing) a message. The normal deliveries for the message do not, of course,
35678 take place.
35679
35680
35681
35682 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35683 .cindex "header lines" "adding; in system filter"
35684 .cindex "header lines" "removing; in system filter"
35685 .cindex "filter" "header lines; adding/removing"
35686 Two filter commands that are available only in system filters are:
35687 .code
35688 headers add <string>
35689 headers remove <string>
35690 .endd
35691 The argument for the &%headers add%& is a string that is expanded and then
35692 added to the end of the message's headers. It is the responsibility of the
35693 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35694 space is ignored, and if the string is otherwise empty, or if the expansion is
35695 forced to fail, the command has no effect.
35696
35697 You can use &"\n"& within the string, followed by white space, to specify
35698 continued header lines. More than one header may be added in one command by
35699 including &"\n"& within the string without any following white space. For
35700 example:
35701 .code
35702 headers add "X-header-1: ....\n  \
35703              continuation of X-header-1 ...\n\
35704              X-header-2: ...."
35705 .endd
35706 Note that the header line continuation white space after the first newline must
35707 be placed before the backslash that continues the input string, because white
35708 space after input continuations is ignored.
35709
35710 The argument for &%headers remove%& is a colon-separated list of header names.
35711 This command applies only to those headers that are stored with the message;
35712 those that are added at delivery time (such as &'Envelope-To:'& and
35713 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35714 header with the same name, they are all removed.
35715
35716 The &%headers%& command in a system filter makes an immediate change to the set
35717 of header lines that was received with the message (with possible additions
35718 from ACL processing). Subsequent commands in the system filter operate on the
35719 modified set, which also forms the basis for subsequent message delivery.
35720 Unless further modified during routing or transporting, this set of headers is
35721 used for all recipients of the message.
35722
35723 During routing and transporting, the variables that refer to the contents of
35724 header lines refer only to those lines that are in this set. Thus, header lines
35725 that are added by a system filter are visible to users' filter files and to all
35726 routers and transports. This contrasts with the manipulation of header lines by
35727 routers and transports, which is not immediate, but which instead is saved up
35728 until the message is actually being written (see section
35729 &<<SECTheadersaddrem>>&).
35730
35731 If the message is not delivered at the first attempt, header lines that were
35732 added by the system filter are stored with the message, and so are still
35733 present at the next delivery attempt. Header lines that were removed are still
35734 present, but marked &"deleted"& so that they are not transported with the
35735 message. For this reason, it is usual to make the &%headers%& command
35736 conditional on &%first_delivery%& so that the set of header lines is not
35737 modified more than once.
35738
35739 Because header modification in a system filter acts immediately, you have to
35740 use an indirect approach if you want to modify the contents of a header line.
35741 For example:
35742 .code
35743 headers add "Old-Subject: $h_subject:"
35744 headers remove "Subject"
35745 headers add "Subject: new subject (was: $h_old-subject:)"
35746 headers remove "Old-Subject"
35747 .endd
35748
35749
35750
35751 .section "Setting an errors address in a system filter" "SECID217"
35752 .cindex "envelope from"
35753 .cindex "envelope sender"
35754 In a system filter, if a &%deliver%& command is followed by
35755 .code
35756 errors_to <some address>
35757 .endd
35758 in order to change the envelope sender (and hence the error reporting) for that
35759 delivery, any address may be specified. (In a user filter, only the current
35760 user's address can be set.) For example, if some mail is being monitored, you
35761 might use
35762 .code
35763 unseen deliver monitor@spying.example errors_to root@local.example
35764 .endd
35765 to take a copy which would not be sent back to the normal error reporting
35766 address if its delivery failed.
35767
35768
35769
35770 .section "Per-address filtering" "SECTperaddfil"
35771 .vindex "&$domain_data$&"
35772 .vindex "&$local_part_data$&"
35773 In contrast to the system filter, which is run just once per message for each
35774 delivery attempt, it is also possible to set up a system-wide filtering
35775 operation that runs once for each recipient address. In this case, variables
35776 such as &$local_part_data$& and &$domain_data$& can be used,
35777 and indeed, the choice of filter file could be made dependent on them.
35778 This is an example of a router which implements such a filter:
35779 .code
35780 central_filter:
35781   check_local_user
35782   driver = redirect
35783   domains = +local_domains
35784   file = /central/filters/$local_part_data
35785   no_verify
35786   allow_filter
35787   allow_freeze
35788 .endd
35789 The filter is run in a separate process under its own uid. Therefore, either
35790 &%check_local_user%& must be set (as above), in which case the filter is run as
35791 the local user, or the &%user%& option must be used to specify which user to
35792 use. If both are set, &%user%& overrides.
35793
35794 Care should be taken to ensure that none of the commands in the filter file
35795 specify a significant delivery if the message is to go on to be delivered to
35796 its intended recipient. The router will not then claim to have dealt with the
35797 address, so it will be passed on to subsequent routers to be delivered in the
35798 normal way.
35799 .ecindex IIDsysfil1
35800 .ecindex IIDsysfil2
35801 .ecindex IIDsysfil3
35802
35803
35804
35805
35806
35807
35808 . ////////////////////////////////////////////////////////////////////////////
35809 . ////////////////////////////////////////////////////////////////////////////
35810
35811 .chapter "Message processing" "CHAPmsgproc"
35812 .scindex IIDmesproc "message" "general processing"
35813 Exim performs various transformations on the sender and recipient addresses of
35814 all messages that it handles, and also on the messages' header lines. Some of
35815 these are optional and configurable, while others always take place. All of
35816 this processing, except rewriting as a result of routing, and the addition or
35817 removal of header lines while delivering, happens when a message is received,
35818 before it is placed on Exim's queue.
35819
35820 Some of the automatic processing takes place by default only for
35821 &"locally-originated"& messages. This adjective is used to describe messages
35822 that are not received over TCP/IP, but instead are passed to an Exim process on
35823 its standard input. This includes the interactive &"local SMTP"& case that is
35824 set up by the &%-bs%& command line option.
35825
35826 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35827 or ::1) are not considered to be locally-originated. Exim does not treat the
35828 loopback interface specially in any way.
35829
35830 If you want the loopback interface to be treated specially, you must ensure
35831 that there are appropriate entries in your ACLs.
35832
35833
35834
35835
35836 .section "Submission mode for non-local messages" "SECTsubmodnon"
35837 .cindex "message" "submission"
35838 .cindex "submission mode"
35839 Processing that happens automatically for locally-originated messages (unless
35840 &%suppress_local_fixups%& is set) can also be requested for messages that are
35841 received over TCP/IP. The term &"submission mode"& is used to describe this
35842 state. Submission mode is set by the modifier
35843 .code
35844 control = submission
35845 .endd
35846 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35847 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35848 a local submission, and is normally used when the source of the message is
35849 known to be an MUA running on a client host (as opposed to an MTA). For
35850 example, to set submission mode for messages originating on the IPv4 loopback
35851 interface, you could include the following in the MAIL ACL:
35852 .code
35853 warn  hosts = 127.0.0.1
35854       control = submission
35855 .endd
35856 .cindex "&%sender_retain%& submission option"
35857 There are some options that can be used when setting submission mode. A slash
35858 is used to separate options. For example:
35859 .code
35860 control = submission/sender_retain
35861 .endd
35862 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35863 true and &%local_from_check%& false for the current incoming message. The first
35864 of these allows an existing &'Sender:'& header in the message to remain, and
35865 the second suppresses the check to ensure that &'From:'& matches the
35866 authenticated sender. With this setting, Exim still fixes up messages by adding
35867 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35868 attempt to check sender authenticity in header lines.
35869
35870 When &%sender_retain%& is not set, a submission mode setting may specify a
35871 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35872 example:
35873 .code
35874 control = submission/domain=some.domain
35875 .endd
35876 The domain may be empty. How this value is used is described in sections
35877 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35878 that allows you to specify the user's full name for inclusion in a created
35879 &'Sender:'& or &'From:'& header line. For example:
35880 .code
35881 accept authenticated = *
35882        control = submission/domain=wonderland.example/\
35883                             name=${lookup {$authenticated_id} \
35884                                    lsearch {/etc/exim/namelist}}
35885 .endd
35886 Because the name may contain any characters, including slashes, the &%name%&
35887 option must be given last. The remainder of the string is used as the name. For
35888 the example above, if &_/etc/exim/namelist_& contains:
35889 .code
35890 bigegg:  Humpty Dumpty
35891 .endd
35892 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35893 line would be:
35894 .code
35895 Sender: Humpty Dumpty <bigegg@wonderland.example>
35896 .endd
35897 .cindex "return path" "in submission mode"
35898 By default, submission mode forces the return path to the same address as is
35899 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35900 specified, the return path is also left unchanged.
35901
35902 &*Note*&: The changes caused by submission mode take effect after the predata
35903 ACL. This means that any sender checks performed before the fix-ups use the
35904 untrusted sender address specified by the user, not the trusted sender address
35905 specified by submission mode. Although this might be slightly unexpected, it
35906 does mean that you can configure ACL checks to spot that a user is trying to
35907 spoof another's address.
35908
35909 .section "Line endings" "SECTlineendings"
35910 .cindex "line endings"
35911 .cindex "carriage return"
35912 .cindex "linefeed"
35913 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35914 linefeed) is the line ending for messages transmitted over the Internet using
35915 SMTP over TCP/IP. However, within individual operating systems, different
35916 conventions are used. For example, Unix-like systems use just LF, but others
35917 use CRLF or just CR.
35918
35919 Exim was designed for Unix-like systems, and internally, it stores messages
35920 using the system's convention of a single LF as a line terminator. When
35921 receiving a message, all line endings are translated to this standard format.
35922 Originally, it was thought that programs that passed messages directly to an
35923 MTA within an operating system would use that system's convention. Experience
35924 has shown that this is not the case; for example, there are Unix applications
35925 that use CRLF in this circumstance. For this reason, and for compatibility with
35926 other MTAs, the way Exim handles line endings for all messages is now as
35927 follows:
35928
35929 .ilist
35930 LF not preceded by CR is treated as a line ending.
35931 .next
35932 CR is treated as a line ending; if it is immediately followed by LF, the LF
35933 is ignored.
35934 .next
35935 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35936 nor a local message in the state where a line containing only a dot is a
35937 terminator.
35938 .next
35939 If a bare CR is encountered within a header line, an extra space is added after
35940 the line terminator so as not to end the header line. The reasoning behind this
35941 is that bare CRs in header lines are most likely either to be mistakes, or
35942 people trying to play silly games.
35943 .next
35944 If the first header line received in a message ends with CRLF, a subsequent
35945 bare LF in a header line is treated in the same way as a bare CR in a header
35946 line.
35947 .endlist
35948
35949
35950
35951
35952
35953 .section "Unqualified addresses" "SECID218"
35954 .cindex "unqualified addresses"
35955 .cindex "address" "qualification"
35956 By default, Exim expects every envelope address it receives from an external
35957 host to be fully qualified. Unqualified addresses cause negative responses to
35958 SMTP commands. However, because SMTP is used as a means of transporting
35959 messages from MUAs running on personal workstations, there is sometimes a
35960 requirement to accept unqualified addresses from specific hosts or IP networks.
35961
35962 Exim has two options that separately control which hosts may send unqualified
35963 sender or recipient addresses in SMTP commands, namely
35964 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35965 cases, if an unqualified address is accepted, it is qualified by adding the
35966 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35967
35968 .oindex "&%qualify_domain%&"
35969 .oindex "&%qualify_recipient%&"
35970 Unqualified addresses in header lines are automatically qualified for messages
35971 that are locally originated, unless the &%-bnq%& option is given on the command
35972 line. For messages received over SMTP, unqualified addresses in header lines
35973 are qualified only if unqualified addresses are permitted in SMTP commands. In
35974 other words, such qualification is also controlled by
35975 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35976
35977
35978
35979
35980 .section "The UUCP From line" "SECID219"
35981 .cindex "&""From""& line"
35982 .cindex "UUCP" "&""From""& line"
35983 .cindex "sender" "address"
35984 .oindex "&%uucp_from_pattern%&"
35985 .oindex "&%uucp_from_sender%&"
35986 .cindex "envelope from"
35987 .cindex "envelope sender"
35988 .cindex "Sendmail compatibility" "&""From""& line"
35989 Messages that have come from UUCP (and some other applications) often begin
35990 with a line containing the envelope sender and a timestamp, following the word
35991 &"From"&. Examples of two common formats are:
35992 .code
35993 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35994 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35995 .endd
35996 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35997 Exim recognizes such lines at the start of messages that are submitted to it
35998 via the command line (that is, on the standard input). It does not recognize
35999 such lines in incoming SMTP messages, unless the sending host matches
36000 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36001 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36002 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36003 default value matches the two common cases shown above and puts the address
36004 that follows &"From"& into &$1$&.
36005
36006 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36007 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36008 a trusted user, the message's sender address is constructed by expanding the
36009 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36010 then parsed as an RFC 2822 address. If there is no domain, the local part is
36011 qualified with &%qualify_domain%& unless it is the empty string. However, if
36012 the command line &%-f%& option is used, it overrides the &"From"& line.
36013
36014 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36015 sender address is not changed. This is also the case for incoming SMTP messages
36016 that are permitted to contain &"From"& lines.
36017
36018 Only one &"From"& line is recognized. If there is more than one, the second is
36019 treated as a data line that starts the body of the message, as it is not valid
36020 as a header line. This also happens if a &"From"& line is present in an
36021 incoming SMTP message from a source that is not permitted to send them.
36022
36023
36024
36025 .section "Resent- header lines" "SECID220"
36026 .cindex "&%Resent-%& header lines"
36027 .cindex "header lines" "Resent-"
36028 RFC 2822 makes provision for sets of header lines starting with the string
36029 &`Resent-`& to be added to a message when it is resent by the original
36030 recipient to somebody else. These headers are &'Resent-Date:'&,
36031 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36032 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36033
36034 .blockquote
36035 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36036 processing of replies or other such automatic actions on messages.'&
36037 .endblockquote
36038
36039 This leaves things a bit vague as far as other processing actions such as
36040 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36041 follows:
36042
36043 .ilist
36044 A &'Resent-From:'& line that just contains the login id of the submitting user
36045 is automatically rewritten in the same way as &'From:'& (see below).
36046 .next
36047 If there's a rewriting rule for a particular header line, it is also applied to
36048 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36049 &'From:'& also rewrites &'Resent-From:'&.
36050 .next
36051 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36052 also removed.
36053 .next
36054 For a locally-submitted message,
36055 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36056 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36057 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36058 included in log lines in this case.
36059 .next
36060 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36061 &%Resent-%& header lines are present.
36062 .endlist
36063
36064
36065
36066
36067 .section "The Auto-Submitted: header line" "SECID221"
36068 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36069 includes the header line:
36070 .code
36071 Auto-Submitted: auto-replied
36072 .endd
36073
36074 .section "The Bcc: header line" "SECID222"
36075 .cindex "&'Bcc:'& header line"
36076 If Exim is called with the &%-t%& option, to take recipient addresses from a
36077 message's header, it removes any &'Bcc:'& header line that may exist (after
36078 extracting its addresses). If &%-t%& is not present on the command line, any
36079 existing &'Bcc:'& is not removed.
36080
36081
36082 .section "The Date: header line" "SECID223"
36083 .cindex "&'Date:'& header line"
36084 .cindex "header lines" "Date:"
36085 If a locally-generated or submission-mode message has no &'Date:'& header line,
36086 Exim adds one, using the current date and time, unless the
36087 &%suppress_local_fixups%& control has been specified.
36088
36089 .section "The Delivery-date: header line" "SECID224"
36090 .cindex "&'Delivery-date:'& header line"
36091 .oindex "&%delivery_date_remove%&"
36092 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36093 set. Exim can be configured to add them to the final delivery of messages. (See
36094 the generic &%delivery_date_add%& transport option.) They should not be present
36095 in messages in transit. If the &%delivery_date_remove%& configuration option is
36096 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36097 messages.
36098
36099
36100 .section "The Envelope-to: header line" "SECID225"
36101 .cindex "&'Envelope-to:'& header line"
36102 .cindex "header lines" "Envelope-to:"
36103 .oindex "&%envelope_to_remove%&"
36104 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36105 Exim can be configured to add them to the final delivery of messages. (See the
36106 generic &%envelope_to_add%& transport option.) They should not be present in
36107 messages in transit. If the &%envelope_to_remove%& configuration option is set
36108 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36109 messages.
36110
36111
36112 .section "The From: header line" "SECTthefrohea"
36113 .cindex "&'From:'& header line"
36114 .cindex "header lines" "From:"
36115 .cindex "Sendmail compatibility" "&""From""& line"
36116 .cindex "message" "submission"
36117 .cindex "submission mode"
36118 If a submission-mode message does not contain a &'From:'& header line, Exim
36119 adds one if either of the following conditions is true:
36120
36121 .ilist
36122 The envelope sender address is not empty (that is, this is not a bounce
36123 message). The added header line copies the envelope sender address.
36124 .next
36125 .vindex "&$authenticated_id$&"
36126 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36127 .olist
36128 .vindex "&$qualify_domain$&"
36129 If no domain is specified by the submission control, the local part is
36130 &$authenticated_id$& and the domain is &$qualify_domain$&.
36131 .next
36132 If a non-empty domain is specified by the submission control, the local
36133 part is &$authenticated_id$&, and the domain is the specified domain.
36134 .next
36135 If an empty domain is specified by the submission control,
36136 &$authenticated_id$& is assumed to be the complete address.
36137 .endlist
36138 .endlist
36139
36140 A non-empty envelope sender takes precedence.
36141
36142 If a locally-generated incoming message does not contain a &'From:'& header
36143 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36144 containing the sender's address. The calling user's login name and full name
36145 are used to construct the address, as described in section &<<SECTconstr>>&.
36146 They are obtained from the password data by calling &[getpwuid()]& (but see the
36147 &%unknown_login%& configuration option). The address is qualified with
36148 &%qualify_domain%&.
36149
36150 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36151 &'From:'& header line containing just the unqualified login name of the calling
36152 user, this is replaced by an address containing the user's login name and full
36153 name as described in section &<<SECTconstr>>&.
36154
36155
36156 .section "The Message-ID: header line" "SECID226"
36157 .cindex "&'Message-ID:'& header line"
36158 .cindex "header lines" "Message-ID:"
36159 .cindex "message" "submission"
36160 .oindex "&%message_id_header_text%&"
36161 If a locally-generated or submission-mode incoming message does not contain a
36162 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36163 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36164 to the message. If there are any &'Resent-:'& headers in the message, it
36165 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36166 message id, preceded by the letter E to ensure it starts with a letter, and
36167 followed by @ and the primary host name. Additional information can be included
36168 in this header line by setting the &%message_id_header_text%& and/or
36169 &%message_id_header_domain%& options.
36170
36171
36172 .section "The Received: header line" "SECID227"
36173 .cindex "&'Received:'& header line"
36174 .cindex "header lines" "Received:"
36175 A &'Received:'& header line is added at the start of every message. The
36176 contents are defined by the &%received_header_text%& configuration option, and
36177 Exim automatically adds a semicolon and a timestamp to the configured string.
36178
36179 The &'Received:'& header is generated as soon as the message's header lines
36180 have been received. At this stage, the timestamp in the &'Received:'& header
36181 line is the time that the message started to be received. This is the value
36182 that is seen by the DATA ACL and by the &[local_scan()]& function.
36183
36184 Once a message is accepted, the timestamp in the &'Received:'& header line is
36185 changed to the time of acceptance, which is (apart from a small delay while the
36186 -H spool file is written) the earliest time at which delivery could start.
36187
36188
36189 .section "The References: header line" "SECID228"
36190 .cindex "&'References:'& header line"
36191 .cindex "header lines" "References:"
36192 Messages created by the &(autoreply)& transport include a &'References:'&
36193 header line. This is constructed according to the rules that are described in
36194 section 3.64 of RFC 2822 (which states that replies should contain such a
36195 header line), and section 3.14 of RFC 3834 (which states that automatic
36196 responses are not different in this respect). However, because some mail
36197 processing software does not cope well with very long header lines, no more
36198 than 12 message IDs are copied from the &'References:'& header line in the
36199 incoming message. If there are more than 12, the first one and then the final
36200 11 are copied, before adding the message ID of the incoming message.
36201
36202
36203
36204 .section "The Return-path: header line" "SECID229"
36205 .cindex "&'Return-path:'& header line"
36206 .cindex "header lines" "Return-path:"
36207 .oindex "&%return_path_remove%&"
36208 &'Return-path:'& header lines are defined as something an MTA may insert when
36209 it does the final delivery of messages. (See the generic &%return_path_add%&
36210 transport option.) Therefore, they should not be present in messages in
36211 transit. If the &%return_path_remove%& configuration option is set (the
36212 default), Exim removes &'Return-path:'& header lines from incoming messages.
36213
36214
36215
36216 .section "The Sender: header line" "SECTthesenhea"
36217 .cindex "&'Sender:'& header line"
36218 .cindex "message" "submission"
36219 .cindex "header lines" "Sender:"
36220 For a locally-originated message from an untrusted user, Exim may remove an
36221 existing &'Sender:'& header line, and it may add a new one. You can modify
36222 these actions by setting the &%local_sender_retain%& option true, the
36223 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36224 control setting.
36225
36226 When a local message is received from an untrusted user and
36227 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36228 control has not been set, a check is made to see if the address given in the
36229 &'From:'& header line is the correct (local) sender of the message. The address
36230 that is expected has the login name as the local part and the value of
36231 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36232 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36233 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36234 line is added to the message.
36235
36236 If you set &%local_from_check%& false, this checking does not occur. However,
36237 the removal of an existing &'Sender:'& line still happens, unless you also set
36238 &%local_sender_retain%& to be true. It is not possible to set both of these
36239 options true at the same time.
36240
36241 .cindex "submission mode"
36242 By default, no processing of &'Sender:'& header lines is done for messages
36243 received over TCP/IP or for messages submitted by trusted users. However, when
36244 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36245 not specified on the submission control, the following processing takes place:
36246
36247 .vindex "&$authenticated_id$&"
36248 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36249 authenticated, and &$authenticated_id$& is not empty, a sender address is
36250 created as follows:
36251
36252 .ilist
36253 .vindex "&$qualify_domain$&"
36254 If no domain is specified by the submission control, the local part is
36255 &$authenticated_id$& and the domain is &$qualify_domain$&.
36256 .next
36257 If a non-empty domain is specified by the submission control, the local part
36258 is &$authenticated_id$&, and the domain is the specified domain.
36259 .next
36260 If an empty domain is specified by the submission control,
36261 &$authenticated_id$& is assumed to be the complete address.
36262 .endlist
36263
36264 This address is compared with the address in the &'From:'& header line. If they
36265 are different, a &'Sender:'& header line containing the created address is
36266 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36267 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36268
36269 .cindex "return path" "created from &'Sender:'&"
36270 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36271 the message (the envelope sender address) is changed to be the same address,
36272 except in the case of submission mode when &%sender_retain%& is specified.
36273
36274
36275
36276 .section "Adding and removing header lines in routers and transports" &&&
36277          "SECTheadersaddrem"
36278 .cindex "header lines" "adding; in router or transport"
36279 .cindex "header lines" "removing; in router or transport"
36280 When a message is delivered, the addition and removal of header lines can be
36281 specified in a system filter, or on any of the routers and transports that
36282 process the message. Section &<<SECTaddremheasys>>& contains details about
36283 modifying headers in a system filter. Header lines can also be added in an ACL
36284 as a message is received (see section &<<SECTaddheadacl>>&).
36285
36286 In contrast to what happens in a system filter, header modifications that are
36287 specified on routers and transports apply only to the particular recipient
36288 addresses that are being processed by those routers and transports. These
36289 changes do not actually take place until a copy of the message is being
36290 transported. Therefore, they do not affect the basic set of header lines, and
36291 they do not affect the values of the variables that refer to header lines.
36292
36293 &*Note*&: In particular, this means that any expansions in the configuration of
36294 the transport cannot refer to the modified header lines, because such
36295 expansions all occur before the message is actually transported.
36296
36297 For both routers and transports, the argument of a &%headers_add%&
36298 option must be in the form of one or more RFC 2822 header lines, separated by
36299 newlines (coded as &"\n"&). For example:
36300 .code
36301 headers_add = X-added-header: added by $primary_hostname\n\
36302               X-added-second: another added header line
36303 .endd
36304 Exim does not check the syntax of these added header lines.
36305
36306 Multiple &%headers_add%& options for a single router or transport can be
36307 specified; the values will append to a single list of header lines.
36308 Each header-line is separately expanded.
36309
36310 The argument of a &%headers_remove%& option must consist of a colon-separated
36311 list of header names. This is confusing, because header names themselves are
36312 often terminated by colons. In this case, the colons are the list separators,
36313 not part of the names. For example:
36314 .code
36315 headers_remove = return-receipt-to:acknowledge-to
36316 .endd
36317
36318 Multiple &%headers_remove%& options for a single router or transport can be
36319 specified; the arguments will append to a single header-names list.
36320 Each item is separately expanded.
36321 Note that colons in complex expansions which are used to
36322 form all or part of a &%headers_remove%& list
36323 will act as list separators.
36324
36325 When &%headers_add%& or &%headers_remove%& is specified on a router,
36326 items are expanded at routing time,
36327 and then associated with all addresses that are
36328 accepted by that router, and also with any new addresses that it generates. If
36329 an address passes through several routers as a result of aliasing or
36330 forwarding, the changes are cumulative.
36331
36332 .oindex "&%unseen%&"
36333 However, this does not apply to multiple routers that result from the use of
36334 the &%unseen%& option. Any header modifications that were specified by the
36335 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36336
36337 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36338 settings cannot be delivered together in a batch, so a transport is always
36339 dealing with a set of addresses that have the same header-processing
36340 requirements.
36341
36342 The transport starts by writing the original set of header lines that arrived
36343 with the message, possibly modified by the system filter. As it writes out
36344 these lines, it consults the list of header names that were attached to the
36345 recipient address(es) by &%headers_remove%& options in routers, and it also
36346 consults the transport's own &%headers_remove%& option. Header lines whose
36347 names are on either of these lists are not written out. If there are multiple
36348 instances of any listed header, they are all skipped.
36349
36350 After the remaining original header lines have been written, new header
36351 lines that were specified by routers' &%headers_add%& options are written, in
36352 the order in which they were attached to the address. These are followed by any
36353 header lines specified by the transport's &%headers_add%& option.
36354
36355 This way of handling header line modifications in routers and transports has
36356 the following consequences:
36357
36358 .ilist
36359 The original set of header lines, possibly modified by the system filter,
36360 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36361 to it, at all times.
36362 .next
36363 Header lines that are added by a router's
36364 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36365 expansion syntax in subsequent routers or the transport.
36366 .next
36367 Conversely, header lines that are specified for removal by &%headers_remove%&
36368 in a router remain visible to subsequent routers and the transport.
36369 .next
36370 Headers added to an address by &%headers_add%& in a router cannot be removed by
36371 a later router or by a transport.
36372 .next
36373 An added header can refer to the contents of an original header that is to be
36374 removed, even it has the same name as the added header. For example:
36375 .code
36376 headers_remove = subject
36377 headers_add = Subject: new subject (was: $h_subject:)
36378 .endd
36379 .endlist
36380
36381 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36382 for a &(redirect)& router that has the &%one_time%& option set.
36383
36384
36385
36386
36387
36388 .section "Constructed addresses" "SECTconstr"
36389 .cindex "address" "constructed"
36390 .cindex "constructed address"
36391 When Exim constructs a sender address for a locally-generated message, it uses
36392 the form
36393 .display
36394 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36395 .endd
36396 For example:
36397 .code
36398 Zaphod Beeblebrox <zaphod@end.univ.example>
36399 .endd
36400 The user name is obtained from the &%-F%& command line option if set, or
36401 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36402 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36403 ampersand character, this is replaced by the login name with the first letter
36404 upper cased, as is conventional in a number of operating systems. See the
36405 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36406 The &%unknown_username%& option can be used to specify user names in cases when
36407 there is no password file entry.
36408
36409 .cindex "RFC 2047"
36410 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36411 parts of it if necessary. In addition, if it contains any non-printing
36412 characters, it is encoded as described in RFC 2047, which defines a way of
36413 including non-ASCII characters in header lines. The value of the
36414 &%headers_charset%& option specifies the name of the encoding that is used (the
36415 characters are assumed to be in this encoding). The setting of
36416 &%print_topbitchars%& controls whether characters with the top bit set (that
36417 is, with codes greater than 127) count as printing characters or not.
36418
36419
36420
36421 .section "Case of local parts" "SECID230"
36422 .cindex "case of local parts"
36423 .cindex "local part" "case of"
36424 RFC 2822 states that the case of letters in the local parts of addresses cannot
36425 be assumed to be non-significant. Exim preserves the case of local parts of
36426 addresses, but by default it uses a lower-cased form when it is routing,
36427 because on most Unix systems, usernames are in lower case and case-insensitive
36428 routing is required. However, any particular router can be made to use the
36429 original case for local parts by setting the &%caseful_local_part%& generic
36430 router option.
36431
36432 .cindex "mixed-case login names"
36433 If you must have mixed-case user names on your system, the best way to proceed,
36434 assuming you want case-independent handling of incoming email, is to set up
36435 your first router to convert incoming local parts in your domains to the
36436 correct case by means of a file lookup. For example:
36437 .code
36438 correct_case:
36439   driver = redirect
36440   domains = +local_domains
36441   data = ${lookup{$local_part}cdb\
36442               {/etc/usercased.cdb}{$value}fail}\
36443               @$domain
36444 .endd
36445 For this router, the local part is forced to lower case by the default action
36446 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36447 up a new local part in the correct case. If you then set &%caseful_local_part%&
36448 on any subsequent routers which process your domains, they will operate on
36449 local parts with the correct case in a case-sensitive manner.
36450
36451
36452
36453 .section "Dots in local parts" "SECID231"
36454 .cindex "dot" "in local part"
36455 .cindex "local part" "dots in"
36456 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36457 part may not begin or end with a dot, nor have two consecutive dots in the
36458 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36459 empty components for compatibility.
36460
36461
36462
36463 .section "Rewriting addresses" "SECID232"
36464 .cindex "rewriting" "addresses"
36465 Rewriting of sender and recipient addresses, and addresses in headers, can
36466 happen automatically, or as the result of configuration options, as described
36467 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36468 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36469
36470 Automatic rewriting includes qualification, as mentioned above. The other case
36471 in which it can happen is when an incomplete non-local domain is given. The
36472 routing process may cause this to be expanded into the full domain name. For
36473 example, a header such as
36474 .code
36475 To: hare@teaparty
36476 .endd
36477 might get rewritten as
36478 .code
36479 To: hare@teaparty.wonderland.fict.example
36480 .endd
36481 Rewriting as a result of routing is the one kind of message processing that
36482 does not happen at input time, as it cannot be done until the address has
36483 been routed.
36484
36485 Strictly, one should not do &'any'& deliveries of a message until all its
36486 addresses have been routed, in case any of the headers get changed as a
36487 result of routing. However, doing this in practice would hold up many
36488 deliveries for unreasonable amounts of time, just because one address could not
36489 immediately be routed. Exim therefore does not delay other deliveries when
36490 routing of one or more addresses is deferred.
36491 .ecindex IIDmesproc
36492
36493
36494
36495 . ////////////////////////////////////////////////////////////////////////////
36496 . ////////////////////////////////////////////////////////////////////////////
36497
36498 .chapter "SMTP processing" "CHAPSMTP"
36499 .scindex IIDsmtpproc1 "SMTP" "processing details"
36500 .scindex IIDsmtpproc2 "LMTP" "processing details"
36501 Exim supports a number of different ways of using the SMTP protocol, and its
36502 LMTP variant, which is an interactive protocol for transferring messages into a
36503 closed mail store application. This chapter contains details of how SMTP is
36504 processed. For incoming mail, the following are available:
36505
36506 .ilist
36507 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36508 .next
36509 SMTP over the standard input and output (the &%-bs%& option);
36510 .next
36511 Batched SMTP on the standard input (the &%-bS%& option).
36512 .endlist
36513
36514 For mail delivery, the following are available:
36515
36516 .ilist
36517 SMTP over TCP/IP (the &(smtp)& transport);
36518 .next
36519 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36520 &"lmtp"&);
36521 .next
36522 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36523 transport);
36524 .next
36525 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36526 the &%use_bsmtp%& option set).
36527 .endlist
36528
36529 &'Batched SMTP'& is the name for a process in which batches of messages are
36530 stored in or read from files (or pipes), in a format in which SMTP commands are
36531 used to contain the envelope information.
36532
36533
36534
36535 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36536 .cindex "SMTP" "outgoing over TCP/IP"
36537 .cindex "outgoing SMTP over TCP/IP"
36538 .cindex "LMTP" "over TCP/IP"
36539 .cindex "outgoing LMTP over TCP/IP"
36540 .cindex "EHLO"
36541 .cindex "HELO"
36542 .cindex "SIZE" "option on MAIL command"
36543 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36544 The &%protocol%& option selects which protocol is to be used, but the actual
36545 processing is the same in both cases.
36546
36547 .cindex "ESMTP extensions" SIZE
36548 If, in response to its EHLO command, Exim is told that the SIZE
36549 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36550 command. The value of <&'n'&> is the message size plus the value of the
36551 &%size_addition%& option (default 1024) to allow for additions to the message
36552 such as per-transport header lines, or changes made in a
36553 .cindex "transport" "filter"
36554 .cindex "filter" "transport filter"
36555 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36556 suppressed.
36557
36558 If the remote server advertises support for PIPELINING, Exim uses the
36559 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36560 required for the transaction.
36561
36562 If the remote server advertises support for the STARTTLS command, and Exim
36563 was built to support TLS encryption, it tries to start a TLS session unless the
36564 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36565 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36566 is called for verification.
36567
36568 If the remote server advertises support for the AUTH command, Exim scans
36569 the authenticators configuration for any suitable client settings, as described
36570 in chapter &<<CHAPSMTPAUTH>>&.
36571
36572 .cindex "carriage return"
36573 .cindex "linefeed"
36574 Responses from the remote host are supposed to be terminated by CR followed by
36575 LF. However, there are known to be hosts that do not send CR characters, so in
36576 order to be able to interwork with such hosts, Exim treats LF on its own as a
36577 line terminator.
36578
36579 If a message contains a number of different addresses, all those with the same
36580 characteristics (for example, the same envelope sender) that resolve to the
36581 same set of hosts, in the same order, are sent in a single SMTP transaction,
36582 even if they are for different domains, unless there are more than the setting
36583 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36584 they are split into groups containing no more than &%max_rcpt%&s addresses
36585 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36586 in parallel sessions. The order of hosts with identical MX values is not
36587 significant when checking whether addresses can be batched in this way.
36588
36589 When the &(smtp)& transport suffers a temporary failure that is not
36590 message-related, Exim updates its transport-specific database, which contains
36591 records indexed by host name that remember which messages are waiting for each
36592 particular host. It also updates the retry database with new retry times.
36593
36594 .cindex "hints database" "retry keys"
36595 Exim's retry hints are based on host name plus IP address, so if one address of
36596 a multi-homed host is broken, it will soon be skipped most of the time.
36597 See the next section for more detail about error handling.
36598
36599 .cindex "SMTP" "passed connection"
36600 .cindex "SMTP" "batching over TCP/IP"
36601 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36602 looks in the hints database for the transport to see if there are any queued
36603 messages waiting for the host to which it is connected. If it finds one, it
36604 creates a new Exim process using the &%-MC%& option (which can only be used by
36605 a process running as root or the Exim user) and passes the TCP/IP socket to it
36606 so that it can deliver another message using the same socket. The new process
36607 does only those deliveries that are routed to the connected host, and may in
36608 turn pass the socket on to a third process, and so on.
36609
36610 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36611 limit the number of messages sent down a single TCP/IP connection.
36612
36613 .cindex "asterisk" "after IP address"
36614 The second and subsequent messages delivered down an existing connection are
36615 identified in the main log by the addition of an asterisk after the closing
36616 square bracket of the IP address.
36617
36618
36619
36620
36621 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36622 .cindex "error" "in outgoing SMTP"
36623 .cindex "SMTP" "errors in outgoing"
36624 .cindex "host" "error"
36625 Three different kinds of error are recognized for outgoing SMTP: host errors,
36626 message errors, and recipient errors.
36627
36628 .vlist
36629 .vitem "&*Host errors*&"
36630 A host error is not associated with a particular message or with a
36631 particular recipient of a message. The host errors are:
36632
36633 .ilist
36634 Connection refused or timed out,
36635 .next
36636 Any error response code on connection,
36637 .next
36638 Any error response code to EHLO or HELO,
36639 .next
36640 Loss of connection at any time, except after &"."&,
36641 .next
36642 I/O errors at any time,
36643 .next
36644 Timeouts during the session, other than in response to MAIL, RCPT or
36645 the &"."& at the end of the data.
36646 .endlist ilist
36647
36648 For a host error, a permanent error response on connection, or in response to
36649 EHLO, causes all addresses routed to the host to be failed. Any other host
36650 error causes all addresses to be deferred, and retry data to be created for the
36651 host. It is not tried again, for any message, until its retry time arrives. If
36652 the current set of addresses are not all delivered in this run (to some
36653 alternative host), the message is added to the list of those waiting for this
36654 host, so if it is still undelivered when a subsequent successful delivery is
36655 made to the host, it will be sent down the same SMTP connection.
36656
36657 .vitem "&*Message errors*&"
36658 .cindex "message" "error"
36659 A message error is associated with a particular message when sent to a
36660 particular host, but not with a particular recipient of the message. The
36661 message errors are:
36662
36663 .ilist
36664 Any error response code to MAIL, DATA, or the &"."& that terminates
36665 the data,
36666 .next
36667 Timeout after MAIL,
36668 .next
36669 Timeout or loss of connection after the &"."& that terminates the data. A
36670 timeout after the DATA command itself is treated as a host error, as is loss of
36671 connection at any other time.
36672 .endlist ilist
36673
36674 For a message error, a permanent error response (5&'xx'&) causes all addresses
36675 to be failed, and a delivery error report to be returned to the sender. A
36676 temporary error response (4&'xx'&), or one of the timeouts, causes all
36677 addresses to be deferred. Retry data is not created for the host, but instead,
36678 a retry record for the combination of host plus message id is created. The
36679 message is not added to the list of those waiting for this host. This ensures
36680 that the failing message will not be sent to this host again until the retry
36681 time arrives. However, other messages that are routed to the host are not
36682 affected, so if it is some property of the message that is causing the error,
36683 it will not stop the delivery of other mail.
36684
36685 If the remote host specified support for the SIZE parameter in its response
36686 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36687 over-large message will cause a message error because the error arrives as a
36688 response to MAIL.
36689
36690 .vitem "&*Recipient errors*&"
36691 .cindex "recipient" "error"
36692 A recipient error is associated with a particular recipient of a message. The
36693 recipient errors are:
36694
36695 .ilist
36696 Any error response to RCPT,
36697 .next
36698 Timeout after RCPT.
36699 .endlist
36700
36701 For a recipient error, a permanent error response (5&'xx'&) causes the
36702 recipient address to be failed, and a bounce message to be returned to the
36703 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36704 address to be deferred, and routing retry data to be created for it. This is
36705 used to delay processing of the address in subsequent queue runs, until its
36706 routing retry time arrives. This applies to all messages, but because it
36707 operates only in queue runs, one attempt will be made to deliver a new message
36708 to the failing address before the delay starts to operate. This ensures that,
36709 if the failure is really related to the message rather than the recipient
36710 (&"message too big for this recipient"& is a possible example), other messages
36711 have a chance of getting delivered. If a delivery to the address does succeed,
36712 the retry information gets cleared, so all stuck messages get tried again, and
36713 the retry clock is reset.
36714
36715 The message is not added to the list of those waiting for this host. Use of the
36716 host for other messages is unaffected, and except in the case of a timeout,
36717 other recipients are processed independently, and may be successfully delivered
36718 in the current SMTP session. After a timeout it is of course impossible to
36719 proceed with the session, so all addresses get deferred. However, those other
36720 than the one that failed do not suffer any subsequent retry delays. Therefore,
36721 if one recipient is causing trouble, the others have a chance of getting
36722 through when a subsequent delivery attempt occurs before the failing
36723 recipient's retry time.
36724 .endlist
36725
36726 In all cases, if there are other hosts (or IP addresses) available for the
36727 current set of addresses (for example, from multiple MX records), they are
36728 tried in this run for any undelivered addresses, subject of course to their
36729 own retry data. In other words, recipient error retry data does not take effect
36730 until the next delivery attempt.
36731
36732 Some hosts have been observed to give temporary error responses to every
36733 MAIL command at certain times (&"insufficient space"& has been seen). It
36734 would be nice if such circumstances could be recognized, and defer data for the
36735 host itself created, but this is not possible within the current Exim design.
36736 What actually happens is that retry data for every (host, message) combination
36737 is created.
36738
36739 The reason that timeouts after MAIL and RCPT are treated specially is that
36740 these can sometimes arise as a result of the remote host's verification
36741 procedures. Exim makes this assumption, and treats them as if a temporary error
36742 response had been received. A timeout after &"."& is treated specially because
36743 it is known that some broken implementations fail to recognize the end of the
36744 message if the last character of the last line is a binary zero. Thus, it is
36745 helpful to treat this case as a message error.
36746
36747 Timeouts at other times are treated as host errors, assuming a problem with the
36748 host, or the connection to it. If a timeout after MAIL, RCPT,
36749 or &"."& is really a connection problem, the assumption is that at the next try
36750 the timeout is likely to occur at some other point in the dialogue, causing it
36751 then to be treated as a host error.
36752
36753 There is experimental evidence that some MTAs drop the connection after the
36754 terminating &"."& if they do not like the contents of the message for some
36755 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36756 should be given. That is why Exim treats this case as a message rather than a
36757 host error, in order not to delay other messages to the same host.
36758
36759
36760
36761
36762 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36763 .cindex "SMTP" "incoming over TCP/IP"
36764 .cindex "incoming SMTP over TCP/IP"
36765 .cindex "inetd"
36766 .cindex "daemon"
36767 Incoming SMTP messages can be accepted in one of two ways: by running a
36768 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36769 &_/etc/inetd.conf_& should be like this:
36770 .code
36771 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36772 .endd
36773 Exim distinguishes between this case and the case of a locally running user
36774 agent using the &%-bs%& option by checking whether or not the standard input is
36775 a socket. When it is, either the port must be privileged (less than 1024), or
36776 the caller must be root or the Exim user. If any other user passes a socket
36777 with an unprivileged port number, Exim prints a message on the standard error
36778 stream and exits with an error code.
36779
36780 By default, Exim does not make a log entry when a remote host connects or
36781 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36782 unexpected. It can be made to write such log entries by setting the
36783 &%smtp_connection%& log selector.
36784
36785 .cindex "carriage return"
36786 .cindex "linefeed"
36787 Commands from the remote host are supposed to be terminated by CR followed by
36788 LF. However, there are known to be hosts that do not send CR characters. In
36789 order to be able to interwork with such hosts, Exim treats LF on its own as a
36790 line terminator.
36791 Furthermore, because common code is used for receiving messages from all
36792 sources, a CR on its own is also interpreted as a line terminator. However, the
36793 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36794
36795 .cindex "EHLO" "invalid data"
36796 .cindex "HELO" "invalid data"
36797 One area that sometimes gives rise to problems concerns the EHLO or
36798 HELO commands. Some clients send syntactically invalid versions of these
36799 commands, which Exim rejects by default. (This is nothing to do with verifying
36800 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36801 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36802 match the broken hosts that send invalid commands.
36803
36804 .cindex "SIZE option on MAIL command"
36805 .cindex "MAIL" "SIZE option"
36806 The amount of disk space available is checked whenever SIZE is received on
36807 a MAIL command, independently of whether &%message_size_limit%& or
36808 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36809 false. A temporary error is given if there is not enough space. If
36810 &%check_spool_space%& is set, the check is for that amount of space plus the
36811 value given with SIZE, that is, it checks that the addition of the incoming
36812 message will not reduce the space below the threshold.
36813
36814 When a message is successfully received, Exim includes the local message id in
36815 its response to the final &"."& that terminates the data. If the remote host
36816 logs this text it can help with tracing what has happened to a message.
36817
36818 The Exim daemon can limit the number of simultaneous incoming connections it is
36819 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36820 number of simultaneous incoming connections from a single remote host (see the
36821 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36822 rejected using the SMTP temporary error code 421.
36823
36824 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36825 subprocess has finished, as this can get lost at busy times. Instead, it looks
36826 for completed subprocesses every time it wakes up. Provided there are other
36827 things happening (new incoming calls, starts of queue runs), completed
36828 processes will be noticed and tidied away. On very quiet systems you may
36829 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36830 it will be noticed when the daemon next wakes up.
36831
36832 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36833 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36834 high system load &-- for details see the &%smtp_accept_reserve%&,
36835 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36836 applies in both the daemon and &'inetd'& cases.
36837
36838 Exim normally starts a delivery process for each message received, though this
36839 can be varied by means of the &%-odq%& command line option and the
36840 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36841 number of simultaneously running delivery processes started in this way from
36842 SMTP input can be limited by the &%smtp_accept_queue%& and
36843 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36844 subsequently received messages are just put on the input queue without starting
36845 a delivery process.
36846
36847 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36848 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36849 started up from the &'inetd'& daemon, because in that case each connection is
36850 handled by an entirely independent Exim process. Control by load average is,
36851 however, available with &'inetd'&.
36852
36853 Exim can be configured to verify addresses in incoming SMTP commands as they
36854 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36855 to rewrite addresses at this time &-- before any syntax checking is done. See
36856 section &<<SECTrewriteS>>&.
36857
36858 Exim can also be configured to limit the rate at which a client host submits
36859 MAIL and RCPT commands in a single SMTP session. See the
36860 &%smtp_ratelimit_hosts%& option.
36861
36862
36863
36864 .section "Unrecognized SMTP commands" "SECID234"
36865 .cindex "SMTP" "unrecognized commands"
36866 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36867 commands during a single SMTP connection, it drops the connection after sending
36868 the error response to the last command. The default value for
36869 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36870 abuse that subvert web servers into making connections to SMTP ports; in these
36871 circumstances, a number of non-SMTP lines are sent first.
36872
36873
36874 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36875 .cindex "SMTP" "syntax errors"
36876 .cindex "SMTP" "protocol errors"
36877 A syntax error is detected if an SMTP command is recognized, but there is
36878 something syntactically wrong with its data, for example, a malformed email
36879 address in a RCPT command. Protocol errors include invalid command
36880 sequencing such as RCPT before MAIL. If Exim receives more than
36881 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36882 drops the connection after sending the error response to the last command. The
36883 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36884 broken clients that loop sending bad commands (yes, it has been seen).
36885
36886
36887
36888 .section "Use of non-mail SMTP commands" "SECID236"
36889 .cindex "SMTP" "non-mail commands"
36890 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36891 DATA. Exim counts such commands, and drops the connection if there are too
36892 many of them in a single SMTP session. This action catches some
36893 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36894 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36895 defines what &"too many"& means. Its default value is 10.
36896
36897 When a new message is expected, one occurrence of RSET is not counted. This
36898 allows a client to send one RSET between messages (this is not necessary,
36899 but some clients do it). Exim also allows one uncounted occurrence of HELO
36900 or EHLO, and one occurrence of STARTTLS between messages. After
36901 starting up a TLS session, another EHLO is expected, and so it too is not
36902 counted.
36903
36904 The first occurrence of AUTH in a connection, or immediately following
36905 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36906 RCPT, DATA, and QUIT are counted.
36907
36908 You can control which hosts are subject to the limit set by
36909 &%smtp_accept_max_nonmail%& by setting
36910 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36911 the limit apply to all hosts. This option means that you can exclude any
36912 specific badly-behaved hosts that you have to live with.
36913
36914
36915
36916
36917 .section "The VRFY and EXPN commands" "SECID237"
36918 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36919 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36920 appropriate) in order to decide whether the command should be accepted or not.
36921
36922 .cindex "VRFY" "processing"
36923 When no ACL is defined for VRFY, or if it rejects without
36924 setting an explicit response code, the command is accepted
36925 (with a 252 SMTP response code)
36926 in order to support awkward clients that do a VRFY before every RCPT.
36927 When VRFY is accepted, it runs exactly the same code as when Exim is
36928 called with the &%-bv%& option, and returns 250/451/550
36929 SMTP response codes.
36930
36931 .cindex "EXPN" "processing"
36932 If no ACL for EXPN is defined, the command is rejected.
36933 When EXPN is accepted, a single-level expansion of the address is done.
36934 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36935 than a verification (the &%-bv%& option). If an unqualified local part is given
36936 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36937 of VRFY and EXPN commands are logged on the main and reject logs, and
36938 VRFY verification failures are logged on the main log for consistency with
36939 RCPT failures.
36940
36941
36942
36943 .section "The ETRN command" "SECTETRN"
36944 .cindex "ETRN" "processing"
36945 .cindex "ESMTP extensions" ETRN
36946 RFC 1985 describes an ESMTP command called ETRN that is designed to
36947 overcome the security problems of the TURN command (which has fallen into
36948 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36949 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36950 should be accepted or not. If no ACL is defined, the command is rejected.
36951
36952 The ETRN command is concerned with &"releasing"& messages that are awaiting
36953 delivery to certain hosts. As Exim does not organize its message queue by host,
36954 the only form of ETRN that is supported by default is the one where the
36955 text starts with the &"#"& prefix, in which case the remainder of the text is
36956 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36957 the &%-R%& option to happen, with the remainder of the ETRN text as its
36958 argument. For example,
36959 .code
36960 ETRN #brigadoon
36961 .endd
36962 runs the command
36963 .code
36964 exim -R brigadoon
36965 .endd
36966 which causes a delivery attempt on all messages with undelivered addresses
36967 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36968 default), Exim prevents the simultaneous execution of more than one queue run
36969 for the same argument string as a result of an ETRN command. This stops
36970 a misbehaving client from starting more than one queue runner at once.
36971
36972 .cindex "hints database" "ETRN serialization"
36973 Exim implements the serialization by means of a hints database in which a
36974 record is written whenever a process is started by ETRN, and deleted when
36975 the process completes. However, Exim does not keep the SMTP session waiting for
36976 the ETRN process to complete. Once ETRN is accepted, the client is sent
36977 a &"success"& return code. Obviously there is scope for hints records to get
36978 left lying around if there is a system or program crash. To guard against this,
36979 Exim ignores any records that are more than six hours old.
36980
36981 .oindex "&%smtp_etrn_command%&"
36982 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36983 used. This specifies a command that is run whenever ETRN is received,
36984 whatever the form of its argument. For
36985 example:
36986 .code
36987 smtp_etrn_command = /etc/etrn_command $domain \
36988                     $sender_host_address
36989 .endd
36990 .vindex "&$domain$&"
36991 The string is split up into arguments which are independently expanded. The
36992 expansion variable &$domain$& is set to the argument of the ETRN command,
36993 and no syntax checking is done on the contents of this argument. Exim does not
36994 wait for the command to complete, so its status code is not checked. Exim runs
36995 under its own uid and gid when receiving incoming SMTP, so it is not possible
36996 for it to change them before running the command.
36997
36998
36999
37000 .section "Incoming local SMTP" "SECID238"
37001 .cindex "SMTP" "local incoming"
37002 Some user agents use SMTP to pass messages to their local MTA using the
37003 standard input and output, as opposed to passing the envelope on the command
37004 line and writing the message to the standard input. This is supported by the
37005 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37006 messages over TCP/IP (including the use of ACLs), except that the envelope
37007 sender given in a MAIL command is ignored unless the caller is trusted. In
37008 an ACL you can detect this form of SMTP input by testing for an empty host
37009 identification. It is common to have this as the first line in the ACL that
37010 runs for RCPT commands:
37011 .code
37012 accept hosts = :
37013 .endd
37014 This accepts SMTP messages from local processes without doing any other tests.
37015
37016
37017
37018 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37019 .cindex "SMTP" "batched outgoing"
37020 .cindex "batched SMTP output"
37021 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37022 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37023 be output in BSMTP format. No SMTP responses are possible for this form of
37024 delivery. All it is doing is using SMTP commands as a way of transmitting the
37025 envelope along with the message.
37026
37027 The message is written to the file or pipe preceded by the SMTP commands
37028 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37029 the message that start with a dot have an extra dot added. The SMTP command
37030 HELO is not normally used. If it is required, the &%message_prefix%& option
37031 can be used to specify it.
37032
37033 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37034 one recipient address at a time by default. However, you can arrange for them
37035 to handle several addresses at once by setting the &%batch_max%& option. When
37036 this is done for BSMTP, messages may contain multiple RCPT commands. See
37037 chapter &<<CHAPbatching>>& for more details.
37038
37039 .vindex "&$host$&"
37040 When one or more addresses are routed to a BSMTP transport by a router that
37041 sets up a host list, the name of the first host on the list is available to the
37042 transport in the variable &$host$&. Here is an example of such a transport and
37043 router:
37044 .code
37045 begin routers
37046 route_append:
37047   driver = manualroute
37048   transport = smtp_appendfile
37049   route_list = domain.example  batch.host.example
37050
37051 begin transports
37052 smtp_appendfile:
37053   driver = appendfile
37054   directory = /var/bsmtp/$host
37055   batch_max = 1000
37056   use_bsmtp
37057   user = exim
37058 .endd
37059 This causes messages addressed to &'domain.example'& to be written in BSMTP
37060 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37061 message (unless there are more than 1000 recipients).
37062
37063
37064
37065 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37066 .cindex "SMTP" "batched incoming"
37067 .cindex "batched SMTP input"
37068 The &%-bS%& command line option causes Exim to accept one or more messages by
37069 reading SMTP on the standard input, but to generate no responses. If the caller
37070 is trusted, the senders in the MAIL commands are believed; otherwise the
37071 sender is always the caller of Exim. Unqualified senders and receivers are not
37072 rejected (there seems little point) but instead just get qualified. HELO
37073 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37074 as NOOP; QUIT quits.
37075
37076 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37077 ACL is run in the same way as for non-SMTP local input.
37078
37079 If an error is detected while reading a message, including a missing &"."& at
37080 the end, Exim gives up immediately. It writes details of the error to the
37081 standard output in a stylized way that the calling program should be able to
37082 make some use of automatically, for example:
37083 .code
37084 554 Unexpected end of file
37085 Transaction started in line 10
37086 Error detected in line 14
37087 .endd
37088 It writes a more verbose version, for human consumption, to the standard error
37089 file, for example:
37090 .code
37091 An error was detected while processing a file of BSMTP input.
37092 The error message was:
37093
37094 501 '>' missing at end of address
37095
37096 The SMTP transaction started in line 10.
37097 The error was detected in line 12.
37098 The SMTP command at fault was:
37099
37100 rcpt to:<malformed@in.com.plete
37101
37102 1 previous message was successfully processed.
37103 The rest of the batch was abandoned.
37104 .endd
37105 The return code from Exim is zero only if there were no errors. It is 1 if some
37106 messages were accepted before an error was detected, and 2 if no messages were
37107 accepted.
37108 .ecindex IIDsmtpproc1
37109 .ecindex IIDsmtpproc2
37110
37111
37112
37113 . ////////////////////////////////////////////////////////////////////////////
37114 . ////////////////////////////////////////////////////////////////////////////
37115
37116 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37117          "Customizing messages"
37118 When a message fails to be delivered, or remains in the queue for more than a
37119 configured amount of time, Exim sends a message to the original sender, or
37120 to an alternative configured address. The text of these messages is built into
37121 the code of Exim, but it is possible to change it, either by adding a single
37122 string, or by replacing each of the paragraphs by text supplied in a file.
37123
37124 The &'From:'& and &'To:'& header lines are automatically generated; you can
37125 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37126 option. Exim also adds the line
37127 .code
37128 Auto-Submitted: auto-generated
37129 .endd
37130 to all warning and bounce messages,
37131
37132
37133 .section "Customizing bounce messages" "SECID239"
37134 .cindex "customizing" "bounce message"
37135 .cindex "bounce message" "customizing"
37136 If &%bounce_message_text%& is set, its contents are included in the default
37137 message immediately after &"This message was created automatically by mail
37138 delivery software."& The string is not expanded. It is not used if
37139 &%bounce_message_file%& is set.
37140
37141 When &%bounce_message_file%& is set, it must point to a template file for
37142 constructing error messages. The file consists of a series of text items,
37143 separated by lines consisting of exactly four asterisks. If the file cannot be
37144 opened, default text is used and a message is written to the main and panic
37145 logs. If any text item in the file is empty, default text is used for that
37146 item.
37147
37148 .vindex "&$bounce_recipient$&"
37149 .vindex "&$bounce_return_size_limit$&"
37150 Each item of text that is read from the file is expanded, and there are two
37151 expansion variables which can be of use here: &$bounce_recipient$& is set to
37152 the recipient of an error message while it is being created, and
37153 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37154 option, rounded to a whole number.
37155
37156 The items must appear in the file in the following order:
37157
37158 .ilist
37159 The first item is included in the headers, and should include at least a
37160 &'Subject:'& header. Exim does not check the syntax of these headers.
37161 .next
37162 The second item forms the start of the error message. After it, Exim lists the
37163 failing addresses with their error messages.
37164 .next
37165 The third item is used to introduce any text from pipe transports that is to be
37166 returned to the sender. It is omitted if there is no such text.
37167 .next
37168 The fourth, fifth and sixth items will be ignored and may be empty.
37169 The fields exist for back-compatibility
37170 .endlist
37171
37172 The default state (&%bounce_message_file%& unset) is equivalent to the
37173 following file, in which the sixth item is empty. The &'Subject:'& and some
37174 other lines have been split in order to fit them on the page:
37175 .code
37176 Subject: Mail delivery failed
37177   ${if eq{$sender_address}{$bounce_recipient}
37178   {: returning message to sender}}
37179 ****
37180 This message was created automatically by mail delivery software.
37181
37182 A message ${if eq{$sender_address}{$bounce_recipient}
37183   {that you sent }{sent by
37184
37185 <$sender_address>
37186
37187 }}could not be delivered to all of its recipients.
37188 This is a permanent error. The following address(es) failed:
37189 ****
37190 The following text was generated during the delivery attempt(s):
37191 ****
37192 ------ This is a copy of the message, including all the headers.
37193   ------
37194 ****
37195 ------ The body of the message is $message_size characters long;
37196   only the first
37197 ------ $bounce_return_size_limit or so are included here.
37198 ****
37199 .endd
37200 .section "Customizing warning messages" "SECTcustwarn"
37201 .cindex "customizing" "warning message"
37202 .cindex "warning of delay" "customizing the message"
37203 The option &%warn_message_file%& can be pointed at a template file for use when
37204 warnings about message delays are created. In this case there are only three
37205 text sections:
37206
37207 .ilist
37208 The first item is included in the headers, and should include at least a
37209 &'Subject:'& header. Exim does not check the syntax of these headers.
37210 .next
37211 The second item forms the start of the warning message. After it, Exim lists
37212 the delayed addresses.
37213 .next
37214 The third item then ends the message.
37215 .endlist
37216
37217 The default state is equivalent to the following file, except that some lines
37218 have been split here, in order to fit them on the page:
37219 .code
37220 Subject: Warning: message $message_exim_id delayed
37221   $warn_message_delay
37222 ****
37223 This message was created automatically by mail delivery software.
37224
37225 A message ${if eq{$sender_address}{$warn_message_recipients}
37226 {that you sent }{sent by
37227
37228 <$sender_address>
37229
37230 }}has not been delivered to all of its recipients after
37231 more than $warn_message_delay in the queue on $primary_hostname.
37232
37233 The message identifier is:     $message_exim_id
37234 The subject of the message is: $h_subject
37235 The date of the message is:    $h_date
37236
37237 The following address(es) have not yet been delivered:
37238 ****
37239 No action is required on your part. Delivery attempts will
37240 continue for some time, and this warning may be repeated at
37241 intervals if the message remains undelivered. Eventually the
37242 mail delivery software will give up, and when that happens,
37243 the message will be returned to you.
37244 .endd
37245 .vindex "&$warn_message_delay$&"
37246 .vindex "&$warn_message_recipients$&"
37247 However, in the default state the subject and date lines are omitted if no
37248 appropriate headers exist. During the expansion of this file,
37249 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37250 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37251 of recipients for the warning message. There may be more than one if there are
37252 multiple addresses with different &%errors_to%& settings on the routers that
37253 handled them.
37254
37255
37256
37257
37258 . ////////////////////////////////////////////////////////////////////////////
37259 . ////////////////////////////////////////////////////////////////////////////
37260
37261 .chapter "Some common configuration settings" "CHAPcomconreq"
37262 This chapter discusses some configuration settings that seem to be fairly
37263 common. More examples and discussion can be found in the Exim book.
37264
37265
37266
37267 .section "Sending mail to a smart host" "SECID240"
37268 .cindex "smart host" "example router"
37269 If you want to send all mail for non-local domains to a &"smart host"&, you
37270 should replace the default &(dnslookup)& router with a router which does the
37271 routing explicitly:
37272 .code
37273 send_to_smart_host:
37274   driver = manualroute
37275   route_list = !+local_domains smart.host.name
37276   transport = remote_smtp
37277 .endd
37278 You can use the smart host's IP address instead of the name if you wish.
37279 If you are using Exim only to submit messages to a smart host, and not for
37280 receiving incoming messages, you can arrange for it to do the submission
37281 synchronously by setting the &%mua_wrapper%& option (see chapter
37282 &<<CHAPnonqueueing>>&).
37283
37284
37285
37286
37287 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37288 .cindex "mailing lists"
37289 Exim can be used to run simple mailing lists, but for large and/or complicated
37290 requirements, the use of additional specialized mailing list software such as
37291 Majordomo or Mailman is recommended.
37292
37293 The &(redirect)& router can be used to handle mailing lists where each list
37294 is maintained in a separate file, which can therefore be managed by an
37295 independent manager. The &%domains%& router option can be used to run these
37296 lists in a separate domain from normal mail. For example:
37297 .code
37298 lists:
37299   driver = redirect
37300   domains = lists.example
37301   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37302   forbid_pipe
37303   forbid_file
37304   errors_to = ${quote_local_part:$local_part-request}@lists.example
37305   no_more
37306 .endd
37307 This router is skipped for domains other than &'lists.example'&. For addresses
37308 in that domain, it looks for a file that matches the local part. If there is no
37309 such file, the router declines, but because &%no_more%& is set, no subsequent
37310 routers are tried, and so the whole delivery fails.
37311
37312 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37313 expanded into a filename or a pipe delivery, which is usually inappropriate in
37314 a mailing list.
37315
37316 .oindex "&%errors_to%&"
37317 The &%errors_to%& option specifies that any delivery errors caused by addresses
37318 taken from a mailing list are to be sent to the given address rather than the
37319 original sender of the message. However, before acting on this, Exim verifies
37320 the error address, and ignores it if verification fails.
37321
37322 For example, using the configuration above, mail sent to
37323 &'dicts@lists.example'& is passed on to those addresses contained in
37324 &_/usr/lists/dicts_&, with error reports directed to
37325 &'dicts-request@lists.example'&, provided that this address can be verified.
37326 There could be a file called &_/usr/lists/dicts-request_& containing
37327 the address(es) of this particular list's manager(s), but other approaches,
37328 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37329 or &%local_part_suffix%& options) to handle addresses of the form
37330 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37331
37332
37333
37334 .section "Syntax errors in mailing lists" "SECID241"
37335 .cindex "mailing lists" "syntax errors in"
37336 If an entry in redirection data contains a syntax error, Exim normally defers
37337 delivery of the original address. That means that a syntax error in a mailing
37338 list holds up all deliveries to the list. This may not be appropriate when a
37339 list is being maintained automatically from data supplied by users, and the
37340 addresses are not rigorously checked.
37341
37342 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37343 entries that fail to parse, noting the incident in the log. If in addition
37344 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37345 whenever a broken address is skipped. It is usually appropriate to set
37346 &%syntax_errors_to%& to the same address as &%errors_to%&.
37347
37348
37349
37350 .section "Re-expansion of mailing lists" "SECID242"
37351 .cindex "mailing lists" "re-expansion of"
37352 Exim remembers every individual address to which a message has been delivered,
37353 in order to avoid duplication, but it normally stores only the original
37354 recipient addresses with a message. If all the deliveries to a mailing list
37355 cannot be done at the first attempt, the mailing list is re-expanded when the
37356 delivery is next tried. This means that alterations to the list are taken into
37357 account at each delivery attempt, so addresses that have been added to
37358 the list since the message arrived will therefore receive a copy of the
37359 message, even though it pre-dates their subscription.
37360
37361 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37362 on the &(redirect)& router. If this is done, any addresses generated by the
37363 router that fail to deliver at the first attempt are added to the message as
37364 &"top level"& addresses, and the parent address that generated them is marked
37365 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37366 subsequent delivery attempts. The disadvantage of this is that if any of the
37367 failing addresses are incorrect, correcting them in the file has no effect on
37368 pre-existing messages.
37369
37370 The original top-level address is remembered with each of the generated
37371 addresses, and is output in any log messages. However, any intermediate parent
37372 addresses are not recorded. This makes a difference to the log only if the
37373 &%all_parents%& selector is set, but for mailing lists there is normally only
37374 one level of expansion anyway.
37375
37376
37377
37378 .section "Closed mailing lists" "SECID243"
37379 .cindex "mailing lists" "closed"
37380 The examples so far have assumed open mailing lists, to which anybody may
37381 send mail. It is also possible to set up closed lists, where mail is accepted
37382 from specified senders only. This is done by making use of the generic
37383 &%senders%& option to restrict the router that handles the list.
37384
37385 The following example uses the same file as a list of recipients and as a list
37386 of permitted senders. It requires three routers:
37387 .code
37388 lists_request:
37389   driver = redirect
37390   domains = lists.example
37391   local_part_suffix = -request
37392   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37393   file = /usr/lists/${local_part_data}-request
37394   no_more
37395
37396 lists_post:
37397   driver = redirect
37398   domains = lists.example
37399   senders = ${if exists {/usr/lists/$local_part}\
37400              {lsearch;/usr/lists/$local_part}{*}}
37401   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37402   forbid_pipe
37403   forbid_file
37404   errors_to = ${quote_local_part:$local_part-request}@lists.example
37405   no_more
37406
37407 lists_closed:
37408   driver = redirect
37409   domains = lists.example
37410   allow_fail
37411   data = :fail: $local_part@lists.example is a closed mailing list
37412 .endd
37413 All three routers have the same &%domains%& setting, so for any other domains,
37414 they are all skipped. The first router runs only if the local part ends in
37415 &%-request%&. It handles messages to the list manager(s) by means of an open
37416 mailing list.
37417
37418 The second router runs only if the &%senders%& precondition is satisfied. It
37419 checks for the existence of a list that corresponds to the local part, and then
37420 checks that the sender is on the list by means of a linear search. It is
37421 necessary to check for the existence of the file before trying to search it,
37422 because otherwise Exim thinks there is a configuration error. If the file does
37423 not exist, the expansion of &%senders%& is *, which matches all senders. This
37424 means that the router runs, but because there is no list, declines, and
37425 &%no_more%& ensures that no further routers are run. The address fails with an
37426 &"unrouteable address"& error.
37427
37428 The third router runs only if the second router is skipped, which happens when
37429 a mailing list exists, but the sender is not on it. This router forcibly fails
37430 the address, giving a suitable error message.
37431
37432
37433
37434
37435 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37436 .cindex "VERP"
37437 .cindex "Variable Envelope Return Paths"
37438 .cindex "envelope from"
37439 .cindex "envelope sender"
37440 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37441 are a way of helping mailing list administrators discover which subscription
37442 address is the cause of a particular delivery failure. The idea is to encode
37443 the original recipient address in the outgoing envelope sender address, so that
37444 if the message is forwarded by another host and then subsequently bounces, the
37445 original recipient can be extracted from the recipient address of the bounce.
37446
37447 .oindex &%errors_to%&
37448 .oindex &%return_path%&
37449 Envelope sender addresses can be modified by Exim using two different
37450 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37451 list examples), or the &%return_path%& option on a transport. The second of
37452 these is effective only if the message is successfully delivered to another
37453 host; it is not used for errors detected on the local host (see the description
37454 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37455 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37456 .code
37457 verp_smtp:
37458   driver = smtp
37459   max_rcpt = 1
37460   return_path = \
37461     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37462       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37463 .endd
37464 This has the effect of rewriting the return path (envelope sender) on outgoing
37465 SMTP messages, if the local part of the original return path ends in
37466 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37467 local part and domain of the recipient into the return path. Suppose, for
37468 example, that a message whose return path has been set to
37469 &'somelist-request@your.dom.example'& is sent to
37470 &'subscriber@other.dom.example'&. In the transport, the return path is
37471 rewritten as
37472 .code
37473 somelist-request+subscriber=other.dom.example@your.dom.example
37474 .endd
37475 .vindex "&$local_part$&"
37476 For this to work, you must tell Exim to send multiple copies of messages that
37477 have more than one recipient, so that each copy has just one recipient. This is
37478 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37479 might be sent to several different recipients in the same domain, in which case
37480 &$local_part$& is not available in the transport, because it is not unique.
37481
37482 Unless your host is doing nothing but mailing list deliveries, you should
37483 probably use a separate transport for the VERP deliveries, so as not to use
37484 extra resources in making one-per-recipient copies for other deliveries. This
37485 can easily be done by expanding the &%transport%& option in the router:
37486 .code
37487 dnslookup:
37488   driver = dnslookup
37489   domains = ! +local_domains
37490   transport = \
37491     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37492       {verp_smtp}{remote_smtp}}
37493   no_more
37494 .endd
37495 If you want to change the return path using &%errors_to%& in a router instead
37496 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37497 routers that handle mailing list addresses. This will ensure that all delivery
37498 errors, including those detected on the local host, are sent to the VERP
37499 address.
37500
37501 On a host that does no local deliveries and has no manual routing, only the
37502 &(dnslookup)& router needs to be changed. A special transport is not needed for
37503 SMTP deliveries. Every mailing list recipient has its own return path value,
37504 and so Exim must hand them to the transport one at a time. Here is an example
37505 of a &(dnslookup)& router that implements VERP:
37506 .code
37507 verp_dnslookup:
37508   driver = dnslookup
37509   domains = ! +local_domains
37510   transport = remote_smtp
37511   errors_to = \
37512     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37513      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37514   no_more
37515 .endd
37516 Before you start sending out messages with VERPed return paths, you must also
37517 configure Exim to accept the bounce messages that come back to those paths.
37518 Typically this is done by setting a &%local_part_suffix%& option for a
37519 router, and using this to route the messages to wherever you want to handle
37520 them.
37521
37522 The overhead incurred in using VERP depends very much on the size of the
37523 message, the number of recipient addresses that resolve to the same remote
37524 host, and the speed of the connection over which the message is being sent. If
37525 a lot of addresses resolve to the same host and the connection is slow, sending
37526 a separate copy of the message for each address may take substantially longer
37527 than sending a single copy with many recipients (for which VERP cannot be
37528 used).
37529
37530
37531
37532
37533
37534
37535 .section "Virtual domains" "SECTvirtualdomains"
37536 .cindex "virtual domains"
37537 .cindex "domain" "virtual"
37538 The phrase &'virtual domain'& is unfortunately used with two rather different
37539 meanings:
37540
37541 .ilist
37542 A domain for which there are no real mailboxes; all valid local parts are
37543 aliases for other email addresses. Common examples are organizational
37544 top-level domains and &"vanity"& domains.
37545 .next
37546 One of a number of independent domains that are all handled by the same host,
37547 with mailboxes on that host, but where the mailbox owners do not necessarily
37548 have login accounts on that host.
37549 .endlist
37550
37551 The first usage is probably more common, and does seem more &"virtual"& than
37552 the second. This kind of domain can be handled in Exim with a straightforward
37553 aliasing router. One approach is to create a separate alias file for each
37554 virtual domain. Exim can test for the existence of the alias file to determine
37555 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37556 to a router of this form:
37557 .code
37558 virtual:
37559   driver = redirect
37560   domains = dsearch;/etc/mail/virtual
37561   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37562   no_more
37563 .endd
37564 The &%domains%& option specifies that the router is to be skipped, unless there
37565 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37566 domain that is being processed.
37567 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37568 being placed into the &$domain_data$& variable.
37569
37570 When the router runs, it looks up the local
37571 part in the file to find a new address (or list of addresses). The &%no_more%&
37572 setting ensures that if the lookup fails (leading to &%data%& being an empty
37573 string), Exim gives up on the address without trying any subsequent routers.
37574
37575 This one router can handle all the virtual domains because the alias filenames
37576 follow a fixed pattern. Permissions can be arranged so that appropriate people
37577 can edit the different alias files. A successful aliasing operation results in
37578 a new envelope recipient address, which is then routed from scratch.
37579
37580 The other kind of &"virtual"& domain can also be handled in a straightforward
37581 way. One approach is to create a file for each domain containing a list of
37582 valid local parts, and use it in a router like this:
37583 .code
37584 my_domains:
37585   driver = accept
37586   domains = dsearch;/etc/mail/domains
37587   local_parts = lsearch;/etc/mail/domains/$domain
37588   transport = my_mailboxes
37589 .endd
37590 The address is accepted if there is a file for the domain, and the local part
37591 can be found in the file. The &%domains%& option is used to check for the
37592 file's existence because &%domains%& is tested before the &%local_parts%&
37593 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37594 because that option is tested after &%local_parts%&. The transport is as
37595 follows:
37596 .code
37597 my_mailboxes:
37598   driver = appendfile
37599   file = /var/mail/$domain_data/$local_part_data
37600   user = mail
37601 .endd
37602 This uses a directory of mailboxes for each domain. The &%user%& setting is
37603 required, to specify which uid is to be used for writing to the mailboxes.
37604
37605 The configuration shown here is just one example of how you might support this
37606 requirement. There are many other ways this kind of configuration can be set
37607 up, for example, by using a database instead of separate files to hold all the
37608 information about the domains.
37609
37610
37611
37612 .section "Multiple user mailboxes" "SECTmulbox"
37613 .cindex "multiple mailboxes"
37614 .cindex "mailbox" "multiple"
37615 .cindex "local part" "prefix"
37616 .cindex "local part" "suffix"
37617 Heavy email users often want to operate with multiple mailboxes, into which
37618 incoming mail is automatically sorted. A popular way of handling this is to
37619 allow users to use multiple sender addresses, so that replies can easily be
37620 identified. Users are permitted to add prefixes or suffixes to their local
37621 parts for this purpose. The wildcard facility of the generic router options
37622 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37623 example, consider this router:
37624 .code
37625 userforward:
37626   driver = redirect
37627   check_local_user
37628   file = $home/.forward
37629   local_part_suffix = -*
37630   local_part_suffix_optional
37631   allow_filter
37632 .endd
37633 .vindex "&$local_part_suffix$&"
37634 It runs a user's &_.forward_& file for all local parts of the form
37635 &'username-*'&. Within the filter file the user can distinguish different
37636 cases by testing the variable &$local_part_suffix$&. For example:
37637 .code
37638 if $local_part_suffix contains -special then
37639 save /home/$local_part_data/Mail/special
37640 endif
37641 .endd
37642 If the filter file does not exist, or does not deal with such addresses, they
37643 fall through to subsequent routers, and, assuming no subsequent use of the
37644 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37645 control over which suffixes are valid.
37646
37647 Alternatively, a suffix can be used to trigger the use of a different
37648 &_.forward_& file &-- which is the way a similar facility is implemented in
37649 another MTA:
37650 .code
37651 userforward:
37652   driver = redirect
37653   check_local_user
37654   local_part_suffix = -*
37655   local_part_suffix_optional
37656   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37657   allow_filter
37658 .endd
37659 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37660 example, &_.forward-special_& is used. Once again, if the appropriate file
37661 does not exist, or does not deal with the address, it is passed on to
37662 subsequent routers, which could, if required, look for an unqualified
37663 &_.forward_& file to use as a default.
37664
37665
37666
37667 .section "Simplified vacation processing" "SECID244"
37668 .cindex "vacation processing"
37669 The traditional way of running the &'vacation'& program is for a user to set up
37670 a pipe command in a &_.forward_& file
37671 (see section &<<SECTspecitredli>>& for syntax details).
37672 This is prone to error by inexperienced users. There are two features of Exim
37673 that can be used to make this process simpler for users:
37674
37675 .ilist
37676 A local part prefix such as &"vacation-"& can be specified on a router which
37677 can cause the message to be delivered directly to the &'vacation'& program, or
37678 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37679 &_.forward_& file are then much simpler. For example:
37680 .code
37681 spqr, vacation-spqr
37682 .endd
37683 .next
37684 The &%require_files%& generic router option can be used to trigger a
37685 vacation delivery by checking for the existence of a certain file in the
37686 user's home directory. The &%unseen%& generic option should also be used, to
37687 ensure that the original delivery also proceeds. In this case, all the user has
37688 to do is to create a file called, say, &_.vacation_&, containing a vacation
37689 message.
37690 .endlist
37691
37692 Another advantage of both these methods is that they both work even when the
37693 use of arbitrary pipes by users is locked out.
37694
37695
37696
37697 .section "Taking copies of mail" "SECID245"
37698 .cindex "message" "copying every"
37699 Some installations have policies that require archive copies of all messages to
37700 be made. A single copy of each message can easily be taken by an appropriate
37701 command in a system filter, which could, for example, use a different file for
37702 each day's messages.
37703
37704 There is also a shadow transport mechanism that can be used to take copies of
37705 messages that are successfully delivered by local transports, one copy per
37706 delivery. This could be used, &'inter alia'&, to implement automatic
37707 notification of delivery by sites that insist on doing such things.
37708
37709
37710
37711 .section "Intermittently connected hosts" "SECID246"
37712 .cindex "intermittently connected hosts"
37713 It has become quite common (because it is cheaper) for hosts to connect to the
37714 Internet periodically rather than remain connected all the time. The normal
37715 arrangement is that mail for such hosts accumulates on a system that is
37716 permanently connected.
37717
37718 Exim was designed for use on permanently connected hosts, and so it is not
37719 particularly well-suited to use in an intermittently connected environment.
37720 Nevertheless there are some features that can be used.
37721
37722
37723 .section "Exim on the upstream server host" "SECID247"
37724 It is tempting to arrange for incoming mail for the intermittently connected
37725 host to remain in Exim's queue until the client connects. However, this
37726 approach does not scale very well. Two different kinds of waiting message are
37727 being mixed up in the same queue &-- those that cannot be delivered because of
37728 some temporary problem, and those that are waiting for their destination host
37729 to connect. This makes it hard to manage the queue, as well as wasting
37730 resources, because each queue runner scans the entire queue.
37731
37732 A better approach is to separate off those messages that are waiting for an
37733 intermittently connected host. This can be done by delivering these messages
37734 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37735 format, from where they are transmitted by other software when their
37736 destination connects. This makes it easy to collect all the mail for one host
37737 in a single directory, and to apply local timeout rules on a per-message basis
37738 if required.
37739
37740 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37741 you are doing this, you should configure Exim with a long retry period for the
37742 intermittent host. For example:
37743 .code
37744 cheshire.wonderland.fict.example    *   F,5d,24h
37745 .endd
37746 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37747 which messages it has queued up for that host. Once the intermittent host comes
37748 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37749 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37750 causes all the queued up messages to be delivered, often down a single SMTP
37751 connection. While the host remains connected, any new messages get delivered
37752 immediately.
37753
37754 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37755 issued with a different IP address each time it connects, Exim's retry
37756 mechanisms on the holding host get confused, because the IP address is normally
37757 used as part of the key string for holding retry information. This can be
37758 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37759 Since this has disadvantages for permanently connected hosts, it is best to
37760 arrange a separate transport for the intermittently connected ones.
37761
37762
37763
37764 .section "Exim on the intermittently connected client host" "SECID248"
37765 The value of &%smtp_accept_queue_per_connection%& should probably be
37766 increased, or even set to zero (that is, disabled) on the intermittently
37767 connected host, so that all incoming messages down a single connection get
37768 delivered immediately.
37769
37770 .cindex "SMTP" "passed connection"
37771 .cindex "SMTP" "multiple deliveries"
37772 .cindex "multiple SMTP deliveries"
37773 .cindex "first pass routing"
37774 Mail waiting to be sent from an intermittently connected host will probably
37775 not have been routed, because without a connection DNS lookups are not
37776 possible. This means that if a normal queue run is done at connection time,
37777 each message is likely to be sent in a separate SMTP session. This can be
37778 avoided by starting the queue run with a command line option beginning with
37779 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37780 first pass, routing is done but no deliveries take place. The second pass is a
37781 normal queue run; since all the messages have been previously routed, those
37782 destined for the same host are likely to get sent as multiple deliveries in a
37783 single SMTP connection.
37784
37785
37786
37787 . ////////////////////////////////////////////////////////////////////////////
37788 . ////////////////////////////////////////////////////////////////////////////
37789
37790 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37791          "Exim as a non-queueing client"
37792 .cindex "client, non-queueing"
37793 .cindex "smart host" "suppressing queueing"
37794 On a personal computer, it is a common requirement for all
37795 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37796 configured to operate that way, for all the popular operating systems.
37797 However, there are some MUAs for Unix-like systems that cannot be so
37798 configured: they submit messages using the command line interface of
37799 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37800 messages this way.
37801
37802 If the personal computer runs continuously, there is no problem, because it can
37803 run a conventional MTA that handles delivery to the smart host, and deal with
37804 any delays via its queueing mechanism. However, if the computer does not run
37805 continuously or runs different operating systems at different times, queueing
37806 email is not desirable.
37807
37808 There is therefore a requirement for something that can provide the
37809 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37810 any queueing or retrying facilities. Furthermore, the delivery to the smart
37811 host should be synchronous, so that if it fails, the sending MUA is immediately
37812 informed. In other words, we want something that extends an MUA that submits
37813 to a local MTA via the command line so that it behaves like one that submits
37814 to a remote smart host using TCP/SMTP.
37815
37816 There are a number of applications (for example, there is one called &'ssmtp'&)
37817 that do this job. However, people have found them to be lacking in various
37818 ways. For instance, you might want to allow aliasing and forwarding to be done
37819 before sending a message to the smart host.
37820
37821 Exim already had the necessary infrastructure for doing this job. Just a few
37822 tweaks were needed to make it behave as required, though it is somewhat of an
37823 overkill to use a fully-featured MTA for this purpose.
37824
37825 .oindex "&%mua_wrapper%&"
37826 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37827 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37828 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37829 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37830 compatible router and transport configuration. Typically there will be just one
37831 router and one transport, sending everything to a smart host.
37832
37833 When run in MUA wrapping mode, the behaviour of Exim changes in the
37834 following ways:
37835
37836 .ilist
37837 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37838 In other words, the only way to submit messages is via the command line.
37839 .next
37840 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37841 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37842 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37843 does not finish until the delivery attempt is complete. If the delivery is
37844 successful, a zero return code is given.
37845 .next
37846 Address redirection is permitted, but the final routing for all addresses must
37847 be to the same remote transport, and to the same list of hosts. Furthermore,
37848 the return address (envelope sender) must be the same for all recipients, as
37849 must any added or deleted header lines. In other words, it must be possible to
37850 deliver the message in a single SMTP transaction, however many recipients there
37851 are.
37852 .next
37853 If these conditions are not met, or if routing any address results in a
37854 failure or defer status, or if Exim is unable to deliver all the recipients
37855 successfully to one of the smart hosts, delivery of the entire message fails.
37856 .next
37857 Because no queueing is allowed, all failures are treated as permanent; there
37858 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37859 smart host. Furthermore, because only a single yes/no response can be given to
37860 the caller, it is not possible to deliver to some recipients and not others. If
37861 there is an error (temporary or permanent) for any recipient, all are failed.
37862 .next
37863 If more than one smart host is listed, Exim will try another host after a
37864 connection failure or a timeout, in the normal way. However, if this kind of
37865 failure happens for all the hosts, the delivery fails.
37866 .next
37867 When delivery fails, an error message is written to the standard error stream
37868 (as well as to Exim's log), and Exim exits to the caller with a return code
37869 value 1. The message is expunged from Exim's spool files. No bounce messages
37870 are ever generated.
37871 .next
37872 No retry data is maintained, and any retry rules are ignored.
37873 .next
37874 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37875 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37876 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37877 .endlist
37878
37879 The overall effect is that Exim makes a single synchronous attempt to deliver
37880 the message, failing if there is any kind of problem. Because no local
37881 deliveries are done and no daemon can be run, Exim does not need root
37882 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37883 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37884 the advantages and disadvantages of running without root privilege.
37885
37886
37887
37888
37889 . ////////////////////////////////////////////////////////////////////////////
37890 . ////////////////////////////////////////////////////////////////////////////
37891
37892 .chapter "Log files" "CHAPlog"
37893 .scindex IIDloggen "log" "general description"
37894 .cindex "log" "types of"
37895 Exim writes three different logs, referred to as the main log, the reject log,
37896 and the panic log:
37897
37898 .ilist
37899 .cindex "main log"
37900 The main log records the arrival of each message and each delivery in a single
37901 line in each case. The format is as compact as possible, in an attempt to keep
37902 down the size of log files. Two-character flag sequences make it easy to pick
37903 out these lines. A number of other events are recorded in the main log. Some of
37904 them are optional, in which case the &%log_selector%& option controls whether
37905 they are included or not. A Perl script called &'eximstats'&, which does simple
37906 analysis of main log files, is provided in the Exim distribution (see section
37907 &<<SECTmailstat>>&).
37908 .next
37909 .cindex "reject log"
37910 The reject log records information from messages that are rejected as a result
37911 of a configuration option (that is, for policy reasons).
37912 The first line of each rejection is a copy of the line that is also written to
37913 the main log. Then, if the message's header has been read at the time the log
37914 is written, its contents are written to this log. Only the original header
37915 lines are available; header lines added by ACLs are not logged. You can use the
37916 reject log to check that your policy controls are working correctly; on a busy
37917 host this may be easier than scanning the main log for rejection messages. You
37918 can suppress the writing of the reject log by setting &%write_rejectlog%&
37919 false.
37920 .next
37921 .cindex "panic log"
37922 .cindex "system log"
37923 When certain serious errors occur, Exim writes entries to its panic log. If the
37924 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37925 are usually written to the main log as well, but can get lost amid the mass of
37926 other entries. The panic log should be empty under normal circumstances. It is
37927 therefore a good idea to check it (or to have a &'cron'& script check it)
37928 regularly, in order to become aware of any problems. When Exim cannot open its
37929 panic log, it tries as a last resort to write to the system log (syslog). This
37930 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37931 message itself is written at priority LOG_CRIT.
37932 .endlist
37933
37934 Every log line starts with a timestamp, in the format shown in the following
37935 example. Note that many of the examples shown in this chapter are line-wrapped.
37936 In the log file, this would be all on one line:
37937 .code
37938 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37939   by QUIT
37940 .endd
37941 By default, the timestamps are in the local timezone. There are two
37942 ways of changing this:
37943
37944 .ilist
37945 You can set the &%timezone%& option to a different time zone; in particular, if
37946 you set
37947 .code
37948 timezone = UTC
37949 .endd
37950 the timestamps will be in UTC (aka GMT).
37951 .next
37952 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37953 example:
37954 .code
37955 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37956 .endd
37957 .endlist
37958
37959 .cindex "log" "process ids in"
37960 .cindex "pid (process id)" "in log lines"
37961 Exim does not include its process id in log lines by default, but you can
37962 request that it does so by specifying the &`pid`& log selector (see section
37963 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37964 brackets, immediately after the time and date.
37965
37966
37967
37968
37969 .section "Where the logs are written" "SECTwhelogwri"
37970 .cindex "log" "destination"
37971 .cindex "log" "to file"
37972 .cindex "log" "to syslog"
37973 .cindex "syslog"
37974 The logs may be written to local files, or to syslog, or both. However, it
37975 should be noted that many syslog implementations use UDP as a transport, and
37976 are therefore unreliable in the sense that messages are not guaranteed to
37977 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37978 It has also been reported that on large log files (tens of megabytes) you may
37979 need to tweak syslog to prevent it syncing the file with each write &-- on
37980 Linux this has been seen to make syslog take 90% plus of CPU time.
37981
37982 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37983 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37984 configuration. This latter string is expanded, so it can contain, for example,
37985 references to the host name:
37986 .code
37987 log_file_path = /var/log/$primary_hostname/exim_%slog
37988 .endd
37989 It is generally advisable, however, to set the string in &_Local/Makefile_&
37990 rather than at runtime, because then the setting is available right from the
37991 start of Exim's execution. Otherwise, if there's something it wants to log
37992 before it has read the configuration file (for example, an error in the
37993 configuration file) it will not use the path you want, and may not be able to
37994 log at all.
37995
37996 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37997 list, currently limited to at most two items. This is one option where the
37998 facility for changing a list separator may not be used. The list must always be
37999 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38000 otherwise the item must either be an absolute path, containing &`%s`& at the
38001 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38002 implying the use of a default path.
38003
38004 When Exim encounters an empty item in the list, it searches the list defined by
38005 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38006 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38007 mean &"use the path specified at build time"&. It no such item exists, log
38008 files are written in the &_log_& subdirectory of the spool directory. This is
38009 equivalent to the setting:
38010 .code
38011 log_file_path = $spool_directory/log/%slog
38012 .endd
38013 If you do not specify anything at build time or runtime,
38014 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38015 that is where the logs are written.
38016
38017 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38018 are in use &-- see section &<<SECTdatlogfil>>& below.
38019
38020 Here are some examples of possible settings:
38021 .display
38022 &`LOG_FILE_PATH=syslog                    `& syslog only
38023 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38024 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38025 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38026 .endd
38027 If there are more than two paths in the list, the first is used and a panic
38028 error is logged.
38029
38030
38031
38032 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38033 .cindex "log" "cycling local files"
38034 .cindex "cycling logs"
38035 .cindex "&'exicyclog'&"
38036 .cindex "log" "local files; writing to"
38037 Some operating systems provide centralized and standardized methods for cycling
38038 log files. For those that do not, a utility script called &'exicyclog'& is
38039 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38040 main and reject logs each time it is called. The maximum number of old logs to
38041 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38042
38043 An Exim delivery process opens the main log when it first needs to write to it,
38044 and it keeps the file open in case subsequent entries are required &-- for
38045 example, if a number of different deliveries are being done for the same
38046 message. However, remote SMTP deliveries can take a long time, and this means
38047 that the file may be kept open long after it is renamed if &'exicyclog'& or
38048 something similar is being used to rename log files on a regular basis. To
38049 ensure that a switch of log files is noticed as soon as possible, Exim calls
38050 &[stat()]& on the main log's name before reusing an open file, and if the file
38051 does not exist, or its inode has changed, the old file is closed and Exim
38052 tries to open the main log from scratch. Thus, an old log file may remain open
38053 for quite some time, but no Exim processes should write to it once it has been
38054 renamed.
38055
38056
38057
38058 .section "Datestamped log files" "SECTdatlogfil"
38059 .cindex "log" "datestamped files"
38060 Instead of cycling the main and reject log files by renaming them
38061 periodically, some sites like to use files whose names contain a datestamp,
38062 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38063 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38064 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38065 point where the datestamp is required. For example:
38066 .code
38067 log_file_path = /var/spool/exim/log/%slog-%D
38068 log_file_path = /var/log/exim-%s-%D.log
38069 log_file_path = /var/spool/exim/log/%D-%slog
38070 log_file_path = /var/log/exim/%s.%M
38071 .endd
38072 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38073 examples of names generated by the above examples:
38074 .code
38075 /var/spool/exim/log/mainlog-20021225
38076 /var/log/exim-reject-20021225.log
38077 /var/spool/exim/log/20021225-mainlog
38078 /var/log/exim/main.200212
38079 .endd
38080 When this form of log file is specified, Exim automatically switches to new
38081 files at midnight. It does not make any attempt to compress old logs; you
38082 will need to write your own script if you require this. You should not
38083 run &'exicyclog'& with this form of logging.
38084
38085 The location of the panic log is also determined by &%log_file_path%&, but it
38086 is not datestamped, because rotation of the panic log does not make sense.
38087 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38088 the string. In addition, if it immediately follows a slash, a following
38089 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38090 character is removed. Thus, the four examples above would give these panic
38091 log names:
38092 .code
38093 /var/spool/exim/log/paniclog
38094 /var/log/exim-panic.log
38095 /var/spool/exim/log/paniclog
38096 /var/log/exim/panic
38097 .endd
38098
38099
38100 .section "Logging to syslog" "SECID249"
38101 .cindex "log" "syslog; writing to"
38102 The use of syslog does not change what Exim logs or the format of its messages,
38103 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38104 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38105 that, the same strings are written to syslog as to log files. The syslog
38106 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38107 by default, but you can change these by setting the &%syslog_facility%& and
38108 &%syslog_processname%& options, respectively. If Exim was compiled with
38109 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38110 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38111 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38112 the time and host name to each line.
38113 The three log streams are mapped onto syslog priorities as follows:
38114
38115 .ilist
38116 &'mainlog'& is mapped to LOG_INFO
38117 .next
38118 &'rejectlog'& is mapped to LOG_NOTICE
38119 .next
38120 &'paniclog'& is mapped to LOG_ALERT
38121 .endlist
38122
38123 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38124 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38125 these are routed by syslog to the same place. You can suppress this duplication
38126 by setting &%syslog_duplication%& false.
38127
38128 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38129 entries contain multiple lines when headers are included. To cope with both
38130 these cases, entries written to syslog are split into separate &[syslog()]&
38131 calls at each internal newline, and also after a maximum of
38132 870 data characters. (This allows for a total syslog line length of 1024, when
38133 additions such as timestamps are added.) If you are running a syslog
38134 replacement that can handle lines longer than the 1024 characters allowed by
38135 RFC 3164, you should set
38136 .code
38137 SYSLOG_LONG_LINES=yes
38138 .endd
38139 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38140 lines, but it still splits at internal newlines in &'reject'& log entries.
38141
38142 To make it easy to re-assemble split lines later, each component of a split
38143 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38144 where <&'n'&> is the component number and <&'m'&> is the total number of
38145 components in the entry. The / delimiter is used when the line was split
38146 because it was too long; if it was split because of an internal newline, the \
38147 delimiter is used. For example, supposing the length limit to be 50 instead of
38148 870, the following would be the result of a typical rejection message to
38149 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38150 name, and pid as added by syslog:
38151 .code
38152 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38153 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38154 [3/5]  when scanning for sender: missing or malformed lo
38155 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38156 [5/5] mple>)
38157 .endd
38158 The same error might cause the following lines to be written to &"rejectlog"&
38159 (LOG_NOTICE):
38160 .code
38161 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38162 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38163 [3/18] er when scanning for sender: missing or malformed
38164 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38165 [5\18] .example>)
38166 [6\18] Recipients: ph10@some.domain.cam.example
38167 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38168 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38169 [9\18]        id 16RdAL-0006pc-00
38170 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38171 [11\18] 09:43 +0100
38172 [12\18] F From: <>
38173 [13\18]   Subject: this is a test header
38174 [18\18]   X-something: this is another header
38175 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38176 [16\18] le>
38177 [17\18] B Bcc:
38178 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38179 .endd
38180 Log lines that are neither too long nor contain newlines are written to syslog
38181 without modification.
38182
38183 If only syslog is being used, the Exim monitor is unable to provide a log tail
38184 display, unless syslog is routing &'mainlog'& to a file on the local host and
38185 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38186 where it is.
38187
38188
38189
38190 .section "Log line flags" "SECID250"
38191 One line is written to the main log for each message received, and for each
38192 successful, unsuccessful, and delayed delivery. These lines can readily be
38193 picked out by the distinctive two-character flags that immediately follow the
38194 timestamp. The flags are:
38195 .display
38196 &`<=`&     message arrival
38197 &`(=`&     message fakereject
38198 &`=>`&     normal message delivery
38199 &`->`&     additional address in same delivery
38200 &`>>`&     cutthrough message delivery
38201 &`*>`&     delivery suppressed by &%-N%&
38202 &`**`&     delivery failed; address bounced
38203 &`==`&     delivery deferred; temporary problem
38204 .endd
38205
38206
38207 .section "Logging message reception" "SECID251"
38208 .cindex "log" "reception line"
38209 The format of the single-line entry in the main log that is written for every
38210 message received is shown in the basic example below, which is split over
38211 several lines in order to fit it on the page:
38212 .code
38213 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38214   H=mailer.fict.example [192.168.123.123] U=exim
38215   P=smtp S=5678 id=<incoming message id>
38216 .endd
38217 The address immediately following &"<="& is the envelope sender address. A
38218 bounce message is shown with the sender address &"<>"&, and if it is locally
38219 generated, this is followed by an item of the form
38220 .code
38221 R=<message id>
38222 .endd
38223 which is a reference to the message that caused the bounce to be sent.
38224
38225 .cindex "HELO"
38226 .cindex "EHLO"
38227 For messages from other hosts, the H and U fields identify the remote host and
38228 record the RFC 1413 identity of the user that sent the message, if one was
38229 received. The number given in square brackets is the IP address of the sending
38230 host. If there is a single, unparenthesized  host name in the H field, as
38231 above, it has been verified to correspond to the IP address (see the
38232 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38233 by the remote host in the SMTP HELO or EHLO command, and has not been
38234 verified. If verification yields a different name to that given for HELO or
38235 EHLO, the verified name appears first, followed by the HELO or EHLO
38236 name in parentheses.
38237
38238 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38239 without brackets, in the HELO or EHLO command, leading to entries in
38240 the log containing text like these examples:
38241 .code
38242 H=(10.21.32.43) [192.168.8.34]
38243 H=([10.21.32.43]) [192.168.8.34]
38244 .endd
38245 This can be confusing. Only the final address in square brackets can be relied
38246 on.
38247
38248 For locally generated messages (that is, messages not received over TCP/IP),
38249 the H field is omitted, and the U field contains the login name of the caller
38250 of Exim.
38251
38252 .cindex "authentication" "logging"
38253 .cindex "AUTH" "logging"
38254 For all messages, the P field specifies the protocol used to receive the
38255 message. This is the value that is stored in &$received_protocol$&. In the case
38256 of incoming SMTP messages, the value indicates whether or not any SMTP
38257 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38258 session was encrypted, there is an additional X field that records the cipher
38259 suite that was used.
38260
38261 .cindex log protocol
38262 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38263 hosts that have authenticated themselves using the SMTP AUTH command. The first
38264 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38265 there is an additional item A= followed by the name of the authenticator that
38266 was used. If an authenticated identification was set up by the authenticator's
38267 &%server_set_id%& option, this is logged too, separated by a colon from the
38268 authenticator name.
38269
38270 .cindex "size" "of message"
38271 The id field records the existing message id, if present. The size of the
38272 received message is given by the S field. When the message is delivered,
38273 headers may be removed or added, so that the size of delivered copies of the
38274 message may not correspond with this value (and indeed may be different to each
38275 other).
38276
38277 The &%log_selector%& option can be used to request the logging of additional
38278 data when a message is received. See section &<<SECTlogselector>>& below.
38279
38280
38281
38282 .section "Logging deliveries" "SECID252"
38283 .cindex "log" "delivery line"
38284 The format of the single-line entry in the main log that is written for every
38285 delivery is shown in one of the examples below, for local and remote
38286 deliveries, respectively. Each example has been split into multiple lines in order
38287 to fit it on the page:
38288 .code
38289 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38290   <marv@hitch.fict.example> R=localuser T=local_delivery
38291 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38292   monk@holistic.fict.example R=dnslookup T=remote_smtp
38293   H=holistic.fict.example [192.168.234.234]
38294 .endd
38295 For ordinary local deliveries, the original address is given in angle brackets
38296 after the final delivery address, which might be a pipe or a file. If
38297 intermediate address(es) exist between the original and the final address, the
38298 last of these is given in parentheses after the final address. The R and T
38299 fields record the router and transport that were used to process the address.
38300
38301 If SMTP AUTH was used for the delivery there is an additional item A=
38302 followed by the name of the authenticator that was used.
38303 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38304 option, this is logged too, as a second colon-separated list item.
38305 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38306
38307 If a shadow transport was run after a successful local delivery, the log line
38308 for the successful delivery has an item added on the end, of the form
38309 .display
38310 &`ST=<`&&'shadow transport name'&&`>`&
38311 .endd
38312 If the shadow transport did not succeed, the error message is put in
38313 parentheses afterwards.
38314
38315 .cindex "asterisk" "after IP address"
38316 When more than one address is included in a single delivery (for example, two
38317 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38318 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38319 down a single SMTP connection, an asterisk follows the
38320 .new
38321 remote IP address (and port if enabled)
38322 .wen
38323 in the log lines for the second and subsequent messages.
38324 When two or more messages are delivered down a single TLS connection, the
38325 DNS and some TLS-related information logged for the first message delivered
38326 will not be present in the log lines for the second and subsequent messages.
38327 TLS cipher information is still available.
38328
38329 .cindex "delivery" "cutthrough; logging"
38330 .cindex "cutthrough" "logging"
38331 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38332 line precedes the reception line, since cutthrough waits for a possible
38333 rejection from the destination in case it can reject the sourced item.
38334
38335 The generation of a reply message by a filter file gets logged as a
38336 &"delivery"& to the addressee, preceded by &">"&.
38337
38338 The &%log_selector%& option can be used to request the logging of additional
38339 data when a message is delivered. See section &<<SECTlogselector>>& below.
38340
38341
38342 .section "Discarded deliveries" "SECID253"
38343 .cindex "discarded messages"
38344 .cindex "message" "discarded"
38345 .cindex "delivery" "discarded; logging"
38346 When a message is discarded as a result of the command &"seen finish"& being
38347 obeyed in a filter file which generates no deliveries, a log entry of the form
38348 .code
38349 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38350   <low.club@bridge.example> R=userforward
38351 .endd
38352 is written, to record why no deliveries are logged. When a message is discarded
38353 because it is aliased to &":blackhole:"& the log line is like this:
38354 .code
38355 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38356   <hole@nowhere.example> R=blackhole_router
38357 .endd
38358
38359
38360 .section "Deferred deliveries" "SECID254"
38361 When a delivery is deferred, a line of the following form is logged:
38362 .code
38363 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38364   R=dnslookup T=smtp defer (146): Connection refused
38365 .endd
38366 In the case of remote deliveries, the error is the one that was given for the
38367 last IP address that was tried. Details of individual SMTP failures are also
38368 written to the log, so the above line would be preceded by something like
38369 .code
38370 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38371   mail1.endrest.example [192.168.239.239]: Connection refused
38372 .endd
38373 When a deferred address is skipped because its retry time has not been reached,
38374 a message is written to the log, but this can be suppressed by setting an
38375 appropriate value in &%log_selector%&.
38376
38377
38378
38379 .section "Delivery failures" "SECID255"
38380 .cindex "delivery" "failure; logging"
38381 If a delivery fails because an address cannot be routed, a line of the
38382 following form is logged:
38383 .code
38384 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38385   <jim@trek99.example>: unknown mail domain
38386 .endd
38387 If a delivery fails at transport time, the router and transport are shown, and
38388 the response from the remote host is included, as in this example:
38389 .code
38390 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38391   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38392   after pipelined RCPT TO:<ace400@pb.example>: host
38393   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38394   <ace400@pb.example>...Addressee unknown
38395 .endd
38396 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38397 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38398 disabling PIPELINING. The log lines for all forms of delivery failure are
38399 flagged with &`**`&.
38400
38401
38402
38403 .section "Fake deliveries" "SECID256"
38404 .cindex "delivery" "fake; logging"
38405 If a delivery does not actually take place because the &%-N%& option has been
38406 used to suppress it, a normal delivery line is written to the log, except that
38407 &"=>"& is replaced by &"*>"&.
38408
38409
38410
38411 .section "Completion" "SECID257"
38412 A line of the form
38413 .code
38414 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38415 .endd
38416 is written to the main log when a message is about to be removed from the spool
38417 at the end of its processing.
38418
38419
38420
38421
38422 .section "Summary of Fields in Log Lines" "SECID258"
38423 .cindex "log" "summary of fields"
38424 A summary of the field identifiers that are used in log lines is shown in
38425 the following table:
38426 .display
38427 &`A   `&        authenticator name (and optional id and sender)
38428 &`C   `&        SMTP confirmation on delivery
38429 &`    `&        command list for &"no mail in SMTP session"&
38430 &`CV  `&        certificate verification status
38431 &`D   `&        duration of &"no mail in SMTP session"&
38432 &`DKIM`&        domain verified in incoming message
38433 &`DN  `&        distinguished name from peer certificate
38434 &`DS  `&        DNSSEC secured lookups
38435 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38436 &`F   `&        sender address (on delivery lines)
38437 &`H   `&        host name and IP address
38438 &`I   `&        local interface used
38439 &`id  `&        message id (from header) for incoming message
38440 &`K   `&        CHUNKING extension used
38441 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38442 &`M8S `&        8BITMIME status for incoming message
38443 &`P   `&        on &`<=`& lines: protocol used
38444 &`    `&        on &`=>`& and &`**`& lines: return path
38445 &`PRDR`&        PRDR extension used
38446 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38447 &`Q   `&        alternate queue name
38448 &`QT  `&        on &`=>`& lines: time spent on queue so far
38449 &`    `&        on &"Completed"& lines: time spent on queue
38450 &`R   `&        on &`<=`& lines: reference for local bounce
38451 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38452 &`RT  `&        on &`<=`& lines: time taken for reception
38453 &`S   `&        size of message in bytes
38454 &`SNI `&        server name indication from TLS client hello
38455 &`ST  `&        shadow transport name
38456 &`T   `&        on &`<=`& lines: message subject (topic)
38457 &`TFO `&        connection took advantage of TCP Fast Open
38458 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38459 &`U   `&        local user or RFC 1413 identity
38460 &`X   `&        TLS cipher suite
38461 .endd
38462
38463
38464 .section "Other log entries" "SECID259"
38465 Various other types of log entry are written from time to time. Most should be
38466 self-explanatory. Among the more common are:
38467
38468 .ilist
38469 .cindex "retry" "time not reached"
38470 &'retry time not reached'&&~&~An address previously suffered a temporary error
38471 during routing or local delivery, and the time to retry has not yet arrived.
38472 This message is not written to an individual message log file unless it happens
38473 during the first delivery attempt.
38474 .next
38475 &'retry time not reached for any host'&&~&~An address previously suffered
38476 temporary errors during remote delivery, and the retry time has not yet arrived
38477 for any of the hosts to which it is routed.
38478 .next
38479 .cindex "spool directory" "file locked"
38480 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38481 some other Exim process is already working on the message. This can be quite
38482 common if queue running processes are started at frequent intervals. The
38483 &'exiwhat'& utility script can be used to find out what Exim processes are
38484 doing.
38485 .next
38486 .cindex "error" "ignored"
38487 &'error ignored'&&~&~There are several circumstances that give rise to this
38488 message:
38489 .olist
38490 Exim failed to deliver a bounce message whose age was greater than
38491 &%ignore_bounce_errors_after%&. The bounce was discarded.
38492 .next
38493 A filter file set up a delivery using the &"noerror"& option, and the delivery
38494 failed. The delivery was discarded.
38495 .next
38496 A delivery set up by a router configured with
38497 . ==== As this is a nested list, any displays it contains must be indented
38498 . ==== as otherwise they are too far to the left.
38499 .code
38500     errors_to = <>
38501 .endd
38502 failed. The delivery was discarded.
38503 .endlist olist
38504 .next
38505 .cindex DKIM "log line"
38506 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38507 logging and the message has a DKIM signature header.
38508 .endlist ilist
38509
38510
38511
38512
38513
38514 .section "Reducing or increasing what is logged" "SECTlogselector"
38515 .cindex "log" "selectors"
38516 By setting the &%log_selector%& global option, you can disable some of Exim's
38517 default logging, or you can request additional logging. The value of
38518 &%log_selector%& is made up of names preceded by plus or minus characters. For
38519 example:
38520 .code
38521 log_selector = +arguments -retry_defer
38522 .endd
38523 The list of optional log items is in the following table, with the default
38524 selection marked by asterisks:
38525 .display
38526 &` 8bitmime                   `&  received 8BITMIME status
38527 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
38528 &` address_rewrite            `&  address rewriting
38529 &` all_parents                `&  all parents in => lines
38530 &` arguments                  `&  command line arguments
38531 &`*connection_reject          `&  connection rejections
38532 &`*delay_delivery             `&  immediate delivery delayed
38533 &` deliver_time               `&  time taken to attempt delivery
38534 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
38535 &`*dkim                       `&  DKIM verified domain on <= lines
38536 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
38537 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
38538 &` dnssec                     `&  DNSSEC secured lookups
38539 &`*etrn                       `&  ETRN commands
38540 &`*host_lookup_failed         `&  as it says
38541 &` ident_timeout              `&  timeout for ident connection
38542 &` incoming_interface         `&  local interface on <= and => lines
38543 &` incoming_port              `&  remote port on <= lines
38544 &`*lost_incoming_connection   `&  as it says (includes timeouts)
38545 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38546 &`*msg_id                     `&  on <= lines, Message-ID: header value
38547 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38548 &` outgoing_interface         `&  local interface on => lines
38549 &` outgoing_port              `&  add remote port to => lines
38550 &`*queue_run                  `&  start and end queue runs
38551 &` queue_time                 `&  time on queue for one recipient
38552 &` queue_time_overall         `&  time on queue for whole message
38553 &` pid                        `&  Exim process id
38554 &` pipelining                 `&  PIPELINING use, on <= and => lines
38555 &` proxy                      `&  proxy address on <= and => lines
38556 &` receive_time               `&  time taken to receive message
38557 &` received_recipients        `&  recipients on <= lines
38558 &` received_sender            `&  sender on <= lines
38559 &`*rejected_header            `&  header contents on reject log
38560 &`*retry_defer                `&  &"retry time not reached"&
38561 &` return_path_on_delivery    `&  put return path on => and ** lines
38562 &` sender_on_delivery         `&  add sender to => lines
38563 &`*sender_verify_fail         `&  sender verification failures
38564 &`*size_reject                `&  rejection because too big
38565 &`*skip_delivery              `&  delivery skipped in a queue run
38566 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38567 &` smtp_connection            `&  incoming SMTP connections
38568 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38569 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38570 &` smtp_no_mail               `&  session with no MAIL commands
38571 &` smtp_protocol_error        `&  SMTP protocol errors
38572 &` smtp_syntax_error          `&  SMTP syntax errors
38573 &` subject                    `&  contents of &'Subject:'& on <= lines
38574 &`*tls_certificate_verified   `&  certificate verification status
38575 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38576 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38577 &` tls_resumption             `&  append * to cipher field
38578 &` tls_sni                    `&  TLS SNI on <= lines
38579 &` unknown_in_list            `&  DNS lookup failed in list match
38580
38581 &` all                        `&  all of the above
38582 .endd
38583 See also the &%slow_lookup_log%& main configuration option,
38584 section &<<SECID99>>&
38585
38586 More details on each of these items follows:
38587
38588 .ilist
38589 .cindex "8BITMIME"
38590 .cindex "log" "8BITMIME"
38591 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38592 which may help in tracking down interoperability issues with ancient MTAs
38593 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38594 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38595 &`7BIT`& and &`8BITMIME`& respectively.
38596 .next
38597 .cindex "&%warn%& ACL verb" "log when skipping"
38598 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38599 its conditions cannot be evaluated, a log line to this effect is written if
38600 this log selector is set.
38601 .next
38602 .cindex "log" "rewriting"
38603 .cindex "rewriting" "logging"
38604 &%address_rewrite%&: This applies both to global rewrites and per-transport
38605 rewrites, but not to rewrites in filters run as an unprivileged user (because
38606 such users cannot access the log).
38607 .next
38608 .cindex "log" "full parentage"
38609 &%all_parents%&: Normally only the original and final addresses are logged on
38610 delivery lines; with this selector, intermediate parents are given in
38611 parentheses between them.
38612 .next
38613 .cindex "log" "Exim arguments"
38614 .cindex "Exim arguments, logging"
38615 &%arguments%&: This causes Exim to write the arguments with which it was called
38616 to the main log, preceded by the current working directory. This is a debugging
38617 feature, added to make it easier to find out how certain MUAs call
38618 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38619 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38620 that are empty or that contain white space are quoted. Non-printing characters
38621 are shown as escape sequences. This facility cannot log unrecognized arguments,
38622 because the arguments are checked before the configuration file is read. The
38623 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38624 between the caller and Exim.
38625 .next
38626 .cindex "log" "connection rejections"
38627 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38628 connection is rejected, for whatever reason.
38629 .next
38630 .cindex "log" "delayed delivery"
38631 .cindex "delayed delivery, logging"
38632 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38633 started for an incoming message because the load is too high or too many
38634 messages were received on one connection. Logging does not occur if no delivery
38635 process is started because &%queue_only%& is set or &%-odq%& was used.
38636 .next
38637 .cindex "log" "delivery duration"
38638 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38639 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38640 If millisecond logging is enabled, short times will be shown with greater
38641 precision, eg. &`DT=0.304s`&.
38642 .next
38643 .cindex "log" "message size on delivery"
38644 .cindex "size" "of message"
38645 &%delivery_size%&: For each delivery, the size of message delivered is added to
38646 the &"=>"& line, tagged with S=.
38647 .next
38648 .cindex log "DKIM verification"
38649 .cindex DKIM "verification logging"
38650 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38651 verifies successfully a tag of DKIM is added, with one of the verified domains.
38652 .next
38653 .cindex log "DKIM verification"
38654 .cindex DKIM "verification logging"
38655 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38656 .next
38657 .cindex "log" "dnslist defer"
38658 .cindex "DNS list" "logging defer"
38659 .cindex "black list (DNS)"
38660 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38661 DNS black list suffers a temporary error.
38662 .next
38663 .cindex log dnssec
38664 .cindex dnssec logging
38665 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38666 dns lookups gave secure results a tag of DS is added.
38667 For acceptance this covers the reverse and forward lookups for host name verification.
38668 It does not cover helo-name verification.
38669 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38670 .next
38671 .cindex "log" "ETRN commands"
38672 .cindex "ETRN" "logging"
38673 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38674 is run to determine whether or not it is actually accepted. An invalid ETRN
38675 command, or one received within a message transaction is not logged by this
38676 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38677 .next
38678 .cindex "log" "host lookup failure"
38679 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38680 any addresses, or when a lookup of an IP address fails to find a host name, a
38681 log line is written. This logging does not apply to direct DNS lookups when
38682 routing email addresses, but it does apply to &"byname"& lookups.
38683 .next
38684 .cindex "log" "ident timeout"
38685 .cindex "RFC 1413" "logging timeout"
38686 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38687 client's ident port times out.
38688 .next
38689 .cindex "log" "incoming interface"
38690 .cindex "log" "outgoing interface"
38691 .cindex "log" "local interface"
38692 .cindex "log" "local address and port"
38693 .cindex "TCP/IP" "logging local address and port"
38694 .cindex "interface" "logging"
38695 &%incoming_interface%&: The interface on which a message was received is added
38696 to the &"<="& line as an IP address in square brackets, tagged by I= and
38697 followed by a colon and the port number. The local interface and port are also
38698 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38699 rejection lines, and (despite the name) to outgoing
38700 .new
38701 &"=>"&, &"->"&, &"=="& and &"**"& lines.
38702 .wen
38703 The latter can be disabled by turning off the &%outgoing_interface%& option.
38704 .next
38705 .cindex log "incoming proxy address"
38706 .cindex proxy "logging proxy address"
38707 .cindex "TCP/IP" "logging proxy address"
38708 &%proxy%&: The internal (closest to the system running Exim) IP address
38709 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38710 on a proxied connection
38711 or the &"=>"& line for a message delivered on a proxied connection.
38712 See &<<SECTproxyInbound>>& for more information.
38713 .next
38714 .cindex "log" "incoming remote port"
38715 .cindex "port" "logging remote"
38716 .cindex "TCP/IP" "logging incoming remote port"
38717 .vindex "&$sender_fullhost$&"
38718 .vindex "&$sender_rcvhost$&"
38719 &%incoming_port%&: The remote port number from which a message was received is
38720 added to log entries and &'Received:'& header lines, following the IP address
38721 in square brackets, and separated from it by a colon. This is implemented by
38722 changing the value that is put in the &$sender_fullhost$& and
38723 &$sender_rcvhost$& variables. Recording the remote port number has become more
38724 important with the widening use of NAT (see RFC 2505).
38725 .next
38726 .cindex "log" "dropped connection"
38727 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38728 connection is unexpectedly dropped.
38729 .next
38730 .cindex "log" "millisecond timestamps"
38731 .cindex millisecond logging
38732 .cindex timestamps "millisecond, in logs"
38733 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38734 appended to the seconds value.
38735 .next
38736 .cindex "log" "message id"
38737 &%msg_id%&: The value of the Message-ID: header.
38738 .next
38739 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38740 This will be either because the message is a bounce, or was submitted locally
38741 (submission mode) without one.
38742 The field identifier will have an asterix appended: &"id*="&.
38743 .next
38744 .cindex "log" "outgoing interface"
38745 .cindex "log" "local interface"
38746 .cindex "log" "local address and port"
38747 .cindex "TCP/IP" "logging local address and port"
38748 .cindex "interface" "logging"
38749 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38750 interface on which a message was sent is added to delivery lines as an I= tag
38751 followed by IP address in square brackets. You can disable this by turning
38752 off the &%outgoing_interface%& option.
38753 .next
38754 .cindex "log" "outgoing remote port"
38755 .cindex "port" "logging outgoing remote"
38756 .cindex "TCP/IP" "logging outgoing remote port"
38757 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38758 containing => tags) following the IP address.
38759 The local port is also added if &%incoming_interface%& and
38760 &%outgoing_interface%& are both enabled.
38761 This option is not included in the default setting, because for most ordinary
38762 configurations, the remote port number is always 25 (the SMTP port), and the
38763 local port is a random ephemeral port.
38764 .next
38765 .cindex "log" "process ids in"
38766 .cindex "pid (process id)" "in log lines"
38767 &%pid%&: The current process id is added to every log line, in square brackets,
38768 immediately after the time and date.
38769 .next
38770 .cindex log pipelining
38771 .cindex pipelining "logging outgoing"
38772 &%pipelining%&: A field is added to delivery and accept
38773 log lines when the ESMTP PIPELINING extension was used.
38774 The field is a single "L".
38775
38776 On accept lines, where PIPELINING was offered but not used by the client,
38777 the field has a minus appended.
38778
38779 .cindex "pipelining" "early connection"
38780 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38781 accept "L" fields have a period appended if the feature was
38782 offered but not used, or an asterisk appended if used.
38783 Delivery "L" fields have an asterisk appended if used.
38784
38785 .next
38786 .cindex "log" "queue run"
38787 .cindex "queue runner" "logging"
38788 &%queue_run%&: The start and end of every queue run are logged.
38789 .next
38790 .cindex "log" "queue time"
38791 &%queue_time%&: The amount of time the message has been in the queue on the
38792 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38793 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38794 includes reception time as well as the delivery time for the current address.
38795 This means that it may be longer than the difference between the arrival and
38796 delivery log line times, because the arrival log line is not written until the
38797 message has been successfully received.
38798 If millisecond logging is enabled, short times will be shown with greater
38799 precision, eg. &`QT=1.578s`&.
38800 .next
38801 &%queue_time_overall%&: The amount of time the message has been in the queue on
38802 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38803 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38804 message, so it includes reception time as well as the total delivery time.
38805 .next
38806 .cindex "log" "receive duration"
38807 &%receive_time%&: For each message, the amount of real time it has taken to
38808 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38809 If millisecond logging is enabled, short times will be shown with greater
38810 precision, eg. &`RT=0.204s`&.
38811 .next
38812 .cindex "log" "recipients"
38813 &%received_recipients%&: The recipients of a message are listed in the main log
38814 as soon as the message is received. The list appears at the end of the log line
38815 that is written when a message is received, preceded by the word &"for"&. The
38816 addresses are listed after they have been qualified, but before any rewriting
38817 has taken place.
38818 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38819 in the list.
38820 .next
38821 .cindex "log" "sender reception"
38822 &%received_sender%&: The unrewritten original sender of a message is added to
38823 the end of the log line that records the message's arrival, after the word
38824 &"from"& (before the recipients if &%received_recipients%& is also set).
38825 .next
38826 .cindex "log" "header lines for rejection"
38827 &%rejected_header%&: If a message's header has been received at the time a
38828 rejection is written to the reject log, the complete header is added to the
38829 log. Header logging can be turned off individually for messages that are
38830 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38831 .next
38832 .cindex "log" "retry defer"
38833 &%retry_defer%&: A log line is written if a delivery is deferred because a
38834 retry time has not yet been reached. However, this &"retry time not reached"&
38835 message is always omitted from individual message logs after the first delivery
38836 attempt.
38837 .next
38838 .cindex "log" "return path"
38839 &%return_path_on_delivery%&: The return path that is being transmitted with
38840 the message is included in delivery and bounce lines, using the tag P=.
38841 This is omitted if no delivery actually happens, for example, if routing fails,
38842 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38843 .next
38844 .cindex "log" "sender on delivery"
38845 &%sender_on_delivery%&: The message's sender address is added to every delivery
38846 and bounce line, tagged by F= (for &"from"&).
38847 This is the original sender that was received with the message; it is not
38848 necessarily the same as the outgoing return path.
38849 .next
38850 .cindex "log" "sender verify failure"
38851 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38852 gives details of a sender verification failure is not written. Log lines for
38853 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38854 detail is lost.
38855 .next
38856 .cindex "log" "size rejection"
38857 &%size_reject%&: A log line is written whenever a message is rejected because
38858 it is too big.
38859 .next
38860 .cindex "log" "frozen messages; skipped"
38861 .cindex "frozen messages" "logging skipping"
38862 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38863 queue run because it is frozen or because another process is already delivering
38864 it.
38865 .cindex "&""spool file is locked""&"
38866 The message that is written is &"spool file is locked"&.
38867 .next
38868 .cindex "log" "smtp confirmation"
38869 .cindex "SMTP" "logging confirmation"
38870 .cindex "LMTP" "logging confirmation"
38871 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38872 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38873 A number of MTAs (including Exim) return an identifying string in this
38874 response.
38875 .next
38876 .cindex "log" "SMTP connections"
38877 .cindex "SMTP" "logging connections"
38878 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38879 established or closed, unless the connection is from a host that matches
38880 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38881 only when the closure is unexpected.) This applies to connections from local
38882 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38883 dropped in the middle of a message, a log line is always written, whether or
38884 not this selector is set, but otherwise nothing is written at the start and end
38885 of connections unless this selector is enabled.
38886
38887 For TCP/IP connections to an Exim daemon, the current number of connections is
38888 included in the log message for each new connection, but note that the count is
38889 reset if the daemon is restarted.
38890 Also, because connections are closed (and the closure is logged) in
38891 subprocesses, the count may not include connections that have been closed but
38892 whose termination the daemon has not yet noticed. Thus, while it is possible to
38893 match up the opening and closing of connections in the log, the value of the
38894 logged counts may not be entirely accurate.
38895 .next
38896 .cindex "log" "SMTP transaction; incomplete"
38897 .cindex "SMTP" "logging incomplete transactions"
38898 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38899 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38900 and the message sender plus any accepted recipients are included in the log
38901 line. This can provide evidence of dictionary attacks.
38902 .next
38903 .cindex "log" "non-MAIL SMTP sessions"
38904 .cindex "MAIL" "logging session without"
38905 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38906 connection terminates without having issued a MAIL command. This includes both
38907 the case when the connection is dropped, and the case when QUIT is used. It
38908 does not include cases where the connection is rejected right at the start (by
38909 an ACL, or because there are too many connections, or whatever). These cases
38910 already have their own log lines.
38911
38912 The log line that is written contains the identity of the client in the usual
38913 way, followed by D= and a time, which records the duration of the connection.
38914 If the connection was authenticated, this fact is logged exactly as it is for
38915 an incoming message, with an A= item. If the connection was encrypted, CV=,
38916 DN=, and X= items may appear as they do for an incoming message, controlled by
38917 the same logging options.
38918
38919 Finally, if any SMTP commands were issued during the connection, a C= item
38920 is added to the line, listing the commands that were used. For example,
38921 .code
38922 C=EHLO,QUIT
38923 .endd
38924 shows that the client issued QUIT straight after EHLO. If there were fewer
38925 than 20 commands, they are all listed. If there were more than 20 commands,
38926 the last 20 are listed, preceded by &"..."&. However, with the default
38927 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38928 have been aborted before 20 non-mail commands are processed.
38929 .next
38930 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38931 colon-separated, is appended to the A= item for a message arrival or delivery
38932 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38933 was accepted or used.
38934 .next
38935 .cindex "log" "SMTP protocol error"
38936 .cindex "SMTP" "logging protocol error"
38937 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38938 encountered. Exim does not have perfect detection of all protocol errors
38939 because of transmission delays and the use of pipelining. If PIPELINING has
38940 been advertised to a client, an Exim server assumes that the client will use
38941 it, and therefore it does not count &"expected"& errors (for example, RCPT
38942 received after rejecting MAIL) as protocol errors.
38943 .next
38944 .cindex "SMTP" "logging syntax errors"
38945 .cindex "SMTP" "syntax errors; logging"
38946 .cindex "SMTP" "unknown command; logging"
38947 .cindex "log" "unknown SMTP command"
38948 .cindex "log" "SMTP syntax error"
38949 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38950 encountered. An unrecognized command is treated as a syntax error. For an
38951 external connection, the host identity is given; for an internal connection
38952 using &%-bs%& the sender identification (normally the calling user) is given.
38953 .next
38954 .cindex "log" "subject"
38955 .cindex "subject, logging"
38956 &%subject%&: The subject of the message is added to the arrival log line,
38957 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38958 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38959 specifies whether characters with values greater than 127 should be logged
38960 unchanged, or whether they should be rendered as escape sequences.
38961 .next
38962 .cindex "log" "certificate verification"
38963 .cindex log DANE
38964 .cindex DANE logging
38965 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38966 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38967 verified
38968 using a CA trust anchor,
38969 &`CA=dane`& if using a DNS trust anchor,
38970 and &`CV=no`& if not.
38971 .next
38972 .cindex "log" "TLS cipher"
38973 .cindex "TLS" "logging cipher"
38974 &%tls_cipher%&: When a message is sent or received over an encrypted
38975 connection, the cipher suite used is added to the log line, preceded by X=.
38976 .next
38977 .cindex "log" "TLS peer DN"
38978 .cindex "TLS" "logging peer DN"
38979 &%tls_peerdn%&: When a message is sent or received over an encrypted
38980 connection, and a certificate is supplied by the remote host, the peer DN is
38981 added to the log line, preceded by DN=.
38982 .next
38983 .cindex "log" "TLS resumption"
38984 .cindex "TLS" "logging session resumption"
38985 .new
38986 &%tls_resumption%&: When a message is sent or received over an encrypted
38987 connection and the TLS session resumed one used on a previous TCP connection,
38988 an asterisk is appended to the X= cipher field in the log line.
38989 .wen
38990 .next
38991 .cindex "log" "TLS SNI"
38992 .cindex "TLS" "logging SNI"
38993 .cindex SNI logging
38994 &%tls_sni%&: When a message is received over an encrypted connection, and
38995 the remote host provided the Server Name Indication extension, the SNI is
38996 added to the log line, preceded by SNI=.
38997 .next
38998 .cindex "log" "DNS failure in list"
38999 &%unknown_in_list%&: This setting causes a log entry to be written when the
39000 result of a list match is failure because a DNS lookup failed.
39001 .endlist
39002
39003
39004 .section "Message log" "SECID260"
39005 .cindex "message" "log file for"
39006 .cindex "log" "message log; description of"
39007 .cindex "&_msglog_& directory"
39008 .oindex "&%preserve_message_logs%&"
39009 In addition to the general log files, Exim writes a log file for each message
39010 that it handles. The names of these per-message logs are the message ids, and
39011 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39012 message log contains copies of the log lines that apply to the message. This
39013 makes it easier to inspect the status of an individual message without having
39014 to search the main log. A message log is deleted when processing of the message
39015 is complete, unless &%preserve_message_logs%& is set, but this should be used
39016 only with great care because they can fill up your disk very quickly.
39017
39018 On a heavily loaded system, it may be desirable to disable the use of
39019 per-message logs, in order to reduce disk I/O. This can be done by setting the
39020 &%message_logs%& option false.
39021 .ecindex IIDloggen
39022
39023
39024
39025
39026 . ////////////////////////////////////////////////////////////////////////////
39027 . ////////////////////////////////////////////////////////////////////////////
39028
39029 .chapter "Exim utilities" "CHAPutils"
39030 .scindex IIDutils "utilities"
39031 A number of utility scripts and programs are supplied with Exim and are
39032 described in this chapter. There is also the Exim Monitor, which is covered in
39033 the next chapter. The utilities described here are:
39034
39035 .itable none 0 0 3  7* left  15* left  40* left
39036 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39037   "list what Exim processes are doing"
39038 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39039 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39040 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39041 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39042                                                 various criteria"
39043 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39044 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39045   "extract statistics from the log"
39046 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39047   "check address acceptance from given IP"
39048 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39049 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39050 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39051 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39052 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39053 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39054 .endtable
39055
39056 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39057 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39058 &url(https://duncanthrax.net/exilog/) for details.
39059
39060
39061
39062
39063 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39064 .cindex "&'exiwhat'&"
39065 .cindex "process, querying"
39066 .cindex "SIGUSR1"
39067 On operating systems that can restart a system call after receiving a signal
39068 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39069 a line describing what it is doing to the file &_exim-process.info_& in the
39070 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39071 processes it can find, having first emptied the file. It then waits for one
39072 second to allow the Exim processes to react before displaying the results. In
39073 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39074 send the signal to the Exim processes, so it is normally run as root.
39075
39076 &*Warning*&: This is not an efficient process. It is intended for occasional
39077 use by system administrators. It is not sensible, for example, to set up a
39078 script that sends SIGUSR1 signals to Exim processes at short intervals.
39079
39080
39081 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39082 varies in different operating systems. Not only are different options used,
39083 but the format of the output is different. For this reason, there are some
39084 system configuration options that configure exactly how &'exiwhat'& works. If
39085 it doesn't seem to be working for you, check the following compile-time
39086 options:
39087 .display
39088 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
39089 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
39090 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
39091 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
39092 .endd
39093 An example of typical output from &'exiwhat'& is
39094 .code
39095 164 daemon: -q1h, listening on port 25
39096 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39097 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39098   [10.19.42.42] (editor@ref.example)
39099 10592 handling incoming call from [192.168.243.242]
39100 10628 accepting a local non-SMTP message
39101 .endd
39102 The first number in the output line is the process number. The third line has
39103 been split here, in order to fit it on the page.
39104
39105
39106
39107 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39108 .cindex "&'exiqgrep'&"
39109 .cindex "queue" "grepping"
39110 This utility is a Perl script contributed by Matt Hubbard. It runs
39111 .code
39112 exim -bpu
39113 .endd
39114 or (in case &*-a*& switch is specified)
39115 .code
39116 exim -bp
39117 .endd
39118 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
39119 contain alternate exim configuration the queue management might be using.
39120
39121 to obtain a queue listing, and then greps the output to select messages
39122 that match given criteria. The following selection options are available:
39123
39124 .vlist
39125 .vitem &*-f*&&~<&'regex'&>
39126 Match the sender address using a case-insensitive search. The field that is
39127 tested is enclosed in angle brackets, so you can test for bounce messages with
39128 .code
39129 exiqgrep -f '^<>$'
39130 .endd
39131 .vitem &*-r*&&~<&'regex'&>
39132 Match a recipient address using a case-insensitive search. The field that is
39133 tested is not enclosed in angle brackets.
39134
39135 .vitem &*-s*&&~<&'regex'&>
39136 Match against the size field.
39137
39138 .vitem &*-y*&&~<&'seconds'&>
39139 Match messages that are younger than the given time.
39140
39141 .vitem &*-o*&&~<&'seconds'&>
39142 Match messages that are older than the given time.
39143
39144 .vitem &*-z*&
39145 Match only frozen messages.
39146
39147 .vitem &*-x*&
39148 Match only non-frozen messages.
39149
39150 .vitem &*-G*&&~<&'queuename'&>
39151 Match only messages in the given queue.  Without this, the default queue is searched.
39152 .endlist
39153
39154 The following options control the format of the output:
39155
39156 .vlist
39157 .vitem &*-c*&
39158 Display only the count of matching messages.
39159
39160 .vitem &*-l*&
39161 Long format &-- display the full message information as output by Exim. This is
39162 the default.
39163
39164 .vitem &*-i*&
39165 Display message ids only.
39166
39167 .vitem &*-b*&
39168 Brief format &-- one line per message.
39169
39170 .vitem &*-R*&
39171 Display messages in reverse order.
39172
39173 .vitem &*-a*&
39174 Include delivered recipients in queue listing.
39175 .endlist
39176
39177 There is one more option, &%-h%&, which outputs a list of options.
39178
39179
39180
39181 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39182 .cindex "&'exiqsumm'&"
39183 .cindex "queue" "summary"
39184 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39185 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39186 running a command such as
39187 .code
39188 exim -bp | exiqsumm
39189 .endd
39190 The output consists of one line for each domain that has messages waiting for
39191 it, as in the following example:
39192 .code
39193 3   2322   74m   66m  msn.com.example
39194 .endd
39195 Each line lists the number of pending deliveries for a domain, their total
39196 volume, and the length of time that the oldest and the newest messages have
39197 been waiting. Note that the number of pending deliveries is greater than the
39198 number of messages when messages have more than one recipient.
39199
39200 A summary line is output at the end. By default the output is sorted on the
39201 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39202 the output to be sorted by oldest message and by count of messages,
39203 respectively. There are also three options that split the messages for each
39204 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39205 separates frozen messages, and &%-s%& separates messages according to their
39206 sender.
39207
39208 The output of &'exim -bp'& contains the original addresses in the message, so
39209 this also applies to the output from &'exiqsumm'&. No domains from addresses
39210 generated by aliasing or forwarding are included (unless the &%one_time%&
39211 option of the &(redirect)& router has been used to convert them into &"top
39212 level"& addresses).
39213
39214
39215
39216
39217 .section "Extracting specific information from the log (exigrep)" &&&
39218          "SECTextspeinf"
39219 .cindex "&'exigrep'&"
39220 .cindex "log" "extracts; grepping for"
39221 The &'exigrep'& utility is a Perl script that searches one or more main log
39222 files for entries that match a given pattern. When it finds a match, it
39223 extracts all the log entries for the relevant message, not just those that
39224 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39225 given message, or all mail for a given user, or for a given host, for example.
39226 The input files can be in Exim log format or syslog format.
39227 If a matching log line is not associated with a specific message, it is
39228 included in &'exigrep'&'s output without any additional lines. The usage is:
39229 .display
39230 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39231 .endd
39232 If no log filenames are given on the command line, the standard input is read.
39233
39234 The &%-t%& argument specifies a number of seconds. It adds an additional
39235 condition for message selection. Messages that are complete are shown only if
39236 they spent more than <&'n'&> seconds in the queue.
39237
39238 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39239 makes it case-sensitive. This may give a performance improvement when searching
39240 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39241 option; with &%-I%& they do not. In both cases it is possible to change the
39242 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39243
39244 The &%-l%& option means &"literal"&, that is, treat all characters in the
39245 pattern as standing for themselves. Otherwise the pattern must be a Perl
39246 regular expression.
39247
39248 The &%-v%& option inverts the matching condition. That is, a line is selected
39249 if it does &'not'& match the pattern.
39250
39251 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39252 that are generated as a result/response to a message that &'exigrep'& matched
39253 normally.
39254
39255 Example of &%-M%&:
39256 user_a sends a message to user_b, which generates a bounce back to user_b. If
39257 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39258 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39259 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39260 when searching for &"user_a"& will show both messages since the bounce is
39261 &"related"& to or a &"result"& of the first message that was found by the
39262 search term.
39263
39264 If the location of a &'zcat'& command is known from the definition of
39265 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39266 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39267 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39268 autodetection of some well known compression extensions.
39269
39270
39271 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39272 .cindex "&'exipick'&"
39273 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39274 lists messages from the queue according to a variety of criteria. For details
39275 of &'exipick'&'s facilities, run &'exipick'& with
39276 the &%--help%& option.
39277
39278
39279 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39280 .cindex "log" "cycling local files"
39281 .cindex "cycling logs"
39282 .cindex "&'exicyclog'&"
39283 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39284 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39285 you are using log files with datestamps in their names (see section
39286 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39287 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39288 There are two command line options for &'exicyclog'&:
39289 .ilist
39290 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39291 default that is set when Exim is built. The default default is 10.
39292 .next
39293 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39294 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39295 overriding the script's default, which is to find the setting from Exim's
39296 configuration.
39297 .endlist
39298
39299 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39300 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39301 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39302 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39303 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39304 logs are handled similarly.
39305
39306 If the limit is greater than 99, the script uses 3-digit numbers such as
39307 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39308 to one that is greater, or &'vice versa'&, you will have to fix the names of
39309 any existing log files.
39310
39311 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39312 the end are deleted. All files with numbers greater than 01 are compressed,
39313 using a compression command which is configured by the COMPRESS_COMMAND
39314 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39315 root &%crontab%& entry of the form
39316 .code
39317 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39318 .endd
39319 assuming you have used the name &"exim"& for the Exim user. You can run
39320 &'exicyclog'& as root if you wish, but there is no need.
39321
39322
39323
39324 .section "Mail statistics (eximstats)" "SECTmailstat"
39325 .cindex "statistics"
39326 .cindex "&'eximstats'&"
39327 A Perl script called &'eximstats'& is provided for extracting statistical
39328 information from log files. The output is either plain text, or HTML.
39329 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39330 . --- 404 error and everything else points to that.
39331
39332 The &'eximstats'& script has been hacked about quite a bit over time. The
39333 latest version is the result of some extensive revision by Steve Campbell. A
39334 lot of information is given by default, but there are options for suppressing
39335 various parts of it. Following any options, the arguments to the script are a
39336 list of files, which should be main log files. For example:
39337 .code
39338 eximstats -nr /var/spool/exim/log/mainlog.01
39339 .endd
39340 By default, &'eximstats'& extracts information about the number and volume of
39341 messages received from or delivered to various hosts. The information is sorted
39342 both by message count and by volume, and the top fifty hosts in each category
39343 are listed on the standard output. Similar information, based on email
39344 addresses or domains instead of hosts can be requested by means of various
39345 options. For messages delivered and received locally, similar statistics are
39346 also produced per user.
39347
39348 The output also includes total counts and statistics about delivery errors, and
39349 histograms showing the number of messages received and deliveries made in each
39350 hour of the day. A delivery with more than one address in its envelope (for
39351 example, an SMTP transaction with more than one RCPT command) is counted
39352 as a single delivery by &'eximstats'&.
39353
39354 Though normally more deliveries than receipts are reported (as messages may
39355 have multiple recipients), it is possible for &'eximstats'& to report more
39356 messages received than delivered, even though the queue is empty at the start
39357 and end of the period in question. If an incoming message contains no valid
39358 recipients, no deliveries are recorded for it. A bounce message is handled as
39359 an entirely separate message.
39360
39361 &'eximstats'& always outputs a grand total summary giving the volume and number
39362 of messages received and deliveries made, and the number of hosts involved in
39363 each case. It also outputs the number of messages that were delayed (that is,
39364 not completely delivered at the first attempt), and the number that had at
39365 least one address that failed.
39366
39367 The remainder of the output is in sections that can be independently disabled
39368 or modified by various options. It consists of a summary of deliveries by
39369 transport, histograms of messages received and delivered per time interval
39370 (default per hour), information about the time messages spent in the queue,
39371 a list of relayed messages, lists of the top fifty sending hosts, local
39372 senders, destination hosts, and destination local users by count and by volume,
39373 and a list of delivery errors that occurred.
39374
39375 The relay information lists messages that were actually relayed, that is, they
39376 came from a remote host and were directly delivered to some other remote host,
39377 without being processed (for example, for aliasing or forwarding) locally.
39378
39379 There are quite a few options for &'eximstats'& to control exactly what it
39380 outputs. These are documented in the Perl script itself, and can be extracted
39381 by running the command &(perldoc)& on the script. For example:
39382 .code
39383 perldoc /usr/exim/bin/eximstats
39384 .endd
39385
39386 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39387 .cindex "&'exim_checkaccess'&"
39388 .cindex "policy control" "checking access"
39389 .cindex "checking access"
39390 The &%-bh%& command line argument allows you to run a fake SMTP session with
39391 debugging output, in order to check what Exim is doing when it is applying
39392 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39393 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39394 sometimes you just want to answer the question &"Does this address have
39395 access?"& without bothering with any further details.
39396
39397 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39398 two arguments, an IP address and an email address:
39399 .code
39400 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39401 .endd
39402 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39403 given email address would be accepted in a RCPT command in a TCP/IP
39404 connection from the host with the given IP address. The output of the utility
39405 is either the word &"accepted"&, or the SMTP error response, for example:
39406 .code
39407 Rejected:
39408 550 Relay not permitted
39409 .endd
39410 When running this test, the utility uses &`<>`& as the envelope sender address
39411 for the MAIL command, but you can change this by providing additional
39412 options. These are passed directly to the Exim command. For example, to specify
39413 that the test is to be run with the sender address &'himself@there.example'&
39414 you can use:
39415 .code
39416 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39417                  -f himself@there.example
39418 .endd
39419 Note that these additional Exim command line items must be given after the two
39420 mandatory arguments.
39421
39422 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39423 while running its checks. You can run checks that include callouts by using
39424 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39425
39426
39427
39428 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39429 .cindex "DBM" "building dbm files"
39430 .cindex "building DBM files"
39431 .cindex "&'exim_dbmbuild'&"
39432 .cindex "lower casing"
39433 .cindex "binary zero" "in lookup key"
39434 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39435 the format used by the &(lsearch)& lookup (see section
39436 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39437 names as keys and the remainder of the information as data. The lower-casing
39438 can be prevented by calling the program with the &%-nolc%& option.
39439
39440 A terminating zero is included as part of the key string. This is expected by
39441 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39442 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39443 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39444 files.
39445
39446 The program requires two arguments: the name of the input file (which can be a
39447 single hyphen to indicate the standard input), and the name of the output file.
39448 It creates the output under a temporary name, and then renames it if all went
39449 well.
39450
39451 .cindex "USE_DB"
39452 If the native DB interface is in use (USE_DB is set in a compile-time
39453 configuration file &-- this is common in free versions of Unix) the two
39454 filenames must be different, because in this mode the Berkeley DB functions
39455 create a single output file using exactly the name given. For example,
39456 .code
39457 exim_dbmbuild /etc/aliases /etc/aliases.db
39458 .endd
39459 reads the system alias file and creates a DBM version of it in
39460 &_/etc/aliases.db_&.
39461
39462 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39463 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39464 environment, the suffixes are added to the second argument of
39465 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39466 when the Berkeley functions are used in compatibility mode (though this is not
39467 recommended), because in that case it adds a &_.db_& suffix to the filename.
39468
39469 If a duplicate key is encountered, the program outputs a warning, and when it
39470 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39471 option is used. By default, only the first of a set of duplicates is used &--
39472 this makes it compatible with &(lsearch)& lookups. There is an option
39473 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39474 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39475 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39476 return code is 2.
39477
39478
39479
39480
39481 .section "Finding individual retry times (exinext)" "SECTfinindret"
39482 .cindex "retry" "times"
39483 .cindex "&'exinext'&"
39484 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39485 fish specific information out of the retry database. Given a mail domain (or a
39486 complete address), it looks up the hosts for that domain, and outputs any retry
39487 information for the hosts or for the domain. At present, the retry information
39488 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39489 output. For example:
39490 .code
39491 $ exinext piglet@milne.fict.example
39492 kanga.milne.example:192.168.8.1 error 146: Connection refused
39493   first failed: 21-Feb-1996 14:57:34
39494   last tried:   21-Feb-1996 14:57:34
39495   next try at:  21-Feb-1996 15:02:34
39496 roo.milne.example:192.168.8.3 error 146: Connection refused
39497   first failed: 20-Jan-1996 13:12:08
39498   last tried:   21-Feb-1996 11:42:03
39499   next try at:  21-Feb-1996 19:42:03
39500   past final cutoff time
39501 .endd
39502 You can also give &'exinext'& a local part, without a domain, and it
39503 will give any retry information for that local part in your default domain.
39504 A message id can be used to obtain retry information pertaining to a specific
39505 message. This exists only when an attempt to deliver a message to a remote host
39506 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39507 &'exinext'& is not particularly efficient, but then it is not expected to be
39508 run very often.
39509
39510 The &'exinext'& utility calls Exim to find out information such as the location
39511 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39512 passed on to the &'exim'& commands. The first specifies an alternate Exim
39513 configuration file, and the second sets macros for use within the configuration
39514 file. These features are mainly to help in testing, but might also be useful in
39515 environments where more than one configuration file is in use.
39516
39517
39518
39519 .section "Hints database maintenance" "SECThindatmai"
39520 .cindex "hints database" "maintenance"
39521 .cindex "maintaining Exim's hints database"
39522 Three utility programs are provided for maintaining the DBM files that Exim
39523 uses to contain its delivery hint information. Each program requires two
39524 arguments. The first specifies the name of Exim's spool directory, and the
39525 second is the name of the database it is to operate on. These are as follows:
39526
39527 .ilist
39528 &'retry'&: the database of retry information
39529 .next
39530 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39531 for remote hosts
39532 .next
39533 &'callout'&: the callout cache
39534 .next
39535 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39536 .next
39537 .new
39538 &'tls'&: TLS session resumption data
39539 .wen
39540 .next
39541 &'misc'&: other hints data
39542 .endlist
39543
39544 The &'misc'& database is used for
39545
39546 .ilist
39547 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39548 .next
39549 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39550 &(smtp)& transport)
39551 .next
39552 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39553 in a transport)
39554 .endlist
39555
39556
39557
39558 .section "exim_dumpdb" "SECTdumpdb"
39559 .cindex "&'exim_dumpdb'&"
39560 The entire contents of a database are written to the standard output by the
39561 &'exim_dumpdb'& program, which has no options or arguments other than the
39562 spool and database names. For example, to dump the retry database:
39563 .code
39564 exim_dumpdb /var/spool/exim retry
39565 .endd
39566 Two lines of output are produced for each entry:
39567 .code
39568 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39569 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39570 .endd
39571 The first item on the first line is the key of the record. It starts with one
39572 of the letters R, or T, depending on whether it refers to a routing or
39573 transport retry. For a local delivery, the next part is the local address; for
39574 a remote delivery it is the name of the remote host, followed by its failing IP
39575 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39576 transport). If the remote port is not the standard one (port 25), it is added
39577 to the IP address. Then there follows an error code, an additional error code,
39578 and a textual description of the error.
39579
39580 The three times on the second line are the time of first failure, the time of
39581 the last delivery attempt, and the computed time for the next attempt. The line
39582 ends with an asterisk if the cutoff time for the last retry rule has been
39583 exceeded.
39584
39585 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39586 consists of a host name followed by a list of ids for messages that are or were
39587 waiting to be delivered to that host. If there are a very large number for any
39588 one host, continuation records, with a sequence number added to the host name,
39589 may be seen. The data in these records is often out of date, because a message
39590 may be routed to several alternative hosts, and Exim makes no effort to keep
39591 cross-references.
39592
39593
39594
39595 .section "exim_tidydb" "SECTtidydb"
39596 .cindex "&'exim_tidydb'&"
39597 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39598 database. If run with no options, it removes all records that are more than 30
39599 days old. The age is calculated from the date and time that the record was last
39600 updated. Note that, in the case of the retry database, it is &'not'& the time
39601 since the first delivery failure. Information about a host that has been down
39602 for more than 30 days will remain in the database, provided that the record is
39603 updated sufficiently often.
39604
39605 The cutoff date can be altered by means of the &%-t%& option, which must be
39606 followed by a time. For example, to remove all records older than a week from
39607 the retry database:
39608 .code
39609 exim_tidydb -t 7d /var/spool/exim retry
39610 .endd
39611 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39612 message ids. In the former these appear as data in records keyed by host &--
39613 they were messages that were waiting for that host &-- and in the latter they
39614 are the keys for retry information for messages that have suffered certain
39615 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39616 message ids in database records are those of messages that are still on the
39617 queue. Message ids for messages that no longer exist are removed from
39618 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39619 For the &'retry'& database, records whose keys are non-existent message ids are
39620 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39621 whenever it removes information from the database.
39622
39623 Certain records are automatically removed by Exim when they are no longer
39624 needed, but others are not. For example, if all the MX hosts for a domain are
39625 down, a retry record is created for each one. If the primary MX host comes back
39626 first, its record is removed when Exim successfully delivers to it, but the
39627 records for the others remain because Exim has not tried to use those hosts.
39628
39629 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39630 hints databases. You should do this at a quiet time of day, because it requires
39631 a database to be locked (and therefore inaccessible to Exim) while it does its
39632 work. Removing records from a DBM file does not normally make the file smaller,
39633 but all the common DBM libraries are able to re-use the space that is released.
39634 After an initial phase of increasing in size, the databases normally reach a
39635 point at which they no longer get any bigger, as long as they are regularly
39636 tidied.
39637
39638 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39639 databases is likely to keep on increasing.
39640
39641
39642
39643
39644 .section "exim_fixdb" "SECTfixdb"
39645 .cindex "&'exim_fixdb'&"
39646 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39647 Its main use is for testing Exim, but it might also be occasionally useful for
39648 getting round problems in a live system. It has no options, and its interface
39649 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39650 key of a database record can then be entered, and the data for that record is
39651 displayed.
39652
39653 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39654 except the &'retry'& database, that is the only operation that can be carried
39655 out. For the &'retry'& database, each field is output preceded by a number, and
39656 data for individual fields can be changed by typing the field number followed
39657 by new data, for example:
39658 .code
39659 > 4 951102:1000
39660 .endd
39661 resets the time of the next delivery attempt. Time values are given as a
39662 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39663 used as optional separators.
39664
39665
39666
39667
39668 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39669 .cindex "mailbox" "maintenance"
39670 .cindex "&'exim_lock'&"
39671 .cindex "locking mailboxes"
39672 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39673 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39674 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39675 a user agent while investigating a problem. The utility requires the name of
39676 the file as its first argument. If the locking is successful, the second
39677 argument is run as a command (using C's &[system()]& function); if there is no
39678 second argument, the value of the SHELL environment variable is used; if this
39679 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39680 is unlocked and the utility ends. The following options are available:
39681
39682 .vlist
39683 .vitem &%-fcntl%&
39684 Use &[fcntl()]& locking on the open mailbox.
39685
39686 .vitem &%-flock%&
39687 Use &[flock()]& locking on the open mailbox, provided the operating system
39688 supports it.
39689
39690 .vitem &%-interval%&
39691 This must be followed by a number, which is a number of seconds; it sets the
39692 interval to sleep between retries (default 3).
39693
39694 .vitem &%-lockfile%&
39695 Create a lock file before opening the mailbox.
39696
39697 .vitem &%-mbx%&
39698 Lock the mailbox using MBX rules.
39699
39700 .vitem &%-q%&
39701 Suppress verification output.
39702
39703 .vitem &%-retries%&
39704 This must be followed by a number; it sets the number of times to try to get
39705 the lock (default 10).
39706
39707 .vitem &%-restore_time%&
39708 This option causes &%exim_lock%& to restore the modified and read times to the
39709 locked file before exiting. This allows you to access a locked mailbox (for
39710 example, to take a backup copy) without disturbing the times that the user
39711 subsequently sees.
39712
39713 .vitem &%-timeout%&
39714 This must be followed by a number, which is a number of seconds; it sets a
39715 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39716 default), a non-blocking call is used.
39717
39718 .vitem &%-v%&
39719 Generate verbose output.
39720 .endlist
39721
39722 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39723 default is to create a lock file and also to use &[fcntl()]& locking on the
39724 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39725 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39726 requires that the directory containing the file be writeable. Locking by lock
39727 file does not last forever; Exim assumes that a lock file is expired if it is
39728 more than 30 minutes old.
39729
39730 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39731 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39732 to be taken out on the open mailbox, and an exclusive lock on the file
39733 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39734 number of the mailbox file. When the locking is released, if an exclusive lock
39735 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39736
39737 The default output contains verification of the locking that takes place. The
39738 &%-v%& option causes some additional information to be given. The &%-q%& option
39739 suppresses all output except error messages.
39740
39741 A command such as
39742 .code
39743 exim_lock /var/spool/mail/spqr
39744 .endd
39745 runs an interactive shell while the file is locked, whereas
39746 .display
39747 &`exim_lock -q /var/spool/mail/spqr <<End`&
39748 <&'some commands'&>
39749 &`End`&
39750 .endd
39751 runs a specific non-interactive sequence of commands while the file is locked,
39752 suppressing all verification output. A single command can be run by a command
39753 such as
39754 .code
39755 exim_lock -q /var/spool/mail/spqr \
39756   "cp /var/spool/mail/spqr /some/where"
39757 .endd
39758 Note that if a command is supplied, it must be entirely contained within the
39759 second argument &-- hence the quotes.
39760 .ecindex IIDutils
39761
39762
39763 . ////////////////////////////////////////////////////////////////////////////
39764 . ////////////////////////////////////////////////////////////////////////////
39765
39766 .chapter "The Exim monitor" "CHAPeximon"
39767 .scindex IIDeximon "Exim monitor" "description"
39768 .cindex "X-windows"
39769 .cindex "&'eximon'&"
39770 .cindex "Local/eximon.conf"
39771 .cindex "&_exim_monitor/EDITME_&"
39772 The Exim monitor is an application which displays in an X window information
39773 about the state of Exim's queue and what Exim is doing. An admin user can
39774 perform certain operations on messages from this GUI interface; however all
39775 such facilities are also available from the command line, and indeed, the
39776 monitor itself makes use of the command line to perform any actions requested.
39777
39778
39779
39780 .section "Running the monitor" "SECID264"
39781 The monitor is started by running the script called &'eximon'&. This is a shell
39782 script that sets up a number of environment variables, and then runs the
39783 binary called &_eximon.bin_&. The default appearance of the monitor window can
39784 be changed by editing the &_Local/eximon.conf_& file created by editing
39785 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39786 parameters are for.
39787
39788 The parameters that get built into the &'eximon'& script can be overridden for
39789 a particular invocation by setting up environment variables of the same names,
39790 preceded by &`EXIMON_`&. For example, a shell command such as
39791 .code
39792 EXIMON_LOG_DEPTH=400 eximon
39793 .endd
39794 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39795 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39796 overrides the Exim log file configuration. This makes it possible to have
39797 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39798 syslog messages are routed to a file on the local host.
39799
39800 X resources can be used to change the appearance of the window in the normal
39801 way. For example, a resource setting of the form
39802 .code
39803 Eximon*background: gray94
39804 .endd
39805 changes the colour of the background to light grey rather than white. The
39806 stripcharts are drawn with both the data lines and the reference lines in
39807 black. This means that the reference lines are not visible when on top of the
39808 data. However, their colour can be changed by setting a resource called
39809 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39810 For example, if your X server is running Unix, you could set up lighter
39811 reference lines in the stripcharts by obeying
39812 .code
39813 xrdb -merge <<End
39814 Eximon*highlight: gray
39815 End
39816 .endd
39817 .cindex "admin user"
39818 In order to see the contents of messages in the queue, and to operate on them,
39819 &'eximon'& must either be run as root or by an admin user.
39820
39821 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39822 contain X11 resource parameters interpreted by the X11 library.  In addition,
39823 if the first parameter starts with the string "gdb" then it is removed and the
39824 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39825 versioned variants of gdb can be invoked).
39826
39827 The monitor's window is divided into three parts. The first contains one or
39828 more stripcharts and two action buttons, the second contains a &"tail"& of the
39829 main log file, and the third is a display of the queue of messages awaiting
39830 delivery, with two more action buttons. The following sections describe these
39831 different parts of the display.
39832
39833
39834
39835
39836 .section "The stripcharts" "SECID265"
39837 .cindex "stripchart"
39838 The first stripchart is always a count of messages in the queue. Its name can
39839 be configured by setting QUEUE_STRIPCHART_NAME in the
39840 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39841 configuration script by regular expression matches on log file entries, making
39842 it possible to display, for example, counts of messages delivered to certain
39843 hosts or using certain transports. The supplied defaults display counts of
39844 received and delivered messages, and of local and SMTP deliveries. The default
39845 period between stripchart updates is one minute; this can be adjusted by a
39846 parameter in the &_Local/eximon.conf_& file.
39847
39848 The stripchart displays rescale themselves automatically as the value they are
39849 displaying changes. There are always 10 horizontal lines in each chart; the
39850 title string indicates the value of each division when it is greater than one.
39851 For example, &"x2"& means that each division represents a value of 2.
39852
39853 It is also possible to have a stripchart which shows the percentage fullness of
39854 a particular disk partition, which is useful when local deliveries are confined
39855 to a single partition.
39856
39857 .cindex "&%statvfs%& function"
39858 This relies on the availability of the &[statvfs()]& function or equivalent in
39859 the operating system. Most, but not all versions of Unix that support Exim have
39860 this. For this particular stripchart, the top of the chart always represents
39861 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39862 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39863 &_Local/eximon.conf_& file.
39864
39865
39866
39867
39868 .section "Main action buttons" "SECID266"
39869 .cindex "size" "of monitor window"
39870 .cindex "Exim monitor" "window size"
39871 .cindex "window size"
39872 Below the stripcharts there is an action button for quitting the monitor. Next
39873 to this is another button marked &"Size"&. They are placed here so that
39874 shrinking the window to its default minimum size leaves just the queue count
39875 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39876 the window to expand to its maximum size, unless it is already at the maximum,
39877 in which case it is reduced to its minimum.
39878
39879 When expanding to the maximum, if the window cannot be fully seen where it
39880 currently is, it is moved back to where it was the last time it was at full
39881 size. When it is expanding from its minimum size, the old position is
39882 remembered, and next time it is reduced to the minimum it is moved back there.
39883
39884 The idea is that you can keep a reduced window just showing one or two
39885 stripcharts at a convenient place on your screen, easily expand it to show
39886 the full window when required, and just as easily put it back to what it was.
39887 The idea is copied from what the &'twm'& window manager does for its
39888 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39889 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39890
39891 Normally, the monitor starts up with the window at its full size, but it can be
39892 built so that it starts up with the window at its smallest size, by setting
39893 START_SMALL=yes in &_Local/eximon.conf_&.
39894
39895
39896
39897 .section "The log display" "SECID267"
39898 .cindex "log" "tail of; in monitor"
39899 The second section of the window is an area in which a display of the tail of
39900 the main log is maintained.
39901 To save space on the screen, the timestamp on each log line is shortened by
39902 removing the date and, if &%log_timezone%& is set, the timezone.
39903 The log tail is not available when the only destination for logging data is
39904 syslog, unless the syslog lines are routed to a local file whose name is passed
39905 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39906
39907 The log sub-window has a scroll bar at its lefthand side which can be used to
39908 move back to look at earlier text, and the up and down arrow keys also have a
39909 scrolling effect. The amount of log that is kept depends on the setting of
39910 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39911 to use. When this is full, the earlier 50% of data is discarded &-- this is
39912 much more efficient than throwing it away line by line. The sub-window also has
39913 a horizontal scroll bar for accessing the ends of long log lines. This is the
39914 only means of horizontal scrolling; the right and left arrow keys are not
39915 available. Text can be cut from this part of the window using the mouse in the
39916 normal way. The size of this subwindow is controlled by parameters in the
39917 configuration file &_Local/eximon.conf_&.
39918
39919 Searches of the text in the log window can be carried out by means of the ^R
39920 and ^S keystrokes, which default to a reverse and a forward search,
39921 respectively. The search covers only the text that is displayed in the window.
39922 It cannot go further back up the log.
39923
39924 The point from which the search starts is indicated by a caret marker. This is
39925 normally at the end of the text in the window, but can be positioned explicitly
39926 by pointing and clicking with the left mouse button, and is moved automatically
39927 by a successful search. If new text arrives in the window when it is scrolled
39928 back, the caret remains where it is, but if the window is not scrolled back,
39929 the caret is moved to the end of the new text.
39930
39931 Pressing ^R or ^S pops up a window into which the search text can be typed.
39932 There are buttons for selecting forward or reverse searching, for carrying out
39933 the search, and for cancelling. If the &"Search"& button is pressed, the search
39934 happens and the window remains so that further searches can be done. If the
39935 &"Return"& key is pressed, a single search is done and the window is closed. If
39936 ^C is typed the search is cancelled.
39937
39938 The searching facility is implemented using the facilities of the Athena text
39939 widget. By default this pops up a window containing both &"search"& and
39940 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39941 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39942 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39943 provided version of &%TextPop%& when the remaining parts of the text widget
39944 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39945 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39946 on these systems, at the expense of having unwanted items in the search popup
39947 window.
39948
39949
39950
39951 .section "The queue display" "SECID268"
39952 .cindex "queue" "display in monitor"
39953 The bottom section of the monitor window contains a list of all messages that
39954 are in the queue, which includes those currently being received or delivered,
39955 as well as those awaiting delivery. The size of this subwindow is controlled by
39956 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39957 at which it is updated is controlled by another parameter in the same file &--
39958 the default is 5 minutes, since queue scans can be quite expensive. However,
39959 there is an &"Update"& action button just above the display which can be used
39960 to force an update of the queue display at any time.
39961
39962 When a host is down for some time, a lot of pending mail can build up for it,
39963 and this can make it hard to deal with other messages in the queue. To help
39964 with this situation there is a button next to &"Update"& called &"Hide"&. If
39965 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39966 type anything in here and press &"Return"&, the text is added to a chain of
39967 such texts, and if every undelivered address in a message matches at least one
39968 of the texts, the message is not displayed.
39969
39970 If there is an address that does not match any of the texts, all the addresses
39971 are displayed as normal. The matching happens on the ends of addresses so, for
39972 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39973 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39974 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39975 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39976 a hide request is automatically cancelled after one hour.
39977
39978 While the dialogue box is displayed, you can't press any buttons or do anything
39979 else to the monitor window. For this reason, if you want to cut text from the
39980 queue display to use in the dialogue box, you have to do the cutting before
39981 pressing the &"Hide"& button.
39982
39983 The queue display contains, for each unhidden queued message, the length of
39984 time it has been in the queue, the size of the message, the message id, the
39985 message sender, and the first undelivered recipient, all on one line. If it is
39986 a bounce message, the sender is shown as &"<>"&. If there is more than one
39987 recipient to which the message has not yet been delivered, subsequent ones are
39988 listed on additional lines, up to a maximum configured number, following which
39989 an ellipsis is displayed. Recipients that have already received the message are
39990 not shown.
39991
39992 .cindex "frozen messages" "display"
39993 If a message is frozen, an asterisk is displayed at the left-hand side.
39994
39995 The queue display has a vertical scroll bar, and can also be scrolled by means
39996 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39997 The text searching facilities, as described above for the log window, are also
39998 available, but the caret is always moved to the end of the text when the queue
39999 display is updated.
40000
40001
40002
40003 .section "The queue menu" "SECID269"
40004 .cindex "queue" "menu in monitor"
40005 If the &%shift%& key is held down and the left button is clicked when the mouse
40006 pointer is over the text for any message, an action menu pops up, and the first
40007 line of the queue display for the message is highlighted. This does not affect
40008 any selected text.
40009
40010 If you want to use some other event for popping up the menu, you can set the
40011 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40012 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40013 value set in this parameter is a standard X event description. For example, to
40014 run eximon using &%ctrl%& rather than &%shift%& you could use
40015 .code
40016 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40017 .endd
40018 The title of the menu is the message id, and it contains entries which act as
40019 follows:
40020
40021 .ilist
40022 &'message log'&: The contents of the message log for the message are displayed
40023 in a new text window.
40024 .next
40025 &'headers'&: Information from the spool file that contains the envelope
40026 information and headers is displayed in a new text window. See chapter
40027 &<<CHAPspool>>& for a description of the format of spool files.
40028 .next
40029 &'body'&: The contents of the spool file containing the body of the message are
40030 displayed in a new text window. There is a default limit of 20,000 bytes to the
40031 amount of data displayed. This can be changed by setting the BODY_MAX
40032 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40033 .next
40034 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40035 delivery of the message. This causes an automatic thaw if the message is
40036 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40037 a new text window. The delivery is run in a separate process, to avoid holding
40038 up the monitor while the delivery proceeds.
40039 .next
40040 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40041 that the message be frozen.
40042 .next
40043 .cindex "thawing messages"
40044 .cindex "unfreezing messages"
40045 .cindex "frozen messages" "thawing"
40046 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40047 that the message be thawed.
40048 .next
40049 .cindex "delivery" "forcing failure"
40050 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40051 that Exim gives up trying to deliver the message. A bounce message is generated
40052 for any remaining undelivered addresses.
40053 .next
40054 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40055 that the message be deleted from the system without generating a bounce
40056 message.
40057 .next
40058 &'add recipient'&: A dialog box is displayed into which a recipient address can
40059 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40060 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40061 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40062 causes a call to Exim to be made using the &%-Mar%& option to request that an
40063 additional recipient be added to the message, unless the entry box is empty, in
40064 which case no action is taken.
40065 .next
40066 &'mark delivered'&: A dialog box is displayed into which a recipient address
40067 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40068 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40069 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40070 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40071 recipient address as already delivered, unless the entry box is empty, in which
40072 case no action is taken.
40073 .next
40074 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40075 mark all recipient addresses as already delivered.
40076 .next
40077 &'edit sender'&: A dialog box is displayed initialized with the current
40078 sender's address. Pressing RETURN causes a call to Exim to be made using the
40079 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40080 in which case no action is taken. If you want to set an empty sender (as in
40081 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40082 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40083 the address is qualified with that domain.
40084 .endlist
40085
40086 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40087 other cases when a call to Exim is made, if there is any output from Exim (in
40088 particular, if the command fails) a window containing the command and the
40089 output is displayed. Otherwise, the results of the action are normally apparent
40090 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40091 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40092 if no output is generated.
40093
40094 The queue display is automatically updated for actions such as freezing and
40095 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40096 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40097 force an update of the display after one of these actions.
40098
40099 In any text window that is displayed as result of a menu action, the normal
40100 cut-and-paste facility is available, and searching can be carried out using ^R
40101 and ^S, as described above for the log tail window.
40102 .ecindex IIDeximon
40103
40104
40105
40106
40107
40108 . ////////////////////////////////////////////////////////////////////////////
40109 . ////////////////////////////////////////////////////////////////////////////
40110
40111 .chapter "Security considerations" "CHAPsecurity"
40112 .scindex IIDsecurcon "security" "discussion of"
40113 This chapter discusses a number of issues concerned with security, some of
40114 which are also covered in other parts of this manual.
40115
40116 For reasons that this author does not understand, some people have promoted
40117 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40118 existence of this chapter in the documentation. However, the intent of the
40119 chapter is simply to describe the way Exim works in relation to certain
40120 security concerns, not to make any specific claims about the effectiveness of
40121 its security as compared with other MTAs.
40122
40123 What follows is a description of the way Exim is supposed to be. Best efforts
40124 have been made to try to ensure that the code agrees with the theory, but an
40125 absence of bugs can never be guaranteed. Any that are reported will get fixed
40126 as soon as possible.
40127
40128
40129 .section "Building a more &""hardened""& Exim" "SECID286"
40130 .cindex "security" "build-time features"
40131 There are a number of build-time options that can be set in &_Local/Makefile_&
40132 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40133 Exim administrator who does not have the root password, or by someone who has
40134 penetrated the Exim (but not the root) account. These options are as follows:
40135
40136 .ilist
40137 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40138 start of any filenames used with the &%-C%& option. When it is set, these
40139 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40140 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40141 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40142 default setting for &%ALT_CONFIG_PREFIX%&.
40143
40144 If the permitted configuration files are confined to a directory to
40145 which only root has access, this guards against someone who has broken
40146 into the Exim account from running a privileged Exim with an arbitrary
40147 configuration file, and using it to break into other accounts.
40148 .next
40149
40150 If a non-trusted configuration file (i.e. not the default configuration file
40151 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40152 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40153 the next item), then root privilege is retained only if the caller of Exim is
40154 root. This locks out the possibility of testing a configuration using &%-C%&
40155 right through message reception and delivery, even if the caller is root. The
40156 reception works, but by that time, Exim is running as the Exim user, so when
40157 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40158 privilege to be lost. However, root can test reception and delivery using two
40159 separate commands.
40160
40161 .next
40162 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40163 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40164 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40165 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40166 the restrictive side.  Requiring build-time selection of safe macros is onerous
40167 but this option is intended solely as a transition mechanism to permit
40168 previously-working configurations to continue to work after release 4.73.
40169 .next
40170 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40171 is disabled.
40172 .next
40173 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40174 never to be used for any deliveries. This is like the &%never_users%& runtime
40175 option, but it cannot be overridden; the runtime option adds additional users
40176 to the list. The default setting is &"root"&; this prevents a non-root user who
40177 is permitted to modify the runtime file from using Exim as a way to get root.
40178 .endlist
40179
40180
40181
40182 .section "Root privilege" "SECID270"
40183 .cindex "setuid"
40184 .cindex "root privilege"
40185 The Exim binary is normally setuid to root, which means that it gains root
40186 privilege (runs as root) when it starts execution. In some special cases (for
40187 example, when the daemon is not in use and there are no local deliveries), it
40188 may be possible to run Exim setuid to some user other than root. This is
40189 discussed in the next section. However, in most installations, root privilege
40190 is required for two things:
40191
40192 .ilist
40193 To set up a socket connected to the standard SMTP port (25) when initialising
40194 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40195 not required.
40196 .next
40197 To be able to change uid and gid in order to read users' &_.forward_& files and
40198 perform local deliveries as the receiving user or as specified in the
40199 configuration.
40200 .endlist
40201
40202 It is not necessary to be root to do any of the other things Exim does, such as
40203 receiving messages and delivering them externally over SMTP, and it is
40204 obviously more secure if Exim does not run as root except when necessary.
40205 For this reason, a user and group for Exim to use must be defined in
40206 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40207 group"&. Their values can be changed by the runtime configuration, though this
40208 is not recommended. Often a user called &'exim'& is used, but some sites use
40209 &'mail'& or another user name altogether.
40210
40211 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40212 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40213 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40214
40215 After a new Exim process has interpreted its command line options, it changes
40216 uid and gid in the following cases:
40217
40218 .ilist
40219 .oindex "&%-C%&"
40220 .oindex "&%-D%&"
40221 If the &%-C%& option is used to specify an alternate configuration file, or if
40222 the &%-D%& option is used to define macro values for the configuration, and the
40223 calling process is not running as root, the uid and gid are changed to those of
40224 the calling process.
40225 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40226 option may not be used at all.
40227 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40228 can be supplied if the calling process is running as root, the Exim run-time
40229 user or CONFIGURE_OWNER, if defined.
40230 .next
40231 .oindex "&%-be%&"
40232 .oindex "&%-bf%&"
40233 .oindex "&%-bF%&"
40234 If the expansion test option (&%-be%&) or one of the filter testing options
40235 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40236 calling process.
40237 .next
40238 If the process is not a daemon process or a queue runner process or a delivery
40239 process or a process for testing address routing (started with &%-bt%&), the
40240 uid and gid are changed to the Exim user and group. This means that Exim always
40241 runs under its own uid and gid when receiving messages. This also applies when
40242 testing address verification
40243 .oindex "&%-bv%&"
40244 .oindex "&%-bh%&"
40245 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40246 option).
40247 .next
40248 For a daemon, queue runner, delivery, or address testing process, the uid
40249 remains as root at this stage, but the gid is changed to the Exim group.
40250 .endlist
40251
40252 The processes that initially retain root privilege behave as follows:
40253
40254 .ilist
40255 A daemon process changes the gid to the Exim group and the uid to the Exim
40256 user after setting up one or more listening sockets. The &[initgroups()]&
40257 function is called, so that if the Exim user is in any additional groups, they
40258 will be used during message reception.
40259 .next
40260 A queue runner process retains root privilege throughout its execution. Its
40261 job is to fork a controlled sequence of delivery processes.
40262 .next
40263 A delivery process retains root privilege throughout most of its execution,
40264 but any actual deliveries (that is, the transports themselves) are run in
40265 subprocesses which always change to a non-root uid and gid. For local
40266 deliveries this is typically the uid and gid of the owner of the mailbox; for
40267 remote deliveries, the Exim uid and gid are used. Once all the delivery
40268 subprocesses have been run, a delivery process changes to the Exim uid and gid
40269 while doing post-delivery tidying up such as updating the retry database and
40270 generating bounce and warning messages.
40271
40272 While the recipient addresses in a message are being routed, the delivery
40273 process runs as root. However, if a user's filter file has to be processed,
40274 this is done in a subprocess that runs under the individual user's uid and
40275 gid. A system filter is run as root unless &%system_filter_user%& is set.
40276 .next
40277 A process that is testing addresses (the &%-bt%& option) runs as root so that
40278 the routing is done in the same environment as a message delivery.
40279 .endlist
40280
40281
40282
40283
40284 .section "Running Exim without privilege" "SECTrunexiwitpri"
40285 .cindex "privilege, running without"
40286 .cindex "unprivileged running"
40287 .cindex "root privilege" "running without"
40288 Some installations like to run Exim in an unprivileged state for more of its
40289 operation, for added security. Support for this mode of operation is provided
40290 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40291 gid are changed to the Exim user and group at the start of a delivery process
40292 (and also queue runner and address testing processes). This means that address
40293 routing is no longer run as root, and the deliveries themselves cannot change
40294 to any other uid.
40295
40296 .cindex SIGHUP
40297 .cindex "daemon" "restarting"
40298 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40299 that the daemon can still be started in the usual way, and it can respond
40300 correctly to SIGHUP because the re-invocation regains root privilege.
40301
40302 An alternative approach is to make Exim setuid to the Exim user and also setgid
40303 to the Exim group. If you do this, the daemon must be started from a root
40304 process. (Calling Exim from a root process makes it behave in the way it does
40305 when it is setuid root.) However, the daemon cannot restart itself after a
40306 SIGHUP signal because it cannot regain privilege.
40307
40308 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40309 stops Exim from trying to re-invoke itself to do a delivery after a message has
40310 been received. Such a re-invocation is a waste of resources because it has no
40311 effect.
40312
40313 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40314 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40315 to the Exim user seems a clean approach, but there is one complication:
40316
40317 In this style of operation, Exim is running with the real uid and gid set to
40318 those of the calling process, and the effective uid/gid set to Exim's values.
40319 Ideally, any association with the calling process' uid/gid should be dropped,
40320 that is, the real uid/gid should be reset to the effective values so as to
40321 discard any privileges that the caller may have. While some operating systems
40322 have a function that permits this action for a non-root effective uid, quite a
40323 number of them do not. Because of this lack of standardization, Exim does not
40324 address this problem at this time.
40325
40326 For this reason, the recommended approach for &"mostly unprivileged"& running
40327 is to keep the Exim binary setuid to root, and to set
40328 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40329 be used in the most straightforward way.
40330
40331 If you configure Exim not to run delivery processes as root, there are a
40332 number of restrictions on what you can do:
40333
40334 .ilist
40335 You can deliver only as the Exim user/group. You should  explicitly use the
40336 &%user%& and &%group%& options to override routers or local transports that
40337 normally deliver as the recipient. This makes sure that configurations that
40338 work in this mode function the same way in normal mode. Any implicit or
40339 explicit specification of another user causes an error.
40340 .next
40341 Use of &_.forward_& files is severely restricted, such that it is usually
40342 not worthwhile to include them in the configuration.
40343 .next
40344 Users who wish to use &_.forward_& would have to make their home directory and
40345 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40346 and their equivalents in Exim filters, cannot be used. While they could be
40347 enabled in the Exim user's name, that would be insecure and not very useful.
40348 .next
40349 Unless the local user mailboxes are all owned by the Exim user (possible in
40350 some POP3 or IMAP-only environments):
40351
40352 .olist
40353 They must be owned by the Exim group and be writeable by that group. This
40354 implies you must set &%mode%& in the appendfile configuration, as well as the
40355 mode of the mailbox files themselves.
40356 .next
40357 You must set &%no_check_owner%&, since most or all of the files will not be
40358 owned by the Exim user.
40359 .next
40360 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40361 on a newly created mailbox when unprivileged. This also implies that new
40362 mailboxes need to be created manually.
40363 .endlist olist
40364 .endlist ilist
40365
40366
40367 These restrictions severely restrict what can be done in local deliveries.
40368 However, there are no restrictions on remote deliveries. If you are running a
40369 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40370 gives more security at essentially no cost.
40371
40372 If you are using the &%mua_wrapper%& facility (see chapter
40373 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40374
40375
40376
40377
40378 .section "Delivering to local files" "SECID271"
40379 Full details of the checks applied by &(appendfile)& before it writes to a file
40380 are given in chapter &<<CHAPappendfile>>&.
40381
40382
40383
40384 .section "Running local commands" "SECTsecconslocalcmds"
40385 .cindex "security" "local commands"
40386 .cindex "security" "command injection attacks"
40387 There are a number of ways in which an administrator can configure Exim to run
40388 commands based upon received, untrustworthy, data. Further, in some
40389 configurations a user who can control a &_.forward_& file can also arrange to
40390 run commands. Configuration to check includes, but is not limited to:
40391
40392 .ilist
40393 Use of &%use_shell%& in the pipe transport: various forms of shell command
40394 injection may be possible with this option present. It is dangerous and should
40395 be used only with considerable caution. Consider constraints which whitelist
40396 allowed characters in a variable which is to be used in a pipe transport that
40397 has &%use_shell%& enabled.
40398 .next
40399 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40400 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40401 &_.forward_& files in a redirect router. If Exim is running on a central mail
40402 hub to which ordinary users do not have shell access, but home directories are
40403 NFS mounted (for instance) then administrators should review the list of these
40404 forbid options available, and should bear in mind that the options that may
40405 need forbidding can change as new features are added between releases.
40406 .next
40407 The &%${run...}%& expansion item does not use a shell by default, but
40408 administrators can configure use of &_/bin/sh_& as part of the command.
40409 Such invocations should be viewed with prejudicial suspicion.
40410 .next
40411 Administrators who use embedded Perl are advised to explore how Perl's
40412 taint checking might apply to their usage.
40413 .next
40414 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40415 administrators are well advised to view its use with suspicion, in case (for
40416 instance) it allows a local-part to contain embedded Exim directives.
40417 .next
40418 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40419 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40420 each can reference arbitrary lists and files, rather than just being a list
40421 of opaque strings.
40422 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40423 real-world security vulnerabilities caused by its use with untrustworthy data
40424 injected in, for SQL injection attacks.
40425 Consider the use of the &%inlisti%& expansion condition instead.
40426 .endlist
40427
40428
40429
40430
40431 .section "Trust in configuration data" "SECTsecconfdata"
40432 .cindex "security" "data sources"
40433 .cindex "security" "regular expressions"
40434 .cindex "regular expressions" "security"
40435 .cindex "PCRE" "security"
40436 If configuration data for Exim can come from untrustworthy sources, there
40437 are some issues to be aware of:
40438
40439 .ilist
40440 Use of &%${expand...}%& may provide a path for shell injection attacks.
40441 .next
40442 Letting untrusted data provide a regular expression is unwise.
40443 .next
40444 Using &%${match...}%& to apply a fixed regular expression against untrusted
40445 data may result in pathological behaviour within PCRE.  Be aware of what
40446 "backtracking" means and consider options for being more strict with a regular
40447 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40448 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40449 possessive quantifiers or just not using regular expressions against untrusted
40450 data.
40451 .next
40452 It can be important to correctly use &%${quote:...}%&,
40453 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40454 items to ensure that data is correctly constructed.
40455 .next
40456 Some lookups might return multiple results, even though normal usage is only
40457 expected to yield one result.
40458 .endlist
40459
40460
40461
40462
40463 .section "IPv4 source routing" "SECID272"
40464 .cindex "source routing" "in IP packets"
40465 .cindex "IP source routing"
40466 Many operating systems suppress IP source-routed packets in the kernel, but
40467 some cannot be made to do this, so Exim does its own check. It logs incoming
40468 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40469 IPv6. No special checking is currently done.
40470
40471
40472
40473 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40474 Support for these SMTP commands is disabled by default. If required, they can
40475 be enabled by defining suitable ACLs.
40476
40477
40478
40479
40480 .section "Privileged users" "SECID274"
40481 .cindex "trusted users"
40482 .cindex "admin user"
40483 .cindex "privileged user"
40484 .cindex "user" "trusted"
40485 .cindex "user" "admin"
40486 Exim recognizes two sets of users with special privileges. Trusted users are
40487 able to submit new messages to Exim locally, but supply their own sender
40488 addresses and information about a sending host. For other users submitting
40489 local messages, Exim sets up the sender address from the uid, and doesn't
40490 permit a remote host to be specified.
40491
40492 .oindex "&%-f%&"
40493 However, an untrusted user is permitted to use the &%-f%& command line option
40494 in the special form &%-f <>%& to indicate that a delivery failure for the
40495 message should not cause an error report. This affects the message's envelope,
40496 but it does not affect the &'Sender:'& header. Untrusted users may also be
40497 permitted to use specific forms of address with the &%-f%& option by setting
40498 the &%untrusted_set_sender%& option.
40499
40500 Trusted users are used to run processes that receive mail messages from some
40501 other mail domain and pass them on to Exim for delivery either locally, or over
40502 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40503 as any user listed in the &%trusted_users%& configuration option, or under any
40504 group listed in the &%trusted_groups%& option.
40505
40506 Admin users are permitted to do things to the messages on Exim's queue. They
40507 can freeze or thaw messages, cause them to be returned to their senders, remove
40508 them entirely, or modify them in various ways. In addition, admin users can run
40509 the Exim monitor and see all the information it is capable of providing, which
40510 includes the contents of files on the spool.
40511
40512 .oindex "&%-M%&"
40513 .oindex "&%-q%&"
40514 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40515 delivery of messages on its queue is restricted to admin users. This
40516 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40517 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40518 queue is also restricted to admin users. This restriction can be relaxed by
40519 setting &%no_queue_list_requires_admin%&.
40520
40521 Exim recognizes an admin user if the calling process is running as root or as
40522 the Exim user or if any of the groups associated with the calling process is
40523 the Exim group. It is not necessary actually to be running under the Exim
40524 group. However, if admin users who are not root or the Exim user are to access
40525 the contents of files on the spool via the Exim monitor (which runs
40526 unprivileged), Exim must be built to allow group read access to its spool
40527 files.
40528
40529 By default, regular users are trusted to perform basic testing and
40530 introspection commands, as themselves.  This setting can be tightened by
40531 setting the &%commandline_checks_require_admin%& option.
40532 This affects most of the checking options,
40533 such as &%-be%& and anything else &%-b*%&.
40534
40535
40536 .section "Spool files" "SECID275"
40537 .cindex "spool directory" "files"
40538 Exim's spool directory and everything it contains is owned by the Exim user and
40539 set to the Exim group. The mode for spool files is defined in the
40540 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40541 any user who is a member of the Exim group can access these files.
40542
40543
40544
40545 .section "Use of argv[0]" "SECID276"
40546 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40547 of specific strings, Exim assumes certain options. For example, calling Exim
40548 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40549 to calling it with the option &%-bS%&. There are no security implications in
40550 this.
40551
40552
40553
40554 .section "Use of %f formatting" "SECID277"
40555 The only use made of &"%f"& by Exim is in formatting load average values. These
40556 are actually stored in integer variables as 1000 times the load average.
40557 Consequently, their range is limited and so therefore is the length of the
40558 converted output.
40559
40560
40561
40562 .section "Embedded Exim path" "SECID278"
40563 Exim uses its own path name, which is embedded in the code, only when it needs
40564 to re-exec in order to regain root privilege. Therefore, it is not root when it
40565 does so. If some bug allowed the path to get overwritten, it would lead to an
40566 arbitrary program's being run as exim, not as root.
40567
40568
40569
40570 .section "Dynamic module directory" "SECTdynmoddir"
40571 Any dynamically loadable modules must be installed into the directory
40572 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40573 loading it.
40574
40575
40576 .section "Use of sprintf()" "SECID279"
40577 .cindex "&[sprintf()]&"
40578 A large number of occurrences of &"sprintf"& in the code are actually calls to
40579 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40580 The intermediate formatting is done into a large fixed buffer by a function
40581 that runs through the format string itself, and checks the length of each
40582 conversion before performing it, thus preventing buffer overruns.
40583
40584 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40585 the output buffer is known to be sufficiently long to contain the converted
40586 string.
40587
40588
40589
40590 .section "Use of debug_printf() and log_write()" "SECID280"
40591 Arbitrary strings are passed to both these functions, but they do their
40592 formatting by calling the function &'string_vformat()'&, which runs through
40593 the format string itself, and checks the length of each conversion.
40594
40595
40596
40597 .section "Use of strcat() and strcpy()" "SECID281"
40598 These are used only in cases where the output buffer is known to be large
40599 enough to hold the result.
40600 .ecindex IIDsecurcon
40601
40602
40603
40604
40605 . ////////////////////////////////////////////////////////////////////////////
40606 . ////////////////////////////////////////////////////////////////////////////
40607
40608 .chapter "Format of spool files" "CHAPspool"
40609 .scindex IIDforspo1 "format" "spool files"
40610 .scindex IIDforspo2 "spool directory" "format of files"
40611 .scindex IIDforspo3 "spool files" "format of"
40612 .cindex "spool files" "editing"
40613 A message on Exim's queue consists of two files, whose names are the message id
40614 followed by -D and -H, respectively. The data portion of the message is kept in
40615 the -D file on its own. The message's envelope, status, and headers are all
40616 kept in the -H file, whose format is described in this chapter. Each of these
40617 two files contains the final component of its own name as its first line. This
40618 is insurance against disk crashes where the directory is lost but the files
40619 themselves are recoverable.
40620
40621 The file formats may be changed, or new formats added, at any release.
40622 Spool files are not intended as an interface to other programs
40623 and should not be used as such.
40624
40625 Some people are tempted into editing -D files in order to modify messages. You
40626 need to be extremely careful if you do this; it is not recommended and you are
40627 on your own if you do it. Here are some of the pitfalls:
40628
40629 .ilist
40630 You must ensure that Exim does not try to deliver the message while you are
40631 fiddling with it. The safest way is to take out a write lock on the -D file,
40632 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40633 place, the lock will be retained. If you write a new file and rename it, the
40634 lock will be lost at the instant of rename.
40635 .next
40636 .vindex "&$body_linecount$&"
40637 If you change the number of lines in the file, the value of
40638 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40639 cause incomplete transmission of messages or undeliverable messages.
40640 .next
40641 If the message is in MIME format, you must take care not to break it.
40642 .next
40643 If the message is cryptographically signed, any change will invalidate the
40644 signature.
40645 .endlist
40646 All in all, modifying -D files is fraught with danger.
40647
40648 Files whose names end with -J may also be seen in the &_input_& directory (or
40649 its subdirectories when &%split_spool_directory%& is set). These are journal
40650 files, used to record addresses to which the message has been delivered during
40651 the course of a delivery attempt. If there are still undelivered recipients at
40652 the end, the -H file is updated, and the -J file is deleted. If, however, there
40653 is some kind of crash (for example, a power outage) before this happens, the -J
40654 file remains in existence. When Exim next processes the message, it notices the
40655 -J file and uses it to update the -H file before starting the next delivery
40656 attempt.
40657
40658 Files whose names end with -K or .eml may also be seen in the spool.
40659 These are temporaries used for DKIM or malware processing, when that is used.
40660 They should be tidied up by normal operations; any old ones are probably
40661 relics of crashes and can be removed.
40662
40663 .section "Format of the -H file" "SECID282"
40664 .cindex "uid (user id)" "in spool file"
40665 .cindex "gid (group id)" "in spool file"
40666 The second line of the -H file contains the login name for the uid of the
40667 process that called Exim to read the message, followed by the numerical uid and
40668 gid. For a locally generated message, this is normally the user who sent the
40669 message. For a message received over TCP/IP via the daemon, it is
40670 normally the Exim user.
40671
40672 The third line of the file contains the address of the message's sender as
40673 transmitted in the envelope, contained in angle brackets. The sender address is
40674 empty for bounce messages. For incoming SMTP mail, the sender address is given
40675 in the MAIL command. For locally generated mail, the sender address is
40676 created by Exim from the login name of the current user and the configured
40677 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40678 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40679 &"<>"& or an address that matches &%untrusted_set_senders%&.
40680
40681 The fourth line contains two numbers. The first is the time that the message
40682 was received, in the conventional Unix form &-- the number of seconds since the
40683 start of the epoch. The second number is a count of the number of messages
40684 warning of delayed delivery that have been sent to the sender.
40685
40686 There follow a number of lines starting with a hyphen. These can appear in any
40687 order, and are omitted when not relevant:
40688
40689 .vlist
40690 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40691 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40692 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40693 recognized, to provide backward compatibility. In the old format, a line of
40694 this form is present for every ACL variable that is not empty. The number
40695 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40696 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40697 the data string for the variable. The string itself starts at the beginning of
40698 the next line, and is followed by a newline character. It may contain internal
40699 newlines.
40700
40701 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40702 A line of this form is present for every ACL connection variable that is
40703 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40704 The length is the length of the data string for the variable. The string itself
40705 starts at the beginning of the next line, and is followed by a newline
40706 character. It may contain internal newlines.
40707
40708 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40709 A line of this form is present for every ACL message variable that is defined.
40710 Note that there is a space between &%-aclm%& and the rest of the name. The
40711 length is the length of the data string for the variable. The string itself
40712 starts at the beginning of the next line, and is followed by a newline
40713 character. It may contain internal newlines.
40714
40715 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40716 This is present if, when the message was received over SMTP, the value of
40717 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40718
40719 .vitem &%-allow_unqualified_recipient%&
40720 This is present if unqualified recipient addresses are permitted in header
40721 lines (to stop such addresses from being qualified if rewriting occurs at
40722 transport time). Local messages that were input using &%-bnq%& and remote
40723 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40724
40725 .vitem &%-allow_unqualified_sender%&
40726 This is present if unqualified sender addresses are permitted in header lines
40727 (to stop such addresses from being qualified if rewriting occurs at transport
40728 time). Local messages that were input using &%-bnq%& and remote messages from
40729 hosts that match &%sender_unqualified_hosts%& set this flag.
40730
40731 .vitem "&%-auth_id%&&~<&'text'&>"
40732 The id information for a message received on an authenticated SMTP connection
40733 &-- the value of the &$authenticated_id$& variable.
40734
40735 .vitem "&%-auth_sender%&&~<&'address'&>"
40736 The address of an authenticated sender &-- the value of the
40737 &$authenticated_sender$& variable.
40738
40739 .vitem "&%-body_linecount%&&~<&'number'&>"
40740 This records the number of lines in the body of the message, and is
40741 present unless &%-spool_file_wireformat%& is.
40742
40743 .vitem "&%-body_zerocount%&&~<&'number'&>"
40744 This records the number of binary zero bytes in the body of the message, and is
40745 present if the number is greater than zero.
40746
40747 .vitem &%-deliver_firsttime%&
40748 This is written when a new message is first added to the spool. When the spool
40749 file is updated after a deferral, it is omitted.
40750
40751 .vitem "&%-frozen%&&~<&'time'&>"
40752 .cindex "frozen messages" "spool data"
40753 The message is frozen, and the freezing happened at <&'time'&>.
40754
40755 .vitem "&%-helo_name%&&~<&'text'&>"
40756 This records the host name as specified by a remote host in a HELO or EHLO
40757 command.
40758
40759 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40760 This records the IP address of the host from which the message was received and
40761 the remote port number that was used. It is omitted for locally generated
40762 messages.
40763
40764 .vitem "&%-host_auth%&&~<&'text'&>"
40765 If the message was received on an authenticated SMTP connection, this records
40766 the name of the authenticator &-- the value of the
40767 &$sender_host_authenticated$& variable.
40768
40769 .vitem &%-host_lookup_failed%&
40770 This is present if an attempt to look up the sending host's name from its IP
40771 address failed. It corresponds to the &$host_lookup_failed$& variable.
40772
40773 .vitem "&%-host_name%&&~<&'text'&>"
40774 .cindex "reverse DNS lookup"
40775 .cindex "DNS" "reverse lookup"
40776 This records the name of the remote host from which the message was received,
40777 if the host name was looked up from the IP address when the message was being
40778 received. It is not present if no reverse lookup was done.
40779
40780 .vitem "&%-ident%&&~<&'text'&>"
40781 For locally submitted messages, this records the login of the originating user,
40782 unless it was a trusted user and the &%-oMt%& option was used to specify an
40783 ident value. For messages received over TCP/IP, this records the ident string
40784 supplied by the remote host, if any.
40785
40786 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40787 This records the IP address of the local interface and the port number through
40788 which a message was received from a remote host. It is omitted for locally
40789 generated messages.
40790
40791 .vitem &%-local%&
40792 The message is from a local sender.
40793
40794 .vitem &%-localerror%&
40795 The message is a locally-generated bounce message.
40796
40797 .vitem "&%-local_scan%&&~<&'string'&>"
40798 This records the data string that was returned by the &[local_scan()]& function
40799 when the message was received &-- the value of the &$local_scan_data$&
40800 variable. It is omitted if no data was returned.
40801
40802 .vitem &%-manual_thaw%&
40803 The message was frozen but has been thawed manually, that is, by an explicit
40804 Exim command rather than via the auto-thaw process.
40805
40806 .vitem &%-N%&
40807 A testing delivery process was started using the &%-N%& option to suppress any
40808 actual deliveries, but delivery was deferred. At any further delivery attempts,
40809 &%-N%& is assumed.
40810
40811 .vitem &%-received_protocol%&
40812 This records the value of the &$received_protocol$& variable, which contains
40813 the name of the protocol by which the message was received.
40814
40815 .vitem &%-sender_set_untrusted%&
40816 The envelope sender of this message was set by an untrusted local caller (used
40817 to ensure that the caller is displayed in queue listings).
40818
40819 .vitem "&%-spam_score_int%&&~<&'number'&>"
40820 If a message was scanned by SpamAssassin, this is present. It records the value
40821 of &$spam_score_int$&.
40822
40823 .vitem &%-spool_file_wireformat%&
40824 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40825 rather than Unix-format.
40826 The line-ending is CRLF rather than newline.
40827 There is still, however, no leading-dot-stuffing.
40828
40829 .vitem &%-tls_certificate_verified%&
40830 A TLS certificate was received from the client that sent this message, and the
40831 certificate was verified by the server.
40832
40833 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40834 When the message was received over an encrypted connection, this records the
40835 name of the cipher suite that was used.
40836
40837 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40838 When the message was received over an encrypted connection, and a certificate
40839 was received from the client, this records the Distinguished Name from that
40840 certificate.
40841 .endlist
40842
40843 Any of the above may have an extra hyphen prepended, to indicate the the
40844 corresponding data is untrusted.
40845
40846 Following the options there is a list of those addresses to which the message
40847 is not to be delivered. This set of addresses is initialized from the command
40848 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40849 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40850 the address is added to this set. The addresses are kept internally as a
40851 balanced binary tree, and it is a representation of that tree which is written
40852 to the spool file. If an address is expanded via an alias or forward file, the
40853 original address is added to the tree when deliveries to all its child
40854 addresses are complete.
40855
40856 If the tree is empty, there is a single line in the spool file containing just
40857 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40858 Y or N, followed by an address. The address is the value for the node of the
40859 tree, and the letters indicate whether the node has a left branch and/or a
40860 right branch attached to it, respectively. If branches exist, they immediately
40861 follow. Here is an example of a three-node tree:
40862 .code
40863 YY darcy@austen.fict.example
40864 NN alice@wonderland.fict.example
40865 NN editor@thesaurus.ref.example
40866 .endd
40867 After the non-recipients tree, there is a list of the message's recipients.
40868 This is a simple list, preceded by a count. It includes all the original
40869 recipients of the message, including those to whom the message has already been
40870 delivered. In the simplest case, the list contains one address per line. For
40871 example:
40872 .code
40873 4
40874 editor@thesaurus.ref.example
40875 darcy@austen.fict.example
40876 rdo@foundation
40877 alice@wonderland.fict.example
40878 .endd
40879 However, when a child address has been added to the top-level addresses as a
40880 result of the use of the &%one_time%& option on a &(redirect)& router, each
40881 line is of the following form:
40882 .display
40883 <&'top-level address'&> <&'errors_to address'&> &&&
40884   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40885 .endd
40886 The 01 flag bit indicates the presence of the three other fields that follow
40887 the top-level address. Other bits may be used in future to support additional
40888 fields. The <&'parent number'&> is the offset in the recipients list of the
40889 original parent of the &"one time"& address. The first two fields are the
40890 envelope sender that is associated with this address and its length. If the
40891 length is zero, there is no special envelope sender (there are then two space
40892 characters in the line). A non-empty field can arise from a &(redirect)& router
40893 that has an &%errors_to%& setting.
40894
40895
40896 A blank line separates the envelope and status information from the headers
40897 which follow. A header may occupy several lines of the file, and to save effort
40898 when reading it in, each header is preceded by a number and an identifying
40899 character. The number is the number of characters in the header, including any
40900 embedded newlines and the terminating newline. The character is one of the
40901 following:
40902
40903 .table2 50pt
40904 .row <&'blank'&>         "header in which Exim has no special interest"
40905 .row &`B`&               "&'Bcc:'& header"
40906 .row &`C`&               "&'Cc:'& header"
40907 .row &`F`&               "&'From:'& header"
40908 .row &`I`&               "&'Message-id:'& header"
40909 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40910 .row &`R`&               "&'Reply-To:'& header"
40911 .row &`S`&               "&'Sender:'& header"
40912 .row &`T`&               "&'To:'& header"
40913 .row &`*`&               "replaced or deleted header"
40914 .endtable
40915
40916 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40917 purposes. They are not transmitted when the message is delivered. Here is a
40918 typical set of headers:
40919 .code
40920 111P Received: by hobbit.fict.example with local (Exim 4.00)
40921 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40922 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40923 038* X-rewrote-sender: bb@hobbit.fict.example
40924 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40925 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40926 099* To: alice@wonderland.fict.example, rdo@foundation,
40927 darcy@austen.fict.example, editor@thesaurus.ref.example
40928 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40929 darcy@austen.fict.example, editor@thesaurus.ref.example
40930 038  Date: Fri, 11 May 2001 10:28:59 +0100
40931 .endd
40932 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40933 &'To:'& header have been rewritten, the last one because routing expanded the
40934 unqualified domain &'foundation'&.
40935 .ecindex IIDforspo1
40936 .ecindex IIDforspo2
40937 .ecindex IIDforspo3
40938
40939 .section "Format of the -D file" "SECID282a"
40940 The data file is traditionally in Unix-standard format: lines are ended with
40941 an ASCII newline character.
40942 However, when the &%spool_wireformat%& main option is used some -D files
40943 can have an alternate format.
40944 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40945 The -D file lines (not including the first name-component line) are
40946 suitable for direct copying to the wire when transmitting using the
40947 ESMTP CHUNKING option, meaning lower processing overhead.
40948 Lines are terminated with an ASCII CRLF pair.
40949 There is no dot-stuffing (and no dot-termination).
40950
40951 . ////////////////////////////////////////////////////////////////////////////
40952 . ////////////////////////////////////////////////////////////////////////////
40953
40954 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
40955          "DKIM, SPF, SRS and DMARC Support"
40956
40957 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40958 .cindex "DKIM"
40959
40960 DKIM is a mechanism by which messages sent by some entity can be provably
40961 linked to a domain which that entity controls.  It permits reputation to
40962 be tracked on a per-domain basis, rather than merely upon source IP address.
40963 DKIM is documented in RFC 6376.
40964
40965 As DKIM relies on the message being unchanged in transit, messages handled
40966 by a mailing-list (which traditionally adds to the message) will not match
40967 any original DKIM signature.
40968
40969 DKIM support is compiled into Exim by default if TLS support is present.
40970 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40971
40972 Exim's DKIM implementation allows for
40973 .olist
40974 Signing outgoing messages: This function is implemented in the SMTP transport.
40975 It can co-exist with all other Exim features
40976 (including transport filters)
40977 except cutthrough delivery.
40978 .next
40979 Verifying signatures in incoming messages: This is implemented by an additional
40980 ACL (acl_smtp_dkim), which can be called several times per message, with
40981 different signature contexts.
40982 .endlist
40983
40984 In typical Exim style, the verification implementation does not include any
40985 default "policy". Instead it enables you to build your own policy using
40986 Exim's standard controls.
40987
40988 Please note that verification of DKIM signatures in incoming mail is turned
40989 on by default for logging (in the <= line) purposes.
40990
40991 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40992 When set, for each signature in incoming email,
40993 exim will log a line displaying the most important signature details, and the
40994 signature status. Here is an example (with line-breaks added for clarity):
40995 .code
40996 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40997     d=facebookmail.com s=q1-2009b
40998     c=relaxed/relaxed a=rsa-sha1
40999     i=@facebookmail.com t=1252484542 [verification succeeded]
41000 .endd
41001
41002 You might want to turn off DKIM verification processing entirely for internal
41003 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41004 control modifier. This should typically be done in the RCPT ACL, at points
41005 where you accept mail from relay sources (internal hosts or authenticated
41006 senders).
41007
41008
41009 .section "Signing outgoing messages" "SECDKIMSIGN"
41010 .cindex "DKIM" "signing"
41011
41012 For signing to be usable you must have published a DKIM record in DNS.
41013 Note that RFC 8301 (which does not cover EC keys) says:
41014 .code
41015 rsa-sha1 MUST NOT be used for signing or verifying.
41016
41017 Signers MUST use RSA keys of at least 1024 bits for all keys.
41018 Signers SHOULD use RSA keys of at least 2048 bits.
41019 .endd
41020
41021 Note also that the key content (the 'p=' field)
41022 in the DNS record is different between RSA and EC keys;
41023 for the former it is the base64 of the ASN.1 for the RSA public key
41024 (equivalent to the private-key .pem with the header/trailer stripped)
41025 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41026
41027 Signing is enabled by setting private options on the SMTP transport.
41028 These options take (expandable) strings as arguments.
41029
41030 .option dkim_domain smtp "string list&!!" unset
41031 The domain(s) you want to sign with.
41032 After expansion, this can be a list.
41033 Each element in turn,
41034 lowercased,
41035 is put into the &%$dkim_domain%& expansion variable
41036 while expanding the remaining signing options.
41037 If it is empty after expansion, DKIM signing is not done,
41038 and no error will result even if &%dkim_strict%& is set.
41039
41040 .option dkim_selector smtp "string list&!!" unset
41041 This sets the key selector string.
41042 After expansion, which can use &$dkim_domain$&, this can be a list.
41043 Each element in turn is put in the expansion
41044 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41045 option along with &%$dkim_domain%&.
41046 If the option is empty after expansion, DKIM signing is not done for this domain,
41047 and no error will result even if &%dkim_strict%& is set.
41048
41049 .option dkim_private_key smtp string&!! unset
41050 This sets the private key to use.
41051 You can use the &%$dkim_domain%& and
41052 &%$dkim_selector%& expansion variables to determine the private key to use.
41053 The result can either
41054 .ilist
41055 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41056 .next
41057 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41058 be a valid Ed25519 private key (same format as above)
41059 .next
41060 start with a slash, in which case it is treated as a file that contains
41061 the private key
41062 .next
41063 be "0", "false" or the empty string, in which case the message will not
41064 be signed. This case will not result in an error, even if &%dkim_strict%&
41065 is set.
41066 .endlist
41067
41068 To generate keys under OpenSSL:
41069 .code
41070 openssl genrsa -out dkim_rsa.private 2048
41071 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41072 .endd
41073 The result file from the first command should be retained, and
41074 this option set to use it.
41075 Take the base-64 lines from the output of the second command, concatenated,
41076 for the DNS TXT record.
41077 See section 3.6 of RFC6376 for the record specification.
41078
41079 Under GnuTLS:
41080 .code
41081 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41082 certtool --load-privkey=dkim_rsa.private --pubkey-info
41083 .endd
41084
41085 Note that RFC 8301 says:
41086 .code
41087 Signers MUST use RSA keys of at least 1024 bits for all keys.
41088 Signers SHOULD use RSA keys of at least 2048 bits.
41089 .endd
41090
41091 EC keys for DKIM are defined by RFC 8463.
41092 They are considerably smaller than RSA keys for equivalent protection.
41093 As they are a recent development, users should consider dual-signing
41094 (by setting a list of selectors, and an expansion for this option)
41095 for some transition period.
41096 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41097 for EC keys.
41098
41099 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41100 .code
41101 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41102 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41103 .endd
41104
41105 To produce the required public key value for a DNS record:
41106 .code
41107 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41108 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41109 .endd
41110
41111 Exim also supports an alternate format
41112 of Ed25519 keys in DNS which was a candidate during development
41113 of the standard, but not adopted.
41114 A future release will probably drop that support.
41115
41116 .option dkim_hash smtp string&!! sha256
41117 Can be set to any one of the supported hash methods, which are:
41118 .ilist
41119 &`sha1`& &-- should not be used, is old and insecure
41120 .next
41121 &`sha256`& &-- the default
41122 .next
41123 &`sha512`& &-- possibly more secure but less well supported
41124 .endlist
41125
41126 Note that RFC 8301 says:
41127 .code
41128 rsa-sha1 MUST NOT be used for signing or verifying.
41129 .endd
41130
41131 .option dkim_identity smtp string&!! unset
41132 If set after expansion, the value is used to set an "i=" tag in
41133 the signing header.  The DKIM standards restrict the permissible
41134 syntax of this optional tag to a mail address, with possibly-empty
41135 local part, an @, and a domain identical to or subdomain of the "d="
41136 tag value.  Note that Exim does not check the value.
41137
41138 .option dkim_canon smtp string&!! unset
41139 This option sets the canonicalization method used when signing a message.
41140 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41141 The option defaults to "relaxed" when unset. Note: the current implementation
41142 only supports signing with the same canonicalization method for both headers and body.
41143
41144 .option dkim_strict smtp string&!! unset
41145 This  option  defines  how  Exim  behaves  when  signing a message that
41146 should be signed fails for some reason.  When the expansion evaluates to
41147 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41148 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41149 variables here.
41150
41151 .option dkim_sign_headers smtp string&!! "see below"
41152 If set, this option must expand to a colon-separated
41153 list of header names.
41154 Headers with these names, or the absence or such a header, will be included
41155 in the message signature.
41156 When unspecified, the header names listed in RFC4871 will be used,
41157 whether or not each header is present in the message.
41158 The default list is available for the expansion in the macro
41159 &"_DKIM_SIGN_HEADERS"&
41160 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41161
41162 If a name is repeated, multiple headers by that name (or the absence thereof)
41163 will be signed.  The textually later headers in the headers part of the
41164 message are signed first, if there are multiples.
41165
41166 A name can be prefixed with either an &"="& or a &"+"& character.
41167 If an &"="& prefix is used, all headers that are present with this name
41168 will be signed.
41169 If a &"+"& prefix if used, all headers that are present with this name
41170 will be signed, and one signature added for a missing header with the
41171 name will be appended.
41172
41173 .option dkim_timestamps smtp integer&!! unset
41174 This option controls the inclusion of timestamp information in the signature.
41175 If not set, no such information will be included.
41176 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41177 for the expiry tag
41178 (eg. 1209600 for two weeks);
41179 both creation (t=) and expiry (x=) tags will be included.
41180
41181 RFC 6376 lists these tags as RECOMMENDED.
41182
41183
41184 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
41185 .cindex "DKIM" "verification"
41186
41187 Verification of DKIM signatures in SMTP incoming email is done for all
41188 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41189 .cindex DKIM "selecting signature algorithms"
41190 Individual classes of signature algorithm can be ignored by changing
41191 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41192 The &%dkim_verify_minimal%& option can be set to cease verification
41193 processing for a message once the first passing signature is found.
41194
41195 .cindex authentication "expansion item"
41196 Performing verification sets up information used by the
41197 &%authresults%& expansion item.
41198
41199 For most purposes the default option settings suffice and the remainder
41200 of this section can be ignored.
41201
41202 The results of verification are made available to the
41203 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41204 A missing ACL definition defaults to accept.
41205 By default, the ACL is called once for each
41206 syntactically(!) correct signature in the incoming message.
41207 If any ACL call does not accept, the message is not accepted.
41208 If a cutthrough delivery was in progress for the message, that is
41209 summarily dropped (having wasted the transmission effort).
41210
41211 To evaluate the verification result in the ACL
41212 a large number of expansion variables
41213 containing the signature status and its details are set up during the
41214 runtime of the ACL.
41215
41216 Calling the ACL only for existing signatures is not sufficient to build
41217 more advanced policies. For that reason, the main option
41218 &%dkim_verify_signers%&, and an expansion variable
41219 &%$dkim_signers%& exist.
41220
41221 The main option &%dkim_verify_signers%& can be set to a colon-separated
41222 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41223 called. It is expanded when the message has been received. At this point,
41224 the expansion variable &%$dkim_signers%& already contains a colon-separated
41225 list of signer domains and identities for the message. When
41226 &%dkim_verify_signers%& is not specified in the main configuration,
41227 it defaults as:
41228 .code
41229 dkim_verify_signers = $dkim_signers
41230 .endd
41231 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41232 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41233 call the ACL for known domains or identities. This would be achieved as follows:
41234 .code
41235 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41236 .endd
41237 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41238 and "ebay.com", plus all domains and identities that have signatures in the message.
41239 You can also be more creative in constructing your policy. For example:
41240 .code
41241 dkim_verify_signers = $sender_address_domain:$dkim_signers
41242 .endd
41243
41244 If a domain or identity is listed several times in the (expanded) value of
41245 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41246
41247 Note that if the option is set using untrustworthy data
41248 (such as the From: header)
41249 care should be taken to force lowercase for domains
41250 and for the domain part if identities.
41251 The default setting can be regarded as trustworthy in this respect.
41252
41253 If multiple signatures match a domain (or identity), the ACL is called once
41254 for each matching signature.
41255
41256
41257 Inside the DKIM ACL, the following expansion variables are
41258 available (from most to least important):
41259
41260
41261 .vlist
41262 .vitem &%$dkim_cur_signer%&
41263 The signer that is being evaluated in this ACL run. This can be a domain or
41264 an identity. This is one of the list items from the expanded main option
41265 &%dkim_verify_signers%& (see above).
41266
41267 .vitem &%$dkim_verify_status%&
41268 Within the DKIM ACL,
41269 a string describing the general status of the signature. One of
41270 .ilist
41271 &%none%&: There is no signature in the message for the current domain or
41272 identity (as reflected by &%$dkim_cur_signer%&).
41273 .next
41274 &%invalid%&: The signature could not be verified due to a processing error.
41275 More detail is available in &%$dkim_verify_reason%&.
41276 .next
41277 &%fail%&: Verification of the signature failed.  More detail is
41278 available in &%$dkim_verify_reason%&.
41279 .next
41280 &%pass%&: The signature passed verification. It is valid.
41281 .endlist
41282
41283 This variable can be overwritten using an ACL 'set' modifier.
41284 This might, for instance, be done to enforce a policy restriction on
41285 hash-method or key-size:
41286 .code
41287   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41288        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41289        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41290                                   {< {$dkim_key_length}{1024}}}}
41291        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41292        set dkim_verify_status = fail
41293        set dkim_verify_reason = hash too weak or key too short
41294 .endd
41295
41296 So long as a DKIM ACL is defined (it need do no more than accept),
41297 after all the DKIM ACL runs have completed, the value becomes a
41298 colon-separated list of the values after each run.
41299 This is maintained for the mime, prdr and data ACLs.
41300
41301 .vitem &%$dkim_verify_reason%&
41302 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41303 "fail" or "invalid". One of
41304 .ilist
41305 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41306 key for the domain could not be retrieved. This may be a temporary problem.
41307 .next
41308 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41309 record for the domain is syntactically invalid.
41310 .next
41311 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41312 body hash does not match the one specified in the signature header. This
41313 means that the message body was modified in transit.
41314 .next
41315 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41316 could not be verified. This may mean that headers were modified,
41317 re-written or otherwise changed in a way which is incompatible with
41318 DKIM verification. It may of course also mean that the signature is forged.
41319 .endlist
41320
41321 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41322
41323 .vitem &%$dkim_domain%&
41324 The signing domain. IMPORTANT: This variable is only populated if there is
41325 an actual signature in the message for the current domain or identity (as
41326 reflected by &%$dkim_cur_signer%&).
41327
41328 .vitem &%$dkim_identity%&
41329 The signing identity, if present. IMPORTANT: This variable is only populated
41330 if there is an actual signature in the message for the current domain or
41331 identity (as reflected by &%$dkim_cur_signer%&).
41332
41333 .vitem &%$dkim_selector%&
41334 The key record selector string.
41335
41336 .vitem &%$dkim_algo%&
41337 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41338 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41339 may also be 'ed25519-sha256'.
41340 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41341 for EC keys.
41342
41343 Note that RFC 8301 says:
41344 .code
41345 rsa-sha1 MUST NOT be used for signing or verifying.
41346
41347 DKIM signatures identified as having been signed with historic
41348 algorithms (currently, rsa-sha1) have permanently failed evaluation
41349 .endd
41350
41351 To enforce this you must either have a DKIM ACL which checks this variable
41352 and overwrites the &$dkim_verify_status$& variable as discussed above,
41353 or have set the main option &%dkim_verify_hashes%& to exclude
41354 processing of such signatures.
41355
41356 .vitem &%$dkim_canon_body%&
41357 The body canonicalization method. One of 'relaxed' or 'simple'.
41358
41359 .vitem &%$dkim_canon_headers%&
41360 The header canonicalization method. One of 'relaxed' or 'simple'.
41361
41362 .vitem &%$dkim_copiedheaders%&
41363 A transcript of headers and their values which are included in the signature
41364 (copied from the 'z=' tag of the signature).
41365 Note that RFC6376 requires that verification fail if the From: header is
41366 not included in the signature.  Exim does not enforce this; sites wishing
41367 strict enforcement should code the check explicitly.
41368
41369 .vitem &%$dkim_bodylength%&
41370 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41371 limit was set by the signer, "9999999999999" is returned. This makes sure
41372 that this variable always expands to an integer value.
41373 &*Note:*& The presence of the signature tag specifying a signing body length
41374 is one possible route to spoofing of valid DKIM signatures.
41375 A paranoid implementation might wish to regard signature where this variable
41376 shows less than the "no limit" return as being invalid.
41377
41378 .vitem &%$dkim_created%&
41379 UNIX timestamp reflecting the date and time when the signature was created.
41380 When this was not specified by the signer, "0" is returned.
41381
41382 .vitem &%$dkim_expires%&
41383 UNIX timestamp reflecting the date and time when the signer wants the
41384 signature to be treated as "expired". When this was not specified by the
41385 signer, "9999999999999" is returned. This makes it possible to do useful
41386 integer size comparisons against this value.
41387 Note that Exim does not check this value.
41388
41389 .vitem &%$dkim_headernames%&
41390 A colon-separated list of names of headers included in the signature.
41391
41392 .vitem &%$dkim_key_testing%&
41393 "1" if the key record has the "testing" flag set, "0" if not.
41394
41395 .vitem &%$dkim_key_nosubdomains%&
41396 "1" if the key record forbids subdomaining, "0" otherwise.
41397
41398 .vitem &%$dkim_key_srvtype%&
41399 Service type (tag s=) from the key record. Defaults to "*" if not specified
41400 in the key record.
41401
41402 .vitem &%$dkim_key_granularity%&
41403 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41404 in the key record.
41405
41406 .vitem &%$dkim_key_notes%&
41407 Notes from the key record (tag n=).
41408
41409 .vitem &%$dkim_key_length%&
41410 Number of bits in the key.
41411 Valid only once the key is loaded, which is at the time the header signature
41412 is verified, which is after the body hash is.
41413
41414 Note that RFC 8301 says:
41415 .code
41416 Verifiers MUST NOT consider signatures using RSA keys of
41417 less than 1024 bits as valid signatures.
41418 .endd
41419
41420 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41421 option.
41422
41423 .endlist
41424
41425 In addition, two ACL conditions are provided:
41426
41427 .vlist
41428 .vitem &%dkim_signers%&
41429 ACL condition that checks a colon-separated list of domains or identities
41430 for a match against the domain or identity that the ACL is currently verifying
41431 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41432 verb to a group of domains or identities. For example:
41433
41434 .code
41435 # Warn when Mail purportedly from GMail has no gmail signature
41436 warn sender_domains = gmail.com
41437      dkim_signers = gmail.com
41438      dkim_status = none
41439      log_message = GMail sender without gmail.com DKIM signature
41440 .endd
41441
41442 Note that the above does not check for a total lack of DKIM signing;
41443 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41444
41445 .vitem &%dkim_status%&
41446 ACL condition that checks a colon-separated list of possible DKIM verification
41447 results against the actual result of verification. This is typically used
41448 to restrict an ACL verb to a list of verification outcomes, for example:
41449
41450 .code
41451 deny sender_domains = paypal.com:paypal.de
41452      dkim_signers = paypal.com:paypal.de
41453      dkim_status = none:invalid:fail
41454      message = Mail from Paypal with invalid/missing signature
41455 .endd
41456
41457 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41458 see the documentation of the &%$dkim_verify_status%& expansion variable above
41459 for more information of what they mean.
41460 .endlist
41461
41462
41463
41464
41465 .section "SPF (Sender Policy Framework)" SECSPF
41466 .cindex SPF verification
41467
41468 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41469 messages with its domain in the envelope from, documented by RFC 7208.
41470 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41471 the &url(http://openspf.org).
41472 . --- 2019-10-28: still not https, open-spf.org is told to be a
41473 . --- web-archive copy of the now dead openspf.org site
41474 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41475 . --- discussion.
41476
41477 Messages sent by a system not authorised will fail checking of such assertions.
41478 This includes retransmissions done by traditional forwarders.
41479
41480 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41481 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41482 &url(https://www.libspf2.org/).
41483 There is no Exim involvement in the transmission of messages;
41484 publishing certain DNS records is all that is required.
41485
41486 For verification, an ACL condition and an expansion lookup are provided.
41487 .cindex authentication "expansion item"
41488 Performing verification sets up information used by the
41489 &%authresults%& expansion item.
41490
41491
41492 .cindex SPF "ACL condition"
41493 .cindex ACL "spf condition"
41494 The ACL condition "spf" can be used at or after the MAIL ACL.
41495 It takes as an argument a list of strings giving the outcome of the SPF check,
41496 and will succeed for any matching outcome.
41497 Valid strings are:
41498 .vlist
41499 .vitem &%pass%&
41500 The SPF check passed, the sending host is positively verified by SPF.
41501
41502 .vitem &%fail%&
41503 The SPF check failed, the sending host is NOT allowed to send mail for the
41504 domain in the envelope-from address.
41505
41506 .vitem &%softfail%&
41507 The SPF check failed, but the queried domain can't absolutely confirm that this
41508 is a forgery.
41509
41510 .vitem &%none%&
41511 The queried domain does not publish SPF records.
41512
41513 .vitem &%neutral%&
41514 The SPF check returned a "neutral" state.  This means the queried domain has
41515 published a SPF record, but wants to allow outside servers to send mail under
41516 its domain as well.  This should be treated like "none".
41517
41518 .vitem &%permerror%&
41519 This indicates a syntax error in the SPF record of the queried domain.
41520 You may deny messages when this occurs.
41521
41522 .vitem &%temperror%&
41523 This indicates a temporary error during all processing, including Exim's
41524 SPF processing.  You may defer messages when this occurs.
41525 .endlist
41526
41527 You can prefix each string with an exclamation mark to  invert
41528 its meaning,  for example  "!fail" will  match all  results but
41529 "fail".  The  string  list is  evaluated  left-to-right,  in a
41530 short-circuit fashion.
41531
41532 Example:
41533 .code
41534 deny spf = fail
41535      message = $sender_host_address is not allowed to send mail from \
41536                ${if def:sender_address_domain \
41537                     {$sender_address_domain}{$sender_helo_name}}.  \
41538                Please see http://www.open-spf.org/Why;\
41539                identity=${if def:sender_address_domain \
41540                              {$sender_address}{$sender_helo_name}};\
41541                ip=$sender_host_address
41542 .endd
41543
41544 Note: The above mentioned URL may not be as helpful as expected. You are
41545 encouraged to replace the link with a link to a site with more
41546 explanations.
41547
41548 When the spf condition has run, it sets up several expansion
41549 variables:
41550
41551 .cindex SPF "verification variables"
41552 .vlist
41553 .vitem &$spf_header_comment$&
41554 .vindex &$spf_header_comment$&
41555   This contains a human-readable string describing the outcome
41556   of the SPF check. You can add it to a custom header or use
41557   it for logging purposes.
41558
41559 .vitem &$spf_received$&
41560 .vindex &$spf_received$&
41561   This contains a complete Received-SPF: header that can be
41562   added to the message. Please note that according to the SPF
41563   draft, this header must be added at the top of the header
41564   list. Please see section 10 on how you can do this.
41565
41566   Note: in case of "Best-guess" (see below), the convention is
41567   to put this string in a header called X-SPF-Guess: instead.
41568
41569 .vitem &$spf_result$&
41570 .vindex &$spf_result$&
41571   This contains the outcome of the SPF check in string form,
41572   one of pass, fail, softfail, none, neutral, permerror or
41573   temperror.
41574
41575 .vitem &$spf_result_guessed$&
41576 .vindex &$spf_result_guessed$&
41577   This boolean is true only if a best-guess operation was used
41578   and required in order to obtain a result.
41579
41580 .vitem &$spf_smtp_comment$&
41581 .vindex &$spf_smtp_comment$&
41582 .vindex &%spf_smtp_comment_template%&
41583   This contains a string that can be used in a SMTP response
41584   to the calling party. Useful for "fail".
41585   The string is generated by the SPF library from the template configured in the main config
41586   option &%spf_smtp_comment_template%&.
41587 .endlist
41588
41589
41590 .cindex SPF "ACL condition"
41591 .cindex ACL "spf_guess condition"
41592 .cindex SPF "best guess"
41593 In addition to SPF, you can also perform checks for so-called
41594 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41595 SPF, but it is supported by the same framework that enables SPF
41596 capability.
41597 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41598 for a description of what it means.
41599 . --- 2019-10-28: still not https:
41600
41601 To access this feature, simply use the spf_guess condition in place
41602 of the spf one.  For example:
41603
41604 .code
41605 deny spf_guess = fail
41606      message = $sender_host_address doesn't look trustworthy to me
41607 .endd
41608
41609 In case you decide to reject messages based on this check, you
41610 should note that although it uses the same framework, "Best-guess"
41611 is not SPF, and therefore you should not mention SPF at all in your
41612 reject message.
41613
41614 When the spf_guess condition has run, it sets up the same expansion
41615 variables as when spf condition is run, described above.
41616
41617 Additionally, since Best-guess is not standardized, you may redefine
41618 what "Best-guess" means to you by redefining the main configuration
41619 &%spf_guess%& option.
41620 For example, the following:
41621
41622 .code
41623 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41624 .endd
41625
41626 would relax host matching rules to a broader network range.
41627
41628
41629 .cindex SPF "lookup expansion"
41630 .cindex lookup spf
41631 A lookup expansion is also available. It takes an email
41632 address as the key and an IP address
41633 (v4 or v6)
41634 as the database:
41635
41636 .code
41637   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41638 .endd
41639
41640 The lookup will return the same result strings as can appear in
41641 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41642
41643
41644
41645
41646
41647 .section "SRS (Sender Rewriting Scheme)" SECTSRS
41648 .cindex SRS "sender rewriting scheme"
41649
41650 .new
41651 SRS can be used to modify sender addresses when forwarding so that
41652 SPF verification does not object to them.
41653 It operates by encoding the original envelope sender in a new
41654 sender local part and using a domain run by the forwarding site
41655 as the new domain for the sender.  Any DSN message should be returned
41656 to this new sender at the forwarding site, which can extract the
41657 original sender from the coded local part and forward the DSN to
41658 the originator.
41659
41660 This is a way of avoiding the breakage that SPF does to forwarding.
41661 The constructed local-part will be longer than the original,
41662 leading to possible problems with very long addresses.
41663 The changing of the sender address also hinders the tracing of mail
41664 problems.
41665
41666 Exim can be built to include native SRS support.  To do this
41667 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
41668 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
41669 will be defined.
41670 The support is limited to SRS0-encoding; SRS1 is not supported.
41671
41672 .cindex SRS excoding
41673 To encode an address use this expansion item:
41674 .vlist
41675 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
41676 .cindex "&%srs_encode%& expansion item"
41677 .cindex SRS "expansion item"
41678 The first argument should be a secret known and used by all systems
41679 handling the recipient domain for the original message.
41680 There is no need to periodically change this key; a timestamp is also
41681 encoded.
41682 The second argument should be given as the envelope sender address before this
41683 encoding operation.
41684 The third argument should be the recipient domain of the message when
41685 it arrived at this system.
41686 .endlist
41687
41688 .cindex SRS decoding
41689 To decode an address use this expansion condition:
41690 .vlist
41691 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
41692 The first argument should be the recipient local prt as is was received.
41693 The second argument is the site secret.
41694
41695 If the messages is not for an SRS-encoded recipient the condition will
41696 return false.  If it is, the condition will return true and the variable
41697 &$srs_recipient$& will be set to the decoded (original) value.
41698 .endlist
41699
41700 Example usage:
41701 .code
41702   #macro
41703   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
41704
41705   #routers
41706
41707   outbound:
41708     driver =    dnslookup
41709     # if outbound, and forwarding has been done, use an alternate transport
41710     domains =   ! +my_domains
41711     transport = ${if eq {$local_part@$domain} \
41712                         {$original_local_part@$original_domain} \
41713                      {remote_smtp} {remote_forwarded_smtp}}
41714
41715   inbound_srs:
41716     driver =    redirect
41717     senders =   :
41718     domains =   +my_domains
41719     # detect inbound bounces which are SRS'd, and decode them
41720     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
41721     data =      $srs_recipient
41722
41723   inbound_srs_failure:
41724     driver =    redirect
41725     senders =   :
41726     domains =   +my_domains
41727     # detect inbound bounces which look SRS'd but are invalid
41728     condition = ${if inbound_srs {$local_part} {}}
41729     allow_fail
41730     data =      :fail: Invalid SRS recipient address
41731
41732   #... further routers here
41733
41734
41735   # transport; should look like the non-forward outbound
41736   # one, plus the max_rcpt and return_path options
41737   remote_forwarded_smtp:
41738     driver =              smtp
41739     # modify the envelope from, for mails that we forward
41740     max_rcpt =            1
41741     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
41742 .endd
41743
41744
41745 .wen
41746
41747
41748
41749 .section DMARC SECDMARC
41750 .cindex DMARC verification
41751
41752 DMARC combines feedback from SPF, DKIM, and header From: in order
41753 to attempt to provide better indicators of the authenticity of an
41754 email.  This document does not explain the fundamentals; you
41755 should read and understand how it works by visiting the website at
41756 &url(http://www.dmarc.org/).
41757
41758 If Exim is built with DMARC support,
41759 the libopendmarc library is used.
41760
41761 For building Exim yourself, obtain the library from
41762 &url(http://sourceforge.net/projects/opendmarc/)
41763 to obtain a copy, or find it in your favorite package
41764 repository.  You will need to attend to the local/Makefile feature
41765 SUPPORT_DMARC and the associated LDFLAGS addition.
41766 This description assumes
41767 that headers will be in /usr/local/include, and that the libraries
41768 are in /usr/local/lib.
41769
41770 . subsection
41771
41772 There are three main-configuration options:
41773 .cindex DMARC "configuration options"
41774
41775 The &%dmarc_tld_file%& option
41776 .oindex &%dmarc_tld_file%&
41777 defines the location of a text file of valid
41778 top level domains the opendmarc library uses
41779 during domain parsing. Maintained by Mozilla,
41780 the most current version can be downloaded
41781 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41782 See also the util/renew-opendmarc-tlds.sh script.
41783 The default for the option is unset.
41784 If not set, DMARC processing is disabled.
41785
41786
41787 The &%dmarc_history_file%& option, if set
41788 .oindex &%dmarc_history_file%&
41789 defines the location of a file to log results
41790 of dmarc verification on inbound emails. The
41791 contents are importable by the opendmarc tools
41792 which will manage the data, send out DMARC
41793 reports, and expire the data. Make sure the
41794 directory of this file is writable by the user
41795 exim runs as.
41796 The default is unset.
41797
41798 The &%dmarc_forensic_sender%& option
41799 .oindex &%dmarc_forensic_sender%&
41800 defines an alternate email address to use when sending a
41801 forensic report detailing alignment failures
41802 if a sender domain's dmarc record specifies it
41803 and you have configured Exim to send them.
41804 If set, this is expanded and used for the
41805 From: header line; the address is extracted
41806 from it and used for the envelope from.
41807 If not set (the default), the From: header is expanded from
41808 the dsn_from option, and <> is used for the
41809 envelope from.
41810
41811 . I wish we had subsections...
41812
41813 .cindex DMARC controls
41814 By default, the DMARC processing will run for any remote,
41815 non-authenticated user.  It makes sense to only verify DMARC
41816 status of messages coming from remote, untrusted sources.  You can
41817 use standard conditions such as hosts, senders, etc, to decide that
41818 DMARC verification should *not* be performed for them and disable
41819 DMARC with an ACL control modifier:
41820 .code
41821   control = dmarc_disable_verify
41822 .endd
41823 A DMARC record can also specify a "forensic address", which gives
41824 exim an email address to submit reports about failed alignment.
41825 Exim does not do this by default because in certain conditions it
41826 results in unintended information leakage (what lists a user might
41827 be subscribed to, etc).  You must configure exim to submit forensic
41828 reports to the owner of the domain.  If the DMARC record contains a
41829 forensic address and you specify the control statement below, then
41830 exim will send these forensic emails.  It is also advised that you
41831 configure a &%dmarc_forensic_sender%& because the default sender address
41832 construction might be inadequate.
41833 .code
41834   control = dmarc_enable_forensic
41835 .endd
41836 (AGAIN: You can choose not to send these forensic reports by simply
41837 not putting the dmarc_enable_forensic control line at any point in
41838 your exim config.  If you don't tell exim to send them, it will not
41839 send them.)
41840
41841 There are no options to either control.  Both must appear before
41842 the DATA acl.
41843
41844 . subsection
41845
41846 DMARC checks cam be run on incoming SMTP  messages by using the
41847 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41848 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41849 condition.  Putting this condition in the ACLs is required in order
41850 for a DMARC check to actually occur.  All of the variables are set
41851 up before the DATA ACL, but there is no actual DMARC check that
41852 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41853
41854 The &"dmarc_status"& condition takes a list of strings on its
41855 right-hand side.  These strings describe recommended action based
41856 on the DMARC check.  To understand what the policy recommendations
41857 mean, refer to the DMARC website above.  Valid strings are:
41858 .display
41859 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41860 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41861 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41862 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41863 &'norecord    '& No policy section in the DMARC record for this RFC5322.From field
41864 &'nofrom      '& Unable to determine the domain of the sender.
41865 &'temperror   '& Library error or dns error.
41866 &'off         '& The DMARC check was disabled for this email.
41867 .endd
41868 You can prefix each string with an exclamation mark to invert its
41869 meaning, for example "!accept" will match all results but
41870 "accept".  The string list is evaluated left-to-right in a
41871 short-circuit fashion.  When a string matches the outcome of the
41872 DMARC check, the condition succeeds.  If none of the listed
41873 strings matches the outcome of the DMARC check, the condition
41874 fails.
41875
41876 Of course, you can also use any other lookup method that Exim
41877 supports, including LDAP, Postgres, MySQL, etc, as long as the
41878 result is a list of colon-separated strings.
41879
41880 Performing the check sets up information used by the
41881 &%authresults%& expansion item.
41882
41883 Several expansion variables are set before the DATA ACL is
41884 processed, and you can use them in this ACL.  The following
41885 expansion variables are available:
41886
41887 .vlist
41888 .vitem &$dmarc_status$&
41889 .vindex &$dmarc_status$&
41890 .cindex DMARC result
41891 A one word status indicating what the DMARC library
41892 thinks of the email.  It is a combination of the results of
41893 DMARC record lookup and the SPF/DKIM/DMARC processing results
41894 (if a DMARC record was found).  The actual policy declared
41895 in the DMARC record is in a separate expansion variable.
41896
41897 .vitem &$dmarc_status_text$&
41898 .vindex &$dmarc_status_text$&
41899 Slightly longer, human readable status.
41900
41901 .vitem &$dmarc_used_domain$&
41902 .vindex &$dmarc_used_domain$&
41903 The domain which DMARC used to look up the DMARC policy record.
41904
41905 .vitem &$dmarc_domain_policy$&
41906 .vindex &$dmarc_domain_policy$&
41907 The policy declared in the DMARC record.  Valid values
41908 are "none", "reject" and "quarantine".  It is blank when there
41909 is any error, including no DMARC record.
41910 .endlist
41911
41912 . subsection
41913
41914 By default, Exim's DMARC configuration is intended to be
41915 non-intrusive and conservative.  To facilitate this, Exim will not
41916 create any type of logging files without explicit configuration by
41917 you, the admin.  Nor will Exim send out any emails/reports about
41918 DMARC issues without explicit configuration by you, the admin (other
41919 than typical bounce messages that may come about due to ACL
41920 processing or failure delivery issues).
41921
41922 In order to log statistics suitable to be imported by the opendmarc
41923 tools, you need to:
41924 .ilist
41925 Configure the global option &%dmarc_history_file%&
41926 .next
41927 Configure cron jobs to call the appropriate opendmarc history
41928 import scripts and truncating the dmarc_history_file
41929 .endlist
41930
41931 In order to send forensic reports, you need to:
41932 .ilist
41933 Configure the global option &%dmarc_forensic_sender%&
41934 .next
41935 Configure, somewhere before the DATA ACL, the control option to
41936 enable sending DMARC forensic reports
41937 .endlist
41938
41939 . subsection
41940
41941 Example usage:
41942 .code
41943 (RCPT ACL)
41944   warn    domains        = +local_domains
41945           hosts          = +local_hosts
41946           control        = dmarc_disable_verify
41947
41948   warn    !domains       = +screwed_up_dmarc_records
41949           control        = dmarc_enable_forensic
41950
41951   warn    condition      = (lookup if destined to mailing list)
41952           set acl_m_mailing_list = 1
41953
41954 (DATA ACL)
41955   warn    dmarc_status   = accept : none : off
41956           !authenticated = *
41957           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
41958
41959   warn    dmarc_status   = !accept
41960           !authenticated = *
41961           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
41962
41963   warn    dmarc_status   = quarantine
41964           !authenticated = *
41965           set $acl_m_quarantine = 1
41966           # Do something in a transport with this flag variable
41967
41968   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
41969           condition      = ${if eq{$acl_m_mailing_list}{1}}
41970           message        = Messages from $dmarc_used_domain break mailing lists
41971
41972   deny    dmarc_status   = reject
41973           !authenticated = *
41974           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
41975
41976   warn    add_header     = :at_start:${authresults {$primary_hostname}}
41977 .endd
41978
41979
41980
41981
41982
41983 . ////////////////////////////////////////////////////////////////////////////
41984 . ////////////////////////////////////////////////////////////////////////////
41985
41986 .chapter "Proxies" "CHAPproxies" &&&
41987          "Proxy support"
41988 .cindex "proxy support"
41989 .cindex "proxy" "access via"
41990
41991 A proxy is an intermediate system through which communication is passed.
41992 Proxies may provide a security, availability or load-distribution function.
41993
41994
41995 .section "Inbound proxies" SECTproxyInbound
41996 .cindex proxy inbound
41997 .cindex proxy "server side"
41998 .cindex proxy "Proxy protocol"
41999 .cindex "Proxy protocol" proxy
42000
42001 Exim has support for receiving inbound SMTP connections via a proxy
42002 that uses &"Proxy Protocol"& to speak to it.
42003 To include this support, include &"SUPPORT_PROXY=yes"&
42004 in Local/Makefile.
42005
42006 It was built on the HAProxy specification, found at
42007 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42008
42009 The purpose of this facility is so that an application load balancer,
42010 such as HAProxy, can sit in front of several Exim servers
42011 to distribute load.
42012 Exim uses the local protocol communication with the proxy to obtain
42013 the remote SMTP system IP address and port information.
42014 There is no logging if a host passes or
42015 fails Proxy Protocol negotiation, but it can easily be determined and
42016 recorded in an ACL (example is below).
42017
42018 Use of a proxy is enabled by setting the &%hosts_proxy%&
42019 main configuration option to a hostlist; connections from these
42020 hosts will use Proxy Protocol.
42021 Exim supports both version 1 and version 2 of the Proxy Protocol and
42022 automatically determines which version is in use.
42023
42024 The Proxy Protocol header is the first data received on a TCP connection
42025 and is inserted before any TLS-on-connect handshake from the client; Exim
42026 negotiates TLS between Exim-as-server and the remote client, not between
42027 Exim and the proxy server. The Proxy Protocol header must be received
42028 within &%proxy_protocol_timeout%&, which defaults to 3s.
42029
42030 The following expansion variables are usable
42031 (&"internal"& and &"external"& here refer to the interfaces
42032 of the proxy):
42033 .display
42034 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
42035 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
42036 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
42037 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
42038 &'proxy_session            '& boolean: SMTP connection via proxy
42039 .endd
42040 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42041 there was a protocol error.
42042 The variables &$sender_host_address$& and &$sender_host_port$&
42043 will have values for the actual client system, not the proxy.
42044
42045 Since the real connections are all coming from the proxy, and the
42046 per host connection tracking is done before Proxy Protocol is
42047 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42048 handle all of the parallel volume you expect per inbound proxy.
42049 With the option set so high, you lose the ability
42050 to protect your server from many connections from one IP.
42051 In order to prevent your server from overload, you
42052 need to add a per connection ratelimit to your connect ACL.
42053 A possible solution is:
42054 .display
42055   # Set max number of connections per host
42056   LIMIT   = 5
42057   # Or do some kind of IP lookup in a flat file or database
42058   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42059
42060   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42061           message        = Too many connections from this IP right now
42062 .endd
42063
42064
42065
42066 .section "Outbound proxies" SECTproxySOCKS
42067 .cindex proxy outbound
42068 .cindex proxy "client side"
42069 .cindex proxy SOCKS
42070 .cindex SOCKS proxy
42071 Exim has support for sending outbound SMTP via a proxy
42072 using a protocol called SOCKS5 (defined by RFC1928).
42073 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42074 Local/Makefile.
42075
42076 Use of a proxy is enabled by setting the &%socks_proxy%& option
42077 on an smtp transport.
42078 The option value is expanded and should then be a list
42079 (colon-separated by default) of proxy specifiers.
42080 Each proxy specifier is a list
42081 (space-separated by default) where the initial element
42082 is an IP address and any subsequent elements are options.
42083
42084 Options are a string <name>=<value>.
42085 The list of options is in the following table:
42086 .display
42087 &'auth   '& authentication method
42088 &'name   '& authentication username
42089 &'pass   '& authentication password
42090 &'port   '& tcp port
42091 &'tmo    '& connection timeout
42092 &'pri    '& priority
42093 &'weight '& selection bias
42094 .endd
42095
42096 More details on each of these options follows:
42097
42098 .ilist
42099 .cindex authentication "to proxy"
42100 .cindex proxy authentication
42101 &%auth%&: Either &"none"& (default) or &"name"&.
42102 Using &"name"& selects username/password authentication per RFC 1929
42103 for access to the proxy.
42104 Default is &"none"&.
42105 .next
42106 &%name%&: sets the username for the &"name"& authentication method.
42107 Default is empty.
42108 .next
42109 &%pass%&: sets the password for the &"name"& authentication method.
42110 Default is empty.
42111 .next
42112 &%port%&: the TCP port number to use for the connection to the proxy.
42113 Default is 1080.
42114 .next
42115 &%tmo%&: sets a connection timeout in seconds for this proxy.
42116 Default is 5.
42117 .next
42118 &%pri%&: specifies a priority for the proxy within the list,
42119 higher values being tried first.
42120 The default priority is 1.
42121 .next
42122 &%weight%&: specifies a selection bias.
42123 Within a priority set servers are queried in a random fashion,
42124 weighted by this value.
42125 The default value for selection bias is 1.
42126 .endlist
42127
42128 Proxies from the list are tried according to their priority
42129 and weight settings until one responds.  The timeout for the
42130 overall connection applies to the set of proxied attempts.
42131
42132 .section Logging SECTproxyLog
42133 To log the (local) IP of a proxy in the incoming or delivery logline,
42134 add &"+proxy"& to the &%log_selector%& option.
42135 This will add a component tagged with &"PRX="& to the line.
42136
42137 . ////////////////////////////////////////////////////////////////////////////
42138 . ////////////////////////////////////////////////////////////////////////////
42139
42140 .chapter "Internationalisation" "CHAPi18n" &&&
42141          "Internationalisation""
42142 .cindex internationalisation "email address"
42143 .cindex EAI
42144 .cindex i18n
42145 .cindex utf8 "mail name handling"
42146
42147 Exim has support for Internationalised mail names.
42148 To include this it must be built with SUPPORT_I18N and the libidn library.
42149 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42150
42151 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42152 instead of it) then IDNA2008 is supported; this adds an extra library
42153 requirement, upon libidn2.
42154
42155 .section "MTA operations" SECTi18nMTA
42156 .cindex SMTPUTF8 "ESMTP option"
42157 .cindex "ESMTP extensions" SMTPUTF8
42158 The main configuration option &%smtputf8_advertise_hosts%& specifies
42159 a host list.  If this matches the sending host and
42160 accept_8bitmime is true (the default) then the ESMTP option
42161 SMTPUTF8 will be advertised.
42162
42163 If the sender specifies the SMTPUTF8 option on a MAIL command
42164 international handling for the message is enabled and
42165 the expansion variable &$message_smtputf8$& will have value TRUE.
42166
42167 The option &%allow_utf8_domains%& is set to true for this
42168 message. All DNS lookups are converted to a-label form
42169 whatever the setting of &%allow_utf8_domains%&
42170 when Exim is built with SUPPORT_I18N.
42171
42172 Both localparts and domain are maintained as the original
42173 UTF-8 form internally; any comparison or regular-expression use will
42174 require appropriate care.  Filenames created, eg. by
42175 the appendfile transport, will have UTF-8 names.
42176
42177 HELO names sent by the smtp transport will have any UTF-8
42178 components expanded to a-label form,
42179 and any certificate name checks will be done using the a-label
42180 form of the name.
42181
42182 .cindex log protocol
42183 .cindex SMTPUTF8 logging
42184 .cindex i18n logging
42185 Log lines and Received-by: header lines will acquire a "utf8"
42186 prefix on the protocol element, eg. utf8esmtp.
42187
42188 The following expansion operators can be used:
42189 .code
42190 ${utf8_domain_to_alabel:str}
42191 ${utf8_domain_from_alabel:str}
42192 ${utf8_localpart_to_alabel:str}
42193 ${utf8_localpart_from_alabel:str}
42194 .endd
42195
42196 .cindex utf8 "address downconversion"
42197 .cindex i18n "utf8 address downconversion"
42198 The RCPT ACL
42199 may use the following modifier:
42200 .display
42201 control = utf8_downconvert
42202 control = utf8_downconvert/<value>
42203 .endd
42204 This sets a flag requiring that envelope addresses are converted to
42205 a-label form before smtp delivery.
42206 This is usually for use in a Message Submission Agent context,
42207 but could be used for any message.
42208
42209 If a value is appended it may be:
42210 .display
42211 &`1  `& mandatory downconversion
42212 &`0  `& no downconversion
42213 &`-1 `& if SMTPUTF8 not supported by destination host
42214 .endd
42215 If no value is given, 1 is used.
42216
42217 If mua_wrapper is set, the utf8_downconvert control
42218 is initially set to -1.
42219
42220 The smtp transport has an option &%utf8_downconvert%&.
42221 If set it must expand to one of the three values described above,
42222 or an empty string.
42223 If non-empty it overrides value previously set
42224 (due to mua_wrapper or by an ACL control).
42225
42226
42227 There is no explicit support for VRFY and EXPN.
42228 Configurations supporting these should inspect
42229 &$smtp_command_argument$& for an SMTPUTF8 argument.
42230
42231 There is no support for LMTP on Unix sockets.
42232 Using the "lmtp" protocol option on an smtp transport,
42233 for LMTP over TCP, should work as expected.
42234
42235 There is no support for DSN unitext handling,
42236 and no provision for converting logging from or to UTF-8.
42237
42238
42239
42240 .section "MDA operations" SECTi18nMDA
42241 To aid in constructing names suitable for IMAP folders
42242 the following expansion operator can be used:
42243 .code
42244 ${imapfolder {<string>} {<sep>} {<specials>}}
42245 .endd
42246
42247 The string is converted from the charset specified by
42248 the "headers charset" command (in a filter file)
42249 or &%headers_charset%& main configuration option (otherwise),
42250 to the
42251 modified UTF-7 encoding specified by RFC 2060,
42252 with the following exception: All occurrences of <sep>
42253 (which has to be a single character)
42254 are replaced with periods ("."), and all periods and slashes that are not
42255 <sep> and are not in the <specials> string are BASE64 encoded.
42256
42257 The third argument can be omitted, defaulting to an empty string.
42258 The second argument can be omitted, defaulting to "/".
42259
42260 This is the encoding used by Courier for Maildir names on disk, and followed
42261 by many other IMAP servers.
42262
42263 Examples:
42264 .display
42265 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42266 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42267 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42268 .endd
42269
42270 Note that the source charset setting is vital, and also that characters
42271 must be representable in UTF-16.
42272
42273
42274 . ////////////////////////////////////////////////////////////////////////////
42275 . ////////////////////////////////////////////////////////////////////////////
42276
42277 .chapter "Events" "CHAPevents" &&&
42278          "Events"
42279 .cindex events
42280
42281 The events mechanism in Exim can be used to intercept processing at a number
42282 of points.  It was originally invented to give a way to do customised logging
42283 actions (for example, to a database) but can also be used to modify some
42284 processing actions.
42285
42286 Most installations will never need to use Events.
42287 The support can be left out of a build by defining DISABLE_EVENT=yes
42288 in &_Local/Makefile_&.
42289
42290 There are two major classes of events: main and transport.
42291 The main configuration option &%event_action%& controls reception events;
42292 a transport option &%event_action%& controls delivery events.
42293
42294 Both options are a string which is expanded when the event fires.
42295 An example might look like:
42296 .cindex logging custom
42297 .code
42298 event_action = ${if eq {msg:delivery}{$event_name} \
42299 {${lookup pgsql {SELECT * FROM record_Delivery( \
42300     '${quote_pgsql:$sender_address_domain}',\
42301     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42302     '${quote_pgsql:$domain}', \
42303     '${quote_pgsql:${lc:$local_part}}', \
42304     '${quote_pgsql:$host_address}', \
42305     '${quote_pgsql:${lc:$host}}', \
42306     '${quote_pgsql:$message_exim_id}')}} \
42307 } {}}
42308 .endd
42309
42310 Events have names which correspond to the point in process at which they fire.
42311 The name is placed in the variable &$event_name$& and the event action
42312 expansion must check this, as it will be called for every possible event type.
42313
42314 The current list of events is:
42315 .display
42316 &`dane:fail              after    transport  `& per connection
42317 &`msg:complete           after    main       `& per message
42318 &`msg:defer              after    transport  `& per message per delivery try
42319 &`msg:delivery           after    transport  `& per recipient
42320 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
42321 &`msg:rcpt:defer         after    transport  `& per recipient
42322 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
42323 &`msg:fail:delivery      after    transport  `& per recipient
42324 &`msg:fail:internal      after    main       `& per recipient
42325 &`tcp:connect            before   transport  `& per connection
42326 &`tcp:close              after    transport  `& per connection
42327 &`tls:cert               before   both       `& per certificate in verification chain
42328 &`smtp:connect           after    transport  `& per connection
42329 &`smtp:ehlo              after    transport  `& per connection
42330 .endd
42331 New event types may be added in future.
42332
42333 The event name is a colon-separated list, defining the type of
42334 event in a tree of possibilities.  It may be used as a list
42335 or just matched on as a whole.  There will be no spaces in the name.
42336
42337 The second column in the table above describes whether the event fires
42338 before or after the action is associates with.  Those which fire before
42339 can be used to affect that action (more on this below).
42340
42341 The third column in the table above says what section of the configuration
42342 should define the event action.
42343
42344 An additional variable, &$event_data$&, is filled with information varying
42345 with the event type:
42346 .display
42347 &`dane:fail            `& failure reason
42348 &`msg:defer            `& error string
42349 &`msg:delivery         `& smtp confirmation message
42350 &`msg:fail:internal    `& failure reason
42351 &`msg:fail:delivery    `& smtp error message
42352 &`msg:host:defer       `& error string
42353 &`msg:rcpt:host:defer  `& error string
42354 &`msg:rcpt:defer       `& error string
42355 &`tls:cert             `& verification chain depth
42356 &`smtp:connect         `& smtp banner
42357 &`smtp:ehlo            `& smtp ehlo response
42358 .endd
42359
42360 The :defer events populate one extra variable: &$event_defer_errno$&.
42361
42362 For complex operations an ACL expansion can be used in &%event_action%&
42363 however due to the multiple contexts that Exim operates in during
42364 the course of its processing:
42365 .ilist
42366 variables set in transport events will not be visible outside that
42367 transport call
42368 .next
42369 acl_m variables in a server context are lost on a new connection,
42370 and after smtp helo/ehlo/mail/starttls/rset commands
42371 .endlist
42372 Using an ACL expansion with the logwrite modifier can be
42373 a useful way of writing to the main log.
42374
42375 The expansion of the event_action option should normally
42376 return an empty string.  Should it return anything else the
42377 following will be forced:
42378 .display
42379 &`tcp:connect      `&  do not connect
42380 &`tls:cert         `&  refuse verification
42381 &`smtp:connect     `&  close connection
42382 .endd
42383 All other message types ignore the result string, and
42384 no other use is made of it.
42385
42386 For a tcp:connect event, if the connection is being made to a proxy
42387 then the address and port variables will be that of the proxy and not
42388 the target system.
42389
42390 For tls:cert events, if GnuTLS is in use this will trigger only per
42391 chain element received on the connection.
42392 For OpenSSL it will trigger for every chain element including those
42393 loaded locally.
42394
42395 . ////////////////////////////////////////////////////////////////////////////
42396 . ////////////////////////////////////////////////////////////////////////////
42397
42398 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42399          "Adding drivers or lookups"
42400 .cindex "adding drivers"
42401 .cindex "new drivers, adding"
42402 .cindex "drivers" "adding new"
42403 The following actions have to be taken in order to add a new router, transport,
42404 authenticator, or lookup type to Exim:
42405
42406 .olist
42407 Choose a name for the driver or lookup type that does not conflict with any
42408 existing name; I will use &"newdriver"& in what follows.
42409 .next
42410 Add to &_src/EDITME_& the line:
42411 .display
42412 <&'type'&>&`_NEWDRIVER=yes`&
42413 .endd
42414 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42415 code is not to be included in the binary by default, comment this line out. You
42416 should also add any relevant comments about the driver or lookup type.
42417 .next
42418 Add to &_src/config.h.defaults_& the line:
42419 .code
42420 #define <type>_NEWDRIVER
42421 .endd
42422 .next
42423 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42424 and create a table entry as is done for all the other drivers and lookup types.
42425 .next
42426 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42427 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42428 Add your &`NEWDRIVER`& to that list.
42429 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42430 simple form that most lookups have.
42431 .next
42432 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42433 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42434 driver or lookup type and add it to the definition of OBJ.
42435 .next
42436 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42437 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42438 .next
42439 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42440 &_src_&.
42441 .next
42442 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42443 as for other drivers and lookups.
42444 .endlist
42445
42446 Then all you need to do is write the code! A good way to start is to make a
42447 proforma by copying an existing module of the same type, globally changing all
42448 occurrences of the name, and cutting out most of the code. Note that any
42449 options you create must be listed in alphabetical order, because the tables are
42450 searched using a binary chop procedure.
42451
42452 There is a &_README_& file in each of the sub-directories of &_src_& describing
42453 the interface that is expected.
42454
42455
42456
42457
42458 . ////////////////////////////////////////////////////////////////////////////
42459 . ////////////////////////////////////////////////////////////////////////////
42460
42461 . /////////////////////////////////////////////////////////////////////////////
42462 . These lines are processing instructions for the Simple DocBook Processor that
42463 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42464 . PDFs than using xmlto and fop. They will be ignored by all other XML
42465 . processors.
42466 . /////////////////////////////////////////////////////////////////////////////
42467
42468 .literal xml
42469 <?sdop
42470   format="newpage"
42471   foot_right_recto="&chaptertitle;"
42472   foot_right_verso="&chaptertitle;"
42473 ?>
42474 .literal off
42475
42476 .makeindex "Options index"   "option"
42477 .makeindex "Variables index" "variable"
42478 .makeindex "Concept index"   "concept"
42479
42480
42481 . /////////////////////////////////////////////////////////////////////////////
42482 . /////////////////////////////////////////////////////////////////////////////